scalar_api_ruby 0.2.0

data/sig/scalar_api_ruby/internal/util.rbs

@@ -0,0 +1,199 @@
+module Scalar
+  module Internal
+    module Util
+      extend Scalar::Internal::Util::SorbetRuntimeSupport
+
+      def self?.monotonic_secs: -> Float
+
+      def self?.walk_namespaces: (
+        Module | Class ns
+      ) -> Enumerable[(Module | Class)]
+
+      def self?.arch: -> String
+
+      def self?.os: -> String
+
+      def self?.primitive?: (top input) -> bool
+
+      def self?.coerce_boolean: (String | bool input) -> (bool | top)
+
+      def self?.coerce_boolean!: (String | bool input) -> bool?
+
+      def self?.coerce_integer: (String | Integer input) -> (Integer | top)
+
+      def self?.coerce_float: (String | Integer | Float input) -> (Float | top)
+
+      def self?.coerce_hash: (top input) -> (::Hash[top, top] | top)
+
+      def self?.coerce_hash!: (top input) -> ::Hash[top, top]?
+
+      def self?.deep_merge_lr: (top lhs, top rhs, ?concat: bool) -> top
+
+      def self?.deep_merge: (
+        *::Array[top] values,
+        ?sentinel: top?,
+        ?concat: bool
+      ) -> top
+
+      def self?.dig: (
+        ::Hash[Symbol, top] | ::Array[top] | top data,
+        (Symbol
+        | Integer
+        | ::Array[(Symbol | Integer)]
+        | (^(top arg0) -> top))? pick
+      ) {
+        -> top?
+      } -> top?
+
+      RFC_3986_NOT_PCHARS: Regexp
+
+      def self?.uri_origin: (URI::Generic uri) -> String
+
+      def self?.encode_path: (String | Integer path) -> String
+
+      def self?.interpolate_path: (String | ::Array[String] path) -> String
+
+      def self?.decode_query: (String? query) -> ::Hash[String, ::Array[String]]
+
+      def self?.encode_query: (
+        ::Hash[String, (::Array[String] | String)?]? query
+      ) -> String?
+
+      type parsed_uri =
+        {
+          scheme: String?,
+          host: String?,
+          port: Integer?,
+          path: String?,
+          query: ::Hash[String, ::Array[String]]
+        }
+
+      def self?.parse_uri: (
+        URI::Generic | String url
+      ) -> Scalar::Internal::Util::parsed_uri
+
+      def self?.unparse_uri: (
+        Scalar::Internal::Util::parsed_uri parsed
+      ) -> URI::Generic
+
+      def self?.join_parsed_uri: (
+        Scalar::Internal::Util::parsed_uri lhs,
+        Scalar::Internal::Util::parsed_uri rhs
+      ) -> URI::Generic
+
+      def self?.normalized_headers: (
+        *::Hash[String, (String
+        | Integer
+        | ::Array[(String | Integer)?])?] headers
+      ) -> ::Hash[String, String]
+
+      class ReadIOAdapter
+        def close?: -> bool?
+
+        def close: -> void
+
+        private def read_enum: (Integer? max_len) -> String
+
+        def read: (?Integer? max_len, ?String? out_string) -> String?
+
+        def initialize: (
+          String | Pathname | StringIO | Enumerable[String] src
+        ) {
+          (String arg0) -> void
+        } -> void
+      end
+
+      def self?.writable_enum: {
+        (Enumerator::Yielder y) -> void
+      } -> Enumerable[String]
+
+      JSON_CONTENT: Regexp
+      JSONL_CONTENT: Regexp
+
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
+      def self?.write_multipart_content: (
+        Enumerator::Yielder y,
+        val: top,
+        closing: ::Array[^-> void],
+        ?content_type: String?
+      ) -> void
+
+      def self?.write_multipart_chunk: (
+        Enumerator::Yielder y,
+        boundary: String,
+        key: Symbol | String,
+        val: top,
+        closing: ::Array[^-> void]
+      ) -> void
+
+      def self?.encode_multipart_streaming: (
+        top body
+      ) -> [String, Enumerable[String]]
+
+      def self?.encode_content: (
+        ::Hash[String, String] headers,
+        top body
+      ) -> top
+
+      def self?.force_charset!: (String content_type, text: String) -> void
+
+      def self?.decode_content: (
+        ::Hash[String, String] headers,
+        stream: Enumerable[String],
+        ?suppress_error: bool
+      ) -> top
+
+      def self?.fused_enum: (
+        Enumerable[top] enum,
+        ?external: bool
+      ) {
+        -> void
+      } -> Enumerable[top]
+
+      def self?.close_fused!: (Enumerable[top]? enum) -> void
+
+      def self?.chain_fused: (
+        Enumerable[top]? enum
+      ) {
+        (Enumerator::Yielder arg0) -> void
+      } -> Enumerable[top]
+
+      type server_sent_event =
+        { event: String?, data: String?, id: String?, retry: Integer? }
+
+      def self?.decode_lines: (Enumerable[String] enum) -> Enumerable[String]
+
+      def self?.decode_sse: (
+        Enumerable[String] lines
+      ) -> Enumerable[Scalar::Internal::Util::server_sent_event]
+
+      module SorbetRuntimeSupport
+        class MissingSorbetRuntimeError < ::RuntimeError
+        end
+
+        private def sorbet_runtime_constants: -> ::Hash[Symbol, top]
+
+        def const_missing: (Symbol name) -> void
+
+        def sorbet_constant_defined?: (Symbol name) -> bool
+
+        def define_sorbet_constant!: (Symbol name) { -> top } -> void
+
+        def to_sorbet_type: -> top
+
+        def self.to_sorbet_type: (
+          Scalar::Internal::Util::SorbetRuntimeSupport | top `type`
+        ) -> top
+      end
+    end
+  end
+end

data/sig/scalar_api_ruby/internal.rbs

@@ -0,0 +1,9 @@
+module Scalar
+  module Internal
+    extend Scalar::Internal::Util::SorbetRuntimeSupport
+
+    type file_input = Pathname | StringIO | IO | String | Scalar::FilePart
+
+    OMIT: Object
+  end
+end

data/sig/scalar_api_ruby/models/400.rbs

@@ -0,0 +1,15 @@
+module Scalar
+  module Models
+    type value400 = { code: String, message: String }
+
+    class Value400 < Scalar::Internal::Type::BaseModel
+      attr_accessor code: String
+
+      attr_accessor message: String
+
+      def initialize: (code: String, message: String) -> void
+
+      def to_hash: -> { code: String, message: String }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/401.rbs

@@ -0,0 +1,15 @@
+module Scalar
+  module Models
+    type value401 = { code: String, message: String }
+
+    class Value401 < Scalar::Internal::Type::BaseModel
+      attr_accessor code: String
+
+      attr_accessor message: String
+
+      def initialize: (code: String, message: String) -> void
+
+      def to_hash: -> { code: String, message: String }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/403.rbs

@@ -0,0 +1,15 @@
+module Scalar
+  module Models
+    type value403 = { code: String, message: String }
+
+    class Value403 < Scalar::Internal::Type::BaseModel
+      attr_accessor code: String
+
+      attr_accessor message: String
+
+      def initialize: (code: String, message: String) -> void
+
+      def to_hash: -> { code: String, message: String }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/404.rbs

@@ -0,0 +1,15 @@
+module Scalar
+  module Models
+    type value404 = { code: String, message: String }
+
+    class Value404 < Scalar::Internal::Type::BaseModel
+      attr_accessor code: String
+
+      attr_accessor message: String
+
+      def initialize: (code: String, message: String) -> void
+
+      def to_hash: -> { code: String, message: String }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/422.rbs

@@ -0,0 +1,15 @@
+module Scalar
+  module Models
+    type value422 = { code: String, message: String }
+
+    class Value422 < Scalar::Internal::Type::BaseModel
+      attr_accessor code: String
+
+      attr_accessor message: String
+
+      def initialize: (code: String, message: String) -> void
+
+      def to_hash: -> { code: String, message: String }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/500.rbs

@@ -0,0 +1,15 @@
+module Scalar
+  module Models
+    type value500 = { code: String, message: String }
+
+    class Value500 < Scalar::Internal::Type::BaseModel
+      attr_accessor code: String
+
+      attr_accessor message: String
+
+      def initialize: (code: String, message: String) -> void
+
+      def to_hash: -> { code: String, message: String }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/access_group.rbs

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

data/sig/scalar_api_ruby/models/access_group_create_params.rbs

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

data/sig/scalar_api_ruby/models/access_group_create_response.rbs

@@ -0,0 +1,40 @@
+module Scalar
+  module Models
+    type access_group_create_response =
+      {
+        allowed_domains: String,
+        allowed_emails: String,
+        name: String,
+        slug: String,
+        uid: String
+      }
+
+    class AccessGroupCreateResponse < Scalar::Internal::Type::BaseModel
+      attr_accessor allowed_domains: String
+
+      attr_accessor allowed_emails: String
+
+      attr_accessor name: String
+
+      attr_accessor slug: String
+
+      attr_accessor uid: String
+
+      def initialize: (
+        allowed_domains: String,
+        allowed_emails: String,
+        name: String,
+        slug: String,
+        uid: String
+      ) -> void
+
+      def to_hash: -> {
+        allowed_domains: String,
+        allowed_emails: String,
+        name: String,
+        slug: String,
+        uid: String
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/access_group_delete_params.rbs

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

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

data/sig/scalar_api_ruby/models/access_group_retrieve_params.rbs

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

@@ -0,0 +1,40 @@
+module Scalar
+  module Models
+    type access_group_retrieve_response =
+      {
+        allowed_domains: String,
+        allowed_emails: String,
+        name: String,
+        slug: String,
+        uid: String
+      }
+
+    class AccessGroupRetrieveResponse < Scalar::Internal::Type::BaseModel
+      attr_accessor allowed_domains: String
+
+      attr_accessor allowed_emails: String
+
+      attr_accessor name: String
+
+      attr_accessor slug: String
+
+      attr_accessor uid: String
+
+      def initialize: (
+        allowed_domains: String,
+        allowed_emails: String,
+        name: String,
+        slug: String,
+        uid: String
+      ) -> void
+
+      def to_hash: -> {
+        allowed_domains: String,
+        allowed_emails: String,
+        name: String,
+        slug: String,
+        uid: String
+      }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/access_group_update_params.rbs

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

data/sig/scalar_api_ruby/models/access_groups/domain_create_params.rbs

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

data/sig/scalar_api_ruby/models/access_groups/domain_delete_params.rbs

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

data/sig/scalar_api_ruby/models/access_groups/email_domain.rbs

@@ -0,0 +1,7 @@
+module Scalar
+  module Models
+    module AccessGroups
+      class EmailDomain = String
+    end
+  end
+end

data/sig/scalar_api_ruby/models/active_deployment.rbs

@@ -0,0 +1,22 @@
+module Scalar
+  module Models
+    type active_deployment =
+      { domain: String, published_at: Integer, uid: String }
+
+    class ActiveDeployment < Scalar::Internal::Type::BaseModel
+      attr_accessor domain: String
+
+      attr_accessor published_at: Integer
+
+      attr_accessor uid: String
+
+      def initialize: (
+        domain: String,
+        published_at: Integer,
+        uid: String
+      ) -> void
+
+      def to_hash: -> { domain: String, published_at: Integer, uid: String }
+    end
+  end
+end

data/sig/scalar_api_ruby/models/api_document.rbs

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