@matchi/api 0.20260731.2 → 0.20260814.1

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.
@@ -616,7 +616,8 @@ declare namespace chatCreation {
616
616
  declare enum chatTarget {
617
617
  PLAYSESSION = "playsession",
618
618
  USERGROUP = "usergroup",
619
- AICOACH = "aicoach"
619
+ AICOACH = "aicoach",
620
+ ADMINMATCH = "adminmatch"
620
621
  }
621
622
 
622
623
  type giftCard = {
@@ -1788,12 +1789,14 @@ declare enum userChatStatusParam {
1788
1789
  * * `ALL` - Default: No filtering.
1789
1790
  * * `PLAYSESSION` - Only returns user chats where the user is a participant of a playsession chat.
1790
1791
  * * `USERGROUP` - Only returns user chats where the user is a participant of a user group chat.
1792
+ * * `ADMINMATCH` - Only returns user chats where the user is a participant of an admin match chat.
1791
1793
  *
1792
1794
  */
1793
1795
  declare enum userChatTargetParam {
1794
1796
  ALL = "ALL",
1795
1797
  PLAYSESSION = "PLAYSESSION",
1796
- USERGROUP = "USERGROUP"
1798
+ USERGROUP = "USERGROUP",
1799
+ ADMINMATCH = "ADMINMATCH"
1797
1800
  }
1798
1801
 
1799
1802
  type userFacility = {
@@ -2203,16 +2206,17 @@ declare class AuthorizedService {
2203
2206
  * * `ALL` - Default: No filtering.
2204
2207
  * * `PLAYSESSION` - Only returns user chats where the user is a participant of a playsession chat.
2205
2208
  * * `USERGROUP` - Only returns user chats where the user is a participant of a user group chat.
2209
+ * * `ADMINMATCH` - Only returns user chats where the user is a participant of an admin match chat.
2206
2210
  *
2207
2211
  * @param offset Number of items to skip before returning the results.
2208
2212
  * @param limit Maximum number of items to return.
2209
2213
  * @returns listOfChats List of user chats based on the provided filters
2210
2214
  * @throws ApiError
2211
2215
  */
2212
- static listChats(userChatStatus?: 'ALL' | 'ACTIVE' | 'INACTIVE' | 'NOT_CONNECTED', userChatTarget?: 'ALL' | 'PLAYSESSION' | 'USERGROUP', offset?: number, limit?: number): CancelablePromise<listOfChats>;
2216
+ static listChats(userChatStatus?: 'ALL' | 'ACTIVE' | 'INACTIVE' | 'NOT_CONNECTED', userChatTarget?: 'ALL' | 'PLAYSESSION' | 'USERGROUP' | 'ADMINMATCH', offset?: number, limit?: number): CancelablePromise<listOfChats>;
2213
2217
  /**
2214
- * Create a new chat for a playsession or a group of players
2215
- * @param requestBody Create chat request.
2218
+ * Create a new chat for a playsession, an admin match or a group of players
2219
+ * @param requestBody Create chat request. Only one identifier for a playsession, an admin match or a group of users is expected and required.
2216
2220
  * @returns chatCreation Successfully created chat.
2217
2221
  * @throws ApiError
2218
2222
  */
@@ -2225,6 +2229,10 @@ declare class AuthorizedService {
2225
2229
  * The ID of the play session to create a chat for
2226
2230
  */
2227
2231
  sessionId?: string;
2232
+ /**
2233
+ * The ID of the admin match to create a chat for.
2234
+ */
2235
+ adminMatchId?: string;
2228
2236
  /**
2229
2237
  * Not needed anymore. In case of target play session, the facilityId of this playsession will be used instead.
2230
2238
  * @deprecated
@@ -2247,6 +2255,24 @@ declare class AuthorizedService {
2247
2255
  }): CancelablePromise<{
2248
2256
  chatId: string;
2249
2257
  }>;
2258
+ /**
2259
+ * M2M request to add a user to the chat of a target
2260
+ * @param target The type of the target
2261
+ * @param targetId The unique target id related to the chat
2262
+ * @param userId The user to add to or remove from the chat of the target
2263
+ * @returns void
2264
+ * @throws ApiError
2265
+ */
2266
+ static adminAddChatUser(target: chatTarget, targetId: string, userId: string): CancelablePromise<void>;
2267
+ /**
2268
+ * M2M request to remove a user from the chat of a target
2269
+ * @param target The type of the target
2270
+ * @param targetId The unique target id related to the chat
2271
+ * @param userId The user to add to or remove from the chat of the target
2272
+ * @returns void
2273
+ * @throws ApiError
2274
+ */
2275
+ static adminRemoveChatUser(target: chatTarget, targetId: string, userId: string): CancelablePromise<void>;
2250
2276
  /**
2251
2277
  * Get the chat of the specified target id
2252
2278
  * @param target The type of the target
@@ -3131,16 +3157,17 @@ declare class UserServiceV1Service {
3131
3157
  * * `ALL` - Default: No filtering.
3132
3158
  * * `PLAYSESSION` - Only returns user chats where the user is a participant of a playsession chat.
3133
3159
  * * `USERGROUP` - Only returns user chats where the user is a participant of a user group chat.
3160
+ * * `ADMINMATCH` - Only returns user chats where the user is a participant of an admin match chat.
3134
3161
  *
3135
3162
  * @param offset Number of items to skip before returning the results.
3136
3163
  * @param limit Maximum number of items to return.
3137
3164
  * @returns listOfChats List of user chats based on the provided filters
3138
3165
  * @throws ApiError
3139
3166
  */
3140
- static listChats(userChatStatus?: 'ALL' | 'ACTIVE' | 'INACTIVE' | 'NOT_CONNECTED', userChatTarget?: 'ALL' | 'PLAYSESSION' | 'USERGROUP', offset?: number, limit?: number): CancelablePromise<listOfChats>;
3167
+ static listChats(userChatStatus?: 'ALL' | 'ACTIVE' | 'INACTIVE' | 'NOT_CONNECTED', userChatTarget?: 'ALL' | 'PLAYSESSION' | 'USERGROUP' | 'ADMINMATCH', offset?: number, limit?: number): CancelablePromise<listOfChats>;
3141
3168
  /**
3142
- * Create a new chat for a playsession or a group of players
3143
- * @param requestBody Create chat request.
3169
+ * Create a new chat for a playsession, an admin match or a group of players
3170
+ * @param requestBody Create chat request. Only one identifier for a playsession, an admin match or a group of users is expected and required.
3144
3171
  * @returns chatCreation Successfully created chat.
3145
3172
  * @throws ApiError
3146
3173
  */
@@ -3153,6 +3180,10 @@ declare class UserServiceV1Service {
3153
3180
  * The ID of the play session to create a chat for
3154
3181
  */
3155
3182
  sessionId?: string;
3183
+ /**
3184
+ * The ID of the admin match to create a chat for.
3185
+ */
3186
+ adminMatchId?: string;
3156
3187
  /**
3157
3188
  * Not needed anymore. In case of target play session, the facilityId of this playsession will be used instead.
3158
3189
  * @deprecated
@@ -3175,6 +3206,24 @@ declare class UserServiceV1Service {
3175
3206
  }): CancelablePromise<{
3176
3207
  chatId: string;
3177
3208
  }>;
3209
+ /**
3210
+ * M2M request to add a user to the chat of a target
3211
+ * @param target The type of the target
3212
+ * @param targetId The unique target id related to the chat
3213
+ * @param userId The user to add to or remove from the chat of the target
3214
+ * @returns void
3215
+ * @throws ApiError
3216
+ */
3217
+ static adminAddChatUser(target: chatTarget, targetId: string, userId: string): CancelablePromise<void>;
3218
+ /**
3219
+ * M2M request to remove a user from the chat of a target
3220
+ * @param target The type of the target
3221
+ * @param targetId The unique target id related to the chat
3222
+ * @param userId The user to add to or remove from the chat of the target
3223
+ * @returns void
3224
+ * @throws ApiError
3225
+ */
3226
+ static adminRemoveChatUser(target: chatTarget, targetId: string, userId: string): CancelablePromise<void>;
3178
3227
  /**
3179
3228
  * Get the chat of the specified target id
3180
3229
  * @param target The type of the target
@@ -616,7 +616,8 @@ declare namespace chatCreation {
616
616
  declare enum chatTarget {
617
617
  PLAYSESSION = "playsession",
618
618
  USERGROUP = "usergroup",
619
- AICOACH = "aicoach"
619
+ AICOACH = "aicoach",
620
+ ADMINMATCH = "adminmatch"
620
621
  }
621
622
 
622
623
  type giftCard = {
@@ -1788,12 +1789,14 @@ declare enum userChatStatusParam {
1788
1789
  * * `ALL` - Default: No filtering.
1789
1790
  * * `PLAYSESSION` - Only returns user chats where the user is a participant of a playsession chat.
1790
1791
  * * `USERGROUP` - Only returns user chats where the user is a participant of a user group chat.
1792
+ * * `ADMINMATCH` - Only returns user chats where the user is a participant of an admin match chat.
1791
1793
  *
1792
1794
  */
1793
1795
  declare enum userChatTargetParam {
1794
1796
  ALL = "ALL",
1795
1797
  PLAYSESSION = "PLAYSESSION",
1796
- USERGROUP = "USERGROUP"
1798
+ USERGROUP = "USERGROUP",
1799
+ ADMINMATCH = "ADMINMATCH"
1797
1800
  }
1798
1801
 
1799
1802
  type userFacility = {
@@ -2203,16 +2206,17 @@ declare class AuthorizedService {
2203
2206
  * * `ALL` - Default: No filtering.
2204
2207
  * * `PLAYSESSION` - Only returns user chats where the user is a participant of a playsession chat.
2205
2208
  * * `USERGROUP` - Only returns user chats where the user is a participant of a user group chat.
2209
+ * * `ADMINMATCH` - Only returns user chats where the user is a participant of an admin match chat.
2206
2210
  *
2207
2211
  * @param offset Number of items to skip before returning the results.
2208
2212
  * @param limit Maximum number of items to return.
2209
2213
  * @returns listOfChats List of user chats based on the provided filters
2210
2214
  * @throws ApiError
2211
2215
  */
2212
- static listChats(userChatStatus?: 'ALL' | 'ACTIVE' | 'INACTIVE' | 'NOT_CONNECTED', userChatTarget?: 'ALL' | 'PLAYSESSION' | 'USERGROUP', offset?: number, limit?: number): CancelablePromise<listOfChats>;
2216
+ static listChats(userChatStatus?: 'ALL' | 'ACTIVE' | 'INACTIVE' | 'NOT_CONNECTED', userChatTarget?: 'ALL' | 'PLAYSESSION' | 'USERGROUP' | 'ADMINMATCH', offset?: number, limit?: number): CancelablePromise<listOfChats>;
2213
2217
  /**
2214
- * Create a new chat for a playsession or a group of players
2215
- * @param requestBody Create chat request.
2218
+ * Create a new chat for a playsession, an admin match or a group of players
2219
+ * @param requestBody Create chat request. Only one identifier for a playsession, an admin match or a group of users is expected and required.
2216
2220
  * @returns chatCreation Successfully created chat.
2217
2221
  * @throws ApiError
2218
2222
  */
@@ -2225,6 +2229,10 @@ declare class AuthorizedService {
2225
2229
  * The ID of the play session to create a chat for
2226
2230
  */
2227
2231
  sessionId?: string;
2232
+ /**
2233
+ * The ID of the admin match to create a chat for.
2234
+ */
2235
+ adminMatchId?: string;
2228
2236
  /**
2229
2237
  * Not needed anymore. In case of target play session, the facilityId of this playsession will be used instead.
2230
2238
  * @deprecated
@@ -2247,6 +2255,24 @@ declare class AuthorizedService {
2247
2255
  }): CancelablePromise<{
2248
2256
  chatId: string;
2249
2257
  }>;
2258
+ /**
2259
+ * M2M request to add a user to the chat of a target
2260
+ * @param target The type of the target
2261
+ * @param targetId The unique target id related to the chat
2262
+ * @param userId The user to add to or remove from the chat of the target
2263
+ * @returns void
2264
+ * @throws ApiError
2265
+ */
2266
+ static adminAddChatUser(target: chatTarget, targetId: string, userId: string): CancelablePromise<void>;
2267
+ /**
2268
+ * M2M request to remove a user from the chat of a target
2269
+ * @param target The type of the target
2270
+ * @param targetId The unique target id related to the chat
2271
+ * @param userId The user to add to or remove from the chat of the target
2272
+ * @returns void
2273
+ * @throws ApiError
2274
+ */
2275
+ static adminRemoveChatUser(target: chatTarget, targetId: string, userId: string): CancelablePromise<void>;
2250
2276
  /**
2251
2277
  * Get the chat of the specified target id
2252
2278
  * @param target The type of the target
@@ -3131,16 +3157,17 @@ declare class UserServiceV1Service {
3131
3157
  * * `ALL` - Default: No filtering.
3132
3158
  * * `PLAYSESSION` - Only returns user chats where the user is a participant of a playsession chat.
3133
3159
  * * `USERGROUP` - Only returns user chats where the user is a participant of a user group chat.
3160
+ * * `ADMINMATCH` - Only returns user chats where the user is a participant of an admin match chat.
3134
3161
  *
3135
3162
  * @param offset Number of items to skip before returning the results.
3136
3163
  * @param limit Maximum number of items to return.
3137
3164
  * @returns listOfChats List of user chats based on the provided filters
3138
3165
  * @throws ApiError
3139
3166
  */
3140
- static listChats(userChatStatus?: 'ALL' | 'ACTIVE' | 'INACTIVE' | 'NOT_CONNECTED', userChatTarget?: 'ALL' | 'PLAYSESSION' | 'USERGROUP', offset?: number, limit?: number): CancelablePromise<listOfChats>;
3167
+ static listChats(userChatStatus?: 'ALL' | 'ACTIVE' | 'INACTIVE' | 'NOT_CONNECTED', userChatTarget?: 'ALL' | 'PLAYSESSION' | 'USERGROUP' | 'ADMINMATCH', offset?: number, limit?: number): CancelablePromise<listOfChats>;
3141
3168
  /**
3142
- * Create a new chat for a playsession or a group of players
3143
- * @param requestBody Create chat request.
3169
+ * Create a new chat for a playsession, an admin match or a group of players
3170
+ * @param requestBody Create chat request. Only one identifier for a playsession, an admin match or a group of users is expected and required.
3144
3171
  * @returns chatCreation Successfully created chat.
3145
3172
  * @throws ApiError
3146
3173
  */
@@ -3153,6 +3180,10 @@ declare class UserServiceV1Service {
3153
3180
  * The ID of the play session to create a chat for
3154
3181
  */
3155
3182
  sessionId?: string;
3183
+ /**
3184
+ * The ID of the admin match to create a chat for.
3185
+ */
3186
+ adminMatchId?: string;
3156
3187
  /**
3157
3188
  * Not needed anymore. In case of target play session, the facilityId of this playsession will be used instead.
3158
3189
  * @deprecated
@@ -3175,6 +3206,24 @@ declare class UserServiceV1Service {
3175
3206
  }): CancelablePromise<{
3176
3207
  chatId: string;
3177
3208
  }>;
3209
+ /**
3210
+ * M2M request to add a user to the chat of a target
3211
+ * @param target The type of the target
3212
+ * @param targetId The unique target id related to the chat
3213
+ * @param userId The user to add to or remove from the chat of the target
3214
+ * @returns void
3215
+ * @throws ApiError
3216
+ */
3217
+ static adminAddChatUser(target: chatTarget, targetId: string, userId: string): CancelablePromise<void>;
3218
+ /**
3219
+ * M2M request to remove a user from the chat of a target
3220
+ * @param target The type of the target
3221
+ * @param targetId The unique target id related to the chat
3222
+ * @param userId The user to add to or remove from the chat of the target
3223
+ * @returns void
3224
+ * @throws ApiError
3225
+ */
3226
+ static adminRemoveChatUser(target: chatTarget, targetId: string, userId: string): CancelablePromise<void>;
3178
3227
  /**
3179
3228
  * Get the chat of the specified target id
3180
3229
  * @param target The type of the target