Struct twitch_api2::helix::points::get_custom_reward_redemption::GetCustomRewardRedemptionRequest

#[non_exhaustive]pub struct GetCustomRewardRedemptionRequest {
    pub broadcaster_id: UserId,
    pub reward_id: RewardId,
    pub status: Option<CustomRewardRedemptionStatus>,
    pub after: Option<Cursor>,
    pub first: Option<usize>,
}

This is supported 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: UserId

Provided broadcaster_id must match the user_id in the auth token

reward_id: RewardId

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

after: Option<Cursor>

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 GetCustomRewardRedemptionRequest

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

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

Trait Implementations

impl Clone for GetCustomRewardRedemptionRequest

fn clone(&self) -> GetCustomRewardRedemptionRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetCustomRewardRedemptionRequest

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GetCustomRewardRedemptionRequest

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 PartialEq<GetCustomRewardRedemptionRequest> for GetCustomRewardRedemptionRequest

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Request for GetCustomRewardRedemptionRequest

type Response = Vec<CustomRewardRedemption>

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

const PATH: &'static str

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

const SCOPE: &'static [Scope]

Scopes needed by this endpoint

const OPT_SCOPE: &'static [Scope]

Optional scopes needed by this endpoint

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

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<Vec<u8>>, CreateRequestError>

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

fn parse_response(
    request: Option<Self>,
    uri: &Uri,
    response: Response<Vec<u8>>
) -> Result<Response<Self, Self::Response>, HelixRequestGetError> where
    Self: Sized, 

Parse response. Override for different behavior

impl Serialize for GetCustomRewardRedemptionRequest

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GetCustomRewardRedemptionRequest