Trait twitch_api2::helix::Request

source · [−]

pub trait Request: Serialize {
    type Response: DeserializeOwned + PartialEq;

    const PATH: &'static str;
    const SCOPE: &'static [Scope];
    const OPT_SCOPE: &'static [Scope] = &[];

    fn query(&self) -> Result<String, SerializeError> { ... }
    fn get_uri(&self) -> Result<Uri, InvalidUri> { ... }
    fn get_bare_uri() -> Result<Uri, InvalidUri> { ... }
}

Available on crate feature helix only.

Expand description

A request is a Twitch endpoint, see New Twitch API reference

Required Associated Types

type Response: DeserializeOwned + PartialEq

Response type. twitch’s response will deserialize to this.

Required Associated Constants

const PATH: &'static str

The path to the endpoint relative to the helix root. eg. channels for Get Channel Information

const SCOPE: &'static [Scope ]

Available on crate feature twitch_oauth2 only.

Scopes needed by this endpoint

Provided Associated Constants

const OPT_SCOPE: &'static [Scope ] = &[]

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this endpoint

Provided Methods

fn query(&self) -> Result<String, SerializeError>

Defines layout of the url parameters.

fn get_uri(&self) -> Result<Uri, InvalidUri>

Returns full URI for the request, including query parameters.

fn get_bare_uri() -> Result<Uri, InvalidUri>

Returns bare URI for the request, NOT including query parameters.

Implementors

impl Request for GetBitsLeaderboardRequest

type Response = BitsLeaderboard

const PATH: &'static str = "bits/leaderboard"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetCheermotesRequest

type Response = Vec<Cheermote, Global>

const PATH: &'static str = "bits/cheermotes"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetChannelEditorsRequest

type Response = Vec<Editor, Global>

const PATH: &'static str = "channels/editors"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelReadEditors]

impl Request for GetChannelInformationRequest

type Response = Option<ChannelInformation>

const PATH: &'static str = "channels"

const SCOPE: &'static [Scope ] = &[]

impl Request for ModifyChannelInformationRequest

type Response = ModifyChannelInformation

const PATH: &'static str = "channels"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::UserEditBroadcast]

impl Request for StartCommercialRequest

type Response = Vec<StartCommercial, Global>

const PATH: &'static str = "channels/commercial"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelEditCommercial]

impl Request for GetChannelChatBadgesRequest

type Response = Vec<BadgeSet, Global>

const PATH: &'static str = "chat/badges"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetChannelEmotesRequest

type Response = Vec<ChannelEmote, Global>

const PATH: &'static str = "chat/emotes"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetEmoteSetsRequest

type Response = Vec<Emote, Global>

const PATH: &'static str = "chat/emotes/set"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetGlobalChatBadgesRequest

type Response = Vec<BadgeSet, Global>

const PATH: &'static str = "chat/badges/global"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetGlobalEmotesRequest

type Response = Vec<GlobalEmote, Global>

const PATH: &'static str = "chat/emotes/global"

const SCOPE: &'static [Scope ] = &[]

impl Request for UpdateChatSettingsRequest

type Response = ChatSettings

const PATH: &'static str = "chat/settings"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ModeratorManageChatSettings]

impl Request for GetClipsRequest

type Response = Vec<Clip, Global>

const PATH: &'static str = "clips"

const SCOPE: &'static [Scope ] = &[]

impl Request for DeleteEventSubSubscriptionRequest

Available on crate feature eventsub only.

type Response = DeleteEventSubSubscription

const PATH: &'static str = "eventsub/subscriptions"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetEventSubSubscriptionsRequest

Available on crate feature eventsub only.

type Response = EventSubSubscriptions

const PATH: &'static str = "eventsub/subscriptions"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetGamesRequest

type Response = Vec<TwitchCategory, Global>

const PATH: &'static str = "games"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetTopGamesRequest

type Response = Vec<TwitchCategory, Global>

const PATH: &'static str = "games/top"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetCreatorGoalsRequest

type Response = Vec<CreatorGoal, Global>

const PATH: &'static str = "goals"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelReadGoals]

impl Request for GetHypeTrainEventsRequest

type Response = Vec<HypeTrainEvent, Global>

const PATH: &'static str = "hypetrain/events"

const SCOPE: &'static [Scope ] = &[]

impl Request for AddBlockedTermRequest

type Response = Vec<BlockedTerm, Global>

const PATH: &'static str = "moderation/blocked_terms"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ModeratorManageBlockedTerms]

impl Request for BanUserRequest

type Response = BanUser

const PATH: &'static str = "moderation/bans"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ModeratorManageBannedUsers]

impl Request for CheckAutoModStatusRequest

type Response = Vec<CheckAutoModStatus, Global>

const PATH: &'static str = "moderation/enforcements/status"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ModerationRead]

impl Request for GetBannedUsersRequest

type Response = Vec<BannedUser, Global>

const PATH: &'static str = "moderation/banned"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ModerationRead]

impl Request for GetBlockedTerms

type Response = Vec<BlockedTerm, Global>

const PATH: &'static str = "moderation/blocked_terms"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ModeratorReadBlockedTerms]

impl Request for GetModeratorsRequest

type Response = Vec<Moderator, Global>

const PATH: &'static str = "moderation/moderators"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ModerationRead]

impl Request for ManageHeldAutoModMessagesRequest

type Response = ManageHeldAutoModMessages

const PATH: &'static str = "moderation/automod/message"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ModerationRead]

impl Request for RemoveBlockedTermRequest

type Response = RemoveBlockedTerm

const OPT_SCOPE: &'static [Scope ] = &[]

const PATH: &'static str = "moderation/blocked_terms"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ModeratorManageBlockedTerms]

impl Request for UnbanUserRequest

type Response = UnbanUserResponse

const PATH: &'static str = "moderation/bans"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ModeratorManageBannedUsers]

impl Request for CreateCustomRewardRequest

type Response = CustomReward

const PATH: &'static str = "channel_points/custom_rewards"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManageRedemptions]

impl Request for DeleteCustomRewardRequest

type Response = DeleteCustomReward

const PATH: &'static str = "channel_points/custom_rewards"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManageRedemptions]

impl Request for GetCustomRewardRequest

type Response = Vec<CustomReward, Global>

const PATH: &'static str = "channel_points/custom_rewards"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::scopes::Scope::ChannelReadRedemptions]

impl Request for GetCustomRewardRedemptionRequest

type Response = Vec<CustomRewardRedemption, Global>

const PATH: &'static str = "channel_points/custom_rewards/redemptions"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::scopes::Scope::ChannelReadRedemptions]

impl Request for UpdateCustomRewardRequest

type Response = UpdateCustomReward

const PATH: &'static str = "channel_points/custom_rewards"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManageRedemptions]

impl Request for UpdateRedemptionStatusRequest

type Response = UpdateRedemptionStatusInformation

const PATH: &'static str = "channel_points/custom_rewards/redemptions"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::scopes::Scope::ChannelManageBroadcast]

impl Request for CreatePollRequest

type Response = Poll

const PATH: &'static str = "polls"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManagePolls]

impl Request for EndPollRequest

type Response = EndPoll

const PATH: &'static str = "polls"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManagePolls]

impl Request for GetPollsRequest

type Response = Vec<Poll, Global>

const PATH: &'static str = "polls"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelReadPolls]

impl Request for CreatePredictionRequest

type Response = Prediction

const PATH: &'static str = "predictions"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManagePredictions]

impl Request for EndPredictionRequest

type Response = EndPrediction

const PATH: &'static str = "predictions"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManagePredictions]

impl Request for GetPredictionsRequest

type Response = Vec<Prediction, Global>

const PATH: &'static str = "predictions"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelReadPredictions]

impl Request for CreateChannelStreamScheduleSegmentRequest

type Response = ScheduledBroadcasts

const PATH: &'static str = "schedule/segment"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManageSchedule]

impl Request for GetChannelStreamScheduleRequest

type Response = ScheduledBroadcasts

const PATH: &'static str = "schedule"

const SCOPE: &'static [Scope ] = &[]

impl Request for UpdateChannelStreamScheduleRequest

type Response = UpdateChannelStreamSchedule

const PATH: &'static str = "schedule/settings"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManageSchedule]

impl Request for UpdateChannelStreamScheduleSegmentRequest

type Response = ScheduledBroadcasts

const PATH: &'static str = "schedule/segment"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManageSchedule]

impl Request for SearchCategoriesRequest

type Response = Vec<TwitchCategory, Global>

const PATH: &'static str = "search/categories"

const SCOPE: &'static [Scope ] = &[]

impl Request for SearchChannelsRequest

type Response = Vec<Channel, Global>

const PATH: &'static str = "search/channels"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetFollowedStreamsRequest

type Response = Vec<Stream, Global>

const PATH: &'static str = "streams/followed"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::UserReadFollows]

impl Request for GetStreamTagsRequest

type Response = Vec<TwitchTag, Global>

const PATH: &'static str = "streams/tags"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetStreamsRequest

type Response = Vec<Stream, Global>

const PATH: &'static str = "streams"

const SCOPE: &'static [Scope ] = &[]

impl Request for ReplaceStreamTagsRequest

type Response = ReplaceStreamTags

const PATH: &'static str = "streams/tags"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManageBroadcast]

impl Request for CheckUserSubscriptionRequest

type Response = UserSubscription

const PATH: &'static str = "subscriptions/user"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::UserReadSubscriptions]

impl Request for GetBroadcasterSubscriptionsRequest

type Response = Vec<BroadcasterSubscription, Global>

const PATH: &'static str = "subscriptions"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelReadSubscriptions]

impl Request for GetBroadcasterSubscriptionsEventsRequest

type Response = Vec<BroadcasterSubscriptionEvent, Global>

const PATH: &'static str = "subscriptions/events"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelReadSubscriptions]

impl Request for GetAllStreamTagsRequest

type Response = Vec<TwitchTag, Global>

const PATH: &'static str = "tags/streams"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetChannelTeamsRequest

type Response = Vec<BroadcasterTeam, Global>

const OPT_SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::UserReadEmail]

const PATH: &'static str = "teams/channel"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetTeamsRequest

type Response = Vec<Team, Global>

const OPT_SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::UserReadEmail]

const PATH: &'static str = "teams"

const SCOPE: &'static [Scope ] = &[]

impl Request for BlockUserRequest

type Response = BlockUser

const OPT_SCOPE: &'static [Scope ] = &[]

const PATH: &'static str = "users/blocks"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::UserManageBlockedUsers]

impl Request for GetUserBlockListRequest

type Response = Vec<UserBlock, Global>

const OPT_SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::UserReadBlockedUsers]

const PATH: &'static str = "users/blocks"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetUsersRequest

type Response = Vec<User, Global>

const OPT_SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::UserReadEmail]

const PATH: &'static str = "users"

const SCOPE: &'static [Scope ] = &[]

impl Request for GetUsersFollowsRequest

type Response = UsersFollows

const OPT_SCOPE: &'static [Scope ] = &[]

const PATH: &'static str = "users/follows"

const SCOPE: &'static [Scope ] = &[]

impl Request for UnblockUserRequest

type Response = UnblockUser

const OPT_SCOPE: &'static [Scope ] = &[]

const PATH: &'static str = "users/blocks"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::UserManageBlockedUsers]

impl Request for DeleteVideosRequest

type Response = DeleteVideo

const PATH: &'static str = "videos"

const SCOPE: &'static [Scope ] = &[twitch_oauth2::Scope::ChannelManageVideos]

impl Request for GetVideosRequest

type Response = Vec<Video, Global>

const PATH: &'static str = "videos"

const SCOPE: &'static [Scope ] = &[]

impl<E: EventSubscription> Request for CreateEventSubSubscriptionRequest<E>

Available on crate feature eventsub only.

type Response = CreateEventSubSubscription<E>

const PATH: &'static str = "eventsub/subscriptions"

const SCOPE: &'static [Scope ] = &[]