@jacobhumston/roblox-openapi-ts 1.0.36 → 1.0.37
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.
- package/dist/types.d.ts +634 -0
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -22102,6 +22102,69 @@ export interface paths {
|
|
|
22102
22102
|
patch?: never;
|
|
22103
22103
|
trace?: never;
|
|
22104
22104
|
};
|
|
22105
|
+
"/v1/groups/{groupId}/community-tier/evaluate": {
|
|
22106
|
+
parameters: {
|
|
22107
|
+
query?: never;
|
|
22108
|
+
header?: never;
|
|
22109
|
+
path?: never;
|
|
22110
|
+
cookie?: never;
|
|
22111
|
+
};
|
|
22112
|
+
get?: never;
|
|
22113
|
+
put?: never;
|
|
22114
|
+
post: {
|
|
22115
|
+
parameters: {
|
|
22116
|
+
query?: never;
|
|
22117
|
+
header?: never;
|
|
22118
|
+
path: {
|
|
22119
|
+
groupId: number;
|
|
22120
|
+
};
|
|
22121
|
+
cookie?: never;
|
|
22122
|
+
};
|
|
22123
|
+
requestBody?: never;
|
|
22124
|
+
responses: {
|
|
22125
|
+
/** @description OK */
|
|
22126
|
+
200: {
|
|
22127
|
+
headers: {
|
|
22128
|
+
[name: string]: unknown;
|
|
22129
|
+
};
|
|
22130
|
+
content: {
|
|
22131
|
+
"application/json": components["schemas"]["Roblox.Groups.Client.TierEvaluationResultResponse"];
|
|
22132
|
+
};
|
|
22133
|
+
};
|
|
22134
|
+
/** @description 1: Group is invalid or does not exist. */
|
|
22135
|
+
400: {
|
|
22136
|
+
headers: {
|
|
22137
|
+
[name: string]: unknown;
|
|
22138
|
+
};
|
|
22139
|
+
content?: never;
|
|
22140
|
+
};
|
|
22141
|
+
/** @description 0: Authorization has been denied for this request. */
|
|
22142
|
+
401: {
|
|
22143
|
+
headers: {
|
|
22144
|
+
[name: string]: unknown;
|
|
22145
|
+
};
|
|
22146
|
+
content?: never;
|
|
22147
|
+
};
|
|
22148
|
+
/**
|
|
22149
|
+
* @description 0: Token Validation Failed
|
|
22150
|
+
* 22: The feature is disabled.
|
|
22151
|
+
* 23: Insufficient permissions to complete the request.
|
|
22152
|
+
* 49: User is invalid or does not exist
|
|
22153
|
+
*/
|
|
22154
|
+
403: {
|
|
22155
|
+
headers: {
|
|
22156
|
+
[name: string]: unknown;
|
|
22157
|
+
};
|
|
22158
|
+
content?: never;
|
|
22159
|
+
};
|
|
22160
|
+
};
|
|
22161
|
+
};
|
|
22162
|
+
delete?: never;
|
|
22163
|
+
options?: never;
|
|
22164
|
+
head?: never;
|
|
22165
|
+
patch?: never;
|
|
22166
|
+
trace?: never;
|
|
22167
|
+
};
|
|
22105
22168
|
"/v1/groups/{groupId}/configuration": {
|
|
22106
22169
|
parameters: {
|
|
22107
22170
|
query?: never;
|
|
@@ -31907,6 +31970,7 @@ export interface paths {
|
|
|
31907
31970
|
* @description 1: The universe does not exist.
|
|
31908
31971
|
* 48: The playtesters list is missing or empty.
|
|
31909
31972
|
* 49: Too many playtesters were specified in a single request.
|
|
31973
|
+
* 51: One or more playtesters cannot be added due to safety restrictions.
|
|
31910
31974
|
*/
|
|
31911
31975
|
400: {
|
|
31912
31976
|
headers: {
|
|
@@ -43450,6 +43514,57 @@ export interface paths {
|
|
|
43450
43514
|
patch?: never;
|
|
43451
43515
|
trace?: never;
|
|
43452
43516
|
};
|
|
43517
|
+
"/virtual-events/v3/game-events/{eventId}": {
|
|
43518
|
+
parameters: {
|
|
43519
|
+
query?: never;
|
|
43520
|
+
header?: never;
|
|
43521
|
+
path?: never;
|
|
43522
|
+
cookie?: never;
|
|
43523
|
+
};
|
|
43524
|
+
/**
|
|
43525
|
+
* Get a single game event by ID.
|
|
43526
|
+
* Use `?fields=` to request a subset of fields; unknown field names return 400.
|
|
43527
|
+
*/
|
|
43528
|
+
get: operations["GameEvent_Get"];
|
|
43529
|
+
put?: never;
|
|
43530
|
+
post?: never;
|
|
43531
|
+
/**
|
|
43532
|
+
* Permanently delete an existing game event. Returns 204 No Content on success.
|
|
43533
|
+
* Permission is enforced via an explicit pre-check: callers that can read but not edit
|
|
43534
|
+
* receive 403; callers that cannot read receive 404.
|
|
43535
|
+
*/
|
|
43536
|
+
delete: operations["GameEvent_Delete"];
|
|
43537
|
+
options?: never;
|
|
43538
|
+
head?: never;
|
|
43539
|
+
/**
|
|
43540
|
+
* Partially update a game event. Only fields present in the request body are changed; omitted or null fields are left
|
|
43541
|
+
* unchanged. Empty body is a no-op and returns the current game event resource.
|
|
43542
|
+
*/
|
|
43543
|
+
patch: operations["GameEvent_Update"];
|
|
43544
|
+
trace?: never;
|
|
43545
|
+
};
|
|
43546
|
+
"/virtual-events/v3/universes/{universeId}/game-events": {
|
|
43547
|
+
parameters: {
|
|
43548
|
+
query?: never;
|
|
43549
|
+
header?: never;
|
|
43550
|
+
path?: never;
|
|
43551
|
+
cookie?: never;
|
|
43552
|
+
};
|
|
43553
|
+
/**
|
|
43554
|
+
* List game events under a universe.
|
|
43555
|
+
* Use `?fields=` to trim the response payload.
|
|
43556
|
+
* Response is always 200 (empty list for unknown universe).
|
|
43557
|
+
*/
|
|
43558
|
+
get: operations["GameEvents_List"];
|
|
43559
|
+
put?: never;
|
|
43560
|
+
/** Create a new game event. Returns the full resource on success. */
|
|
43561
|
+
post: operations["GameEvents_Create"];
|
|
43562
|
+
delete?: never;
|
|
43563
|
+
options?: never;
|
|
43564
|
+
head?: never;
|
|
43565
|
+
patch?: never;
|
|
43566
|
+
trace?: never;
|
|
43567
|
+
};
|
|
43453
43568
|
}
|
|
43454
43569
|
export type webhooks = Record<string, never>;
|
|
43455
43570
|
export interface components {
|
|
@@ -43823,6 +43938,17 @@ export interface components {
|
|
|
43823
43938
|
doesOwnerPrivacyRestrictJoins?: boolean;
|
|
43824
43939
|
inviteResponseType?: components["schemas"]["PrivateServerInviteResponseType"];
|
|
43825
43940
|
};
|
|
43941
|
+
CategoryResponse: {
|
|
43942
|
+
/**
|
|
43943
|
+
* @description The event category type of an event.
|
|
43944
|
+
*
|
|
43945
|
+
* Mirror of:
|
|
43946
|
+
* https://github.rbx.com/Roblox/virtual-events/blob/master/services/virtual-events/src/Implementations/Types/EventCategory.cs
|
|
43947
|
+
*/
|
|
43948
|
+
category?: components["schemas"]["EventCategory"];
|
|
43949
|
+
/** Format: int32 */
|
|
43950
|
+
rank?: number;
|
|
43951
|
+
};
|
|
43826
43952
|
/** @description Get Client Status request. */
|
|
43827
43953
|
ClientStatusGetRequest: {
|
|
43828
43954
|
/**
|
|
@@ -43916,6 +44042,17 @@ export interface components {
|
|
|
43916
44042
|
/** @description Conditional RPN rules and evaluation order, when any exist. */
|
|
43917
44043
|
conditionalRules?: components["schemas"]["ConditionalRulesPayload"] | null;
|
|
43918
44044
|
};
|
|
44045
|
+
ConfigResponse: {
|
|
44046
|
+
/** @description Cron expression defining the event's recurrence schedule, if any. */
|
|
44047
|
+
recurrence?: string | null;
|
|
44048
|
+
/**
|
|
44049
|
+
* Format: date-time
|
|
44050
|
+
* @description The latest UTC timestamp at which automatic recurrence scheduling can occur.
|
|
44051
|
+
*/
|
|
44052
|
+
recurrenceEndTime?: string | null;
|
|
44053
|
+
/** @description The audience that should receive notifications for this event. */
|
|
44054
|
+
notificationAudience?: components["schemas"]["EventNotificationAudience"];
|
|
44055
|
+
};
|
|
43919
44056
|
/** @description A full representation of a configuration value, including its metadata. */
|
|
43920
44057
|
ConfigValueFull: {
|
|
43921
44058
|
/** @description Non-default branches (e.g. conditional), when present. */
|
|
@@ -43996,6 +44133,62 @@ export interface components {
|
|
|
43996
44133
|
*/
|
|
43997
44134
|
value: number;
|
|
43998
44135
|
};
|
|
44136
|
+
/** @description Optional event configuration block (recurrence + notification audience) on the v3 Create body. */
|
|
44137
|
+
CreateGameEventConfigRequest: {
|
|
44138
|
+
/** @description Cron expression for recurrence. Null = no recurrence. Validated server-side. */
|
|
44139
|
+
recurrence?: string | null;
|
|
44140
|
+
/** Format: date-time */
|
|
44141
|
+
recurrenceEndTime?: string | null;
|
|
44142
|
+
notificationAudience?: components["schemas"]["EventNotificationAudience"] | null;
|
|
44143
|
+
};
|
|
44144
|
+
/**
|
|
44145
|
+
* @description Request body for `POST /v3/universes/{universeId}/game-events`.
|
|
44146
|
+
* `universeId` comes from the URL path, not the body.
|
|
44147
|
+
* VirtualEventsApi.Models.V3.Request.CreateGameEventRequest.Visibility is restricted to Public/Private — Moderated is server-side only.
|
|
44148
|
+
* Nullable CLR properties allow JSON binding to materialize incomplete requests; required
|
|
44149
|
+
* fields are enforced by the virtual-events gRPC service when `CreateVirtualEvent` runs.
|
|
44150
|
+
*/
|
|
44151
|
+
CreateGameEventRequest: {
|
|
44152
|
+
/** @description Event title. Clients must provide a non-empty value. */
|
|
44153
|
+
title?: string | null;
|
|
44154
|
+
/** @description Event subtitle. Clients must provide a non-empty value. */
|
|
44155
|
+
subtitle?: string | null;
|
|
44156
|
+
/** @description Optional event description. */
|
|
44157
|
+
description?: string | null;
|
|
44158
|
+
/**
|
|
44159
|
+
* Format: date-time
|
|
44160
|
+
* @description Event start time. Clients must provide a timestamp such as
|
|
44161
|
+
* `yyyy-MM-ddTHH:mm:ss.fffzzz` or `yyyy-MM-ddTHH:mm:ss.fffZ`.
|
|
44162
|
+
*/
|
|
44163
|
+
startTime?: string | null;
|
|
44164
|
+
/**
|
|
44165
|
+
* Format: date-time
|
|
44166
|
+
* @description Event end time. Clients must provide a timestamp such as
|
|
44167
|
+
* `yyyy-MM-ddTHH:mm:ss.fffzzz` or `yyyy-MM-ddTHH:mm:ss.fffZ`, and it must be after
|
|
44168
|
+
* VirtualEventsApi.Models.V3.Request.CreateGameEventRequest.StartTime.
|
|
44169
|
+
*/
|
|
44170
|
+
endTime?: string | null;
|
|
44171
|
+
/** @description Must be `Public` or `Private`; `Moderated` is server-managed and rejected. */
|
|
44172
|
+
visibility?: components["schemas"]["EventVisibility"] | null;
|
|
44173
|
+
/**
|
|
44174
|
+
* Format: int64
|
|
44175
|
+
* @description Group host. When omitted, the authenticated user is the host.
|
|
44176
|
+
*/
|
|
44177
|
+
groupId?: number | null;
|
|
44178
|
+
/**
|
|
44179
|
+
* Format: int64
|
|
44180
|
+
* @description Optional venue place ID. When omitted, the event is created in the universe root place.
|
|
44181
|
+
*/
|
|
44182
|
+
placeId?: number | null;
|
|
44183
|
+
categories?: components["schemas"]["EventRankedCategory"][] | null;
|
|
44184
|
+
thumbnails?: components["schemas"]["EventMedia"][] | null;
|
|
44185
|
+
/** @description Optional event configuration block (recurrence + notification audience) on the v3 Create body. */
|
|
44186
|
+
config?: components["schemas"]["CreateGameEventConfigRequest"] | null;
|
|
44187
|
+
/** @description Optional featuring status flag. When omitted, defaults to "not featured". */
|
|
44188
|
+
featuringStatus?: components["schemas"]["FeaturingStatus"] | null;
|
|
44189
|
+
/** @description Optional tagline. Length and content are validated server-side. */
|
|
44190
|
+
tagline?: string | null;
|
|
44191
|
+
};
|
|
43999
44192
|
/** @description Request to create a new MatchmakingPlayerAttributeDefinition. */
|
|
44000
44193
|
CreateMatchmakingPlayerAttributeDefinitionRequest: {
|
|
44001
44194
|
/**
|
|
@@ -44714,6 +44907,52 @@ export interface components {
|
|
|
44714
44907
|
/** @description A hint as to what caused the error, if applicable. */
|
|
44715
44908
|
hint?: string | null;
|
|
44716
44909
|
};
|
|
44910
|
+
/**
|
|
44911
|
+
* @description The event category type of an event.
|
|
44912
|
+
*
|
|
44913
|
+
* Mirror of:
|
|
44914
|
+
* https://github.rbx.com/Roblox/virtual-events/blob/master/services/virtual-events/src/Implementations/Types/EventCategory.cs
|
|
44915
|
+
* @enum {string}
|
|
44916
|
+
*/
|
|
44917
|
+
EventCategory: "contentUpdate" | "locationUpdate" | "systemUpdate" | "activity" | "newContent" | "itemDrop" | "newSeason" | "newLocation" | "newMap" | "moreLevels" | "newFeature" | "earlyAccess" | "expansion" | "challenge" | "quest" | "festival";
|
|
44918
|
+
/** @description Representation of some media associated with an event. */
|
|
44919
|
+
EventMedia: {
|
|
44920
|
+
/**
|
|
44921
|
+
* Format: int64
|
|
44922
|
+
* @description The ID of the media.
|
|
44923
|
+
*/
|
|
44924
|
+
mediaId?: number;
|
|
44925
|
+
/**
|
|
44926
|
+
* Format: int32
|
|
44927
|
+
* @description The rank of the media.
|
|
44928
|
+
*/
|
|
44929
|
+
rank?: number;
|
|
44930
|
+
};
|
|
44931
|
+
/**
|
|
44932
|
+
* @description The notification audience for an experience event
|
|
44933
|
+
* @enum {string}
|
|
44934
|
+
*/
|
|
44935
|
+
EventNotificationAudience: "all" | "rsvp" | "subscribed" | "group" | "none";
|
|
44936
|
+
/** @description Representation of the category associated with an event. */
|
|
44937
|
+
EventRankedCategory: {
|
|
44938
|
+
/** @description The category content. */
|
|
44939
|
+
category?: components["schemas"]["EventCategory"];
|
|
44940
|
+
/**
|
|
44941
|
+
* Format: int32
|
|
44942
|
+
* @description The rank of the category.
|
|
44943
|
+
*/
|
|
44944
|
+
rank?: number;
|
|
44945
|
+
};
|
|
44946
|
+
/**
|
|
44947
|
+
* @description The visibility of a virtual event.
|
|
44948
|
+
* @enum {string}
|
|
44949
|
+
*/
|
|
44950
|
+
EventVisibility: "private" | "public" | "moderated";
|
|
44951
|
+
/**
|
|
44952
|
+
* @description The featuring status of a virtual event.
|
|
44953
|
+
* @enum {string}
|
|
44954
|
+
*/
|
|
44955
|
+
FeaturingStatus: "invalid" | "enabled" | "disabled";
|
|
44717
44956
|
/**
|
|
44718
44957
|
* @description Enum describing the different available filter fields.
|
|
44719
44958
|
* @enum {string}
|
|
@@ -44781,6 +45020,48 @@ export interface components {
|
|
|
44781
45020
|
ForecastUpdateResponse: {
|
|
44782
45021
|
placeSummaries?: components["schemas"]["PlaceSummaryForGameUpdate"][] | null;
|
|
44783
45022
|
};
|
|
45023
|
+
/** @description v3 game event response. All fields except VirtualEventsApi.Models.V3.Response.GameEventResponse.Id are gated by the `?fields=` mask. */
|
|
45024
|
+
GameEventResponse: {
|
|
45025
|
+
/**
|
|
45026
|
+
* @description The unique id of the game event. Always populated. Serialized as a string to
|
|
45027
|
+
* preserve precision for clients (event IDs exceed 2^53).
|
|
45028
|
+
*/
|
|
45029
|
+
id?: string | null;
|
|
45030
|
+
title?: string | null;
|
|
45031
|
+
/** @description Localized title (caller's locale). Populated only when `displayTitle` is in the mask. */
|
|
45032
|
+
displayTitle?: string | null;
|
|
45033
|
+
subtitle?: string | null;
|
|
45034
|
+
/** @description Localized subtitle. Populated only when `displaySubtitle` is in the mask. */
|
|
45035
|
+
displaySubtitle?: string | null;
|
|
45036
|
+
description?: string | null;
|
|
45037
|
+
/** @description Localized description. Populated only when `displayDescription` is in the mask. */
|
|
45038
|
+
displayDescription?: string | null;
|
|
45039
|
+
/** Format: date-time */
|
|
45040
|
+
startTime?: string | null;
|
|
45041
|
+
/** Format: date-time */
|
|
45042
|
+
endTime?: string | null;
|
|
45043
|
+
/** Format: int64 */
|
|
45044
|
+
universeId?: number | null;
|
|
45045
|
+
/** Format: int64 */
|
|
45046
|
+
placeId?: number | null;
|
|
45047
|
+
/** @description Host block. VirtualEventsApi.Models.V3.Response.HostResponse.HostName and VirtualEventsApi.Models.V3.Response.HostResponse.HasVerifiedBadge are omitted when host-details resolution failed. */
|
|
45048
|
+
host?: components["schemas"]["HostResponse"] | null;
|
|
45049
|
+
visibility?: components["schemas"]["EventVisibility"] | null;
|
|
45050
|
+
featuringStatus?: components["schemas"]["FeaturingStatus"] | null;
|
|
45051
|
+
/** @description Tagline for featuring review; visible to curators only when featuring is opted into. */
|
|
45052
|
+
tagline?: string | null;
|
|
45053
|
+
categories?: components["schemas"]["CategoryResponse"][] | null;
|
|
45054
|
+
thumbnails?: components["schemas"]["ThumbnailResponse"][] | null;
|
|
45055
|
+
/** @description Whether all requested thumbnails were successfully persisted. Returned on Create/Update. */
|
|
45056
|
+
allThumbnailsCreated?: boolean | null;
|
|
45057
|
+
config?: components["schemas"]["ConfigResponse"] | null;
|
|
45058
|
+
/** @description Authenticated caller's RSVP status. Omitted for unauthenticated callers. */
|
|
45059
|
+
userRsvpStatus?: components["schemas"]["RsvpStatus"] | null;
|
|
45060
|
+
/** Format: date-time */
|
|
45061
|
+
createTime?: string | null;
|
|
45062
|
+
/** Format: date-time */
|
|
45063
|
+
updateTime?: string | null;
|
|
45064
|
+
};
|
|
44784
45065
|
/** @description Creator-facing representation of a game pass configuration. */
|
|
44785
45066
|
GamePassConfigV2: {
|
|
44786
45067
|
/**
|
|
@@ -45588,6 +45869,20 @@ export interface components {
|
|
|
45588
45869
|
};
|
|
45589
45870
|
/** @enum {string} */
|
|
45590
45871
|
HomepageThumbnailStatus: "Active" | "Spammy";
|
|
45872
|
+
/** @description Host block. VirtualEventsApi.Models.V3.Response.HostResponse.HostName and VirtualEventsApi.Models.V3.Response.HostResponse.HasVerifiedBadge are omitted when host-details resolution failed. */
|
|
45873
|
+
HostResponse: {
|
|
45874
|
+
/** @description The type of host of a virtual event. */
|
|
45875
|
+
hostType?: components["schemas"]["HostType"];
|
|
45876
|
+
/** Format: int64 */
|
|
45877
|
+
hostId?: number;
|
|
45878
|
+
hostName?: string | null;
|
|
45879
|
+
hasVerifiedBadge?: boolean | null;
|
|
45880
|
+
};
|
|
45881
|
+
/**
|
|
45882
|
+
* @description The type of host of a virtual event.
|
|
45883
|
+
* @enum {string}
|
|
45884
|
+
*/
|
|
45885
|
+
HostType: "user" | "group";
|
|
45591
45886
|
HttpContent: {
|
|
45592
45887
|
readonly headers?: components["schemas"]["StringStringIEnumerableKeyValuePair"][] | null;
|
|
45593
45888
|
};
|
|
@@ -47217,6 +47512,12 @@ export interface components {
|
|
|
47217
47512
|
/** @description The name of the entry. */
|
|
47218
47513
|
readonly id?: string;
|
|
47219
47514
|
};
|
|
47515
|
+
/** @description Paginated response for v3 LIST. Page tokens are null at the collection boundaries. */
|
|
47516
|
+
PaginatedGameEventsResponse: {
|
|
47517
|
+
gameEvents?: components["schemas"]["GameEventResponse"][] | null;
|
|
47518
|
+
nextPageToken?: string | null;
|
|
47519
|
+
previousPageToken?: string | null;
|
|
47520
|
+
};
|
|
47220
47521
|
/** @enum {string} */
|
|
47221
47522
|
PersonalizedConfigStatus: "Active" | "Inactive";
|
|
47222
47523
|
/** @description Represents a Roblox place. */
|
|
@@ -53808,6 +54109,10 @@ export interface components {
|
|
|
53808
54109
|
contentType?: string;
|
|
53809
54110
|
contentId?: string;
|
|
53810
54111
|
};
|
|
54112
|
+
"Roblox.Groups.Client.TierEvaluationResultResponse": {
|
|
54113
|
+
tierInfo?: components["schemas"]["Roblox.Groups.Client.CommunityTierInfoResponse"];
|
|
54114
|
+
passedSignals?: string[];
|
|
54115
|
+
};
|
|
53811
54116
|
"Roblox.InGameContentTables.Client.GameLocation": {
|
|
53812
54117
|
path?: string;
|
|
53813
54118
|
};
|
|
@@ -56239,6 +56544,11 @@ export interface components {
|
|
|
56239
56544
|
/** @description RPN operand: attribute reference or literal value (same concepts as the proto `RpnOperand` oneof). */
|
|
56240
56545
|
operand?: components["schemas"]["RpnOperandDto"] | null;
|
|
56241
56546
|
};
|
|
56547
|
+
/**
|
|
56548
|
+
* @description The type of RSVP statuses.
|
|
56549
|
+
* @enum {string}
|
|
56550
|
+
*/
|
|
56551
|
+
RsvpStatus: "none" | "going" | "maybeGoing" | "notGoing";
|
|
56242
56552
|
RuleDeltaPayload: {
|
|
56243
56553
|
before?: unknown;
|
|
56244
56554
|
after?: unknown;
|
|
@@ -56861,6 +57171,12 @@ export interface components {
|
|
|
56861
57171
|
};
|
|
56862
57172
|
/** @enum {string} */
|
|
56863
57173
|
"ThumbnailPersonalizationApi.ModerationStatus": "Reviewing" | "Rejected" | "Approved" | "Unspecified";
|
|
57174
|
+
ThumbnailResponse: {
|
|
57175
|
+
/** Format: int64 */
|
|
57176
|
+
mediaId?: number;
|
|
57177
|
+
/** Format: int32 */
|
|
57178
|
+
rank?: number;
|
|
57179
|
+
};
|
|
56864
57180
|
/** @description Representation of an asset. */
|
|
56865
57181
|
"ToolboxService.Asset": {
|
|
56866
57182
|
/**
|
|
@@ -57352,6 +57668,37 @@ export interface components {
|
|
|
57352
57668
|
*/
|
|
57353
57669
|
value: number;
|
|
57354
57670
|
};
|
|
57671
|
+
/** @description Optional config block on the v3 PATCH body. Null sub-fields = no change. */
|
|
57672
|
+
UpdateGameEventConfigRequest: {
|
|
57673
|
+
/** @description New cron recurrence expression. Null = no change. Validated server-side. */
|
|
57674
|
+
recurrence?: string | null;
|
|
57675
|
+
/** Format: date-time */
|
|
57676
|
+
recurrenceEndTime?: string | null;
|
|
57677
|
+
notificationAudience?: components["schemas"]["EventNotificationAudience"] | null;
|
|
57678
|
+
};
|
|
57679
|
+
/**
|
|
57680
|
+
* @description Request body for `PATCH /v3/game-events/{eventId}`.
|
|
57681
|
+
* Every field is optional; null = "no change". An empty body is a no-op and returns the current resource.
|
|
57682
|
+
*/
|
|
57683
|
+
UpdateGameEventRequest: {
|
|
57684
|
+
title?: string | null;
|
|
57685
|
+
subtitle?: string | null;
|
|
57686
|
+
description?: string | null;
|
|
57687
|
+
/** Format: date-time */
|
|
57688
|
+
startTime?: string | null;
|
|
57689
|
+
/** Format: date-time */
|
|
57690
|
+
endTime?: string | null;
|
|
57691
|
+
/** @description Must be `Public` or `Private`; other values are rejected. Null = no change. */
|
|
57692
|
+
visibility?: components["schemas"]["EventVisibility"] | null;
|
|
57693
|
+
/** Format: int64 */
|
|
57694
|
+
placeId?: number | null;
|
|
57695
|
+
categories?: components["schemas"]["EventRankedCategory"][] | null;
|
|
57696
|
+
thumbnails?: components["schemas"]["EventMedia"][] | null;
|
|
57697
|
+
/** @description Optional config block on the v3 PATCH body. Null sub-fields = no change. */
|
|
57698
|
+
config?: components["schemas"]["UpdateGameEventConfigRequest"] | null;
|
|
57699
|
+
featuringStatus?: components["schemas"]["FeaturingStatus"] | null;
|
|
57700
|
+
tagline?: string | null;
|
|
57701
|
+
};
|
|
57355
57702
|
/**
|
|
57356
57703
|
* @description Represents metadata about the long-running operation corresponding to a
|
|
57357
57704
|
* UpdateInstance request.
|
|
@@ -57856,6 +58203,16 @@ export interface components {
|
|
|
57856
58203
|
displayName?: string | null;
|
|
57857
58204
|
hasVerifiedBadge?: boolean;
|
|
57858
58205
|
};
|
|
58206
|
+
"VirtualEventsApi.ProblemDetails": {
|
|
58207
|
+
type?: string | null;
|
|
58208
|
+
title?: string | null;
|
|
58209
|
+
/** Format: int32 */
|
|
58210
|
+
status?: number | null;
|
|
58211
|
+
detail?: string | null;
|
|
58212
|
+
instance?: string | null;
|
|
58213
|
+
} & {
|
|
58214
|
+
[key: string]: unknown;
|
|
58215
|
+
};
|
|
57859
58216
|
/** @description model for voting. */
|
|
57860
58217
|
VotingModel: {
|
|
57861
58218
|
/** @description Gets or sets show votes. */
|
|
@@ -65942,4 +66299,281 @@ export interface operations {
|
|
|
65942
66299
|
};
|
|
65943
66300
|
};
|
|
65944
66301
|
};
|
|
66302
|
+
GameEvent_Get: {
|
|
66303
|
+
parameters: {
|
|
66304
|
+
query?: {
|
|
66305
|
+
/** @description Optional field mask (comma-separated; omit or use * for all fields). */
|
|
66306
|
+
fields?: string;
|
|
66307
|
+
};
|
|
66308
|
+
header?: never;
|
|
66309
|
+
path: {
|
|
66310
|
+
/** @description Game event ID (from path). */
|
|
66311
|
+
eventId: number;
|
|
66312
|
+
};
|
|
66313
|
+
cookie?: never;
|
|
66314
|
+
};
|
|
66315
|
+
requestBody?: never;
|
|
66316
|
+
responses: {
|
|
66317
|
+
/** @description The requested game event. */
|
|
66318
|
+
200: {
|
|
66319
|
+
headers: {
|
|
66320
|
+
[name: string]: unknown;
|
|
66321
|
+
};
|
|
66322
|
+
content: {
|
|
66323
|
+
"application/json": components["schemas"]["GameEventResponse"];
|
|
66324
|
+
};
|
|
66325
|
+
};
|
|
66326
|
+
/** @description Malformed `?fields=` or invalid event ID. */
|
|
66327
|
+
400: {
|
|
66328
|
+
headers: {
|
|
66329
|
+
[name: string]: unknown;
|
|
66330
|
+
};
|
|
66331
|
+
content: {
|
|
66332
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66333
|
+
};
|
|
66334
|
+
};
|
|
66335
|
+
/** @description Event does not exist. */
|
|
66336
|
+
404: {
|
|
66337
|
+
headers: {
|
|
66338
|
+
[name: string]: unknown;
|
|
66339
|
+
};
|
|
66340
|
+
content: {
|
|
66341
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66342
|
+
};
|
|
66343
|
+
};
|
|
66344
|
+
};
|
|
66345
|
+
};
|
|
66346
|
+
GameEvent_Delete: {
|
|
66347
|
+
parameters: {
|
|
66348
|
+
query?: never;
|
|
66349
|
+
header?: never;
|
|
66350
|
+
path: {
|
|
66351
|
+
/** @description Game event ID to delete (from path). */
|
|
66352
|
+
eventId: number;
|
|
66353
|
+
};
|
|
66354
|
+
cookie?: never;
|
|
66355
|
+
};
|
|
66356
|
+
requestBody?: never;
|
|
66357
|
+
responses: {
|
|
66358
|
+
/** @description The event was deleted. */
|
|
66359
|
+
204: {
|
|
66360
|
+
headers: {
|
|
66361
|
+
[name: string]: unknown;
|
|
66362
|
+
};
|
|
66363
|
+
content?: never;
|
|
66364
|
+
};
|
|
66365
|
+
/** @description Caller is not authenticated. */
|
|
66366
|
+
401: {
|
|
66367
|
+
headers: {
|
|
66368
|
+
[name: string]: unknown;
|
|
66369
|
+
};
|
|
66370
|
+
content: {
|
|
66371
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66372
|
+
};
|
|
66373
|
+
};
|
|
66374
|
+
/** @description Caller can read the event but lacks delete permission. */
|
|
66375
|
+
403: {
|
|
66376
|
+
headers: {
|
|
66377
|
+
[name: string]: unknown;
|
|
66378
|
+
};
|
|
66379
|
+
content: {
|
|
66380
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66381
|
+
};
|
|
66382
|
+
};
|
|
66383
|
+
/** @description Event does not exist or caller cannot see it. */
|
|
66384
|
+
404: {
|
|
66385
|
+
headers: {
|
|
66386
|
+
[name: string]: unknown;
|
|
66387
|
+
};
|
|
66388
|
+
content: {
|
|
66389
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66390
|
+
};
|
|
66391
|
+
};
|
|
66392
|
+
/** @description The backend rejected the delete after the permission pre-check passed. */
|
|
66393
|
+
500: {
|
|
66394
|
+
headers: {
|
|
66395
|
+
[name: string]: unknown;
|
|
66396
|
+
};
|
|
66397
|
+
content: {
|
|
66398
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66399
|
+
};
|
|
66400
|
+
};
|
|
66401
|
+
};
|
|
66402
|
+
};
|
|
66403
|
+
GameEvent_Update: {
|
|
66404
|
+
parameters: {
|
|
66405
|
+
query?: never;
|
|
66406
|
+
header?: never;
|
|
66407
|
+
path: {
|
|
66408
|
+
/** @description Game event ID from the route. */
|
|
66409
|
+
eventId: number;
|
|
66410
|
+
};
|
|
66411
|
+
cookie?: never;
|
|
66412
|
+
};
|
|
66413
|
+
/** @description Partial update payload. Omitted or null fields are treated as no change. */
|
|
66414
|
+
requestBody?: {
|
|
66415
|
+
content: {
|
|
66416
|
+
"application/json-patch+json": components["schemas"]["UpdateGameEventRequest"];
|
|
66417
|
+
"application/json": components["schemas"]["UpdateGameEventRequest"];
|
|
66418
|
+
"text/json": components["schemas"]["UpdateGameEventRequest"];
|
|
66419
|
+
"application/*+json": components["schemas"]["UpdateGameEventRequest"];
|
|
66420
|
+
};
|
|
66421
|
+
};
|
|
66422
|
+
responses: {
|
|
66423
|
+
/** @description The updated game event resource. */
|
|
66424
|
+
200: {
|
|
66425
|
+
headers: {
|
|
66426
|
+
[name: string]: unknown;
|
|
66427
|
+
};
|
|
66428
|
+
content: {
|
|
66429
|
+
"application/json": components["schemas"]["GameEventResponse"];
|
|
66430
|
+
};
|
|
66431
|
+
};
|
|
66432
|
+
/** @description Validation failure or backend reject. */
|
|
66433
|
+
400: {
|
|
66434
|
+
headers: {
|
|
66435
|
+
[name: string]: unknown;
|
|
66436
|
+
};
|
|
66437
|
+
content: {
|
|
66438
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66439
|
+
};
|
|
66440
|
+
};
|
|
66441
|
+
/** @description Caller is not authenticated. */
|
|
66442
|
+
401: {
|
|
66443
|
+
headers: {
|
|
66444
|
+
[name: string]: unknown;
|
|
66445
|
+
};
|
|
66446
|
+
content: {
|
|
66447
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66448
|
+
};
|
|
66449
|
+
};
|
|
66450
|
+
/** @description Caller can read but lacks edit permission. */
|
|
66451
|
+
403: {
|
|
66452
|
+
headers: {
|
|
66453
|
+
[name: string]: unknown;
|
|
66454
|
+
};
|
|
66455
|
+
content: {
|
|
66456
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66457
|
+
};
|
|
66458
|
+
};
|
|
66459
|
+
/** @description Event not found. */
|
|
66460
|
+
404: {
|
|
66461
|
+
headers: {
|
|
66462
|
+
[name: string]: unknown;
|
|
66463
|
+
};
|
|
66464
|
+
content: {
|
|
66465
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66466
|
+
};
|
|
66467
|
+
};
|
|
66468
|
+
};
|
|
66469
|
+
};
|
|
66470
|
+
GameEvents_List: {
|
|
66471
|
+
parameters: {
|
|
66472
|
+
query?: {
|
|
66473
|
+
/** @description Requested page size. */
|
|
66474
|
+
pageSize?: number;
|
|
66475
|
+
/** @description Continuation token from a prior page's `nextPageToken`. */
|
|
66476
|
+
pageToken?: string;
|
|
66477
|
+
/** @description When true, treats `pageToken` as a backward-pagination cursor. */
|
|
66478
|
+
reverse?: boolean;
|
|
66479
|
+
/** @description Upper bound on event start time. */
|
|
66480
|
+
startsBefore?: string;
|
|
66481
|
+
/** @description Lower bound on event start time. */
|
|
66482
|
+
startsAfter?: string;
|
|
66483
|
+
/** @description Upper bound on event end time. */
|
|
66484
|
+
endsBefore?: string;
|
|
66485
|
+
/** @description Lower bound on event end time. Defaults to now when neither bound is set. */
|
|
66486
|
+
endsAfter?: string;
|
|
66487
|
+
/** @description Visibility filter. */
|
|
66488
|
+
visibility?: components["schemas"]["EventVisibility"];
|
|
66489
|
+
/** @description Field mask (comma-separated; omit or `*` for all fields). */
|
|
66490
|
+
fields?: string;
|
|
66491
|
+
};
|
|
66492
|
+
header?: never;
|
|
66493
|
+
path: {
|
|
66494
|
+
/** @description Universe that owns the events (from path). */
|
|
66495
|
+
universeId: number;
|
|
66496
|
+
};
|
|
66497
|
+
cookie?: never;
|
|
66498
|
+
};
|
|
66499
|
+
requestBody?: never;
|
|
66500
|
+
responses: {
|
|
66501
|
+
/** @description A page of game events. */
|
|
66502
|
+
200: {
|
|
66503
|
+
headers: {
|
|
66504
|
+
[name: string]: unknown;
|
|
66505
|
+
};
|
|
66506
|
+
content: {
|
|
66507
|
+
"application/json": components["schemas"]["PaginatedGameEventsResponse"];
|
|
66508
|
+
};
|
|
66509
|
+
};
|
|
66510
|
+
/** @description Invalid `?fields=`, out-of-range `pageSize`, or bad query parameter. */
|
|
66511
|
+
400: {
|
|
66512
|
+
headers: {
|
|
66513
|
+
[name: string]: unknown;
|
|
66514
|
+
};
|
|
66515
|
+
content: {
|
|
66516
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66517
|
+
};
|
|
66518
|
+
};
|
|
66519
|
+
};
|
|
66520
|
+
};
|
|
66521
|
+
GameEvents_Create: {
|
|
66522
|
+
parameters: {
|
|
66523
|
+
query?: never;
|
|
66524
|
+
header?: never;
|
|
66525
|
+
path: {
|
|
66526
|
+
/** @description Universe that will own the new event (from path). */
|
|
66527
|
+
universeId: number;
|
|
66528
|
+
};
|
|
66529
|
+
cookie?: never;
|
|
66530
|
+
};
|
|
66531
|
+
/** @description The create payload. */
|
|
66532
|
+
requestBody?: {
|
|
66533
|
+
content: {
|
|
66534
|
+
"application/json-patch+json": components["schemas"]["CreateGameEventRequest"];
|
|
66535
|
+
"application/json": components["schemas"]["CreateGameEventRequest"];
|
|
66536
|
+
"text/json": components["schemas"]["CreateGameEventRequest"];
|
|
66537
|
+
"application/*+json": components["schemas"]["CreateGameEventRequest"];
|
|
66538
|
+
};
|
|
66539
|
+
};
|
|
66540
|
+
responses: {
|
|
66541
|
+
/** @description The newly-created game event resource. */
|
|
66542
|
+
200: {
|
|
66543
|
+
headers: {
|
|
66544
|
+
[name: string]: unknown;
|
|
66545
|
+
};
|
|
66546
|
+
content: {
|
|
66547
|
+
"application/json": components["schemas"]["GameEventResponse"];
|
|
66548
|
+
};
|
|
66549
|
+
};
|
|
66550
|
+
/** @description Validation failure or server-side reject (moderation, age requirement, ...). */
|
|
66551
|
+
400: {
|
|
66552
|
+
headers: {
|
|
66553
|
+
[name: string]: unknown;
|
|
66554
|
+
};
|
|
66555
|
+
content: {
|
|
66556
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66557
|
+
};
|
|
66558
|
+
};
|
|
66559
|
+
/** @description Caller is not authenticated. */
|
|
66560
|
+
401: {
|
|
66561
|
+
headers: {
|
|
66562
|
+
[name: string]: unknown;
|
|
66563
|
+
};
|
|
66564
|
+
content: {
|
|
66565
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66566
|
+
};
|
|
66567
|
+
};
|
|
66568
|
+
/** @description Caller lacks permission or quota is exhausted. */
|
|
66569
|
+
403: {
|
|
66570
|
+
headers: {
|
|
66571
|
+
[name: string]: unknown;
|
|
66572
|
+
};
|
|
66573
|
+
content: {
|
|
66574
|
+
"application/json": components["schemas"]["VirtualEventsApi.ProblemDetails"];
|
|
66575
|
+
};
|
|
66576
|
+
};
|
|
66577
|
+
};
|
|
66578
|
+
};
|
|
65945
66579
|
}
|