-
Notifications
You must be signed in to change notification settings - Fork 0
/
sponsorblock.go
5301 lines (4311 loc) · 145 KB
/
sponsorblock.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Package sponsorblockgo provides primitives to interact with the openapi HTTP API.
//
// Code generated by github.com/deepmap/oapi-codegen version v1.9.1 DO NOT EDIT.
package sponsorblockgo
import (
"bytes"
"context"
"encoding/json"
"fmt"
"io"
"io/ioutil"
"net/http"
"net/url"
"strings"
"github.com/deepmap/oapi-codegen/pkg/runtime"
)
const (
PrivateAdminUserIDScopes = "privateAdminUserID.Scopes"
PrivateUserIDScopes = "privateUserID.Scopes"
)
// Defines values for ActionType.
const (
ActionTypeMute ActionType = "mute"
ActionTypeSkip ActionType = "skip"
)
// Defines values for Category.
const (
CategoryInteraction Category = "interaction"
CategoryIntro Category = "intro"
CategoryMusicOfftopic Category = "music_offtopic"
CategoryOutro Category = "outro"
CategoryPoiHighlight Category = "poi_highlight"
CategoryPreview Category = "preview"
CategorySelfpromo Category = "selfpromo"
CategorySponsor Category = "sponsor"
)
// Defines values for DbSegmentHidden.
const (
DbSegmentHiddenN0 DbSegmentHidden = 0
DbSegmentHiddenN1 DbSegmentHidden = 1
)
// Defines values for DbSegmentLocked.
const (
DbSegmentLockedN0 DbSegmentLocked = 0
DbSegmentLockedN1 DbSegmentLocked = 1
)
// Defines values for DbSegmentShadowHidden.
const (
DbSegmentShadowHiddenN0 DbSegmentShadowHidden = 0
DbSegmentShadowHiddenN1 DbSegmentShadowHidden = 1
)
// Defines values for LockReasonLocked.
const (
LockReasonLockedN0 LockReasonLocked = 0
LockReasonLockedN1 LockReasonLocked = 1
)
// Defines values for Services.
const (
ServicesYouTube Services = "YouTube"
)
// Defines values for SkipSegmentLocked.
const (
SkipSegmentLockedN0 SkipSegmentLocked = 0
SkipSegmentLockedN1 SkipSegmentLocked = 1
)
// Defines values for Service.
const (
YouTube Service = "YouTube"
)
// Defines values for SubmitActionType.
const (
Mute SubmitActionType = "mute"
Skip SubmitActionType = "skip"
)
// Defines values for SubmitCategory.
const (
Filler SubmitCategory = "filler"
Interaction SubmitCategory = "interaction"
Intro SubmitCategory = "intro"
MusicOfftopic SubmitCategory = "music_offtopic"
Outro SubmitCategory = "outro"
PoiHighlight SubmitCategory = "poi_highlight"
Preview SubmitCategory = "preview"
Selfpromo SubmitCategory = "selfpromo"
Sponsor SubmitCategory = "sponsor"
)
// 403 Error when non-VIP users access VIP endpoints
type N403VIP struct {
Message *string `json:"message,omitempty"`
}
// possible action types
type ActionType string
// Segment Category
type Category string
// Segment as-is in DB
type DbSegment struct {
UUID *SegmentUUID `json:"UUID,omitempty"`
// possible action types
ActionType *ActionType `json:"actionType,omitempty"`
// Segment Category
Category *Category `json:"category,omitempty"`
// end time of segment
EndTime *float32 `json:"endTime,omitempty"`
// Full hash of videoID
HashedVideoID *VideoIDHash `json:"hashedVideoID,omitempty"`
// If segment is hidden
Hidden *DbSegmentHidden `json:"hidden,omitempty"`
// Number of incorrect votes
IncorrectVotes *int `json:"incorrectVotes,omitempty"`
// If segment is locked
Locked *DbSegmentLocked `json:"locked,omitempty"`
// Reputation of submitter at time of submission
Reputation *float32 `json:"reputation,omitempty"`
// Supported services
Service *Services `json:"service,omitempty"`
// If submitter is shadowbanned
ShadowHidden *DbSegmentShadowHidden `json:"shadowHidden,omitempty"`
// start time of segment
StartTime *float32 `json:"startTime,omitempty"`
// Time of submission (epoch ms)
TimeSubmitted *int `json:"timeSubmitted,omitempty"`
// userAgent of submitter
UserAgent *string `json:"userAgent,omitempty"`
// Public userID (private userID hashed 5000 times)
UserID *PublicUserID `json:"userID,omitempty"`
// Duration of video at time of submission.
VideoDuration *VideoDuration `json:"videoDuration,omitempty"`
// ID of video
VideoID *VideoID `json:"videoID,omitempty"`
// Number of reported views on segment
Views *int `json:"views,omitempty"`
// votes on segment
Votes *int `json:"votes,omitempty"`
}
// If segment is hidden
type DbSegmentHidden int
// If segment is locked
type DbSegmentLocked int
// If submitter is shadowbanned
type DbSegmentShadowHidden int
// Privacy preserving skip segments
type HashSkipSegment []struct {
// Full hash of videoID
Hash *VideoIDHash `json:"hash,omitempty"`
Segments *SkipSegment `json:"segments,omitempty"`
// ID of video
VideoID *VideoID `json:"videoID,omitempty"`
}
// Parameter does not match format requirements (Bad JSON or not an arrya)
type InvalidParameter string
// VIP specified lock reason
type LockReason struct {
// Segment Category
Category *Category `json:"category,omitempty"`
// Status of lockStatusk of category
Locked *LockReasonLocked `json:"locked,omitempty"`
// VIP specified lock reason
Reason *string `json:"reason"`
// Public userID (private userID hashed 5000 times)
UserID *PublicUserID `json:"userID,omitempty"`
// Username of locking VIP
UserName *string `json:"userName"`
}
// Status of lockStatusk of category
type LockReasonLocked int
// private userID when not used in query parameter
type PrivateUserID string
// Public userID (private userID hashed 5000 times)
type PublicUserID string
// Single search segment
type SearchSegment struct {
UUID *SegmentUUID `json:"UUID,omitempty"`
// possible action types
ActionType *ActionType `json:"actionType,omitempty"`
// Segment Category
Category *Category `json:"category,omitempty"`
// end time of segment
EndTime *float32 `json:"endTime,omitempty"`
// If segment is hidden
Hidden *bool `json:"hidden,omitempty"`
// If segment is locked
Locked *bool `json:"locked,omitempty"`
// If submitter is shadowbanned
Shadowhidden *bool `json:"shadowhidden,omitempty"`
// start time of segment
StartTime *float32 `json:"startTime,omitempty"`
// Time submitted (ms epoch)
TimeSubmitted *int `json:"timeSubmitted,omitempty"`
// Reported views on segment
Views *int `json:"views,omitempty"`
// votes on segment
Votes *string `json:"votes,omitempty"`
}
// SegmentUUID defines model for segmentUUID.
type SegmentUUID string
// Supported services
type Services string
// SkipSegment defines model for skipSegment.
type SkipSegment struct {
UUID *SegmentUUID `json:"UUID,omitempty"`
// possible action types
ActionType *ActionType `json:"actionType,omitempty"`
// Segment Category
Category *Category `json:"category,omitempty"`
// Unused
Description *string `json:"description"`
// If segment is locked
Locked *SkipSegmentLocked `json:"locked,omitempty"`
// start and end time in seconds
Segment *[]float32 `json:"segment,omitempty"`
// Public userID (private userID hashed 5000 times)
UserID *PublicUserID `json:"userID,omitempty"`
// Duration of video at time of submission.
VideoDuration *VideoDuration `json:"videoDuration,omitempty"`
// Votes on segment on the segment
Votes *float32 `json:"votes,omitempty"`
}
// If segment is locked
type SkipSegmentLocked int
// StatusResponse defines model for statusResponse.
type StatusResponse struct {
Commit *interface{} `json:"commit,omitempty"`
// Current database version
Db *int `json:"db,omitempty"`
// ms between startTime and sending response
ProcessTime *int `json:"processTime,omitempty"`
// Unix (ms) time that request was recieved
StartTime *int `json:"startTime,omitempty"`
// Uptime in seconds
Uptime *int `json:"uptime,omitempty"`
}
// Object of segment to submit
type SubmitSegment struct {
// possible action types
ActionType *ActionType `json:"actionType,omitempty"`
// Segment Category
Category Category `json:"category"`
// start and end time in seconds
Segment []float32 `json:"segment"`
}
// Response from userStats
type UserStats struct {
ActionTypeCount *interface{} `json:"actionTypeCount,omitempty"`
CategoryCount *interface{} `json:"categoryCount,omitempty"`
MinutesSaved *int `json:"minutesSaved,omitempty"`
SegmentCount *int `json:"segmentCount,omitempty"`
// Public userID (private userID hashed 5000 times)
UserID *PublicUserID `json:"userID,omitempty"`
// user name
UserName *string `json:"userName,omitempty"`
}
// Duration of video at time of submission.
type VideoDuration float32
// ID of video
type VideoID string
// Full hash of videoID
type VideoIDHash string
// VideoLock defines model for videoLock.
type VideoLock struct {
Categories *[]Category `json:"categories,omitempty"`
// Specified reason for lock
Reason *string `json:"reason,omitempty"`
// Supported services
Service *Services `json:"service,omitempty"`
}
// UUID defines model for UUID.
type UUID string
// RequiredSegment defines model for requiredSegment.
type RequiredSegment []string
// RequiredVideoID defines model for requiredVideoID.
type RequiredVideoID string
// Service defines model for service.
type Service string
// Sha256HashPrefix defines model for sha256HashPrefix.
type Sha256HashPrefix string
// SubmitActionType defines model for submitActionType.
type SubmitActionType string
// SubmitCategory defines model for submitCategory.
type SubmitCategory string
// PostadduserasvipParams defines parameters for Postadduserasvip.
type PostadduserasvipParams struct {
// Public userID of user to add to VIP list
UserID string `json:"userID"`
// enable or disable user
Enabled *bool `json:"enabled,omitempty"`
}
// PostClearCacheParams defines parameters for PostClearCache.
type PostClearCacheParams struct {
// ID of video
VideoID RequiredVideoID `json:"videoID"`
// Service to target - See https://wiki.sponsor.ajay.app/w/Types#Service
Service PostClearCacheParamsService `json:"service"`
}
// PostClearCacheParamsService defines parameters for PostClearCache.
type PostClearCacheParamsService string
// GetTopUsersParams defines parameters for GetTopUsers.
type GetTopUsersParams struct {
// 0 for by minutes saved, 1 for by view count, 2 for by total submissions
SortType GetTopUsersParamsSortType `json:"sortType"`
}
// GetTopUsersParamsSortType defines parameters for GetTopUsers.
type GetTopUsersParamsSortType int
// GetTotalStatsParams defines parameters for GetTotalStats.
type GetTotalStatsParams struct {
// Include contributing users
CountContributingUsers *bool `json:"countContributingUsers,omitempty"`
}
// DeleteLockCategoriesParams defines parameters for DeleteLockCategories.
type DeleteLockCategoriesParams struct {
// ID of video
VideoID RequiredVideoID `json:"videoID"`
// Array of categories - See https://wiki.sponsor.ajay.app/w/Types#Category
Category Category `json:"category"`
}
// DeleteLockCategoriesParamsCategory defines parameters for DeleteLockCategories.
type DeleteLockCategoriesParamsCategory string
// GetLockCategoriesParams defines parameters for GetLockCategories.
type GetLockCategoriesParams struct {
// ID of video
VideoID RequiredVideoID `json:"videoID"`
}
// PostLockCategoriesParams defines parameters for PostLockCategories.
type PostLockCategoriesParams struct {
// ID of video
VideoID RequiredVideoID `json:"videoID"`
// Array of categories - See https://wiki.sponsor.ajay.app/w/Types#Category
Category Category `json:"category"`
// Lock reason
Reason *string `json:"reason,omitempty"`
}
// PostLockCategoriesParamsCategory defines parameters for PostLockCategories.
type PostLockCategoriesParamsCategory string
// GetLockReasonParams defines parameters for GetLockReason.
type GetLockReasonParams struct {
// ID of video
VideoID RequiredVideoID `json:"videoID"`
// categories to get reasons for
Category *GetLockReasonParamsCategory `json:"category,omitempty"`
}
// GetLockReasonParamsCategory defines parameters for GetLockReason.
type GetLockReasonParamsCategory []interface{}
// PostPurgeAllSegmentsParams defines parameters for PostPurgeAllSegments.
type PostPurgeAllSegmentsParams struct {
// ID of video
VideoID RequiredVideoID `json:"videoID"`
// Service to target - See https://wiki.sponsor.ajay.app/w/Types#Service
Service PostPurgeAllSegmentsParamsService `json:"service"`
}
// PostPurgeAllSegmentsParamsService defines parameters for PostPurgeAllSegments.
type PostPurgeAllSegmentsParamsService string
// GetSearchSegmentsParams defines parameters for GetSearchSegments.
type GetSearchSegmentsParams struct {
// ID of video
VideoID RequiredVideoID `json:"videoID"`
// Array of categories - See https://wiki.sponsor.ajay.app/w/Types#Category
Category Category `json:"category"`
// multiple action types - Options are skip, mute
ActionType ActionType `json:"actionType"`
// Service to target - See https://wiki.sponsor.ajay.app/w/Types#Service
Service GetSearchSegmentsParamsService `json:"service"`
// Page to start from (0 indexed)
Page *int `json:"page,omitempty"`
// Lower vote threshold
MinVotes *int `json:"minVotes,omitempty"`
// Upper vote threshold
MaxVotes *int `json:"maxVotes,omitempty"`
// Lower view threshold
MinViews *int `json:"minViews,omitempty"`
// Upper view threshold
MaxViews *int `json:"maxViews,omitempty"`
// Show locked segments
Locked *bool `json:"locked,omitempty"`
// Show hidden segments
Hidden *bool `json:"hidden,omitempty"`
// Show ignored segments
Ignored *bool `json:"ignored,omitempty"`
}
// GetSearchSegmentsParamsCategory defines parameters for GetSearchSegments.
type GetSearchSegmentsParamsCategory string
// GetSearchSegmentsParamsActionType defines parameters for GetSearchSegments.
type GetSearchSegmentsParamsActionType string
// GetSearchSegmentsParamsService defines parameters for GetSearchSegments.
type GetSearchSegmentsParamsService string
// GetSegmentInfoParams defines parameters for GetSegmentInfo.
type GetSegmentInfoParams struct {
// Target segment UUID
UUID *string `json:"UUID,omitempty"`
// Array of UUID
UUIDs *[]string `json:"UUIDs,omitempty"`
}
// SetUsernameParams defines parameters for SetUsername.
type SetUsernameParams struct {
// New Username
Username string `json:"username"`
}
// PostShadowBanUserParams defines parameters for PostShadowBanUser.
type PostShadowBanUserParams struct {
// Public userID of target
UserID PublicUserID `json:"userID"`
// Enable or disable ban
Enabled *bool `json:"enabled,omitempty"`
// Should all previous submissions be banned as well
UnHideOldSubmittions *bool `json:"unHideOldSubmittions,omitempty"`
}
// GetskipsegmentsParams defines parameters for Getskipsegments.
type GetskipsegmentsParams struct {
// ID of video
VideoID RequiredVideoID `json:"videoID"`
// Array of categories - See https://wiki.sponsor.ajay.app/w/Types#Category
Category Category `json:"category"`
// multiple action types - Options are skip, mute
ActionType ActionType `json:"actionType"`
// Segment UUIDs to get regardless of votes
RequiredSegment *RequiredSegment `json:"requiredSegment,omitempty"`
// Service to target - See https://wiki.sponsor.ajay.app/w/Types#Service
Service GetskipsegmentsParamsService `json:"service"`
}
// GetskipsegmentsParamsCategory defines parameters for Getskipsegments.
type GetskipsegmentsParamsCategory string
// GetskipsegmentsParamsActionType defines parameters for Getskipsegments.
type GetskipsegmentsParamsActionType string
// GetskipsegmentsParamsService defines parameters for Getskipsegments.
type GetskipsegmentsParamsService string
// PostSkipSegmentsJSONBody defines parameters for PostSkipSegments.
type PostSkipSegmentsJSONBody struct {
Segments []SubmitSegment `json:"segments"`
// Supported services
Service *Services `json:"service,omitempty"`
UserAgent string `json:"userAgent"`
// Duration of video, will attempt to retrieve from YT API if missing. Used to determine when a submission is out of date
VideoDuration *float32 `json:"videoDuration,omitempty"`
// ID of video
VideoID string `json:"videoID"`
}
// PostSkipSegmentsParams defines parameters for PostSkipSegments.
type PostSkipSegmentsParams struct {
// ID of video
VideoID RequiredVideoID `json:"videoID"`
// user agent of submitter
UserAgent string `json:"userAgent"`
// Service to target - See https://wiki.sponsor.ajay.app/w/Types#Service
Service PostSkipSegmentsParamsService `json:"service"`
// duration of video, will attempt to retrieve from YT API if missing. Used to determine when a submission is out of date
VideoDuration *float32 `json:"videoDuration,omitempty"`
// Action type
ActionType PostSkipSegmentsParamsActionType `json:"actionType"`
// Segment Category - See https://wiki.sponsor.ajay.app/w/Types#Category
Category PostSkipSegmentsParamsCategory `json:"category"`
// Start time of segment
StartTime float32 `json:"startTime"`
// End time of segment
EndTime float32 `json:"endTime"`
}
// PostSkipSegmentsParamsService defines parameters for PostSkipSegments.
type PostSkipSegmentsParamsService string
// PostSkipSegmentsParamsActionType defines parameters for PostSkipSegments.
type PostSkipSegmentsParamsActionType string
// PostSkipSegmentsParamsCategory defines parameters for PostSkipSegments.
type PostSkipSegmentsParamsCategory string
// GetSkipSegmentsByHashParams defines parameters for GetSkipSegmentsByHash.
type GetSkipSegmentsByHashParams struct {
// Array of categories - See https://wiki.sponsor.ajay.app/w/Types#Category
Category Category `json:"category"`
// Segment UUIDs to get regardless of votes
RequiredSegment *RequiredSegment `json:"requiredSegment,omitempty"`
// multiple action types - Options are skip, mute
ActionType ActionType `json:"actionType"`
// Service to target - See https://wiki.sponsor.ajay.app/w/Types#Service
Service GetSkipSegmentsByHashParamsService `json:"service"`
}
// GetSkipSegmentsByHashParamsCategory defines parameters for GetSkipSegmentsByHash.
type GetSkipSegmentsByHashParamsCategory string
// GetSkipSegmentsByHashParamsActionType defines parameters for GetSkipSegmentsByHash.
type GetSkipSegmentsByHashParamsActionType string
// GetSkipSegmentsByHashParamsService defines parameters for GetSkipSegmentsByHash.
type GetSkipSegmentsByHashParamsService string
// GetUserIDParams defines parameters for GetUserID.
type GetUserIDParams struct {
// Search string for username. Case sensitive. Minimum for non-exact is 3 characters, maximum is 64 characters
Username string `json:"username"`
// Searches for exact username with no wildcard
Exact *bool `json:"exact,omitempty"`
}
// GetUserInfoParams defines parameters for GetUserInfo.
type GetUserInfoParams struct {
// public userID of user to lookup
PublicUserID *string `json:"publicUserID,omitempty"`
// Private userID
UserID *string `json:"userID,omitempty"`
// Values to get from userInfo
Value *GetUserInfoParamsValue `json:"value,omitempty"`
}
// GetUserInfoParamsValue defines parameters for GetUserInfo.
type GetUserInfoParamsValue []string
// GetUserStatsParams defines parameters for GetUserStats.
type GetUserStatsParams struct {
// Public userID of target
UserID PublicUserID `json:"userID"`
// display category stats
FetchCategoryStats *bool `json:"fetchCategoryStats,omitempty"`
// display type stats
FetchActionTypeStats *string `json:"fetchActionTypeStats,omitempty"`
}
// PostViewedVideoSponsorTimeParams defines parameters for PostViewedVideoSponsorTime.
type PostViewedVideoSponsorTimeParams struct {
// UUID of target segment
UUID UUID `json:"UUID"`
}
// PostVoteOnSponsorTimeParams defines parameters for PostVoteOnSponsorTime.
type PostVoteOnSponsorTimeParams struct {
// UUID of target segment
UUID UUID `json:"UUID"`
// Vote type - 0 for downvote, 1 for upvote, 20 to undo vote
Type *PostVoteOnSponsorTimeParamsType `json:"type,omitempty"`
// Array of categories - See https://wiki.sponsor.ajay.app/w/Types#Category
Category Category `json:"category"`
}
// PostVoteOnSponsorTimeParamsType defines parameters for PostVoteOnSponsorTime.
type PostVoteOnSponsorTimeParamsType int
// PostVoteOnSponsorTimeParamsCategory defines parameters for PostVoteOnSponsorTime.
type PostVoteOnSponsorTimeParamsCategory string
// PostWarnUserJSONBody defines parameters for PostWarnUser.
type PostWarnUserJSONBody struct {
// If warning should be enabled or disabled
Enabled *bool `json:"enabled,omitempty"`
// private userID when not used in query parameter
IssuerUserID *PrivateUserID `json:"issuerUserID,omitempty"`
// Warning reason to display to user
Reason *string `json:"reason,omitempty"`
// Public userID (private userID hashed 5000 times)
UserID *PublicUserID `json:"userID,omitempty"`
}
// PostSkipSegmentsJSONRequestBody defines body for PostSkipSegments for application/json ContentType.
type PostSkipSegmentsJSONRequestBody PostSkipSegmentsJSONBody
// PostWarnUserJSONRequestBody defines body for PostWarnUser for application/json ContentType.
type PostWarnUserJSONRequestBody PostWarnUserJSONBody
// RequestEditorFn is the function signature for the RequestEditor callback function
type RequestEditorFn func(ctx context.Context, req *http.Request) error
// Doer performs HTTP requests.
//
// The standard http.Client implements this interface.
type HttpRequestDoer interface {
Do(req *http.Request) (*http.Response, error)
}
// Client which conforms to the OpenAPI3 specification for this service.
type Client struct {
// The endpoint of the server conforming to this interface, with scheme,
// https://api.deepmap.com for example. This can contain a path relative
// to the server, such as https://api.deepmap.com/dev-test, and all the
// paths in the swagger spec will be appended to the server.
Server string
// Doer for performing requests, typically a *http.Client with any
// customized settings, such as certificate chains.
Client HttpRequestDoer
// A list of callbacks for modifying requests which are generated before sending over
// the network.
RequestEditors []RequestEditorFn
}
// ClientOption allows setting custom parameters during construction
type ClientOption func(*Client) error
// Creates a new Client, with reasonable defaults
func NewClient(server string, opts ...ClientOption) (*Client, error) {
// create a client with sane default values
client := Client{
Server: server,
}
// mutate client and add all optional params
for _, o := range opts {
if err := o(&client); err != nil {
return nil, err
}
}
// ensure the server URL always has a trailing slash
if !strings.HasSuffix(client.Server, "/") {
client.Server += "/"
}
// create httpClient, if not already present
if client.Client == nil {
client.Client = &http.Client{}
}
return &client, nil
}
// WithHTTPClient allows overriding the default Doer, which is
// automatically created using http.Client. This is useful for tests.
func WithHTTPClient(doer HttpRequestDoer) ClientOption {
return func(c *Client) error {
c.Client = doer
return nil
}
}
// WithRequestEditorFn allows setting up a callback function, which will be
// called right before sending the request. This can be used to mutate the request.
func WithRequestEditorFn(fn RequestEditorFn) ClientOption {
return func(c *Client) error {
c.RequestEditors = append(c.RequestEditors, fn)
return nil
}
}
// The interface specification for the client above.
type ClientInterface interface {
// Postadduserasvip request
Postadduserasvip(ctx context.Context, params *PostadduserasvipParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostClearCache request
PostClearCache(ctx context.Context, params *PostClearCacheParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetDaysSavedFormatted request
GetDaysSavedFormatted(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetTimeSavedForUser request
GetTimeSavedForUser(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetTopUsers request
GetTopUsers(ctx context.Context, params *GetTopUsersParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetTotalStats request
GetTotalStats(ctx context.Context, params *GetTotalStatsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetUsername request
GetUsername(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetViewsForUser request
GetViewsForUser(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetIsUserVIP request
GetIsUserVIP(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// DeleteLockCategories request
DeleteLockCategories(ctx context.Context, params *DeleteLockCategoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLockCategories request
GetLockCategories(ctx context.Context, params *GetLockCategoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostLockCategories request
PostLockCategories(ctx context.Context, params *PostLockCategoriesParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLockCategoriesByHash request
GetLockCategoriesByHash(ctx context.Context, sha256HashPrefix Sha256HashPrefix, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetLockReason request
GetLockReason(ctx context.Context, params *GetLockReasonParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostPurgeAllSegments request
PostPurgeAllSegments(ctx context.Context, params *PostPurgeAllSegmentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSearchSegments request
GetSearchSegments(ctx context.Context, params *GetSearchSegmentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSegmentInfo request
GetSegmentInfo(ctx context.Context, params *GetSegmentInfoParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// SetUsername request
SetUsername(ctx context.Context, params *SetUsernameParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostShadowBanUser request
PostShadowBanUser(ctx context.Context, params *PostShadowBanUserParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// Getskipsegments request
Getskipsegments(ctx context.Context, params *GetskipsegmentsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostSkipSegments request with any body
PostSkipSegmentsWithBody(ctx context.Context, params *PostSkipSegmentsParams, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostSkipSegments(ctx context.Context, params *PostSkipSegmentsParams, body PostSkipSegmentsJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetSkipSegmentsByHash request
GetSkipSegmentsByHash(ctx context.Context, sha256HashPrefix Sha256HashPrefix, params *GetSkipSegmentsByHashParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetStatus request
GetStatus(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetStatusParam request
GetStatusParam(ctx context.Context, value string, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetUserID request
GetUserID(ctx context.Context, params *GetUserIDParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetUserInfo request
GetUserInfo(ctx context.Context, params *GetUserInfoParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// GetUserStats request
GetUserStats(ctx context.Context, params *GetUserStatsParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostViewedVideoSponsorTime request
PostViewedVideoSponsorTime(ctx context.Context, params *PostViewedVideoSponsorTimeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostVoteOnSponsorTime request
PostVoteOnSponsorTime(ctx context.Context, params *PostVoteOnSponsorTimeParams, reqEditors ...RequestEditorFn) (*http.Response, error)
// PostWarnUser request with any body
PostWarnUserWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error)
PostWarnUser(ctx context.Context, body PostWarnUserJSONRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error)
}
func (c *Client) Postadduserasvip(ctx context.Context, params *PostadduserasvipParams, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewPostadduserasvipRequest(c.Server, params)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) PostClearCache(ctx context.Context, params *PostClearCacheParams, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewPostClearCacheRequest(c.Server, params)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) GetDaysSavedFormatted(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewGetDaysSavedFormattedRequest(c.Server)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) GetTimeSavedForUser(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewGetTimeSavedForUserRequest(c.Server)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) GetTopUsers(ctx context.Context, params *GetTopUsersParams, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewGetTopUsersRequest(c.Server, params)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) GetTotalStats(ctx context.Context, params *GetTotalStatsParams, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewGetTotalStatsRequest(c.Server, params)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)
}
func (c *Client) GetUsername(ctx context.Context, reqEditors ...RequestEditorFn) (*http.Response, error) {
req, err := NewGetUsernameRequest(c.Server)
if err != nil {
return nil, err
}
req = req.WithContext(ctx)
if err := c.applyEditors(ctx, req, reqEditors); err != nil {
return nil, err
}
return c.Client.Do(req)