@pidgr/proto 0.36.0

package/pidgr/v1/template_pb.ts

@@ -0,0 +1,517 @@
+// @generated by protoc-gen-es v2.11.0 with parameter "target=ts"
+// @generated from file pidgr/v1/template.proto (package pidgr.v1, syntax proto3)
+/* eslint-disable */
+
+import type { GenEnum, GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
+import { enumDesc, 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 { Pagination, PaginationMeta } from "./common_pb";
+import { file_pidgr_v1_common } from "./common_pb";
+import type { Message } from "@bufbuild/protobuf";
+
+/**
+ * Describes the file pidgr/v1/template.proto.
+ */
+export const file_pidgr_v1_template: GenFile = /*@__PURE__*/
+  fileDesc("ChdwaWRnci92MS90ZW1wbGF0ZS5wcm90bxIIcGlkZ3IudjEikAEKEFRlbXBsYXRlVmFyaWFibGUSDAoEbmFtZRgBIAEoCRITCgtkZXNjcmlwdGlvbhgCIAEoCRIQCghyZXF1aXJlZBgDIAEoCBIwCgZzb3VyY2UYBCABKA4yIC5waWRnci52MS5UZW1wbGF0ZVZhcmlhYmxlU291cmNlEhUKDWRlZmF1bHRfdmFsdWUYBSABKAkihwIKCFRlbXBsYXRlEgoKAmlkGAEgASgJEgwKBG5hbWUYAiABKAkSDAoEYm9keRgDIAEoCRItCgl2YXJpYWJsZXMYBCADKAsyGi5waWRnci52MS5UZW1wbGF0ZVZhcmlhYmxlEg8KB3ZlcnNpb24YBSABKAUSLgoKY3JlYXRlZF9hdBgGIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASLgoKdXBkYXRlZF9hdBgHIAEoCzIaLmdvb2dsZS5wcm90b2J1Zi5UaW1lc3RhbXASDQoFdGl0bGUYCCABKAkSJAoEdHlwZRgJIAEoDjIWLnBpZGdyLnYxLlRlbXBsYXRlVHlwZSKXAQoVQ3JlYXRlVGVtcGxhdGVSZXF1ZXN0EgwKBG5hbWUYASABKAkSDAoEYm9keRgCIAEoCRItCgl2YXJpYWJsZXMYAyADKAsyGi5waWRnci52MS5UZW1wbGF0ZVZhcmlhYmxlEg0KBXRpdGxlGAQgASgJEiQKBHR5cGUYBSABKA4yFi5waWRnci52MS5UZW1wbGF0ZVR5cGUiPgoWQ3JlYXRlVGVtcGxhdGVSZXNwb25zZRIkCgh0ZW1wbGF0ZRgBIAEoCzISLnBpZGdyLnYxLlRlbXBsYXRlImkKFVVwZGF0ZVRlbXBsYXRlUmVxdWVzdBITCgt0ZW1wbGF0ZV9pZBgBIAEoCRIMCgRib2R5GAIgASgJEi0KCXZhcmlhYmxlcxgDIAMoCzIaLnBpZGdyLnYxLlRlbXBsYXRlVmFyaWFibGUiPgoWVXBkYXRlVGVtcGxhdGVSZXNwb25zZRIkCgh0ZW1wbGF0ZRgBIAEoCzISLnBpZGdyLnYxLlRlbXBsYXRlIjoKEkdldFRlbXBsYXRlUmVxdWVzdBITCgt0ZW1wbGF0ZV9pZBgBIAEoCRIPCgd2ZXJzaW9uGAIgASgFIjsKE0dldFRlbXBsYXRlUmVzcG9uc2USJAoIdGVtcGxhdGUYASABKAsyEi5waWRnci52MS5UZW1wbGF0ZSJmChRMaXN0VGVtcGxhdGVzUmVxdWVzdBIoCgpwYWdpbmF0aW9uGAEgASgLMhQucGlkZ3IudjEuUGFnaW5hdGlvbhIkCgR0eXBlGAIgASgOMhYucGlkZ3IudjEuVGVtcGxhdGVUeXBlInEKFUxpc3RUZW1wbGF0ZXNSZXNwb25zZRIlCgl0ZW1wbGF0ZXMYASADKAsyEi5waWRnci52MS5UZW1wbGF0ZRIxCg9wYWdpbmF0aW9uX21ldGEYAiABKAsyGC5waWRnci52MS5QYWdpbmF0aW9uTWV0YSp5CgxUZW1wbGF0ZVR5cGUSHQoZVEVNUExBVEVfVFlQRV9VTlNQRUNJRklFRBAAEhoKFlRFTVBMQVRFX1RZUEVfTUFSS0RPV04QARIWChJURU1QTEFURV9UWVBFX1JJQ0gQAhIWChJURU1QTEFURV9UWVBFX0hUTUwQAyqNAQoWVGVtcGxhdGVWYXJpYWJsZVNvdXJjZRIoCiRURU1QTEFURV9WQVJJQUJMRV9TT1VSQ0VfVU5TUEVDSUZJRUQQABIkCiBURU1QTEFURV9WQVJJQUJMRV9TT1VSQ0VfUFJPRklMRRABEiMKH1RFTVBMQVRFX1ZBUklBQkxFX1NPVVJDRV9DVVNUT00QAjLZAgoPVGVtcGxhdGVTZXJ2aWNlElMKDkNyZWF0ZVRlbXBsYXRlEh8ucGlkZ3IudjEuQ3JlYXRlVGVtcGxhdGVSZXF1ZXN0GiAucGlkZ3IudjEuQ3JlYXRlVGVtcGxhdGVSZXNwb25zZRJTCg5VcGRhdGVUZW1wbGF0ZRIfLnBpZGdyLnYxLlVwZGF0ZVRlbXBsYXRlUmVxdWVzdBogLnBpZGdyLnYxLlVwZGF0ZVRlbXBsYXRlUmVzcG9uc2USSgoLR2V0VGVtcGxhdGUSHC5waWRnci52MS5HZXRUZW1wbGF0ZVJlcXVlc3QaHS5waWRnci52MS5HZXRUZW1wbGF0ZVJlc3BvbnNlElAKDUxpc3RUZW1wbGF0ZXMSHi5waWRnci52MS5MaXN0VGVtcGxhdGVzUmVxdWVzdBofLnBpZGdyLnYxLkxpc3RUZW1wbGF0ZXNSZXNwb25zZUI2WjRnaXRodWIuY29tL3BpZGdyL3BpZGdyLXByb3RvL2dlbi9nby9waWRnci92MTtwaWRncnYxYgZwcm90bzM", [file_google_protobuf_timestamp, file_pidgr_v1_common]);
+
+/**
+ * A variable placeholder within a template that gets substituted during rendering.
+ *
+ * @generated from message pidgr.v1.TemplateVariable
+ */
+export type TemplateVariable = Message<"pidgr.v1.TemplateVariable"> & {
+  /**
+   * Variable name used in the template body (e.g. "employee_name").
+   * Constraints: Max length 100 characters.
+   *
+   * @generated from field: string name = 1;
+   */
+  name: string;
+
+  /**
+   * Human-readable description of what this variable represents.
+   * Constraints: Max length 500 characters.
+   *
+   * @generated from field: string description = 2;
+   */
+  description: string;
+
+  /**
+   * Whether this variable must be provided during rendering.
+   *
+   * @generated from field: bool required = 3;
+   */
+  required: boolean;
+
+  /**
+   * Where this variable's value comes from (profile attribute or campaign config).
+   *
+   * @generated from field: pidgr.v1.TemplateVariableSource source = 4;
+   */
+  source: TemplateVariableSource;
+
+  /**
+   * Fallback value used when the source does not provide a value.
+   * Constraints: Max length 1000 characters.
+   *
+   * @generated from field: string default_value = 5;
+   */
+  defaultValue: string;
+};
+
+/**
+ * Describes the message pidgr.v1.TemplateVariable.
+ * Use `create(TemplateVariableSchema)` to create a new message.
+ */
+export const TemplateVariableSchema: GenMessage<TemplateVariable> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_template, 0);
+
+/**
+ * A versioned message template with variable placeholders.
+ * Templates are append-only — updates create new versions.
+ *
+ * @generated from message pidgr.v1.Template
+ */
+export type Template = Message<"pidgr.v1.Template"> & {
+  /**
+   * Unique identifier for the template.
+   *
+   * @generated from field: string id = 1;
+   */
+  id: string;
+
+  /**
+   * Human-readable template name (admin-facing label).
+   * Constraints: Max length 200 characters.
+   *
+   * @generated from field: string name = 2;
+   */
+  name: string;
+
+  /**
+   * Template body with {{variable}} placeholders for substitution.
+   * Constraints: Max length 50000 characters.
+   *
+   * @generated from field: string body = 3;
+   */
+  body: string;
+
+  /**
+   * Variables that can be substituted into the template body.
+   *
+   * @generated from field: repeated pidgr.v1.TemplateVariable variables = 4;
+   */
+  variables: TemplateVariable[];
+
+  /**
+   * Version number (auto-incremented on each update).
+   *
+   * @generated from field: int32 version = 5;
+   */
+  version: number;
+
+  /**
+   * Timestamp when this version was created.
+   *
+   * @generated from field: google.protobuf.Timestamp created_at = 6;
+   */
+  createdAt?: Timestamp;
+
+  /**
+   * Timestamp of the most recent update (same as created_at for the latest version).
+   *
+   * @generated from field: google.protobuf.Timestamp updated_at = 7;
+   */
+  updatedAt?: Timestamp;
+
+  /**
+   * User-facing title shown as the message subject to recipients.
+   * Serves as the default title; campaigns can override it.
+   * Constraints: Max length 200 characters.
+   *
+   * @generated from field: string title = 8;
+   */
+  title: string;
+
+  /**
+   * Content format of this template (markdown, rich, HTML).
+   * UNSPECIFIED is treated as MARKDOWN for backward compatibility.
+   *
+   * @generated from field: pidgr.v1.TemplateType type = 9;
+   */
+  type: TemplateType;
+};
+
+/**
+ * Describes the message pidgr.v1.Template.
+ * Use `create(TemplateSchema)` to create a new message.
+ */
+export const TemplateSchema: GenMessage<Template> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_template, 1);
+
+/**
+ * Request to create a new template.
+ *
+ * @generated from message pidgr.v1.CreateTemplateRequest
+ */
+export type CreateTemplateRequest = Message<"pidgr.v1.CreateTemplateRequest"> & {
+  /**
+   * Human-readable template name (admin-facing label).
+   * Constraints: Max length 200 characters.
+   *
+   * @generated from field: string name = 1;
+   */
+  name: string;
+
+  /**
+   * Template body with {{variable}} placeholders.
+   * Constraints: Max length 50000 characters.
+   *
+   * @generated from field: string body = 2;
+   */
+  body: string;
+
+  /**
+   * Variables available for substitution in the body.
+   *
+   * @generated from field: repeated pidgr.v1.TemplateVariable variables = 3;
+   */
+  variables: TemplateVariable[];
+
+  /**
+   * User-facing title shown as the message subject to recipients.
+   * Constraints: Max length 200 characters.
+   *
+   * @generated from field: string title = 4;
+   */
+  title: string;
+
+  /**
+   * Content format of the template. Defaults to MARKDOWN if unspecified.
+   *
+   * @generated from field: pidgr.v1.TemplateType type = 5;
+   */
+  type: TemplateType;
+};
+
+/**
+ * Describes the message pidgr.v1.CreateTemplateRequest.
+ * Use `create(CreateTemplateRequestSchema)` to create a new message.
+ */
+export const CreateTemplateRequestSchema: GenMessage<CreateTemplateRequest> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_template, 2);
+
+/**
+ * Response after creating a template.
+ *
+ * @generated from message pidgr.v1.CreateTemplateResponse
+ */
+export type CreateTemplateResponse = Message<"pidgr.v1.CreateTemplateResponse"> & {
+  /**
+   * The newly created template (version 1).
+   *
+   * @generated from field: pidgr.v1.Template template = 1;
+   */
+  template?: Template;
+};
+
+/**
+ * Describes the message pidgr.v1.CreateTemplateResponse.
+ * Use `create(CreateTemplateResponseSchema)` to create a new message.
+ */
+export const CreateTemplateResponseSchema: GenMessage<CreateTemplateResponse> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_template, 3);
+
+/**
+ * Request to update a template, creating a new version.
+ *
+ * @generated from message pidgr.v1.UpdateTemplateRequest
+ */
+export type UpdateTemplateRequest = Message<"pidgr.v1.UpdateTemplateRequest"> & {
+  /**
+   * ID of the template to update.
+   *
+   * @generated from field: string template_id = 1;
+   */
+  templateId: string;
+
+  /**
+   * New template body with {{variable}} placeholders.
+   * Constraints: Max length 50000 characters.
+   *
+   * @generated from field: string body = 2;
+   */
+  body: string;
+
+  /**
+   * Updated variables for substitution.
+   *
+   * @generated from field: repeated pidgr.v1.TemplateVariable variables = 3;
+   */
+  variables: TemplateVariable[];
+};
+
+/**
+ * Describes the message pidgr.v1.UpdateTemplateRequest.
+ * Use `create(UpdateTemplateRequestSchema)` to create a new message.
+ */
+export const UpdateTemplateRequestSchema: GenMessage<UpdateTemplateRequest> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_template, 4);
+
+/**
+ * Response after updating a template.
+ *
+ * @generated from message pidgr.v1.UpdateTemplateResponse
+ */
+export type UpdateTemplateResponse = Message<"pidgr.v1.UpdateTemplateResponse"> & {
+  /**
+   * The updated template with incremented version number.
+   *
+   * @generated from field: pidgr.v1.Template template = 1;
+   */
+  template?: Template;
+};
+
+/**
+ * Describes the message pidgr.v1.UpdateTemplateResponse.
+ * Use `create(UpdateTemplateResponseSchema)` to create a new message.
+ */
+export const UpdateTemplateResponseSchema: GenMessage<UpdateTemplateResponse> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_template, 5);
+
+/**
+ * Request to retrieve a specific template version.
+ *
+ * @generated from message pidgr.v1.GetTemplateRequest
+ */
+export type GetTemplateRequest = Message<"pidgr.v1.GetTemplateRequest"> & {
+  /**
+   * ID of the template to retrieve.
+   *
+   * @generated from field: string template_id = 1;
+   */
+  templateId: string;
+
+  /**
+   * Version to retrieve. 0 returns the latest version.
+   *
+   * @generated from field: int32 version = 2;
+   */
+  version: number;
+};
+
+/**
+ * Describes the message pidgr.v1.GetTemplateRequest.
+ * Use `create(GetTemplateRequestSchema)` to create a new message.
+ */
+export const GetTemplateRequestSchema: GenMessage<GetTemplateRequest> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_template, 6);
+
+/**
+ * Response containing the requested template.
+ *
+ * @generated from message pidgr.v1.GetTemplateResponse
+ */
+export type GetTemplateResponse = Message<"pidgr.v1.GetTemplateResponse"> & {
+  /**
+   * The requested template.
+   *
+   * @generated from field: pidgr.v1.Template template = 1;
+   */
+  template?: Template;
+};
+
+/**
+ * Describes the message pidgr.v1.GetTemplateResponse.
+ * Use `create(GetTemplateResponseSchema)` to create a new message.
+ */
+export const GetTemplateResponseSchema: GenMessage<GetTemplateResponse> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_template, 7);
+
+/**
+ * Request to list templates with pagination.
+ *
+ * @generated from message pidgr.v1.ListTemplatesRequest
+ */
+export type ListTemplatesRequest = Message<"pidgr.v1.ListTemplatesRequest"> & {
+  /**
+   * Pagination parameters.
+   *
+   * @generated from field: pidgr.v1.Pagination pagination = 1;
+   */
+  pagination?: Pagination;
+
+  /**
+   * Filter by template type. UNSPECIFIED returns all templates.
+   *
+   * @generated from field: pidgr.v1.TemplateType type = 2;
+   */
+  type: TemplateType;
+};
+
+/**
+ * Describes the message pidgr.v1.ListTemplatesRequest.
+ * Use `create(ListTemplatesRequestSchema)` to create a new message.
+ */
+export const ListTemplatesRequestSchema: GenMessage<ListTemplatesRequest> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_template, 8);
+
+/**
+ * Response containing a page of templates.
+ *
+ * @generated from message pidgr.v1.ListTemplatesResponse
+ */
+export type ListTemplatesResponse = Message<"pidgr.v1.ListTemplatesResponse"> & {
+  /**
+   * List of templates in this page (latest version of each).
+   *
+   * @generated from field: repeated pidgr.v1.Template templates = 1;
+   */
+  templates: Template[];
+
+  /**
+   * Pagination metadata for fetching subsequent pages.
+   *
+   * @generated from field: pidgr.v1.PaginationMeta pagination_meta = 2;
+   */
+  paginationMeta?: PaginationMeta;
+};
+
+/**
+ * Describes the message pidgr.v1.ListTemplatesResponse.
+ * Use `create(ListTemplatesResponseSchema)` to create a new message.
+ */
+export const ListTemplatesResponseSchema: GenMessage<ListTemplatesResponse> = /*@__PURE__*/
+  messageDesc(file_pidgr_v1_template, 9);
+
+/**
+ * Content format of a template, determining which editor and renderer to use.
+ *
+ * @generated from enum pidgr.v1.TemplateType
+ */
+export enum TemplateType {
+  /**
+   * Default value; treated as MARKDOWN for backward compatibility.
+   *
+   * @generated from enum value: TEMPLATE_TYPE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Markdown with {{variable}} placeholders.
+   *
+   * @generated from enum value: TEMPLATE_TYPE_MARKDOWN = 1;
+   */
+  MARKDOWN = 1,
+
+  /**
+   * Rich text format (reserved for future use).
+   *
+   * @generated from enum value: TEMPLATE_TYPE_RICH = 2;
+   */
+  RICH = 2,
+
+  /**
+   * Raw HTML format (reserved for future use).
+   *
+   * @generated from enum value: TEMPLATE_TYPE_HTML = 3;
+   */
+  HTML = 3,
+}
+
+/**
+ * Describes the enum pidgr.v1.TemplateType.
+ */
+export const TemplateTypeSchema: GenEnum<TemplateType> = /*@__PURE__*/
+  enumDesc(file_pidgr_v1_template, 0);
+
+/**
+ * Source from which a template variable's value is resolved at render time.
+ *
+ * @generated from enum pidgr.v1.TemplateVariableSource
+ */
+export enum TemplateVariableSource {
+  /**
+   * Default value; treated as CUSTOM for backward compatibility.
+   *
+   * @generated from enum value: TEMPLATE_VARIABLE_SOURCE_UNSPECIFIED = 0;
+   */
+  UNSPECIFIED = 0,
+
+  /**
+   * Auto-resolved from the target user's profile attributes.
+   *
+   * @generated from enum value: TEMPLATE_VARIABLE_SOURCE_PROFILE = 1;
+   */
+  PROFILE = 1,
+
+  /**
+   * Provided manually in the campaign or workflow step configuration.
+   *
+   * @generated from enum value: TEMPLATE_VARIABLE_SOURCE_CUSTOM = 2;
+   */
+  CUSTOM = 2,
+}
+
+/**
+ * Describes the enum pidgr.v1.TemplateVariableSource.
+ */
+export const TemplateVariableSourceSchema: GenEnum<TemplateVariableSource> = /*@__PURE__*/
+  enumDesc(file_pidgr_v1_template, 1);
+
+/**
+ * Manages versioned message templates used by campaigns.
+ * Templates are append-only — updates create new versions while preserving history.
+ *
+ * @generated from service pidgr.v1.TemplateService
+ */
+export const TemplateService: GenService<{
+  /**
+   * Create a new template with a body and variable definitions.
+   * Authorization: Requires MANAGER+ role.
+   *
+   * @generated from rpc pidgr.v1.TemplateService.CreateTemplate
+   */
+  createTemplate: {
+    methodKind: "unary";
+    input: typeof CreateTemplateRequestSchema;
+    output: typeof CreateTemplateResponseSchema;
+  },
+  /**
+   * Update an existing template, creating a new version.
+   * Authorization: Requires MANAGER+ role.
+   *
+   * @generated from rpc pidgr.v1.TemplateService.UpdateTemplate
+   */
+  updateTemplate: {
+    methodKind: "unary";
+    input: typeof UpdateTemplateRequestSchema;
+    output: typeof UpdateTemplateResponseSchema;
+  },
+  /**
+   * Retrieve a specific template by ID and optional version.
+   * Authorization: Authenticated user within the organization.
+   *
+   * @generated from rpc pidgr.v1.TemplateService.GetTemplate
+   */
+  getTemplate: {
+    methodKind: "unary";
+    input: typeof GetTemplateRequestSchema;
+    output: typeof GetTemplateResponseSchema;
+  },
+  /**
+   * List all templates for the organization with pagination.
+   * Authorization: Authenticated user within the organization.
+   *
+   * @generated from rpc pidgr.v1.TemplateService.ListTemplates
+   */
+  listTemplates: {
+    methodKind: "unary";
+    input: typeof ListTemplatesRequestSchema;
+    output: typeof ListTemplatesResponseSchema;
+  },
+}> = /*@__PURE__*/
+  serviceDesc(file_pidgr_v1_template, 0);
+