@orlikfy/api-interfaces 6.1.9 → 6.1.11

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/README.md CHANGED
@@ -2,6 +2,11 @@
2
2
 
3
3
  TypeScript interfaces generated from the Orlikfy backend OpenAPI specification.
4
4
 
5
+ # Changelog
6
+
7
+ v6.1.11 - private games on map - added query param
8
+ v6.1.10 - notification preferences, optional price in alerts
9
+
5
10
  ## Publishing New Version
6
11
 
7
12
  ### 1. Generate Latest OpenAPI Spec
package/dist/api.d.ts CHANGED
@@ -87,27 +87,6 @@ export interface paths {
87
87
  patch?: never;
88
88
  trace?: never;
89
89
  };
90
- "/nearby-games": {
91
- parameters: {
92
- query?: never;
93
- header?: never;
94
- path?: never;
95
- cookie?: never;
96
- };
97
- /**
98
- * getNearbyGamesByLocation
99
- * @deprecated
100
- * @description Use /location instead
101
- */
102
- get: operations["getNearbyGamesDeprecated"];
103
- put?: never;
104
- post?: never;
105
- delete?: never;
106
- options?: never;
107
- head?: never;
108
- patch?: never;
109
- trace?: never;
110
- };
111
90
  "/nearby-games/locations": {
112
91
  parameters: {
113
92
  query?: never;
@@ -1411,6 +1390,40 @@ export interface paths {
1411
1390
  patch?: never;
1412
1391
  trace?: never;
1413
1392
  };
1393
+ "/notifications/preferences": {
1394
+ parameters: {
1395
+ query?: never;
1396
+ header?: never;
1397
+ path?: never;
1398
+ cookie?: never;
1399
+ };
1400
+ get: operations["getPreferences"];
1401
+ put?: never;
1402
+ post?: never;
1403
+ delete?: never;
1404
+ options?: never;
1405
+ head?: never;
1406
+ patch?: never;
1407
+ trace?: never;
1408
+ };
1409
+ "/notifications/preferences/{category}": {
1410
+ parameters: {
1411
+ query?: never;
1412
+ header?: never;
1413
+ path: {
1414
+ category: string;
1415
+ };
1416
+ cookie?: never;
1417
+ };
1418
+ get?: never;
1419
+ put?: never;
1420
+ post?: never;
1421
+ delete?: never;
1422
+ options?: never;
1423
+ head?: never;
1424
+ patch: operations["togglePreference"];
1425
+ trace?: never;
1426
+ };
1414
1427
  "/rating/app": {
1415
1428
  parameters: {
1416
1429
  query?: never;
@@ -1906,6 +1919,7 @@ export interface components {
1906
1919
  thumbnail: string | null;
1907
1920
  phone: string | null;
1908
1921
  rating: components["schemas"]["HostRatingDto"];
1922
+ isAnonymous: boolean;
1909
1923
  lastActive: string | null;
1910
1924
  };
1911
1925
  /** @enum {string} */
@@ -1998,6 +2012,7 @@ export interface components {
1998
2012
  thumbnail: string | null;
1999
2013
  phone: string | null;
2000
2014
  rating: components["schemas"]["HostRatingDto"];
2015
+ isAnonymous: boolean;
2001
2016
  };
2002
2017
  CommonGameDto: {
2003
2018
  gameId: string;
@@ -2203,7 +2218,7 @@ export interface components {
2203
2218
  isEnabled: boolean;
2204
2219
  coordinates?: components["schemas"]["CoordinatesDto"] | null;
2205
2220
  maxDistanceMeters: number;
2206
- price: components["schemas"]["AlertPriceDto"];
2221
+ price?: components["schemas"]["AlertPriceDto"];
2207
2222
  time: components["schemas"]["AlertTimeDto"];
2208
2223
  gameLevel: components["schemas"]["gameLevelEnum"][];
2209
2224
  /** @description If empty then all */
@@ -3286,6 +3301,25 @@ export interface components {
3286
3301
  UpdateTeamMemberDto: {
3287
3302
  isAutoApproved: boolean;
3288
3303
  };
3304
+ NotificationPreferenceCategoryResponseDto: {
3305
+ /** @enum {string} */
3306
+ category: NotificationPreferenceCategoryResponseDtoCategory;
3307
+ label: string;
3308
+ description: string;
3309
+ enabled: boolean;
3310
+ editable: boolean;
3311
+ };
3312
+ GetNotificationPreferencesResponseDto: {
3313
+ categories: components["schemas"]["NotificationPreferenceCategoryResponseDto"][];
3314
+ };
3315
+ ToggleNotificationPreferenceBodyDto: {
3316
+ enabled: boolean;
3317
+ };
3318
+ ToggleNotificationPreferenceResponseDto: {
3319
+ /** @enum {string} */
3320
+ category: ToggleNotificationPreferenceResponseDtoCategory;
3321
+ enabled: boolean;
3322
+ };
3289
3323
  CreateAppRatingDto: {
3290
3324
  /**
3291
3325
  * @deprecated
@@ -3597,6 +3631,10 @@ export type TeamMemberCandidateDto = components['schemas']['TeamMemberCandidateD
3597
3631
  export type GetTeamMemberCandidatesDto = components['schemas']['GetTeamMemberCandidatesDto'];
3598
3632
  export type CreateTeamMembersDto = components['schemas']['CreateTeamMembersDto'];
3599
3633
  export type UpdateTeamMemberDto = components['schemas']['UpdateTeamMemberDto'];
3634
+ export type NotificationPreferenceCategoryResponseDto = components['schemas']['NotificationPreferenceCategoryResponseDto'];
3635
+ export type GetNotificationPreferencesResponseDto = components['schemas']['GetNotificationPreferencesResponseDto'];
3636
+ export type ToggleNotificationPreferenceBodyDto = components['schemas']['ToggleNotificationPreferenceBodyDto'];
3637
+ export type ToggleNotificationPreferenceResponseDto = components['schemas']['ToggleNotificationPreferenceResponseDto'];
3600
3638
  export type CreateAppRatingDto = components['schemas']['CreateAppRatingDto'];
3601
3639
  export type CreateContactMessageDto = components['schemas']['CreateContactMessageDto'];
3602
3640
  export type UserProfileStatsDto = components['schemas']['UserProfileStatsDto'];
@@ -3795,49 +3833,6 @@ export interface operations {
3795
3833
  };
3796
3834
  };
3797
3835
  };
3798
- getNearbyGamesDeprecated: {
3799
- parameters: {
3800
- query?: {
3801
- longitude?: string;
3802
- latitude?: string;
3803
- maxDistanceMeters?: string;
3804
- gameLevel?: components["schemas"]["gameLevelEnum"][];
3805
- locationType?: components["schemas"]["AppGameLocationType"][];
3806
- specificDate?: string;
3807
- /** @description Show private games, available only for admins. */
3808
- showPrivate?: string;
3809
- };
3810
- header: {
3811
- "x-timezone": string;
3812
- /** @description Request trace id for logs */
3813
- "x-trace-request-id"?: string;
3814
- /** @description Session trace id for logs */
3815
- "x-trace-session-id"?: string;
3816
- };
3817
- path?: never;
3818
- cookie?: never;
3819
- };
3820
- requestBody?: never;
3821
- responses: {
3822
- 200: {
3823
- headers: {
3824
- [name: string]: unknown;
3825
- };
3826
- content: {
3827
- "application/json": components["schemas"]["NearbyGamesByLocationDto"];
3828
- };
3829
- };
3830
- /** @description Application Error */
3831
- 500: {
3832
- headers: {
3833
- [name: string]: unknown;
3834
- };
3835
- content: {
3836
- "application/json": components["schemas"]["ErrorResponse"];
3837
- };
3838
- };
3839
- };
3840
- };
3841
3836
  getNearbyGamesByLocation: {
3842
3837
  parameters: {
3843
3838
  query?: {
@@ -3849,6 +3844,8 @@ export interface operations {
3849
3844
  specificDate?: string;
3850
3845
  /** @description Show private games, available only for admins. */
3851
3846
  showPrivate?: string;
3847
+ /** @description Show private games with anonymized host data. Private games without user relation will have host info blurred. */
3848
+ showPrivateBlurred?: string;
3852
3849
  };
3853
3850
  header: {
3854
3851
  "x-timezone": string;
@@ -3892,6 +3889,8 @@ export interface operations {
3892
3889
  specificDate?: string;
3893
3890
  /** @description Show private games, available only for admins. */
3894
3891
  showPrivate?: string;
3892
+ /** @description Show private games with anonymized host data. Private games without user relation will have host info blurred. */
3893
+ showPrivateBlurred?: string;
3895
3894
  };
3896
3895
  header: {
3897
3896
  "x-timezone": string;
@@ -3935,6 +3934,8 @@ export interface operations {
3935
3934
  specificDate?: string;
3936
3935
  /** @description Show private games, available only for admins. */
3937
3936
  showPrivate?: string;
3937
+ /** @description Show private games with anonymized host data. Private games without user relation will have host info blurred. */
3938
+ showPrivateBlurred?: string;
3938
3939
  };
3939
3940
  header: {
3940
3941
  "x-timezone": string;
@@ -7115,6 +7116,64 @@ export interface operations {
7115
7116
  };
7116
7117
  };
7117
7118
  };
7119
+ getPreferences: {
7120
+ parameters: {
7121
+ query?: never;
7122
+ header?: {
7123
+ /** @description Request trace id for logs */
7124
+ "x-trace-request-id"?: string;
7125
+ /** @description Session trace id for logs */
7126
+ "x-trace-session-id"?: string;
7127
+ /** @description IANA Timezone */
7128
+ "x-timezone"?: string;
7129
+ };
7130
+ path?: never;
7131
+ cookie?: never;
7132
+ };
7133
+ requestBody?: never;
7134
+ responses: {
7135
+ 200: {
7136
+ headers: {
7137
+ [name: string]: unknown;
7138
+ };
7139
+ content: {
7140
+ "application/json": components["schemas"]["GetNotificationPreferencesResponseDto"];
7141
+ };
7142
+ };
7143
+ };
7144
+ };
7145
+ togglePreference: {
7146
+ parameters: {
7147
+ query?: never;
7148
+ header?: {
7149
+ /** @description Request trace id for logs */
7150
+ "x-trace-request-id"?: string;
7151
+ /** @description Session trace id for logs */
7152
+ "x-trace-session-id"?: string;
7153
+ /** @description IANA Timezone */
7154
+ "x-timezone"?: string;
7155
+ };
7156
+ path: {
7157
+ category: string;
7158
+ };
7159
+ cookie?: never;
7160
+ };
7161
+ requestBody: {
7162
+ content: {
7163
+ "application/json": components["schemas"]["ToggleNotificationPreferenceBodyDto"];
7164
+ };
7165
+ };
7166
+ responses: {
7167
+ 200: {
7168
+ headers: {
7169
+ [name: string]: unknown;
7170
+ };
7171
+ content: {
7172
+ "application/json": components["schemas"]["ToggleNotificationPreferenceResponseDto"];
7173
+ };
7174
+ };
7175
+ };
7176
+ };
7118
7177
  createRating: {
7119
7178
  parameters: {
7120
7179
  query?: never;
@@ -8056,7 +8115,9 @@ export declare enum KnownException {
8056
8115
  CannotCreateMultipleTeams = "CannotCreateMultipleTeams",
8057
8116
  NotTheHostOfTeam = "NotTheHostOfTeam",
8058
8117
  UserPenaltyAlreadyRevoked = "UserPenaltyAlreadyRevoked",
8059
- NotAParticipantOfGame = "NotAParticipantOfGame"
8118
+ NotAParticipantOfGame = "NotAParticipantOfGame",
8119
+ CategoryNotEditable = "CategoryNotEditable",
8120
+ UnknownNotificationCategory = "UnknownNotificationCategory"
8060
8121
  }
8061
8122
  export declare enum Visibility {
8062
8123
  PUBLIC = "PUBLIC",
@@ -8255,6 +8316,32 @@ export declare enum MemberRole {
8255
8316
  Moderator = "Moderator",
8256
8317
  Member = "Member"
8257
8318
  }
8319
+ export declare enum NotificationPreferenceCategoryResponseDtoCategory {
8320
+ YOUR_GAMES = "YOUR_GAMES",
8321
+ GAMES_YOU_ORGANIZE = "GAMES_YOU_ORGANIZE",
8322
+ INVITATIONS = "INVITATIONS",
8323
+ CHAT = "CHAT",
8324
+ REMINDERS = "REMINDERS",
8325
+ COMMUNITY = "COMMUNITY",
8326
+ PENALTIES_AND_COMMENTS = "PENALTIES_AND_COMMENTS",
8327
+ ACHIEVEMENTS = "ACHIEVEMENTS",
8328
+ TEAMS = "TEAMS",
8329
+ TIPS_AND_SUGGESTIONS = "TIPS_AND_SUGGESTIONS",
8330
+ ALERTY = "ALERTY"
8331
+ }
8332
+ export declare enum ToggleNotificationPreferenceResponseDtoCategory {
8333
+ YOUR_GAMES = "YOUR_GAMES",
8334
+ GAMES_YOU_ORGANIZE = "GAMES_YOU_ORGANIZE",
8335
+ INVITATIONS = "INVITATIONS",
8336
+ CHAT = "CHAT",
8337
+ REMINDERS = "REMINDERS",
8338
+ COMMUNITY = "COMMUNITY",
8339
+ PENALTIES_AND_COMMENTS = "PENALTIES_AND_COMMENTS",
8340
+ ACHIEVEMENTS = "ACHIEVEMENTS",
8341
+ TEAMS = "TEAMS",
8342
+ TIPS_AND_SUGGESTIONS = "TIPS_AND_SUGGESTIONS",
8343
+ ALERTY = "ALERTY"
8344
+ }
8258
8345
  export declare enum CommentTypeEnum {
8259
8346
  GOOD_PLAYER = "GOOD_PLAYER",
8260
8347
  FAIR_PLAY = "FAIR_PLAY",
@@ -8290,7 +8377,6 @@ export declare enum ApiPaths {
8290
8377
  getErrorUncaught = "/error-uncaught",
8291
8378
  postUserRegistration = "/users/user-registered-cloud-fn-callback",
8292
8379
  getGameById = "/games/{gameId}",
8293
- getNearbyGamesDeprecated = "/nearby-games",
8294
8380
  getNearbyGamesByLocation = "/nearby-games/locations",
8295
8381
  getNearbyGamesList = "/nearby-games/list",
8296
8382
  getLocationGames = "/location/{locationId}/games",
@@ -8379,6 +8465,8 @@ export declare enum ApiPaths {
8379
8465
  leave = "/teams/{teamId}/member/me",
8380
8466
  acceptTeamInvitation = "/teams/{teamId}/invitations/accept",
8381
8467
  processScheduledNotification = "/game-notifications/scheduled-notification",
8468
+ getPreferences = "/notifications/preferences",
8469
+ togglePreference = "/notifications/preferences/{category}",
8382
8470
  createRating = "/rating/app",
8383
8471
  createContactMessage = "/contact/message",
8384
8472
  triggerNotificationsForGameFinished = "/game-notifications/game-finished",
package/dist/api.js CHANGED
@@ -4,7 +4,7 @@
4
4
  * Do not make direct changes to the file.
5
5
  */
6
6
  Object.defineProperty(exports, "__esModule", { value: true });
7
- exports.ApiPaths = exports.AuthProvider = exports.AppTrophyType = exports.CommentTypeEnum = exports.MemberRole = exports.GameVisibility = exports.AdminGameTypeFilter = exports.UserRoleEnum = exports.ArrivalType = exports.NotificationTypes = exports.CustomNotificationType = exports.ChatChannelType = exports.NotificationType = exports.PenaltyReason = exports.PenaltyType = exports.AppGameLevel = exports.AppLanguage = exports.AppProfileType = exports.Weekday = exports.GameLevelEnum = exports.AppGameLocationType = exports.AppPreferredPlayerPosition = exports.UserParticipationStatus = exports.Level = exports.PaymentTypes = exports.PriceCurrency = exports.Visibility = exports.KnownException = void 0;
7
+ exports.ApiPaths = exports.AuthProvider = exports.AppTrophyType = exports.CommentTypeEnum = exports.ToggleNotificationPreferenceResponseDtoCategory = exports.NotificationPreferenceCategoryResponseDtoCategory = exports.MemberRole = exports.GameVisibility = exports.AdminGameTypeFilter = exports.UserRoleEnum = exports.ArrivalType = exports.NotificationTypes = exports.CustomNotificationType = exports.ChatChannelType = exports.NotificationType = exports.PenaltyReason = exports.PenaltyType = exports.AppGameLevel = exports.AppLanguage = exports.AppProfileType = exports.Weekday = exports.GameLevelEnum = exports.AppGameLocationType = exports.AppPreferredPlayerPosition = exports.UserParticipationStatus = exports.Level = exports.PaymentTypes = exports.PriceCurrency = exports.Visibility = exports.KnownException = void 0;
8
8
  var KnownException;
9
9
  (function (KnownException) {
10
10
  KnownException["UserBanned"] = "UserBanned";
@@ -37,6 +37,8 @@ var KnownException;
37
37
  KnownException["NotTheHostOfTeam"] = "NotTheHostOfTeam";
38
38
  KnownException["UserPenaltyAlreadyRevoked"] = "UserPenaltyAlreadyRevoked";
39
39
  KnownException["NotAParticipantOfGame"] = "NotAParticipantOfGame";
40
+ KnownException["CategoryNotEditable"] = "CategoryNotEditable";
41
+ KnownException["UnknownNotificationCategory"] = "UnknownNotificationCategory";
40
42
  })(KnownException || (exports.KnownException = KnownException = {}));
41
43
  var Visibility;
42
44
  (function (Visibility) {
@@ -258,6 +260,34 @@ var MemberRole;
258
260
  MemberRole["Moderator"] = "Moderator";
259
261
  MemberRole["Member"] = "Member";
260
262
  })(MemberRole || (exports.MemberRole = MemberRole = {}));
263
+ var NotificationPreferenceCategoryResponseDtoCategory;
264
+ (function (NotificationPreferenceCategoryResponseDtoCategory) {
265
+ NotificationPreferenceCategoryResponseDtoCategory["YOUR_GAMES"] = "YOUR_GAMES";
266
+ NotificationPreferenceCategoryResponseDtoCategory["GAMES_YOU_ORGANIZE"] = "GAMES_YOU_ORGANIZE";
267
+ NotificationPreferenceCategoryResponseDtoCategory["INVITATIONS"] = "INVITATIONS";
268
+ NotificationPreferenceCategoryResponseDtoCategory["CHAT"] = "CHAT";
269
+ NotificationPreferenceCategoryResponseDtoCategory["REMINDERS"] = "REMINDERS";
270
+ NotificationPreferenceCategoryResponseDtoCategory["COMMUNITY"] = "COMMUNITY";
271
+ NotificationPreferenceCategoryResponseDtoCategory["PENALTIES_AND_COMMENTS"] = "PENALTIES_AND_COMMENTS";
272
+ NotificationPreferenceCategoryResponseDtoCategory["ACHIEVEMENTS"] = "ACHIEVEMENTS";
273
+ NotificationPreferenceCategoryResponseDtoCategory["TEAMS"] = "TEAMS";
274
+ NotificationPreferenceCategoryResponseDtoCategory["TIPS_AND_SUGGESTIONS"] = "TIPS_AND_SUGGESTIONS";
275
+ NotificationPreferenceCategoryResponseDtoCategory["ALERTY"] = "ALERTY";
276
+ })(NotificationPreferenceCategoryResponseDtoCategory || (exports.NotificationPreferenceCategoryResponseDtoCategory = NotificationPreferenceCategoryResponseDtoCategory = {}));
277
+ var ToggleNotificationPreferenceResponseDtoCategory;
278
+ (function (ToggleNotificationPreferenceResponseDtoCategory) {
279
+ ToggleNotificationPreferenceResponseDtoCategory["YOUR_GAMES"] = "YOUR_GAMES";
280
+ ToggleNotificationPreferenceResponseDtoCategory["GAMES_YOU_ORGANIZE"] = "GAMES_YOU_ORGANIZE";
281
+ ToggleNotificationPreferenceResponseDtoCategory["INVITATIONS"] = "INVITATIONS";
282
+ ToggleNotificationPreferenceResponseDtoCategory["CHAT"] = "CHAT";
283
+ ToggleNotificationPreferenceResponseDtoCategory["REMINDERS"] = "REMINDERS";
284
+ ToggleNotificationPreferenceResponseDtoCategory["COMMUNITY"] = "COMMUNITY";
285
+ ToggleNotificationPreferenceResponseDtoCategory["PENALTIES_AND_COMMENTS"] = "PENALTIES_AND_COMMENTS";
286
+ ToggleNotificationPreferenceResponseDtoCategory["ACHIEVEMENTS"] = "ACHIEVEMENTS";
287
+ ToggleNotificationPreferenceResponseDtoCategory["TEAMS"] = "TEAMS";
288
+ ToggleNotificationPreferenceResponseDtoCategory["TIPS_AND_SUGGESTIONS"] = "TIPS_AND_SUGGESTIONS";
289
+ ToggleNotificationPreferenceResponseDtoCategory["ALERTY"] = "ALERTY";
290
+ })(ToggleNotificationPreferenceResponseDtoCategory || (exports.ToggleNotificationPreferenceResponseDtoCategory = ToggleNotificationPreferenceResponseDtoCategory = {}));
261
291
  var CommentTypeEnum;
262
292
  (function (CommentTypeEnum) {
263
293
  CommentTypeEnum["GOOD_PLAYER"] = "GOOD_PLAYER";
@@ -297,7 +327,6 @@ var ApiPaths;
297
327
  ApiPaths["getErrorUncaught"] = "/error-uncaught";
298
328
  ApiPaths["postUserRegistration"] = "/users/user-registered-cloud-fn-callback";
299
329
  ApiPaths["getGameById"] = "/games/{gameId}";
300
- ApiPaths["getNearbyGamesDeprecated"] = "/nearby-games";
301
330
  ApiPaths["getNearbyGamesByLocation"] = "/nearby-games/locations";
302
331
  ApiPaths["getNearbyGamesList"] = "/nearby-games/list";
303
332
  ApiPaths["getLocationGames"] = "/location/{locationId}/games";
@@ -386,6 +415,8 @@ var ApiPaths;
386
415
  ApiPaths["leave"] = "/teams/{teamId}/member/me";
387
416
  ApiPaths["acceptTeamInvitation"] = "/teams/{teamId}/invitations/accept";
388
417
  ApiPaths["processScheduledNotification"] = "/game-notifications/scheduled-notification";
418
+ ApiPaths["getPreferences"] = "/notifications/preferences";
419
+ ApiPaths["togglePreference"] = "/notifications/preferences/{category}";
389
420
  ApiPaths["createRating"] = "/rating/app";
390
421
  ApiPaths["createContactMessage"] = "/contact/message";
391
422
  ApiPaths["triggerNotificationsForGameFinished"] = "/game-notifications/game-finished";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@orlikfy/api-interfaces",
3
- "version": "6.1.9",
3
+ "version": "6.1.11",
4
4
  "description": "",
5
5
  "license": "ISC",
6
6
  "author": "kruligh",