Skip to content

Commit 457cf40

Browse files
EmilgardisEmilgardis
committed
fix docs
1 parent 9146648 commit 457cf40

File tree

4 files changed

+19
-9
lines changed

4 files changed

+19
-9
lines changed

‎README.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ This crate aims to target
4949
* TMI
5050
* Implemented, see [implemented endpoints](#tmi)
5151
* [EventSub](https://dev.twitch.tv/docs/eventsub/eventsub-reference)
52-
* Not implemented, see issue #55
52+
* Implemented, see [eventsub Helix endpoints](#eventsub)
5353
* [Webhooks](https://dev.twitch.tv/docs/api/webhooks-reference)
5454
* Partially implemented, see [implemented webhooks](#webhooks)
5555
* [PubSub](https://dev.twitch.tv/docs/pubsub) (without a client)
@@ -146,6 +146,15 @@ There are no current plans to support
146146
| 🔨 Redeem Code | `POST https://api.twitch.tv/helix/entitlements/code` | <!--[![docs-rs]](https://docs.rs/twitch_api2/*/twitch_api2/helix/redeem_code)--> [![twitch-reference]](https://dev.twitch.tv/docs/api/reference#redeem-code) |
147147

148148

149+
#### EventSub
150+
151+
| Endpoint | | |
152+
| :------------------------------------- | :----------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
153+
| 🔨 Create EventSub Subscription | `POST https://api.twitch.tv/helix/eventsub/subscriptions` | [![docs-rs]](https://docs.rs/twitch_api2/*/twitch_api2/helix/eventsub/create_eventsub_subscription) [![twitch-reference]](https://dev.twitch.tv/docs/api/reference#create-eventsub-subscription) |
154+
| 🔨 Delete EventSub Subscription | `DELETE https://api.twitch.tv/helix/eventsub/subscriptions` | [![docs-rs]](https://docs.rs/twitch_api2/*/twitch_api2/helix/eventsub/delete_eventsub_subscription) [![twitch-reference]](https://dev.twitch.tv/docs/api/reference#delete-eventsub-subscription) |
155+
| 🔨 Get EventSub Subscriptions | `GET https://api.twitch.tv/helix/eventsub/subscriptions` | [![docs-rs]](https://docs.rs/twitch_api2/*/twitch_api2/helix/eventsub/redeem_cget_eventsub_subscriptionsode) [![twitch-reference]](https://dev.twitch.tv/docs/api/reference#get-eventsub-subscriptions) |
156+
157+
149158
#### Games
150159

151160
| Endpoint | | |
@@ -214,7 +223,7 @@ There are no current plans to support
214223

215224
| Endpoint | | |
216225
| :-------------------------- | :------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
217-
| 🔨 Get Webhook Subscriptions | `GET https://api.twitch.tv/helix/webhooks/subscriptions` | <!--[![docs-rs]](https://docs.rs/twitch_api2/*/twitch_api2/helix/webhooks/get_webhook_subscriptions)--> [![twitch-reference]](https://dev.twitch.tv/docs/api/reference#get-webhook-subscriptions) |
226+
| ✔ Get Webhook Subscriptions | `GET https://api.twitch.tv/helix/webhooks/subscriptions` | [![docs-rs]](https://docs.rs/twitch_api2/*/twitch_api2/helix/webhooks/get_webhook_subscriptions) [![twitch-reference]](https://dev.twitch.tv/docs/api/reference#get-webhook-subscriptions) |
218227
219228
#### Hypetrain
220229

‎src/helix/eventsub/create_eventsub_subscription.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use crate::eventsub::{EventSubscription, EventType, Status, Transport, Transport
77

88
/// Query Parameters for [Create EventSub Subscription](super::create_eventsub_subscription)
99
///
10-
/// [`create-eventsub-subscription`](https://dev.twitch.tv/docs/eventsub/helix-endpoints#create-eventsub-subscription)
10+
/// [`create-eventsub-subscription`](https://dev.twitch.tv/docs/api/reference#create-eventsub-subscription)
1111
#[derive(PartialEq, typed_builder::TypedBuilder, Serialize, Clone, Debug, Default)]
1212
#[non_exhaustive]
1313
pub struct CreateEventSubSubscriptionRequest<E: EventSubscription> {
@@ -26,9 +26,10 @@ impl<E: EventSubscription> helix::Request for CreateEventSubSubscriptionRequest<
2626

2727
/// Body Parameters for [Create EventSub Subscription](super::create_eventsub_subscription)
2828
///
29-
/// [`create-eventsub-subscription`](https://dev.twitch.tv/docs/eventsub/helix-endpoints#create-eventsub-subscription)
29+
/// [`create-eventsub-subscription`](https://dev.twitch.tv/docs/api/reference#create-eventsub-subscription)
3030
///
3131
/// # Notes
32+
///
3233
/// This body is quite different from the official body. If you want the true representation in text, see [`helix::RequestPost::body`] on [`CreateEventSubSubscriptionRequest<E: EventSubscription>`](CreateEventSubSubscriptionRequest)
3334
#[derive(PartialEq, typed_builder::TypedBuilder, Deserialize, Serialize, Clone, Debug)]
3435
#[non_exhaustive]
@@ -53,7 +54,7 @@ impl<E: EventSubscription> CreateEventSubSubscriptionBody<E> {
5354

5455
/// Return Values for [Create EventSub Subscription](super::create_eventsub_subscription)
5556
///
56-
/// [`create-eventsub-subscription`](https://dev.twitch.tv/docs/eventsub/helix-endpoints#create-eventsub-subscription)
57+
/// [`create-eventsub-subscription`](https://dev.twitch.tv/docs/api/reference#create-eventsub-subscription)
5758
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
5859
#[non_exhaustive]
5960
pub struct CreateEventSubSubscription<E: EventSubscription> {

‎src/helix/eventsub/delete_eventsub_subscription.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use super::*;
44

55
/// Query Parameters for [Get EventSub Subscriptions](super::get_eventsub_subscriptions)
66
///
7-
/// [`get-eventsub-subscriptions`](https://dev.twitch.tv/docs/eventsub/helix-endpoints#get-eventsub-subscriptions)
7+
/// [`get-eventsub-subscriptions`](https://dev.twitch.tv/docs/api/reference#delete-eventsub-subscription)
88
#[derive(PartialEq, typed_builder::TypedBuilder, Serialize, Clone, Debug, Default)]
99
#[non_exhaustive]
1010
pub struct DeleteEventSubSubscriptionRequest {
@@ -23,7 +23,7 @@ impl helix::Request for DeleteEventSubSubscriptionRequest {
2323

2424
/// Return Values for [Get EventSub Subscriptions](super::get_eventsub_subscriptions)
2525
///
26-
/// [`get-eventsub-subscriptions`](https://dev.twitch.tv/docs/eventsub/helix-endpoints#get-eventsub-subscriptions)
26+
/// [`get-eventsub-subscriptions`](https://dev.twitch.tv/docs/api/reference#delete-eventsub-subscription)
2727
#[derive(PartialEq, Deserialize, Serialize, Debug, Clone)]
2828
#[non_exhaustive]
2929
pub enum DeleteEventSubSubscription {

‎src/helix/eventsub/get_eventsub_subscriptions.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ use crate::eventsub;
55

66
/// Query Parameters for [Get EventSub Subscriptions](super::get_eventsub_subscriptions)
77
///
8-
/// [`get-eventsub-subscriptions`](https://dev.twitch.tv/docs/eventsub/helix-endpoints#get-eventsub-subscriptions)
8+
/// [`get-eventsub-subscriptions`](https://dev.twitch.tv/docs/api/reference#get-eventsub-subscriptions)
99
#[derive(PartialEq, typed_builder::TypedBuilder, Serialize, Clone, Debug)]
1010
#[non_exhaustive]
1111
pub struct GetEventSubSubscriptionsRequest {
@@ -32,7 +32,7 @@ impl helix::Request for GetEventSubSubscriptionsRequest {
3232

3333
/// Return Values for [Get EventSub Subscriptions](super::get_eventsub_subscriptions)
3434
///
35-
/// [`get-eventsub-subscriptions`](https://dev.twitch.tv/docs/eventsub/helix-endpoints#get-eventsub-subscriptions)
35+
/// [`get-eventsub-subscriptions`](https://dev.twitch.tv/docs/api/reference#get-eventsub-subscriptions)
3636
pub type EventSubSubscription = eventsub::EventSubSubscription;
3737

3838
impl helix::RequestGet for GetEventSubSubscriptionsRequest {}

0 commit comments

Comments
 (0)