rozod 6.7.1 → 6.9.0
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/LICENSE +1 -1
- package/README.md +75 -451
- package/lib/endpoints/accountinformationv1.d.ts +92 -95
- package/lib/endpoints/accountsettingsv1.d.ts +88 -110
- package/lib/endpoints/adconfigurationv2.d.ts +108 -215
- package/lib/endpoints/assetdeliveryv1.d.ts +267 -230
- package/lib/endpoints/assetdeliveryv1.js +38 -0
- package/lib/endpoints/assetdeliveryv2.d.ts +201 -176
- package/lib/endpoints/assetdeliveryv2.js +26 -0
- package/lib/endpoints/authv1.d.ts +480 -517
- package/lib/endpoints/authv1.js +3 -1
- package/lib/endpoints/authv2.d.ts +210 -222
- package/lib/endpoints/authv2.js +1 -1
- package/lib/endpoints/authv3.d.ts +32 -35
- package/lib/endpoints/avatarv1.d.ts +112 -117
- package/lib/endpoints/avatarv2.d.ts +71 -76
- package/lib/endpoints/avatarv3.d.ts +27 -33
- package/lib/endpoints/badgesv1.d.ts +96 -99
- package/lib/endpoints/badgesv1.js +4 -0
- package/lib/endpoints/catalogv1.d.ts +209 -234
- package/lib/endpoints/catalogv1.js +2 -1
- package/lib/endpoints/catalogv2.d.ts +106 -136
- package/lib/endpoints/catalogv2.js +21 -17
- package/lib/endpoints/chatv2.d.ts +778 -778
- package/lib/endpoints/clientsettingsv1.d.ts +33 -35
- package/lib/endpoints/clientsettingsv2.d.ts +62 -68
- package/lib/endpoints/contactsv1.d.ts +18 -20
- package/lib/endpoints/developv1.d.ts +233 -293
- package/lib/endpoints/developv1.js +3 -0
- package/lib/endpoints/developv2.d.ts +87 -138
- package/lib/endpoints/developv2.js +3 -1
- package/lib/endpoints/economycreatorstatsv1.d.ts +12 -12
- package/lib/endpoints/economyv1.d.ts +6 -6
- package/lib/endpoints/engagementpayoutsv1.d.ts +9 -9
- package/lib/endpoints/followingsv1.d.ts +33 -34
- package/lib/endpoints/followingsv2.d.ts +9 -9
- package/lib/endpoints/friendsv1.d.ts +416 -545
- package/lib/endpoints/friendsv1.js +213 -313
- package/lib/endpoints/gameinternationalizationv1.d.ts +1509 -1642
- package/lib/endpoints/gameinternationalizationv2.d.ts +62 -64
- package/lib/endpoints/gamejoinv1.d.ts +458 -458
- package/lib/endpoints/gamesv1.d.ts +183 -143
- package/lib/endpoints/gamesv1.js +2 -0
- package/lib/endpoints/gamesv2.d.ts +161 -158
- package/lib/endpoints/gamesv2.js +9 -0
- package/lib/endpoints/groupsv1.d.ts +967 -976
- package/lib/endpoints/groupsv1.js +48 -4
- package/lib/endpoints/groupsv2.d.ts +259 -277
- package/lib/endpoints/groupsv2.js +1 -0
- package/lib/endpoints/inventoryv1.d.ts +93 -122
- package/lib/endpoints/inventoryv1.js +3 -1
- package/lib/endpoints/inventoryv2.d.ts +163 -178
- package/lib/endpoints/inventoryv2.js +2 -0
- package/lib/endpoints/itemconfigurationv1.d.ts +33 -40
- package/lib/endpoints/localev1.d.ts +47 -48
- package/lib/endpoints/localizationtablesv1.d.ts +315 -353
- package/lib/endpoints/matchmakingv1.d.ts +184 -190
- package/lib/endpoints/metricsv1.d.ts +88 -88
- package/lib/endpoints/notificationsv2.d.ts +144 -158
- package/lib/endpoints/premiumfeaturesv1.d.ts +14 -14
- package/lib/endpoints/presencev1.d.ts +7 -12
- package/lib/endpoints/privatemessagesv1.d.ts +56 -64
- package/lib/endpoints/publishv1.d.ts +32 -32
- package/lib/endpoints/thumbnailsresizerv1.d.ts +52 -53
- package/lib/endpoints/thumbnailsv1.d.ts +317 -361
- package/lib/endpoints/thumbnailsv1.js +25 -0
- package/lib/endpoints/tradesv1.d.ts +92 -104
- package/lib/endpoints/tradesv2.d.ts +81 -84
- package/lib/endpoints/translationrolesv1.d.ts +46 -51
- package/lib/endpoints/twostepverificationv1.d.ts +233 -237
- package/lib/endpoints/usersv1.d.ts +110 -114
- package/lib/index.d.ts +152 -4
- package/lib/index.js +273 -4
- package/lib/opencloud/v1/asset-permissions.d.ts +1 -1
- package/lib/opencloud/v1/assets.d.ts +9 -9
- package/lib/opencloud/v1/datastores-ordered.d.ts +6 -6
- package/lib/opencloud/v1/datastores.d.ts +8 -8
- package/lib/opencloud/v1/developer-products.d.ts +4 -4
- package/lib/opencloud/v1/game-passes.d.ts +4 -4
- package/lib/opencloud/v1/messaging.d.ts +1 -1
- package/lib/opencloud/v1/open-eval.d.ts +2 -2
- package/lib/opencloud/v1/secrets-store.d.ts +5 -5
- package/lib/opencloud/v1/toolbox.d.ts +2 -2
- package/lib/opencloud/v1/universes.d.ts +1 -1
- package/lib/opencloud/v2/cloud.d.ts +172 -84
- package/lib/opencloud/v2/cloud.js +25 -9
- package/package.json +2 -2
|
@@ -1,49 +1,22 @@
|
|
|
1
|
-
import { z } from
|
|
2
|
-
import { endpoint } from
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { endpoint } from '..';
|
|
3
3
|
|
|
4
4
|
const Roblox_AdConfiguration_Api_SponsoredCampaignModel = z.object({
|
|
5
5
|
adId: z.number().int(),
|
|
6
6
|
adSetId: z.number().int(),
|
|
7
7
|
adName: z.string(),
|
|
8
|
-
adStatus: z.enum([
|
|
9
|
-
|
|
10
|
-
"Draft",
|
|
11
|
-
"PendingApproval",
|
|
12
|
-
"Approved",
|
|
13
|
-
"Moderated",
|
|
14
|
-
]),
|
|
15
|
-
creativeType: z.enum(["Undefined", "Image", "Video"]),
|
|
8
|
+
adStatus: z.enum(['Undefined', 'Draft', 'PendingApproval', 'Approved', 'Moderated']),
|
|
9
|
+
creativeType: z.enum(['Undefined', 'Image', 'Video']),
|
|
16
10
|
creativeTargetId: z.number().int(),
|
|
17
11
|
bidAmountInRobux: z.number().int(),
|
|
18
12
|
budgetInRobux: z.number().int(),
|
|
19
|
-
adSetStatus: z.enum([
|
|
20
|
-
"Undefined",
|
|
21
|
-
"Draft",
|
|
22
|
-
"Scheduled",
|
|
23
|
-
"Running",
|
|
24
|
-
"Paused",
|
|
25
|
-
"Stopped",
|
|
26
|
-
"Completed",
|
|
27
|
-
]),
|
|
13
|
+
adSetStatus: z.enum(['Undefined', 'Draft', 'Scheduled', 'Running', 'Paused', 'Stopped', 'Completed']),
|
|
28
14
|
startDate: z.string().datetime({ offset: true }),
|
|
29
15
|
endDate: z.string().datetime({ offset: true }),
|
|
30
|
-
targetGender: z.enum([
|
|
31
|
-
targetAgeBracket: z.enum([
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
"Age13OrOver",
|
|
35
|
-
"Age13To16",
|
|
36
|
-
"Age17OrOver",
|
|
37
|
-
]),
|
|
38
|
-
targetDeviceType: z.enum([
|
|
39
|
-
"Undefined",
|
|
40
|
-
"Computer",
|
|
41
|
-
"Phone",
|
|
42
|
-
"Tablet",
|
|
43
|
-
"Console",
|
|
44
|
-
"VR",
|
|
45
|
-
]),
|
|
46
|
-
campaignTargetType: z.enum(["Undefined", "Universe", "Asset", "ImmersiveAd"]),
|
|
16
|
+
targetGender: z.enum(['Undefined', 'Male', 'Female']),
|
|
17
|
+
targetAgeBracket: z.enum(['Undefined', 'AgeUnder13', 'Age13OrOver', 'Age13To16', 'Age17OrOver']),
|
|
18
|
+
targetDeviceType: z.enum(['Undefined', 'Computer', 'Phone', 'Tablet', 'Console', 'VR']),
|
|
19
|
+
campaignTargetType: z.enum(['Undefined', 'Universe', 'Asset', 'ImmersiveAd']),
|
|
47
20
|
campaignTargetId: z.number().int(),
|
|
48
21
|
totalSpendInRobux: z.number().int(),
|
|
49
22
|
totalImpressions: z.number().int(),
|
|
@@ -53,9 +26,7 @@ const Roblox_AdConfiguration_Api_SponsoredCampaignModel = z.object({
|
|
|
53
26
|
clickConversions: z.number().int(),
|
|
54
27
|
});
|
|
55
28
|
const Roblox_AdConfiguration_Api_GetSponsoredCampaignsResponse = z.object({
|
|
56
|
-
sponsoredCampaigns: z.array(
|
|
57
|
-
Roblox_AdConfiguration_Api_SponsoredCampaignModel
|
|
58
|
-
),
|
|
29
|
+
sponsoredCampaigns: z.array(Roblox_AdConfiguration_Api_SponsoredCampaignModel),
|
|
59
30
|
previousPageCursor: z.string(),
|
|
60
31
|
nextPageCursor: z.string(),
|
|
61
32
|
});
|
|
@@ -63,46 +34,19 @@ const Roblox_AdConfiguration_Api_SponsoredGameV2Model = z.object({
|
|
|
63
34
|
adId: z.number().int(),
|
|
64
35
|
adSetId: z.number().int(),
|
|
65
36
|
adName: z.string(),
|
|
66
|
-
adStatus: z.enum([
|
|
67
|
-
|
|
68
|
-
"Draft",
|
|
69
|
-
"PendingApproval",
|
|
70
|
-
"Approved",
|
|
71
|
-
"Moderated",
|
|
72
|
-
]),
|
|
73
|
-
creativeType: z.enum(["Undefined", "Image", "Video"]),
|
|
37
|
+
adStatus: z.enum(['Undefined', 'Draft', 'PendingApproval', 'Approved', 'Moderated']),
|
|
38
|
+
creativeType: z.enum(['Undefined', 'Image', 'Video']),
|
|
74
39
|
creativeTargetId: z.number().int(),
|
|
75
40
|
creativeUrl: z.string(),
|
|
76
41
|
bidAmountInRobux: z.number().int(),
|
|
77
42
|
budgetInRobux: z.number().int(),
|
|
78
|
-
adSetStatus: z.enum([
|
|
79
|
-
"Undefined",
|
|
80
|
-
"Draft",
|
|
81
|
-
"Scheduled",
|
|
82
|
-
"Running",
|
|
83
|
-
"Paused",
|
|
84
|
-
"Stopped",
|
|
85
|
-
"Completed",
|
|
86
|
-
]),
|
|
43
|
+
adSetStatus: z.enum(['Undefined', 'Draft', 'Scheduled', 'Running', 'Paused', 'Stopped', 'Completed']),
|
|
87
44
|
startDate: z.string().datetime({ offset: true }),
|
|
88
45
|
endDate: z.string().datetime({ offset: true }),
|
|
89
|
-
targetGender: z.enum([
|
|
90
|
-
targetAgeBracket: z.enum([
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
"Age13OrOver",
|
|
94
|
-
"Age13To16",
|
|
95
|
-
"Age17OrOver",
|
|
96
|
-
]),
|
|
97
|
-
targetDeviceType: z.enum([
|
|
98
|
-
"Undefined",
|
|
99
|
-
"Computer",
|
|
100
|
-
"Phone",
|
|
101
|
-
"Tablet",
|
|
102
|
-
"Console",
|
|
103
|
-
"VR",
|
|
104
|
-
]),
|
|
105
|
-
campaignTargetType: z.enum(["Undefined", "Universe", "Asset", "ImmersiveAd"]),
|
|
46
|
+
targetGender: z.enum(['Undefined', 'Male', 'Female']),
|
|
47
|
+
targetAgeBracket: z.enum(['Undefined', 'AgeUnder13', 'Age13OrOver', 'Age13To16', 'Age17OrOver']),
|
|
48
|
+
targetDeviceType: z.enum(['Undefined', 'Computer', 'Phone', 'Tablet', 'Console', 'VR']),
|
|
49
|
+
campaignTargetType: z.enum(['Undefined', 'Universe', 'Asset', 'ImmersiveAd']),
|
|
106
50
|
campaignTargetId: z.number().int(),
|
|
107
51
|
totalSpendInRobux: z.number().int(),
|
|
108
52
|
totalImpressions: z.number().int(),
|
|
@@ -120,96 +64,56 @@ const Roblox_AdConfiguration_Api_Models_UniverseModel = z.object({
|
|
|
120
64
|
id: z.number().int(),
|
|
121
65
|
name: z.string(),
|
|
122
66
|
});
|
|
123
|
-
const Roblox_AdConfiguration_Api_Models_GetRecentAdsRankedUniversesResponse =
|
|
124
|
-
z.
|
|
125
|
-
|
|
126
|
-
});
|
|
67
|
+
const Roblox_AdConfiguration_Api_Models_GetRecentAdsRankedUniversesResponse = z.object({
|
|
68
|
+
universes: z.array(Roblox_AdConfiguration_Api_Models_UniverseModel),
|
|
69
|
+
});
|
|
127
70
|
const Roblox_AdConfiguration_Api_CreativeModel = z.object({
|
|
128
71
|
creativeId: z.number().int(),
|
|
129
|
-
creativeType: z.enum([
|
|
72
|
+
creativeType: z.enum(['Undefined', 'Image', 'Video']),
|
|
73
|
+
});
|
|
74
|
+
const Roblox_AdConfiguration_Api_Models_CreateSponsoredCampaignRequest = z.object({
|
|
75
|
+
campaignTargetId: z.number().int(),
|
|
76
|
+
campaignTargetType: z.enum(['Undefined', 'Universe', 'Asset', 'ImmersiveAd']),
|
|
77
|
+
targetGender: z.enum(['Undefined', 'Male', 'Female']),
|
|
78
|
+
targetAgeBracket: z.enum(['Undefined', 'AgeUnder13', 'Age13OrOver', 'Age13To16', 'Age17OrOver']),
|
|
79
|
+
startDate: z.string().datetime({ offset: true }),
|
|
80
|
+
endDate: z.string().datetime({ offset: true }),
|
|
81
|
+
targetDeviceType: z.enum(['Undefined', 'Computer', 'Phone', 'Tablet', 'Console', 'VR']),
|
|
82
|
+
campaignName: z.string(),
|
|
83
|
+
dailyBidAmountInRobux: z.number().int(),
|
|
84
|
+
placementLocation: z.enum([
|
|
85
|
+
'Undefined',
|
|
86
|
+
'GameSort',
|
|
87
|
+
'AvatarShop',
|
|
88
|
+
'ItemDetails',
|
|
89
|
+
'HomePage',
|
|
90
|
+
'Billboard300x250',
|
|
91
|
+
'Billboard600x300',
|
|
92
|
+
'Billboard300x600',
|
|
93
|
+
]),
|
|
94
|
+
creativeModel: Roblox_AdConfiguration_Api_CreativeModel,
|
|
95
|
+
});
|
|
96
|
+
const Roblox_AdConfiguration_Api_Models_GetEligibleCampaignTargetsRequest = z.object({
|
|
97
|
+
campaignTargetTypes: z.array(z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3)])),
|
|
98
|
+
groupId: z.number().int(),
|
|
130
99
|
});
|
|
131
|
-
const Roblox_AdConfiguration_Api_Models_CreateSponsoredCampaignRequest =
|
|
132
|
-
z.object({
|
|
133
|
-
campaignTargetId: z.number().int(),
|
|
134
|
-
campaignTargetType: z.enum([
|
|
135
|
-
"Undefined",
|
|
136
|
-
"Universe",
|
|
137
|
-
"Asset",
|
|
138
|
-
"ImmersiveAd",
|
|
139
|
-
]),
|
|
140
|
-
targetGender: z.enum(["Undefined", "Male", "Female"]),
|
|
141
|
-
targetAgeBracket: z.enum([
|
|
142
|
-
"Undefined",
|
|
143
|
-
"AgeUnder13",
|
|
144
|
-
"Age13OrOver",
|
|
145
|
-
"Age13To16",
|
|
146
|
-
"Age17OrOver",
|
|
147
|
-
]),
|
|
148
|
-
startDate: z.string().datetime({ offset: true }),
|
|
149
|
-
endDate: z.string().datetime({ offset: true }),
|
|
150
|
-
targetDeviceType: z.enum([
|
|
151
|
-
"Undefined",
|
|
152
|
-
"Computer",
|
|
153
|
-
"Phone",
|
|
154
|
-
"Tablet",
|
|
155
|
-
"Console",
|
|
156
|
-
"VR",
|
|
157
|
-
]),
|
|
158
|
-
campaignName: z.string(),
|
|
159
|
-
dailyBidAmountInRobux: z.number().int(),
|
|
160
|
-
placementLocation: z.enum([
|
|
161
|
-
"Undefined",
|
|
162
|
-
"GameSort",
|
|
163
|
-
"AvatarShop",
|
|
164
|
-
"ItemDetails",
|
|
165
|
-
"HomePage",
|
|
166
|
-
"Billboard300x250",
|
|
167
|
-
"Billboard600x300",
|
|
168
|
-
"Billboard300x600",
|
|
169
|
-
]),
|
|
170
|
-
creativeModel: Roblox_AdConfiguration_Api_CreativeModel,
|
|
171
|
-
});
|
|
172
|
-
const Roblox_AdConfiguration_Api_Models_GetEligibleCampaignTargetsRequest =
|
|
173
|
-
z.object({
|
|
174
|
-
campaignTargetTypes: z.array(
|
|
175
|
-
z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3)])
|
|
176
|
-
),
|
|
177
|
-
groupId: z.number().int(),
|
|
178
|
-
});
|
|
179
100
|
const Roblox_AdConfiguration_Api_Models_CampaignTargetModel = z.object({
|
|
180
|
-
campaignTargetType: z.enum([
|
|
101
|
+
campaignTargetType: z.enum(['Undefined', 'Universe', 'Asset', 'ImmersiveAd']),
|
|
181
102
|
campaignTargetId: z.number().int(),
|
|
182
103
|
name: z.string(),
|
|
183
104
|
});
|
|
184
105
|
const Roblox_AdConfiguration_Api_Models_GetCampaignTargetsResponse = z.object({
|
|
185
|
-
campaignTargetModels: z.array(
|
|
186
|
-
Roblox_AdConfiguration_Api_Models_CampaignTargetModel
|
|
187
|
-
),
|
|
106
|
+
campaignTargetModels: z.array(Roblox_AdConfiguration_Api_Models_CampaignTargetModel),
|
|
188
107
|
});
|
|
189
|
-
const Roblox_AdConfiguration_Api_Models_StopSponsoredCampaignRequest = z.object(
|
|
190
|
-
{ adSetId: z.number().int() }
|
|
191
|
-
);
|
|
108
|
+
const Roblox_AdConfiguration_Api_Models_StopSponsoredCampaignRequest = z.object({ adSetId: z.number().int() });
|
|
192
109
|
const Roblox_AdConfiguration_Api_CreateSponsoredGameV2Request = z.object({
|
|
193
110
|
universeId: z.number().int(),
|
|
194
|
-
targetGender: z.enum([
|
|
195
|
-
targetAgeBracket: z.enum([
|
|
196
|
-
"Undefined",
|
|
197
|
-
"AgeUnder13",
|
|
198
|
-
"Age13OrOver",
|
|
199
|
-
"Age13To16",
|
|
200
|
-
"Age17OrOver",
|
|
201
|
-
]),
|
|
111
|
+
targetGender: z.enum(['Undefined', 'Male', 'Female']),
|
|
112
|
+
targetAgeBracket: z.enum(['Undefined', 'AgeUnder13', 'Age13OrOver', 'Age13To16', 'Age17OrOver']),
|
|
202
113
|
budgetInRobux: z.number().int(),
|
|
203
114
|
startDate: z.string().datetime({ offset: true }),
|
|
204
115
|
endDate: z.string().datetime({ offset: true }),
|
|
205
|
-
targetDeviceType: z.enum([
|
|
206
|
-
"Undefined",
|
|
207
|
-
"Computer",
|
|
208
|
-
"Phone",
|
|
209
|
-
"Tablet",
|
|
210
|
-
"Console",
|
|
211
|
-
"VR",
|
|
212
|
-
]),
|
|
116
|
+
targetDeviceType: z.enum(['Undefined', 'Computer', 'Phone', 'Tablet', 'Console', 'VR']),
|
|
213
117
|
adName: z.string(),
|
|
214
118
|
bidAmountInRobux: z.number().int(),
|
|
215
119
|
});
|
|
@@ -228,39 +132,34 @@ const Roblox_AdConfiguration_Api_Models_StopSponsoredGameV2Request = z.object({
|
|
|
228
132
|
* @param pageCursor The cursor of the page to retrieve. If empty, fetches the first page
|
|
229
133
|
*/
|
|
230
134
|
export const getSponsoredCampaigns = endpoint({
|
|
231
|
-
method:
|
|
232
|
-
path:
|
|
233
|
-
baseUrl:
|
|
234
|
-
requestFormat:
|
|
135
|
+
method: 'GET',
|
|
136
|
+
path: '/v2/sponsored-campaigns',
|
|
137
|
+
baseUrl: 'https://adconfiguration.roblox.com',
|
|
138
|
+
requestFormat: 'json',
|
|
235
139
|
serializationMethod: {
|
|
236
140
|
campaignTargetType: {
|
|
237
|
-
style:
|
|
141
|
+
style: 'form',
|
|
238
142
|
explode: true,
|
|
239
143
|
},
|
|
240
144
|
campaignTargetId: {
|
|
241
|
-
style:
|
|
145
|
+
style: 'form',
|
|
242
146
|
explode: true,
|
|
243
147
|
},
|
|
244
148
|
includeReportingStats: {
|
|
245
|
-
style:
|
|
149
|
+
style: 'form',
|
|
246
150
|
explode: true,
|
|
247
151
|
},
|
|
248
152
|
isArchived: {
|
|
249
|
-
style:
|
|
153
|
+
style: 'form',
|
|
250
154
|
explode: true,
|
|
251
155
|
},
|
|
252
156
|
pageCursor: {
|
|
253
|
-
style:
|
|
157
|
+
style: 'form',
|
|
254
158
|
explode: true,
|
|
255
159
|
},
|
|
256
160
|
},
|
|
257
161
|
parameters: {
|
|
258
|
-
campaignTargetType: z.union([
|
|
259
|
-
z.literal(0),
|
|
260
|
-
z.literal(1),
|
|
261
|
-
z.literal(2),
|
|
262
|
-
z.literal(3),
|
|
263
|
-
]),
|
|
162
|
+
campaignTargetType: z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3)]),
|
|
264
163
|
campaignTargetId: z.number().int(),
|
|
265
164
|
includeReportingStats: z.boolean().optional(),
|
|
266
165
|
isArchived: z.boolean().optional(),
|
|
@@ -290,10 +189,10 @@ Currently intended for creation of sponsorships only.
|
|
|
290
189
|
* @param body Roblox.AdConfiguration.Api.Models.CreateSponsoredCampaignRequest
|
|
291
190
|
*/
|
|
292
191
|
export const postSponsoredCampaignsCreate = endpoint({
|
|
293
|
-
method:
|
|
294
|
-
path:
|
|
295
|
-
baseUrl:
|
|
296
|
-
requestFormat:
|
|
192
|
+
method: 'POST',
|
|
193
|
+
path: '/v2/sponsored-campaigns/create',
|
|
194
|
+
baseUrl: 'https://adconfiguration.roblox.com',
|
|
195
|
+
requestFormat: 'json',
|
|
297
196
|
serializationMethod: {
|
|
298
197
|
body: {},
|
|
299
198
|
},
|
|
@@ -355,10 +254,10 @@ export const postSponsoredCampaignsCreate = endpoint({
|
|
|
355
254
|
* @summary Get all asset type IDs that are eligible to be sponsored.
|
|
356
255
|
*/
|
|
357
256
|
export const getSponsoredCampaignsEligibleAssetTypeIds = endpoint({
|
|
358
|
-
method:
|
|
359
|
-
path:
|
|
360
|
-
baseUrl:
|
|
361
|
-
requestFormat:
|
|
257
|
+
method: 'GET',
|
|
258
|
+
path: '/v2/sponsored-campaigns/eligible-asset-type-ids',
|
|
259
|
+
baseUrl: 'https://adconfiguration.roblox.com',
|
|
260
|
+
requestFormat: 'json',
|
|
362
261
|
response: z.array(z.number()),
|
|
363
262
|
errors: [
|
|
364
263
|
{
|
|
@@ -377,10 +276,10 @@ export const getSponsoredCampaignsEligibleAssetTypeIds = endpoint({
|
|
|
377
276
|
* @param body Roblox.AdConfiguration.Api.Models.GetEligibleCampaignTargetsRequest
|
|
378
277
|
*/
|
|
379
278
|
export const postSponsoredCampaignsEligibleCampaignTargets = endpoint({
|
|
380
|
-
method:
|
|
381
|
-
path:
|
|
382
|
-
baseUrl:
|
|
383
|
-
requestFormat:
|
|
279
|
+
method: 'POST',
|
|
280
|
+
path: '/v2/sponsored-campaigns/eligible-campaign-targets',
|
|
281
|
+
baseUrl: 'https://adconfiguration.roblox.com',
|
|
282
|
+
requestFormat: 'json',
|
|
384
283
|
serializationMethod: {
|
|
385
284
|
body: {},
|
|
386
285
|
},
|
|
@@ -411,27 +310,22 @@ if the user is authorized to sponsor the targets.
|
|
|
411
310
|
* @param campaignTargetIds The IDs of the campaign targets.
|
|
412
311
|
*/
|
|
413
312
|
export const getSponsoredCampaignsMultiGetCanUserSponsor = endpoint({
|
|
414
|
-
method:
|
|
415
|
-
path:
|
|
416
|
-
baseUrl:
|
|
417
|
-
requestFormat:
|
|
313
|
+
method: 'GET',
|
|
314
|
+
path: '/v2/sponsored-campaigns/multi-get-can-user-sponsor',
|
|
315
|
+
baseUrl: 'https://adconfiguration.roblox.com',
|
|
316
|
+
requestFormat: 'json',
|
|
418
317
|
serializationMethod: {
|
|
419
318
|
campaignTargetType: {
|
|
420
|
-
style:
|
|
319
|
+
style: 'form',
|
|
421
320
|
explode: true,
|
|
422
321
|
},
|
|
423
322
|
campaignTargetIds: {
|
|
424
|
-
style:
|
|
323
|
+
style: 'form',
|
|
425
324
|
explode: true,
|
|
426
325
|
},
|
|
427
326
|
},
|
|
428
327
|
parameters: {
|
|
429
|
-
campaignTargetType: z.union([
|
|
430
|
-
z.literal(0),
|
|
431
|
-
z.literal(1),
|
|
432
|
-
z.literal(2),
|
|
433
|
-
z.literal(3),
|
|
434
|
-
]),
|
|
328
|
+
campaignTargetType: z.union([z.literal(0), z.literal(1), z.literal(2), z.literal(3)]),
|
|
435
329
|
campaignTargetIds: z.array(z.number()),
|
|
436
330
|
},
|
|
437
331
|
response: z.boolean(),
|
|
@@ -460,10 +354,10 @@ export const getSponsoredCampaignsMultiGetCanUserSponsor = endpoint({
|
|
|
460
354
|
* @param body Roblox.AdConfiguration.Api.Models.StopSponsoredCampaignRequest
|
|
461
355
|
*/
|
|
462
356
|
export const postSponsoredCampaignsStop = endpoint({
|
|
463
|
-
method:
|
|
464
|
-
path:
|
|
465
|
-
baseUrl:
|
|
466
|
-
requestFormat:
|
|
357
|
+
method: 'POST',
|
|
358
|
+
path: '/v2/sponsored-campaigns/stop',
|
|
359
|
+
baseUrl: 'https://adconfiguration.roblox.com',
|
|
360
|
+
requestFormat: 'json',
|
|
467
361
|
serializationMethod: {
|
|
468
362
|
body: {},
|
|
469
363
|
},
|
|
@@ -500,25 +394,25 @@ export const postSponsoredCampaignsStop = endpoint({
|
|
|
500
394
|
* @param pageCursor The cursor of the page to retrieve.
|
|
501
395
|
*/
|
|
502
396
|
export const getSponsoredGames = endpoint({
|
|
503
|
-
method:
|
|
504
|
-
path:
|
|
505
|
-
baseUrl:
|
|
506
|
-
requestFormat:
|
|
397
|
+
method: 'GET',
|
|
398
|
+
path: '/v2/sponsored-games',
|
|
399
|
+
baseUrl: 'https://adconfiguration.roblox.com',
|
|
400
|
+
requestFormat: 'json',
|
|
507
401
|
serializationMethod: {
|
|
508
402
|
universeId: {
|
|
509
|
-
style:
|
|
403
|
+
style: 'form',
|
|
510
404
|
explode: true,
|
|
511
405
|
},
|
|
512
406
|
includeReportingStats: {
|
|
513
|
-
style:
|
|
407
|
+
style: 'form',
|
|
514
408
|
explode: true,
|
|
515
409
|
},
|
|
516
410
|
isArchived: {
|
|
517
|
-
style:
|
|
411
|
+
style: 'form',
|
|
518
412
|
explode: true,
|
|
519
413
|
},
|
|
520
414
|
pageCursor: {
|
|
521
|
-
style:
|
|
415
|
+
style: 'form',
|
|
522
416
|
explode: true,
|
|
523
417
|
},
|
|
524
418
|
},
|
|
@@ -551,10 +445,10 @@ export const getSponsoredGames = endpoint({
|
|
|
551
445
|
* @param body Roblox.AdConfiguration.Api.CreateSponsoredGameV2Request
|
|
552
446
|
*/
|
|
553
447
|
export const postSponsoredGamesCreate = endpoint({
|
|
554
|
-
method:
|
|
555
|
-
path:
|
|
556
|
-
baseUrl:
|
|
557
|
-
requestFormat:
|
|
448
|
+
method: 'POST',
|
|
449
|
+
path: '/v2/sponsored-games/create',
|
|
450
|
+
baseUrl: 'https://adconfiguration.roblox.com',
|
|
451
|
+
requestFormat: 'json',
|
|
558
452
|
serializationMethod: {
|
|
559
453
|
body: {},
|
|
560
454
|
},
|
|
@@ -617,10 +511,10 @@ export const postSponsoredGamesCreate = endpoint({
|
|
|
617
511
|
* @param body Roblox.AdConfiguration.Api.Models.StopSponsoredGameV2Request
|
|
618
512
|
*/
|
|
619
513
|
export const postSponsoredGamesStop = endpoint({
|
|
620
|
-
method:
|
|
621
|
-
path:
|
|
622
|
-
baseUrl:
|
|
623
|
-
requestFormat:
|
|
514
|
+
method: 'POST',
|
|
515
|
+
path: '/v2/sponsored-games/stop',
|
|
516
|
+
baseUrl: 'https://adconfiguration.roblox.com',
|
|
517
|
+
requestFormat: 'json',
|
|
624
518
|
serializationMethod: {
|
|
625
519
|
body: {},
|
|
626
520
|
},
|
|
@@ -653,21 +547,20 @@ export const postSponsoredGamesStop = endpoint({
|
|
|
653
547
|
* @param groupId The group id, if applicable.
|
|
654
548
|
*/
|
|
655
549
|
export const getSponsoredGamesUniverses = endpoint({
|
|
656
|
-
method:
|
|
657
|
-
path:
|
|
658
|
-
baseUrl:
|
|
659
|
-
requestFormat:
|
|
550
|
+
method: 'GET',
|
|
551
|
+
path: '/v2/sponsored-games/universes',
|
|
552
|
+
baseUrl: 'https://adconfiguration.roblox.com',
|
|
553
|
+
requestFormat: 'json',
|
|
660
554
|
serializationMethod: {
|
|
661
555
|
groupId: {
|
|
662
|
-
style:
|
|
556
|
+
style: 'form',
|
|
663
557
|
explode: true,
|
|
664
558
|
},
|
|
665
559
|
},
|
|
666
560
|
parameters: {
|
|
667
561
|
groupId: z.number().int().optional(),
|
|
668
562
|
},
|
|
669
|
-
response:
|
|
670
|
-
Roblox_AdConfiguration_Api_Models_GetRecentAdsRankedUniversesResponse,
|
|
563
|
+
response: Roblox_AdConfiguration_Api_Models_GetRecentAdsRankedUniversesResponse,
|
|
671
564
|
errors: [
|
|
672
565
|
{
|
|
673
566
|
status: 400,
|