@jacobhumston/roblox-openapi-ts 1.0.34 → 1.0.35

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 (2) hide show
  1. package/dist/types.d.ts +22 -254
  2. package/package.json +1 -1
package/dist/types.d.ts CHANGED
@@ -240,7 +240,7 @@ export interface paths {
240
240
  /** @description Universe ID to check eligibility for */
241
241
  universeId?: string;
242
242
  /** @description Objective filter (ENGAGEMENT in v1) */
243
- objective?: string;
243
+ objective?: "ENGAGEMENT";
244
244
  };
245
245
  header?: never;
246
246
  path?: never;
@@ -622,176 +622,6 @@ export interface paths {
622
622
  };
623
623
  trace?: never;
624
624
  };
625
- "/ads-management/v1/campaigns/{id}/performance": {
626
- parameters: {
627
- query?: never;
628
- header?: never;
629
- path?: never;
630
- cookie?: never;
631
- };
632
- /**
633
- * Get campaign performance
634
- * @description Returns aggregate performance for a single campaign over the requested period: impressions, clicks, plays, spend, CPM (cost per 1,000 impressions), CPP (cost per play), playRate, and CTR (click-through rate). Metrics are calculated in the billing account's time zone. Money fields (spendMicros, cpmMicros, cppMicros) are micro-USD returned as decimal strings (e.g. "5000000" = $5.00). Set the period query parameter to choose the window (defaults to LAST_7_DAYS).
635
- */
636
- get: {
637
- parameters: {
638
- query?: {
639
- /** @description Reporting period (TODAY, YESTERDAY, LAST_7_DAYS, LAST_30_DAYS, THIS_MONTH, LAST_MONTH, YEAR_TO_DATE, PREVIOUS_YEAR; default LAST_7_DAYS) */
640
- period?: string;
641
- };
642
- header?: never;
643
- path: {
644
- /** @description Campaign ID */
645
- id: string;
646
- };
647
- cookie?: never;
648
- };
649
- requestBody?: never;
650
- responses: {
651
- /** @description OK */
652
- 200: {
653
- headers: {
654
- [name: string]: unknown;
655
- };
656
- content: {
657
- "application/json": components["schemas"]["internal_public_v1.PerformanceResponse"];
658
- };
659
- };
660
- /** @description Invalid period value */
661
- 400: {
662
- headers: {
663
- [name: string]: unknown;
664
- };
665
- content: {
666
- "application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
667
- };
668
- };
669
- /** @description Permission denied */
670
- 403: {
671
- headers: {
672
- [name: string]: unknown;
673
- };
674
- content: {
675
- "application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
676
- };
677
- };
678
- /** @description Campaign not found */
679
- 404: {
680
- headers: {
681
- [name: string]: unknown;
682
- };
683
- content: {
684
- "application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
685
- };
686
- };
687
- /** @description Rate limit exceeded */
688
- 429: {
689
- headers: {
690
- [name: string]: unknown;
691
- };
692
- content: {
693
- "application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
694
- };
695
- };
696
- /** @description Internal server error */
697
- 500: {
698
- headers: {
699
- [name: string]: unknown;
700
- };
701
- content: {
702
- "application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
703
- };
704
- };
705
- };
706
- };
707
- put?: never;
708
- post?: never;
709
- delete?: never;
710
- options?: never;
711
- head?: never;
712
- patch?: never;
713
- trace?: never;
714
- };
715
- "/ads-management/v1/campaigns:batchGetPerformance": {
716
- parameters: {
717
- query?: never;
718
- header?: never;
719
- path?: never;
720
- cookie?: never;
721
- };
722
- get?: never;
723
- put?: never;
724
- /**
725
- * Batch get campaign performance
726
- * @description Returns aggregate performance for up to 100 campaigns over a single shared period (default LAST_7_DAYS), calculated in the billing account's time zone. Each result carries the same metrics as the single-campaign performance endpoint: impressions, clicks, plays, spend, CPM (cost per 1,000 impressions), CPP (cost per play), playRate, and CTR (click-through rate). Provide the campaign IDs in campaignIds; any ID that is not found or is not owned by the caller is returned in the failures array with reason NOT_FOUND. Prefer this over calling the single-campaign endpoint in a loop when building account-wide dashboards.
727
- */
728
- post: {
729
- parameters: {
730
- query?: never;
731
- header?: never;
732
- path?: never;
733
- cookie?: never;
734
- };
735
- /** @description Campaign IDs (max 100) and optional period */
736
- requestBody: {
737
- content: {
738
- "application/json": components["schemas"]["internal_public_v1.BatchGetPerformanceRequest"];
739
- };
740
- };
741
- responses: {
742
- /** @description OK */
743
- 200: {
744
- headers: {
745
- [name: string]: unknown;
746
- };
747
- content: {
748
- "application/json": components["schemas"]["internal_public_v1.BatchGetPerformanceResponse"];
749
- };
750
- };
751
- /** @description Invalid request, exceeds 100 IDs, or invalid period */
752
- 400: {
753
- headers: {
754
- [name: string]: unknown;
755
- };
756
- content: {
757
- "application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
758
- };
759
- };
760
- /** @description Permission denied */
761
- 403: {
762
- headers: {
763
- [name: string]: unknown;
764
- };
765
- content: {
766
- "application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
767
- };
768
- };
769
- /** @description Rate limit exceeded */
770
- 429: {
771
- headers: {
772
- [name: string]: unknown;
773
- };
774
- content: {
775
- "application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
776
- };
777
- };
778
- /** @description Internal server error */
779
- 500: {
780
- headers: {
781
- [name: string]: unknown;
782
- };
783
- content: {
784
- "application/json": components["schemas"]["internal_public_v1.ErrorEnvelope"];
785
- };
786
- };
787
- };
788
- };
789
- delete?: never;
790
- options?: never;
791
- head?: never;
792
- patch?: never;
793
- trace?: never;
794
- };
795
625
  "/ads-management/v1/campaigns:batchGetStatus": {
796
626
  parameters: {
797
627
  query?: never;
@@ -58068,40 +57898,9 @@ export interface components {
58068
57898
  */
58069
57899
  universeId?: string;
58070
57900
  };
58071
- "internal_public_v1.BatchGetPerformanceRequest": {
58072
- /** @description The campaign IDs to report on. Required. At most 100 per request. */
58073
- campaignIds?: string[];
58074
- /**
58075
- * @description The reporting window applied to every campaign in the batch. Optional; defaults
58076
- * to `LAST_7_DAYS`. Can be `TODAY`, `YESTERDAY`, `LAST_7_DAYS`, `LAST_30_DAYS`,
58077
- * `THIS_MONTH`, `LAST_MONTH`, `YEAR_TO_DATE`, or `PREVIOUS_YEAR`.
58078
- * @enum {string}
58079
- */
58080
- period?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "YEAR_TO_DATE" | "PREVIOUS_YEAR";
58081
- };
58082
- "internal_public_v1.BatchGetPerformanceResponse": {
58083
- /** @description The time the metrics were current, as an RFC 3339 UTC timestamp. */
58084
- dataAsOf?: string;
58085
- /** @description The last day of the window (inclusive), as YYYY-MM-DD in the account's time zone. */
58086
- endDate?: string;
58087
- /** @description The IDs that could not be resolved. Omitted when every ID resolved. */
58088
- failures?: components["schemas"]["internal_public_v1.CampaignIDFailure"][];
58089
- /**
58090
- * @description The reporting window applied to every campaign. Can be `TODAY`, `YESTERDAY`,
58091
- * `LAST_7_DAYS`, `LAST_30_DAYS`, `THIS_MONTH`, `LAST_MONTH`, `YEAR_TO_DATE`, or `PREVIOUS_YEAR`.
58092
- * @enum {string}
58093
- */
58094
- period?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "YEAR_TO_DATE" | "PREVIOUS_YEAR";
58095
- /** @description One entry per successfully resolved campaign. */
58096
- results?: components["schemas"]["internal_public_v1.CampaignPerformance"][];
58097
- /** @description The first day of the window (inclusive), as YYYY-MM-DD in the account's time zone. */
58098
- startDate?: string;
58099
- /** @description The IANA time zone the window and metrics are computed in. */
58100
- timeZone?: string;
58101
- };
58102
57901
  "internal_public_v1.BatchGetStatusRequest": {
58103
57902
  /** @description The campaign IDs to look up. Required. At most 100 per request. */
58104
- campaignIds?: string[];
57903
+ campaignIds: string[];
58105
57904
  };
58106
57905
  "internal_public_v1.BatchGetStatusResponse": {
58107
57906
  /** @description The IDs that could not be resolved. Omitted when every ID resolved. */
@@ -58246,11 +58045,6 @@ export interface components {
58246
58045
  paymentTypes?: ("CREDIT_CARD" | "ADS_CREDIT" | "INVOICE")[];
58247
58046
  targetingDimensions?: components["schemas"]["internal_public_v1.TargetingDimensions"];
58248
58047
  };
58249
- "internal_public_v1.CampaignPerformance": {
58250
- /** @description The campaign these metrics belong to. */
58251
- campaignId?: string;
58252
- totals?: components["schemas"]["internal_public_v1.PerformanceTotals"];
58253
- };
58254
58048
  "internal_public_v1.CampaignStatus": {
58255
58049
  /**
58256
58050
  * @description The current serving state. Can be `SERVING`, `IN_REVIEW`, `NOT_SERVING`, or `REJECTED`.
@@ -58270,28 +58064,28 @@ export interface components {
58270
58064
  "internal_public_v1.CreateCampaignRequest": {
58271
58065
  /** @description Optional bidding strategy. Only `AUTOMATED` is accepted in v1; may be omitted. */
58272
58066
  bid?: components["schemas"]["internal_public_v1.Bid"];
58273
- budget?: components["schemas"]["internal_public_v1.Budget"];
58067
+ budget: components["schemas"]["internal_public_v1.Budget"];
58274
58068
  /**
58275
58069
  * @description The Open Cloud image asset IDs to advertise, as decimal strings. Required. The
58276
58070
  * assets must already exist and be usable by the caller.
58277
58071
  */
58278
- creativeAssetIds?: string[];
58072
+ creativeAssetIds: string[];
58279
58073
  /** @description The display name of the campaign. Required. */
58280
- name?: string;
58074
+ name: string;
58281
58075
  /**
58282
58076
  * @description The advertising goal. Required. Only `ENGAGEMENT` is supported in v1.
58283
58077
  * @enum {string}
58284
58078
  */
58285
- objective?: "ENGAGEMENT";
58079
+ objective: "ENGAGEMENT";
58286
58080
  /**
58287
58081
  * @description How the campaign is paid for. Required. Can be `CREDIT_CARD`, `ADS_CREDIT`, or
58288
58082
  * `INVOICE`, subject to what the billing account supports.
58289
58083
  * @enum {string}
58290
58084
  */
58291
- paymentType?: "CREDIT_CARD" | "ADS_CREDIT" | "INVOICE";
58292
- schedule?: components["schemas"]["internal_public_v1.Schedule"];
58085
+ paymentType: "CREDIT_CARD" | "ADS_CREDIT" | "INVOICE";
58086
+ schedule: components["schemas"]["internal_public_v1.Schedule"];
58293
58087
  /** @description The identifier of the experience to advertise. Required. */
58294
- targetUniverseId?: string;
58088
+ targetUniverseId: string;
58295
58089
  /** @description Optional audience targeting. Omit it, or send an empty object, to reach all audiences. */
58296
58090
  targeting?: components["schemas"]["internal_public_v1.Targeting"];
58297
58091
  };
@@ -58377,43 +58171,6 @@ export interface components {
58377
58171
  */
58378
58172
  nextPageToken?: string;
58379
58173
  };
58380
- "internal_public_v1.PerformanceResponse": {
58381
- /** @description The campaign these metrics belong to. */
58382
- campaignId?: string;
58383
- /** @description The time the metrics were current, as an RFC 3339 UTC timestamp. */
58384
- dataAsOf?: string;
58385
- /** @description The last day of the window (inclusive), as YYYY-MM-DD in the account's time zone. */
58386
- endDate?: string;
58387
- /**
58388
- * @description The reporting window applied. Can be `TODAY`, `YESTERDAY`, `LAST_7_DAYS`,
58389
- * `LAST_30_DAYS`, `THIS_MONTH`, `LAST_MONTH`, `YEAR_TO_DATE`, or `PREVIOUS_YEAR`.
58390
- * @enum {string}
58391
- */
58392
- period?: "TODAY" | "YESTERDAY" | "LAST_7_DAYS" | "LAST_30_DAYS" | "THIS_MONTH" | "LAST_MONTH" | "YEAR_TO_DATE" | "PREVIOUS_YEAR";
58393
- /** @description The first day of the window (inclusive), as YYYY-MM-DD in the account's time zone. */
58394
- startDate?: string;
58395
- /** @description The IANA time zone the window and metrics are computed in. */
58396
- timeZone?: string;
58397
- totals?: components["schemas"]["internal_public_v1.PerformanceTotals"];
58398
- };
58399
- "internal_public_v1.PerformanceTotals": {
58400
- /** @description The number of clicks on an ad. */
58401
- clicks?: number;
58402
- /** @description Cost per 1,000 impressions in micro-USD, as a decimal string. */
58403
- cpmMicros?: string;
58404
- /** @description Cost per play in micro-USD, as a decimal string. */
58405
- cppMicros?: string;
58406
- /** @description The click-through rate: clicks divided by impressions, from 0 to 1. */
58407
- ctr?: number;
58408
- /** @description The number of times an ad was shown. */
58409
- impressions?: number;
58410
- /** @description The play rate: plays divided by impressions, from 0 to 1. */
58411
- playRate?: number;
58412
- /** @description The number of resulting experience plays. */
58413
- plays?: number;
58414
- /** @description Total spend in micro-USD, as a decimal string (for example, `5000000` = $5.00). */
58415
- spendMicros?: string;
58416
- };
58417
58174
  "internal_public_v1.PublicError": {
58418
58175
  /**
58419
58176
  * @description A stable, machine-readable error code (for example, `INVALID_ARGUMENT`,
@@ -58476,11 +58233,22 @@ export interface components {
58476
58233
  /** @description The identifier of the experience that was checked. */
58477
58234
  universeId?: string;
58478
58235
  };
58236
+ "internal_public_v1.UpdateBudget": {
58237
+ /**
58238
+ * @description The new budget amount in micro-USD, as a decimal string (for example,
58239
+ * `5000000` = $5.00). Money is sent as a string so large values keep full
58240
+ * precision in every client. Must be a numeric string of micro-USD.
58241
+ */
58242
+ amountMicros?: string;
58243
+ };
58479
58244
  "internal_public_v1.UpdateCampaignRequest": {
58480
58245
  /** @description Immutable in v1; including it returns 400. */
58481
58246
  bid?: components["schemas"]["internal_public_v1.Bid"];
58482
- /** @description A budget change. Only the amount may change; the budget type is immutable. */
58483
- budget?: components["schemas"]["internal_public_v1.Budget"];
58247
+ /**
58248
+ * @description A budget change. Only the amount is mutable; the budget type is fixed at
58249
+ * creation, so it is not part of this object. Sending `type` returns 400.
58250
+ */
58251
+ budget?: components["schemas"]["internal_public_v1.UpdateBudget"];
58484
58252
  /** @description Immutable in v1; including it returns 400. */
58485
58253
  creativeAssetIds?: string[];
58486
58254
  /** @description A new display name for the campaign. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@jacobhumston/roblox-openapi-ts",
3
- "version": "1.0.34",
3
+ "version": "1.0.35",
4
4
  "description": "An automatically updated Roblox API client based on their OpenAPI documentation.",
5
5
  "keywords": [
6
6
  "roblox",