Struct GetCustomRewardRedemptionRequest

#[non_exhaustive]
pub struct GetCustomRewardRedemptionRequest<'a> {
    pub broadcaster_id: Cow<'a, UserIdRef>,
    pub reward_id: Option<Cow<'a, RewardIdRef>>,
    pub status: Option<CustomRewardRedemptionStatus>,
    pub id: Collection<'a, RedemptionId>,
    pub sort: Option<GetCustomRewardRedemptionSortOrder>,
    pub after: Option<Cow<'a, CursorRef>>,
    pub first: Option<usize>,
}

Available on crate feature helix only.

Query Parameters for Get Custom Reward Redemption

get-custom-reward-redemption

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

broadcaster_id: Cow<'a, UserIdRef>

Provided broadcaster_id must match the user_id in the auth token

reward_id: Option<Cow<'a, RewardIdRef>>

When ID is not provided, this parameter returns paginated Custom Reward Redemption objects for redemptions of the Custom Reward with ID reward_id

status: Option<CustomRewardRedemptionStatus>

When id is not provided, this param is required and filters the paginated Custom Reward Redemption objects for redemptions with the matching status. Can be one of UNFULFILLED, FULFILLED or CANCELED

id: Collection<'a, RedemptionId>

A list of IDs to filter the redemptions by.

sort: Option<GetCustomRewardRedemptionSortOrder>

The order to sort redemptions by.

after: Option<Cow<'a, CursorRef>>

Cursor for forward pagination: tells the server where to start fetching the next set of results, in a multi-page response. This applies only to queries without ID. If an ID is specified, it supersedes any cursor/offset combinations. The cursor value specified here is from the pagination response field of a prior query.

first: Option<usize>

Number of results to be returned when getting the paginated Custom Reward Redemption objects for a reward. Limit: 50. Default: 20.

Implementations

impl<'a> GetCustomRewardRedemptionRequest<'a>

pub fn builder() -> GetCustomRewardRedemptionRequestBuilder<'a, ((), (), (), (), (), (), ())>

Create a builder for building GetCustomRewardRedemptionRequest. On the builder, call .broadcaster_id(...), .reward_id(...), .status(...)(optional), .id(...)(optional), .sort(...)(optional), .after(...)(optional), .first(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of GetCustomRewardRedemptionRequest.

impl<'a> GetCustomRewardRedemptionRequest<'a>

pub fn broadcaster_id(broadcaster_id: impl IntoCow<'a, UserIdRef> + 'a) -> Self

Reward to fetch

pub fn reward_id(self, reward_id: impl IntoCow<'a, RewardIdRef> + 'a) -> Self

Specific reward to query

pub fn status(self, status: impl Into<CustomRewardRedemptionStatus>) -> Self

Status of rewards to return

pub fn sort(self, sort: impl Into<GetCustomRewardRedemptionSortOrder>) -> Self

The order to sort redemptions by.

pub fn ids(self, id: impl Into<Collection<'a, RedemptionId>>) -> Self

Get redemptions with these ids

Trait Implementations

impl<'a> Clone for GetCustomRewardRedemptionRequest<'a>

fn clone(&self) -> GetCustomRewardRedemptionRequest<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for GetCustomRewardRedemptionRequest<'a>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for GetCustomRewardRedemptionRequest<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Paginated for GetCustomRewardRedemptionRequest<'_>

fn set_pagination(&mut self, cursor: Option<Cursor>)

Should returns the current pagination cursor.

impl<'a> PartialEq for GetCustomRewardRedemptionRequest<'a>

fn eq(&self, other: &GetCustomRewardRedemptionRequest<'a>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Request for GetCustomRewardRedemptionRequest<'_>

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

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

const SCOPE: Validator

Available on crate feature twitch_oauth2 only.

Scopes needed for this endpoint

type Response = Vec<CustomRewardRedemption>

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

const OPT_SCOPE: &'static [Scope] = _

Available on crate feature twitch_oauth2 only.

Optional scopes needed by this endpoint

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.

impl RequestGet for GetCustomRewardRedemptionRequest<'_>

fn create_request( &self, token: &str, client_id: &str, ) -> Result<Request<Bytes>, CreateRequestError>

Create a http::Request from this Request in your client

fn parse_response<B: Into<Bytes>>( request: Option<Self>, uri: &Uri, response: Response<B>, ) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>

where Self: Sized,

Parse response.

fn parse_inner_response( request: Option<Self>, uri: &Uri, response: &str, status: StatusCode, ) -> Result<Response<Self, <Self as Request>::Response>, HelixRequestGetError>

where Self: Sized,

Parse a response string into the response.

impl<'a> Serialize for GetCustomRewardRedemptionRequest<'a>

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'a> Eq for GetCustomRewardRedemptionRequest<'a>

impl<'a> StructuralPartialEq for GetCustomRewardRedemptionRequest<'a>