@towns-protocol/proto 0.0.191

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.
Files changed (39) hide show
  1. package/LICENSE.txt +21 -0
  2. package/README.md +3 -0
  3. package/dist/gen/apps_pb.d.ts +438 -0
  4. package/dist/gen/apps_pb.d.ts.map +1 -0
  5. package/dist/gen/apps_pb.js +113 -0
  6. package/dist/gen/apps_pb.js.map +1 -0
  7. package/dist/gen/auth_pb.d.ts +154 -0
  8. package/dist/gen/auth_pb.d.ts.map +1 -0
  9. package/dist/gen/auth_pb.js +37 -0
  10. package/dist/gen/auth_pb.js.map +1 -0
  11. package/dist/gen/internal_pb.d.ts +82 -0
  12. package/dist/gen/internal_pb.d.ts.map +1 -0
  13. package/dist/gen/internal_pb.js +25 -0
  14. package/dist/gen/internal_pb.js.map +1 -0
  15. package/dist/gen/notifications_pb.d.ts +874 -0
  16. package/dist/gen/notifications_pb.d.ts.map +1 -0
  17. package/dist/gen/notifications_pb.js +349 -0
  18. package/dist/gen/notifications_pb.js.map +1 -0
  19. package/dist/gen/payloads_pb.d.ts +893 -0
  20. package/dist/gen/payloads_pb.d.ts.map +1 -0
  21. package/dist/gen/payloads_pb.js +180 -0
  22. package/dist/gen/payloads_pb.js.map +1 -0
  23. package/dist/gen/protocol_pb.d.ts +3972 -0
  24. package/dist/gen/protocol_pb.d.ts.map +1 -0
  25. package/dist/gen/protocol_pb.js +1158 -0
  26. package/dist/gen/protocol_pb.js.map +1 -0
  27. package/dist/index.d.ts +11 -0
  28. package/dist/index.d.ts.map +1 -0
  29. package/dist/index.js +11 -0
  30. package/dist/index.js.map +1 -0
  31. package/dist/tests/stub.test.d.ts +1 -0
  32. package/dist/tests/stub.test.d.ts.map +1 -0
  33. package/dist/tests/stub.test.js +7 -0
  34. package/dist/tests/stub.test.js.map +1 -0
  35. package/dist/types.d.ts +23 -0
  36. package/dist/types.d.ts.map +1 -0
  37. package/dist/types.js +2 -0
  38. package/dist/types.js.map +1 -0
  39. package/package.json +41 -0
@@ -0,0 +1,874 @@
1
+ import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv1";
2
+ import type { Message } from "@bufbuild/protobuf";
3
+ /**
4
+ * Describes the file notifications.proto.
5
+ */
6
+ export declare const file_notifications: GenFile;
7
+ /**
8
+ * @generated from message river.GetSettingsRequest
9
+ */
10
+ export type GetSettingsRequest = Message<"river.GetSettingsRequest"> & {};
11
+ /**
12
+ * Describes the message river.GetSettingsRequest.
13
+ * Use `create(GetSettingsRequestSchema)` to create a new message.
14
+ */
15
+ export declare const GetSettingsRequestSchema: GenMessage<GetSettingsRequest>;
16
+ /**
17
+ * @generated from message river.GetSettingsResponse
18
+ */
19
+ export type GetSettingsResponse = Message<"river.GetSettingsResponse"> & {
20
+ /**
21
+ * user id for which to retrieve settings
22
+ *
23
+ * @generated from field: bytes user_id = 1;
24
+ */
25
+ userId: Uint8Array;
26
+ /**
27
+ * space holds specific settings for spaces and channels within a space
28
+ *
29
+ * @generated from field: repeated river.SpaceSetting space = 2;
30
+ */
31
+ space: SpaceSetting[];
32
+ /**
33
+ * dm_global is the default setting that is applied to all DM channels and can be overwritten by channel specific
34
+ * settings with dm_gdm_channels.
35
+ *
36
+ * @generated from field: river.DmChannelSettingValue dm_global = 3;
37
+ */
38
+ dmGlobal: DmChannelSettingValue;
39
+ /**
40
+ * gdm_global is the default setting that is applied to all GDM channels and can be overwritten by channel specific
41
+ * settings with dm_gdm_channels.
42
+ *
43
+ * @generated from field: river.GdmChannelSettingValue gdm_global = 4;
44
+ */
45
+ gdmGlobal: GdmChannelSettingValue;
46
+ /**
47
+ * dm_channels holds specific settings for DM channels
48
+ *
49
+ * @generated from field: repeated river.DmChannelSetting dm_channels = 5;
50
+ */
51
+ dmChannels: DmChannelSetting[];
52
+ /**
53
+ * gdm_channels holds specific settings for GDM channels
54
+ *
55
+ * @generated from field: repeated river.GdmChannelSetting gdm_channels = 6;
56
+ */
57
+ gdmChannels: GdmChannelSetting[];
58
+ /**
59
+ * web_subscriptions is the list of web push subscriptions
60
+ *
61
+ * @generated from field: repeated river.WebPushSubscriptionObject web_subscriptions = 7;
62
+ */
63
+ webSubscriptions: WebPushSubscriptionObject[];
64
+ /**
65
+ * apn_subscriptions is the list of APN push subscriptions
66
+ *
67
+ * @generated from field: repeated river.APNSubscription apn_subscriptions = 8;
68
+ */
69
+ apnSubscriptions: APNSubscription[];
70
+ };
71
+ /**
72
+ * Describes the message river.GetSettingsResponse.
73
+ * Use `create(GetSettingsResponseSchema)` to create a new message.
74
+ */
75
+ export declare const GetSettingsResponseSchema: GenMessage<GetSettingsResponse>;
76
+ /**
77
+ * @generated from message river.SetSettingsRequest
78
+ */
79
+ export type SetSettingsRequest = Message<"river.SetSettingsRequest"> & {
80
+ /**
81
+ * dm_global holds the default config setting that is applied to all DM channels unless overwritten by a DM specific
82
+ * preference.
83
+ *
84
+ * @generated from field: river.DmChannelSettingValue dm_global = 1;
85
+ */
86
+ dmGlobal: DmChannelSettingValue;
87
+ /**
88
+ * dm_channels holds DM channel specific preferences that overwrite dm_global.
89
+ *
90
+ * @generated from field: repeated river.DmChannelSetting dm_channels = 2;
91
+ */
92
+ dmChannels: DmChannelSetting[];
93
+ /**
94
+ * gdm_global is the default setting that is applied to all GDM channels and can be overwritten by channel specific
95
+ * settings with dm_gdm_channels.
96
+ *
97
+ * @generated from field: river.GdmChannelSettingValue gdm_global = 3;
98
+ */
99
+ gdmGlobal: GdmChannelSettingValue;
100
+ /**
101
+ * dm_gdm_channels holds settings for GDM channels that overwrite the default setting in gdm_global.
102
+ *
103
+ * @generated from field: repeated river.GdmChannelSetting gdm_channels = 4;
104
+ */
105
+ gdmChannels: GdmChannelSetting[];
106
+ /**
107
+ * spaces holds specific settings for spaces and their channels.
108
+ *
109
+ * @generated from field: repeated river.SpaceSetting spaces = 5;
110
+ */
111
+ spaces: SpaceSetting[];
112
+ };
113
+ /**
114
+ * Describes the message river.SetSettingsRequest.
115
+ * Use `create(SetSettingsRequestSchema)` to create a new message.
116
+ */
117
+ export declare const SetSettingsRequestSchema: GenMessage<SetSettingsRequest>;
118
+ /**
119
+ * @generated from message river.SetSettingsResponse
120
+ */
121
+ export type SetSettingsResponse = Message<"river.SetSettingsResponse"> & {};
122
+ /**
123
+ * Describes the message river.SetSettingsResponse.
124
+ * Use `create(SetSettingsResponseSchema)` to create a new message.
125
+ */
126
+ export declare const SetSettingsResponseSchema: GenMessage<SetSettingsResponse>;
127
+ /**
128
+ * DmChannelSetting hold settings specific for a DM.
129
+ *
130
+ * @generated from message river.DmChannelSetting
131
+ */
132
+ export type DmChannelSetting = Message<"river.DmChannelSetting"> & {
133
+ /**
134
+ * channel_id points to the channel for which this setting applies.
135
+ *
136
+ * @generated from field: bytes channel_id = 1;
137
+ */
138
+ channelId: Uint8Array;
139
+ /**
140
+ * setting indicates if the user wants to receive notifications for the channel within the space.
141
+ *
142
+ * @generated from field: river.DmChannelSettingValue value = 2;
143
+ */
144
+ value: DmChannelSettingValue;
145
+ };
146
+ /**
147
+ * Describes the message river.DmChannelSetting.
148
+ * Use `create(DmChannelSettingSchema)` to create a new message.
149
+ */
150
+ export declare const DmChannelSettingSchema: GenMessage<DmChannelSetting>;
151
+ /**
152
+ * GdmChannelSetting hold settings specific for a GDM.
153
+ *
154
+ * @generated from message river.GdmChannelSetting
155
+ */
156
+ export type GdmChannelSetting = Message<"river.GdmChannelSetting"> & {
157
+ /**
158
+ * channel_id points to the channel for which this setting applies.
159
+ *
160
+ * @generated from field: bytes channel_id = 1;
161
+ */
162
+ channelId: Uint8Array;
163
+ /**
164
+ * setting indicates if the user wants to receive notifications for the channel.
165
+ *
166
+ * @generated from field: river.GdmChannelSettingValue value = 2;
167
+ */
168
+ value: GdmChannelSettingValue;
169
+ };
170
+ /**
171
+ * Describes the message river.GdmChannelSetting.
172
+ * Use `create(GdmChannelSettingSchema)` to create a new message.
173
+ */
174
+ export declare const GdmChannelSettingSchema: GenMessage<GdmChannelSetting>;
175
+ /**
176
+ * @generated from message river.SpaceChannelSetting
177
+ */
178
+ export type SpaceChannelSetting = Message<"river.SpaceChannelSetting"> & {
179
+ /**
180
+ * channel_id points to the channel for which this setting applies.
181
+ *
182
+ * @generated from field: bytes channel_id = 1;
183
+ */
184
+ channelId: Uint8Array;
185
+ /**
186
+ * setting indicates if the user wants to receive notifications for the channel.
187
+ *
188
+ * @generated from field: river.SpaceChannelSettingValue value = 2;
189
+ */
190
+ value: SpaceChannelSettingValue;
191
+ };
192
+ /**
193
+ * Describes the message river.SpaceChannelSetting.
194
+ * Use `create(SpaceChannelSettingSchema)` to create a new message.
195
+ */
196
+ export declare const SpaceChannelSettingSchema: GenMessage<SpaceChannelSetting>;
197
+ /**
198
+ * SpaceSettings hold settings that applied to all streams within the space.
199
+ * These can be overwritten by channel specific settings.
200
+ *
201
+ * @generated from message river.SpaceSetting
202
+ */
203
+ export type SpaceSetting = Message<"river.SpaceSetting"> & {
204
+ /**
205
+ * space channel id
206
+ *
207
+ * @generated from field: bytes space_id = 1;
208
+ */
209
+ spaceId: Uint8Array;
210
+ /**
211
+ * value is applied to all channels within the space unless overwritten by a channel specific setting.
212
+ *
213
+ * @generated from field: river.SpaceChannelSettingValue value = 2;
214
+ */
215
+ value: SpaceChannelSettingValue;
216
+ /**
217
+ * channels holds channel specific settings for channels within the space
218
+ *
219
+ * @generated from field: repeated river.SpaceChannelSetting channels = 3;
220
+ */
221
+ channels: SpaceChannelSetting[];
222
+ };
223
+ /**
224
+ * Describes the message river.SpaceSetting.
225
+ * Use `create(SpaceSettingSchema)` to create a new message.
226
+ */
227
+ export declare const SpaceSettingSchema: GenMessage<SpaceSetting>;
228
+ /**
229
+ * @generated from message river.SetDmGdmSettingsRequest
230
+ */
231
+ export type SetDmGdmSettingsRequest = Message<"river.SetDmGdmSettingsRequest"> & {
232
+ /**
233
+ * dm_global is the default setting that is applied to all DM channels and can be overwritten by channel specific
234
+ * settings
235
+ *
236
+ * @generated from field: river.DmChannelSettingValue dm_global = 1;
237
+ */
238
+ dmGlobal: DmChannelSettingValue;
239
+ /**
240
+ * gdm_global is the default setting that is applied to all GDM channels and can be overwritten by channel specific
241
+ * settings
242
+ *
243
+ * @generated from field: river.GdmChannelSettingValue gdm_global = 2;
244
+ */
245
+ gdmGlobal: GdmChannelSettingValue;
246
+ };
247
+ /**
248
+ * Describes the message river.SetDmGdmSettingsRequest.
249
+ * Use `create(SetDmGdmSettingsRequestSchema)` to create a new message.
250
+ */
251
+ export declare const SetDmGdmSettingsRequestSchema: GenMessage<SetDmGdmSettingsRequest>;
252
+ /**
253
+ * @generated from message river.SetDmGdmSettingsResponse
254
+ */
255
+ export type SetDmGdmSettingsResponse = Message<"river.SetDmGdmSettingsResponse"> & {};
256
+ /**
257
+ * Describes the message river.SetDmGdmSettingsResponse.
258
+ * Use `create(SetDmGdmSettingsResponseSchema)` to create a new message.
259
+ */
260
+ export declare const SetDmGdmSettingsResponseSchema: GenMessage<SetDmGdmSettingsResponse>;
261
+ /**
262
+ * @generated from message river.SetDmChannelSettingRequest
263
+ */
264
+ export type SetDmChannelSettingRequest = Message<"river.SetDmChannelSettingRequest"> & {
265
+ /**
266
+ * dm channel id
267
+ *
268
+ * @generated from field: bytes dm_channel_id = 1;
269
+ */
270
+ dmChannelId: Uint8Array;
271
+ /**
272
+ * dm setting
273
+ *
274
+ * @generated from field: river.DmChannelSettingValue value = 2;
275
+ */
276
+ value: DmChannelSettingValue;
277
+ };
278
+ /**
279
+ * Describes the message river.SetDmChannelSettingRequest.
280
+ * Use `create(SetDmChannelSettingRequestSchema)` to create a new message.
281
+ */
282
+ export declare const SetDmChannelSettingRequestSchema: GenMessage<SetDmChannelSettingRequest>;
283
+ /**
284
+ * @generated from message river.SetDmChannelSettingResponse
285
+ */
286
+ export type SetDmChannelSettingResponse = Message<"river.SetDmChannelSettingResponse"> & {};
287
+ /**
288
+ * Describes the message river.SetDmChannelSettingResponse.
289
+ * Use `create(SetDmChannelSettingResponseSchema)` to create a new message.
290
+ */
291
+ export declare const SetDmChannelSettingResponseSchema: GenMessage<SetDmChannelSettingResponse>;
292
+ /**
293
+ * @generated from message river.SetGdmChannelSettingRequest
294
+ */
295
+ export type SetGdmChannelSettingRequest = Message<"river.SetGdmChannelSettingRequest"> & {
296
+ /**
297
+ * gdm channel id
298
+ *
299
+ * @generated from field: bytes gdm_channel_id = 1;
300
+ */
301
+ gdmChannelId: Uint8Array;
302
+ /**
303
+ * dm setting
304
+ *
305
+ * @generated from field: river.GdmChannelSettingValue value = 2;
306
+ */
307
+ value: GdmChannelSettingValue;
308
+ };
309
+ /**
310
+ * Describes the message river.SetGdmChannelSettingRequest.
311
+ * Use `create(SetGdmChannelSettingRequestSchema)` to create a new message.
312
+ */
313
+ export declare const SetGdmChannelSettingRequestSchema: GenMessage<SetGdmChannelSettingRequest>;
314
+ /**
315
+ * @generated from message river.SetGdmChannelSettingResponse
316
+ */
317
+ export type SetGdmChannelSettingResponse = Message<"river.SetGdmChannelSettingResponse"> & {};
318
+ /**
319
+ * Describes the message river.SetGdmChannelSettingResponse.
320
+ * Use `create(SetGdmChannelSettingResponseSchema)` to create a new message.
321
+ */
322
+ export declare const SetGdmChannelSettingResponseSchema: GenMessage<SetGdmChannelSettingResponse>;
323
+ /**
324
+ * @generated from message river.SetSpaceSettingsRequest
325
+ */
326
+ export type SetSpaceSettingsRequest = Message<"river.SetSpaceSettingsRequest"> & {
327
+ /**
328
+ * space channel id
329
+ *
330
+ * @generated from field: bytes space_id = 1;
331
+ */
332
+ spaceId: Uint8Array;
333
+ /**
334
+ * value are applied to all channels within the space.
335
+ *
336
+ * @generated from field: river.SpaceChannelSettingValue value = 2;
337
+ */
338
+ value: SpaceChannelSettingValue;
339
+ };
340
+ /**
341
+ * Describes the message river.SetSpaceSettingsRequest.
342
+ * Use `create(SetSpaceSettingsRequestSchema)` to create a new message.
343
+ */
344
+ export declare const SetSpaceSettingsRequestSchema: GenMessage<SetSpaceSettingsRequest>;
345
+ /**
346
+ * @generated from message river.SetSpaceSettingsResponse
347
+ */
348
+ export type SetSpaceSettingsResponse = Message<"river.SetSpaceSettingsResponse"> & {};
349
+ /**
350
+ * Describes the message river.SetSpaceSettingsResponse.
351
+ * Use `create(SetSpaceSettingsResponseSchema)` to create a new message.
352
+ */
353
+ export declare const SetSpaceSettingsResponseSchema: GenMessage<SetSpaceSettingsResponse>;
354
+ /**
355
+ * @generated from message river.SetSpaceChannelSettingsRequest
356
+ */
357
+ export type SetSpaceChannelSettingsRequest = Message<"river.SetSpaceChannelSettingsRequest"> & {
358
+ /**
359
+ * channel_id points to the channel for which this setting applies.
360
+ *
361
+ * @generated from field: bytes channel_id = 1;
362
+ */
363
+ channelId: Uint8Array;
364
+ /**
365
+ * space_id this channel is part of
366
+ *
367
+ * @generated from field: bytes space_id = 2;
368
+ */
369
+ spaceId: Uint8Array;
370
+ /**
371
+ * value indicates the user overwritten value or a channel default must be used.
372
+ *
373
+ * @generated from field: river.SpaceChannelSettingValue value = 3;
374
+ */
375
+ value: SpaceChannelSettingValue;
376
+ };
377
+ /**
378
+ * Describes the message river.SetSpaceChannelSettingsRequest.
379
+ * Use `create(SetSpaceChannelSettingsRequestSchema)` to create a new message.
380
+ */
381
+ export declare const SetSpaceChannelSettingsRequestSchema: GenMessage<SetSpaceChannelSettingsRequest>;
382
+ /**
383
+ * @generated from message river.SetSpaceChannelSettingsResponse
384
+ */
385
+ export type SetSpaceChannelSettingsResponse = Message<"river.SetSpaceChannelSettingsResponse"> & {};
386
+ /**
387
+ * Describes the message river.SetSpaceChannelSettingsResponse.
388
+ * Use `create(SetSpaceChannelSettingsResponseSchema)` to create a new message.
389
+ */
390
+ export declare const SetSpaceChannelSettingsResponseSchema: GenMessage<SetSpaceChannelSettingsResponse>;
391
+ /**
392
+ * @generated from message river.WebPushSubscriptionObjectKeys
393
+ */
394
+ export type WebPushSubscriptionObjectKeys = Message<"river.WebPushSubscriptionObjectKeys"> & {
395
+ /**
396
+ * An Elliptic curve Diffie–Hellman public key on the P-256 curve (that is, the NIST
397
+ * secp256r1 elliptic curve) and obtained from the browser when subscribing.
398
+ *
399
+ * @generated from field: string p256dh = 1;
400
+ */
401
+ p256dh: string;
402
+ /**
403
+ * An authentication secret and obtained from the browser when subscribing.
404
+ *
405
+ * @generated from field: string auth = 2;
406
+ */
407
+ auth: string;
408
+ };
409
+ /**
410
+ * Describes the message river.WebPushSubscriptionObjectKeys.
411
+ * Use `create(WebPushSubscriptionObjectKeysSchema)` to create a new message.
412
+ */
413
+ export declare const WebPushSubscriptionObjectKeysSchema: GenMessage<WebPushSubscriptionObjectKeys>;
414
+ /**
415
+ * @generated from message river.WebPushSubscriptionObject
416
+ */
417
+ export type WebPushSubscriptionObject = Message<"river.WebPushSubscriptionObject"> & {
418
+ /**
419
+ * A string containing the endpoint associated with the push subscription.
420
+ *
421
+ * @generated from field: string endpoint = 1;
422
+ */
423
+ endpoint: string;
424
+ /**
425
+ * keys obtained from the browser when subscribing for notifications. The notifications
426
+ * service uses these details to protect the notifications content.
427
+ *
428
+ * @generated from field: river.WebPushSubscriptionObjectKeys keys = 2;
429
+ */
430
+ keys?: WebPushSubscriptionObjectKeys;
431
+ };
432
+ /**
433
+ * Describes the message river.WebPushSubscriptionObject.
434
+ * Use `create(WebPushSubscriptionObjectSchema)` to create a new message.
435
+ */
436
+ export declare const WebPushSubscriptionObjectSchema: GenMessage<WebPushSubscriptionObject>;
437
+ /**
438
+ * @generated from message river.SubscribeWebPushRequest
439
+ */
440
+ export type SubscribeWebPushRequest = Message<"river.SubscribeWebPushRequest"> & {
441
+ /**
442
+ * subscription holds the subscribe data that is returned by the browser when subscribing
443
+ *
444
+ * @generated from field: river.WebPushSubscriptionObject subscription = 1;
445
+ */
446
+ subscription?: WebPushSubscriptionObject;
447
+ };
448
+ /**
449
+ * Describes the message river.SubscribeWebPushRequest.
450
+ * Use `create(SubscribeWebPushRequestSchema)` to create a new message.
451
+ */
452
+ export declare const SubscribeWebPushRequestSchema: GenMessage<SubscribeWebPushRequest>;
453
+ /**
454
+ * @generated from message river.SubscribeWebPushResponse
455
+ */
456
+ export type SubscribeWebPushResponse = Message<"river.SubscribeWebPushResponse"> & {};
457
+ /**
458
+ * Describes the message river.SubscribeWebPushResponse.
459
+ * Use `create(SubscribeWebPushResponseSchema)` to create a new message.
460
+ */
461
+ export declare const SubscribeWebPushResponseSchema: GenMessage<SubscribeWebPushResponse>;
462
+ /**
463
+ * @generated from message river.UnsubscribeWebPushRequest
464
+ */
465
+ export type UnsubscribeWebPushRequest = Message<"river.UnsubscribeWebPushRequest"> & {
466
+ /**
467
+ * subscription holds the subscribe data that is returned by the browser when subscribing
468
+ *
469
+ * @generated from field: river.WebPushSubscriptionObject subscription = 1;
470
+ */
471
+ subscription?: WebPushSubscriptionObject;
472
+ };
473
+ /**
474
+ * Describes the message river.UnsubscribeWebPushRequest.
475
+ * Use `create(UnsubscribeWebPushRequestSchema)` to create a new message.
476
+ */
477
+ export declare const UnsubscribeWebPushRequestSchema: GenMessage<UnsubscribeWebPushRequest>;
478
+ /**
479
+ * @generated from message river.UnsubscribeWebPushResponse
480
+ */
481
+ export type UnsubscribeWebPushResponse = Message<"river.UnsubscribeWebPushResponse"> & {};
482
+ /**
483
+ * Describes the message river.UnsubscribeWebPushResponse.
484
+ * Use `create(UnsubscribeWebPushResponseSchema)` to create a new message.
485
+ */
486
+ export declare const UnsubscribeWebPushResponseSchema: GenMessage<UnsubscribeWebPushResponse>;
487
+ /**
488
+ * @generated from message river.SubscribeAPNRequest
489
+ */
490
+ export type SubscribeAPNRequest = Message<"river.SubscribeAPNRequest"> & {
491
+ /**
492
+ * APN device token
493
+ *
494
+ * @generated from field: bytes device_token = 1;
495
+ */
496
+ deviceToken: Uint8Array;
497
+ /**
498
+ * environment indicates what type of environment the subscription is target.
499
+ *
500
+ * @generated from field: river.APNEnvironment environment = 2;
501
+ */
502
+ environment: APNEnvironment;
503
+ /**
504
+ * Requested push notification version (default=NOTIFICATION_PUSH_VERSION_1)
505
+ *
506
+ * @generated from field: river.NotificationPushVersion push_version = 3;
507
+ */
508
+ pushVersion: NotificationPushVersion;
509
+ };
510
+ /**
511
+ * Describes the message river.SubscribeAPNRequest.
512
+ * Use `create(SubscribeAPNRequestSchema)` to create a new message.
513
+ */
514
+ export declare const SubscribeAPNRequestSchema: GenMessage<SubscribeAPNRequest>;
515
+ /**
516
+ * @generated from message river.APNSubscription
517
+ */
518
+ export type APNSubscription = Message<"river.APNSubscription"> & {
519
+ /**
520
+ * APN device token
521
+ *
522
+ * @generated from field: bytes device_token = 1;
523
+ */
524
+ deviceToken: Uint8Array;
525
+ /**
526
+ * environment indicates what type of environment the subscription is target.
527
+ *
528
+ * @generated from field: river.APNEnvironment environment = 2;
529
+ */
530
+ environment: APNEnvironment;
531
+ };
532
+ /**
533
+ * Describes the message river.APNSubscription.
534
+ * Use `create(APNSubscriptionSchema)` to create a new message.
535
+ */
536
+ export declare const APNSubscriptionSchema: GenMessage<APNSubscription>;
537
+ /**
538
+ * @generated from message river.SubscribeAPNResponse
539
+ */
540
+ export type SubscribeAPNResponse = Message<"river.SubscribeAPNResponse"> & {};
541
+ /**
542
+ * Describes the message river.SubscribeAPNResponse.
543
+ * Use `create(SubscribeAPNResponseSchema)` to create a new message.
544
+ */
545
+ export declare const SubscribeAPNResponseSchema: GenMessage<SubscribeAPNResponse>;
546
+ /**
547
+ * @generated from message river.UnsubscribeAPNRequest
548
+ */
549
+ export type UnsubscribeAPNRequest = Message<"river.UnsubscribeAPNRequest"> & {
550
+ /**
551
+ * APN device token
552
+ *
553
+ * @generated from field: bytes device_token = 1;
554
+ */
555
+ deviceToken: Uint8Array;
556
+ };
557
+ /**
558
+ * Describes the message river.UnsubscribeAPNRequest.
559
+ * Use `create(UnsubscribeAPNRequestSchema)` to create a new message.
560
+ */
561
+ export declare const UnsubscribeAPNRequestSchema: GenMessage<UnsubscribeAPNRequest>;
562
+ /**
563
+ * @generated from message river.UnsubscribeAPNResponse
564
+ */
565
+ export type UnsubscribeAPNResponse = Message<"river.UnsubscribeAPNResponse"> & {};
566
+ /**
567
+ * Describes the message river.UnsubscribeAPNResponse.
568
+ * Use `create(UnsubscribeAPNResponseSchema)` to create a new message.
569
+ */
570
+ export declare const UnsubscribeAPNResponseSchema: GenMessage<UnsubscribeAPNResponse>;
571
+ /**
572
+ * DmChannelSettingValue specifies if the user wants to receive notifications for DM streams.
573
+ * This can be overwritten with DM channel specific configuration.
574
+ *
575
+ * @generated from enum river.DmChannelSettingValue
576
+ */
577
+ export declare enum DmChannelSettingValue {
578
+ /**
579
+ * DM_UNSPECIFIED not set, assumes DM_MESSAGES_YES as a default.
580
+ *
581
+ * @generated from enum value: DM_UNSPECIFIED = 0;
582
+ */
583
+ DM_UNSPECIFIED = 0,
584
+ /**
585
+ * DM_MESSAGES_YES indicates that the user wants to receive notifications for DM channels.
586
+ *
587
+ * @generated from enum value: DM_MESSAGES_YES = 1;
588
+ */
589
+ DM_MESSAGES_YES = 1,
590
+ /**
591
+ * DM_MESSAGES_NO indicates that the user doesn't want to receive notifications for DM channels.
592
+ *
593
+ * @generated from enum value: DM_MESSAGES_NO = 2;
594
+ */
595
+ DM_MESSAGES_NO = 2,
596
+ /**
597
+ * DM_MESSAGES_NO_AND_MUTE indicates that the user doesn't want to receive notifications for DM channels
598
+ * and the UI should not render any feedback that a message was received.
599
+ *
600
+ * @generated from enum value: DM_MESSAGES_NO_AND_MUTE = 3;
601
+ */
602
+ DM_MESSAGES_NO_AND_MUTE = 3
603
+ }
604
+ /**
605
+ * Describes the enum river.DmChannelSettingValue.
606
+ */
607
+ export declare const DmChannelSettingValueSchema: GenEnum<DmChannelSettingValue>;
608
+ /**
609
+ * GdmChannelSettingValue is a default setting that is applied to all GDM streams a user is in and can be
610
+ * overwritten by GDM channel specific settings.
611
+ *
612
+ * @generated from enum river.GdmChannelSettingValue
613
+ */
614
+ export declare enum GdmChannelSettingValue {
615
+ /**
616
+ * GDM_UNSPECIFIED not set, assumes GDM_MESSAGES_ALL as a default.
617
+ *
618
+ * @generated from enum value: GDM_UNSPECIFIED = 0;
619
+ */
620
+ GDM_UNSPECIFIED = 0,
621
+ /**
622
+ * GDM_MESSAGES_NO indicates that the user will not receive notifications for GDM channels.
623
+ *
624
+ * @generated from enum value: GDM_MESSAGES_NO = 1;
625
+ */
626
+ GDM_MESSAGES_NO = 1,
627
+ /**
628
+ * GDM_MESSAGES_NO_AND_MUTE indicates that the user doesn't want to receive notifications for GDM channels
629
+ * and the UI should not render any feedback that a message was received.
630
+ *
631
+ * @generated from enum value: GDM_MESSAGES_NO_AND_MUTE = 2;
632
+ */
633
+ GDM_MESSAGES_NO_AND_MUTE = 2,
634
+ /**
635
+ * GDM_ONLY_MENTIONS_REPLIES_REACTIONS indicates that the user receives notifications for messages added to
636
+ * GDM channels that are either a direct reply or a reaction to his own messages.
637
+ *
638
+ * @generated from enum value: GDM_ONLY_MENTIONS_REPLIES_REACTIONS = 3;
639
+ */
640
+ GDM_ONLY_MENTIONS_REPLIES_REACTIONS = 3,
641
+ /**
642
+ * GDM_MESSAGES_ALL indicates that the user receives notifications for all messages in GDM channels.
643
+ * This is the default.
644
+ *
645
+ * @generated from enum value: GDM_MESSAGES_ALL = 4;
646
+ */
647
+ GDM_MESSAGES_ALL = 4
648
+ }
649
+ /**
650
+ * Describes the enum river.GdmChannelSettingValue.
651
+ */
652
+ export declare const GdmChannelSettingValueSchema: GenEnum<GdmChannelSettingValue>;
653
+ /**
654
+ * SpaceSettingValue is a user specified setting that is applied to all channels in a space by default and can be
655
+ * overwritten with channel specific settings.
656
+ *
657
+ * @generated from enum river.SpaceChannelSettingValue
658
+ */
659
+ export declare enum SpaceChannelSettingValue {
660
+ /**
661
+ * SPACE_CHANNEL_SETTING_UNSPECIFIED not set, assumes SPACE_SETTING_ONLY_MENTIONS_REPLIES_REACTIONS as default.
662
+ *
663
+ * @generated from enum value: SPACE_CHANNEL_SETTING_UNSPECIFIED = 0;
664
+ */
665
+ SPACE_CHANNEL_SETTING_UNSPECIFIED = 0,
666
+ /**
667
+ * SPACE_CHANNEL_SETTING_NO_MESSAGES indicates that the user won't receive notifications of any channel in the space.
668
+ *
669
+ * @generated from enum value: SPACE_CHANNEL_SETTING_NO_MESSAGES = 1;
670
+ */
671
+ SPACE_CHANNEL_SETTING_NO_MESSAGES = 1,
672
+ /**
673
+ * SPACE_CHANNEL_SETTING_NO_MESSAGES_AND_MUTE indicates that the user won't receive notifications of any channel in
674
+ * the space and the UI must not render any feedback that a message was received.
675
+ *
676
+ * @generated from enum value: SPACE_CHANNEL_SETTING_NO_MESSAGES_AND_MUTE = 2;
677
+ */
678
+ SPACE_CHANNEL_SETTING_NO_MESSAGES_AND_MUTE = 2,
679
+ /**
680
+ * SPACE_CHANNEL_SETTING_ONLY_MENTIONS_REPLIES_REACTIONS indicates that the user will receive notifications for
681
+ * messages that either the user is mentioned in or are a direct reply/reaction to his own message. This is the
682
+ * default.
683
+ *
684
+ * @generated from enum value: SPACE_CHANNEL_SETTING_ONLY_MENTIONS_REPLIES_REACTIONS = 3;
685
+ */
686
+ SPACE_CHANNEL_SETTING_ONLY_MENTIONS_REPLIES_REACTIONS = 3,
687
+ /**
688
+ * SPACE_CHANNEL_SETTING_MESSAGES_ALL indicates that the user will receive notifications for all types of
689
+ * messages/reactions for all channels in the space.
690
+ *
691
+ * @generated from enum value: SPACE_CHANNEL_SETTING_MESSAGES_ALL = 4;
692
+ */
693
+ SPACE_CHANNEL_SETTING_MESSAGES_ALL = 4
694
+ }
695
+ /**
696
+ * Describes the enum river.SpaceChannelSettingValue.
697
+ */
698
+ export declare const SpaceChannelSettingValueSchema: GenEnum<SpaceChannelSettingValue>;
699
+ /**
700
+ * @generated from enum river.APNEnvironment
701
+ */
702
+ export declare enum APNEnvironment {
703
+ /**
704
+ * APN_ENVIRONMENT_UNSPECIFIED is invalid.
705
+ *
706
+ * @generated from enum value: APN_ENVIRONMENT_UNSPECIFIED = 0;
707
+ */
708
+ APN_ENVIRONMENT_UNSPECIFIED = 0,
709
+ /**
710
+ * APN_ENVIRONMENT_PRODUCTION uses Apple's APN service to deliver notifications.
711
+ *
712
+ * @generated from enum value: APN_ENVIRONMENT_PRODUCTION = 1;
713
+ */
714
+ APN_ENVIRONMENT_PRODUCTION = 1,
715
+ /**
716
+ * APN_ENVIRONMENT_SANDBOX uses Apple's sandbox environment to send notifications.
717
+ * Only used for development purposes.
718
+ *
719
+ * @generated from enum value: APN_ENVIRONMENT_SANDBOX = 2;
720
+ */
721
+ APN_ENVIRONMENT_SANDBOX = 2
722
+ }
723
+ /**
724
+ * Describes the enum river.APNEnvironment.
725
+ */
726
+ export declare const APNEnvironmentSchema: GenEnum<APNEnvironment>;
727
+ /**
728
+ * NotificationPushVersion specifies the notification format version.
729
+ *
730
+ * @generated from enum river.NotificationPushVersion
731
+ */
732
+ export declare enum NotificationPushVersion {
733
+ /**
734
+ * @generated from enum value: NOTIFICATION_PUSH_VERSION_UNSPECIFIED = 0;
735
+ */
736
+ NOTIFICATION_PUSH_VERSION_UNSPECIFIED = 0,
737
+ /**
738
+ * @generated from enum value: NOTIFICATION_PUSH_VERSION_1 = 1;
739
+ */
740
+ NOTIFICATION_PUSH_VERSION_1 = 1,
741
+ /**
742
+ * @generated from enum value: NOTIFICATION_PUSH_VERSION_2 = 2;
743
+ */
744
+ NOTIFICATION_PUSH_VERSION_2 = 2
745
+ }
746
+ /**
747
+ * Describes the enum river.NotificationPushVersion.
748
+ */
749
+ export declare const NotificationPushVersionSchema: GenEnum<NotificationPushVersion>;
750
+ /**
751
+ * NotificationService allows user to set notification related preferences for messages added to channels within a
752
+ * space, DM and GDM channels.
753
+ *
754
+ * These functions are all authenticated and require a session token to be passed through the authorization metadata.
755
+ * This session token can be obtained from the AuthenticationService. If the session token is missing or invalid an
756
+ * Err_UNAUTHENTICATED (code=16) is returned.
757
+ *
758
+ * @generated from service river.NotificationService
759
+ */
760
+ export declare const NotificationService: GenService<{
761
+ /**
762
+ * GetSettings returns user stored notification settings.
763
+ *
764
+ * @generated from rpc river.NotificationService.GetSettings
765
+ */
766
+ getSettings: {
767
+ methodKind: "unary";
768
+ input: typeof GetSettingsRequestSchema;
769
+ output: typeof GetSettingsResponseSchema;
770
+ };
771
+ /**
772
+ * SetSettings sets the notification settings, overwriting all existing settings.
773
+ *
774
+ * @generated from rpc river.NotificationService.SetSettings
775
+ */
776
+ setSettings: {
777
+ methodKind: "unary";
778
+ input: typeof SetSettingsRequestSchema;
779
+ output: typeof SetSettingsResponseSchema;
780
+ };
781
+ /**
782
+ * SetDmGdmSettings updates global settings for DM/GDM channels.
783
+ *
784
+ * @generated from rpc river.NotificationService.SetDmGdmSettings
785
+ */
786
+ setDmGdmSettings: {
787
+ methodKind: "unary";
788
+ input: typeof SetDmGdmSettingsRequestSchema;
789
+ output: typeof SetDmGdmSettingsResponseSchema;
790
+ };
791
+ /**
792
+ * SetDmChannelSetting updates settings for a DM channel
793
+ *
794
+ * @generated from rpc river.NotificationService.SetDmChannelSetting
795
+ */
796
+ setDmChannelSetting: {
797
+ methodKind: "unary";
798
+ input: typeof SetDmChannelSettingRequestSchema;
799
+ output: typeof SetDmChannelSettingResponseSchema;
800
+ };
801
+ /**
802
+ * SetGdmChannelSetting updates settings for a GDM channel
803
+ *
804
+ * @generated from rpc river.NotificationService.SetGdmChannelSetting
805
+ */
806
+ setGdmChannelSetting: {
807
+ methodKind: "unary";
808
+ input: typeof SetGdmChannelSettingRequestSchema;
809
+ output: typeof SetGdmChannelSettingResponseSchema;
810
+ };
811
+ /**
812
+ * SetSpaceSettings updates space setting that are applied to all channels within that stream.
813
+ *
814
+ * @generated from rpc river.NotificationService.SetSpaceSettings
815
+ */
816
+ setSpaceSettings: {
817
+ methodKind: "unary";
818
+ input: typeof SetSpaceSettingsRequestSchema;
819
+ output: typeof SetSpaceSettingsResponseSchema;
820
+ };
821
+ /**
822
+ * SetSpaceChannelSettings updates settings for a channel that is part of a space.
823
+ *
824
+ * @generated from rpc river.NotificationService.SetSpaceChannelSettings
825
+ */
826
+ setSpaceChannelSettings: {
827
+ methodKind: "unary";
828
+ input: typeof SetSpaceChannelSettingsRequestSchema;
829
+ output: typeof SetSpaceChannelSettingsResponseSchema;
830
+ };
831
+ /**
832
+ * SubscribeWebPush subscribes a client to receive notifications through web push.
833
+ * If the given req.subscription is already associated with a web push subscription the user id is updated (upsert).
834
+ *
835
+ * @generated from rpc river.NotificationService.SubscribeWebPush
836
+ */
837
+ subscribeWebPush: {
838
+ methodKind: "unary";
839
+ input: typeof SubscribeWebPushRequestSchema;
840
+ output: typeof SubscribeWebPushResponseSchema;
841
+ };
842
+ /**
843
+ * UnsubscribeWebPush deletes web push subscription.
844
+ *
845
+ * @generated from rpc river.NotificationService.UnsubscribeWebPush
846
+ */
847
+ unsubscribeWebPush: {
848
+ methodKind: "unary";
849
+ input: typeof UnsubscribeWebPushRequestSchema;
850
+ output: typeof UnsubscribeWebPushResponseSchema;
851
+ };
852
+ /**
853
+ * SubscribeAPN subscribes a device to receive Apple Push Notifications.
854
+ * If the given device token is already associated with an APN subscription the user id is updated (upsert).
855
+ *
856
+ * @generated from rpc river.NotificationService.SubscribeAPN
857
+ */
858
+ subscribeAPN: {
859
+ methodKind: "unary";
860
+ input: typeof SubscribeAPNRequestSchema;
861
+ output: typeof SubscribeAPNResponseSchema;
862
+ };
863
+ /**
864
+ * UnsubscribeAPN unsubscribes a device from receiving Apple Push Notifications.
865
+ *
866
+ * @generated from rpc river.NotificationService.UnsubscribeAPN
867
+ */
868
+ unsubscribeAPN: {
869
+ methodKind: "unary";
870
+ input: typeof UnsubscribeAPNRequestSchema;
871
+ output: typeof UnsubscribeAPNResponseSchema;
872
+ };
873
+ }>;
874
+ //# sourceMappingURL=notifications_pb.d.ts.map