scalar_api_ruby 0.2.0

data/lib/scalar_api_ruby/models/github_project.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    class GithubProject < Scalar::Internal::Type::BaseModel
+      # @!attribute access_groups
+      #
+      #   @return [String]
+      required :access_groups, String, api_name: :accessGroups
+
+      # @!attribute active_deployment
+      #
+      #   @return [Scalar::Models::ActiveDeployment, nil]
+      required :active_deployment, -> { Scalar::ActiveDeployment }, api_name: :activeDeployment, nil?: true
+
+      # @!attribute active_theme_id
+      #
+      #   @return [String]
+      required :active_theme_id, String, api_name: :activeThemeId
+
+      # @!attribute agent_enabled
+      #
+      #   @return [Boolean]
+      required :agent_enabled, Scalar::Internal::Type::Boolean, api_name: :agentEnabled
+
+      # @!attribute analytics_enabled
+      #
+      #   @return [Boolean]
+      required :analytics_enabled, Scalar::Internal::Type::Boolean, api_name: :analyticsEnabled
+
+      # @!attribute created_at
+      #
+      #   @return [Integer]
+      required :created_at, Integer, api_name: :createdAt
+
+      # @!attribute is_private
+      #
+      #   @return [Boolean]
+      required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate
+
+      # @!attribute last_published
+      #
+      #   @return [Integer, nil]
+      required :last_published, Integer, api_name: :lastPublished, nil?: true
+
+      # @!attribute last_published_uid
+      #
+      #   @return [String, nil]
+      required :last_published_uid, String, api_name: :lastPublishedUid, nil?: true
+
+      # @!attribute login_portal_uid
+      #
+      #   @return [String]
+      required :login_portal_uid, String, api_name: :loginPortalUid
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute publish_message
+      #
+      #   @return [String]
+      required :publish_message, String, api_name: :publishMessage
+
+      # @!attribute publish_status
+      #
+      #   @return [String]
+      required :publish_status, String, api_name: :publishStatus
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute uid
+      #
+      #   @return [String]
+      required :uid, String
+
+      # @!attribute updated_at
+      #
+      #   @return [Integer]
+      required :updated_at, Integer, api_name: :updatedAt
+
+      # @!attribute user_info_hook_url
+      #
+      #   @return [String]
+      required :user_info_hook_url, String, api_name: :userInfoHookUrl
+
+      # @!attribute repository
+      #
+      #   @return [Scalar::Models::GithubProjectRepository, nil]
+      optional :repository, -> { Scalar::GithubProjectRepository }, nil?: true
+
+      # @!attribute typesense_id
+      #
+      #   @return [Float, nil]
+      optional :typesense_id, Float, api_name: :typesenseId
+
+      # @!method initialize(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)
+      #   @param access_groups [String]
+      #   @param active_deployment [Scalar::Models::ActiveDeployment, nil]
+      #   @param active_theme_id [String]
+      #   @param agent_enabled [Boolean]
+      #   @param analytics_enabled [Boolean]
+      #   @param created_at [Integer]
+      #   @param is_private [Boolean]
+      #   @param last_published [Integer, nil]
+      #   @param last_published_uid [String, nil]
+      #   @param login_portal_uid [String]
+      #   @param name [String]
+      #   @param publish_message [String]
+      #   @param publish_status [String]
+      #   @param slug [String]
+      #   @param uid [String]
+      #   @param updated_at [Integer]
+      #   @param user_info_hook_url [String]
+      #   @param repository [Scalar::Models::GithubProjectRepository, nil]
+      #   @param typesense_id [Float]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/github_project_repository.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    class GithubProjectRepository < Scalar::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [Float]
+      required :id, Float
+
+      # @!attribute branch
+      #
+      #   @return [String]
+      required :branch, String
+
+      # @!attribute config_path
+      #
+      #   @return [String]
+      required :config_path, String, api_name: :configPath
+
+      # @!attribute expired
+      #
+      #   @return [Boolean]
+      required :expired, Scalar::Internal::Type::Boolean
+
+      # @!attribute linked_by
+      #
+      #   @return [String]
+      required :linked_by, String, api_name: :linkedBy
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute pr_comments
+      #
+      #   @return [Boolean]
+      required :pr_comments, Scalar::Internal::Type::Boolean, api_name: :prComments
+
+      # @!attribute publish_on_merge
+      #
+      #   @return [Boolean]
+      required :publish_on_merge, Scalar::Internal::Type::Boolean, api_name: :publishOnMerge
+
+      # @!attribute publish_previews
+      #
+      #   @return [Boolean]
+      required :publish_previews, Scalar::Internal::Type::Boolean, api_name: :publishPreviews
+
+      # @!method initialize(id:, branch:, config_path:, expired:, linked_by:, name:, pr_comments:, publish_on_merge:, publish_previews:)
+      #   @param id [Float]
+      #   @param branch [String]
+      #   @param config_path [String]
+      #   @param expired [Boolean]
+      #   @param linked_by [String]
+      #   @param name [String]
+      #   @param pr_comments [Boolean]
+      #   @param publish_on_merge [Boolean]
+      #   @param publish_previews [Boolean]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/login_portal.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    class LoginPortal < Scalar::Internal::Type::BaseModel
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute title
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute uid
+      #
+      #   @return [String]
+      required :uid, String
+
+      # @!method initialize(slug:, title:, uid:)
+      #   @param slug [String]
+      #   @param title [String]
+      #   @param uid [String]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/login_portal_create_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::LoginPortals#create
+    class LoginPortalCreateParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute email
+      #
+      #   @return [Scalar::Models::LoginPortalEmail]
+      required :email, -> { Scalar::LoginPortalEmail }
+
+      # @!attribute page
+      #
+      #   @return [Scalar::Models::LoginPortalPage]
+      required :page, -> { Scalar::LoginPortalPage }
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute title
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!method initialize(email:, page:, slug:, title:, request_options: {})
+      #   @param email [Scalar::Models::LoginPortalEmail]
+      #   @param page [Scalar::Models::LoginPortalPage]
+      #   @param slug [String]
+      #   @param title [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/login_portal_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::LoginPortals#delete
+    class LoginPortalDeleteParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!method initialize(slug:, request_options: {})
+      #   @param slug [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/login_portal_email.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    class LoginPortalEmail < Scalar::Internal::Type::BaseModel
+      # @!attribute button_background
+      #
+      #   @return [String]
+      required :button_background, String, api_name: :buttonBackground
+
+      # @!attribute button_color
+      #
+      #   @return [String]
+      required :button_color, String, api_name: :buttonColor
+
+      # @!attribute button_text
+      #
+      #   @return [String]
+      required :button_text, String, api_name: :buttonText
+
+      # @!attribute card_background
+      #
+      #   @return [String]
+      required :card_background, String, api_name: :cardBackground
+
+      # @!attribute card_color
+      #
+      #   @return [String]
+      required :card_color, String, api_name: :cardColor
+
+      # @!attribute logo
+      #
+      #   @return [String]
+      required :logo, String
+
+      # @!attribute logo_size
+      #
+      #   @return [String]
+      required :logo_size, String, api_name: :logoSize
+
+      # @!attribute main_background
+      #
+      #   @return [String]
+      required :main_background, String, api_name: :mainBackground
+
+      # @!attribute main_color
+      #
+      #   @return [String]
+      required :main_color, String, api_name: :mainColor
+
+      # @!attribute message
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!attribute title
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!method initialize(button_background:, button_color:, button_text:, card_background:, card_color:, logo:, logo_size:, main_background:, main_color:, message:, title:)
+      #   @param button_background [String]
+      #   @param button_color [String]
+      #   @param button_text [String]
+      #   @param card_background [String]
+      #   @param card_color [String]
+      #   @param logo [String]
+      #   @param logo_size [String]
+      #   @param main_background [String]
+      #   @param main_color [String]
+      #   @param message [String]
+      #   @param title [String]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/login_portal_list_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::LoginPortals#list
+    class LoginPortalListParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/login_portal_list_response.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @type [Scalar::Internal::Type::Converter]
+    LoginPortalListResponse = Scalar::Internal::Type::ArrayOf[-> { Scalar::LoginPortal }]
+  end
+end

data/lib/scalar_api_ruby/models/login_portal_page.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    class LoginPortalPage < Scalar::Internal::Type::BaseModel
+      # @!attribute company_name
+      #
+      #   @return [String]
+      required :company_name, String, api_name: :companyName
+
+      # @!attribute description
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute favicon
+      #
+      #   @return [String]
+      required :favicon, String
+
+      # @!attribute form_description
+      #
+      #   @return [String]
+      required :form_description, String, api_name: :formDescription
+
+      # @!attribute form_image
+      #
+      #   @return [String]
+      required :form_image, String, api_name: :formImage
+
+      # @!attribute form_title
+      #
+      #   @return [String]
+      required :form_title, String, api_name: :formTitle
+
+      # @!attribute head
+      #
+      #   @return [String]
+      required :head, String
+
+      # @!attribute logo
+      #
+      #   @return [String]
+      required :logo, String
+
+      # @!attribute logo_url
+      #
+      #   @return [String]
+      required :logo_url, String, api_name: :logoURL
+
+      # @!attribute privacy_link
+      #
+      #   @return [String]
+      required :privacy_link, String, api_name: :privacyLink
+
+      # @!attribute script
+      #
+      #   @return [String]
+      required :script, String
+
+      # @!attribute terms_link
+      #
+      #   @return [String]
+      required :terms_link, String, api_name: :termsLink
+
+      # @!attribute theme
+      #
+      #   @return [String]
+      required :theme, String
+
+      # @!attribute title
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!method initialize(company_name:, description:, favicon:, form_description:, form_image:, form_title:, head:, logo:, logo_url:, privacy_link:, script:, terms_link:, theme:, title:)
+      #   @param company_name [String]
+      #   @param description [String]
+      #   @param favicon [String]
+      #   @param form_description [String]
+      #   @param form_image [String]
+      #   @param form_title [String]
+      #   @param head [String]
+      #   @param logo [String]
+      #   @param logo_url [String]
+      #   @param privacy_link [String]
+      #   @param script [String]
+      #   @param terms_link [String]
+      #   @param theme [String]
+      #   @param title [String]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/login_portal_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::LoginPortals#retrieve
+    class LoginPortalRetrieveParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!method initialize(slug:, request_options: {})
+      #   @param slug [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/login_portal_retrieve_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::LoginPortals#retrieve
+    class LoginPortalRetrieveResponse < Scalar::Internal::Type::BaseModel
+      # @!attribute email
+      #
+      #   @return [Scalar::Models::LoginPortalEmail]
+      required :email, -> { Scalar::LoginPortalEmail }
+
+      # @!attribute page
+      #
+      #   @return [Scalar::Models::LoginPortalPage]
+      required :page, -> { Scalar::LoginPortalPage }
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute title
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute uid
+      #
+      #   @return [String]
+      required :uid, String
+
+      # @!method initialize(email:, page:, slug:, title:, uid:)
+      #   @param email [Scalar::Models::LoginPortalEmail]
+      #   @param page [Scalar::Models::LoginPortalPage]
+      #   @param slug [String]
+      #   @param title [String]
+      #   @param uid [String]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/login_portal_update_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::LoginPortals#update
+    class LoginPortalUpdateParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute title
+      #
+      #   @return [String, nil]
+      optional :title, String
+
+      # @!method initialize(slug:, title: nil, request_options: {})
+      #   @param slug [String]
+      #   @param title [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/managed_doc_version.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    class ManagedDocVersion < Scalar::Internal::Type::BaseModel
+      # @!attribute created_at
+      #
+      #   @return [Float]
+      required :created_at, Float, api_name: :createdAt
+
+      # @!attribute embed_status
+      #
+      #   @return [Symbol, Scalar::Models::ManagedDocVersion::EmbedStatus, nil]
+      required :embed_status,
+               enum: -> { Scalar::ManagedDocVersion::EmbedStatus },
+               api_name: :embedStatus,
+               nil?: true
+
+      # @!attribute endpoint_count
+      #
+      #   @return [Integer, nil]
+      required :endpoint_count, Integer, api_name: :endpointCount, nil?: true
+
+      # @!attribute tags
+      #
+      #   @return [Array<String>]
+      required :tags, Scalar::Internal::Type::ArrayOf[String]
+
+      # @!attribute uid
+      #
+      #   @return [String]
+      required :uid, String
+
+      # @!attribute upgraded
+      #
+      #   @return [Boolean]
+      required :upgraded, Scalar::Internal::Type::Boolean
+
+      # @!attribute version
+      #
+      #   @return [String]
+      required :version, String
+
+      # @!attribute json_sha
+      #
+      #   @return [String, nil]
+      optional :json_sha, String, api_name: :jsonSha
+
+      # @!attribute tools
+      #
+      #   @return [Array<Scalar::Models::ManagedDocVersion::Tool>, nil]
+      optional :tools, -> { Scalar::Internal::Type::ArrayOf[Scalar::ManagedDocVersion::Tool] }
+
+      # @!attribute yaml_sha
+      #
+      #   @return [String, nil]
+      optional :yaml_sha, String, api_name: :yamlSha
+
+      # @!method initialize(created_at:, embed_status:, endpoint_count:, tags:, uid:, upgraded:, version:, json_sha: nil, tools: nil, yaml_sha: nil)
+      #   @param created_at [Float]
+      #   @param embed_status [Symbol, Scalar::Models::ManagedDocVersion::EmbedStatus, nil]
+      #   @param endpoint_count [Integer, nil]
+      #   @param tags [Array<String>]
+      #   @param uid [String]
+      #   @param upgraded [Boolean]
+      #   @param version [String]
+      #   @param json_sha [String]
+      #   @param tools [Array<Scalar::Models::ManagedDocVersion::Tool>]
+      #   @param yaml_sha [String]
+
+      # @see Scalar::Models::ManagedDocVersion#embed_status
+      module EmbedStatus
+        extend Scalar::Internal::Type::Enum
+
+        COMPLETE = :complete
+        FAILED = :failed
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Tool < Scalar::Internal::Type::BaseModel
+        # @!attribute enabled_tools
+        #
+        #   @return [Array<Symbol, Scalar::Models::ManagedDocVersion::Tool::EnabledTool>]
+        required :enabled_tools,
+                 -> { Scalar::Internal::Type::ArrayOf[enum: Scalar::ManagedDocVersion::Tool::EnabledTool] },
+                 api_name: :enabledTools
+
+        # @!attribute method_
+        #
+        #   @return [String]
+        required :method_, String, api_name: :method
+
+        # @!attribute path
+        #
+        #   @return [String]
+        required :path, String
+
+        # @!method initialize(enabled_tools:, method_:, path:)
+        #   @param enabled_tools [Array<Symbol, Scalar::Models::ManagedDocVersion::Tool::EnabledTool>]
+        #   @param method_ [String]
+        #   @param path [String]
+
+        module EnabledTool
+          extend Scalar::Internal::Type::Enum
+
+          EXECUTE_REQUEST = :"execute-request"
+          GET_MINI_OPENAPI_SPEC = :"get-mini-openapi-spec"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end