shared::api::endpoints

Trait ApiEndpoint

Source
pub trait ApiEndpoint {
    type Path: PathParts;
    type Req: Serialize;
    type Res: DeserializeOwned + Serialize + 'static;
    type Err: DeserializeOwned + Serialize + Error + 'static;

    const METHOD: Method;
}
Expand description

Represents a A endpoint that the backend will support, and how to call it.

Required Associated Constants§

Source

const METHOD: Method

The method used to make a request to the endpoint.

Required Associated Types§

Source

type Path: PathParts

The path type for this endpoint.

Source

type Req: Serialize

The request type for this endpoint.

Source

type Res: DeserializeOwned + Serialize + 'static

The response type for this endpoint.

Source

type Err: DeserializeOwned + Serialize + Error + 'static

The (inner) error type for this endpoint.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors§

Source§

impl ApiEndpoint for CreateSchoolAccount

Source§

impl ApiEndpoint for DeleteSchoolAccount

Source§

impl ApiEndpoint for GetIndividualAccount

Source§

impl ApiEndpoint for GetSchoolAccount

Source§

impl ApiEndpoint for UpdateSchoolAccount

Source§

impl ApiEndpoint for shared::api::endpoints::additional_resource::Create

Source§

impl ApiEndpoint for shared::api::endpoints::additional_resource::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::additional_resource::GetDraft

Source§

impl ApiEndpoint for shared::api::endpoints::additional_resource::GetLive

Source§

impl ApiEndpoint for shared::api::endpoints::additional_resource::Update

Source§

impl ApiEndpoint for AdminJigExport

Source§

impl ApiEndpoint for AdminPlaylistExport

Source§

impl ApiEndpoint for AdminUserExport

Source§

impl ApiEndpoint for CreateSchoolName

Source§

impl ApiEndpoint for CreateUpdateSubscriptionPlans

Source§

impl ApiEndpoint for DeleteUserAccount

Source§

impl ApiEndpoint for GetAdminSchoolAccount

Source§

impl ApiEndpoint for GetSchoolNames

Source§

impl ApiEndpoint for Impersonate

Source§

impl ApiEndpoint for ImportSchoolNames

Source§

impl ApiEndpoint for InviteUsers

Source§

impl ApiEndpoint for RemoveUserFromSchool

Source§

impl ApiEndpoint for SearchSchools

Source§

impl ApiEndpoint for SetAccountTierOverride

Source§

impl ApiEndpoint for SetInternalSchoolName

Source§

impl ApiEndpoint for UpdateSchoolName

Source§

impl ApiEndpoint for VerifySchool

Source§

impl ApiEndpoint for shared::api::endpoints::animation::Create

Source§

impl ApiEndpoint for shared::api::endpoints::animation::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::animation::Get

Source§

impl ApiEndpoint for shared::api::endpoints::animation::Upload

Source§

impl ApiEndpoint for shared::api::endpoints::audio::user::Create

Source§

impl ApiEndpoint for shared::api::endpoints::audio::user::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::audio::user::Get

Source§

impl ApiEndpoint for shared::api::endpoints::audio::user::List

Source§

impl ApiEndpoint for shared::api::endpoints::audio::user::Upload

Source§

impl ApiEndpoint for AdminUpgradeSubscriptionPlan

Source§

impl ApiEndpoint for CreateSetupIntent

Source§

impl ApiEndpoint for CreateSubscription

Source§

impl ApiEndpoint for UpdateSubscriptionCancellation

Source§

impl ApiEndpoint for UpdateSubscriptionPaused

Source§

impl ApiEndpoint for UpgradeSubscriptionPlan

Source§

impl ApiEndpoint for shared::api::endpoints::category::Create

Source§

impl ApiEndpoint for shared::api::endpoints::category::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::category::Get

Source§

impl ApiEndpoint for shared::api::endpoints::category::Update

Source§

impl ApiEndpoint for shared::api::endpoints::circle::Browse

Source§

impl ApiEndpoint for BrowseMembers

Source§

impl ApiEndpoint for shared::api::endpoints::circle::Create

Source§

impl ApiEndpoint for shared::api::endpoints::circle::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::circle::Get

Source§

impl ApiEndpoint for JoinCircle

Source§

impl ApiEndpoint for LeaveCircle

Source§

impl ApiEndpoint for RemoveMember

Source§

impl ApiEndpoint for shared::api::endpoints::circle::Update

Source§

impl ApiEndpoint for shared::api::endpoints::course::Browse

Source§

impl ApiEndpoint for shared::api::endpoints::course::Clone

Source§

impl ApiEndpoint for CourseAdminDataUpdate

Source§

impl ApiEndpoint for shared::api::endpoints::course::Create

Source§

impl ApiEndpoint for shared::api::endpoints::course::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::course::GetDraft

Source§

impl ApiEndpoint for shared::api::endpoints::course::GetLive

Source§

impl ApiEndpoint for shared::api::endpoints::course::Play

Source§

impl ApiEndpoint for shared::api::endpoints::course::Publish

Source§

impl ApiEndpoint for shared::api::endpoints::course::Search

Source§

impl ApiEndpoint for shared::api::endpoints::course::UpdateDraftData

Source§

impl ApiEndpoint for shared::api::endpoints::course::unit::Create

Source§

impl ApiEndpoint for shared::api::endpoints::course::unit::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::course::unit::GetDraft

Source§

impl ApiEndpoint for shared::api::endpoints::course::unit::GetLive

Source§

impl ApiEndpoint for shared::api::endpoints::course::unit::Update

Source§

impl ApiEndpoint for shared::api::endpoints::image::recent::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::image::recent::List

Source§

impl ApiEndpoint for Put

Source§

impl ApiEndpoint for shared::api::endpoints::image::Browse

Source§

impl ApiEndpoint for shared::api::endpoints::image::Create

Source§

impl ApiEndpoint for shared::api::endpoints::image::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::image::Get

Source§

impl ApiEndpoint for PutImageUsage

Source§

impl ApiEndpoint for shared::api::endpoints::image::Search

Source§

impl ApiEndpoint for UpdateMetadata

Source§

impl ApiEndpoint for shared::api::endpoints::image::Upload

Source§

impl ApiEndpoint for shared::api::endpoints::image::tag::Create

Source§

impl ApiEndpoint for shared::api::endpoints::image::tag::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::image::tag::List

Source§

impl ApiEndpoint for shared::api::endpoints::image::tag::Update

Source§

impl ApiEndpoint for shared::api::endpoints::image::user::Create

Source§

impl ApiEndpoint for shared::api::endpoints::image::user::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::image::user::Get

Source§

impl ApiEndpoint for shared::api::endpoints::image::user::List

Source§

impl ApiEndpoint for shared::api::endpoints::image::user::Upload

Source§

impl ApiEndpoint for Complete

Source§

impl ApiEndpoint for shared::api::endpoints::jig::codes::instance::Create

Source§

impl ApiEndpoint for shared::api::endpoints::jig::codes::Create

Source§

impl ApiEndpoint for GetJigCode

Source§

impl ApiEndpoint for JigCodeList

Source§

impl ApiEndpoint for JigCodeSessions

Source§

impl ApiEndpoint for JigsWithCodes

Source§

impl ApiEndpoint for shared::api::endpoints::jig::codes::Update

Source§

impl ApiEndpoint for shared::api::endpoints::jig::curation::CreateComment

Source§

impl ApiEndpoint for shared::api::endpoints::jig::curation::GetComment

Source§

impl ApiEndpoint for shared::api::endpoints::jig::curation::GetCuration

Source§

impl ApiEndpoint for shared::api::endpoints::jig::curation::UpdateCuration

Source§

impl ApiEndpoint for shared::api::endpoints::jig::report::Create

Source§

impl ApiEndpoint for shared::api::endpoints::jig::report::Get

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Browse

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Clone

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Count

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Cover

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Create

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::jig::DeleteAll

Source§

impl ApiEndpoint for FeaturedUpdate

Source§

impl ApiEndpoint for shared::api::endpoints::jig::GetDraft

Source§

impl ApiEndpoint for GetJigPlaylists

Source§

impl ApiEndpoint for shared::api::endpoints::jig::GetLive

Source§

impl ApiEndpoint for JigAdminDataUpdate

Source§

impl ApiEndpoint for JigAdminTransfer

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Like

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Liked

Source§

impl ApiEndpoint for shared::api::endpoints::jig::ListLiked

Source§

impl ApiEndpoint for ListPlayed

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Play

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Publish

Source§

impl ApiEndpoint for RemoveResource

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Search

Source§

impl ApiEndpoint for shared::api::endpoints::jig::Unlike

Source§

impl ApiEndpoint for shared::api::endpoints::jig::UpdateDraftData

Source§

impl ApiEndpoint for shared::api::endpoints::locale::bundle::List

Source§

impl ApiEndpoint for shared::api::endpoints::locale::entry::Create

Source§

impl ApiEndpoint for shared::api::endpoints::locale::entry::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::locale::entry::Get

Source§

impl ApiEndpoint for shared::api::endpoints::locale::entry::List

Source§

impl ApiEndpoint for shared::api::endpoints::locale::entry::Update

Source§

impl ApiEndpoint for shared::api::endpoints::locale::item_kind::List

Source§

impl ApiEndpoint for shared::api::endpoints::media::Create

Source§

impl ApiEndpoint for DeleteId

Source§

impl ApiEndpoint for DeleteUrl

Source§

impl ApiEndpoint for GetId

Source§

impl ApiEndpoint for GetUrl

Source§

impl ApiEndpoint for shared::api::endpoints::meta::Get

Source§

impl ApiEndpoint for shared::api::endpoints::module::Create

Source§

impl ApiEndpoint for shared::api::endpoints::module::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::module::GetDraft

Source§

impl ApiEndpoint for shared::api::endpoints::module::GetLive

Source§

impl ApiEndpoint for shared::api::endpoints::module::Update

Source§

impl ApiEndpoint for shared::api::endpoints::pdf::user::Create

Source§

impl ApiEndpoint for shared::api::endpoints::pdf::user::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::pdf::user::Get

Source§

impl ApiEndpoint for shared::api::endpoints::pdf::user::List

Source§

impl ApiEndpoint for shared::api::endpoints::pdf::user::Upload

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::Browse

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::Clone

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::Create

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::GetDraft

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::GetLive

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::Like

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::Liked

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::ListLiked

Source§

impl ApiEndpoint for PlaylistAdminDataUpdate

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::Publish

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::Search

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::Unlike

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::UpdateDraftData

Source§

impl ApiEndpoint for shared::api::endpoints::playlist::View

Source§

impl ApiEndpoint for shared::api::endpoints::resource::curation::CreateComment

Source§

impl ApiEndpoint for shared::api::endpoints::resource::curation::GetComment

Source§

impl ApiEndpoint for shared::api::endpoints::resource::curation::GetCuration

Source§

impl ApiEndpoint for shared::api::endpoints::resource::curation::UpdateCuration

Source§

impl ApiEndpoint for shared::api::endpoints::resource::report::Create

Source§

impl ApiEndpoint for shared::api::endpoints::resource::report::Get

Source§

impl ApiEndpoint for shared::api::endpoints::resource::Browse

Source§

impl ApiEndpoint for shared::api::endpoints::resource::Clone

Source§

impl ApiEndpoint for shared::api::endpoints::resource::Count

Source§

impl ApiEndpoint for shared::api::endpoints::resource::Cover

Source§

impl ApiEndpoint for shared::api::endpoints::resource::Create

Source§

impl ApiEndpoint for shared::api::endpoints::resource::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::resource::DeleteAll

Source§

impl ApiEndpoint for shared::api::endpoints::resource::GetDraft

Source§

impl ApiEndpoint for shared::api::endpoints::resource::GetLive

Source§

impl ApiEndpoint for shared::api::endpoints::resource::Like

Source§

impl ApiEndpoint for shared::api::endpoints::resource::Liked

Source§

impl ApiEndpoint for shared::api::endpoints::resource::ListLiked

Source§

impl ApiEndpoint for shared::api::endpoints::resource::Publish

Source§

impl ApiEndpoint for ResourceAdminDataUpdate

Source§

impl ApiEndpoint for shared::api::endpoints::resource::Search

Source§

impl ApiEndpoint for shared::api::endpoints::resource::Unlike

Source§

impl ApiEndpoint for shared::api::endpoints::resource::UpdateDraftData

Source§

impl ApiEndpoint for shared::api::endpoints::resource::View

Source§

impl ApiEndpoint for CreateKey

Source§

impl ApiEndpoint for WebImageSearch

Source§

impl ApiEndpoint for shared::api::endpoints::session::Create

Source§

impl ApiEndpoint for CreateOAuth

Source§

impl ApiEndpoint for shared::api::endpoints::session::Delete

Source§

impl ApiEndpoint for GetOAuthUrl

Source§

impl ApiEndpoint for shared::api::endpoints::user::Browse

Source§

impl ApiEndpoint for BrowseFollowers

Source§

impl ApiEndpoint for BrowseFollowing

Source§

impl ApiEndpoint for BrowseUserPlaylists

Source§

impl ApiEndpoint for BrowsePublicUser

Source§

impl ApiEndpoint for BrowseUserResources

Source§

impl ApiEndpoint for BrowseUserJigs

Source§

impl ApiEndpoint for ChangePassword

Source§

impl ApiEndpoint for shared::api::endpoints::user::Create

Source§

impl ApiEndpoint for shared::api::endpoints::user::CreateColor

Source§

impl ApiEndpoint for shared::api::endpoints::user::CreateFont

Source§

impl ApiEndpoint for shared::api::endpoints::user::CreateProfile

Source§

impl ApiEndpoint for shared::api::endpoints::user::Delete

Source§

impl ApiEndpoint for shared::api::endpoints::user::DeleteColor

Source§

impl ApiEndpoint for shared::api::endpoints::user::DeleteFont

Source§

impl ApiEndpoint for Follow

Source§

impl ApiEndpoint for shared::api::endpoints::user::GetColors

Source§

impl ApiEndpoint for shared::api::endpoints::user::GetFonts

Source§

impl ApiEndpoint for shared::api::endpoints::user::GetPublicUser

Source§

impl ApiEndpoint for Patch

Source§

impl ApiEndpoint for PatchProfileAdminData

Source§

impl ApiEndpoint for shared::api::endpoints::user::Profile

Source§

impl ApiEndpoint for ResetEmail

Source§

impl ApiEndpoint for ResetPassword

Source§

impl ApiEndpoint for SearchPublicUser

Source§

impl ApiEndpoint for SearchUser

Source§

impl ApiEndpoint for Unfollow

Source§

impl ApiEndpoint for shared::api::endpoints::user::UpdateColor

Source§

impl ApiEndpoint for shared::api::endpoints::user::UpdateFont

Source§

impl ApiEndpoint for UserLookup

Source§

impl ApiEndpoint for VerifyEmail

Source§

impl ApiEndpoint for VerifyResetEmail