scalar_api_ruby 0.2.0

data/sig/scalar_api_ruby/models/registry_update_api_document_version_params.rbs

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

data/sig/scalar_api_ruby/models/registry_update_api_document_version_response.rbs

@@ -0,0 +1,16 @@
+module Scalar
+  module Models
+    type registry_update_api_document_version_response =
+      { json_sha: String, yaml_sha: String }
+
+    class RegistryUpdateAPIDocumentVersionResponse < Scalar::Internal::Type::BaseModel
+      attr_accessor json_sha: String
+
+      attr_accessor yaml_sha: String
+
+      def initialize: (json_sha: String, yaml_sha: String) -> void
+
+      def to_hash: -> { json_sha: String, yaml_sha: String }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/rule.rbs

@@ -0,0 +1,45 @@
+module Scalar
+  module Models
+    type rule =
+      {
+        description: String,
+        is_private: bool,
+        namespace: String,
+        slug: String,
+        title: String,
+        uid: String
+      }
+
+    class Rule < 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
+
+      def initialize: (
+        description: String,
+        is_private: bool,
+        namespace: String,
+        slug: String,
+        title: String,
+        uid: String
+      ) -> void
+
+      def to_hash: -> {
+        description: String,
+        is_private: bool,
+        namespace: String,
+        slug: String,
+        title: String,
+        uid: String
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/rule_create_ruleset_access_group_params.rbs

@@ -0,0 +1,32 @@
+module Scalar
+  module Models
+    type rule_create_ruleset_access_group_params =
+      { namespace: String, slug: String }
+      & Scalar::Internal::Type::request_parameters
+
+    class RuleCreateRulesetAccessGroupParams < 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

data/sig/scalar_api_ruby/models/rule_create_ruleset_params.rbs

@@ -0,0 +1,55 @@
+module Scalar
+  module Models
+    type rule_create_ruleset_params =
+      {
+        namespace: String,
+        document: String,
+        slug: String,
+        title: String,
+        description: String,
+        is_private: bool
+      }
+      & Scalar::Internal::Type::request_parameters
+
+    class RuleCreateRulesetParams < 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_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,
+        ?description: String,
+        ?is_private: bool,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        namespace: String,
+        document: String,
+        slug: String,
+        title: String,
+        description: String,
+        is_private: bool,
+        request_options: Scalar::RequestOptions
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/rule_delete_ruleset_access_group_params.rbs

@@ -0,0 +1,32 @@
+module Scalar
+  module Models
+    type rule_delete_ruleset_access_group_params =
+      { namespace: String, slug: String }
+      & Scalar::Internal::Type::request_parameters
+
+    class RuleDeleteRulesetAccessGroupParams < 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

data/sig/scalar_api_ruby/models/rule_delete_ruleset_params.rbs

@@ -0,0 +1,28 @@
+module Scalar
+  module Models
+    type rule_delete_ruleset_params =
+      { namespace: String, slug: String }
+      & Scalar::Internal::Type::request_parameters
+
+    class RuleDeleteRulesetParams < 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/rule_list_rulesets_params.rbs

@@ -0,0 +1,23 @@
+module Scalar
+  module Models
+    type rule_list_rulesets_params =
+      { namespace: String } & Scalar::Internal::Type::request_parameters
+
+    class RuleListRulesetsParams < 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/rule_list_rulesets_response.rbs

@@ -0,0 +1,7 @@
+module Scalar
+  module Models
+    type rule_list_rulesets_response = ::Array[Scalar::Rule]
+
+    RuleListRulesetsResponse: Scalar::Internal::Type::Converter
+  end
+end

data/sig/scalar_api_ruby/models/rule_retrieve_ruleset_document_params.rbs

@@ -0,0 +1,28 @@
+module Scalar
+  module Models
+    type rule_retrieve_ruleset_document_params =
+      { namespace: String, slug: String }
+      & Scalar::Internal::Type::request_parameters
+
+    class RuleRetrieveRulesetDocumentParams < 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/rule_retrieve_ruleset_document_response.rbs

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

data/sig/scalar_api_ruby/models/rule_update_ruleset_params.rbs

@@ -0,0 +1,66 @@
+module Scalar
+  module Models
+    type rule_update_ruleset_params =
+      {
+        path_namespace: String,
+        path_slug: String,
+        description: String,
+        is_private: bool,
+        body_namespace: String,
+        body_slug: String,
+        title: String
+      }
+      & Scalar::Internal::Type::request_parameters
+
+    class RuleUpdateRulesetParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor path_namespace: String
+
+      attr_accessor path_slug: String
+
+      attr_reader description: String?
+
+      def description=: (String) -> String
+
+      attr_reader is_private: bool?
+
+      def is_private=: (bool) -> bool
+
+      attr_reader body_namespace: String?
+
+      def body_namespace=: (String) -> String
+
+      attr_reader body_slug: String?
+
+      def body_slug=: (String) -> String
+
+      attr_reader title: String?
+
+      def title=: (String) -> String
+
+      def initialize: (
+        path_namespace: String,
+        path_slug: String,
+        ?description: String,
+        ?is_private: bool,
+        ?body_namespace: String,
+        ?body_slug: String,
+        ?title: String,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        path_namespace: String,
+        path_slug: String,
+        description: String,
+        is_private: bool,
+        body_namespace: String,
+        body_slug: String,
+        title: String,
+        request_options: Scalar::RequestOptions
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/scalar_doc_create_guide_params.rbs

@@ -0,0 +1,48 @@
+module Scalar
+  module Models
+    type scalar_doc_create_guide_params =
+      {
+        allowed_domains: ::Array[String],
+        allowed_users: ::Array[String],
+        is_private: bool,
+        name: String,
+        slug: String
+      }
+      & Scalar::Internal::Type::request_parameters
+
+    class ScalarDocCreateGuideParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor allowed_domains: ::Array[String]
+
+      attr_accessor allowed_users: ::Array[String]
+
+      attr_accessor is_private: bool
+
+      attr_accessor name: String
+
+      attr_reader slug: String?
+
+      def slug=: (String) -> String
+
+      def initialize: (
+        allowed_domains: ::Array[String],
+        allowed_users: ::Array[String],
+        is_private: bool,
+        name: String,
+        ?slug: String,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        allowed_domains: ::Array[String],
+        allowed_users: ::Array[String],
+        is_private: bool,
+        name: String,
+        slug: String,
+        request_options: Scalar::RequestOptions
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/scalar_doc_create_guide_response.rbs

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

data/sig/scalar_api_ruby/models/scalar_doc_create_project_params.rbs

@@ -0,0 +1,106 @@
+module Scalar
+  module Models
+    type scalar_doc_create_project_params =
+      {
+        name: String,
+        provider: Scalar::Models::ScalarDocCreateProjectParams::provider,
+        bitbucket_repository: Scalar::ScalarDocCreateProjectParams::BitbucketRepository,
+        blank: bool,
+        github_repository: Scalar::ScalarDocCreateProjectParams::GithubRepository,
+        is_private: bool,
+        slug: String
+      }
+      & Scalar::Internal::Type::request_parameters
+
+    class ScalarDocCreateProjectParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      attr_accessor name: String
+
+      attr_accessor provider: Scalar::Models::ScalarDocCreateProjectParams::provider
+
+      attr_reader bitbucket_repository: Scalar::ScalarDocCreateProjectParams::BitbucketRepository?
+
+      def bitbucket_repository=: (
+        Scalar::ScalarDocCreateProjectParams::BitbucketRepository
+      ) -> Scalar::ScalarDocCreateProjectParams::BitbucketRepository
+
+      attr_reader blank: bool?
+
+      def blank=: (bool) -> bool
+
+      attr_reader github_repository: Scalar::ScalarDocCreateProjectParams::GithubRepository?
+
+      def github_repository=: (
+        Scalar::ScalarDocCreateProjectParams::GithubRepository
+      ) -> Scalar::ScalarDocCreateProjectParams::GithubRepository
+
+      attr_reader is_private: bool?
+
+      def is_private=: (bool) -> bool
+
+      attr_reader slug: String?
+
+      def slug=: (String) -> String
+
+      def initialize: (
+        name: String,
+        provider: Scalar::Models::ScalarDocCreateProjectParams::provider,
+        ?bitbucket_repository: Scalar::ScalarDocCreateProjectParams::BitbucketRepository,
+        ?blank: bool,
+        ?github_repository: Scalar::ScalarDocCreateProjectParams::GithubRepository,
+        ?is_private: bool,
+        ?slug: String,
+        ?request_options: Scalar::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        name: String,
+        provider: Scalar::Models::ScalarDocCreateProjectParams::provider,
+        bitbucket_repository: Scalar::ScalarDocCreateProjectParams::BitbucketRepository,
+        blank: bool,
+        github_repository: Scalar::ScalarDocCreateProjectParams::GithubRepository,
+        is_private: bool,
+        slug: String,
+        request_options: Scalar::RequestOptions
+      }
+
+      type provider = :forgejo | :github | :bitbucket
+
+      module Provider
+        extend Scalar::Internal::Type::Enum
+
+        FORGEJO: :forgejo
+        GITHUB: :github
+        BITBUCKET: :bitbucket
+
+        def self?.values: -> ::Array[Scalar::Models::ScalarDocCreateProjectParams::provider]
+      end
+
+      type bitbucket_repository = { repo_uuid: String, workspace_uuid: String }
+
+      class BitbucketRepository < Scalar::Internal::Type::BaseModel
+        attr_accessor repo_uuid: String
+
+        attr_accessor workspace_uuid: String
+
+        def initialize: (repo_uuid: String, workspace_uuid: String) -> void
+
+        def to_hash: -> { repo_uuid: String, workspace_uuid: String }
+      end
+
+      type github_repository = { installation_id: Integer, repo_id: Integer }
+
+      class GithubRepository < Scalar::Internal::Type::BaseModel
+        attr_accessor installation_id: Integer
+
+        attr_accessor repo_id: Integer
+
+        def initialize: (installation_id: Integer, repo_id: Integer) -> void
+
+        def to_hash: -> { installation_id: Integer, repo_id: Integer }
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/models/scalar_doc_delete_project_params.rbs

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

@@ -0,0 +1,15 @@
+module Scalar
+  module Models
+    type scalar_doc_list_guides_params =
+      {  } & Scalar::Internal::Type::request_parameters
+
+    class ScalarDocListGuidesParams < 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/scalar_doc_list_guides_response.rbs

@@ -0,0 +1,7 @@
+module Scalar
+  module Models
+    type scalar_doc_list_guides_response = ::Array[Scalar::GithubProject]
+
+    ScalarDocListGuidesResponse: Scalar::Internal::Type::Converter
+  end
+end

data/sig/scalar_api_ruby/models/scalar_doc_list_project_config_params.rbs

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

data/sig/scalar_api_ruby/models/scalar_doc_list_project_config_response.rbs

@@ -0,0 +1,30 @@
+module Scalar
+  module Models
+    type scalar_doc_list_project_config_response =
+      { base_token: String, content: String, path: String, ref: String }
+
+    class ScalarDocListProjectConfigResponse < Scalar::Internal::Type::BaseModel
+      attr_accessor base_token: String
+
+      attr_accessor content: String
+
+      attr_accessor path: String
+
+      attr_accessor ref: String
+
+      def initialize: (
+        base_token: String,
+        content: String,
+        path: String,
+        ref: String
+      ) -> void
+
+      def to_hash: -> {
+        base_token: String,
+        content: String,
+        path: String,
+        ref: String
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/scalar_doc_list_project_domain_params.rbs

@@ -0,0 +1,20 @@
+module Scalar
+  module Models
+    type scalar_doc_list_project_domain_params =
+      { slug: String } & Scalar::Internal::Type::request_parameters
+
+    class ScalarDocListProjectDomainParams < 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