Skip to content

This repository contains python bindings for Speakeasy. This is not intended to be used directly, but is rather a requirement from the official client.

Notifications You must be signed in to change notification settings

Alan-s-Speakeasy/speakeasy-openapi-python

Repository files navigation

Speakeasy's python bindings.

This repository is only meant to be used a requirement of the Speakeasy Python Client.

Full API for Alan's Speakeasy, Version 0.1

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 0.1
  • Package version: 1.0.0
  • Generator version: 7.12.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://speakeasy.ifi.uzh.ch

Documentation for API Endpoints

All URIs are relative to http://localhost

Class Method HTTP request Description
AdminApi delete_api_group DELETE /api/group Removes all existing groups.
AdminApi get_api_feedbackaverage_by_form_name GET /api/feedbackaverage/{formName} Gets the list of feedback averages (both assigned and requested) per user
AdminApi get_api_feedbackaverageexport_by_form_name GET /api/feedbackaverageexport/{formName} Exports the feedback responses to a CSV file
AdminApi get_api_feedbackhistory_form_by_form_name GET /api/feedbackhistory/form/{formName} Gets two lists (assigned and requested) of feedback responses to this form
AdminApi get_api_group_list GET /api/group/list Lists all groups with corresponding users.
AdminApi get_api_rooms_active GET /api/rooms/active Lists all active Chatrooms
AdminApi get_api_rooms_all GET /api/rooms/all Lists all Chatrooms with pagination, ordered by descending startTime, filtered by users and time range.
AdminApi get_api_rooms_export GET /api/rooms/export Export specified chatrooms as JSON or CSV. In case of CSV, a ZIP file is returned.
AdminApi get_api_user_list GET /api/user/list Lists all available users.
AdminApi get_api_user_sessions GET /api/user/sessions Lists all current user sessions.
AdminApi patch_api_group_update PATCH /api/group/update Modifies an existing group by updating its users.
AdminApi post_api_group_create POST /api/group/create Creates a group with existing, non-duplicate and at least one users.
AdminApi post_api_group_remove POST /api/group/remove Deletes an existing group.
AdminApi post_api_user_add POST /api/user/add Adds a new user.
AdminApi post_api_user_remove POST /api/user/remove Removes an existing user.
AssignmentApi delete_api_assignment DELETE /api/assignment Delete the active assignment generator.
AssignmentApi get_api_assignment GET /api/assignment Get the status of the current assignment generator
AssignmentApi patch_api_assignment_round PATCH /api/assignment/round Start the generated assignment round
AssignmentApi post_api_assignment_new POST /api/assignment/new Initialize a new assignment generator.
AssignmentApi post_api_assignment_round POST /api/assignment/round Generate a new assignment round
ChatApi get_api_room_by_room_id GET /api/room/{roomId} Get state and all messages for a chat room since a specified time
ChatApi get_api_room_by_room_id_users_status GET /api/room/{roomId}/users-status Get users and their online status for a chat room
ChatApi get_api_rooms GET /api/rooms Lists all Chatrooms for current user
ChatApi get_api_rooms_assessed GET /api/rooms/assessed Lists all assessed chatrooms for current user (including chatrooms marked as no need for assessment)
ChatApi patch_api_request_by_room_id PATCH /api/request/{roomId} Add a user to an existing Chatroom.
ChatApi patch_api_room_by_room_id PATCH /api/room/{roomId} Closes a Chatroom.
ChatApi post_api_room_by_room_id POST /api/room/{roomId} Post a message to a Chatroom.
ChatApi post_api_room_by_room_id_reaction POST /api/room/{roomId}/reaction Post a chat message reaction to a Chatroom.
ChatApi post_api_rooms_request POST /api/rooms/request Creates a Chatroom with another user. If formname is not provided, no form is used
FeedbackApi get_api_feedbackaverage_by_form_name GET /api/feedbackaverage/{formName} Gets the list of feedback averages (both assigned and requested) per user
FeedbackApi get_api_feedbackaverageexport_by_form_name GET /api/feedbackaverageexport/{formName} Exports the feedback responses to a CSV file
FeedbackApi get_api_feedbackhistory_form_by_form_name GET /api/feedbackhistory/form/{formName} Gets two lists (assigned and requested) of feedback responses to this form
FeedbackApi get_api_feedbackhistory_room_by_room_id GET /api/feedbackhistory/room/{roomId} Gets the list of feedback responses for a Chatroom.
FeedbackApi post_api_feedback_by_room_id POST /api/feedback/{roomId} Posts Feedback for a Chatroom.
FormApi delete_api_feedbackforms_by_form_name DELETE /api/feedbackforms/{formName} Deletes a feedback form
FormApi get_api_feedbackforms GET /api/feedbackforms Gets the list of all feedback forms
FormApi get_api_feedbackforms_by_form_name GET /api/feedbackforms/{formName} Gets a feedback form
FormApi post_api_feedbackforms POST /api/feedbackforms/ Creates a new feedback form
FormApi put_api_feedbackforms_by_form_name PUT /api/feedbackforms/{formName} Updates a feedback form
GroupApi delete_api_group DELETE /api/group Removes all existing groups.
GroupApi get_api_group_list GET /api/group/list Lists all groups with corresponding users.
GroupApi patch_api_group_update PATCH /api/group/update Modifies an existing group by updating its users.
GroupApi post_api_group_create POST /api/group/create Creates a group with existing, non-duplicate and at least one users.
GroupApi post_api_group_remove POST /api/group/remove Deletes an existing group.
UserApi api_user_check_get GET /api/user/check Returns details for the current session.
UserApi get_api_logout GET /api/logout Clears all user roles of the current session.
UserApi get_api_user_count GET /api/user/count Counts all humans and bots.
UserApi get_api_user_current GET /api/user/current Returns details for the current session.
UserApi patch_api_user_password PATCH /api/user/password Changes the password for a given user.
UserApi post_api_login POST /api/login Sets roles for session based on user account and returns a session cookie.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

CookieAuth

  • Type: API key
  • API key parameter name: SESSIONID
  • Location:

Author

About

This repository contains python bindings for Speakeasy. This is not intended to be used directly, but is rather a requirement from the official client.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published