scalar_api_ruby 0.2.0

data/sig/scalar_api_ruby/models/teams/member_list_response.rbs

@@ -0,0 +1,27 @@
+module Scalar
+  module Models
+    module Teams
+      type member_list_response =
+        {
+          members: ::Array[Scalar::Teams::TeamMember],
+          pending_invites: ::Array[Scalar::Teams::TeamInvite]
+        }
+
+      class MemberListResponse < Scalar::Internal::Type::BaseModel
+        attr_accessor members: ::Array[Scalar::Teams::TeamMember]
+
+        attr_accessor pending_invites: ::Array[Scalar::Teams::TeamInvite]
+
+        def initialize: (
+          members: ::Array[Scalar::Teams::TeamMember],
+          pending_invites: ::Array[Scalar::Teams::TeamInvite]
+        ) -> void
+
+        def to_hash: -> {
+          members: ::Array[Scalar::Teams::TeamMember],
+          pending_invites: ::Array[Scalar::Teams::TeamInvite]
+        }
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/models/teams/member_update_params.rbs

@@ -0,0 +1,30 @@
+module Scalar
+  module Models
+    module Teams
+      type member_update_params =
+        { uid: String, role: Scalar::Models::Teams::role }
+        & Scalar::Internal::Type::request_parameters
+
+      class MemberUpdateParams < Scalar::Internal::Type::BaseModel
+        extend Scalar::Internal::Type::RequestParameters::Converter
+        include Scalar::Internal::Type::RequestParameters
+
+        attr_accessor uid: String
+
+        attr_accessor role: Scalar::Models::Teams::role
+
+        def initialize: (
+          uid: String,
+          role: Scalar::Models::Teams::role,
+          ?request_options: Scalar::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          uid: String,
+          role: Scalar::Models::Teams::role,
+          request_options: Scalar::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/models/teams/role.rbs

@@ -0,0 +1,18 @@
+module Scalar
+  module Models
+    module Teams
+      type role = :owner | :admin | :editor | :viewer
+
+      module Role
+        extend Scalar::Internal::Type::Enum
+
+        OWNER: :owner
+        ADMIN: :admin
+        EDITOR: :editor
+        VIEWER: :viewer
+
+        def self?.values: -> ::Array[Scalar::Models::Teams::role]
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/models/teams/team_invite.rbs

@@ -0,0 +1,41 @@
+module Scalar
+  module Models
+    class TeamInvite = Teams::TeamInvite
+
+    module Teams
+      type team_invite =
+        {
+          email: String,
+          role: Scalar::Models::Teams::role,
+          uid: String,
+          expires: Float
+        }
+
+      class TeamInvite < Scalar::Internal::Type::BaseModel
+        attr_accessor email: String
+
+        attr_accessor role: Scalar::Models::Teams::role
+
+        attr_accessor uid: String
+
+        attr_reader expires: Float?
+
+        def expires=: (Float) -> Float
+
+        def initialize: (
+          email: String,
+          role: Scalar::Models::Teams::role,
+          uid: String,
+          ?expires: Float
+        ) -> void
+
+        def to_hash: -> {
+          email: String,
+          role: Scalar::Models::Teams::role,
+          uid: String,
+          expires: Float
+        }
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/models/teams/team_member.rbs

@@ -0,0 +1,41 @@
+module Scalar
+  module Models
+    class TeamMember = Teams::TeamMember
+
+    module Teams
+      type team_member =
+        {
+          display_name: String,
+          role: Scalar::Models::Teams::role,
+          uid: String,
+          image_uri: String
+        }
+
+      class TeamMember < Scalar::Internal::Type::BaseModel
+        attr_accessor display_name: String
+
+        attr_accessor role: Scalar::Models::Teams::role
+
+        attr_accessor uid: String
+
+        attr_reader image_uri: String?
+
+        def image_uri=: (String) -> String
+
+        def initialize: (
+          display_name: String,
+          role: Scalar::Models::Teams::role,
+          uid: String,
+          ?image_uri: String
+        ) -> void
+
+        def to_hash: -> {
+          display_name: String,
+          role: Scalar::Models::Teams::role,
+          uid: String,
+          image_uri: String
+        }
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/models/theme.rbs

@@ -0,0 +1,30 @@
+module Scalar
+  module Models
+    type theme =
+      { description: String, name: String, slug: String, uid: String }
+
+    class Theme < Scalar::Internal::Type::BaseModel
+      attr_accessor description: String
+
+      attr_accessor name: String
+
+      attr_accessor slug: String
+
+      attr_accessor uid: String
+
+      def initialize: (
+        description: String,
+        name: String,
+        slug: String,
+        uid: String
+      ) -> void
+
+      def to_hash: -> {
+        description: String,
+        name: String,
+        slug: String,
+        uid: String
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/theme_create_params.rbs

@@ -0,0 +1,38 @@
+module Scalar
+  module Models
+    type theme_create_params =
+      { document: String, name: String, slug: String, description: String }
+      & Scalar::Internal::Type::request_parameters
+
+    class ThemeCreateParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor document: String
+
+      attr_accessor name: String
+
+      attr_accessor slug: String
+
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      def initialize: (
+        document: String,
+        name: String,
+        slug: String,
+        ?description: String,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        document: String,
+        name: String,
+        slug: String,
+        description: String,
+        request_options: Scalar::RequestOptions
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/theme_delete_params.rbs

@@ -0,0 +1,20 @@
+module Scalar
+  module Models
+    type theme_delete_params =
+      { slug: String } & Scalar::Internal::Type::request_parameters
+
+    class ThemeDeleteParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor slug: String
+
+      def initialize: (
+        slug: String,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> { slug: String, request_options: Scalar::RequestOptions }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/theme_list_params.rbs

@@ -0,0 +1,14 @@
+module Scalar
+  module Models
+    type theme_list_params = {  } & Scalar::Internal::Type::request_parameters
+
+    class ThemeListParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      def initialize: (?request_options: Scalar::request_opts) -> void
+
+      def to_hash: -> { request_options: Scalar::RequestOptions }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/theme_list_response.rbs

@@ -0,0 +1,7 @@
+module Scalar
+  module Models
+    type theme_list_response = ::Array[Scalar::Theme]
+
+    ThemeListResponse: Scalar::Internal::Type::Converter
+  end
+end

data/sig/scalar_api_ruby/models/theme_replace_document_params.rbs

@@ -0,0 +1,28 @@
+module Scalar
+  module Models
+    type theme_replace_document_params =
+      { slug: String, document: String }
+      & Scalar::Internal::Type::request_parameters
+
+    class ThemeReplaceDocumentParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor slug: String
+
+      attr_accessor document: String
+
+      def initialize: (
+        slug: String,
+        document: String,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        slug: String,
+        document: String,
+        request_options: Scalar::RequestOptions
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/theme_retrieve_params.rbs

@@ -0,0 +1,20 @@
+module Scalar
+  module Models
+    type theme_retrieve_params =
+      { slug: String } & Scalar::Internal::Type::request_parameters
+
+    class ThemeRetrieveParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor slug: String
+
+      def initialize: (
+        slug: String,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> { slug: String, request_options: Scalar::RequestOptions }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/theme_retrieve_response.rbs

@@ -0,0 +1,5 @@
+module Scalar
+  module Models
+    class ThemeRetrieveResponse = String
+  end
+end

data/sig/scalar_api_ruby/models/theme_update_params.rbs

@@ -0,0 +1,36 @@
+module Scalar
+  module Models
+    type theme_update_params =
+      { slug: String, description: String, name: String }
+      & Scalar::Internal::Type::request_parameters
+
+    class ThemeUpdateParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor slug: String
+
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      def initialize: (
+        slug: String,
+        ?description: String,
+        ?name: String,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        slug: String,
+        description: String,
+        name: String,
+        request_options: Scalar::RequestOptions
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/timestamp.rbs

@@ -0,0 +1,5 @@
+module Scalar
+  module Models
+    class Timestamp = Integer
+  end
+end

data/sig/scalar_api_ruby/models/uid.rbs

@@ -0,0 +1,13 @@
+module Scalar
+  module Models
+    type uid = { uid: String }
+
+    class UID < Scalar::Internal::Type::BaseModel
+      attr_accessor uid: String
+
+      def initialize: (uid: String) -> void
+
+      def to_hash: -> { uid: String }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/user.rbs

@@ -0,0 +1,57 @@
+module Scalar
+  module Models
+    type user =
+      {
+        active_team_id: String?,
+        created_at: Integer,
+        email: String,
+        has_github: bool,
+        teams: ::Array[Scalar::TeamSummary],
+        uid: String,
+        updated_at: Integer,
+        theme: String
+      }
+
+    class User < Scalar::Internal::Type::BaseModel
+      attr_accessor active_team_id: String?
+
+      attr_accessor created_at: Integer
+
+      attr_accessor email: String
+
+      attr_accessor has_github: bool
+
+      attr_accessor teams: ::Array[Scalar::TeamSummary]
+
+      attr_accessor uid: String
+
+      attr_accessor updated_at: Integer
+
+      attr_reader theme: String?
+
+      def theme=: (String) -> String
+
+      def initialize: (
+        active_team_id: String?,
+        created_at: Integer,
+        email: String,
+        has_github: bool,
+        teams: ::Array[Scalar::TeamSummary],
+        uid: String,
+        updated_at: Integer,
+        ?theme: String
+      ) -> void
+
+      def to_hash: -> {
+        active_team_id: String?,
+        created_at: Integer,
+        email: String,
+        has_github: bool,
+        teams: ::Array[Scalar::TeamSummary],
+        uid: String,
+        updated_at: Integer,
+        theme: String
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/version.rbs

@@ -0,0 +1,5 @@
+module Scalar
+  module Models
+    class Version = String
+  end
+end

data/sig/scalar_api_ruby/models.rbs

@@ -0,0 +1,205 @@
+module Scalar
+  class AccessGroup = Scalar::Models::AccessGroup
+
+  class AccessGroupCreateParams = Scalar::Models::AccessGroupCreateParams
+
+  class AccessGroupDeleteParams = Scalar::Models::AccessGroupDeleteParams
+
+  class AccessGroupName = Scalar::Models::AccessGroupName
+
+  class AccessGroupRetrieveParams = Scalar::Models::AccessGroupRetrieveParams
+
+  module AccessGroups = Scalar::Models::AccessGroups
+
+  class AccessGroupUpdateParams = Scalar::Models::AccessGroupUpdateParams
+
+  class ActiveDeployment = Scalar::Models::ActiveDeployment
+
+  class APIDocument = Scalar::Models::APIDocument
+
+  class AuthenticationExchangePersonalTokenParams = Scalar::Models::AuthenticationExchangePersonalTokenParams
+
+  class AuthenticationListCurrentUserParams = Scalar::Models::AuthenticationListCurrentUserParams
+
+  class DocsProject = Scalar::Models::DocsProject
+
+  class GithubProject = Scalar::Models::GithubProject
+
+  class GithubProjectRepository = Scalar::Models::GithubProjectRepository
+
+  class LoginPortal = Scalar::Models::LoginPortal
+
+  class LoginPortalCreateParams = Scalar::Models::LoginPortalCreateParams
+
+  class LoginPortalDeleteParams = Scalar::Models::LoginPortalDeleteParams
+
+  class LoginPortalEmail = Scalar::Models::LoginPortalEmail
+
+  class LoginPortalListParams = Scalar::Models::LoginPortalListParams
+
+  class LoginPortalPage = Scalar::Models::LoginPortalPage
+
+  class LoginPortalRetrieveParams = Scalar::Models::LoginPortalRetrieveParams
+
+  class LoginPortalUpdateParams = Scalar::Models::LoginPortalUpdateParams
+
+  class ManagedDocVersion = Scalar::Models::ManagedDocVersion
+
+  class ManagedSchemaVersion = Scalar::Models::ManagedSchemaVersion
+
+  module Mcp = Scalar::Models::Mcp
+
+  class Method = Scalar::Models::Method
+
+  class Namespace = Scalar::Models::Namespace
+
+  class NamespaceListParams = Scalar::Models::NamespaceListParams
+
+  class Nanoid = Scalar::Models::Nanoid
+
+  class RegistryCreateAPIDocumentAccessGroupParams = Scalar::Models::RegistryCreateAPIDocumentAccessGroupParams
+
+  class RegistryCreateAPIDocumentParams = Scalar::Models::RegistryCreateAPIDocumentParams
+
+  class RegistryCreateAPIDocumentVersionParams = Scalar::Models::RegistryCreateAPIDocumentVersionParams
+
+  class RegistryDeleteAPIDocumentAccessGroupParams = Scalar::Models::RegistryDeleteAPIDocumentAccessGroupParams
+
+  class RegistryDeleteAPIDocumentParams = Scalar::Models::RegistryDeleteAPIDocumentParams
+
+  class RegistryDeleteAPIDocumentVersionParams = Scalar::Models::RegistryDeleteAPIDocumentVersionParams
+
+  class RegistryListAllAPIDocumentsParams = Scalar::Models::RegistryListAllAPIDocumentsParams
+
+  class RegistryListAPIDocumentsParams = Scalar::Models::RegistryListAPIDocumentsParams
+
+  class RegistryListAPIDocumentVersionMetadataParams = Scalar::Models::RegistryListAPIDocumentVersionMetadataParams
+
+  class RegistryRetrieveAPIDocumentVersionParams = Scalar::Models::RegistryRetrieveAPIDocumentVersionParams
+
+  class RegistryUpdateAPIDocumentParams = Scalar::Models::RegistryUpdateAPIDocumentParams
+
+  class RegistryUpdateAPIDocumentVersionParams = Scalar::Models::RegistryUpdateAPIDocumentVersionParams
+
+  class Rule = Scalar::Models::Rule
+
+  class RuleCreateRulesetAccessGroupParams = Scalar::Models::RuleCreateRulesetAccessGroupParams
+
+  class RuleCreateRulesetParams = Scalar::Models::RuleCreateRulesetParams
+
+  class RuleDeleteRulesetAccessGroupParams = Scalar::Models::RuleDeleteRulesetAccessGroupParams
+
+  class RuleDeleteRulesetParams = Scalar::Models::RuleDeleteRulesetParams
+
+  class RuleListRulesetsParams = Scalar::Models::RuleListRulesetsParams
+
+  class RuleRetrieveRulesetDocumentParams = Scalar::Models::RuleRetrieveRulesetDocumentParams
+
+  class RuleUpdateRulesetParams = Scalar::Models::RuleUpdateRulesetParams
+
+  class ScalarDocCreateGuideParams = Scalar::Models::ScalarDocCreateGuideParams
+
+  class ScalarDocCreateProjectParams = Scalar::Models::ScalarDocCreateProjectParams
+
+  class ScalarDocDeleteProjectParams = Scalar::Models::ScalarDocDeleteProjectParams
+
+  class ScalarDocListGuidesParams = Scalar::Models::ScalarDocListGuidesParams
+
+  class ScalarDocListProjectConfigParams = Scalar::Models::ScalarDocListProjectConfigParams
+
+  class ScalarDocListProjectDomainParams = Scalar::Models::ScalarDocListProjectDomainParams
+
+  class ScalarDocListProjectDomainStatusParams = Scalar::Models::ScalarDocListProjectDomainStatusParams
+
+  class ScalarDocListProjectsParams = Scalar::Models::ScalarDocListProjectsParams
+
+  class ScalarDocPublishGuideParams = Scalar::Models::ScalarDocPublishGuideParams
+
+  class ScalarDocPublishProjectParams = Scalar::Models::ScalarDocPublishProjectParams
+
+  class ScalarDocRetrieveProjectParams = Scalar::Models::ScalarDocRetrieveProjectParams
+
+  class ScalarDocUpdateProjectConfigParams = Scalar::Models::ScalarDocUpdateProjectConfigParams
+
+  class ScalarDocUpdateProjectParams = Scalar::Models::ScalarDocUpdateProjectParams
+
+  class Schema = Scalar::Models::Schema
+
+  class SchemaCreateParams = Scalar::Models::SchemaCreateParams
+
+  class SchemaDeleteParams = Scalar::Models::SchemaDeleteParams
+
+  class SchemaListParams = Scalar::Models::SchemaListParams
+
+  module Schemas = Scalar::Models::Schemas
+
+  class SchemaUpdateParams = Scalar::Models::SchemaUpdateParams
+
+  class Sdk = Scalar::Models::Sdk
+
+  class SdkBuildParams = Scalar::Models::SdkBuildParams
+
+  class SdkCreateParams = Scalar::Models::SdkCreateParams
+
+  class SdkDeleteParams = Scalar::Models::SdkDeleteParams
+
+  class SdkListParams = Scalar::Models::SdkListParams
+
+  class SdkRetrieveParams = Scalar::Models::SdkRetrieveParams
+
+  module Sdks = Scalar::Models::Sdks
+
+  class SdkTargetSummary = Scalar::Models::SdkTargetSummary
+
+  class SdkUpdateParams = Scalar::Models::SdkUpdateParams
+
+  class SdkVersion = Scalar::Models::SdkVersion
+
+  class Slug = Scalar::Models::Slug
+
+  class Team = Scalar::Models::Team
+
+  class TeamImage = Scalar::Models::TeamImage
+
+  class TeamListParams = Scalar::Models::TeamListParams
+
+  class TeamName = Scalar::Models::TeamName
+
+  module Teams = Scalar::Models::Teams
+
+  class TeamSummary = Scalar::Models::TeamSummary
+
+  class Theme = Scalar::Models::Theme
+
+  class ThemeCreateParams = Scalar::Models::ThemeCreateParams
+
+  class ThemeDeleteParams = Scalar::Models::ThemeDeleteParams
+
+  class ThemeListParams = Scalar::Models::ThemeListParams
+
+  class ThemeReplaceDocumentParams = Scalar::Models::ThemeReplaceDocumentParams
+
+  class ThemeRetrieveParams = Scalar::Models::ThemeRetrieveParams
+
+  class ThemeUpdateParams = Scalar::Models::ThemeUpdateParams
+
+  class Timestamp = Scalar::Models::Timestamp
+
+  class UID = Scalar::Models::UID
+
+  class User = Scalar::Models::User
+
+  class Value400 = Scalar::Models::Value400
+
+  class Value401 = Scalar::Models::Value401
+
+  class Value403 = Scalar::Models::Value403
+
+  class Value404 = Scalar::Models::Value404
+
+  class Value422 = Scalar::Models::Value422
+
+  class Value500 = Scalar::Models::Value500
+
+  class Version = Scalar::Models::Version
+end

data/sig/scalar_api_ruby/request_options.rbs

@@ -0,0 +1,34 @@
+module Scalar
+  type request_opts =
+    Scalar::RequestOptions | Scalar::request_options | ::Hash[Symbol, top]
+
+  type request_options =
+    {
+      idempotency_key: String?,
+      extra_query: ::Hash[String, (::Array[String] | String)?]?,
+      extra_headers: ::Hash[String, String?]?,
+      extra_body: top?,
+      max_retries: Integer?,
+      timeout: Float?
+    }
+
+  class RequestOptions < Scalar::Internal::Type::BaseModel
+    def self.validate!: (Scalar::request_opts opts) -> void
+
+    attr_accessor idempotency_key: String?
+
+    attr_accessor extra_query: ::Hash[String, (::Array[String] | String)?]?
+
+    attr_accessor extra_headers: ::Hash[String, String?]?
+
+    attr_accessor extra_body: top?
+
+    attr_accessor max_retries: Integer?
+
+    attr_accessor timeout: Float?
+
+    def initialize: (
+      ?Scalar::request_options | ::Hash[Symbol, top] values
+    ) -> void
+  end
+end