scalar_api_ruby 0.2.0

data/rbi/scalar_api_ruby/models/docs_project.rbi

@@ -0,0 +1,93 @@
+# typed: strong
+
+module Scalar
+  module Models
+    class DocsProject < Scalar::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Scalar::DocsProject, Scalar::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :access_groups
+
+      sig { returns(String) }
+      attr_accessor :active_theme_id
+
+      sig { returns(T::Boolean) }
+      attr_accessor :agent_enabled
+
+      sig { returns(T::Boolean) }
+      attr_accessor :analytics_enabled
+
+      sig { returns(T::Boolean) }
+      attr_accessor :is_private
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last_published
+
+      sig { returns(String) }
+      attr_accessor :login_portal_uid
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(String) }
+      attr_accessor :publish_status
+
+      sig { returns(String) }
+      attr_accessor :slug
+
+      sig { returns(String) }
+      attr_accessor :uid
+
+      sig do
+        params(
+          access_groups: String,
+          active_theme_id: String,
+          agent_enabled: T::Boolean,
+          analytics_enabled: T::Boolean,
+          is_private: T::Boolean,
+          last_published: T.nilable(Integer),
+          login_portal_uid: String,
+          name: String,
+          publish_status: String,
+          slug: String,
+          uid: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        access_groups:,
+        active_theme_id:,
+        agent_enabled:,
+        analytics_enabled:,
+        is_private:,
+        last_published:,
+        login_portal_uid:,
+        name:,
+        publish_status:,
+        slug:,
+        uid:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            access_groups: String,
+            active_theme_id: String,
+            agent_enabled: T::Boolean,
+            analytics_enabled: T::Boolean,
+            is_private: T::Boolean,
+            last_published: T.nilable(Integer),
+            login_portal_uid: String,
+            name: String,
+            publish_status: String,
+            slug: String,
+            uid: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/models/github_project.rbi

@@ -0,0 +1,158 @@
+# typed: strong
+
+module Scalar
+  module Models
+    class GithubProject < Scalar::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Scalar::GithubProject, Scalar::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :access_groups
+
+      sig { returns(T.nilable(Scalar::ActiveDeployment)) }
+      attr_reader :active_deployment
+
+      sig do
+        params(
+          active_deployment: T.nilable(Scalar::ActiveDeployment::OrHash)
+        ).void
+      end
+      attr_writer :active_deployment
+
+      sig { returns(String) }
+      attr_accessor :active_theme_id
+
+      sig { returns(T::Boolean) }
+      attr_accessor :agent_enabled
+
+      sig { returns(T::Boolean) }
+      attr_accessor :analytics_enabled
+
+      sig { returns(Integer) }
+      attr_accessor :created_at
+
+      sig { returns(T::Boolean) }
+      attr_accessor :is_private
+
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :last_published
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :last_published_uid
+
+      sig { returns(String) }
+      attr_accessor :login_portal_uid
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(String) }
+      attr_accessor :publish_message
+
+      sig { returns(String) }
+      attr_accessor :publish_status
+
+      sig { returns(String) }
+      attr_accessor :slug
+
+      sig { returns(String) }
+      attr_accessor :uid
+
+      sig { returns(Integer) }
+      attr_accessor :updated_at
+
+      sig { returns(String) }
+      attr_accessor :user_info_hook_url
+
+      sig { returns(T.nilable(Scalar::GithubProjectRepository)) }
+      attr_reader :repository
+
+      sig do
+        params(
+          repository: T.nilable(Scalar::GithubProjectRepository::OrHash)
+        ).void
+      end
+      attr_writer :repository
+
+      sig { returns(T.nilable(Float)) }
+      attr_reader :typesense_id
+
+      sig { params(typesense_id: Float).void }
+      attr_writer :typesense_id
+
+      sig do
+        params(
+          access_groups: String,
+          active_deployment: T.nilable(Scalar::ActiveDeployment::OrHash),
+          active_theme_id: String,
+          agent_enabled: T::Boolean,
+          analytics_enabled: T::Boolean,
+          created_at: Integer,
+          is_private: T::Boolean,
+          last_published: T.nilable(Integer),
+          last_published_uid: T.nilable(String),
+          login_portal_uid: String,
+          name: String,
+          publish_message: String,
+          publish_status: String,
+          slug: String,
+          uid: String,
+          updated_at: Integer,
+          user_info_hook_url: String,
+          repository: T.nilable(Scalar::GithubProjectRepository::OrHash),
+          typesense_id: Float
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        access_groups:,
+        active_deployment:,
+        active_theme_id:,
+        agent_enabled:,
+        analytics_enabled:,
+        created_at:,
+        is_private:,
+        last_published:,
+        last_published_uid:,
+        login_portal_uid:,
+        name:,
+        publish_message:,
+        publish_status:,
+        slug:,
+        uid:,
+        updated_at:,
+        user_info_hook_url:,
+        repository: nil,
+        typesense_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            access_groups: String,
+            active_deployment: T.nilable(Scalar::ActiveDeployment),
+            active_theme_id: String,
+            agent_enabled: T::Boolean,
+            analytics_enabled: T::Boolean,
+            created_at: Integer,
+            is_private: T::Boolean,
+            last_published: T.nilable(Integer),
+            last_published_uid: T.nilable(String),
+            login_portal_uid: String,
+            name: String,
+            publish_message: String,
+            publish_status: String,
+            slug: String,
+            uid: String,
+            updated_at: Integer,
+            user_info_hook_url: String,
+            repository: T.nilable(Scalar::GithubProjectRepository),
+            typesense_id: Float
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/models/github_project_repository.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module Scalar
+  module Models
+    class GithubProjectRepository < Scalar::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Scalar::GithubProjectRepository, Scalar::Internal::AnyHash)
+        end
+
+      sig { returns(Float) }
+      attr_accessor :id
+
+      sig { returns(String) }
+      attr_accessor :branch
+
+      sig { returns(String) }
+      attr_accessor :config_path
+
+      sig { returns(T::Boolean) }
+      attr_accessor :expired
+
+      sig { returns(String) }
+      attr_accessor :linked_by
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      sig { returns(T::Boolean) }
+      attr_accessor :pr_comments
+
+      sig { returns(T::Boolean) }
+      attr_accessor :publish_on_merge
+
+      sig { returns(T::Boolean) }
+      attr_accessor :publish_previews
+
+      sig do
+        params(
+          id: Float,
+          branch: String,
+          config_path: String,
+          expired: T::Boolean,
+          linked_by: String,
+          name: String,
+          pr_comments: T::Boolean,
+          publish_on_merge: T::Boolean,
+          publish_previews: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        branch:,
+        config_path:,
+        expired:,
+        linked_by:,
+        name:,
+        pr_comments:,
+        publish_on_merge:,
+        publish_previews:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: Float,
+            branch: String,
+            config_path: String,
+            expired: T::Boolean,
+            linked_by: String,
+            name: String,
+            pr_comments: T::Boolean,
+            publish_on_merge: T::Boolean,
+            publish_previews: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/models/login_portal.rbi

@@ -0,0 +1,31 @@
+# typed: strong
+
+module Scalar
+  module Models
+    class LoginPortal < Scalar::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Scalar::LoginPortal, Scalar::Internal::AnyHash) }
+
+      sig { returns(String) }
+      attr_accessor :slug
+
+      sig { returns(String) }
+      attr_accessor :title
+
+      sig { returns(String) }
+      attr_accessor :uid
+
+      sig do
+        params(slug: String, title: String, uid: String).returns(
+          T.attached_class
+        )
+      end
+      def self.new(slug:, title:, uid:)
+      end
+
+      sig { override.returns({ slug: String, title: String, uid: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/models/login_portal_create_params.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module Scalar
+  module Models
+    class LoginPortalCreateParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Scalar::LoginPortalCreateParams, Scalar::Internal::AnyHash)
+        end
+
+      sig { returns(Scalar::LoginPortalEmail) }
+      attr_reader :email
+
+      sig { params(email: Scalar::LoginPortalEmail::OrHash).void }
+      attr_writer :email
+
+      sig { returns(Scalar::LoginPortalPage) }
+      attr_reader :page
+
+      sig { params(page: Scalar::LoginPortalPage::OrHash).void }
+      attr_writer :page
+
+      sig { returns(String) }
+      attr_accessor :slug
+
+      sig { returns(String) }
+      attr_accessor :title
+
+      sig do
+        params(
+          email: Scalar::LoginPortalEmail::OrHash,
+          page: Scalar::LoginPortalPage::OrHash,
+          slug: String,
+          title: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(email:, page:, slug:, title:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            email: Scalar::LoginPortalEmail,
+            page: Scalar::LoginPortalPage,
+            slug: String,
+            title: String,
+            request_options: Scalar::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/models/login_portal_delete_params.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Scalar
+  module Models
+    class LoginPortalDeleteParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Scalar::LoginPortalDeleteParams, Scalar::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :slug
+
+      sig do
+        params(
+          slug: String,
+          request_options: Scalar::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(slug:, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          { slug: String, request_options: Scalar::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/models/login_portal_email.rbi

@@ -0,0 +1,95 @@
+# typed: strong
+
+module Scalar
+  module Models
+    class LoginPortalEmail < Scalar::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Scalar::LoginPortalEmail, Scalar::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :button_background
+
+      sig { returns(String) }
+      attr_accessor :button_color
+
+      sig { returns(String) }
+      attr_accessor :button_text
+
+      sig { returns(String) }
+      attr_accessor :card_background
+
+      sig { returns(String) }
+      attr_accessor :card_color
+
+      sig { returns(String) }
+      attr_accessor :logo
+
+      sig { returns(String) }
+      attr_accessor :logo_size
+
+      sig { returns(String) }
+      attr_accessor :main_background
+
+      sig { returns(String) }
+      attr_accessor :main_color
+
+      sig { returns(String) }
+      attr_accessor :message
+
+      sig { returns(String) }
+      attr_accessor :title
+
+      sig do
+        params(
+          button_background: String,
+          button_color: String,
+          button_text: String,
+          card_background: String,
+          card_color: String,
+          logo: String,
+          logo_size: String,
+          main_background: String,
+          main_color: String,
+          message: String,
+          title: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        button_background:,
+        button_color:,
+        button_text:,
+        card_background:,
+        card_color:,
+        logo:,
+        logo_size:,
+        main_background:,
+        main_color:,
+        message:,
+        title:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            button_background: String,
+            button_color: String,
+            button_text: String,
+            card_background: String,
+            card_color: String,
+            logo: String,
+            logo_size: String,
+            main_background: String,
+            main_color: String,
+            message: String,
+            title: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/models/login_portal_list_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Scalar
+  module Models
+    class LoginPortalListParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Scalar::LoginPortalListParams, Scalar::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Scalar::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Scalar::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/scalar_api_ruby/models/login_portal_list_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module Scalar
+  module Models
+    LoginPortalListResponse =
+      T.let(
+        Scalar::Internal::Type::ArrayOf[Scalar::LoginPortal],
+        Scalar::Internal::Type::Converter
+      )
+  end
+end

data/rbi/scalar_api_ruby/models/login_portal_page.rbi

@@ -0,0 +1,113 @@
+# typed: strong
+
+module Scalar
+  module Models
+    class LoginPortalPage < Scalar::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Scalar::LoginPortalPage, Scalar::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :company_name
+
+      sig { returns(String) }
+      attr_accessor :description
+
+      sig { returns(String) }
+      attr_accessor :favicon
+
+      sig { returns(String) }
+      attr_accessor :form_description
+
+      sig { returns(String) }
+      attr_accessor :form_image
+
+      sig { returns(String) }
+      attr_accessor :form_title
+
+      sig { returns(String) }
+      attr_accessor :head
+
+      sig { returns(String) }
+      attr_accessor :logo
+
+      sig { returns(String) }
+      attr_accessor :logo_url
+
+      sig { returns(String) }
+      attr_accessor :privacy_link
+
+      sig { returns(String) }
+      attr_accessor :script
+
+      sig { returns(String) }
+      attr_accessor :terms_link
+
+      sig { returns(String) }
+      attr_accessor :theme
+
+      sig { returns(String) }
+      attr_accessor :title
+
+      sig do
+        params(
+          company_name: String,
+          description: String,
+          favicon: String,
+          form_description: String,
+          form_image: String,
+          form_title: String,
+          head: String,
+          logo: String,
+          logo_url: String,
+          privacy_link: String,
+          script: String,
+          terms_link: String,
+          theme: String,
+          title: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        company_name:,
+        description:,
+        favicon:,
+        form_description:,
+        form_image:,
+        form_title:,
+        head:,
+        logo:,
+        logo_url:,
+        privacy_link:,
+        script:,
+        terms_link:,
+        theme:,
+        title:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            company_name: String,
+            description: String,
+            favicon: String,
+            form_description: String,
+            form_image: String,
+            form_title: String,
+            head: String,
+            logo: String,
+            logo_url: String,
+            privacy_link: String,
+            script: String,
+            terms_link: String,
+            theme: String,
+            title: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end