@orlikfy/api-interfaces 6.0.2 → 6.1.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.
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 {
@@ -2136,6 +2188,7 @@ export interface components {
2136
2188
  gameContactPhone?: string | null;
2137
2189
  visibility?: components["schemas"]["visibility"];
2138
2190
  locationType?: components["schemas"]["AppGameLocationType"];
2191
+ teamId?: string | null;
2139
2192
  };
2140
2193
  HostedGameDtoLocation: {
2141
2194
  locationId: string;
@@ -2818,7 +2871,14 @@ export interface components {
2818
2871
  };
2819
2872
  RegionDto: {
2820
2873
  regionId: string;
2874
+ /** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
2821
2875
  name: string;
2876
+ /** @example 52.2297 */
2877
+ lat: number;
2878
+ /** @example 21.0122 */
2879
+ lng: number;
2880
+ /** @example 15 */
2881
+ radiusKm: number;
2822
2882
  };
2823
2883
  AdminUserDto: {
2824
2884
  userId: string;
@@ -2856,10 +2916,12 @@ export interface components {
2856
2916
  count: number;
2857
2917
  };
2858
2918
  RegionUserStatsDto: {
2919
+ /** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
2859
2920
  regionName: string;
2860
2921
  userCount: number;
2861
2922
  };
2862
2923
  RegionDailyRegistrationsDto: {
2924
+ /** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
2863
2925
  regionName: string;
2864
2926
  dailyRegistrations: components["schemas"]["DailyStatsDto"][];
2865
2927
  };
@@ -2950,10 +3012,12 @@ export interface components {
2950
3012
  gamesByLocationMessage: string;
2951
3013
  };
2952
3014
  RegionGameStatsDto: {
3015
+ /** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
2953
3016
  regionName: string;
2954
3017
  gameCount: number;
2955
3018
  };
2956
3019
  RegionDailyGamesStatsDto: {
3020
+ /** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
2957
3021
  regionName: string;
2958
3022
  dailyStats: components["schemas"]["DailyStatsDto"][];
2959
3023
  };
@@ -2972,6 +3036,9 @@ export interface components {
2972
3036
  GetKnownCitiesForPostDto: {
2973
3037
  knownCities: string[];
2974
3038
  };
3039
+ GetKnownRegionsDto: {
3040
+ knownRegions: components["schemas"]["RegionDto"][];
3041
+ };
2975
3042
  RestoreRecurringGameDto: {
2976
3043
  /**
2977
3044
  * @description ID of the abandoned recurring game to restore
@@ -3374,6 +3441,7 @@ export type RegionGameStatsDto = components['schemas']['RegionGameStatsDto'];
3374
3441
  export type RegionDailyGamesStatsDto = components['schemas']['RegionDailyGamesStatsDto'];
3375
3442
  export type GetAdminGamesStatsDto = components['schemas']['GetAdminGamesStatsDto'];
3376
3443
  export type GetKnownCitiesForPostDto = components['schemas']['GetKnownCitiesForPostDto'];
3444
+ export type GetKnownRegionsDto = components['schemas']['GetKnownRegionsDto'];
3377
3445
  export type RestoreRecurringGameDto = components['schemas']['RestoreRecurringGameDto'];
3378
3446
  export type RestoreRecurringGameResponseDto = components['schemas']['RestoreRecurringGameResponseDto'];
3379
3447
  export type PostCustomNotificationDto = components['schemas']['PostCustomNotificationDto'];
@@ -5397,6 +5465,8 @@ export interface operations {
5397
5465
  visibility?: components["schemas"]["GameVisibility"];
5398
5466
  /** @description Filter by city name */
5399
5467
  city?: string;
5468
+ /** @description Filter by region name */
5469
+ region?: string;
5400
5470
  };
5401
5471
  header?: {
5402
5472
  /** @description Request trace id for logs */
@@ -5551,6 +5621,41 @@ export interface operations {
5551
5621
  };
5552
5622
  };
5553
5623
  };
5624
+ getKnownRegions: {
5625
+ parameters: {
5626
+ query?: never;
5627
+ header?: {
5628
+ /** @description Request trace id for logs */
5629
+ "x-trace-request-id"?: string;
5630
+ /** @description Session trace id for logs */
5631
+ "x-trace-session-id"?: string;
5632
+ /** @description IANA Timezone */
5633
+ "x-timezone"?: string;
5634
+ };
5635
+ path?: never;
5636
+ cookie?: never;
5637
+ };
5638
+ requestBody?: never;
5639
+ responses: {
5640
+ 200: {
5641
+ headers: {
5642
+ [name: string]: unknown;
5643
+ };
5644
+ content: {
5645
+ "application/json": components["schemas"]["GetKnownRegionsDto"];
5646
+ };
5647
+ };
5648
+ /** @description Application Error */
5649
+ 500: {
5650
+ headers: {
5651
+ [name: string]: unknown;
5652
+ };
5653
+ content: {
5654
+ "application/json": components["schemas"]["ErrorResponse"];
5655
+ };
5656
+ };
5657
+ };
5658
+ };
5554
5659
  restoreRecurringGame: {
5555
5660
  parameters: {
5556
5661
  query?: never;
@@ -7489,6 +7594,78 @@ export interface operations {
7489
7594
  };
7490
7595
  };
7491
7596
  };
7597
+ collect: {
7598
+ parameters: {
7599
+ query: {
7600
+ "api-key": string;
7601
+ };
7602
+ header?: {
7603
+ /** @description Request trace id for logs */
7604
+ "x-trace-request-id"?: string;
7605
+ /** @description Session trace id for logs */
7606
+ "x-trace-session-id"?: string;
7607
+ /** @description IANA Timezone */
7608
+ "x-timezone"?: string;
7609
+ };
7610
+ path?: never;
7611
+ cookie?: never;
7612
+ };
7613
+ requestBody?: never;
7614
+ responses: {
7615
+ 201: {
7616
+ headers: {
7617
+ [name: string]: unknown;
7618
+ };
7619
+ content?: never;
7620
+ };
7621
+ /** @description Application Error */
7622
+ 500: {
7623
+ headers: {
7624
+ [name: string]: unknown;
7625
+ };
7626
+ content: {
7627
+ "application/json": components["schemas"]["ErrorResponse"];
7628
+ };
7629
+ };
7630
+ };
7631
+ };
7632
+ backfill: {
7633
+ parameters: {
7634
+ query: {
7635
+ "api-key": string;
7636
+ fromDate: string;
7637
+ toDate: string;
7638
+ };
7639
+ header?: {
7640
+ /** @description Request trace id for logs */
7641
+ "x-trace-request-id"?: string;
7642
+ /** @description Session trace id for logs */
7643
+ "x-trace-session-id"?: string;
7644
+ /** @description IANA Timezone */
7645
+ "x-timezone"?: string;
7646
+ };
7647
+ path?: never;
7648
+ cookie?: never;
7649
+ };
7650
+ requestBody?: never;
7651
+ responses: {
7652
+ 201: {
7653
+ headers: {
7654
+ [name: string]: unknown;
7655
+ };
7656
+ content?: never;
7657
+ };
7658
+ /** @description Application Error */
7659
+ 500: {
7660
+ headers: {
7661
+ [name: string]: unknown;
7662
+ };
7663
+ content: {
7664
+ "application/json": components["schemas"]["ErrorResponse"];
7665
+ };
7666
+ };
7667
+ };
7668
+ };
7492
7669
  }
7493
7670
  export declare enum KnownException {
7494
7671
  UserBanned = "UserBanned",
@@ -7515,7 +7692,10 @@ export declare enum KnownException {
7515
7692
  UserNameAndSurnameCannotBeEmpty = "UserNameAndSurnameCannotBeEmpty",
7516
7693
  UserNameAndSurnameCannotBeEmptyToCreateGame = "UserNameAndSurnameCannotBeEmptyToCreateGame",
7517
7694
  UserDisplayNameNotSet = "UserDisplayNameNotSet",
7518
- YouHaveAlreadyGivenThisComment = "YouHaveAlreadyGivenThisComment"
7695
+ YouHaveAlreadyGivenThisComment = "YouHaveAlreadyGivenThisComment",
7696
+ NotAMemberOfTeam = "NotAMemberOfTeam",
7697
+ CannotCreateMultipleTeams = "CannotCreateMultipleTeams",
7698
+ NotTheHostOfTeam = "NotTheHostOfTeam"
7519
7699
  }
7520
7700
  export declare enum Visibility {
7521
7701
  PUBLIC = "PUBLIC",
@@ -7788,6 +7968,7 @@ export declare enum ApiPaths {
7788
7968
  getGamesForPost = "/admin/games-for-post",
7789
7969
  getGamesStats = "/admin/games/stats",
7790
7970
  getKnownCitiesForPost = "/admin/known-cities",
7971
+ getKnownRegions = "/admin/known-regions",
7791
7972
  restoreRecurringGame = "/admin/restore-recurring-game",
7792
7973
  removeOldGameChats = "/admin/adhoc/remove-old-game-chats",
7793
7974
  emitGameUpdated = "/admin/adhoc/emit-game-updated",
@@ -7841,5 +8022,7 @@ export declare enum ApiPaths {
7841
8022
  generateReassignToken = "/hosted-games/{hostedGameId}/reassign/create-reassign-token",
7842
8023
  reassignGameByToken = "/hosted-games/{hostedGameId}/reassign/{reassignToken}",
7843
8024
  triggerInactiveUsersNotification = "/action-push/inactive-users-since-registered-notification",
7844
- triggerInactiveWithoutGameApplications = "/action-push/inactive-users-notification"
8025
+ triggerInactiveWithoutGameApplications = "/action-push/inactive-users-notification",
8026
+ collect = "/kpi-snapshots/collect",
8027
+ backfill = "/kpi-snapshots/backfill"
7845
8028
  }
package/dist/api.js CHANGED
@@ -32,6 +32,9 @@ var KnownException;
32
32
  KnownException["UserNameAndSurnameCannotBeEmptyToCreateGame"] = "UserNameAndSurnameCannotBeEmptyToCreateGame";
33
33
  KnownException["UserDisplayNameNotSet"] = "UserDisplayNameNotSet";
34
34
  KnownException["YouHaveAlreadyGivenThisComment"] = "YouHaveAlreadyGivenThisComment";
35
+ KnownException["NotAMemberOfTeam"] = "NotAMemberOfTeam";
36
+ KnownException["CannotCreateMultipleTeams"] = "CannotCreateMultipleTeams";
37
+ KnownException["NotTheHostOfTeam"] = "NotTheHostOfTeam";
35
38
  })(KnownException || (exports.KnownException = KnownException = {}));
36
39
  var Visibility;
37
40
  (function (Visibility) {
@@ -330,6 +333,7 @@ var ApiPaths;
330
333
  ApiPaths["getGamesForPost"] = "/admin/games-for-post";
331
334
  ApiPaths["getGamesStats"] = "/admin/games/stats";
332
335
  ApiPaths["getKnownCitiesForPost"] = "/admin/known-cities";
336
+ ApiPaths["getKnownRegions"] = "/admin/known-regions";
333
337
  ApiPaths["restoreRecurringGame"] = "/admin/restore-recurring-game";
334
338
  ApiPaths["removeOldGameChats"] = "/admin/adhoc/remove-old-game-chats";
335
339
  ApiPaths["emitGameUpdated"] = "/admin/adhoc/emit-game-updated";
@@ -384,4 +388,6 @@ var ApiPaths;
384
388
  ApiPaths["reassignGameByToken"] = "/hosted-games/{hostedGameId}/reassign/{reassignToken}";
385
389
  ApiPaths["triggerInactiveUsersNotification"] = "/action-push/inactive-users-since-registered-notification";
386
390
  ApiPaths["triggerInactiveWithoutGameApplications"] = "/action-push/inactive-users-notification";
391
+ ApiPaths["collect"] = "/kpi-snapshots/collect";
392
+ ApiPaths["backfill"] = "/kpi-snapshots/backfill";
387
393
  })(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.2",
4
4
  "description": "",
5
5
  "license": "ISC",
6
6
  "author": "kruligh",