/** * #modmail_template.ts * * Code generated by ts-proto. DO NOT EDIT. * @packageDocumentation */ /** Whether a template is used for rejection or publication modmail. */ export declare enum ModmailTemplateActionType { /** MODMAIL_TEMPLATE_ACTION_TYPE_UNSPECIFIED - Unspecified action type. */ MODMAIL_TEMPLATE_ACTION_TYPE_UNSPECIFIED = 0, /** MODMAIL_TEMPLATE_ACTION_TYPE_REJECT - Template is sent when rejecting an app. */ MODMAIL_TEMPLATE_ACTION_TYPE_REJECT = 1, /** MODMAIL_TEMPLATE_ACTION_TYPE_PUBLISH - Template is sent when publishing an app. */ MODMAIL_TEMPLATE_ACTION_TYPE_PUBLISH = 2, UNRECOGNIZED = -1 } /** A modmail message template managed by app reviewers. */ export type ModmailTemplate = { /** The template UUID, for example "a1b2c3d4-5678-90ab-cdef-1234567890ab". */ id: string; /** Short display title, for example "Missing privacy policy". */ title: string; /** The markdown body of the template, for example "Your app is missing a privacy policy link in the description.". */ body: string; /** Whether this template applies to rejection or publication, for example MODMAIL_TEMPLATE_ACTION_TYPE_REJECT. */ actionType: ModmailTemplateActionType; /** Optional group name for grouping related templates, for example "Policy violations". */ groupName: string; /** Zero-based position within the action type list, for example 0. */ sortOrder: number; }; /** Global header/footer configuration applied to all modmail messages. */ export type ModmailConfig = { /** Markdown prepended to rejection messages, for example "Hi, thank you for submitting your app.". */ rejectHeader: string; /** Markdown appended to rejection messages, for example "Please feel free to resubmit after addressing the above.". */ rejectFooter: string; /** Markdown prepended to publication messages, for example "Congratulations!". */ publishHeader: string; /** Markdown appended to publication messages, for example "Your app is now live on the directory.". */ publishFooter: string; }; /** Request to list all modmail templates and the global config. */ export type ListModmailTemplatesRequest = {}; /** Response containing all templates and global config. */ export type ListModmailTemplatesResponse = { /** All modmail templates ordered by action type and sort order. */ templates: ModmailTemplate[]; /** The global header/footer configuration. */ config?: ModmailConfig | undefined; }; /** Request to create a new modmail template. */ export type CreateModmailTemplateRequest = { /** Short display title, for example "Missing privacy policy". */ title: string; /** Markdown body of the template, for example "Your app must include a privacy policy.". */ body: string; /** Whether this template is for rejection or publication, for example "REJECT". */ actionType: string; /** Optional group name, for example "Policy violations". */ groupName: string; }; /** Request to update an existing modmail template. */ export type UpdateModmailTemplateRequest = { /** The template UUID to update, for example "a1b2c3d4-5678-90ab-cdef-1234567890ab". */ id: string; /** New title, if provided, for example "Updated privacy policy". */ title?: string | undefined; /** New body, if provided. */ body?: string | undefined; /** New action type, if provided, for example "PUBLISH". */ actionType?: string | undefined; /** New group name, if provided, for example "Policy violations". */ groupName?: string | undefined; /** New sort order, if provided, for example 3. */ sortOrder?: number | undefined; }; /** Request to delete a single modmail template. */ export type DeleteModmailTemplateRequest = { /** The template UUID to delete, for example "a1b2c3d4-5678-90ab-cdef-1234567890ab". */ id: string; }; /** Request to dissolve or delete a group of templates. */ export type DeleteModmailTemplateGroupRequest = { /** The group name to target, for example "Policy violations". */ groupName: string; /** The action type the group belongs to, for example "REJECT". */ actionType: string; /** If true, un-group the templates instead of deleting them. */ keepTemplates: boolean; }; /** Request to reorder templates by specifying the desired ID order. */ export type ReorderModmailTemplatesRequest = { /** Ordered list of template UUIDs, for example ["id1", "id2", "id3"]. */ templateIds: string[]; }; /** Request to retrieve the global modmail config. */ export type GetModmailConfigRequest = {}; /** Request to update the global modmail config. */ export type UpdateModmailConfigRequest = { /** New reject header, if provided, for example "Hi, thank you for submitting your app.". */ rejectHeader?: string | undefined; /** New reject footer, if provided. */ rejectFooter?: string | undefined; /** New publish header, if provided, for example "Congratulations!". */ publishHeader?: string | undefined; /** New publish footer, if provided. */ publishFooter?: string | undefined; }; //# sourceMappingURL=modmail_template.d.ts.map