rozod 4.4.1 → 4.4.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/lib/endpoints/accountinformationv1.d.ts +42 -81
  2. package/lib/endpoints/accountinformationv1.js +0 -1
  3. package/lib/endpoints/accountsettingsv1.d.ts +54 -89
  4. package/lib/endpoints/assetdeliveryv1.d.ts +22 -19
  5. package/lib/endpoints/assetdeliveryv2.d.ts +10 -10
  6. package/lib/endpoints/authv1.d.ts +98 -146
  7. package/lib/endpoints/authv1.js +218 -9
  8. package/lib/endpoints/authv2.d.ts +70 -120
  9. package/lib/endpoints/authv2.js +10 -7
  10. package/lib/endpoints/authv3.d.ts +3 -4
  11. package/lib/endpoints/authv3.js +12 -1
  12. package/lib/endpoints/avatarv1.d.ts +62 -84
  13. package/lib/endpoints/avatarv1.js +3 -1
  14. package/lib/endpoints/avatarv2.d.ts +16 -29
  15. package/lib/endpoints/avatarv2.js +1 -1
  16. package/lib/endpoints/avatarv3.d.ts +11 -21
  17. package/lib/endpoints/avatarv3.js +1 -1
  18. package/lib/endpoints/badgesv1.d.ts +36 -47
  19. package/lib/endpoints/catalogv1.d.ts +61 -79
  20. package/lib/endpoints/chatv2.d.ts +47 -61
  21. package/lib/endpoints/developv1.d.ts +166 -200
  22. package/lib/endpoints/developv2.d.ts +22 -27
  23. package/lib/endpoints/economyv1.d.ts +2 -3
  24. package/lib/endpoints/friendsv1.d.ts +70 -105
  25. package/lib/endpoints/gamejoinv1.d.ts +17 -27
  26. package/lib/endpoints/gamesv1.d.ts +122 -171
  27. package/lib/endpoints/gamesv2.d.ts +31 -32
  28. package/lib/endpoints/groupsv1.d.ts +245 -360
  29. package/lib/endpoints/groupsv2.d.ts +15 -19
  30. package/lib/endpoints/inventoryv1.d.ts +44 -45
  31. package/lib/endpoints/inventoryv2.d.ts +21 -24
  32. package/lib/endpoints/itemconfigurationv1.d.ts +21 -40
  33. package/lib/endpoints/presencev1.d.ts +6 -5
  34. package/lib/endpoints/privatemessagesv1.d.ts +21 -34
  35. package/lib/endpoints/thumbnailsv1.d.ts +108 -111
  36. package/lib/endpoints/thumbnailsv1.js +2 -0
  37. package/lib/endpoints/tradesv1.d.ts +31 -51
  38. package/lib/endpoints/translationsv1.d.ts +9 -14
  39. package/lib/endpoints/usersv1.d.ts +48 -69
  40. package/package.json +1 -1
@@ -134,7 +134,8 @@ const schemas = {
134
134
  };
135
135
 
136
136
  /**
137
- * @api get https://accountinformation.roblox.com/v1/birthdate
137
+ * @api GET https://accountinformation.roblox.com/v1/birthdate
138
+ * @summary Get the user's birthdate
138
139
  */
139
140
  export const getBirthdate = endpoint({
140
141
  method: 'get' as const,
@@ -146,17 +147,16 @@ export const getBirthdate = endpoint({
146
147
  {
147
148
  status: 400,
148
149
  description: `1: User not found.`,
149
- schema: z.void(),
150
150
  },
151
151
  {
152
152
  status: 401,
153
153
  description: `0: Authorization has been denied for this request.`,
154
- schema: z.void(),
155
154
  },
156
155
  ],
157
156
  });
158
157
  /**
159
- * @api post https://accountinformation.roblox.com/v1/birthdate
158
+ * @api POST https://accountinformation.roblox.com/v1/birthdate
159
+ * @summary Update the user's birthdate
160
160
  * @param body The Roblox.AccountInformation.Api.Models.BirthdateRequest
161
161
  */
162
162
  export const postBirthdate = endpoint({
@@ -176,30 +176,27 @@ export const postBirthdate = endpoint({
176
176
  description: `1: User not found.
177
177
  4: The birthdate provided is invalid.
178
178
  8: Password is incorrect.`,
179
- schema: z.void(),
180
179
  },
181
180
  {
182
181
  status: 401,
183
182
  description: `0: Authorization has been denied for this request.`,
184
- schema: z.void(),
185
183
  },
186
184
  {
187
185
  status: 403,
188
186
  description: `0: Token Validation Failed
189
187
  2: PIN is locked.
190
188
  5: Invalid birthdate change.`,
191
- schema: z.void(),
192
189
  },
193
190
  {
194
191
  status: 500,
195
192
  description: `0: An unknown error occured.
196
193
  5: Invalid birthdate change.`,
197
- schema: z.void(),
198
194
  },
199
195
  ],
200
196
  });
201
197
  /**
202
- * @api get https://accountinformation.roblox.com/v1/description
198
+ * @api GET https://accountinformation.roblox.com/v1/description
199
+ * @summary Get the user's description
203
200
  */
204
201
  export const getDescription = endpoint({
205
202
  method: 'get' as const,
@@ -211,17 +208,16 @@ export const getDescription = endpoint({
211
208
  {
212
209
  status: 400,
213
210
  description: `1: User not found.`,
214
- schema: z.void(),
215
211
  },
216
212
  {
217
213
  status: 401,
218
214
  description: `0: Authorization has been denied for this request.`,
219
- schema: z.void(),
220
215
  },
221
216
  ],
222
217
  });
223
218
  /**
224
- * @api post https://accountinformation.roblox.com/v1/description
219
+ * @api POST https://accountinformation.roblox.com/v1/description
220
+ * @summary Update the user's description
225
221
  * @param body The Roblox.AccountInformation.Api.Models.DescriptionRequest
226
222
  */
227
223
  export const postDescription = endpoint({
@@ -239,33 +235,29 @@ export const postDescription = endpoint({
239
235
  {
240
236
  status: 400,
241
237
  description: `1: User not found.`,
242
- schema: z.void(),
243
238
  },
244
239
  {
245
240
  status: 401,
246
241
  description: `0: Authorization has been denied for this request.`,
247
- schema: z.void(),
248
242
  },
249
243
  {
250
244
  status: 403,
251
245
  description: `0: Token Validation Failed
252
246
  2: PIN is locked.`,
253
- schema: z.void(),
254
247
  },
255
248
  {
256
249
  status: 500,
257
250
  description: `0: An unknown error occured.`,
258
- schema: z.void(),
259
251
  },
260
252
  {
261
253
  status: 503,
262
254
  description: `3: This feature is currently disabled. Please try again later.`,
263
- schema: z.void(),
264
255
  },
265
256
  ],
266
257
  });
267
258
  /**
268
- * @api post https://accountinformation.roblox.com/v1/email/verify
259
+ * @api POST https://accountinformation.roblox.com/v1/email/verify
260
+ * @summary Verify the user's email address from token
269
261
  * @param body Roblox.AccountInformation.Api.Models.VerifyEmailRequest
270
262
  */
271
263
  export const postEmailVerify = endpoint({
@@ -283,12 +275,12 @@ export const postEmailVerify = endpoint({
283
275
  {
284
276
  status: 403,
285
277
  description: `0: Token Validation Failed`,
286
- schema: z.void(),
287
278
  },
288
279
  ],
289
280
  });
290
281
  /**
291
- * @api get https://accountinformation.roblox.com/v1/gender
282
+ * @api GET https://accountinformation.roblox.com/v1/gender
283
+ * @summary Get the user's gender
292
284
  */
293
285
  export const getGender = endpoint({
294
286
  method: 'get' as const,
@@ -300,17 +292,16 @@ export const getGender = endpoint({
300
292
  {
301
293
  status: 400,
302
294
  description: `1: User not found.`,
303
- schema: z.void(),
304
295
  },
305
296
  {
306
297
  status: 401,
307
298
  description: `0: Authorization has been denied for this request.`,
308
- schema: z.void(),
309
299
  },
310
300
  ],
311
301
  });
312
302
  /**
313
- * @api post https://accountinformation.roblox.com/v1/gender
303
+ * @api POST https://accountinformation.roblox.com/v1/gender
304
+ * @summary Update the user's gender
314
305
  * @param body The Roblox.AccountInformation.Api.Models.GenderRequest
315
306
  */
316
307
  export const postGender = endpoint({
@@ -329,28 +320,25 @@ export const postGender = endpoint({
329
320
  status: 400,
330
321
  description: `1: User not found.
331
322
  6: The gender provided is invalid.`,
332
- schema: z.void(),
333
323
  },
334
324
  {
335
325
  status: 401,
336
326
  description: `0: Authorization has been denied for this request.`,
337
- schema: z.void(),
338
327
  },
339
328
  {
340
329
  status: 403,
341
330
  description: `0: Token Validation Failed
342
331
  2: PIN is locked.`,
343
- schema: z.void(),
344
332
  },
345
333
  {
346
334
  status: 500,
347
335
  description: `0: An unknown error occured.`,
348
- schema: z.void(),
349
336
  },
350
337
  ],
351
338
  });
352
339
  /**
353
- * @api get https://accountinformation.roblox.com/v1/metadata
340
+ * @api GET https://accountinformation.roblox.com/v1/metadata
341
+ * @summary Get the metadata
354
342
  */
355
343
  export const getMetadata = endpoint({
356
344
  method: 'get' as const,
@@ -361,7 +349,8 @@ export const getMetadata = endpoint({
361
349
  errors: [],
362
350
  });
363
351
  /**
364
- * @api get https://accountinformation.roblox.com/v1/phone
352
+ * @api GET https://accountinformation.roblox.com/v1/phone
353
+ * @summary Get Verified Phone Number
365
354
  */
366
355
  export const getPhone = endpoint({
367
356
  method: 'get' as const,
@@ -373,17 +362,16 @@ export const getPhone = endpoint({
373
362
  {
374
363
  status: 401,
375
364
  description: `0: Authorization has been denied for this request.`,
376
- schema: z.void(),
377
365
  },
378
366
  {
379
367
  status: 500,
380
368
  description: `0: An unknown error occured.`,
381
- schema: z.void(),
382
369
  },
383
370
  ],
384
371
  });
385
372
  /**
386
- * @api post https://accountinformation.roblox.com/v1/phone
373
+ * @api POST https://accountinformation.roblox.com/v1/phone
374
+ * @summary Set Phone Number
387
375
  * @param body Roblox.AccountInformation.Api.Models.PhoneRequest
388
376
  */
389
377
  export const postPhone = endpoint({
@@ -403,12 +391,10 @@ export const postPhone = endpoint({
403
391
  description: `2: Invalid Phone Number
404
392
  3: Phone Number Already Associated
405
393
  8: Invalid Phone Number Type`,
406
- schema: z.void(),
407
394
  },
408
395
  {
409
396
  status: 401,
410
397
  description: `0: Authorization has been denied for this request.`,
411
- schema: z.void(),
412
398
  },
413
399
  {
414
400
  status: 403,
@@ -416,27 +402,24 @@ export const postPhone = endpoint({
416
402
  4: Account Pin Locked
417
403
  5: Incorrect Password
418
404
  10: `,
419
- schema: z.void(),
420
405
  },
421
406
  {
422
407
  status: 429,
423
408
  description: `6: Flooded`,
424
- schema: z.void(),
425
409
  },
426
410
  {
427
411
  status: 500,
428
412
  description: `0: An unknown error occured.`,
429
- schema: z.void(),
430
413
  },
431
414
  {
432
415
  status: 503,
433
416
  description: `1: This feature is currently disabled. Please try again later.`,
434
- schema: z.void(),
435
417
  },
436
418
  ],
437
419
  });
438
420
  /**
439
- * @api post https://accountinformation.roblox.com/v1/phone/delete
421
+ * @api POST https://accountinformation.roblox.com/v1/phone/delete
422
+ * @summary Delete Phone
440
423
  * @param body Roblox.AccountInformation.Api.Models.PhoneRequest
441
424
  */
442
425
  export const postPhoneDelete = endpoint({
@@ -454,34 +437,30 @@ export const postPhoneDelete = endpoint({
454
437
  {
455
438
  status: 401,
456
439
  description: `0: Authorization has been denied for this request.`,
457
- schema: z.void(),
458
440
  },
459
441
  {
460
442
  status: 403,
461
443
  description: `0: Token Validation Failed
462
444
  4: Account Pin Locked
463
445
  5: Incorrect Password`,
464
- schema: z.void(),
465
446
  },
466
447
  {
467
448
  status: 429,
468
449
  description: `6: Flooded`,
469
- schema: z.void(),
470
450
  },
471
451
  {
472
452
  status: 500,
473
453
  description: `0: An unknown error occured.`,
474
- schema: z.void(),
475
454
  },
476
455
  {
477
456
  status: 503,
478
457
  description: `1: This feature is currently disabled. Please try again later.`,
479
- schema: z.void(),
480
458
  },
481
459
  ],
482
460
  });
483
461
  /**
484
- * @api post https://accountinformation.roblox.com/v1/phone/resend
462
+ * @api POST https://accountinformation.roblox.com/v1/phone/resend
463
+ * @summary Resend Phone code
485
464
  * @param body Roblox.AccountInformation.Api.Models.PhoneRequest
486
465
  */
487
466
  export const postPhoneResend = endpoint({
@@ -499,32 +478,28 @@ export const postPhoneResend = endpoint({
499
478
  {
500
479
  status: 401,
501
480
  description: `0: Authorization has been denied for this request.`,
502
- schema: z.void(),
503
481
  },
504
482
  {
505
483
  status: 403,
506
484
  description: `0: Token Validation Failed`,
507
- schema: z.void(),
508
485
  },
509
486
  {
510
487
  status: 429,
511
488
  description: `6: Flooded`,
512
- schema: z.void(),
513
489
  },
514
490
  {
515
491
  status: 500,
516
492
  description: `0: An unknown error occured.`,
517
- schema: z.void(),
518
493
  },
519
494
  {
520
495
  status: 503,
521
496
  description: `1: This feature is currently disabled. Please try again later.`,
522
- schema: z.void(),
523
497
  },
524
498
  ],
525
499
  });
526
500
  /**
527
- * @api post https://accountinformation.roblox.com/v1/phone/verify
501
+ * @api POST https://accountinformation.roblox.com/v1/phone/verify
502
+ * @summary Verify Phone
528
503
  * @param body Roblox.AccountInformation.Api.Models.VerifyPhoneRequest
529
504
  */
530
505
  export const postPhoneVerify = endpoint({
@@ -544,37 +519,32 @@ export const postPhoneVerify = endpoint({
544
519
  description: `2: Invalid Phone Number
545
520
  3: Phone Number Already Associated
546
521
  7: Invalid Code`,
547
- schema: z.void(),
548
522
  },
549
523
  {
550
524
  status: 401,
551
525
  description: `0: Authorization has been denied for this request.`,
552
- schema: z.void(),
553
526
  },
554
527
  {
555
528
  status: 403,
556
529
  description: `0: Token Validation Failed`,
557
- schema: z.void(),
558
530
  },
559
531
  {
560
532
  status: 429,
561
533
  description: `6: Flooded`,
562
- schema: z.void(),
563
534
  },
564
535
  {
565
536
  status: 500,
566
537
  description: `0: An unknown error occured.`,
567
- schema: z.void(),
568
538
  },
569
539
  {
570
540
  status: 503,
571
541
  description: `1: This feature is currently disabled. Please try again later.`,
572
- schema: z.void(),
573
542
  },
574
543
  ],
575
544
  });
576
545
  /**
577
- * @api get https://accountinformation.roblox.com/v1/promotion-channels
546
+ * @api GET https://accountinformation.roblox.com/v1/promotion-channels
547
+ * @summary Get the user's promotion channels
578
548
  */
579
549
  export const getPromotionChannels = endpoint({
580
550
  method: 'get' as const,
@@ -586,17 +556,16 @@ export const getPromotionChannels = endpoint({
586
556
  {
587
557
  status: 400,
588
558
  description: `1: User not found.`,
589
- schema: z.void(),
590
559
  },
591
560
  {
592
561
  status: 401,
593
562
  description: `0: Authorization has been denied for this request.`,
594
- schema: z.void(),
595
563
  },
596
564
  ],
597
565
  });
598
566
  /**
599
- * @api post https://accountinformation.roblox.com/v1/promotion-channels
567
+ * @api POST https://accountinformation.roblox.com/v1/promotion-channels
568
+ * @summary Update the user's promotion channels
600
569
  * @param body The Roblox.AccountInformation.Api.Models.PromotionChannelsRequest
601
570
  */
602
571
  export const postPromotionChannels = endpoint({
@@ -619,24 +588,22 @@ export const postPromotionChannels = endpoint({
619
588
  13: The YouTube url is invalid.
620
589
  14: The Twitch profile url is invalid.
621
590
  15: The Guilded profile url is invalid.`,
622
- schema: z.void(),
623
591
  },
624
592
  {
625
593
  status: 401,
626
594
  description: `0: Authorization has been denied for this request.`,
627
- schema: z.void(),
628
595
  },
629
596
  {
630
597
  status: 403,
631
598
  description: `0: Token Validation Failed
632
599
  3: PIN is locked.
633
600
  4: Only users who are over twelve years of age may edit social network channels.`,
634
- schema: z.void(),
635
601
  },
636
602
  ],
637
603
  });
638
604
  /**
639
- * @api get https://accountinformation.roblox.com/v1/star-code-affiliates
605
+ * @api GET https://accountinformation.roblox.com/v1/star-code-affiliates
606
+ * @summary Gets a star code affiliate supporter for the authenticated user
640
607
  */
641
608
  export const getStarCodeAffiliates = endpoint({
642
609
  method: 'get' as const,
@@ -648,17 +615,16 @@ export const getStarCodeAffiliates = endpoint({
648
615
  {
649
616
  status: 401,
650
617
  description: `0: Authorization has been denied for this request.`,
651
- schema: z.void(),
652
618
  },
653
619
  {
654
620
  status: 500,
655
621
  description: `0: An unknown error occured.`,
656
- schema: z.void(),
657
622
  },
658
623
  ],
659
624
  });
660
625
  /**
661
- * @api post https://accountinformation.roblox.com/v1/star-code-affiliates
626
+ * @api POST https://accountinformation.roblox.com/v1/star-code-affiliates
627
+ * @summary Adds a star code affiliate supporter for the authenticated user
662
628
  * @param body Roblox.AccountInformation.Api.Models.StarCodeAffiliateRequest
663
629
  */
664
630
  export const postStarCodeAffiliates = endpoint({
@@ -676,27 +642,24 @@ export const postStarCodeAffiliates = endpoint({
676
642
  {
677
643
  status: 400,
678
644
  description: `1: The code was invalid.`,
679
- schema: z.void(),
680
645
  },
681
646
  {
682
647
  status: 401,
683
648
  description: `0: Authorization has been denied for this request.`,
684
- schema: z.void(),
685
649
  },
686
650
  {
687
651
  status: 403,
688
652
  description: `0: Token Validation Failed`,
689
- schema: z.void(),
690
653
  },
691
654
  {
692
655
  status: 500,
693
656
  description: `0: An unknown error occured.`,
694
- schema: z.void(),
695
657
  },
696
658
  ],
697
659
  });
698
660
  /**
699
- * @api delete https://accountinformation.roblox.com/v1/star-code-affiliates
661
+ * @api DELETE https://accountinformation.roblox.com/v1/star-code-affiliates
662
+ * @summary Removes the star code affiliate supporter for the authenticated user
700
663
  */
701
664
  export const deleteStarCodeAffiliates = endpoint({
702
665
  method: 'delete' as const,
@@ -708,22 +671,20 @@ export const deleteStarCodeAffiliates = endpoint({
708
671
  {
709
672
  status: 401,
710
673
  description: `0: Authorization has been denied for this request.`,
711
- schema: z.void(),
712
674
  },
713
675
  {
714
676
  status: 403,
715
677
  description: `0: Token Validation Failed`,
716
- schema: z.void(),
717
678
  },
718
679
  {
719
680
  status: 500,
720
681
  description: `0: An unknown error occured.`,
721
- schema: z.void(),
722
682
  },
723
683
  ],
724
684
  });
725
685
  /**
726
- * @api get https://accountinformation.roblox.com/v1/users/:userId/promotion-channels
686
+ * @api GET https://accountinformation.roblox.com/v1/users/:userId/promotion-channels
687
+ * @summary Get promotion channels for a given user ID
727
688
  * @param userId
728
689
  */
729
690
  export const getUsersUseridPromotionChannels = endpoint({
@@ -744,12 +705,12 @@ export const getUsersUseridPromotionChannels = endpoint({
744
705
  {
745
706
  status: 400,
746
707
  description: `1: User not found.`,
747
- schema: z.void(),
748
708
  },
749
709
  ],
750
710
  });
751
711
  /**
752
- * @api get https://accountinformation.roblox.com/v1/users/:userId/roblox-badges
712
+ * @api GET https://accountinformation.roblox.com/v1/users/:userId/roblox-badges
713
+ * @summary Returns a list of Roblox badges belonging to a user.
753
714
  * @param userId
754
715
  */
755
716
  export const getUsersUseridRobloxBadges = endpoint({
@@ -769,7 +730,8 @@ export const getUsersUseridRobloxBadges = endpoint({
769
730
  errors: [],
770
731
  });
771
732
  /**
772
- * @api get https://accountinformation.roblox.com/v1/xbox-live/consecutive-login-days
733
+ * @api GET https://accountinformation.roblox.com/v1/xbox-live/consecutive-login-days
734
+ * @summary Returns number of consecutive login days for xbox users
773
735
  */
774
736
  export const getXboxLiveConsecutiveLoginDays = endpoint({
775
737
  method: 'get' as const,
@@ -782,7 +744,6 @@ export const getXboxLiveConsecutiveLoginDays = endpoint({
782
744
  status: 401,
783
745
  description: `0: Authorization has been denied for this request.
784
746
  7: The account is not connected to an Xbox Live account`,
785
- schema: z.void(),
786
747
  },
787
748
  ],
788
749
  });
@@ -34,7 +34,6 @@ const Roblox_AccountInformation_Api_Models_MetadataResponse = zod_1.z
34
34
  isPasswordRequiredForAgingDown: zod_1.z.boolean(),
35
35
  shouldUsePersonaForIdVerification: zod_1.z.boolean(),
36
36
  shouldDisplaySessionManagement: zod_1.z.boolean(),
37
- shouldUseSecurityReactUI: zod_1.z.boolean(),
38
37
  })
39
38
  .passthrough();
40
39
  const Roblox_AccountInformation_Api_Models_PhoneResponse = zod_1.z