openlayer 0.3.0 → 0.4.0

data/rbi/openlayer/models/commit_retrieve_response.rbi

@@ -0,0 +1,393 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    class CommitRetrieveResponse < Openlayer::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Openlayer::Models::CommitRetrieveResponse,
+            Openlayer::Internal::AnyHash
+          )
+        end
+
+      # The details of a commit (project version).
+      sig { returns(Openlayer::Models::CommitRetrieveResponse::Commit) }
+      attr_reader :commit
+
+      sig do
+        params(
+          commit: Openlayer::Models::CommitRetrieveResponse::Commit::OrHash
+        ).void
+      end
+      attr_writer :commit
+
+      # Whether the commit is archived.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :archived
+
+      # The deployment status associated with the commit's model.
+      sig { returns(T.nilable(String)) }
+      attr_reader :deployment_status
+
+      sig { params(deployment_status: String).void }
+      attr_writer :deployment_status
+
+      # The project version (commit) id.
+      sig { returns(String) }
+      attr_accessor :id
+
+      # The commit archive date.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :date_archived
+
+      # The project version (commit) creation date.
+      sig { returns(Time) }
+      attr_accessor :date_created
+
+      # The number of tests that are failing for the commit.
+      sig { returns(Integer) }
+      attr_accessor :failing_goal_count
+
+      # The model id.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :ml_model_id
+
+      # The number of tests that are passing for the commit.
+      sig { returns(Integer) }
+      attr_accessor :passing_goal_count
+
+      # The project id.
+      sig { returns(String) }
+      attr_accessor :project_id
+
+      # The commit status. Initially, the commit is `queued`, then, it switches to
+      # `running`. Finally, it can be `paused`, `failed`, or `completed`.
+      sig do
+        returns(Openlayer::Models::CommitRetrieveResponse::Status::TaggedSymbol)
+      end
+      attr_accessor :status
+
+      # The commit status message.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :status_message
+
+      # The total number of tests for the commit.
+      sig { returns(Integer) }
+      attr_accessor :total_goal_count
+
+      # The training dataset id.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :training_dataset_id
+
+      # The validation dataset id.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :validation_dataset_id
+
+      sig do
+        returns(T.nilable(Openlayer::Models::CommitRetrieveResponse::Links))
+      end
+      attr_reader :links
+
+      sig do
+        params(
+          links: Openlayer::Models::CommitRetrieveResponse::Links::OrHash
+        ).void
+      end
+      attr_writer :links
+
+      sig do
+        params(
+          id: String,
+          commit: Openlayer::Models::CommitRetrieveResponse::Commit::OrHash,
+          date_archived: T.nilable(Time),
+          date_created: Time,
+          failing_goal_count: Integer,
+          ml_model_id: T.nilable(String),
+          passing_goal_count: Integer,
+          project_id: String,
+          status: Openlayer::Models::CommitRetrieveResponse::Status::OrSymbol,
+          status_message: T.nilable(String),
+          total_goal_count: Integer,
+          training_dataset_id: T.nilable(String),
+          validation_dataset_id: T.nilable(String),
+          archived: T.nilable(T::Boolean),
+          deployment_status: String,
+          links: Openlayer::Models::CommitRetrieveResponse::Links::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The project version (commit) id.
+        id:,
+        # The details of a commit (project version).
+        commit:,
+        # The commit archive date.
+        date_archived:,
+        # The project version (commit) creation date.
+        date_created:,
+        # The number of tests that are failing for the commit.
+        failing_goal_count:,
+        # The model id.
+        ml_model_id:,
+        # The number of tests that are passing for the commit.
+        passing_goal_count:,
+        # The project id.
+        project_id:,
+        # The commit status. Initially, the commit is `queued`, then, it switches to
+        # `running`. Finally, it can be `paused`, `failed`, or `completed`.
+        status:,
+        # The commit status message.
+        status_message:,
+        # The total number of tests for the commit.
+        total_goal_count:,
+        # The training dataset id.
+        training_dataset_id:,
+        # The validation dataset id.
+        validation_dataset_id:,
+        # Whether the commit is archived.
+        archived: nil,
+        # The deployment status associated with the commit's model.
+        deployment_status: nil,
+        links: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            commit: Openlayer::Models::CommitRetrieveResponse::Commit,
+            date_archived: T.nilable(Time),
+            date_created: Time,
+            failing_goal_count: Integer,
+            ml_model_id: T.nilable(String),
+            passing_goal_count: Integer,
+            project_id: String,
+            status:
+              Openlayer::Models::CommitRetrieveResponse::Status::TaggedSymbol,
+            status_message: T.nilable(String),
+            storage_uri: String,
+            total_goal_count: Integer,
+            training_dataset_id: T.nilable(String),
+            validation_dataset_id: T.nilable(String),
+            archived: T.nilable(T::Boolean),
+            deployment_status: String,
+            links: Openlayer::Models::CommitRetrieveResponse::Links
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Commit < Openlayer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Models::CommitRetrieveResponse::Commit,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        # The commit message.
+        sig { returns(String) }
+        attr_accessor :message
+
+        # The commit id.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # The author id of the commit.
+        sig { returns(String) }
+        attr_accessor :author_id
+
+        # The size of the commit bundle in bytes.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :file_size
+
+        # The model id.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :ml_model_id
+
+        # The storage URI where the commit bundle is stored.
+        sig { returns(String) }
+        attr_accessor :storage_uri
+
+        # The training dataset id.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :training_dataset_id
+
+        # The validation dataset id.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :validation_dataset_id
+
+        # The commit creation date.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :date_created
+
+        sig { params(date_created: Time).void }
+        attr_writer :date_created
+
+        # The ref of the corresponding git commit.
+        sig { returns(T.nilable(String)) }
+        attr_reader :git_commit_ref
+
+        sig { params(git_commit_ref: String).void }
+        attr_writer :git_commit_ref
+
+        # The SHA of the corresponding git commit.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :git_commit_sha
+
+        sig { params(git_commit_sha: Integer).void }
+        attr_writer :git_commit_sha
+
+        # The URL of the corresponding git commit.
+        sig { returns(T.nilable(String)) }
+        attr_reader :git_commit_url
+
+        sig { params(git_commit_url: String).void }
+        attr_writer :git_commit_url
+
+        # The details of a commit (project version).
+        sig do
+          params(
+            id: String,
+            author_id: String,
+            file_size: T.nilable(Integer),
+            message: String,
+            ml_model_id: T.nilable(String),
+            storage_uri: String,
+            training_dataset_id: T.nilable(String),
+            validation_dataset_id: T.nilable(String),
+            date_created: Time,
+            git_commit_ref: String,
+            git_commit_sha: Integer,
+            git_commit_url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The commit id.
+          id:,
+          # The author id of the commit.
+          author_id:,
+          # The size of the commit bundle in bytes.
+          file_size:,
+          # The commit message.
+          message:,
+          # The model id.
+          ml_model_id:,
+          # The storage URI where the commit bundle is stored.
+          storage_uri:,
+          # The training dataset id.
+          training_dataset_id:,
+          # The validation dataset id.
+          validation_dataset_id:,
+          # The commit creation date.
+          date_created: nil,
+          # The ref of the corresponding git commit.
+          git_commit_ref: nil,
+          # The SHA of the corresponding git commit.
+          git_commit_sha: nil,
+          # The URL of the corresponding git commit.
+          git_commit_url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              author_id: String,
+              file_size: T.nilable(Integer),
+              message: String,
+              ml_model_id: T.nilable(String),
+              storage_uri: String,
+              training_dataset_id: T.nilable(String),
+              validation_dataset_id: T.nilable(String),
+              date_created: Time,
+              git_commit_ref: String,
+              git_commit_sha: Integer,
+              git_commit_url: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # The commit status. Initially, the commit is `queued`, then, it switches to
+      # `running`. Finally, it can be `paused`, `failed`, or `completed`.
+      module Status
+        extend Openlayer::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Openlayer::Models::CommitRetrieveResponse::Status)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        QUEUED =
+          T.let(
+            :queued,
+            Openlayer::Models::CommitRetrieveResponse::Status::TaggedSymbol
+          )
+        RUNNING =
+          T.let(
+            :running,
+            Openlayer::Models::CommitRetrieveResponse::Status::TaggedSymbol
+          )
+        PAUSED =
+          T.let(
+            :paused,
+            Openlayer::Models::CommitRetrieveResponse::Status::TaggedSymbol
+          )
+        FAILED =
+          T.let(
+            :failed,
+            Openlayer::Models::CommitRetrieveResponse::Status::TaggedSymbol
+          )
+        COMPLETED =
+          T.let(
+            :completed,
+            Openlayer::Models::CommitRetrieveResponse::Status::TaggedSymbol
+          )
+        UNKNOWN =
+          T.let(
+            :unknown,
+            Openlayer::Models::CommitRetrieveResponse::Status::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Openlayer::Models::CommitRetrieveResponse::Status::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Links < Openlayer::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Models::CommitRetrieveResponse::Links,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :app
+
+        sig { params(app: String).returns(T.attached_class) }
+        def self.new(app:)
+        end
+
+        sig { override.returns({ app: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/openlayer/models/commits/test_result_list_params.rbi

@@ -0,0 +1,214 @@
+# typed: strong
+
+module Openlayer
+  module Models
+    module Commits
+      class TestResultListParams < Openlayer::Internal::Type::BaseModel
+        extend Openlayer::Internal::Type::RequestParameters::Converter
+        include Openlayer::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Openlayer::Commits::TestResultListParams,
+              Openlayer::Internal::AnyHash
+            )
+          end
+
+        # Filter for archived tests.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :include_archived
+
+        sig { params(include_archived: T::Boolean).void }
+        attr_writer :include_archived
+
+        # The page to return in a paginated query.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page
+
+        sig { params(page: Integer).void }
+        attr_writer :page
+
+        # Maximum number of items to return per page.
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :per_page
+
+        sig { params(per_page: Integer).void }
+        attr_writer :per_page
+
+        # Filter list of test results by status. Available statuses are `running`,
+        # `passing`, `failing`, `skipped`, and `error`.
+        sig do
+          returns(
+            T.nilable(
+              Openlayer::Commits::TestResultListParams::Status::OrSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status: Openlayer::Commits::TestResultListParams::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        # Filter objects by test type. Available types are `integrity`, `consistency`,
+        # `performance`, `fairness`, and `robustness`.
+        sig do
+          returns(
+            T.nilable(Openlayer::Commits::TestResultListParams::Type::OrSymbol)
+          )
+        end
+        attr_reader :type
+
+        sig do
+          params(
+            type: Openlayer::Commits::TestResultListParams::Type::OrSymbol
+          ).void
+        end
+        attr_writer :type
+
+        sig do
+          params(
+            include_archived: T::Boolean,
+            page: Integer,
+            per_page: Integer,
+            status: Openlayer::Commits::TestResultListParams::Status::OrSymbol,
+            type: Openlayer::Commits::TestResultListParams::Type::OrSymbol,
+            request_options: Openlayer::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Filter for archived tests.
+          include_archived: nil,
+          # The page to return in a paginated query.
+          page: nil,
+          # Maximum number of items to return per page.
+          per_page: nil,
+          # Filter list of test results by status. Available statuses are `running`,
+          # `passing`, `failing`, `skipped`, and `error`.
+          status: nil,
+          # Filter objects by test type. Available types are `integrity`, `consistency`,
+          # `performance`, `fairness`, and `robustness`.
+          type: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              include_archived: T::Boolean,
+              page: Integer,
+              per_page: Integer,
+              status:
+                Openlayer::Commits::TestResultListParams::Status::OrSymbol,
+              type: Openlayer::Commits::TestResultListParams::Type::OrSymbol,
+              request_options: Openlayer::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Filter list of test results by status. Available statuses are `running`,
+        # `passing`, `failing`, `skipped`, and `error`.
+        module Status
+          extend Openlayer::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Openlayer::Commits::TestResultListParams::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          RUNNING =
+            T.let(
+              :running,
+              Openlayer::Commits::TestResultListParams::Status::TaggedSymbol
+            )
+          PASSING =
+            T.let(
+              :passing,
+              Openlayer::Commits::TestResultListParams::Status::TaggedSymbol
+            )
+          FAILING =
+            T.let(
+              :failing,
+              Openlayer::Commits::TestResultListParams::Status::TaggedSymbol
+            )
+          SKIPPED =
+            T.let(
+              :skipped,
+              Openlayer::Commits::TestResultListParams::Status::TaggedSymbol
+            )
+          ERROR =
+            T.let(
+              :error,
+              Openlayer::Commits::TestResultListParams::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Openlayer::Commits::TestResultListParams::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Filter objects by test type. Available types are `integrity`, `consistency`,
+        # `performance`, `fairness`, and `robustness`.
+        module Type
+          extend Openlayer::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Openlayer::Commits::TestResultListParams::Type)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          INTEGRITY =
+            T.let(
+              :integrity,
+              Openlayer::Commits::TestResultListParams::Type::TaggedSymbol
+            )
+          CONSISTENCY =
+            T.let(
+              :consistency,
+              Openlayer::Commits::TestResultListParams::Type::TaggedSymbol
+            )
+          PERFORMANCE =
+            T.let(
+              :performance,
+              Openlayer::Commits::TestResultListParams::Type::TaggedSymbol
+            )
+          FAIRNESS =
+            T.let(
+              :fairness,
+              Openlayer::Commits::TestResultListParams::Type::TaggedSymbol
+            )
+          ROBUSTNESS =
+            T.let(
+              :robustness,
+              Openlayer::Commits::TestResultListParams::Type::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Openlayer::Commits::TestResultListParams::Type::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end