scalar_api_ruby 0.2.0

data/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_response.rbs

@@ -0,0 +1,16 @@
+module Scalar
+  module Models
+    type scalar_doc_list_project_domain_response =
+      { custom_domain: String?, scalar_domain: String? }
+
+    class ScalarDocListProjectDomainResponse < Scalar::Internal::Type::BaseModel
+      attr_accessor custom_domain: String?
+
+      attr_accessor scalar_domain: String?
+
+      def initialize: (custom_domain: String?, scalar_domain: String?) -> void
+
+      def to_hash: -> { custom_domain: String?, scalar_domain: String? }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_status_params.rbs

@@ -0,0 +1,20 @@
+module Scalar
+  module Models
+    type scalar_doc_list_project_domain_status_params =
+      { slug: String } & Scalar::Internal::Type::request_parameters
+
+    class ScalarDocListProjectDomainStatusParams < 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/scalar_doc_list_project_domain_status_response.rbs

@@ -0,0 +1,59 @@
+module Scalar
+  module Models
+    type scalar_doc_list_project_domain_status_response =
+      {
+        domain: String?,
+        expected: Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected?,
+        found: ::Array[String],
+        status: Scalar::Models::ScalarDocListProjectDomainStatusResponse::status
+      }
+
+    class ScalarDocListProjectDomainStatusResponse < Scalar::Internal::Type::BaseModel
+      attr_accessor domain: String?
+
+      attr_accessor expected: Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected?
+
+      attr_accessor found: ::Array[String]
+
+      attr_accessor status: Scalar::Models::ScalarDocListProjectDomainStatusResponse::status
+
+      def initialize: (
+        domain: String?,
+        expected: Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected?,
+        found: ::Array[String],
+        status: Scalar::Models::ScalarDocListProjectDomainStatusResponse::status
+      ) -> void
+
+      def to_hash: -> {
+        domain: String?,
+        expected: Scalar::Models::ScalarDocListProjectDomainStatusResponse::Expected?,
+        found: ::Array[String],
+        status: Scalar::Models::ScalarDocListProjectDomainStatusResponse::status
+      }
+
+      type expected = { target: String, type: :CNAME }
+
+      class Expected < Scalar::Internal::Type::BaseModel
+        attr_accessor target: String
+
+        attr_accessor type: :CNAME
+
+        def initialize: (target: String, ?type: :CNAME) -> void
+
+        def to_hash: -> { target: String, type: :CNAME }
+      end
+
+      type status = :verified | :pending | :misconfigured
+
+      module Status
+        extend Scalar::Internal::Type::Enum
+
+        VERIFIED: :verified
+        PENDING: :pending
+        MISCONFIGURED: :misconfigured
+
+        def self?.values: -> ::Array[Scalar::Models::ScalarDocListProjectDomainStatusResponse::status]
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/models/scalar_doc_list_projects_params.rbs

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

data/sig/scalar_api_ruby/models/scalar_doc_list_projects_response.rbs

@@ -0,0 +1,19 @@
+module Scalar
+  module Models
+    type scalar_doc_list_projects_response =
+      { data: ::Array[Scalar::DocsProject], has_more: bool }
+
+    class ScalarDocListProjectsResponse < Scalar::Internal::Type::BaseModel
+      attr_accessor data: ::Array[Scalar::DocsProject]
+
+      attr_accessor has_more: bool
+
+      def initialize: (
+        data: ::Array[Scalar::DocsProject],
+        has_more: bool
+      ) -> void
+
+      def to_hash: -> { data: ::Array[Scalar::DocsProject], has_more: bool }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/scalar_doc_publish_guide_params.rbs

@@ -0,0 +1,20 @@
+module Scalar
+  module Models
+    type scalar_doc_publish_guide_params =
+      { slug: String } & Scalar::Internal::Type::request_parameters
+
+    class ScalarDocPublishGuideParams < 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/scalar_doc_publish_guide_response.rbs

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

data/sig/scalar_api_ruby/models/scalar_doc_publish_project_params.rbs

@@ -0,0 +1,42 @@
+module Scalar
+  module Models
+    type scalar_doc_publish_project_params =
+      { slug: String, commit_sha: String, config_path: String, preview: bool }
+      & Scalar::Internal::Type::request_parameters
+
+    class ScalarDocPublishProjectParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor slug: String
+
+      attr_reader commit_sha: String?
+
+      def commit_sha=: (String) -> String
+
+      attr_reader config_path: String?
+
+      def config_path=: (String) -> String
+
+      attr_reader preview: bool?
+
+      def preview=: (bool) -> bool
+
+      def initialize: (
+        slug: String,
+        ?commit_sha: String,
+        ?config_path: String,
+        ?preview: bool,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        slug: String,
+        commit_sha: String,
+        config_path: String,
+        preview: bool,
+        request_options: Scalar::RequestOptions
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/scalar_doc_publish_project_response.rbs

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

data/sig/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rbs

@@ -0,0 +1,20 @@
+module Scalar
+  module Models
+    type scalar_doc_retrieve_project_params =
+      { slug: String } & Scalar::Internal::Type::request_parameters
+
+    class ScalarDocRetrieveProjectParams < 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/scalar_doc_update_project_config_params.rbs

@@ -0,0 +1,59 @@
+module Scalar
+  module Models
+    type scalar_doc_update_project_config_params =
+      {
+        slug: String,
+        content: String,
+        base_token: String,
+        message: String,
+        path: String,
+        ref: String
+      }
+      & Scalar::Internal::Type::request_parameters
+
+    class ScalarDocUpdateProjectConfigParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor slug: String
+
+      attr_accessor content: String
+
+      attr_reader base_token: String?
+
+      def base_token=: (String) -> String
+
+      attr_reader message: String?
+
+      def message=: (String) -> String
+
+      attr_reader path: String?
+
+      def path=: (String) -> String
+
+      attr_reader ref: String?
+
+      def ref=: (String) -> String
+
+      def initialize: (
+        slug: String,
+        content: String,
+        ?base_token: String,
+        ?message: String,
+        ?path: String,
+        ?ref: String,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        slug: String,
+        content: String,
+        base_token: String,
+        message: String,
+        path: String,
+        ref: String,
+        request_options: Scalar::RequestOptions
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/scalar_doc_update_project_config_response.rbs

@@ -0,0 +1,22 @@
+module Scalar
+  module Models
+    type scalar_doc_update_project_config_response =
+      { base_token: String, commit_sha: String?, ref: String }
+
+    class ScalarDocUpdateProjectConfigResponse < Scalar::Internal::Type::BaseModel
+      attr_accessor base_token: String
+
+      attr_accessor commit_sha: String?
+
+      attr_accessor ref: String
+
+      def initialize: (
+        base_token: String,
+        commit_sha: String?,
+        ref: String
+      ) -> void
+
+      def to_hash: -> { base_token: String, commit_sha: String?, ref: String }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/scalar_doc_update_project_params.rbs

@@ -0,0 +1,85 @@
+module Scalar
+  module Models
+    type scalar_doc_update_project_params =
+      {
+        slug: String,
+        access_groups: ::Array[String],
+        active_theme_id: String,
+        agent_enabled: bool,
+        analytics_enabled: bool,
+        is_private: bool,
+        login_portal_uid: Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid,
+        name: String
+      }
+      & Scalar::Internal::Type::request_parameters
+
+    class ScalarDocUpdateProjectParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor slug: String
+
+      attr_reader access_groups: ::Array[String]?
+
+      def access_groups=: (::Array[String]) -> ::Array[String]
+
+      attr_reader active_theme_id: String?
+
+      def active_theme_id=: (String) -> String
+
+      attr_reader agent_enabled: bool?
+
+      def agent_enabled=: (bool) -> bool
+
+      attr_reader analytics_enabled: bool?
+
+      def analytics_enabled=: (bool) -> bool
+
+      attr_reader is_private: bool?
+
+      def is_private=: (bool) -> bool
+
+      attr_reader login_portal_uid: Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid?
+
+      def login_portal_uid=: (
+        Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid
+      ) -> Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid
+
+      attr_reader name: String?
+
+      def name=: (String) -> String
+
+      def initialize: (
+        slug: String,
+        ?access_groups: ::Array[String],
+        ?active_theme_id: String,
+        ?agent_enabled: bool,
+        ?analytics_enabled: bool,
+        ?is_private: bool,
+        ?login_portal_uid: Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid,
+        ?name: String,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        slug: String,
+        access_groups: ::Array[String],
+        active_theme_id: String,
+        agent_enabled: bool,
+        analytics_enabled: bool,
+        is_private: bool,
+        login_portal_uid: Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid,
+        name: String,
+        request_options: Scalar::RequestOptions
+      }
+
+      type login_portal_uid = String | :""
+
+      module LoginPortalUID
+        extend Scalar::Internal::Type::Union
+
+        def self?.variants: -> ::Array[Scalar::Models::ScalarDocUpdateProjectParams::login_portal_uid]
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/models/schema.rbs

@@ -0,0 +1,50 @@
+module Scalar
+  module Models
+    type schema =
+      {
+        description: String,
+        is_private: bool,
+        namespace: String,
+        slug: String,
+        title: String,
+        uid: String,
+        versions: ::Array[Scalar::ManagedSchemaVersion]
+      }
+
+    class Schema < Scalar::Internal::Type::BaseModel
+      attr_accessor description: String
+
+      attr_accessor is_private: bool
+
+      attr_accessor namespace: String
+
+      attr_accessor slug: String
+
+      attr_accessor title: String
+
+      attr_accessor uid: String
+
+      attr_accessor versions: ::Array[Scalar::ManagedSchemaVersion]
+
+      def initialize: (
+        description: String,
+        is_private: bool,
+        namespace: String,
+        slug: String,
+        title: String,
+        uid: String,
+        versions: ::Array[Scalar::ManagedSchemaVersion]
+      ) -> void
+
+      def to_hash: -> {
+        description: String,
+        is_private: bool,
+        namespace: String,
+        slug: String,
+        title: String,
+        uid: String,
+        versions: ::Array[Scalar::ManagedSchemaVersion]
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/schema_create_params.rbs

@@ -0,0 +1,60 @@
+module Scalar
+  module Models
+    type schema_create_params =
+      {
+        namespace: String,
+        document: String,
+        slug: String,
+        title: String,
+        version: String,
+        description: String,
+        is_private: bool
+      }
+      & Scalar::Internal::Type::request_parameters
+
+    class SchemaCreateParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor namespace: String
+
+      attr_accessor document: String
+
+      attr_accessor slug: String
+
+      attr_accessor title: String
+
+      attr_accessor version: String
+
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      attr_reader is_private: bool?
+
+      def is_private=: (bool) -> bool
+
+      def initialize: (
+        namespace: String,
+        document: String,
+        slug: String,
+        title: String,
+        version: String,
+        ?description: String,
+        ?is_private: bool,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        namespace: String,
+        document: String,
+        slug: String,
+        title: String,
+        version: String,
+        description: String,
+        is_private: bool,
+        request_options: Scalar::RequestOptions
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/schema_delete_params.rbs

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

data/sig/scalar_api_ruby/models/schema_list_params.rbs

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

data/sig/scalar_api_ruby/models/schema_list_response.rbs

@@ -0,0 +1,7 @@
+module Scalar
+  module Models
+    type schema_list_response = ::Array[Scalar::Schema]
+
+    SchemaListResponse: Scalar::Internal::Type::Converter
+  end
+end

data/sig/scalar_api_ruby/models/schema_update_params.rbs

@@ -0,0 +1,52 @@
+module Scalar
+  module Models
+    type schema_update_params =
+      {
+        namespace: String,
+        slug: String,
+        description: String,
+        is_private: bool,
+        title: String
+      }
+      & Scalar::Internal::Type::request_parameters
+
+    class SchemaUpdateParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor namespace: String
+
+      attr_accessor slug: String
+
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      attr_reader is_private: bool?
+
+      def is_private=: (bool) -> bool
+
+      attr_reader title: String?
+
+      def title=: (String) -> String
+
+      def initialize: (
+        namespace: String,
+        slug: String,
+        ?description: String,
+        ?is_private: bool,
+        ?title: String,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        namespace: String,
+        slug: String,
+        description: String,
+        is_private: bool,
+        title: String,
+        request_options: Scalar::RequestOptions
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/schemas/access_group_create_params.rbs

@@ -0,0 +1,34 @@
+module Scalar
+  module Models
+    module Schemas
+      type access_group_create_params =
+        { namespace: String, slug: String }
+        & Scalar::Internal::Type::request_parameters
+
+      class AccessGroupCreateParams < Scalar::Models::AccessGroup
+        extend Scalar::Internal::Type::RequestParameters::Converter
+        include Scalar::Internal::Type::RequestParameters
+
+        def namespace: -> String
+
+        def namespace=: (String _) -> String
+
+        def slug: -> String
+
+        def slug=: (String _) -> String
+
+        def initialize: (
+          namespace: String,
+          slug: String,
+          ?request_options: Scalar::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          namespace: String,
+          slug: String,
+          request_options: Scalar::RequestOptions
+        }
+      end
+    end
+  end
+end