@pidgr/proto 0.36.0

package/pidgr/v1/device_pb.ts

@@ -0,0 +1,374 @@
+// @generated by protoc-gen-es v2.11.0 with parameter "target=ts"
+// @generated from file pidgr/v1/device.proto (package pidgr.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import { fileDesc, messageDesc, serviceDesc } from "@bufbuild/protobuf/codegenv2";
+import type { Timestamp } from "@bufbuild/protobuf/wkt";
+import { file_google_protobuf_timestamp } from "@bufbuild/protobuf/wkt";
+import type { Platform } from "./common_pb";
+import { file_pidgr_v1_common } from "./common_pb";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file pidgr/v1/device.proto.
+ */
+export const file_pidgr_v1_device: GenFile = /*@__PURE__*/
+  fileDesc("ChVwaWRnci92MS9kZXZpY2UucHJvdG8SCHBpZGdyLnYxItUBCgZEZXZpY2USEQoJZGV2aWNlX2lkGAEgASgJEg8KB3VzZXJfaWQYAiABKAkSJAoIcGxhdGZvcm0YAyABKA4yEi5waWRnci52MS5QbGF0Zm9ybRISCgpwdXNoX3Rva2VuGAQgASgJEg4KBmFjdGl2ZRgFIAEoCBItCglsYXN0X3NlZW4YBiABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wEi4KCmNyZWF0ZWRfYXQYByABKAsyGi5nb29nbGUucHJvdG9idWYuVGltZXN0YW1wIsgBCg1EZXZpY2VTdW1tYXJ5EhEKCWRldmljZV9pZBgBIAEoCRIPCgd1c2VyX2lkGAIgASgJEiQKCHBsYXRmb3JtGAMgASgOMhIucGlkZ3IudjEuUGxhdGZvcm0SDgoGYWN0aXZlGAQgASgIEi0KCWxhc3Rfc2VlbhgFIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASLgoKY3JlYXRlZF9hdBgGIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXAiXgoPUmVnaXN0ZXJSZXF1ZXN0EhEKCWRldmljZV9pZBgBIAEoCRIkCghwbGF0Zm9ybRgCIAEoDjISLnBpZGdyLnYxLlBsYXRmb3JtEhIKCnB1c2hfdG9rZW4YAyABKAkiOwoQUmVnaXN0ZXJSZXNwb25zZRInCgZkZXZpY2UYASABKAsyFy5waWRnci52MS5EZXZpY2VTdW1tYXJ5IiYKEURlYWN0aXZhdGVSZXF1ZXN0EhEKCWRldmljZV9pZBgBIAEoCSIlChJEZWFjdGl2YXRlUmVzcG9uc2USDwoHc3VjY2VzcxgBIAEoCCIUChJMaXN0RGV2aWNlc1JlcXVlc3QiPwoTTGlzdERldmljZXNSZXNwb25zZRIoCgdkZXZpY2VzGAEgAygLMhcucGlkZ3IudjEuRGV2aWNlU3VtbWFyeSIrChhMaXN0TWVtYmVyRGV2aWNlc1JlcXVlc3QSDwoHdXNlcl9pZBgBIAEoCSJFChlMaXN0TWVtYmVyRGV2aWNlc1Jlc3BvbnNlEigKB2RldmljZXMYASADKAsyFy5waWRnci52MS5EZXZpY2VTdW1tYXJ5MsUCCg1EZXZpY2VTZXJ2aWNlEkEKCFJlZ2lzdGVyEhkucGlkZ3IudjEuUmVnaXN0ZXJSZXF1ZXN0GhoucGlkZ3IudjEuUmVnaXN0ZXJSZXNwb25zZRJHCgpEZWFjdGl2YXRlEhsucGlkZ3IudjEuRGVhY3RpdmF0ZVJlcXVlc3QaHC5waWRnci52MS5EZWFjdGl2YXRlUmVzcG9uc2USSgoLTGlzdERldmljZXMSHC5waWRnci52MS5MaXN0RGV2aWNlc1JlcXVlc3QaHS5waWRnci52MS5MaXN0RGV2aWNlc1Jlc3BvbnNlElwKEUxpc3RNZW1iZXJEZXZpY2VzEiIucGlkZ3IudjEuTGlzdE1lbWJlckRldmljZXNSZXF1ZXN0GiMucGlkZ3IudjEuTGlzdE1lbWJlckRldmljZXNSZXNwb25zZUI2WjRnaXRodWIuY29tL3BpZGdyL3BpZGdyLXByb3RvL2dlbi9nby9waWRnci92MTtwaWRncnYxYgZwcm90bzM", [file_google_protobuf_timestamp, file_pidgr_v1_common]);
+
+/**
+ * A registered device that can receive push notifications.
+ * INTERNAL: This message is for server-side use only. Use DeviceSummary for API responses.
+ *
+ * @generated from message pidgr.v1.Device
+ */
+export type Device = Message<"pidgr.v1.Device"> & {
+  /**
+   * Unique identifier for this device.
+   * Constraints: UUID format (36 characters).
+   *
+   * @generated from field: string device_id = 1;
+   */
+  deviceId: string;
+
+  /**
+   * ID of the user who owns this device.
+   * Constraints: UUID format (36 characters).
+   *
+   * @generated from field: string user_id = 2;
+   */
+  userId: string;
+
+  /**
+   * Mobile platform (iOS or Android).
+   *
+   * @generated from field: pidgr.v1.Platform platform = 3;
+   */
+  platform: Platform;
+
+  /**
+   * Push token used to send notifications to this device.
+   *
+   * @generated from field: string push_token = 4;
+   */
+  pushToken: string;
+
+  /**
+   * Whether the device is currently active and eligible for push delivery.
+   *
+   * @generated from field: bool active = 5;
+   */
+  active: boolean;
+
+  /**
+   * Timestamp of the last activity from this device.
+   *
+   * @generated from field: google.protobuf.Timestamp last_seen = 6;
+   */
+  lastSeen?: Timestamp;
+
+  /**
+   * Timestamp when the device was first registered.
+   *
+   * @generated from field: google.protobuf.Timestamp created_at = 7;
+   */
+  createdAt?: Timestamp;
+};
+
+/**
+ * Describes the message pidgr.v1.Device.
+ * Use `create(DeviceSchema)` to create a new message.
+ */
+export const DeviceSchema: GenMessage<Device> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_device, 0);
+
+/**
+ * A device summary safe for API responses — excludes sensitive push_token.
+ *
+ * @generated from message pidgr.v1.DeviceSummary
+ */
+export type DeviceSummary = Message<"pidgr.v1.DeviceSummary"> & {
+  /**
+   * Unique identifier for this device.
+   *
+   * @generated from field: string device_id = 1;
+   */
+  deviceId: string;
+
+  /**
+   * ID of the user who owns this device.
+   *
+   * @generated from field: string user_id = 2;
+   */
+  userId: string;
+
+  /**
+   * Mobile platform (iOS or Android).
+   *
+   * @generated from field: pidgr.v1.Platform platform = 3;
+   */
+  platform: Platform;
+
+  /**
+   * Whether the device is currently active and eligible for push delivery.
+   *
+   * @generated from field: bool active = 4;
+   */
+  active: boolean;
+
+  /**
+   * Timestamp of the last activity from this device.
+   *
+   * @generated from field: google.protobuf.Timestamp last_seen = 5;
+   */
+  lastSeen?: Timestamp;
+
+  /**
+   * Timestamp when the device was first registered.
+   *
+   * @generated from field: google.protobuf.Timestamp created_at = 6;
+   */
+  createdAt?: Timestamp;
+};
+
+/**
+ * Describes the message pidgr.v1.DeviceSummary.
+ * Use `create(DeviceSummarySchema)` to create a new message.
+ */
+export const DeviceSummarySchema: GenMessage<DeviceSummary> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_device, 1);
+
+/**
+ * Request to register a device for push notifications.
+ *
+ * @generated from message pidgr.v1.RegisterRequest
+ */
+export type RegisterRequest = Message<"pidgr.v1.RegisterRequest"> & {
+  /**
+   * Client-generated unique device identifier.
+   * Constraints: UUID format (36 characters).
+   *
+   * @generated from field: string device_id = 1;
+   */
+  deviceId: string;
+
+  /**
+   * Mobile platform of the device.
+   *
+   * @generated from field: pidgr.v1.Platform platform = 2;
+   */
+  platform: Platform;
+
+  /**
+   * Push token obtained from the push notification provider on the client.
+   * Constraints: Max length 4096 characters.
+   *
+   * @generated from field: string push_token = 3;
+   */
+  pushToken: string;
+};
+
+/**
+ * Describes the message pidgr.v1.RegisterRequest.
+ * Use `create(RegisterRequestSchema)` to create a new message.
+ */
+export const RegisterRequestSchema: GenMessage<RegisterRequest> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_device, 2);
+
+/**
+ * Response after registering a device.
+ *
+ * @generated from message pidgr.v1.RegisterResponse
+ */
+export type RegisterResponse = Message<"pidgr.v1.RegisterResponse"> & {
+  /**
+   * The registered device summary (excludes push_token).
+   *
+   * @generated from field: pidgr.v1.DeviceSummary device = 1;
+   */
+  device?: DeviceSummary;
+};
+
+/**
+ * Describes the message pidgr.v1.RegisterResponse.
+ * Use `create(RegisterResponseSchema)` to create a new message.
+ */
+export const RegisterResponseSchema: GenMessage<RegisterResponse> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_device, 3);
+
+/**
+ * Request to deactivate a device, stopping push notifications.
+ *
+ * @generated from message pidgr.v1.DeactivateRequest
+ */
+export type DeactivateRequest = Message<"pidgr.v1.DeactivateRequest"> & {
+  /**
+   * ID of the device to deactivate.
+   * Constraints: UUID format (36 characters).
+   *
+   * @generated from field: string device_id = 1;
+   */
+  deviceId: string;
+};
+
+/**
+ * Describes the message pidgr.v1.DeactivateRequest.
+ * Use `create(DeactivateRequestSchema)` to create a new message.
+ */
+export const DeactivateRequestSchema: GenMessage<DeactivateRequest> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_device, 4);
+
+/**
+ * Response after deactivating a device.
+ *
+ * @generated from message pidgr.v1.DeactivateResponse
+ */
+export type DeactivateResponse = Message<"pidgr.v1.DeactivateResponse"> & {
+  /**
+   * Whether the device was successfully deactivated.
+   *
+   * @generated from field: bool success = 1;
+   */
+  success: boolean;
+};
+
+/**
+ * Describes the message pidgr.v1.DeactivateResponse.
+ * Use `create(DeactivateResponseSchema)` to create a new message.
+ */
+export const DeactivateResponseSchema: GenMessage<DeactivateResponse> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_device, 5);
+
+/**
+ * Request to list all devices for the authenticated user.
+ *
+ * @generated from message pidgr.v1.ListDevicesRequest
+ */
+export type ListDevicesRequest = Message<"pidgr.v1.ListDevicesRequest"> & {
+};
+
+/**
+ * Describes the message pidgr.v1.ListDevicesRequest.
+ * Use `create(ListDevicesRequestSchema)` to create a new message.
+ */
+export const ListDevicesRequestSchema: GenMessage<ListDevicesRequest> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_device, 6);
+
+/**
+ * Response containing all devices for the user.
+ *
+ * @generated from message pidgr.v1.ListDevicesResponse
+ */
+export type ListDevicesResponse = Message<"pidgr.v1.ListDevicesResponse"> & {
+  /**
+   * List of devices registered to the authenticated user.
+   *
+   * @generated from field: repeated pidgr.v1.DeviceSummary devices = 1;
+   */
+  devices: DeviceSummary[];
+};
+
+/**
+ * Describes the message pidgr.v1.ListDevicesResponse.
+ * Use `create(ListDevicesResponseSchema)` to create a new message.
+ */
+export const ListDevicesResponseSchema: GenMessage<ListDevicesResponse> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_device, 7);
+
+/**
+ * Request to list devices for a specific member (admin use).
+ *
+ * @generated from message pidgr.v1.ListMemberDevicesRequest
+ */
+export type ListMemberDevicesRequest = Message<"pidgr.v1.ListMemberDevicesRequest"> & {
+  /**
+   * ID of the user whose devices to list.
+   * Constraints: UUID format (36 characters).
+   *
+   * @generated from field: string user_id = 1;
+   */
+  userId: string;
+};
+
+/**
+ * Describes the message pidgr.v1.ListMemberDevicesRequest.
+ * Use `create(ListMemberDevicesRequestSchema)` to create a new message.
+ */
+export const ListMemberDevicesRequestSchema: GenMessage<ListMemberDevicesRequest> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_device, 8);
+
+/**
+ * Response containing all devices for the specified member.
+ *
+ * @generated from message pidgr.v1.ListMemberDevicesResponse
+ */
+export type ListMemberDevicesResponse = Message<"pidgr.v1.ListMemberDevicesResponse"> & {
+  /**
+   * List of devices registered to the specified user.
+   *
+   * @generated from field: repeated pidgr.v1.DeviceSummary devices = 1;
+   */
+  devices: DeviceSummary[];
+};
+
+/**
+ * Describes the message pidgr.v1.ListMemberDevicesResponse.
+ * Use `create(ListMemberDevicesResponseSchema)` to create a new message.
+ */
+export const ListMemberDevicesResponseSchema: GenMessage<ListMemberDevicesResponse> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_device, 9);
+
+/**
+ * Manages push notification device registration.
+ * Used by the mobile app to register push tokens and manage device lifecycle.
+ *
+ * @generated from service pidgr.v1.DeviceService
+ */
+export const DeviceService: GenService<{
+  /**
+   * Register a device with its push token for receiving notifications.
+   * Authorization: Authenticated user (own devices only).
+   *
+   * @generated from rpc pidgr.v1.DeviceService.Register
+   */
+  register: {
+    methodKind: "unary";
+    input: typeof RegisterRequestSchema;
+    output: typeof RegisterResponseSchema;
+  },
+  /**
+   * Deactivate a device, preventing further push notifications.
+   * Authorization: Authenticated user (own devices only).
+   *
+   * @generated from rpc pidgr.v1.DeviceService.Deactivate
+   */
+  deactivate: {
+    methodKind: "unary";
+    input: typeof DeactivateRequestSchema;
+    output: typeof DeactivateResponseSchema;
+  },
+  /**
+   * List all devices registered to the authenticated user.
+   * Authorization: Authenticated user (own devices only).
+   *
+   * @generated from rpc pidgr.v1.DeviceService.ListDevices
+   */
+  listDevices: {
+    methodKind: "unary";
+    input: typeof ListDevicesRequestSchema;
+    output: typeof ListDevicesResponseSchema;
+  },
+  /**
+   * List all devices for a specific organization member.
+   * Authorization: Requires MEMBERS_READ permission.
+   *
+   * @generated from rpc pidgr.v1.DeviceService.ListMemberDevices
+   */
+  listMemberDevices: {
+    methodKind: "unary";
+    input: typeof ListMemberDevicesRequestSchema;
+    output: typeof ListMemberDevicesResponseSchema;
+  },
+}> = /*@__PURE__*/
+  serviceDesc(file_pidgr_v1_device, 0);
+