@orlikfy/api-interfaces 6.0.1 → 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 +205 -11
- package/dist/api.js +3 -0
- package/package.json +1 -1
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
|
-
/**
|
|
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
|
};
|
|
@@ -2877,6 +2938,14 @@ export interface components {
|
|
|
2877
2938
|
AdminGameTypeFilter: AdminGameTypeFilter;
|
|
2878
2939
|
/** @enum {string} */
|
|
2879
2940
|
GameVisibility: GameVisibility;
|
|
2941
|
+
AdminGameDtoLocation: {
|
|
2942
|
+
locationId: string;
|
|
2943
|
+
name: string;
|
|
2944
|
+
coordinates: components["schemas"]["CoordinatesDto"];
|
|
2945
|
+
address: string;
|
|
2946
|
+
city: string;
|
|
2947
|
+
region: components["schemas"]["RegionDto"] | null;
|
|
2948
|
+
};
|
|
2880
2949
|
AdminGamePlayerDto: {
|
|
2881
2950
|
playerId: string;
|
|
2882
2951
|
gamePlayerId: string;
|
|
@@ -2901,7 +2970,7 @@ export interface components {
|
|
|
2901
2970
|
priceAmount: string;
|
|
2902
2971
|
priceCurrency: components["schemas"]["priceCurrency"];
|
|
2903
2972
|
level: components["schemas"]["level"];
|
|
2904
|
-
location: components["schemas"]["
|
|
2973
|
+
location: components["schemas"]["AdminGameDtoLocation"];
|
|
2905
2974
|
distanceMeters: number | null;
|
|
2906
2975
|
currentUserParticipationStatus: components["schemas"]["userParticipationStatus"];
|
|
2907
2976
|
visibility: components["schemas"]["visibility"];
|
|
@@ -2930,13 +2999,6 @@ export interface components {
|
|
|
2930
2999
|
dateFormatted: string;
|
|
2931
3000
|
games: components["schemas"]["AdminGameDto"][];
|
|
2932
3001
|
};
|
|
2933
|
-
AdminGameDtoLocation: {
|
|
2934
|
-
locationId: string;
|
|
2935
|
-
name: string;
|
|
2936
|
-
coordinates: components["schemas"]["CoordinatesDto"];
|
|
2937
|
-
address: string;
|
|
2938
|
-
city: string;
|
|
2939
|
-
};
|
|
2940
3002
|
GamesByLocation: {
|
|
2941
3003
|
location: components["schemas"]["AdminGameDtoLocation"];
|
|
2942
3004
|
games: components["schemas"]["AdminGameDto"][];
|
|
@@ -2948,6 +3010,16 @@ export interface components {
|
|
|
2948
3010
|
gamesByDateMessage: string;
|
|
2949
3011
|
gamesByLocationMessage: string;
|
|
2950
3012
|
};
|
|
3013
|
+
RegionGameStatsDto: {
|
|
3014
|
+
/** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
|
|
3015
|
+
regionName: string;
|
|
3016
|
+
gameCount: number;
|
|
3017
|
+
};
|
|
3018
|
+
RegionDailyGamesStatsDto: {
|
|
3019
|
+
/** @description Region name. "Unknown" means no known city was found in the neighbourhood — all cities are too far away. */
|
|
3020
|
+
regionName: string;
|
|
3021
|
+
dailyStats: components["schemas"]["DailyStatsDto"][];
|
|
3022
|
+
};
|
|
2951
3023
|
GetAdminGamesStatsDto: {
|
|
2952
3024
|
/** @description Daily game creation counts */
|
|
2953
3025
|
dailyGamesCreated: components["schemas"]["DailyStatsDto"][];
|
|
@@ -2955,10 +3027,17 @@ export interface components {
|
|
|
2955
3027
|
dailyApplicationsCreated: components["schemas"]["DailyStatsDto"][];
|
|
2956
3028
|
/** @description Daily game application acceptance counts */
|
|
2957
3029
|
dailyApplicationsAccepted: components["schemas"]["DailyStatsDto"][];
|
|
3030
|
+
regionStats: components["schemas"]["RegionGameStatsDto"][];
|
|
3031
|
+
regionDailyGamesCreated: components["schemas"]["RegionDailyGamesStatsDto"][];
|
|
3032
|
+
regionDailyApplicationsCreated: components["schemas"]["RegionDailyGamesStatsDto"][];
|
|
3033
|
+
regionDailyApplicationsAccepted: components["schemas"]["RegionDailyGamesStatsDto"][];
|
|
2958
3034
|
};
|
|
2959
3035
|
GetKnownCitiesForPostDto: {
|
|
2960
3036
|
knownCities: string[];
|
|
2961
3037
|
};
|
|
3038
|
+
GetKnownRegionsDto: {
|
|
3039
|
+
knownRegions: components["schemas"]["RegionDto"][];
|
|
3040
|
+
};
|
|
2962
3041
|
RestoreRecurringGameDto: {
|
|
2963
3042
|
/**
|
|
2964
3043
|
* @description ID of the abandoned recurring game to restore
|
|
@@ -3350,15 +3429,18 @@ export type DailyStatsDto = components['schemas']['DailyStatsDto'];
|
|
|
3350
3429
|
export type RegionUserStatsDto = components['schemas']['RegionUserStatsDto'];
|
|
3351
3430
|
export type RegionDailyRegistrationsDto = components['schemas']['RegionDailyRegistrationsDto'];
|
|
3352
3431
|
export type GetAdminUsersStatsDto = components['schemas']['GetAdminUsersStatsDto'];
|
|
3432
|
+
export type AdminGameDtoLocation = components['schemas']['AdminGameDtoLocation'];
|
|
3353
3433
|
export type AdminGamePlayerDto = components['schemas']['AdminGamePlayerDto'];
|
|
3354
3434
|
export type AdminGameDto = components['schemas']['AdminGameDto'];
|
|
3355
3435
|
export type AdminGamesDto = components['schemas']['AdminGamesDto'];
|
|
3356
3436
|
export type GamesByDate = components['schemas']['GamesByDate'];
|
|
3357
|
-
export type AdminGameDtoLocation = components['schemas']['AdminGameDtoLocation'];
|
|
3358
3437
|
export type GamesByLocation = components['schemas']['GamesByLocation'];
|
|
3359
3438
|
export type GetAdminGamesForPostDto = components['schemas']['GetAdminGamesForPostDto'];
|
|
3439
|
+
export type RegionGameStatsDto = components['schemas']['RegionGameStatsDto'];
|
|
3440
|
+
export type RegionDailyGamesStatsDto = components['schemas']['RegionDailyGamesStatsDto'];
|
|
3360
3441
|
export type GetAdminGamesStatsDto = components['schemas']['GetAdminGamesStatsDto'];
|
|
3361
3442
|
export type GetKnownCitiesForPostDto = components['schemas']['GetKnownCitiesForPostDto'];
|
|
3443
|
+
export type GetKnownRegionsDto = components['schemas']['GetKnownRegionsDto'];
|
|
3362
3444
|
export type RestoreRecurringGameDto = components['schemas']['RestoreRecurringGameDto'];
|
|
3363
3445
|
export type RestoreRecurringGameResponseDto = components['schemas']['RestoreRecurringGameResponseDto'];
|
|
3364
3446
|
export type PostCustomNotificationDto = components['schemas']['PostCustomNotificationDto'];
|
|
@@ -5382,6 +5464,8 @@ export interface operations {
|
|
|
5382
5464
|
visibility?: components["schemas"]["GameVisibility"];
|
|
5383
5465
|
/** @description Filter by city name */
|
|
5384
5466
|
city?: string;
|
|
5467
|
+
/** @description Filter by region name */
|
|
5468
|
+
region?: string;
|
|
5385
5469
|
};
|
|
5386
5470
|
header?: {
|
|
5387
5471
|
/** @description Request trace id for logs */
|
|
@@ -5536,6 +5620,41 @@ export interface operations {
|
|
|
5536
5620
|
};
|
|
5537
5621
|
};
|
|
5538
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
|
+
};
|
|
5539
5658
|
restoreRecurringGame: {
|
|
5540
5659
|
parameters: {
|
|
5541
5660
|
query?: never;
|
|
@@ -7474,6 +7593,78 @@ export interface operations {
|
|
|
7474
7593
|
};
|
|
7475
7594
|
};
|
|
7476
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
|
+
};
|
|
7477
7668
|
}
|
|
7478
7669
|
export declare enum KnownException {
|
|
7479
7670
|
UserBanned = "UserBanned",
|
|
@@ -7773,6 +7964,7 @@ export declare enum ApiPaths {
|
|
|
7773
7964
|
getGamesForPost = "/admin/games-for-post",
|
|
7774
7965
|
getGamesStats = "/admin/games/stats",
|
|
7775
7966
|
getKnownCitiesForPost = "/admin/known-cities",
|
|
7967
|
+
getKnownRegions = "/admin/known-regions",
|
|
7776
7968
|
restoreRecurringGame = "/admin/restore-recurring-game",
|
|
7777
7969
|
removeOldGameChats = "/admin/adhoc/remove-old-game-chats",
|
|
7778
7970
|
emitGameUpdated = "/admin/adhoc/emit-game-updated",
|
|
@@ -7826,5 +8018,7 @@ export declare enum ApiPaths {
|
|
|
7826
8018
|
generateReassignToken = "/hosted-games/{hostedGameId}/reassign/create-reassign-token",
|
|
7827
8019
|
reassignGameByToken = "/hosted-games/{hostedGameId}/reassign/{reassignToken}",
|
|
7828
8020
|
triggerInactiveUsersNotification = "/action-push/inactive-users-since-registered-notification",
|
|
7829
|
-
triggerInactiveWithoutGameApplications = "/action-push/inactive-users-notification"
|
|
8021
|
+
triggerInactiveWithoutGameApplications = "/action-push/inactive-users-notification",
|
|
8022
|
+
collect = "/kpi-snapshots/collect",
|
|
8023
|
+
backfill = "/kpi-snapshots/backfill"
|
|
7830
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 = {}));
|