diff --git a/Runtime/Libs/Dev.Dres.ClientApi.dll b/Runtime/Libs/Dev.Dres.ClientApi.dll old mode 100644 new mode 100755 index dc63cfe..3a3c53f 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 578c07b..b7c99db 100644 --- a/Runtime/Libs/Dev.Dres.ClientApi.xml +++ b/Runtime/Libs/Dev.Dres.ClientApi.xml @@ -1,3565 +1,3041 @@ - - - - Dev.Dres.ClientApi - - - - - Represents a collection of functions to interact with the API endpoints - - - - - Represents configuration aspects required to interact with the API endpoints. - - - - - Gets 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. - - - - - 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 - - - - Lists an overview of all competition runs visible to the current client - - - - - Thrown when fails to make API call - Session Token - ClientRunInfoList - - - - Lists an overview of all competition runs visible to the current client - - - - - Thrown when fails to make API call - Session Token - ApiResponse of ClientRunInfoList - - - - 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) - - - - Lists an overview of all competition runs visible to the current client - - - - - Thrown when fails to make API call - Session Token - Task of ClientRunInfoList - - - - Lists an overview of all competition runs visible to the current client - - - - - Thrown when fails to make API call - Session Token - Task of ApiResponse (ClientRunInfoList) - - - - 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 the default header. - - Dictionary of HTTP header - - - - Add default header. - - Header field name. - 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 - - 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) - - - - Lists an overview of all competition runs visible to the current client - - Thrown when fails to make API call - Session Token - ClientRunInfoList - - - - Lists an overview of all competition runs visible to the current client - - Thrown when fails to make API call - Session Token - ApiResponse of ClientRunInfoList - - - - Lists an overview of all competition runs visible to the current client - - Thrown when fails to make API call - Session Token - Task of ClientRunInfoList - - - - Lists an overview of all competition runs visible to the current client - - Thrown when fails to make API call - Session Token - Task of ApiResponse (ClientRunInfoList) - - - - Gets or sets the configuration object - - An instance of the Configuration - - - - Provides a factory method hook for the creation of exceptions. - - - - - Represents a collection of functions to interact with the API endpoints - - - - - Provides a JSON download of the entire competition description structure. - - - - - Thrown when fails to make API call - Competition ID - string - - - - Provides a JSON download of the entire competition description structure. - - - - - Thrown when fails to make API call - Competition ID - ApiResponse of string - - - - Provides a JSON download of the entire competition run structure. - - - - - Thrown when fails to make API call - Competition run ID - string - - - - Provides a JSON download of the entire competition run structure. - - - - - Thrown when fails to make API call - Competition run ID - ApiResponse of string - - - - Provides a CSV download with the scores for a given competition run. - - - - - Thrown when fails to make API call - Competition run ID - string - - - - Provides a CSV download with the scores for a given competition run. - - - - - Thrown when fails to make API call - Competition run ID - 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. - - - - - Thrown when fails to make API call - Competition run ID - Task of string - - - - Provides a CSV download with the scores for a given competition run. - - - - - Thrown when fails to make API call - Competition run ID - 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 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. - - Thrown when fails to make API call - Competition ID - string - - - - Provides a JSON download of the entire competition description structure. - - Thrown when fails to make API call - Competition ID - 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 - string - - - - Provides a JSON download of the entire competition run structure. - - Thrown when fails to make API call - Competition run ID - ApiResponse of 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. - - Thrown when fails to make API call - Competition run ID - string - - - - Provides a CSV download with the scores for a given competition run. - - Thrown when fails to make API call - Competition run ID - ApiResponse of string - - - - Provides a CSV download with the scores for a given competition run. - - Thrown when fails to make API call - Competition run ID - Task of string - - - - Provides a CSV download with the scores for a given competition run. - - Thrown when fails to make API call - Competition run ID - Task of ApiResponse (string) - - - - Gets or sets the configuration object - - An instance of the Configuration - - - - Provides a factory method hook for the creation of exceptions. - - - - - Represents a collection of functions to interact with the API endpoints - - - - - Accepts query logs from participants - - - - - Thrown when fails to make API call - Session Token - (optional) - SuccessStatus - - - - Accepts query 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) - SuccessStatus - - - - Accepts result 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) - Task of SuccessStatus - - - - Accepts query logs from participants - - - - - Thrown when fails to make API call - Session Token - (optional) - Task of ApiResponse (SuccessStatus) - - - - Accepts result logs from participants - - - - - Thrown when fails to make API call - Session Token - (optional) - Task of SuccessStatus - - - - Accepts result logs from participants - - - - - Thrown when fails to make API call - Session Token - (optional) - Task of ApiResponse (SuccessStatus) - - - - 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 the default header. - - Dictionary of HTTP header - - - - Add default header. - - Header field name. - Header field value. - - - - - Accepts query logs from participants - - Thrown when fails to make API call - Session Token - (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) - Task of SuccessStatus - - - - Accepts query logs from participants - - Thrown when fails to make API call - Session Token - (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) - Task of SuccessStatus - - - - Accepts result logs from participants - - Thrown when fails to make API call - Session Token - (optional) - Task of ApiResponse (SuccessStatus) - - - - Gets or sets the configuration object - - An instance of the Configuration - - - - Provides a factory method hook for the creation of exceptions. - - - - - Represents a collection of functions to interact with the API endpoints - - - - - 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 - Task of CurrentTime - - - - Returns the current time on the server. - - - - - Thrown when fails to make API call - Task of ApiResponse (CurrentTime) - - - - 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 the default header. - - Dictionary of HTTP header - - - - Add default header. - - Header field name. - 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 - Task of CurrentTime - - - - Returns the current time on the server. - - Thrown when fails to make API call - Task of ApiResponse (CurrentTime) - - - - Gets or sets the configuration object - - An instance of the Configuration - - - - Provides a factory method hook for the creation of exceptions. - - - - - Represents a collection of functions to interact with the API endpoints - - - - - Endpoint to accept submissions - - - - - 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) - 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 - - - - - 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) - 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 - - - - - 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) - 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) - Task of SuccessfulSubmissionsStatus - - - - Endpoint to accept submissions - - - - - 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) - 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) - Task of ApiResponse (SuccessfulSubmissionsStatus) - - - - 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 the default header. - - Dictionary of HTTP header - - - - Add default header. - - Header field name. - Header field value. - - - - - Endpoint to accept submissions - - 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) - 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 - - 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) - 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 - - 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) - 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) - Task of SuccessfulSubmissionsStatus - - - - Endpoint to accept submissions - - 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) - 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) - Task of ApiResponse (SuccessfulSubmissionsStatus) - - - - Gets or sets the configuration object - - An instance of the Configuration - - - - Provides a factory method hook for the creation of exceptions. - - - - - 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 - UserDetails - - - - Deletes the specified user. Requires ADMIN privileges - - - - - Thrown when fails to make API call - User ID - ApiResponse of UserDetails - - - - 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 - UserDetails - - - - Get information about the current user. - - - - - Thrown when fails to make API call - ApiResponse of UserDetails - - - - Get current sessionId - - - - - Thrown when fails to make API call - Session Token (optional) - SessionId - - - - Get current sessionId - - - - - Thrown when fails to make API call - Session Token (optional) - ApiResponse of SessionId - - - - Gets details of the user with the given id - - - - - Thrown when fails to make API call - User's UID - UserDetails - - - - Gets details of the user with the given id - - - - - Thrown when fails to make API call - User's UID - ApiResponse of UserDetails - - - - 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) - UserDetails - - - - 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) - ApiResponse of UserDetails - - - - Sets roles for session based on user account and returns a session cookie. - - - - - Thrown when fails to make API call - (optional) - UserDetails - - - - Sets roles for session based on user account and returns a session cookie. - - - - - Thrown when fails to make API call - (optional) - ApiResponse of UserDetails - - - - Creates a new user, if the username is not already taken. Requires ADMIN privileges - - - - - Thrown when fails to make API call - (optional) - UserDetails - - - - Creates a new user, if the username is not already taken. Requires ADMIN privileges - - - - - Thrown when fails to make API call - (optional) - ApiResponse of UserDetails - - - - Deletes the specified user. Requires ADMIN privileges - - - - - Thrown when fails to make API call - User ID - Task of UserDetails - - - - Deletes the specified user. Requires ADMIN privileges - - - - - Thrown when fails to make API call - User ID - Task of ApiResponse (UserDetails) - - - - Clears all user roles of the current session. - - - - - Thrown when fails to make API call - Session Token (optional) - Task of SuccessStatus - - - - Clears all user roles of the current session. - - - - - Thrown when fails to make API call - Session Token (optional) - Task of ApiResponse (SuccessStatus) - - - - Get information about the current user. - - - - - Thrown when fails to make API call - Task of UserDetails - - - - Get information about the current user. - - - - - Thrown when fails to make API call - Task of ApiResponse (UserDetails) - - - - Get current sessionId - - - - - Thrown when fails to make API call - Session Token (optional) - Task of SessionId - - - - Get current sessionId - - - - - Thrown when fails to make API call - Session Token (optional) - Task of ApiResponse (SessionId) - - - - Gets details of the user with the given id - - - - - Thrown when fails to make API call - User's UID - Task of UserDetails - - - - Gets details of the user with the given id - - - - - Thrown when fails to make API call - User's UID - Task of ApiResponse (UserDetails) - - - - 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) - Task of UserDetails - - - - 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) - Task of ApiResponse (UserDetails) - - - - Sets roles for session based on user account and returns a session cookie. - - - - - Thrown when fails to make API call - (optional) - Task of UserDetails - - - - Sets roles for session based on user account and returns a session cookie. - - - - - Thrown when fails to make API call - (optional) - Task of ApiResponse (UserDetails) - - - - Creates a new user, if the username is not already taken. Requires ADMIN privileges - - - - - Thrown when fails to make API call - (optional) - Task of UserDetails - - - - Creates a new user, if the username is not already taken. Requires ADMIN privileges - - - - - Thrown when fails to make API call - (optional) - Task of ApiResponse (UserDetails) - - - - 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 the default header. - - Dictionary of HTTP header - - - - Add default header. - - Header field name. - Header field value. - - - - - Deletes the specified user. Requires ADMIN privileges - - Thrown when fails to make API call - User ID - UserDetails - - - - Deletes the specified user. Requires ADMIN privileges - - Thrown when fails to make API call - User ID - ApiResponse of UserDetails - - - - Deletes the specified user. Requires ADMIN privileges - - Thrown when fails to make API call - User ID - Task of UserDetails - - - - Deletes the specified user. Requires ADMIN privileges - - Thrown when fails to make API call - User ID - Task of ApiResponse (UserDetails) - - - - 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 - - - - Clears all user roles of the current session. - - Thrown when fails to make API call - Session Token (optional) - Task of SuccessStatus - - - - Clears all user roles of the current session. - - Thrown when fails to make API call - Session Token (optional) - Task of ApiResponse (SuccessStatus) - - - - Get information about the current user. - - Thrown when fails to make API call - UserDetails - - - - Get information about the current user. - - Thrown when fails to make API call - ApiResponse of UserDetails - - - - Get information about the current user. - - Thrown when fails to make API call - Task of UserDetails - - - - Get information about the current user. - - Thrown when fails to make API call - Task of ApiResponse (UserDetails) - - - - Get current sessionId - - Thrown when fails to make API call - Session Token (optional) - SessionId - - - - Get current sessionId - - Thrown when fails to make API call - Session Token (optional) - ApiResponse of SessionId - - - - Get current sessionId - - Thrown when fails to make API call - Session Token (optional) - Task of SessionId - - - - Get current sessionId - - Thrown when fails to make API call - Session Token (optional) - Task of ApiResponse (SessionId) - - - - Gets details of the user with the given id - - Thrown when fails to make API call - User's UID - UserDetails - - - - Gets details of the user with the given id - - Thrown when fails to make API call - User's UID - ApiResponse of UserDetails - - - - Gets details of the user with the given id - - Thrown when fails to make API call - User's UID - Task of UserDetails - - - - Gets details of the user with the given id - - Thrown when fails to make API call - User's UID - Task of ApiResponse (UserDetails) - - - - 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) - UserDetails - - - - 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) - ApiResponse of UserDetails - - - - 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) - Task of UserDetails - - - - 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) - Task of ApiResponse (UserDetails) - - - - Sets roles for session based on user account and returns a session cookie. - - Thrown when fails to make API call - (optional) - UserDetails - - - - Sets roles for session based on user account and returns a session cookie. - - Thrown when fails to make API call - (optional) - ApiResponse of UserDetails - - - - Sets roles for session based on user account and returns a session cookie. - - Thrown when fails to make API call - (optional) - Task of UserDetails - - - - Sets roles for session based on user account and returns a session cookie. - - Thrown when fails to make API call - (optional) - Task of ApiResponse (UserDetails) - - - - Creates a new user, if the username is not already taken. Requires ADMIN privileges - - Thrown when fails to make API call - (optional) - UserDetails - - - - Creates a new user, if the username is not already taken. Requires ADMIN privileges - - Thrown when fails to make API call - (optional) - ApiResponse of UserDetails - - - - Creates a new user, if the username is not already taken. Requires ADMIN privileges - - Thrown when fails to make API call - (optional) - Task of UserDetails - - - - Creates a new user, if the username is not already taken. Requires ADMIN privileges - - Thrown when fails to make API call - (optional) - Task of ApiResponse (UserDetails) - - - - Gets or sets the configuration object - - An instance of the Configuration - - - - Provides a factory method hook for the creation of exceptions. - - - - - API client is mainly responsible for making the HTTP call to the API backend. - - - - - Initializes a new instance of the class - with default configuration. - - - - - Initializes a new instance of the class - with default base path (http://localhost). - - An instance of Configuration. - - - - Initializes a new instance of the class - with default configuration. - - The base path. - - - - Gets or sets the default API client for making HTTP calls. - - The default API client. - - - - Makes the HTTP request (Sync). - - URL path. - HTTP method. - Query parameters. - HTTP body (POST request). - Header parameters. - Form parameters. - File parameters. - Path parameters. - Content Type of the request - Object - - - - Makes the asynchronous HTTP request. - - URL path. - HTTP method. - Query parameters. - HTTP body (POST request). - Header parameters. - Form parameters. - File parameters. - Path parameters. - Content type. - The Task instance. - - - - Escape string (url-encoded). - - String to be escaped. - Escaped string. - - - - Create FileParameter based on Stream. - - Parameter name. - Input stream. - FileParameter. - - - - If parameter is DateTime, output in a formatted string (default ISO 8601), customizable with Configuration.DateTime. - If parameter is a list, join the list with ",". - Otherwise just return the string. - - The parameter (header, path, query, form). - Formatted string. - - - - Deserialize the JSON string into a proper object. - - The HTTP response. - Object type. - Object representation of the JSON string. - - - - Serialize an input (model) into JSON string - - Object. - JSON string. - - - - Check if the given MIME is a JSON MIME. - JSON MIME examples: - application/json - application/json; charset=UTF8 - APPLICATION/JSON - application/vnd.company+json - - MIME - Returns True if MIME type is json. - - - - Select the Content-Type header's value from the given content-type array: - if JSON type exists in the given array, use it; - otherwise use the first one defined in 'consumes' - - The Content-Type array to select from. - The Content-Type header to use. - - - - Select the Accept header's value from the given accepts array: - if JSON exists in the given array, use it; - otherwise use all of them (joining into a string) - - The accepts array to select from. - The Accept header to use. - - - - Encode string in base64 format. - - String to be encoded. - Encoded string. - - - - Dynamically cast the object into target type. - - Object to be casted - Target type - Casted object - - - - Convert stream to byte array - - Input stream to be converted - Byte array - - - - URL encode a string - Credit/Ref: https://github.com/restsharp/RestSharp/blob/master/RestSharp/Extensions/StringExtensions.cs#L50 - - String to be URL encoded - Byte array - - - - Sanitize filename by removing the path - - Filename - Filename - - - - Convert params to key/value pairs. - Use collectionFormat to properly format lists and collections. - - Collection format. - Key name. - Value object. - A list of KeyValuePairs - - - - Check if generic object is a collection. - - - True if object is a collection type - - - - Gets or sets an instance of the IReadableConfiguration. - - An instance of the IReadableConfiguration. - - helps us to avoid modifying possibly global - configuration values from within a given client. It does not guarantee thread-safety - of the instance in any way. - - - - - Gets or sets the RestClient. - - An instance of the RestClient - - - - API Exception - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - HTTP status code. - Error message. - - - - Initializes a new instance of the class. - - HTTP status code. - Error message. - Error content. - - - - Gets or sets the error code (HTTP status code) - - The error code (HTTP status code). - - - - Gets or sets the error content (body json object) - - The error content (Http response body). - - - - API Response - - - - - Initializes a new instance of the class. - - HTTP status code. - HTTP headers. - Data (parsed HTTP body) - - - - Gets or sets the status code (HTTP status code) - - The status code. - - - - Gets or sets the HTTP headers - - HTTP headers - - - - Gets or sets the data (parsed HTTP body) - - The data. - - - - Represents a set of configuration settings - - - - - Represents a readable-only configuration contract. - - - - - Gets the API key with prefix. - - API key identifier (authentication scheme). - API key with prefix. - - - - Gets the access token. - - Access token. - - - - Gets the API key. - - API key. - - - - Gets the API key prefix. - - API key prefix. - - - - Gets the base path. - - Base path. - - - - Gets the date time format. - - Date time foramt. - - - - Gets the default header. - - Default header. - - - - Gets the temp folder path. - - Temp folder path. - - - - Gets the HTTP connection timeout (in milliseconds) - - HTTP connection timeout. - - - - Gets the user agent. - - User agent. - - - - Gets the username. - - Username. - - - - Gets the password. - - Password. - - - - Version of the package. - - Version of the package. - - - - Identifier for ISO 8601 DateTime Format - - See https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx#Anchor_8 for more information. - - - - Default creation of exceptions for a given method name and response object - - - - - Gets or sets the API key based on the authentication name. - - The API key. - - - - Gets or sets the prefix (e.g. Token) of the API key based on the authentication name. - - The prefix of the API key. - - - - Initializes a new instance of the class - - - - - Initializes a new instance of the class - - - - - Initializes a new instance of the class with different settings - - Api client - Dictionary of default HTTP header - Username - Password - accessToken - Dictionary of API key - Dictionary of API key prefix - Temp folder path - DateTime format string - HTTP connection timeout (in milliseconds) - HTTP user agent - - - - Initializes a new instance of the Configuration class. - - Api client. - - - - Gets the API key with prefix. - - API key identifier (authentication scheme). - API key with prefix. - - - - Add default header. - - Header field name. - Header field value. - - - - - Creates a new based on this instance. - - - - - - Returns a string with essential information for debugging. - - - - - Add Api Key Header. - - Api Key name. - Api Key value. - - - - - Sets the API key prefix. - - Api Key name. - Api Key value. - - - - Gets or sets the default Configuration. - - Configuration. - - - - Gets an instance of an ApiClient for this configuration - - - - - Gets or sets the base path for API access. - - - - - Gets or sets the default header. - - - - - Gets or sets the HTTP timeout (milliseconds) of ApiClient. Default to 100000 milliseconds. - - - - - Gets or sets the HTTP user agent. - - Http user agent. - - - - Gets or sets the username (HTTP basic authentication). - - The username. - - - - Gets or sets the password (HTTP basic authentication). - - The password. - - - - Gets or sets the access token for OAuth2 authentication. - - The access token. - - - - Gets or sets the temporary folder path to store the files downloaded from the server. - - Folder path. - - - - Gets or sets the date time format used when serializing in the ApiClient - By default, it's set to ISO 8601 - "o", for others see: - https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx - and https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx - No validation is done to ensure that the string you're providing is valid - - The DateTimeFormat string - - - - Gets or sets the prefix (e.g. Token) of the API key based on the authentication name. - - The prefix of the API key. - - - - Gets or sets the API key based on the authentication name. - - The API key. - - - - A delegate to ExceptionFactory method - - Method name - Response - Exceptions - - - - provides a compile-time extension point for globally configuring - API Clients. - - - A customized implementation via partial class may reside in another file and may - be excluded from automatic generation via a .openapi-generator-ignore file. - - - - - Formatter for 'date' openapi formats ss defined by full-date - RFC3339 - see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#data-types - - - - - Initializes a new instance of the class. - - - - - ClientRunInfo - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - id (required). - name (required). - description. - status (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 ClientRunInfo instances are equal - - Instance of ClientRunInfo to be compared - Boolean - - - - Gets the hash code - - Hash code - - - - To validate all properties of the instance - - Validation context - Validation Result - - - - Gets or Sets Status - - - - - Gets or Sets Id - - - - - Gets or Sets Name - - - - - Gets or Sets Description - - - - - Defines Status - - - - - Enum CREATED for value: CREATED - - - - - Enum ACTIVE for value: ACTIVE - - - - - Enum PREPARINGTASK for value: PREPARING_TASK - - - - - Enum RUNNINGTASK for value: RUNNING_TASK - - - - - Enum TASKENDED for value: TASK_ENDED - - - - - Enum TERMINATED for value: TERMINATED - - - - - ClientRunInfoList - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - runs (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 ClientRunInfoList instances are equal - - Instance of ClientRunInfoList to be compared - Boolean - - - - Gets the hash code - - Hash code - - - - To validate all properties of the instance - - Validation context - Validation Result - - - - Gets or Sets Runs - - - - - ClientTaskInfo - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - id (required). - name (required). - taskGroup (required). - remainingTime (required). - running (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 ClientTaskInfo instances are equal - - Instance of ClientTaskInfo to be compared - Boolean - - - - Gets the hash code - - Hash code - - - - To validate all properties of the instance - - Validation context - Validation Result - - - - Gets or Sets Id - - - - - Gets or Sets Name - - - - - Gets or Sets TaskGroup - - - - - Gets or Sets RemainingTime - - - - - Gets or Sets Running - - - - - CurrentTime - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - timeStamp (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 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 - - - - Gets or Sets TimeStamp - - - - - ErrorStatus - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - description (required). - status (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 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 - - - - Gets or Sets Description - - - - - Gets or Sets Status - - - - - LoginRequest - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - username (required). - password (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 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 - - - - Gets or Sets Username - - - - - Gets or Sets Password - - - - - QueryEvent - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - timestamp (required). - category (required). - type (required). - value (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 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 - - - - Gets or Sets Category - - - - - Gets or Sets Timestamp - - - - - Gets or Sets Type - - - - - Gets or Sets Value - - - - - Defines Category - - - - - 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 - - - - - QueryEventLog - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - timestamp (required). - events (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 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 - - - - Gets or Sets Timestamp - - - - - Gets or Sets Events - - - - - QueryResult - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - item (required). - segment. - frame. - score. - 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 - - - - Gets or Sets Item - - - - - Gets or Sets Segment - - - - - Gets or Sets Frame - - - - - Gets or Sets Score - - - - - Gets or Sets Rank - - - - - 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). - - - - 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 - - - - Gets or Sets Timestamp - - - - - Gets or Sets SortType - - - - - Gets or Sets ResultSetAvailability - - - - - Gets or Sets Results - - - - - Gets or Sets Events - - - - - SessionId - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - sessionId (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 SessionId instances are equal - - Instance of SessionId to be compared - Boolean - - - - Gets the hash code - - Hash code - - - - To validate all properties of the instance - - Validation context - Validation Result - - - - Gets or Sets _SessionId - - - - - SuccessfulSubmissionsStatus - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - submission (required). - description (required). - status (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 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 - - - - Gets or Sets Submission - - - - - Gets or Sets Description - - - - - Gets or Sets Status - - - - - Defines Submission - - - - - Enum CORRECT for value: CORRECT - - - - - Enum WRONG for value: WRONG - - - - - Enum INDETERMINATE for value: INDETERMINATE - - - - - Enum UNDECIDABLE for value: UNDECIDABLE - - - - - SuccessStatus - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - description (required). - status (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 - - Instance of SuccessStatus to be compared - Boolean - - - - Gets the hash code - - Hash code - - - - To validate all properties of the instance - - Validation context - Validation Result - - - - Gets or Sets Description - - - - - Gets or Sets Status - - - - - UserDetails - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - id (required). - username (required). - role (required). - 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 UserDetails instances are equal - - Instance of UserDetails to be compared - Boolean - - - - Gets the hash code - - Hash code - - - - To validate all properties of the instance - - Validation context - Validation Result - - - - Gets or Sets Role - - - - - Gets or Sets Id - - - - - Gets or Sets Username - - - - - Gets or Sets SessionId - - - - - Defines Role - - - - - Enum ADMIN for value: ADMIN - - - - - Enum JUDGE for value: JUDGE - - - - - Enum VIEWER for value: VIEWER - - - - - Enum PARTICIPANT for value: PARTICIPANT - - - - - UserRequest - - - - - Initializes a new instance of the class. - - - - - Initializes a new instance of the class. - - username (required). - password. - role. - - - - 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 UserRequest instances are equal - - Instance of UserRequest to be compared - Boolean - - - - Gets the hash code - - Hash code - - - - To validate all properties of the instance - - Validation context - Validation Result - - - - Gets or Sets Role - - - - - Gets or Sets Username - - - - - Gets or Sets Password - - - - - Defines Role - - - - - Enum ADMIN for value: ADMIN - - - - - Enum JUDGE for value: JUDGE - - - - - Enum VIEWER for value: VIEWER - - - - - Enum PARTICIPANT for value: PARTICIPANT - - - - + + + + Dev.Dres.ClientApi + + + + + CurrentTime + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + timeStamp (required). + + + + 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 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 + + + + SuccessfulSubmissionsStatus + + + + + Defines Submission + + + + + Enum CORRECT for value: CORRECT + + + + + Enum WRONG for value: WRONG + + + + + Enum INDETERMINATE for value: INDETERMINATE + + + + + Enum UNDECIDABLE for value: UNDECIDABLE + + + + + Gets or Sets Submission + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + submission (required). + description (required). + status (required). + + + + Gets or Sets Description + + + + + Gets or Sets Status + + + + + 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 + + + + 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 + + + + 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 + + + + ErrorStatus + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + description (required). + status (required). + + + + Gets or Sets Description + + + + + Gets or Sets Status + + + + + 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 + + + + ClientTaskInfo + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id (required). + name (required). + taskGroup (required). + remainingTime (required). + running (required). + + + + Gets or Sets Id + + + + + Gets or Sets Name + + + + + Gets or Sets TaskGroup + + + + + Gets or Sets RemainingTime + + + + + Gets or Sets Running + + + + + 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 + + Instance of ClientTaskInfo 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 + + + + 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 + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id (required). + username (required). + role (required). + 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 UserDetails instances are equal + + Instance of UserDetails 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. + + description (required). + status (required). + + + + Gets or Sets Description + + + + + Gets or Sets Status + + + + + 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 + + + + ClientRunInfo + + + + + Defines Status + + + + + Enum CREATED for value: CREATED + + + + + Enum ACTIVE for value: ACTIVE + + + + + Enum PREPARINGTASK for value: PREPARING_TASK + + + + + Enum RUNNINGTASK for value: RUNNING_TASK + + + + + Enum TASKENDED for value: TASK_ENDED + + + + + Enum TERMINATED for value: TERMINATED + + + + + Gets or Sets Status + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + id (required). + name (required). + description. + status (required). + + + + Gets or Sets Id + + + + + 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 ClientRunInfo instances are equal + + Instance of ClientRunInfo to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + 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 + + + + ClientRunInfoList + + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + runs (required). + + + + Gets or Sets Runs + + + + + 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 + + Instance of ClientRunInfoList to be compared + Boolean + + + + Gets the hash code + + Hash code + + + + To validate all properties of the instance + + Validation context + Validation Result + + + + QueryEvent + + + + + Defines Category + + + + + 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 + + + + + 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 + + + + Represents a collection of functions to interact with the API endpoints + + + + + 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 + + + + Lists an overview of all competition runs visible to the current client + + + + + Thrown when fails to make API call + Session Token + ClientRunInfoList + + + + Lists an overview of all competition runs visible to the current client + + + + + Thrown when fails to make API call + Session Token + ApiResponse of ClientRunInfoList + + + + 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) + + + + Lists an overview of all competition runs visible to the current client + + + + + Thrown when fails to make API call + Session Token + Task of ClientRunInfoList + + + + Lists an overview of all competition runs visible to the current client + + + + + Thrown when fails to make API call + Session Token + Task of ApiResponse (ClientRunInfoList) + + + + 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 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 + + 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) + + + + Lists an overview of all competition runs visible to the current client + + Thrown when fails to make API call + Session Token + ClientRunInfoList + + + + Lists an overview of all competition runs visible to the current client + + Thrown when fails to make API call + Session Token + ApiResponse of ClientRunInfoList + + + + Lists an overview of all competition runs visible to the current client + + Thrown when fails to make API call + Session Token + Task of ClientRunInfoList + + + + Lists an overview of all competition runs visible to the current client + + Thrown when fails to make API call + Session Token + Task of ApiResponse (ClientRunInfoList) + + + + Represents a collection of functions to interact with the API endpoints + + + + + 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 + Task of CurrentTime + + + + Returns the current time on the server. + + + + + Thrown when fails to make API call + Task of ApiResponse (CurrentTime) + + + + 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 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 + Task of CurrentTime + + + + Returns the current time on the server. + + Thrown when fails to make API call + Task of ApiResponse (CurrentTime) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Endpoint to accept submissions + + + + + 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) + Session Token (optional) + SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions + + + + + 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) + Session Token (optional) + ApiResponse of SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions + + + + + 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) + Session Token (optional) + Task of SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions + + + + + 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) + Session Token (optional) + Task of ApiResponse (SuccessfulSubmissionsStatus) + + + + 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. + + + + + Endpoint to accept submissions + + 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) + Session Token (optional) + SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions + + 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) + Session Token (optional) + ApiResponse of SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions + + 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) + Session Token (optional) + Task of SuccessfulSubmissionsStatus + + + + Endpoint to accept submissions + + 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) + Session Token (optional) + Task of ApiResponse (SuccessfulSubmissionsStatus) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Accepts query logs from participants + + + + + Thrown when fails to make API call + Session Token + (optional) + SuccessStatus + + + + Accepts query 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) + SuccessStatus + + + + Accepts result 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) + Task of SuccessStatus + + + + Accepts query logs from participants + + + + + Thrown when fails to make API call + Session Token + (optional) + Task of ApiResponse (SuccessStatus) + + + + Accepts result logs from participants + + + + + Thrown when fails to make API call + Session Token + (optional) + Task of SuccessStatus + + + + Accepts result logs from participants + + + + + Thrown when fails to make API call + Session Token + (optional) + Task of ApiResponse (SuccessStatus) + + + + 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. + + + + + Accepts query logs from participants + + Thrown when fails to make API call + Session Token + (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) + Task of SuccessStatus + + + + Accepts query logs from participants + + Thrown when fails to make API call + Session Token + (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) + Task of SuccessStatus + + + + Accepts result logs from participants + + Thrown when fails to make API call + Session Token + (optional) + Task of ApiResponse (SuccessStatus) + + + + Represents a collection of functions to interact with the API endpoints + + + + + 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 + UserDetails + + + + Get information about the current user. + + + + + Thrown when fails to make API call + ApiResponse of UserDetails + + + + Sets roles for session based on user account and returns a session cookie. + + + + + Thrown when fails to make API call + (optional) + UserDetails + + + + Sets roles for session based on user account and returns a session cookie. + + + + + Thrown when fails to make API call + (optional) + ApiResponse of UserDetails + + + + Clears all user roles of the current session. + + + + + Thrown when fails to make API call + Session Token (optional) + Task of SuccessStatus + + + + Clears all user roles of the current session. + + + + + Thrown when fails to make API call + Session Token (optional) + Task of ApiResponse (SuccessStatus) + + + + Get information about the current user. + + + + + Thrown when fails to make API call + Task of UserDetails + + + + Get information about the current user. + + + + + Thrown when fails to make API call + Task of ApiResponse (UserDetails) + + + + Sets roles for session based on user account and returns a session cookie. + + + + + Thrown when fails to make API call + (optional) + Task of UserDetails + + + + Sets roles for session based on user account and returns a session cookie. + + + + + Thrown when fails to make API call + (optional) + Task of ApiResponse (UserDetails) + + + + 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. + + + + + 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 + + + + Clears all user roles of the current session. + + Thrown when fails to make API call + Session Token (optional) + Task of SuccessStatus + + + + Clears all user roles of the current session. + + Thrown when fails to make API call + Session Token (optional) + Task of ApiResponse (SuccessStatus) + + + + Get information about the current user. + + Thrown when fails to make API call + UserDetails + + + + Get information about the current user. + + Thrown when fails to make API call + ApiResponse of UserDetails + + + + Get information about the current user. + + Thrown when fails to make API call + Task of UserDetails + + + + Get information about the current user. + + Thrown when fails to make API call + Task of ApiResponse (UserDetails) + + + + Sets roles for session based on user account and returns a session cookie. + + Thrown when fails to make API call + (optional) + UserDetails + + + + Sets roles for session based on user account and returns a session cookie. + + Thrown when fails to make API call + (optional) + ApiResponse of UserDetails + + + + Sets roles for session based on user account and returns a session cookie. + + Thrown when fails to make API call + (optional) + Task of UserDetails + + + + Sets roles for session based on user account and returns a session cookie. + + Thrown when fails to make API call + (optional) + Task of ApiResponse (UserDetails) + + + + Represents a collection of functions to interact with the API endpoints + + + + + Provides a JSON download of the entire competition description structure. + + + + + Thrown when fails to make API call + Competition ID + string + + + + Provides a JSON download of the entire competition description structure. + + + + + Thrown when fails to make API call + Competition ID + ApiResponse of string + + + + Provides a JSON download of the entire competition run structure. + + + + + Thrown when fails to make API call + Competition run ID + string + + + + Provides a JSON download of the entire competition run structure. + + + + + Thrown when fails to make API call + Competition run ID + ApiResponse of string + + + + Provides a CSV download with the scores for a given competition run. + + + + + Thrown when fails to make API call + Competition run ID + string + + + + Provides a CSV download with the scores for a given competition run. + + + + + Thrown when fails to make API call + Competition run ID + 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. + + + + + Thrown when fails to make API call + Competition run ID + Task of string + + + + Provides a CSV download with the scores for a given competition run. + + + + + Thrown when fails to make API call + Competition run ID + 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. + + Thrown when fails to make API call + Competition ID + string + + + + Provides a JSON download of the entire competition description structure. + + Thrown when fails to make API call + Competition ID + 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 + string + + + + Provides a JSON download of the entire competition run structure. + + Thrown when fails to make API call + Competition run ID + ApiResponse of 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. + + Thrown when fails to make API call + Competition run ID + string + + + + Provides a CSV download with the scores for a given competition run. + + Thrown when fails to make API call + Competition run ID + ApiResponse of string + + + + Provides a CSV download with the scores for a given competition run. + + Thrown when fails to make API call + Competition run ID + Task of string + + + + Provides a CSV download with the scores for a given competition run. + + Thrown when fails to make API call + Competition run ID + Task of ApiResponse (string) + + + + API client is mainly responsible for making the HTTP call to the API backend. + + + + + Allows for extending request processing for generated code. + + The RestSharp request object + + + + Allows for extending response processing for generated code. + + The RestSharp request object + The RestSharp response object + + + + Initializes a new instance of the class + with default configuration. + + + + + Initializes a new instance of the class + with default base path (http://localhost). + + An instance of Configuration. + + + + Initializes a new instance of the class + with default configuration. + + The base path. + + + + Gets or sets the default API client for making HTTP calls. + + The default API client. + + + + Gets or sets an instance of the IReadableConfiguration. + + An instance of the IReadableConfiguration. + + helps us to avoid modifying possibly global + configuration values from within a given client. It does not guarantee thread-safety + of the instance in any way. + + + + + Gets or sets the RestClient. + + An instance of the RestClient + + + + Makes the HTTP request (Sync). + + URL path. + HTTP method. + Query parameters. + HTTP body (POST request). + Header parameters. + Form parameters. + File parameters. + Path parameters. + Content Type of the request + Object + + + + Makes the asynchronous HTTP request. + + URL path. + HTTP method. + Query parameters. + HTTP body (POST request). + Header parameters. + Form parameters. + File parameters. + Path parameters. + Content type. + The Task instance. + + + + Escape string (url-encoded). + + String to be escaped. + Escaped string. + + + + Create FileParameter based on Stream. + + Parameter name. + Input stream. + FileParameter. + + + + If parameter is DateTime, output in a formatted string (default ISO 8601), customizable with Configuration.DateTime. + If parameter is a list, join the list with ",". + Otherwise just return the string. + + The parameter (header, path, query, form). + Formatted string. + + + + Deserialize the JSON string into a proper object. + + The HTTP response. + Object type. + Object representation of the JSON string. + + + + Serialize an input (model) into JSON string + + Object. + JSON string. + + + + Check if the given MIME is a JSON MIME. + JSON MIME examples: + application/json + application/json; charset=UTF8 + APPLICATION/JSON + application/vnd.company+json + + MIME + Returns True if MIME type is json. + + + + Select the Content-Type header's value from the given content-type array: + if JSON type exists in the given array, use it; + otherwise use the first one defined in 'consumes' + + The Content-Type array to select from. + The Content-Type header to use. + + + + Select the Accept header's value from the given accepts array: + if JSON exists in the given array, use it; + otherwise use all of them (joining into a string) + + The accepts array to select from. + The Accept header to use. + + + + Encode string in base64 format. + + String to be encoded. + Encoded string. + + + + Dynamically cast the object into target type. + + Object to be casted + Target type + Casted object + + + + Convert stream to byte array + + Input stream to be converted + Byte array + + + + URL encode a string + Credit/Ref: https://github.com/restsharp/RestSharp/blob/master/RestSharp/Extensions/StringExtensions.cs#L50 + + String to be URL encoded + Byte array + + + + Sanitize filename by removing the path + + Filename + Filename + + + + Convert params to key/value pairs. + Use collectionFormat to properly format lists and collections. + + Collection format. + Key name. + Value object. + A list of KeyValuePairs + + + + Check if generic object is a collection. + + + True if object is a collection type + + + + Represents a readable-only configuration contract. + + + + + Gets the access token. + + Access token. + + + + Gets the API key. + + API key. + + + + Gets the API key prefix. + + API key prefix. + + + + Gets the base path. + + Base path. + + + + Gets the date time format. + + Date time foramt. + + + + Gets the default header. + + Default header. + + + + Gets the temp folder path. + + Temp folder path. + + + + Gets the HTTP connection timeout (in milliseconds) + + HTTP connection timeout. + + + + Gets the user agent. + + User agent. + + + + Gets the username. + + Username. + + + + Gets the password. + + Password. + + + + Gets the API key with prefix. + + API key identifier (authentication scheme). + API key with prefix. + + + + API Response + + + + + Gets or sets the status code (HTTP status code) + + The status code. + + + + Gets or sets the HTTP headers + + HTTP headers + + + + Gets or sets the data (parsed HTTP body) + + The data. + + + + Initializes a new instance of the class. + + HTTP status code. + HTTP headers. + Data (parsed HTTP body) + + + + Represents a set of configuration settings + + + + + Version of the package. + + Version of the package. + + + + Identifier for ISO 8601 DateTime Format + + See https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx#Anchor_8 for more information. + + + + Default creation of exceptions for a given method name and response object + + + + + Gets or sets the default Configuration. + + Configuration. + + + + Gets or sets the API key based on the authentication name. + + The API key. + + + + Gets or sets the prefix (e.g. Token) of the API key based on the authentication name. + + The prefix of the API key. + + + + Initializes a new instance of the class + + + + + Initializes a new instance of the class + + + + + Initializes a new instance of the class with different settings + + Api client + Dictionary of default HTTP header + Username + Password + accessToken + Dictionary of API key + Dictionary of API key prefix + Temp folder path + DateTime format string + HTTP connection timeout (in milliseconds) + HTTP user agent + + + + Initializes a new instance of the Configuration class. + + Api client. + + + + Gets an instance of an ApiClient for this configuration + + + + + Gets or sets the base path for API access. + + + + + Gets or sets the default header. + + + + + Gets or sets the HTTP timeout (milliseconds) of ApiClient. Default to 100000 milliseconds. + + + + + Gets or sets the HTTP user agent. + + Http user agent. + + + + Gets or sets the username (HTTP basic authentication). + + The username. + + + + Gets or sets the password (HTTP basic authentication). + + The password. + + + + Gets the API key with prefix. + + API key identifier (authentication scheme). + API key with prefix. + + + + Gets or sets the access token for OAuth2 authentication. + + The access token. + + + + Gets or sets the temporary folder path to store the files downloaded from the server. + + Folder path. + + + + Gets or sets the date time format used when serializing in the ApiClient + By default, it's set to ISO 8601 - "o", for others see: + https://msdn.microsoft.com/en-us/library/az4se3k1(v=vs.110).aspx + and https://msdn.microsoft.com/en-us/library/8kb3ddd4(v=vs.110).aspx + No validation is done to ensure that the string you're providing is valid + + The DateTimeFormat string + + + + Gets or sets the prefix (e.g. Token) of the API key based on the authentication name. + + The prefix of the API key. + + + + Gets or sets the API key based on the authentication name. + + The API key. + + + + Add default header. + + Header field name. + Header field value. + + + + + Creates a new based on this instance. + + + + + + Returns a string with essential information for debugging. + + + + + Add Api Key Header. + + Api Key name. + Api Key value. + + + + + Sets the API key prefix. + + Api Key name. + Api Key value. + + + + API Exception + + + + + Gets or sets the error code (HTTP status code) + + The error code (HTTP status code). + + + + Gets or sets the error content (body json object) + + The error content (Http response body). + + + + Initializes a new instance of the class. + + + + + Initializes a new instance of the class. + + HTTP status code. + Error message. + + + + Initializes a new instance of the class. + + HTTP status code. + Error message. + Error content. + + + + Represents configuration aspects required to interact with the API endpoints. + + + + + Gets or sets the configuration object + + An instance of the Configuration + + + + Gets the base path of the API client. + + The base path + + + + Provides a factory method hook for the creation of exceptions. + + + + + provides a compile-time extension point for globally configuring + API Clients. + + + A customized implementation via partial class may reside in another file and may + be excluded from automatic generation via a .openapi-generator-ignore file. + + + + + Formatter for 'date' openapi formats ss defined by full-date - RFC3339 + see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.0.md#data-types + + + + + Initializes a new instance of the class. + + + + + A delegate to ExceptionFactory method + + Method name + Response + Exceptions + + + diff --git a/Runtime/Scripts/Dres/UnityClient/DresClient.cs b/Runtime/Scripts/Dres/UnityClient/DresClient.cs index 424b94d..71fa089 100644 --- a/Runtime/Scripts/Dres/UnityClient/DresClient.cs +++ b/Runtime/Scripts/Dres/UnityClient/DresClient.cs @@ -1,6 +1,7 @@ using System.Collections.Generic; using System.Threading.Tasks; using Dev.Dres.ClientApi.Model; +using UnityEditor; namespace Dres.Unityclient { @@ -26,6 +27,7 @@ public async Task Login() UserDetails = await DresWrapper.Login(config.user, config.password); } + /// /// Submits the given item (and optionally frame informaiton) to the DRES instance as current user. /// @@ -38,6 +40,16 @@ public async Task SubmitResult(string item, int? fr return await DresWrapper.Submit(item, UserDetails.SessionId, frame); } + /// + /// Submits the given text to the DRES instance as current user + /// + /// The text to submit (this can be anything). + /// The success / failure state of the operation + public async Task SubmitTextualResult(string text) + { + return await DresWrapper.SubmitText(text, UserDetails.SessionId); + } + /// /// Sends the given results as result log to the DRES instance as current user. /// For further information on the logging format, please consider visiting the diff --git a/Runtime/Scripts/Dres/UnityClient/DresWrapper.cs b/Runtime/Scripts/Dres/UnityClient/DresWrapper.cs index 16a588f..fd8a325 100644 --- a/Runtime/Scripts/Dres/UnityClient/DresWrapper.cs +++ b/Runtime/Scripts/Dres/UnityClient/DresWrapper.cs @@ -12,25 +12,25 @@ namespace Dres.Unityclient ///
/// This class is held deliberately stateless (no session ID etc.) to allow multi-user scenarios in the future. /// - public static class DresWrapper + internal static class DresWrapper { /// /// The deliberately single Logging Api instance of DRES. Used to send logs to DRES /// - public static readonly LogApi LogApi = new LogApi(DresConfigManager.Instance.ApiConfiguration); + internal static readonly LogApi LogApi = new LogApi(DresConfigManager.Instance.ApiConfiguration); /// /// The deliberately single Status Api instance of DRES. Used to get the status of DRES /// - public static readonly StatusApi StatusApi = new StatusApi(DresConfigManager.Instance.ApiConfiguration); + internal static readonly StatusApi StatusApi = new StatusApi(DresConfigManager.Instance.ApiConfiguration); /// /// The deliberately single Submission Api instance of DRES. Used to submit media items during competitions to DRES: /// - public static readonly SubmissionApi SubmissionApi = new SubmissionApi(DresConfigManager.Instance.ApiConfiguration); + internal static readonly SubmissionApi SubmissionApi = new SubmissionApi(DresConfigManager.Instance.ApiConfiguration); /// /// The deliberately single User Api instance of DRES. Used to log into DRES and retrieve the session id of the user. /// - public static readonly UserApi UserApi = new UserApi(DresConfigManager.Instance.ApiConfiguration); + internal static readonly UserApi UserApi = new UserApi(DresConfigManager.Instance.ApiConfiguration); /// /// Login to DRES with given username and password. @@ -41,7 +41,7 @@ public static class DresWrapper /// The DRES password /// The login state on success. /// If the config has no credentials set and no credentials file exists - public static async Task Login(string user, string password) + internal static async Task Login(string user, string password) { var loginRequest = new LoginRequest(user, password); return await UserApi.PostApiV1LoginAsync(loginRequest); @@ -57,10 +57,24 @@ public 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 - public static async Task Submit(string item, string session, int? frame = null) + internal static async Task Submit(string item, string session, int? frame = null) { return await 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) + /// + /// The submission in textual form (might also be a number) submit + /// 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) + { + return await SubmissionApi.GetApiV1SubmitAsync(text: text, session: session); + } + /// /// Send result logs to the DRES endpoint. @@ -75,7 +89,7 @@ public static async Task Submit(string item, string /// 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 - public static async Task LogResults(long timestamp, string sortType, string resultSetAvailability, + internal static async Task LogResults(long timestamp, string sortType, string resultSetAvailability, List results, List events, string session) { var resultLog = new QueryResultLog(timestamp, sortType, resultSetAvailability, results, events); @@ -92,7 +106,7 @@ public static async Task LogResults(long timestamp, string sortTy /// 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 - public static async Task LogQueryEvents(long timestamp, List events, string session) + internal static async Task LogQueryEvents(long timestamp, List events, string session) { var queryEventLog = new QueryEventLog(timestamp, events); return await LogApi.PostApiV1LogQueryAsync(session, queryEventLog); diff --git a/Runtime/Scripts/Dres/UnityInterface.meta b/Runtime/Scripts/Dres/UnityInterface.meta deleted file mode 100644 index 5c7a2c8..0000000 --- a/Runtime/Scripts/Dres/UnityInterface.meta +++ /dev/null @@ -1,3 +0,0 @@ -fileFormatVersion: 2 -guid: 557a5c5eae9b444fb1f602a66abf358d -timeCreated: 1638192805 \ No newline at end of file