@orlikfy/api-interfaces 6.0.2 → 6.1.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/dist/api.d.ts CHANGED
@@ -411,7 +411,11 @@ export interface paths {
411
411
  delete?: never;
412
412
  options?: never;
413
413
  head?: never;
414
- /** updateNearbyGamesAlertLocation */
414
+ /**
415
+ * updateNearbyGamesAlertLocation
416
+ * @deprecated
417
+ * @description Can be removed after update-user-location flag
418
+ */
415
419
  patch: operations["updateNearbyGamesAlertLocation"];
416
420
  trace?: never;
417
421
  };
@@ -843,6 +847,22 @@ export interface paths {
843
847
  patch?: never;
844
848
  trace?: never;
845
849
  };
850
+ "/admin/known-regions": {
851
+ parameters: {
852
+ query?: never;
853
+ header?: never;
854
+ path?: never;
855
+ cookie?: never;
856
+ };
857
+ get: operations["getKnownRegions"];
858
+ put?: never;
859
+ post?: never;
860
+ delete?: never;
861
+ options?: never;
862
+ head?: never;
863
+ patch?: never;
864
+ trace?: never;
865
+ };
846
866
  "/admin/restore-recurring-game": {
847
867
  parameters: {
848
868
  query?: never;
@@ -1700,6 +1720,38 @@ export interface paths {
1700
1720
  patch?: never;
1701
1721
  trace?: never;
1702
1722
  };
1723
+ "/kpi-snapshots/collect": {
1724
+ parameters: {
1725
+ query?: never;
1726
+ header?: never;
1727
+ path?: never;
1728
+ cookie?: never;
1729
+ };
1730
+ get?: never;
1731
+ put?: never;
1732
+ post: operations["collect"];
1733
+ delete?: never;
1734
+ options?: never;
1735
+ head?: never;
1736
+ patch?: never;
1737
+ trace?: never;
1738
+ };
1739
+ "/kpi-snapshots/backfill": {
1740
+ parameters: {
1741
+ query?: never;
1742
+ header?: never;
1743
+ path?: never;
1744
+ cookie?: never;
1745
+ };
1746
+ get?: never;
1747
+ put?: never;
1748
+ post: operations["backfill"];
1749
+ delete?: never;
1750
+ options?: never;
1751
+ head?: never;
1752
+ patch?: never;
1753
+ trace?: never;
1754
+ };
1703
1755
  }
1704
1756
  export type webhooks = Record<string, never>;
1705
1757
  export interface components {
@@ -2818,7 +2870,14 @@ export interface components {
2818
2870
  };
2819
2871
  RegionDto: {
2820
2872
  regionId: string;
2873
+ /** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
2821
2874
  name: string;
2875
+ /** @example 52.2297 */
2876
+ lat: number;
2877
+ /** @example 21.0122 */
2878
+ lng: number;
2879
+ /** @example 15 */
2880
+ radiusKm: number;
2822
2881
  };
2823
2882
  AdminUserDto: {
2824
2883
  userId: string;
@@ -2856,10 +2915,12 @@ export interface components {
2856
2915
  count: number;
2857
2916
  };
2858
2917
  RegionUserStatsDto: {
2918
+ /** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
2859
2919
  regionName: string;
2860
2920
  userCount: number;
2861
2921
  };
2862
2922
  RegionDailyRegistrationsDto: {
2923
+ /** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
2863
2924
  regionName: string;
2864
2925
  dailyRegistrations: components["schemas"]["DailyStatsDto"][];
2865
2926
  };
@@ -2950,10 +3011,12 @@ export interface components {
2950
3011
  gamesByLocationMessage: string;
2951
3012
  };
2952
3013
  RegionGameStatsDto: {
3014
+ /** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
2953
3015
  regionName: string;
2954
3016
  gameCount: number;
2955
3017
  };
2956
3018
  RegionDailyGamesStatsDto: {
3019
+ /** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
2957
3020
  regionName: string;
2958
3021
  dailyStats: components["schemas"]["DailyStatsDto"][];
2959
3022
  };
@@ -2972,6 +3035,9 @@ export interface components {
2972
3035
  GetKnownCitiesForPostDto: {
2973
3036
  knownCities: string[];
2974
3037
  };
3038
+ GetKnownRegionsDto: {
3039
+ knownRegions: components["schemas"]["RegionDto"][];
3040
+ };
2975
3041
  RestoreRecurringGameDto: {
2976
3042
  /**
2977
3043
  * @description ID of the abandoned recurring game to restore
@@ -3374,6 +3440,7 @@ export type RegionGameStatsDto = components['schemas']['RegionGameStatsDto'];
3374
3440
  export type RegionDailyGamesStatsDto = components['schemas']['RegionDailyGamesStatsDto'];
3375
3441
  export type GetAdminGamesStatsDto = components['schemas']['GetAdminGamesStatsDto'];
3376
3442
  export type GetKnownCitiesForPostDto = components['schemas']['GetKnownCitiesForPostDto'];
3443
+ export type GetKnownRegionsDto = components['schemas']['GetKnownRegionsDto'];
3377
3444
  export type RestoreRecurringGameDto = components['schemas']['RestoreRecurringGameDto'];
3378
3445
  export type RestoreRecurringGameResponseDto = components['schemas']['RestoreRecurringGameResponseDto'];
3379
3446
  export type PostCustomNotificationDto = components['schemas']['PostCustomNotificationDto'];
@@ -5397,6 +5464,8 @@ export interface operations {
5397
5464
  visibility?: components["schemas"]["GameVisibility"];
5398
5465
  /** @description Filter by city name */
5399
5466
  city?: string;
5467
+ /** @description Filter by region name */
5468
+ region?: string;
5400
5469
  };
5401
5470
  header?: {
5402
5471
  /** @description Request trace id for logs */
@@ -5551,6 +5620,41 @@ export interface operations {
5551
5620
  };
5552
5621
  };
5553
5622
  };
5623
+ getKnownRegions: {
5624
+ parameters: {
5625
+ query?: never;
5626
+ header?: {
5627
+ /** @description Request trace id for logs */
5628
+ "x-trace-request-id"?: string;
5629
+ /** @description Session trace id for logs */
5630
+ "x-trace-session-id"?: string;
5631
+ /** @description IANA Timezone */
5632
+ "x-timezone"?: string;
5633
+ };
5634
+ path?: never;
5635
+ cookie?: never;
5636
+ };
5637
+ requestBody?: never;
5638
+ responses: {
5639
+ 200: {
5640
+ headers: {
5641
+ [name: string]: unknown;
5642
+ };
5643
+ content: {
5644
+ "application/json": components["schemas"]["GetKnownRegionsDto"];
5645
+ };
5646
+ };
5647
+ /** @description Application Error */
5648
+ 500: {
5649
+ headers: {
5650
+ [name: string]: unknown;
5651
+ };
5652
+ content: {
5653
+ "application/json": components["schemas"]["ErrorResponse"];
5654
+ };
5655
+ };
5656
+ };
5657
+ };
5554
5658
  restoreRecurringGame: {
5555
5659
  parameters: {
5556
5660
  query?: never;
@@ -7489,6 +7593,78 @@ export interface operations {
7489
7593
  };
7490
7594
  };
7491
7595
  };
7596
+ collect: {
7597
+ parameters: {
7598
+ query: {
7599
+ "api-key": string;
7600
+ };
7601
+ header?: {
7602
+ /** @description Request trace id for logs */
7603
+ "x-trace-request-id"?: string;
7604
+ /** @description Session trace id for logs */
7605
+ "x-trace-session-id"?: string;
7606
+ /** @description IANA Timezone */
7607
+ "x-timezone"?: string;
7608
+ };
7609
+ path?: never;
7610
+ cookie?: never;
7611
+ };
7612
+ requestBody?: never;
7613
+ responses: {
7614
+ 201: {
7615
+ headers: {
7616
+ [name: string]: unknown;
7617
+ };
7618
+ content?: never;
7619
+ };
7620
+ /** @description Application Error */
7621
+ 500: {
7622
+ headers: {
7623
+ [name: string]: unknown;
7624
+ };
7625
+ content: {
7626
+ "application/json": components["schemas"]["ErrorResponse"];
7627
+ };
7628
+ };
7629
+ };
7630
+ };
7631
+ backfill: {
7632
+ parameters: {
7633
+ query: {
7634
+ "api-key": string;
7635
+ fromDate: string;
7636
+ toDate: string;
7637
+ };
7638
+ header?: {
7639
+ /** @description Request trace id for logs */
7640
+ "x-trace-request-id"?: string;
7641
+ /** @description Session trace id for logs */
7642
+ "x-trace-session-id"?: string;
7643
+ /** @description IANA Timezone */
7644
+ "x-timezone"?: string;
7645
+ };
7646
+ path?: never;
7647
+ cookie?: never;
7648
+ };
7649
+ requestBody?: never;
7650
+ responses: {
7651
+ 201: {
7652
+ headers: {
7653
+ [name: string]: unknown;
7654
+ };
7655
+ content?: never;
7656
+ };
7657
+ /** @description Application Error */
7658
+ 500: {
7659
+ headers: {
7660
+ [name: string]: unknown;
7661
+ };
7662
+ content: {
7663
+ "application/json": components["schemas"]["ErrorResponse"];
7664
+ };
7665
+ };
7666
+ };
7667
+ };
7492
7668
  }
7493
7669
  export declare enum KnownException {
7494
7670
  UserBanned = "UserBanned",
@@ -7788,6 +7964,7 @@ export declare enum ApiPaths {
7788
7964
  getGamesForPost = "/admin/games-for-post",
7789
7965
  getGamesStats = "/admin/games/stats",
7790
7966
  getKnownCitiesForPost = "/admin/known-cities",
7967
+ getKnownRegions = "/admin/known-regions",
7791
7968
  restoreRecurringGame = "/admin/restore-recurring-game",
7792
7969
  removeOldGameChats = "/admin/adhoc/remove-old-game-chats",
7793
7970
  emitGameUpdated = "/admin/adhoc/emit-game-updated",
@@ -7841,5 +8018,7 @@ export declare enum ApiPaths {
7841
8018
  generateReassignToken = "/hosted-games/{hostedGameId}/reassign/create-reassign-token",
7842
8019
  reassignGameByToken = "/hosted-games/{hostedGameId}/reassign/{reassignToken}",
7843
8020
  triggerInactiveUsersNotification = "/action-push/inactive-users-since-registered-notification",
7844
- triggerInactiveWithoutGameApplications = "/action-push/inactive-users-notification"
8021
+ triggerInactiveWithoutGameApplications = "/action-push/inactive-users-notification",
8022
+ collect = "/kpi-snapshots/collect",
8023
+ backfill = "/kpi-snapshots/backfill"
7845
8024
  }
package/dist/api.js CHANGED
@@ -330,6 +330,7 @@ var ApiPaths;
330
330
  ApiPaths["getGamesForPost"] = "/admin/games-for-post";
331
331
  ApiPaths["getGamesStats"] = "/admin/games/stats";
332
332
  ApiPaths["getKnownCitiesForPost"] = "/admin/known-cities";
333
+ ApiPaths["getKnownRegions"] = "/admin/known-regions";
333
334
  ApiPaths["restoreRecurringGame"] = "/admin/restore-recurring-game";
334
335
  ApiPaths["removeOldGameChats"] = "/admin/adhoc/remove-old-game-chats";
335
336
  ApiPaths["emitGameUpdated"] = "/admin/adhoc/emit-game-updated";
@@ -384,4 +385,6 @@ var ApiPaths;
384
385
  ApiPaths["reassignGameByToken"] = "/hosted-games/{hostedGameId}/reassign/{reassignToken}";
385
386
  ApiPaths["triggerInactiveUsersNotification"] = "/action-push/inactive-users-since-registered-notification";
386
387
  ApiPaths["triggerInactiveWithoutGameApplications"] = "/action-push/inactive-users-notification";
388
+ ApiPaths["collect"] = "/kpi-snapshots/collect";
389
+ ApiPaths["backfill"] = "/kpi-snapshots/backfill";
387
390
  })(ApiPaths || (exports.ApiPaths = ApiPaths = {}));
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orlikfy/api-interfaces",
3
- "version": "6.0.2",
3
+ "version": "6.1.0",
4
4
  "description": "",
5
5
  "license": "ISC",
6
6
  "author": "kruligh",