scalar_api_ruby 0.2.0

data/lib/scalar_api_ruby/models/scalar_doc_publish_guide_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::ScalarDocs#publish_guide
+    class ScalarDocPublishGuideParams < 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/scalar_doc_publish_guide_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::ScalarDocs#publish_guide
+    class ScalarDocPublishGuideResponse < Scalar::Internal::Type::BaseModel
+      # @!attribute publish_uid
+      #
+      #   @return [String]
+      required :publish_uid, String, api_name: :publishUid
+
+      # @!method initialize(publish_uid:)
+      #   @param publish_uid [String]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/scalar_doc_publish_project_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::ScalarDocs#publish_project
+    class ScalarDocPublishProjectParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute commit_sha
+      #
+      #   @return [String, nil]
+      optional :commit_sha, String, api_name: :commitSha
+
+      # @!attribute config_path
+      #
+      #   @return [String, nil]
+      optional :config_path, String, api_name: :configPath
+
+      # @!attribute preview
+      #
+      #   @return [Boolean, nil]
+      optional :preview, Scalar::Internal::Type::Boolean
+
+      # @!method initialize(slug:, commit_sha: nil, config_path: nil, preview: nil, request_options: {})
+      #   @param slug [String]
+      #   @param commit_sha [String]
+      #   @param config_path [String]
+      #   @param preview [Boolean]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/scalar_doc_publish_project_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::ScalarDocs#publish_project
+    class ScalarDocPublishProjectResponse < Scalar::Internal::Type::BaseModel
+      # @!attribute publish_uid
+      #
+      #   @return [String]
+      required :publish_uid, String, api_name: :publishUid
+
+      # @!method initialize(publish_uid:)
+      #   @param publish_uid [String]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/scalar_doc_retrieve_project_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::ScalarDocs#retrieve_project
+    class ScalarDocRetrieveProjectParams < 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/scalar_doc_update_project_config_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::ScalarDocs#update_project_config
+    class ScalarDocUpdateProjectConfigParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute content
+      #
+      #   @return [String]
+      required :content, String
+
+      # @!attribute base_token
+      #
+      #   @return [String, nil]
+      optional :base_token, String, api_name: :baseToken
+
+      # @!attribute message
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute path
+      #
+      #   @return [String, nil]
+      optional :path, String
+
+      # @!attribute ref
+      #
+      #   @return [String, nil]
+      optional :ref, String
+
+      # @!method initialize(slug:, content:, base_token: nil, message: nil, path: nil, ref: nil, request_options: {})
+      #   @param slug [String]
+      #   @param content [String]
+      #   @param base_token [String]
+      #   @param message [String]
+      #   @param path [String]
+      #   @param ref [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/scalar_doc_update_project_config_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::ScalarDocs#update_project_config
+    class ScalarDocUpdateProjectConfigResponse < Scalar::Internal::Type::BaseModel
+      # @!attribute base_token
+      #
+      #   @return [String]
+      required :base_token, String, api_name: :baseToken
+
+      # @!attribute commit_sha
+      #
+      #   @return [String, nil]
+      required :commit_sha, String, api_name: :commitSha, nil?: true
+
+      # @!attribute ref
+      #
+      #   @return [String]
+      required :ref, String
+
+      # @!method initialize(base_token:, commit_sha:, ref:)
+      #   @param base_token [String]
+      #   @param commit_sha [String, nil]
+      #   @param ref [String]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/scalar_doc_update_project_params.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::ScalarDocs#update_project
+    class ScalarDocUpdateProjectParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute access_groups
+      #
+      #   @return [Array<String>, nil]
+      optional :access_groups, Scalar::Internal::Type::ArrayOf[String], api_name: :accessGroups
+
+      # @!attribute active_theme_id
+      #
+      #   @return [String, nil]
+      optional :active_theme_id, String, api_name: :activeThemeId
+
+      # @!attribute agent_enabled
+      #
+      #   @return [Boolean, nil]
+      optional :agent_enabled, Scalar::Internal::Type::Boolean, api_name: :agentEnabled
+
+      # @!attribute analytics_enabled
+      #
+      #   @return [Boolean, nil]
+      optional :analytics_enabled, Scalar::Internal::Type::Boolean, api_name: :analyticsEnabled
+
+      # @!attribute is_private
+      #
+      #   @return [Boolean, nil]
+      optional :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate
+
+      # @!attribute login_portal_uid
+      #
+      #   @return [String, Symbol, nil]
+      optional :login_portal_uid,
+               union: -> { Scalar::ScalarDocUpdateProjectParams::LoginPortalUID },
+               api_name: :loginPortalUid
+
+      # @!attribute name
+      #
+      #   @return [String, nil]
+      optional :name, String
+
+      # @!method initialize(slug:, access_groups: nil, active_theme_id: nil, agent_enabled: nil, analytics_enabled: nil, is_private: nil, login_portal_uid: nil, name: nil, request_options: {})
+      #   @param slug [String]
+      #   @param access_groups [Array<String>]
+      #   @param active_theme_id [String]
+      #   @param agent_enabled [Boolean]
+      #   @param analytics_enabled [Boolean]
+      #   @param is_private [Boolean]
+      #   @param login_portal_uid [String, Symbol]
+      #   @param name [String]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+
+      module LoginPortalUID
+        extend Scalar::Internal::Type::Union
+
+        variant String
+
+        variant const: :""
+
+        # @!method self.variants
+        #   @return [Array(String, Symbol)]
+      end
+    end
+  end
+end

data/lib/scalar_api_ruby/models/schema.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    class Schema < Scalar::Internal::Type::BaseModel
+      # @!attribute description
+      #
+      #   @return [String]
+      required :description, String
+
+      # @!attribute is_private
+      #
+      #   @return [Boolean]
+      required :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate
+
+      # @!attribute namespace
+      #
+      #   @return [String]
+      required :namespace, String
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute title
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute uid
+      #
+      #   @return [String]
+      required :uid, String
+
+      # @!attribute versions
+      #
+      #   @return [Array<Scalar::Models::ManagedSchemaVersion>]
+      required :versions, -> { Scalar::Internal::Type::ArrayOf[Scalar::ManagedSchemaVersion] }
+
+      # @!method initialize(description:, is_private:, namespace:, slug:, title:, uid:, versions:)
+      #   @param description [String]
+      #   @param is_private [Boolean]
+      #   @param namespace [String]
+      #   @param slug [String]
+      #   @param title [String]
+      #   @param uid [String]
+      #   @param versions [Array<Scalar::Models::ManagedSchemaVersion>]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/schema_create_params.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    # @see Scalar::Resources::Schemas#create
+    class SchemaCreateParams < Scalar::Internal::Type::BaseModel
+      extend Scalar::Internal::Type::RequestParameters::Converter
+      include Scalar::Internal::Type::RequestParameters
+
+      # @!attribute namespace
+      #
+      #   @return [String]
+      required :namespace, String
+
+      # @!attribute document
+      #
+      #   @return [String]
+      required :document, String
+
+      # @!attribute slug
+      #
+      #   @return [String]
+      required :slug, String
+
+      # @!attribute title
+      #
+      #   @return [String]
+      required :title, String
+
+      # @!attribute version
+      #
+      #   @return [String]
+      required :version, String
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String
+
+      # @!attribute is_private
+      #
+      #   @return [Boolean, nil]
+      optional :is_private, Scalar::Internal::Type::Boolean, api_name: :isPrivate
+
+      # @!method initialize(namespace:, document:, slug:, title:, version:, description: nil, is_private: nil, request_options: {})
+      #   @param namespace [String]
+      #   @param document [String]
+      #   @param slug [String]
+      #   @param title [String]
+      #   @param version [String]
+      #   @param description [String]
+      #   @param is_private [Boolean]
+      #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/scalar_api_ruby/models/schema_delete_params.rb

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

data/lib/scalar_api_ruby/models/schema_list_params.rb

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

data/lib/scalar_api_ruby/models/schema_list_response.rb

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

data/lib/scalar_api_ruby/models/schema_update_params.rb

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

data/lib/scalar_api_ruby/models/schemas/access_group_create_params.rb

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

data/lib/scalar_api_ruby/models/schemas/access_group_delete_params.rb

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

data/lib/scalar_api_ruby/models/schemas/version_create_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    module Schemas
+      # @see Scalar::Resources::Schemas::Version#create
+      class VersionCreateParams < Scalar::Internal::Type::BaseModel
+        extend Scalar::Internal::Type::RequestParameters::Converter
+        include Scalar::Internal::Type::RequestParameters
+
+        # @!attribute namespace
+        #
+        #   @return [String]
+        required :namespace, String
+
+        # @!attribute slug
+        #
+        #   @return [String]
+        required :slug, String
+
+        # @!attribute document
+        #
+        #   @return [String]
+        required :document, String
+
+        # @!attribute version
+        #
+        #   @return [String]
+        required :version, String
+
+        # @!attribute force
+        #
+        #   @return [Boolean, nil]
+        optional :force, Scalar::Internal::Type::Boolean
+
+        # @!method initialize(namespace:, slug:, document:, version:, force: nil, request_options: {})
+        #   @param namespace [String]
+        #   @param slug [String]
+        #   @param document [String]
+        #   @param version [String]
+        #   @param force [Boolean]
+        #   @param request_options [Scalar::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/scalar_api_ruby/models/schemas/version_create_response.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    module Schemas
+      # @see Scalar::Resources::Schemas::Version#create
+      class VersionCreateResponse < Scalar::Internal::Type::BaseModel
+        # @!attribute uid
+        #
+        #   @return [String]
+        required :uid, String
+
+        # @!method initialize(uid:)
+        #   @param uid [String]
+      end
+    end
+  end
+end

data/lib/scalar_api_ruby/models/schemas/version_delete_params.rb

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

data/lib/scalar_api_ruby/models/schemas/version_retrieve_params.rb

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

data/lib/scalar_api_ruby/models/schemas/version_retrieve_response.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Scalar
+  module Models
+    module Schemas
+      VersionRetrieveResponse = String
+    end
+  end
+end