diff --git a/README.md b/README.md index f10f230..065aa10 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,5 @@ # DresUnityInterface ---- -** ATTENTION ** -** The unity interface points to version 1.3 of DRES, which is behind the current version v2.0.0-RC1"" ---- - An interface for [DRES](https://github.com/dres-dev/DRES), meant to be used in [Unity](https://unity.com/). ## Usage / Installation diff --git a/Runtime/Libs/Dev.Dres.ClientApi.dll b/Runtime/Libs/Dev.Dres.ClientApi.dll index 3a3c53f..1c9751d 100755 Binary files a/Runtime/Libs/Dev.Dres.ClientApi.dll and b/Runtime/Libs/Dev.Dres.ClientApi.dll differ diff --git a/Runtime/Libs/Dev.Dres.ClientApi.xml b/Runtime/Libs/Dev.Dres.ClientApi.xml index b7c99db..ea07669 100644 --- a/Runtime/Libs/Dev.Dres.ClientApi.xml +++ b/Runtime/Libs/Dev.Dres.ClientApi.xml @@ -4,1225 +4,5900 @@ Dev.Dres.ClientApi - + - CurrentTime + ApiMediaItemMetaDataEntry - + - Initializes a new instance of the class. + Initializes a new instance of the class. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - timeStamp (required). + key (required). + value (required). - + - Gets or Sets TimeStamp + Gets or Sets Key - + + + Gets or Sets Value + + + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if CurrentTime instances are equal + Returns true if ApiMediaItemMetaDataEntry instances are equal - Instance of CurrentTime to be compared + Instance of ApiMediaItemMetaDataEntry to be compared Boolean - + Gets the hash code Hash code - + To validate all properties of the instance Validation context Validation Result - - - SuccessfulSubmissionsStatus - - - - - Defines Submission - - - - - Enum CORRECT for value: CORRECT - - - - - Enum WRONG for value: WRONG - - - - - Enum INDETERMINATE for value: INDETERMINATE - - - + - Enum UNDECIDABLE for value: UNDECIDABLE + ApiTeamInfo - + - Gets or Sets Submission + Initializes a new instance of the class. - + - Initializes a new instance of the class. + Initializes a new instance of the class. + id (required). + name (required). + color (required). - + - Initializes a new instance of the class. + Gets or Sets Id - submission (required). - description (required). - status (required). - + - Gets or Sets Description + Gets or Sets Name - + - Gets or Sets Status + Gets or Sets Color - + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if SuccessfulSubmissionsStatus instances are equal + Returns true if ApiTeamInfo instances are equal - Instance of SuccessfulSubmissionsStatus to be compared + Instance of ApiTeamInfo to be compared Boolean - + Gets the hash code Hash code - + To validate all properties of the instance Validation context Validation Result - - - QueryResultLog - - - - - Initializes a new instance of the class. - - - + - Initializes a new instance of the class. + ApiScoreOverview - timestamp (required). - sortType (required). - resultSetAvailability (required). - results (required). - events (required). - + - Gets or Sets Timestamp + Initializes a new instance of the class. - + - Gets or Sets SortType + Initializes a new instance of the class. + name (required). + taskGroup. + scores (required). - + - Gets or Sets ResultSetAvailability + Gets or Sets Name - + - Gets or Sets Results + Gets or Sets TaskGroup - + - Gets or Sets Events + Gets or Sets Scores - + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if QueryResultLog instances are equal + Returns true if ApiScoreOverview instances are equal - Instance of QueryResultLog to be compared + Instance of ApiScoreOverview to be compared Boolean - + Gets the hash code Hash code - + To validate all properties of the instance Validation context Validation Result - + - LoginRequest + ApiJudgementValidatorStatus - + - Initializes a new instance of the class. + Initializes a new instance of the class. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - username (required). - password (required). + validatorName (required). + pending (required). + open (required). - + - Gets or Sets Username + Gets or Sets ValidatorName - + - Gets or Sets Password + Gets or Sets Pending - + + + Gets or Sets Open + + + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if LoginRequest instances are equal + Returns true if ApiJudgementValidatorStatus instances are equal - Instance of LoginRequest to be compared + Instance of ApiJudgementValidatorStatus to be compared Boolean - + Gets the hash code Hash code - + To validate all properties of the instance Validation context Validation Result - - - ErrorStatus - - - + - Initializes a new instance of the class. + Defines ApiSubmissionOption - + - Initializes a new instance of the class. + Enum NODUPLICATES for value: NO_DUPLICATES - description (required). - status (required). - + - Gets or Sets Description + Enum LIMITCORRECTPERTEAM for value: LIMIT_CORRECT_PER_TEAM - + - Gets or Sets Status + Enum LIMITWRONGPERTEAM for value: LIMIT_WRONG_PER_TEAM - + - Returns the string presentation of the object + Enum LIMITTOTALPERTEAM for value: LIMIT_TOTAL_PER_TEAM - String presentation of the object - + - Returns the JSON string presentation of the object + Enum LIMITCORRECTPERMEMBER for value: LIMIT_CORRECT_PER_MEMBER - JSON string presentation of the object - + - Returns true if objects are equal + Enum TEMPORALSUBMISSION for value: TEMPORAL_SUBMISSION - Object to be compared - Boolean - + - Returns true if ErrorStatus instances are equal + Enum TEXTUALSUBMISSION for value: TEXTUAL_SUBMISSION - Instance of ErrorStatus to be compared - Boolean - + - Gets the hash code + Enum ITEMSUBMISSION for value: ITEM_SUBMISSION - Hash code - + - To validate all properties of the instance + Enum MINIMUMTIMEGAP for value: MINIMUM_TIME_GAP - Validation context - Validation Result - + - ClientTaskInfo + ApiScoreSeries - + - Initializes a new instance of the class. + Initializes a new instance of the class. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - id (required). + team (required). name (required). - taskGroup (required). - remainingTime (required). - running (required). + points (required). - + - Gets or Sets Id + Gets or Sets Team - + Gets or Sets Name - - - Gets or Sets TaskGroup - - - - - Gets or Sets RemainingTime - - - + - Gets or Sets Running + Gets or Sets Points - + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if ClientTaskInfo instances are equal + Returns true if ApiScoreSeries instances are equal - Instance of ClientTaskInfo to be compared + Instance of ApiScoreSeries to be compared Boolean - + Gets the hash code Hash code - + To validate all properties of the instance Validation context Validation Result - + - QueryEventLog + ApiRunProperties - + - Initializes a new instance of the class. + Initializes a new instance of the class. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - timestamp (required). - events (required). + participantCanView (required). + shuffleTasks (required). + allowRepeatedTasks (required). + limitSubmissionPreviews (required). - + - Gets or Sets Timestamp + Gets or Sets ParticipantCanView - + - Gets or Sets Events + Gets or Sets ShuffleTasks - + + + Gets or Sets AllowRepeatedTasks + + + + + Gets or Sets LimitSubmissionPreviews + + + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if QueryEventLog instances are equal + Returns true if ApiRunProperties instances are equal - Instance of QueryEventLog to be compared + Instance of ApiRunProperties to be compared Boolean - + Gets the hash code Hash code - + To validate all properties of the instance Validation context Validation Result - - - UserDetails - - - - - Defines Role - - - - - Enum ADMIN for value: ADMIN - - - - - Enum JUDGE for value: JUDGE - - - - - Enum VIEWER for value: VIEWER - - - - - Enum PARTICIPANT for value: PARTICIPANT - - - + - Gets or Sets Role + ApiTaskGroup - + - Initializes a new instance of the class. + Initializes a new instance of the class. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - id (required). - username (required). - role (required). - sessionId. + id. + name (required). + type (required). - + Gets or Sets Id - + - Gets or Sets Username + Gets or Sets Name - + - Gets or Sets SessionId + Gets or Sets Type - + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if UserDetails instances are equal + Returns true if ApiTaskGroup instances are equal - Instance of UserDetails to be compared + Instance of ApiTaskGroup to be compared Boolean - + Gets the hash code Hash code - + To validate all properties of the instance Validation context Validation Result - - - SuccessStatus - - - + - Initializes a new instance of the class. + ApiOverrideAnswerSetVerdictDto - + - Initializes a new instance of the class. + Gets or Sets Verdict - description (required). - status (required). - + - Gets or Sets Description + Initializes a new instance of the class. - + - Gets or Sets Status + Initializes a new instance of the class. + verdict (required). - + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if SuccessStatus instances are equal + Returns true if ApiOverrideAnswerSetVerdictDto instances are equal - Instance of SuccessStatus to be compared + Instance of ApiOverrideAnswerSetVerdictDto to be compared Boolean - + Gets the hash code Hash code - + To validate all properties of the instance Validation context Validation Result - + - ClientRunInfo + Defines ApiContentType - + - Defines Status + Enum EMPTY for value: EMPTY - + - Enum CREATED for value: CREATED + Enum TEXT for value: TEXT - + - Enum ACTIVE for value: ACTIVE + Enum VIDEO for value: VIDEO - + - Enum PREPARINGTASK for value: PREPARING_TASK + Enum IMAGE for value: IMAGE - + - Enum RUNNINGTASK for value: RUNNING_TASK + ApiViewerInfo - + - Enum TASKENDED for value: TASK_ENDED + Initializes a new instance of the class. - + - Enum TERMINATED for value: TERMINATED + Initializes a new instance of the class. + viewersId (required). + username (required). + host (required). + ready (required). - + - Gets or Sets Status + Gets or Sets ViewersId - + - Initializes a new instance of the class. + Gets or Sets Username - + - Initializes a new instance of the class. + Gets or Sets Host - id (required). - name (required). - description. - status (required). - + - Gets or Sets Id + Gets or Sets Ready - + - Gets or Sets Name + Returns the string presentation of the object + String presentation of the object - + - Gets or Sets Description + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiViewerInfo instances are equal + + Instance of ApiViewerInfo to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiSubmissionInfo + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + evaluationId (required). + taskId (required). + submissions (required). + + + + Gets or Sets EvaluationId + + + + + Gets or Sets TaskId - + + + Gets or Sets Submissions + + + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if ClientRunInfo instances are equal + Returns true if ApiSubmissionInfo instances are equal - Instance of ClientRunInfo to be compared + Instance of ApiSubmissionInfo to be compared Boolean - + Gets the hash code Hash code - + To validate all properties of the instance Validation context Validation Result - + - QueryResult + TemporalRange - + - Initializes a new instance of the class. + Initializes a new instance of the class. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - item (required). - segment. - frame. - score. - rank. + start (required). + end (required). + center (required). - + - Gets or Sets Item + Gets or Sets Start - + - Gets or Sets Segment + Gets or Sets End - + - Gets or Sets Frame + Gets or Sets Center - + - Gets or Sets Score + Returns the string presentation of the object + String presentation of the object - + - Gets or Sets Rank + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + Object to be compared + Boolean - + + + Returns true if TemporalRange instances are equal + + Instance of TemporalRange to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiEvaluationState + + + + + Gets or Sets EvaluationStatus + + + + + Gets or Sets TaskStatus + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + evaluationId (required). + evaluationStatus (required). + taskId. + taskStatus (required). + taskTemplateId. + timeLeft (required). + timeElapsed (required). + + + + Gets or Sets EvaluationId + + + + + Gets or Sets TaskId + + + + + Gets or Sets TaskTemplateId + + + + + Gets or Sets TimeLeft + + + + + Gets or Sets TimeElapsed + + + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if QueryResult instances are equal + Returns true if ApiEvaluationState instances are equal - Instance of QueryResult to be compared + Instance of ApiEvaluationState to be compared Boolean - + Gets the hash code Hash code - + To validate all properties of the instance Validation context Validation Result - + + + ApiTemporalRange + + + - ClientRunInfoList + Initializes a new instance of the class. - + - Initializes a new instance of the class. + Initializes a new instance of the class. + start (required). + end (required). - + - Initializes a new instance of the class. + Gets or Sets Start - runs (required). - + - Gets or Sets Runs + Gets or Sets End - + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if ClientRunInfoList instances are equal + Returns true if ApiTemporalRange instances are equal - Instance of ClientRunInfoList to be compared + Instance of ApiTemporalRange to be compared Boolean - + Gets the hash code Hash code - + To validate all properties of the instance Validation context Validation Result - + - QueryEvent + Defines ApiMediaType - + - Defines Category + Enum IMAGE for value: IMAGE + + + + + Enum VIDEO for value: VIDEO - + Enum TEXT for value: TEXT - + - Enum IMAGE for value: IMAGE + Defines ApiRole - + - Enum SKETCH for value: SKETCH + Enum ANYONE for value: ANYONE - + - Enum FILTER for value: FILTER + Enum VIEWER for value: VIEWER - + - Enum BROWSING for value: BROWSING + Enum PARTICIPANT for value: PARTICIPANT - + - Enum COOPERATION for value: COOPERATION + Enum JUDGE for value: JUDGE - + - Enum OTHER for value: OTHER + Enum ADMIN for value: ADMIN - + - Gets or Sets Category + CurrentTime - + - Initializes a new instance of the class. + Initializes a new instance of the class. - + - Initializes a new instance of the class. + Initializes a new instance of the class. - timestamp (required). - category (required). - type (required). - value (required). + timeStamp (required). - + - Gets or Sets Timestamp + Gets or Sets TimeStamp - + - Gets or Sets Type + Returns the string presentation of the object + String presentation of the object - + - Gets or Sets Value + Returns the JSON string presentation of the object + JSON string presentation of the object - + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if CurrentTime instances are equal + + Instance of CurrentTime to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiTeam + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id. + name. + color. + users (required). + logoData. + teamId (required). + + + + Gets or Sets Id + + + + + Gets or Sets Name + + + + + Gets or Sets Color + + + + + Gets or Sets Users + + + + + Gets or Sets LogoData + + + + + Gets or Sets TeamId + + + Returns the string presentation of the object String presentation of the object - + Returns the JSON string presentation of the object JSON string presentation of the object - + Returns true if objects are equal Object to be compared Boolean - + - Returns true if QueryEvent instances are equal + Returns true if ApiTeam instances are equal - Instance of QueryEvent to be compared + Instance of ApiTeam to be compared Boolean - + Gets the hash code Hash code - + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines ApiTeamAggregatorType + + + + + Enum MIN for value: MIN + + + + + Enum MAX for value: MAX + + + + + Enum MEAN for value: MEAN + + + + + Enum LAST for value: LAST + + + + + ApiClientSubmission + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + answerSets (required). + + + + Gets or Sets AnswerSets + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiClientSubmission instances are equal + + Instance of ApiClientSubmission to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiJudgementRequest + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + token. + validator (required). + taskDescription (required). + answerSet (required). + + + + Gets or Sets Token + + + + + Gets or Sets Validator + + + + + Gets or Sets TaskDescription + + + + + Gets or Sets AnswerSet + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiJudgementRequest instances are equal + + Instance of ApiJudgementRequest to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines ApiTaskOption + + + + + Enum HIDDENRESULTS for value: HIDDEN_RESULTS + + + + + Enum MAPTOSEGMENT for value: MAP_TO_SEGMENT + + + + + Enum PROLONGONSUBMISSION for value: PROLONG_ON_SUBMISSION + + + + + ApiClientAnswerSet + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + taskId. + taskName. + answers (required). + + + + Gets or Sets TaskId + + + + + Gets or Sets TaskName + + + + + Gets or Sets Answers + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiClientAnswerSet instances are equal + + Instance of ApiClientAnswerSet to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines QueryEventCategory + + + + + Enum TEXT for value: TEXT + + + + + Enum IMAGE for value: IMAGE + + + + + Enum SKETCH for value: SKETCH + + + + + Enum FILTER for value: FILTER + + + + + Enum BROWSING for value: BROWSING + + + + + Enum COOPERATION for value: COOPERATION + + + + + Enum OTHER for value: OTHER + + + + + Defines ApiScoreOption + + + + + Enum KIS for value: KIS + + + + + Enum AVS for value: AVS + + + + + Enum LEGACYAVS for value: LEGACY_AVS + + + + + SuccessfulSubmissionsStatus + + + + + Gets or Sets Submission + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + status (required). + submission (required). + description (required). + + + + Gets or Sets Status + + + + + Gets or Sets Description + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SuccessfulSubmissionsStatus instances are equal + + Instance of SuccessfulSubmissionsStatus to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines ApiHintType + + + + + Enum EMPTY for value: EMPTY + + + + + Enum TEXT for value: TEXT + + + + + Enum VIDEO for value: VIDEO + + + + + Enum IMAGE for value: IMAGE + + + + + QueryResultLog + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + timestamp (required). + sortType (required). + resultSetAvailability (required). + results (required). + events (required). + + + + Gets or Sets Timestamp + + + + + Gets or Sets SortType + + + + + Gets or Sets ResultSetAvailability + + + + + Gets or Sets Results + + + + + Gets or Sets Events + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if QueryResultLog instances are equal + + Instance of QueryResultLog to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines ApiTargetType + + + + + Enum JUDGEMENT for value: JUDGEMENT + + + + + Enum JUDGEMENTWITHVOTE for value: JUDGEMENT_WITH_VOTE + + + + + Enum MEDIAITEM for value: MEDIA_ITEM + + + + + Enum MEDIAITEMTEMPORALRANGE for value: MEDIA_ITEM_TEMPORAL_RANGE + + + + + Enum TEXT for value: TEXT + + + + + Defines ApiVerdictStatus + + + + + Enum CORRECT for value: CORRECT + + + + + Enum WRONG for value: WRONG + + + + + Enum INDETERMINATE for value: INDETERMINATE + + + + + Enum UNDECIDABLE for value: UNDECIDABLE + + + + + ApiEvaluationTemplateOverview + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id (required). + name (required). + description. + taskCount (required). + teamCount (required). + + + + Gets or Sets Id + + + + + Gets or Sets Name + + + + + Gets or Sets Description + + + + + Gets or Sets TaskCount + + + + + Gets or Sets TeamCount + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiEvaluationTemplateOverview instances are equal + + Instance of ApiEvaluationTemplateOverview to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiUser + + + + + Gets or Sets Role + + + + + Initializes a new instance of the class. + + id. + username. + role. + sessionId. + + + + Gets or Sets Id + + + + + Gets or Sets Username + + + + + Gets or Sets SessionId + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiUser instances are equal + + Instance of ApiUser to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiTeamGroup + + + + + Gets or Sets Aggregation + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id. + name. + teams (required). + aggregation (required). + + + + Gets or Sets Id + + + + + Gets or Sets Name + + + + + Gets or Sets Teams + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiTeamGroup instances are equal + + Instance of ApiTeamGroup to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiTask + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + taskId (required). + templateId (required). + started. + ended. + submissions (required). + + + + Gets or Sets TaskId + + + + + Gets or Sets TemplateId + + + + + Gets or Sets Started + + + + + Gets or Sets Ended + + + + + Gets or Sets Submissions + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiTask instances are equal + + Instance of ApiTask to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiUserRequest + + + + + Gets or Sets Role + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + username (required). + password. + role. + + + + Gets or Sets Username + + + + + Gets or Sets Password + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiUserRequest instances are equal + + Instance of ApiUserRequest to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiEvaluation + + + + + Gets or Sets Type + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + evaluationId (required). + name (required). + type (required). + template (required). + created (required). + started. + ended. + tasks (required). + + + + Gets or Sets EvaluationId + + + + + Gets or Sets Name + + + + + Gets or Sets Template + + + + + Gets or Sets Created + + + + + Gets or Sets Started + + + + + Gets or Sets Ended + + + + + Gets or Sets Tasks + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiEvaluation instances are equal + + Instance of ApiEvaluation to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiSubmission + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + submissionId (required). + teamId (required). + memberId (required). + teamName (required). + memberName (required). + timestamp (required). + answers (required). + + + + Gets or Sets SubmissionId + + + + + Gets or Sets TeamId + + + + + Gets or Sets MemberId + + + + + Gets or Sets TeamName + + + + + Gets or Sets MemberName + + + + + Gets or Sets Timestamp + + + + + Gets or Sets Answers + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiSubmission instances are equal + + Instance of ApiSubmission to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + LoginRequest + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + username (required). + password (required). + + + + Gets or Sets Username + + + + + Gets or Sets Password + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if LoginRequest instances are equal + + Instance of LoginRequest to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines RunManagerStatus + + + + + Enum CREATED for value: CREATED + + + + + Enum ACTIVE for value: ACTIVE + + + + + Enum TERMINATED for value: TERMINATED + + + + + ErrorStatus + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + status (required). + description (required). + + + + Gets or Sets Status + + + + + Gets or Sets Description + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ErrorStatus instances are equal + + Instance of ErrorStatus to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiAnswer + + + + + Gets or Sets Type + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + type (required). + item. + text. + start. + end. + temporalRange. + + + + Gets or Sets Item + + + + + Gets or Sets Text + + + + + Gets or Sets Start + + + + + Gets or Sets End + + + + + Gets or Sets TemporalRange + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiAnswer instances are equal + + Instance of ApiAnswer to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiEvaluationInfo + + + + + Gets or Sets Type + + + + + Gets or Sets Status + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id (required). + name (required). + type (required). + status (required). + properties (required). + templateId (required). + templateDescription. + teams (required). + taskTemplates (required). + + + + Gets or Sets Id + + + + + Gets or Sets Name + + + + + Gets or Sets Properties + + + + + Gets or Sets TemplateId + + + + + Gets or Sets TemplateDescription + + + + + Gets or Sets Teams + + + + + Gets or Sets TaskTemplates + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiEvaluationInfo instances are equal + + Instance of ApiEvaluationInfo to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiScoreSeriesPoint + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + score (required). + timestamp (required). + + + + Gets or Sets Score + + + + + Gets or Sets Timestamp + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiScoreSeriesPoint instances are equal + + Instance of ApiScoreSeriesPoint to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiHint + + + + + Gets or Sets Type + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + type (required). + start. + end. + description. + path. + dataType. + mediaItem. + mediaItemName. + range. + + + + Gets or Sets Start + + + + + Gets or Sets End + + + + + Gets or Sets Description + + + + + Gets or Sets Path + + + + + Gets or Sets DataType + + + + + Gets or Sets MediaItem + + + + + Gets or Sets MediaItemName + + + + + Gets or Sets Range + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiHint instances are equal + + Instance of ApiHint to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiHintContent + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + taskId (required). + sequence (required). + loop (required). + + + + Gets or Sets TaskId + + + + + Gets or Sets Sequence + + + + + Gets or Sets Loop + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiHintContent instances are equal + + Instance of ApiHintContent to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiJudgement + + + + + Gets or Sets Verdict + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + token (required). + validator (required). + verdict (required). + + + + Gets or Sets Token + + + + + Gets or Sets Validator + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiJudgement instances are equal + + Instance of ApiJudgement to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiTeamTaskOverview + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + teamId (required). + tasks (required). + + + + Gets or Sets TeamId + + + + + Gets or Sets Tasks + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiTeamTaskOverview instances are equal + + Instance of ApiTeamTaskOverview to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines ApiTargetOption + + + + + Enum SINGLEMEDIAITEM for value: SINGLE_MEDIA_ITEM + + + + + Enum SINGLEMEDIASEGMENT for value: SINGLE_MEDIA_SEGMENT + + + + + Enum JUDGEMENT for value: JUDGEMENT + + + + + Enum VOTE for value: VOTE + + + + + Enum TEXT for value: TEXT + + + + + Defines ApiTaskStatus + + + + + Enum NOTASK for value: NO_TASK + + + + + Enum CREATED for value: CREATED + + + + + Enum PREPARING for value: PREPARING + + + + + Enum RUNNING for value: RUNNING + + + + + Enum ENDED for value: ENDED + + + + + Enum IGNORED for value: IGNORED + + + + + Defines ApiAnswerType + + + + + Enum ITEM for value: ITEM + + + + + Enum TEMPORAL for value: TEMPORAL + + + + + Enum TEXT for value: TEXT + + + + + ApiEvaluationTemplate + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id (required). + name (required). + description. + created. + modified. + taskTypes (required). + taskGroups (required). + tasks (required). + teams (required). + teamGroups (required). + judges (required). + + + + Gets or Sets Id + + + + + Gets or Sets Name + + + + + Gets or Sets Description + + + + + Gets or Sets Created + + + + + Gets or Sets Modified + + + + + Gets or Sets TaskTypes + + + + + Gets or Sets TaskGroups + + + + + Gets or Sets Tasks + + + + + Gets or Sets Teams + + + + + Gets or Sets TeamGroups + + + + + Gets or Sets Judges + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiEvaluationTemplate instances are equal + + Instance of ApiEvaluationTemplate to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines ApiEvaluationStatus + + + + + Enum CREATED for value: CREATED + + + + + Enum ACTIVE for value: ACTIVE + + + + + Enum TERMINATED for value: TERMINATED + + + + + ApiTaskTemplateInfo + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + templateId (required). + name (required). + comment. + taskGroup (required). + taskType (required). + duration (required). + + + + Gets or Sets TemplateId + + + + + Gets or Sets Name + + + + + Gets or Sets Comment + + + + + Gets or Sets TaskGroup + + + + + Gets or Sets TaskType + + + + + Gets or Sets Duration + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiTaskTemplateInfo instances are equal + + Instance of ApiTaskTemplateInfo to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + QueryEventLog + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + timestamp (required). + events (required). + + + + Gets or Sets Timestamp + + + + + Gets or Sets Events + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if QueryEventLog instances are equal + + Instance of QueryEventLog to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + SuccessStatus + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + status (required). + description (required). + + + + Gets or Sets Status + + + + + Gets or Sets Description + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if SuccessStatus instances are equal + + Instance of SuccessStatus to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiCreateEvaluation + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + name (required). + description (required). + + + + Gets or Sets Name + + + + + Gets or Sets Description + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiCreateEvaluation instances are equal + + Instance of ApiCreateEvaluation to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiEvaluationStartMessage + + + + + Gets or Sets Type + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + templateId (required). + name (required). + type (required). + properties (required). + + + + Gets or Sets TemplateId + + + + + Gets or Sets Name + + + + + Gets or Sets Properties + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiEvaluationStartMessage instances are equal + + Instance of ApiEvaluationStartMessage to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiEvaluationOverview + + + + + Gets or Sets State + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + state (required). + teamOverviews (required). + + + + Gets or Sets TeamOverviews + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiEvaluationOverview instances are equal + + Instance of ApiEvaluationOverview to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiMediaItem + + + + + Gets or Sets Type + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + mediaItemId (required). + name (required). + type (required). + collectionId (required). + location (required). + durationMs. + fps. + metadata (required). + + + + Gets or Sets MediaItemId + + + + + Gets or Sets Name + + + + + Gets or Sets CollectionId + + + + + Gets or Sets Location + + + + + Gets or Sets DurationMs + + + + + Gets or Sets Fps + + + + + Gets or Sets Metadata + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiMediaItem instances are equal + + Instance of ApiMediaItem to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiTargetContent + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + taskId (required). + sequence (required). + + + + Gets or Sets TaskId + + + + + Gets or Sets Sequence + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiTargetContent instances are equal + + Instance of ApiTargetContent to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiContentElement + + + + + Gets or Sets ContentType + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + contentType (required). + content. + offset (required). + + + + Gets or Sets Content + + + + + Gets or Sets Offset + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiContentElement instances are equal + + Instance of ApiContentElement to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiTaskType + + + + + Gets or Sets TargetOption + + + + + Gets or Sets ScoreOption + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + name (required). + duration (required). + targetOption (required). + hintOptions (required). + submissionOptions (required). + taskOptions (required). + scoreOption (required). + configuration (required). + + + + Gets or Sets Name + + + + + Gets or Sets Duration + + + + + Gets or Sets HintOptions + + + + + Gets or Sets SubmissionOptions + + + + + Gets or Sets TaskOptions + + + + + Gets or Sets _Configuration + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiTaskType instances are equal + + Instance of ApiTaskType to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiTeamGroupValue + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + name (required). + value (required). + + + + Gets or Sets Name + + + + + Gets or Sets Value + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiTeamGroupValue instances are equal + + Instance of ApiTeamGroupValue to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiClientTaskTemplateInfo + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + name (required). + taskGroup (required). + taskType (required). + duration (required). + + + + Gets or Sets Name + + + + + Gets or Sets TaskGroup + + + + + Gets or Sets TaskType + + + + + Gets or Sets Duration + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiClientTaskTemplateInfo instances are equal + + Instance of ApiClientTaskTemplateInfo to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiTaskOverview + + + + + Gets or Sets Status + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id (required). + name (required). + type (required). + group (required). + duration (required). + taskId (required). + status (required). + started. + ended. + + + + Gets or Sets Id + + + + + Gets or Sets Name + + + + + Gets or Sets Type + + + + + Gets or Sets Group + + + + + Gets or Sets Duration + + + + + Gets or Sets TaskId + + + + + Gets or Sets Started + + + + + Gets or Sets Ended + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiTaskOverview instances are equal + + Instance of ApiTaskOverview to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiMediaCollection + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id. + name (required). + description. + basePath. + itemCount (required). + + + + Gets or Sets Id + + + + + Gets or Sets Name + + + + + Gets or Sets Description + + + + + Gets or Sets BasePath + + + + + Gets or Sets ItemCount + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiMediaCollection instances are equal + + Instance of ApiMediaCollection to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines ApiHintOption + + + + + Enum IMAGEITEM for value: IMAGE_ITEM + + + + + Enum VIDEOITEMSEGMENT for value: VIDEO_ITEM_SEGMENT + + + + + Enum TEXT for value: TEXT + + + + + Enum EXTERNALIMAGE for value: EXTERNAL_IMAGE + + + + + Enum EXTERNALVIDEO for value: EXTERNAL_VIDEO + + + + + QueryResult + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + item (required). + segment. + frame. + score. + rank. + + + + Gets or Sets Item + + + + + Gets or Sets Segment + + + + + Gets or Sets Frame + + + + + Gets or Sets Score + + + + + Gets or Sets Rank + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if QueryResult instances are equal + + Instance of QueryResult to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines ApiEvaluationType + + + + + Enum SYNCHRONOUS for value: SYNCHRONOUS + + + + + Enum ASYNCHRONOUS for value: ASYNCHRONOUS + + + + + Enum NONINTERACTIVE for value: NON_INTERACTIVE + + + + + ApiClientEvaluationInfo + + + + + Gets or Sets Type + + + + + Gets or Sets Status + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id (required). + name (required). + type (required). + status (required). + templateId (required). + templateDescription. + teams (required). + taskTemplates (required). + + + + Gets or Sets Id + + + + + Gets or Sets Name + + + + + Gets or Sets TemplateId + + + + + Gets or Sets TemplateDescription + + + + + Gets or Sets Teams + + + + + Gets or Sets TaskTemplates + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiClientEvaluationInfo instances are equal + + Instance of ApiClientEvaluationInfo to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiClientAnswer + + + + + Initializes a new instance of the class. + + text. + mediaItemName. + mediaItemCollectionName. + start. + end. + + + + Gets or Sets Text + + + + + Gets or Sets MediaItemName + + + + + Gets or Sets MediaItemCollectionName + + + + + Gets or Sets Start + + + + + Gets or Sets End + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiClientAnswer instances are equal + + Instance of ApiClientAnswer to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiTemporalPoint + + + + + Gets or Sets Unit + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + value (required). + unit (required). + + + + Gets or Sets Value + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiTemporalPoint instances are equal + + Instance of ApiTemporalPoint to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + QueryEvent + + + + + Gets or Sets Category + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + timestamp (required). + category (required). + type (required). + value (required). + + + + Gets or Sets Timestamp + + + + + Gets or Sets Type + + + + + Gets or Sets Value + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if QueryEvent instances are equal + + Instance of QueryEvent to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiAnswerSet + + + + + Gets or Sets Status + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id (required). + status (required). + taskId (required). + answers (required). + + + + Gets or Sets Id + + + + + Gets or Sets TaskId + + + + + Gets or Sets Answers + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiAnswerSet instances are equal + + Instance of ApiAnswerSet to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiTarget + + + + + Gets or Sets Type + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + type (required). + target. + range. + name. + + + + Gets or Sets Target + + + + + Gets or Sets Range + + + + + Gets or Sets Name + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiTarget instances are equal + + Instance of ApiTarget to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiVote + + + + + Gets or Sets Verdict + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + verdict (required). + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiVote instances are equal + + Instance of ApiVote to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiPopulatedMediaCollection + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + collection (required). + items (required). + + + + Gets or Sets Collection + + + + + Gets or Sets Items + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiPopulatedMediaCollection instances are equal + + Instance of ApiPopulatedMediaCollection to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + DresInfo + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + version (required). + startTime (required). + uptime (required). + os. + jvm. + args. + cores. + freeMemory. + totalMemory. + load. + availableSeverThreads. + + + + Gets or Sets _Version + + + + + Gets or Sets StartTime + + + + + Gets or Sets Uptime + + + + + Gets or Sets Os + + + + + Gets or Sets Jvm + + + + + Gets or Sets Args + + + + + Gets or Sets Cores + + + + + Gets or Sets FreeMemory + + + + + Gets or Sets TotalMemory + + + + + Gets or Sets Load + + + + + Gets or Sets AvailableSeverThreads + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if DresInfo instances are equal + + Instance of DresInfo to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Defines ApiTemporalUnit + + + + + Enum FRAMENUMBER for value: FRAME_NUMBER + + + + + Enum SECONDS for value: SECONDS + + + + + Enum MILLISECONDS for value: MILLISECONDS + + + + + Enum TIMECODE for value: TIMECODE + + + + + ApiTaskTemplate + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id. + name (required). + taskGroup (required). + taskType (required). + duration (required). + collectionId (required). + targets (required). + hints (required). + comment. + + + + Gets or Sets Id + + + + + Gets or Sets Name + + + + + Gets or Sets TaskGroup + + + + + Gets or Sets TaskType + + + + + Gets or Sets Duration + + + + + Gets or Sets CollectionId + + + + + Gets or Sets Targets + + + + + Gets or Sets Hints + + + + + Gets or Sets Comment + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiTaskTemplate instances are equal + + Instance of ApiTaskTemplate to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + ApiScore + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + teamId (required). + score (required). + + + + Gets or Sets TeamId + + + + + Gets or Sets Score + + + + + Returns the string presentation of the object + + String presentation of the object + + + + Returns the JSON string presentation of the object + + JSON string presentation of the object + + + + Returns true if objects are equal + + Object to be compared + Boolean + + + + Returns true if ApiScore instances are equal + + Instance of ApiScore to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + Represents a collection of functions to interact with the API endpoints + + + + + Returns basic information about a specific evaluation. + + + + + Thrown when fails to make API call + The evaluation ID. + ApiEvaluationInfo + + + + Returns basic information about a specific evaluation. + + + + + Thrown when fails to make API call + The evaluation ID. + ApiResponse of ApiEvaluationInfo + + + + Returns the state of a specific evaluation. + + + + + Thrown when fails to make API call + The evaluation ID. + ApiEvaluationState + + + + Returns the state of a specific evaluation. + + + + + Thrown when fails to make API call + The evaluation ID. + ApiResponse of ApiEvaluationState + + + + + + + + Returns basic information about a specific evaluation. + + + + + Thrown when fails to make API call + The evaluation ID. + Cancellation Token to cancel request (optional) + Task of ApiEvaluationInfo + + + + Returns basic information about a specific evaluation. + + + + + Thrown when fails to make API call + The evaluation ID. + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiEvaluationInfo) + + + + Returns the state of a specific evaluation. + + + + + Thrown when fails to make API call + The evaluation ID. + Cancellation Token to cancel request (optional) + Task of ApiEvaluationState + + + + Returns the state of a specific evaluation. + + + + + Thrown when fails to make API call + The evaluation ID. + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiEvaluationState) + + + + + Lists an overview of all evaluations visible to the current user. + + + + + Thrown when fails to make API call + Cancellation Token to cancel request (optional) + Task of ApiResponse (List<ApiEvaluationInfo>) + + + + + Lists an overview of all evaluation visible to the current user. + + + + + Thrown when fails to make API call + Cancellation Token to cancel request (optional) + Task of ApiResponse (List<ApiEvaluationState>) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Initializes a new instance of the class. + + + + + + Initializes a new instance of the class + + + + + + Initializes a new instance of the class + using Configuration object + + An instance of Configuration + + + + + Gets the base path of the API client. + + The base path + + + + Sets the base path of the API client. + + The base path + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Provides a factory method hook for the creation of exceptions. + + + + + Gets the default header. + + Dictionary of HTTP header + + + + Add default header. + + Header field name. + Header field value. + + + + + Returns basic information about a specific evaluation. + + Thrown when fails to make API call + The evaluation ID. + ApiEvaluationInfo + + + + Returns basic information about a specific evaluation. + + Thrown when fails to make API call + The evaluation ID. + ApiResponse of ApiEvaluationInfo + + + + Returns basic information about a specific evaluation. + + Thrown when fails to make API call + The evaluation ID. + Cancellation Token to cancel request (optional) + Task of ApiEvaluationInfo + + + + Returns basic information about a specific evaluation. + + Thrown when fails to make API call + The evaluation ID. + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiEvaluationInfo) + + + + Returns the state of a specific evaluation. + + Thrown when fails to make API call + The evaluation ID. + ApiEvaluationState + + + + Returns the state of a specific evaluation. + + Thrown when fails to make API call + The evaluation ID. + ApiResponse of ApiEvaluationState + + - To validate all properties of the instance + Returns the state of a specific evaluation. - Validation context - Validation Result + Thrown when fails to make API call + The evaluation ID. + Cancellation Token to cancel request (optional) + Task of ApiEvaluationState - + - Represents a collection of functions to interact with the API endpoints + Returns the state of a specific evaluation. + Thrown when fails to make API call + The evaluation ID. + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiEvaluationState) - + + + + - Returns an overview of the currently active task for a run + Lists an overview of all evaluations visible to the current user. - - - Thrown when fails to make API call - - Session Token - ClientTaskInfo + Cancellation Token to cancel request (optional) + Task of ApiResponse (List<ApiEvaluationInfo>) - + + + + - Returns an overview of the currently active task for a run + Lists an overview of all evaluation visible to the current user. - - - Thrown when fails to make API call - - Session Token - ApiResponse of ClientTaskInfo + Cancellation Token to cancel request (optional) + Task of ApiResponse (List<ApiEvaluationState>) - + - Lists an overview of all competition runs visible to the current client + Represents a collection of functions to interact with the API endpoints - - - - Thrown when fails to make API call - Session Token - ClientRunInfoList - + - Lists an overview of all competition runs visible to the current client + Returns an overview of the currently active task for a run. Thrown when fails to make API call - Session Token - ApiResponse of ClientRunInfoList + The evaluation ID. + Session Token (optional) + ApiTaskTemplateInfo - + - Returns an overview of the currently active task for a run + Returns an overview of the currently active task for a run. Thrown when fails to make API call - - Session Token - Task of ClientTaskInfo + The evaluation ID. + Session Token (optional) + ApiResponse of ApiTaskTemplateInfo - + + + - Returns an overview of the currently active task for a run + Returns an overview of the currently active task for a run. Thrown when fails to make API call - - Session Token - Task of ApiResponse (ClientTaskInfo) + The evaluation ID. + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of ApiTaskTemplateInfo - + - Lists an overview of all competition runs visible to the current client + Returns an overview of the currently active task for a run. Thrown when fails to make API call - Session Token - Task of ClientRunInfoList + The evaluation ID. + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiTaskTemplateInfo) - + + - Lists an overview of all competition runs visible to the current client + Lists an overview of all evaluation runs visible to the current client. Thrown when fails to make API call - Session Token - Task of ApiResponse (ClientRunInfoList) + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (List<ApiClientEvaluationInfo>) - + Represents a collection of functions to interact with the API endpoints - + - Initializes a new instance of the class. + Initializes a new instance of the class. - + - Initializes a new instance of the class + Initializes a new instance of the class - + - Initializes a new instance of the class + Initializes a new instance of the class using Configuration object An instance of Configuration - + Gets the base path of the API client. The base path - + Sets the base path of the API client. The base path - + Gets or sets the configuration object An instance of the Configuration - + Provides a factory method hook for the creation of exceptions. - + Gets the default header. Dictionary of HTTP header - + Add default header. @@ -1230,80 +5905,62 @@ Header field value. - - - Returns an overview of the currently active task for a run - - Thrown when fails to make API call - - Session Token - ClientTaskInfo - - - - Returns an overview of the currently active task for a run - - Thrown when fails to make API call - - Session Token - ApiResponse of ClientTaskInfo - - + - Returns an overview of the currently active task for a run + Returns an overview of the currently active task for a run. Thrown when fails to make API call - - Session Token - Task of ClientTaskInfo - - - - Returns an overview of the currently active task for a run - - Thrown when fails to make API call - - Session Token - Task of ApiResponse (ClientTaskInfo) + The evaluation ID. + Session Token (optional) + ApiTaskTemplateInfo - + - Lists an overview of all competition runs visible to the current client + Returns an overview of the currently active task for a run. Thrown when fails to make API call - Session Token - ClientRunInfoList + The evaluation ID. + Session Token (optional) + ApiResponse of ApiTaskTemplateInfo - + - Lists an overview of all competition runs visible to the current client + Returns an overview of the currently active task for a run. Thrown when fails to make API call - Session Token - ApiResponse of ClientRunInfoList + The evaluation ID. + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of ApiTaskTemplateInfo - + - Lists an overview of all competition runs visible to the current client + Returns an overview of the currently active task for a run. Thrown when fails to make API call - Session Token - Task of ClientRunInfoList + The evaluation ID. + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiTaskTemplateInfo) - + + + + - Lists an overview of all competition runs visible to the current client + Lists an overview of all evaluation runs visible to the current client. Thrown when fails to make API call - Session Token - Task of ApiResponse (ClientRunInfoList) + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (List<ApiClientEvaluationInfo>) Represents a collection of functions to interact with the API endpoints - + Returns the current time on the server. @@ -1313,7 +5970,7 @@ Thrown when fails to make API call CurrentTime - + Returns the current time on the server. @@ -1323,7 +5980,7 @@ Thrown when fails to make API call ApiResponse of CurrentTime - + Returns the current time on the server. @@ -1331,9 +5988,10 @@ Thrown when fails to make API call + Cancellation Token to cancel request (optional) Task of CurrentTime - + Returns the current time on the server. @@ -1341,6 +5999,7 @@ Thrown when fails to make API call + Cancellation Token to cancel request (optional) Task of ApiResponse (CurrentTime) @@ -1405,32 +6064,34 @@ Header field value. - + Returns the current time on the server. Thrown when fails to make API call CurrentTime - + Returns the current time on the server. Thrown when fails to make API call ApiResponse of CurrentTime - + Returns the current time on the server. Thrown when fails to make API call + Cancellation Token to cancel request (optional) Task of CurrentTime - + Returns the current time on the server. Thrown when fails to make API call + Cancellation Token to cancel request (optional) Task of ApiResponse (CurrentTime) @@ -1443,15 +6104,15 @@ Endpoint to accept submissions - + This has been the submission endpoint for version 1. Please refrain from using it and migrate to the v2 endpoint. Thrown when fails to make API call Collection identifier. Optional, in which case the default collection for the run will be considered. (optional) Identifier for the actual media object or media file. (optional) Text to be submitted. ONLY for tasks with target type TEXT. If this parameter is provided, it superseeds all athers. (optional) - Frame number for media with temporal progression (e.g. video). (optional) - Shot number for media with temporal progression (e.g. video). (optional) - Timecode for media with temporal progression (e.g. video). (optional) + Frame number for media with temporal progression (e.g., video). (optional) + Shot number for media with temporal progression (e.g., video). (optional) + Timecode for media with temporal progression (e.g,. video). (optional) Session Token (optional) SuccessfulSubmissionsStatus @@ -1460,50 +6121,106 @@ Endpoint to accept submissions - + This has been the submission endpoint for version 1. Please refrain from using it and migrate to the v2 endpoint. Thrown when fails to make API call Collection identifier. Optional, in which case the default collection for the run will be considered. (optional) Identifier for the actual media object or media file. (optional) Text to be submitted. ONLY for tasks with target type TEXT. If this parameter is provided, it superseeds all athers. (optional) - Frame number for media with temporal progression (e.g. video). (optional) - Shot number for media with temporal progression (e.g. video). (optional) - Timecode for media with temporal progression (e.g. video). (optional) + Frame number for media with temporal progression (e.g., video). (optional) + Shot number for media with temporal progression (e.g., video). (optional) + Timecode for media with temporal progression (e.g,. video). (optional) Session Token (optional) ApiResponse of SuccessfulSubmissionsStatus - + - Endpoint to accept submissions + Endpoint to accept submissions. + + + + + Thrown when fails to make API call + The ID of the evaluation the submission belongs to. + + Session Token (optional) + SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions. + + Thrown when fails to make API call + The ID of the evaluation the submission belongs to. + + Session Token (optional) + ApiResponse of SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions + + + This has been the submission endpoint for version 1. Please refrain from using it and migrate to the v2 endpoint. Thrown when fails to make API call Collection identifier. Optional, in which case the default collection for the run will be considered. (optional) Identifier for the actual media object or media file. (optional) Text to be submitted. ONLY for tasks with target type TEXT. If this parameter is provided, it superseeds all athers. (optional) - Frame number for media with temporal progression (e.g. video). (optional) - Shot number for media with temporal progression (e.g. video). (optional) - Timecode for media with temporal progression (e.g. video). (optional) + Frame number for media with temporal progression (e.g., video). (optional) + Shot number for media with temporal progression (e.g., video). (optional) + Timecode for media with temporal progression (e.g,. video). (optional) Session Token (optional) + Cancellation Token to cancel request (optional) Task of SuccessfulSubmissionsStatus - + Endpoint to accept submissions - + This has been the submission endpoint for version 1. Please refrain from using it and migrate to the v2 endpoint. Thrown when fails to make API call Collection identifier. Optional, in which case the default collection for the run will be considered. (optional) Identifier for the actual media object or media file. (optional) Text to be submitted. ONLY for tasks with target type TEXT. If this parameter is provided, it superseeds all athers. (optional) - Frame number for media with temporal progression (e.g. video). (optional) - Shot number for media with temporal progression (e.g. video). (optional) - Timecode for media with temporal progression (e.g. video). (optional) + Frame number for media with temporal progression (e.g., video). (optional) + Shot number for media with temporal progression (e.g., video). (optional) + Timecode for media with temporal progression (e.g,. video). (optional) + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (SuccessfulSubmissionsStatus) + + + + Endpoint to accept submissions. + + + + + Thrown when fails to make API call + The ID of the evaluation the submission belongs to. + + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions. + + + + + Thrown when fails to make API call + The ID of the evaluation the submission belongs to. + Session Token (optional) + Cancellation Token to cancel request (optional) Task of ApiResponse (SuccessfulSubmissionsStatus) @@ -1570,58 +6287,102 @@ - Endpoint to accept submissions + Endpoint to accept submissions This has been the submission endpoint for version 1. Please refrain from using it and migrate to the v2 endpoint. Thrown when fails to make API call Collection identifier. Optional, in which case the default collection for the run will be considered. (optional) Identifier for the actual media object or media file. (optional) Text to be submitted. ONLY for tasks with target type TEXT. If this parameter is provided, it superseeds all athers. (optional) - Frame number for media with temporal progression (e.g. video). (optional) - Shot number for media with temporal progression (e.g. video). (optional) - Timecode for media with temporal progression (e.g. video). (optional) + Frame number for media with temporal progression (e.g., video). (optional) + Shot number for media with temporal progression (e.g., video). (optional) + Timecode for media with temporal progression (e.g,. video). (optional) Session Token (optional) SuccessfulSubmissionsStatus - Endpoint to accept submissions + Endpoint to accept submissions This has been the submission endpoint for version 1. Please refrain from using it and migrate to the v2 endpoint. Thrown when fails to make API call Collection identifier. Optional, in which case the default collection for the run will be considered. (optional) Identifier for the actual media object or media file. (optional) Text to be submitted. ONLY for tasks with target type TEXT. If this parameter is provided, it superseeds all athers. (optional) - Frame number for media with temporal progression (e.g. video). (optional) - Shot number for media with temporal progression (e.g. video). (optional) - Timecode for media with temporal progression (e.g. video). (optional) + Frame number for media with temporal progression (e.g., video). (optional) + Shot number for media with temporal progression (e.g., video). (optional) + Timecode for media with temporal progression (e.g,. video). (optional) Session Token (optional) ApiResponse of SuccessfulSubmissionsStatus - + - Endpoint to accept submissions + Endpoint to accept submissions This has been the submission endpoint for version 1. Please refrain from using it and migrate to the v2 endpoint. Thrown when fails to make API call Collection identifier. Optional, in which case the default collection for the run will be considered. (optional) Identifier for the actual media object or media file. (optional) Text to be submitted. ONLY for tasks with target type TEXT. If this parameter is provided, it superseeds all athers. (optional) - Frame number for media with temporal progression (e.g. video). (optional) - Shot number for media with temporal progression (e.g. video). (optional) - Timecode for media with temporal progression (e.g. video). (optional) + Frame number for media with temporal progression (e.g., video). (optional) + Shot number for media with temporal progression (e.g., video). (optional) + Timecode for media with temporal progression (e.g,. video). (optional) Session Token (optional) + Cancellation Token to cancel request (optional) Task of SuccessfulSubmissionsStatus - + - Endpoint to accept submissions + Endpoint to accept submissions This has been the submission endpoint for version 1. Please refrain from using it and migrate to the v2 endpoint. Thrown when fails to make API call Collection identifier. Optional, in which case the default collection for the run will be considered. (optional) Identifier for the actual media object or media file. (optional) Text to be submitted. ONLY for tasks with target type TEXT. If this parameter is provided, it superseeds all athers. (optional) - Frame number for media with temporal progression (e.g. video). (optional) - Shot number for media with temporal progression (e.g. video). (optional) - Timecode for media with temporal progression (e.g. video). (optional) + Frame number for media with temporal progression (e.g., video). (optional) + Shot number for media with temporal progression (e.g., video). (optional) + Timecode for media with temporal progression (e.g,. video). (optional) + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (SuccessfulSubmissionsStatus) + + + + Endpoint to accept submissions. + + Thrown when fails to make API call + The ID of the evaluation the submission belongs to. + + Session Token (optional) + SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions. + + Thrown when fails to make API call + The ID of the evaluation the submission belongs to. + + Session Token (optional) + ApiResponse of SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions. + + Thrown when fails to make API call + The ID of the evaluation the submission belongs to. + + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions. + + Thrown when fails to make API call + The ID of the evaluation the submission belongs to. + Session Token (optional) + Cancellation Token to cancel request (optional) Task of ApiResponse (SuccessfulSubmissionsStatus) @@ -1629,7 +6390,7 @@ Represents a collection of functions to interact with the API endpoints - + Accepts query logs from participants @@ -1641,7 +6402,7 @@ (optional) SuccessStatus - + Accepts query logs from participants @@ -1653,9 +6414,9 @@ (optional) ApiResponse of SuccessStatus - + - Accepts result logs from participants + Accepts result logs from participants. @@ -1665,9 +6426,9 @@ (optional) SuccessStatus - + - Accepts result logs from participants + Accepts result logs from participants. @@ -1677,7 +6438,7 @@ (optional) ApiResponse of SuccessStatus - + Accepts query logs from participants @@ -1687,9 +6448,10 @@ Thrown when fails to make API call Session Token (optional) + Cancellation Token to cancel request (optional) Task of SuccessStatus - + Accepts query logs from participants @@ -1699,11 +6461,12 @@ Thrown when fails to make API call Session Token (optional) + Cancellation Token to cancel request (optional) Task of ApiResponse (SuccessStatus) - + - Accepts result logs from participants + Accepts result logs from participants. @@ -1711,11 +6474,12 @@ Thrown when fails to make API call Session Token (optional) + Cancellation Token to cancel request (optional) Task of SuccessStatus - + - Accepts result logs from participants + Accepts result logs from participants. @@ -1723,6 +6487,7 @@ Thrown when fails to make API call Session Token (optional) + Cancellation Token to cancel request (optional) Task of ApiResponse (SuccessStatus) @@ -1787,7 +6552,7 @@ Header field value. - + Accepts query logs from participants @@ -1796,75 +6561,279 @@ (optional) SuccessStatus - + + + Accepts query logs from participants + + Thrown when fails to make API call + Session Token + (optional) + ApiResponse of SuccessStatus + + + + Accepts query logs from participants + + Thrown when fails to make API call + Session Token + (optional) + Cancellation Token to cancel request (optional) + Task of SuccessStatus + + Accepts query logs from participants Thrown when fails to make API call Session Token (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (SuccessStatus) + + + + Accepts result logs from participants. + + Thrown when fails to make API call + Session Token + (optional) + SuccessStatus + + + + Accepts result logs from participants. + + Thrown when fails to make API call + Session Token + (optional) + ApiResponse of SuccessStatus + + + + Accepts result logs from participants. + + Thrown when fails to make API call + Session Token + (optional) + Cancellation Token to cancel request (optional) + Task of SuccessStatus + + + + Accepts result logs from participants. + + Thrown when fails to make API call + Session Token + (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (SuccessStatus) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Deletes the specified user. Requires ADMIN privileges + + + + + Thrown when fails to make API call + User ID + ApiUser + + + + Deletes the specified user. Requires ADMIN privileges + + + + + Thrown when fails to make API call + User ID + ApiResponse of ApiUser + + + + Clears all user roles of the current session. + + + + + Thrown when fails to make API call + Session Token (optional) + SuccessStatus + + + + Clears all user roles of the current session. + + + + + Thrown when fails to make API call + Session Token (optional) ApiResponse of SuccessStatus - + + + Get information about the current user. + + + + + Thrown when fails to make API call + ApiUser + + + + Get information about the current user. + + + + + Thrown when fails to make API call + ApiResponse of ApiUser + + + + Gets details of the user with the given id. + + + + + Thrown when fails to make API call + User's UID + ApiUser + + + + Gets details of the user with the given id. + + + + + Thrown when fails to make API call + User's UID + ApiResponse of ApiUser + + + + Get current sessionId + + + + + Thrown when fails to make API call + Session Token (optional) + string + + + + Get current sessionId + + + + + Thrown when fails to make API call + Session Token (optional) + ApiResponse of string + + + + Updates the specified user, if it exists. Anyone is allowed to update their data, however only ADMINs are allowed to update anyone. + + + + + Thrown when fails to make API call + User ID + (optional) + ApiUser + + - Accepts query logs from participants + Updates the specified user, if it exists. Anyone is allowed to update their data, however only ADMINs are allowed to update anyone. + + + Thrown when fails to make API call - Session Token - (optional) - Task of SuccessStatus + User ID + (optional) + ApiResponse of ApiUser - + - Accepts query logs from participants + Sets roles for session based on user account and returns a session cookie. + + + Thrown when fails to make API call - Session Token - (optional) - Task of ApiResponse (SuccessStatus) + (optional) + ApiUser - + - Accepts result logs from participants + Sets roles for session based on user account and returns a session cookie. + + + Thrown when fails to make API call - Session Token - (optional) - SuccessStatus + (optional) + ApiResponse of ApiUser - + - Accepts result logs from participants + Creates a new user, if the username is not already taken. Requires ADMIN privileges + + + Thrown when fails to make API call - Session Token - (optional) - ApiResponse of SuccessStatus + (optional) + ApiUser - + - Accepts result logs from participants + Creates a new user, if the username is not already taken. Requires ADMIN privileges + + + Thrown when fails to make API call - Session Token - (optional) - Task of SuccessStatus + (optional) + ApiResponse of ApiUser - + - Accepts result logs from participants + Deletes the specified user. Requires ADMIN privileges + + + Thrown when fails to make API call - Session Token - (optional) - Task of ApiResponse (SuccessStatus) + User ID + Cancellation Token to cancel request (optional) + Task of ApiUser - + - Represents a collection of functions to interact with the API endpoints + Deletes the specified user. Requires ADMIN privileges + + + + Thrown when fails to make API call + User ID + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) - + Clears all user roles of the current session. @@ -1873,9 +6842,10 @@ Thrown when fails to make API call Session Token (optional) - SuccessStatus + Cancellation Token to cancel request (optional) + Task of SuccessStatus - + Clears all user roles of the current session. @@ -1884,9 +6854,10 @@ Thrown when fails to make API call Session Token (optional) - ApiResponse of SuccessStatus + Cancellation Token to cancel request (optional) + Task of ApiResponse (SuccessStatus) - + Get information about the current user. @@ -1894,9 +6865,10 @@ Thrown when fails to make API call - UserDetails + Cancellation Token to cancel request (optional) + Task of ApiUser - + Get information about the current user. @@ -1904,73 +6876,84 @@ Thrown when fails to make API call - ApiResponse of UserDetails + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) - + - Sets roles for session based on user account and returns a session cookie. + Gets details of the user with the given id. Thrown when fails to make API call - (optional) - UserDetails + User's UID + Cancellation Token to cancel request (optional) + Task of ApiUser - + - Sets roles for session based on user account and returns a session cookie. + Gets details of the user with the given id. Thrown when fails to make API call - (optional) - ApiResponse of UserDetails + User's UID + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) - + - Clears all user roles of the current session. + Get current sessionId Thrown when fails to make API call Session Token (optional) - Task of SuccessStatus + Cancellation Token to cancel request (optional) + Task of string - + - Clears all user roles of the current session. + Get current sessionId Thrown when fails to make API call Session Token (optional) - Task of ApiResponse (SuccessStatus) + Cancellation Token to cancel request (optional) + Task of ApiResponse (string) - + - Get information about the current user. + Updates the specified user, if it exists. Anyone is allowed to update their data, however only ADMINs are allowed to update anyone. Thrown when fails to make API call - Task of UserDetails + User ID + (optional) + Cancellation Token to cancel request (optional) + Task of ApiUser - + - Get information about the current user. + Updates the specified user, if it exists. Anyone is allowed to update their data, however only ADMINs are allowed to update anyone. Thrown when fails to make API call - Task of ApiResponse (UserDetails) + User ID + (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) - + Sets roles for session based on user account and returns a session cookie. @@ -1979,9 +6962,10 @@ Thrown when fails to make API call (optional) - Task of UserDetails + Cancellation Token to cancel request (optional) + Task of ApiUser - + Sets roles for session based on user account and returns a session cookie. @@ -1990,7 +6974,32 @@ Thrown when fails to make API call (optional) - Task of ApiResponse (UserDetails) + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) + + + + Creates a new user, if the username is not already taken. Requires ADMIN privileges + + + + + Thrown when fails to make API call + (optional) + Cancellation Token to cancel request (optional) + Task of ApiUser + + + + Creates a new user, if the username is not already taken. Requires ADMIN privileges + + + + + Thrown when fails to make API call + (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) @@ -2054,392 +7063,277 @@ Header field value. - + - Clears all user roles of the current session. + Deletes the specified user. Requires ADMIN privileges Thrown when fails to make API call - Session Token (optional) - SuccessStatus + User ID + ApiUser - + - Clears all user roles of the current session. + Deletes the specified user. Requires ADMIN privileges Thrown when fails to make API call - Session Token (optional) - ApiResponse of SuccessStatus + User ID + ApiResponse of ApiUser - + - Clears all user roles of the current session. + Deletes the specified user. Requires ADMIN privileges Thrown when fails to make API call - Session Token (optional) - Task of SuccessStatus + User ID + Cancellation Token to cancel request (optional) + Task of ApiUser - + - Clears all user roles of the current session. + Deletes the specified user. Requires ADMIN privileges Thrown when fails to make API call - Session Token (optional) - Task of ApiResponse (SuccessStatus) + User ID + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) - + - Get information about the current user. + Clears all user roles of the current session. Thrown when fails to make API call - UserDetails + Session Token (optional) + SuccessStatus - + - Get information about the current user. + Clears all user roles of the current session. Thrown when fails to make API call - ApiResponse of UserDetails + Session Token (optional) + ApiResponse of SuccessStatus - + - Get information about the current user. + Clears all user roles of the current session. Thrown when fails to make API call - Task of UserDetails + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of SuccessStatus - + - Get information about the current user. + Clears all user roles of the current session. Thrown when fails to make API call - Task of ApiResponse (UserDetails) + Session Token (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (SuccessStatus) - + - Sets roles for session based on user account and returns a session cookie. + Get information about the current user. Thrown when fails to make API call - (optional) - UserDetails + ApiUser - + - Sets roles for session based on user account and returns a session cookie. + Get information about the current user. Thrown when fails to make API call - (optional) - ApiResponse of UserDetails + ApiResponse of ApiUser - + - Sets roles for session based on user account and returns a session cookie. + Get information about the current user. Thrown when fails to make API call - (optional) - Task of UserDetails + Cancellation Token to cancel request (optional) + Task of ApiUser - + - Sets roles for session based on user account and returns a session cookie. + Get information about the current user. Thrown when fails to make API call - (optional) - Task of ApiResponse (UserDetails) - - - - Represents a collection of functions to interact with the API endpoints - + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) - + - Provides a JSON download of the entire competition description structure. + Gets details of the user with the given id. - - - Thrown when fails to make API call - Competition ID - string + User's UID + ApiUser - + - Provides a JSON download of the entire competition description structure. + Gets details of the user with the given id. - - - Thrown when fails to make API call - Competition ID - ApiResponse of string + User's UID + ApiResponse of ApiUser - + - Provides a JSON download of the entire competition run structure. + Gets details of the user with the given id. - - - Thrown when fails to make API call - Competition run ID - string + User's UID + Cancellation Token to cancel request (optional) + Task of ApiUser - + - Provides a JSON download of the entire competition run structure. + Gets details of the user with the given id. - - - Thrown when fails to make API call - Competition run ID - ApiResponse of string + User's UID + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) - + - Provides a CSV download with the scores for a given competition run. + Get current sessionId - - - Thrown when fails to make API call - Competition run ID + Session Token (optional) string - + - Provides a CSV download with the scores for a given competition run. + Get current sessionId - - - Thrown when fails to make API call - Competition run ID + Session Token (optional) ApiResponse of string - - - Provides a JSON download of the entire competition description structure. - - - - - Thrown when fails to make API call - Competition ID - Task of string - - - - Provides a JSON download of the entire competition description structure. - - - - - Thrown when fails to make API call - Competition ID - Task of ApiResponse (string) - - - - Provides a JSON download of the entire competition run structure. - - - - - Thrown when fails to make API call - Competition run ID - Task of string - - - - Provides a JSON download of the entire competition run structure. - - - - - Thrown when fails to make API call - Competition run ID - Task of ApiResponse (string) - - + - Provides a CSV download with the scores for a given competition run. + Get current sessionId - - - Thrown when fails to make API call - Competition run ID + Session Token (optional) + Cancellation Token to cancel request (optional) Task of string - + - Provides a CSV download with the scores for a given competition run. + Get current sessionId - - - Thrown when fails to make API call - Competition run ID + Session Token (optional) + Cancellation Token to cancel request (optional) Task of ApiResponse (string) - - - Represents a collection of functions to interact with the API endpoints - - - - - Initializes a new instance of the class. - - - - - - Initializes a new instance of the class - - - - - - Initializes a new instance of the class - using Configuration object - - An instance of Configuration - - - - - Gets the base path of the API client. - - The base path - - - - Sets the base path of the API client. - - The base path - - - - Gets or sets the configuration object - - An instance of the Configuration - - - - Provides a factory method hook for the creation of exceptions. - - - + - Gets the default header. - - Dictionary of HTTP header - - - - Add default header. - - Header field name. - Header field value. - - - - - Provides a JSON download of the entire competition description structure. + Updates the specified user, if it exists. Anyone is allowed to update their data, however only ADMINs are allowed to update anyone. Thrown when fails to make API call - Competition ID - string + User ID + (optional) + ApiUser - + - Provides a JSON download of the entire competition description structure. + Updates the specified user, if it exists. Anyone is allowed to update their data, however only ADMINs are allowed to update anyone. Thrown when fails to make API call - Competition ID - ApiResponse of string + User ID + (optional) + ApiResponse of ApiUser - + - Provides a JSON download of the entire competition description structure. + Updates the specified user, if it exists. Anyone is allowed to update their data, however only ADMINs are allowed to update anyone. Thrown when fails to make API call - Competition ID - Task of string + User ID + (optional) + Cancellation Token to cancel request (optional) + Task of ApiUser - + - Provides a JSON download of the entire competition description structure. + Updates the specified user, if it exists. Anyone is allowed to update their data, however only ADMINs are allowed to update anyone. Thrown when fails to make API call - Competition ID - Task of ApiResponse (string) + User ID + (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) - + - Provides a JSON download of the entire competition run structure. + Sets roles for session based on user account and returns a session cookie. Thrown when fails to make API call - Competition run ID - string + (optional) + ApiUser - + - Provides a JSON download of the entire competition run structure. + Sets roles for session based on user account and returns a session cookie. Thrown when fails to make API call - Competition run ID - ApiResponse of string + (optional) + ApiResponse of ApiUser - + - Provides a JSON download of the entire competition run structure. + Sets roles for session based on user account and returns a session cookie. Thrown when fails to make API call - Competition run ID - Task of string + (optional) + Cancellation Token to cancel request (optional) + Task of ApiUser - + - Provides a JSON download of the entire competition run structure. + Sets roles for session based on user account and returns a session cookie. Thrown when fails to make API call - Competition run ID - Task of ApiResponse (string) + (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) - + - Provides a CSV download with the scores for a given competition run. + Creates a new user, if the username is not already taken. Requires ADMIN privileges Thrown when fails to make API call - Competition run ID - string + (optional) + ApiUser - + - Provides a CSV download with the scores for a given competition run. + Creates a new user, if the username is not already taken. Requires ADMIN privileges Thrown when fails to make API call - Competition run ID - ApiResponse of string + (optional) + ApiResponse of ApiUser - + - Provides a CSV download with the scores for a given competition run. + Creates a new user, if the username is not already taken. Requires ADMIN privileges Thrown when fails to make API call - Competition run ID - Task of string + (optional) + Cancellation Token to cancel request (optional) + Task of ApiUser - + - Provides a CSV download with the scores for a given competition run. + Creates a new user, if the username is not already taken. Requires ADMIN privileges Thrown when fails to make API call - Competition run ID - Task of ApiResponse (string) + (optional) + Cancellation Token to cancel request (optional) + Task of ApiResponse (ApiUser) @@ -2517,7 +7411,7 @@ Content Type of the request Object - + Makes the asynchronous HTTP request. @@ -2530,6 +7424,7 @@ File parameters. Path parameters. Content type. + Cancellation Token. The Task instance. @@ -2640,7 +7535,7 @@ - Convert params to key/value pairs. + Convert params to key/value pairs. Use collectionFormat to properly format lists and collections. Collection format. @@ -2688,7 +7583,7 @@ Gets the date time format. - Date time foramt. + Date time format. diff --git a/Runtime/Scripts/Dres/UnityClient/DresClient.cs b/Runtime/Scripts/Dres/UnityClient/DresClient.cs index 71fa089..fb081b2 100644 --- a/Runtime/Scripts/Dres/UnityClient/DresClient.cs +++ b/Runtime/Scripts/Dres/UnityClient/DresClient.cs @@ -1,7 +1,8 @@ -using System.Collections.Generic; +using System; +using System.Collections.Generic; using System.Threading.Tasks; using Dev.Dres.ClientApi.Model; -using UnityEditor; +using JetBrains.Annotations; namespace Dres.Unityclient { @@ -15,7 +16,18 @@ public class DresClient /// /// The user state, available after . /// - public UserDetails UserDetails; + public ApiUser UserDetails { get; private set; } + + /// + /// List of the available evaluations for the current user. + /// Must be updated manually with before use. + /// + public List EvaluationInfo { get; private set; } + + /// + /// The currently selected evaluation. Used for submissions. + /// + public ApiClientEvaluationInfo CurrentEvaluation { get; private set; } /// /// Login to DRES with the currently loaded credentials. @@ -27,7 +39,55 @@ public async Task Login() UserDetails = await DresWrapper.Login(config.user, config.password); } - + /// + /// Updates the list of available evaluations for the current user. + /// + /// List of available evaluations + public async Task> UpdateEvaluations() + { + EvaluationInfo = await DresWrapper.ListClientEvaluations(UserDetails.SessionId); + return EvaluationInfo; + } + + /// + /// Sets the current evaluation to the one with the given id. + /// + /// The id of the evaluation to set as current + /// True if the evaluation was found and set, false otherwise + public bool SetCurrentEvaluation(string evaluationId) + { + CurrentEvaluation = EvaluationInfo.Find(evaluation => evaluation.Id == evaluationId); + return CurrentEvaluation != null; + } + + /// + /// Submits the given item (and optionally start & end information) to the DRES instance as current user. + /// + /// The item name or identifier to submit + /// Optional, the item's start time + /// Optional, the item's end time + /// Manual override of the evaluation ID of the currently set evaluation. + /// The success / failure state of the operation + public Task SubmitResultV2(string item, long? start = null, long? end = null, + [CanBeNull] string evaluationId = null) + { + evaluationId ??= CurrentEvaluation.Id; + return DresWrapper.SubmitV2(UserDetails.SessionId, evaluationId, item, start, end); + } + + /// + /// Submits the given text to the DRES instance as current user + /// + /// The text to submit (this can be anything). + /// Manual override of the evaluation ID of the currently set evaluation. + /// The success / failure state of the operation + public Task SubmitTextualResultV2(string text, [CanBeNull] string evaluationId = null) + { + evaluationId ??= CurrentEvaluation.Id; + return DresWrapper.SubmitTextV2(UserDetails.SessionId, evaluationId, text); + } + + /// /// Submits the given item (and optionally frame informaiton) to the DRES instance as current user. /// @@ -35,9 +95,10 @@ public async Task Login() /// Optional, the item's frame number. This can likely be omitted, if there is no such /// concept as frames for the given item (e.g. for videos, a frame is reasonable while for images it isn't. /// The success / failure state of the operation - public async Task SubmitResult(string item, int? frame = null) + [Obsolete("Obsolete")] + public Task SubmitResult(string item, int? frame = null) { - return await DresWrapper.Submit(item, UserDetails.SessionId, frame); + return DresWrapper.Submit(item, UserDetails.SessionId, frame); } /// @@ -45,9 +106,10 @@ public async Task SubmitResult(string item, int? fr /// /// The text to submit (this can be anything). /// The success / failure state of the operation - public async Task SubmitTextualResult(string text) + [Obsolete("Obsolete")] + public Task SubmitTextualResult(string text) { - return await DresWrapper.SubmitText(text, UserDetails.SessionId); + return DresWrapper.SubmitText(text, UserDetails.SessionId); } /// @@ -61,10 +123,10 @@ public async Task SubmitTextualResult(string text) /// The results to log /// The events associated with these results /// The success / failure state of the operation - public async Task LogResults(long timestamp, string sortType, string resultSetAvailability, + public Task LogResults(long timestamp, string sortType, string resultSetAvailability, List results, List events) { - return await DresWrapper.LogResults(timestamp, sortType, resultSetAvailability, results, events, + return DresWrapper.LogResults(timestamp, sortType, resultSetAvailability, results, events, UserDetails.SessionId); } @@ -76,9 +138,9 @@ public async Task LogResults(long timestamp, string sortType, str /// The client side timestamp of this log /// The events to log /// The success / failure state of the operation - public async Task LogQueryEvents(long timestamp, List events) + public Task LogQueryEvents(long timestamp, List events) { - return await DresWrapper.LogQueryEvents(timestamp, events, UserDetails.SessionId); + return DresWrapper.LogQueryEvents(timestamp, events, UserDetails.SessionId); } } } \ No newline at end of file diff --git a/Runtime/Scripts/Dres/UnityClient/DresWrapper.cs b/Runtime/Scripts/Dres/UnityClient/DresWrapper.cs index fd8a325..3030439 100644 --- a/Runtime/Scripts/Dres/UnityClient/DresWrapper.cs +++ b/Runtime/Scripts/Dres/UnityClient/DresWrapper.cs @@ -1,4 +1,5 @@ -using System.Collections.Generic; +using System; +using System.Collections.Generic; using System.Threading.Tasks; using Dev.Dres.ClientApi.Api; using Dev.Dres.ClientApi.Client; @@ -14,39 +15,92 @@ namespace Dres.Unityclient /// internal static class DresWrapper { - + internal static readonly EvaluationClientApi EvaluationClientApi = new(DresConfigManager.Instance.ApiConfiguration); + /// /// The deliberately single Logging Api instance of DRES. Used to send logs to DRES /// - internal static readonly LogApi LogApi = new LogApi(DresConfigManager.Instance.ApiConfiguration); + internal static readonly LogApi LogApi = new(DresConfigManager.Instance.ApiConfiguration); + /// /// The deliberately single Status Api instance of DRES. Used to get the status of DRES /// - internal static readonly StatusApi StatusApi = new StatusApi(DresConfigManager.Instance.ApiConfiguration); + internal static readonly StatusApi StatusApi = new(DresConfigManager.Instance.ApiConfiguration); + /// /// The deliberately single Submission Api instance of DRES. Used to submit media items during competitions to DRES: /// - internal static readonly SubmissionApi SubmissionApi = new SubmissionApi(DresConfigManager.Instance.ApiConfiguration); + internal static readonly SubmissionApi SubmissionApi = new(DresConfigManager.Instance.ApiConfiguration); + /// /// The deliberately single User Api instance of DRES. Used to log into DRES and retrieve the session id of the user. /// - internal static readonly UserApi UserApi = new UserApi(DresConfigManager.Instance.ApiConfiguration); + internal static readonly UserApi UserApi = new(DresConfigManager.Instance.ApiConfiguration); /// /// Login to DRES with given username and password. - /// The login state (i.e. the ) are not kept + /// The login state (i.e. the ) are not kept /// and have to be managed by the caller. /// /// The DRES username /// The DRES password /// The login state on success. /// If the config has no credentials set and no credentials file exists - internal static async Task Login(string user, string password) + internal static Task Login(string user, string password) { var loginRequest = new LoginRequest(user, password); - return await UserApi.PostApiV1LoginAsync(loginRequest); + return UserApi.PostApiV2LoginAsync(loginRequest); + } + + internal static Task> ListClientEvaluations(string session) + { + return EvaluationClientApi.GetApiV2ClientEvaluationListAsync(session); + } + + internal static Task GetTaskInfo(string evaluationId, string session) + { + return EvaluationClientApi.GetApiV2ClientEvaluationCurrentTaskByEvaluationIdAsync(evaluationId, session); } + /// + /// Submits an item to the DRES endpoint using the DRES API v2. + /// + /// The session ID to which this submission belongs + /// The evaluation ID to which this submission belongs + /// The name of the item (or identifier) to submit + /// The optional start (in milliseconds) of the submitted item + /// The optional end (in milliseconds) of the submitted item + /// The submission state on success / failure. + internal static Task SubmitV2(string session, string evaluationId, string item, long? start = null, + long? end = null) + { + var answerSets = new List + { + new(answers: new List + { + new(mediaItemName: item, start: start.GetValueOrDefault(), end: end.GetValueOrDefault()) + }) + }; + var apiClientSubmission = new ApiClientSubmission(answerSets); + return SubmissionApi.PostApiV2SubmitByEvaluationIdAsync(evaluationId, apiClientSubmission, session); + } + + /// + /// Submits text to the DRES endpoint using the DRES API v2. + /// + /// The session ID to which this submission belongs + /// The evaluation ID to which this submission belongs + /// The text to submit + /// The submission state on success / failure. + internal static Task SubmitTextV2(string session, string evaluationId, string text) + { + var answerSets = new List { new(answers: new List { new(text: text) }) }; + var apiClientSubmission = new ApiClientSubmission(answerSets); + return SubmissionApi.PostApiV2SubmitByEvaluationIdAsync(evaluationId, apiClientSubmission, session); + } + + // TODO: Once the functionality of the new API is confirmed, implement bulk submission + /// /// Submits an item to the DRES endpoint. /// Submissions are only allowed during active competitions (inferred from the given sesssion id) @@ -57,11 +111,12 @@ internal static async Task Login(string user, string password) /// If no notion of frames exist for the item, this can likely be omitted. /// The submission state on success / failure. /// A 404 if there is no ongoing competition for this session, a 403 if there is no such user - internal static async Task Submit(string item, string session, int? frame = null) + [Obsolete("Obsolete")] + internal static Task Submit(string item, string session, int? frame = null) { - return await SubmissionApi.GetApiV1SubmitAsync(item: item, frame: frame, session: session); + return SubmissionApi.GetApiV1SubmitAsync(item: item, frame: frame, session: session); } - + /// /// Submits given TEXT to the DRES endpoint. /// Submissions are only allowed during active competitions (inferred from the given sesssion id) @@ -70,9 +125,10 @@ internal static async Task Submit(string item, stri /// The session id to which this submission belongs /// The submission state on success / failure. /// A 404 if there is no ongoing competition for this session, a 403 if there is no such user - internal static async Task SubmitText(string text, string session) + [Obsolete("Obsolete")] + internal static Task SubmitText(string text, string session) { - return await SubmissionApi.GetApiV1SubmitAsync(text: text, session: session); + return SubmissionApi.GetApiV1SubmitAsync(text: text, session: session); } @@ -89,11 +145,11 @@ internal static async Task SubmitText(string text, /// The session id to which this log belongs /// The state of success / failure of the log sending. /// A 404 if there is no ongoing competition for this session, a 403 if there is no such user - internal static async Task LogResults(long timestamp, string sortType, string resultSetAvailability, + internal static Task LogResults(long timestamp, string sortType, string resultSetAvailability, List results, List events, string session) { var resultLog = new QueryResultLog(timestamp, sortType, resultSetAvailability, results, events); - return await LogApi.PostApiV1LogResultAsync(session, resultLog); + return LogApi.PostApiV2LogResultAsync(session, resultLog); } /// @@ -106,10 +162,10 @@ internal static async Task LogResults(long timestamp, string sort /// The session id to which this log belongs /// The state of success / failure of the log sending. /// A 404 if there is no ongoing competition for this session, a 403 if there is no such user - internal static async Task LogQueryEvents(long timestamp, List events, string session) + internal static Task LogQueryEvents(long timestamp, List events, string session) { var queryEventLog = new QueryEventLog(timestamp, events); - return await LogApi.PostApiV1LogQueryAsync(session, queryEventLog); + return LogApi.PostApiV2LogQueryAsync(session, queryEventLog); } } } \ No newline at end of file diff --git a/build.gradle b/build.gradle index 5b0e312..30add06 100644 --- a/build.gradle +++ b/build.gradle @@ -3,7 +3,7 @@ import org.apache.tools.ant.taskdefs.condition.Os /* Get the openapi generator plugin */ plugins { - id "org.openapi.generator" version "4.3.1" + id "org.openapi.generator" version "6.4.0" } /* Setup OpenApi Specs (OAS): Defaults to default.*/ @@ -11,7 +11,7 @@ plugins { + http://localhost:8080/client-oas.json // Local DRES + https://raw.githubusercontent.com/dres-dev/DRES/master/doc/oas-client.json // When oas-client is released */ -def dresOAS = "https://raw.githubusercontent.com/dres-dev/DRES/1.0/doc/oas-client.json" +def dresOAS = "https://raw.githubusercontent.com/dres-dev/DRES/2.0.0-RC1/doc/oas-client.json" /* If gradle gets 'oas' argument (with -Poas="path/to/OAS"), take these */ if(project.hasProperty('oas')){ dresOAS = oas @@ -68,9 +68,9 @@ task modex(type: Exec){ task deployLibs(type: Copy){ from(file("$rootDir/Generated/bin")) into(file("$rootDir/Runtime/Libs")) - rename("RestSharp.dll", "RestSharp.Dres.dll") - rename("Newtonsoft.Json.dll", "Newtonsoft.Json.Dres.dll") - rename("JsonSubTypes.dll", "JsonSubTypes.Dres.dll") + rename("RestSharp.dll", "RestSharp." + dllName + ".dll") + rename("Newtonsoft.Json.dll", "Newtonsoft.Json." + dllName + ".dll") + rename("JsonSubTypes.dll", "JsonSubTypes." + dllName + ".dll") } /* Copy the mandatory link.xml */ diff --git a/package.json b/package.json index 10597c2..48e88c0 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "dev.dres.unityclient", - "version": "1.1.0", + "version": "1.2.0", "displayName": "DRES Unity Client", "description": "An all-unity client for [DRES](https://github.com/dres-dev/DRES)", "unity": "2020.3",