@graph8/sdk 0.251.0 → 0.260.0

package/docs/api/signatures.d.ts

@@ -0,0 +1,719 @@
+/* Generated by sdk/js/scripts/generate-agent-docs.ts from developer-contract/openapi.json. Regenerated on every build. */
+
+/**
+ * Types for `g8.api.signatures` (Signatures): 24 operations.
+ *
+ * For reading. In code, import from the package instead:
+ *   import type { ApiInput, ApiOutput, G8Contract } from "@graph8/sdk";
+ *   type In = ApiInput<"archive_signature_template_signatures_templates__template_id__delete">;
+ *
+ * Reference with examples: signatures.md
+ */
+/* eslint-disable */
+
+/** `g8.api.signatures.<member>` -> the operationId it calls. */
+export interface SignaturesMembers {
+  archiveSignatureTemplate: "archive_signature_template_signatures_templates__template_id__delete";
+  assignSignatureIdentity: "assign_signature_identity_signatures_assignments_post";
+  assignSignatureTemplate: "assign_signature_template_signatures_templates__template_id__assign_post";
+  changeSignatureSource: "change_signature_source_signatures_mailboxes__mailbox_id__source_post";
+  createSignatureCampaign: "create_signature_campaign_signatures_campaigns_post";
+  createSignatureTemplate: "create_signature_template_signatures_templates_post";
+  getSignatureReport: "get_signature_report_signatures_reports_get";
+  getSignatureSettings: "get_signature_settings_signatures_settings_get";
+  getSignatureTemplate: "get_signature_template_signatures_templates__template_id__get";
+  listSignatureCampaigns: "list_signature_campaigns_signatures_campaigns_get";
+  listSignatureDeployments: "list_signature_deployments_signatures_mailboxes_get";
+  listSignatureMembers: "list_signature_members_signatures_members_get";
+  listSignatureTemplates: "list_signature_templates_signatures_templates_get";
+  previewSavedSignatureTemplate: "preview_saved_signature_template_signatures_templates__template_id__preview_post";
+  previewSignatureCampaign: "preview_signature_campaign_signatures_campaigns_preview_post";
+  previewSignatureSetup: "preview_signature_setup_signatures_setup_preview_post";
+  previewSignatureTemplate: "preview_signature_template_signatures_preview_post";
+  pushSignature: "push_signature_signatures_mailboxes__mailbox_id__push_post";
+  pushSignatures: "push_signatures_signatures_mailboxes_push_post";
+  restoreSignature: "restore_signature_signatures_mailboxes__mailbox_id__restore_post";
+  setDefaultSignatureTemplate: "set_default_signature_template_signatures_templates__template_id__set_default_post";
+  updateSignatureCampaign: "update_signature_campaign_signatures_campaigns__campaign_id__patch";
+  updateSignatureSettings: "update_signature_settings_signatures_settings_put";
+  updateSignatureTemplate: "update_signature_template_signatures_templates__template_id__patch";
+}
+
+/** Input and output of every `g8.api.signatures` operation, keyed by operationId. */
+export interface SignaturesOperations {
+  /**
+   * DELETE /signatures/templates/{template_id}
+   * Archive Signature Template
+   * tier: destructive · scope: signatures:delete
+   */
+  archive_signature_template_signatures_templates__template_id__delete: {
+    input: {
+    path: {
+      /** Signature template id */
+      template_id: string;
+    };
+    query: {
+      /** Template version you last read. A mismatch is a 409. */
+      version: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SignatureArchiveResponse_;
+  };
+  /**
+   * POST /signatures/assignments
+   * Assign Signature Identity
+   * tier: write · scope: signatures:write
+   */
+  assign_signature_identity_signatures_assignments_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureAssignmentWrite;
+  };
+    output: ApiResponse_list_SignatureAssignmentResult__;
+  };
+  /**
+   * POST /signatures/templates/{template_id}/assign
+   * Assign Signature Template
+   * tier: write · scope: signatures:write
+   */
+  assign_signature_template_signatures_templates__template_id__assign_post: {
+    input: {
+    path: {
+      /** Signature template id */
+      template_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureTemplateTargets;
+  };
+    output: ApiResponse_SignatureBulkTemplateResponse_;
+  };
+  /**
+   * POST /signatures/mailboxes/{mailbox_id}/source
+   * Change Signature Source
+   * tier: write · scope: signatures:write
+   */
+  change_signature_source_signatures_mailboxes__mailbox_id__source_post: {
+    input: {
+    path: {
+      /** Mailbox id (mailboxes.id) — from GET /signatures/mailboxes */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureSourceWrite;
+  };
+    output: ApiResponse_SignatureDeploymentStatus_;
+  };
+  /**
+   * POST /signatures/campaigns
+   * Create Signature Campaign
+   * tier: write · scope: signatures:write
+   */
+  create_signature_campaign_signatures_campaigns_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureCampaignWrite;
+  };
+    output: ApiResponse_SignatureCampaignResponse_;
+  };
+  /**
+   * POST /signatures/templates
+   * Create Signature Template
+   * tier: write · scope: signatures:write
+   */
+  create_signature_template_signatures_templates_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureTemplateWrite;
+  };
+    output: ApiResponse_SignatureTemplateResponse_;
+  };
+  /**
+   * GET /signatures/reports
+   * Get Signature Report
+   * tier: read · scope: signatures:read
+   */
+  get_signature_report_signatures_reports_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * GET /signatures/settings
+   * Get Signature Settings
+   * tier: read · scope: signatures:read
+   */
+  get_signature_settings_signatures_settings_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SignatureSettingsResponse_;
+  };
+  /**
+   * GET /signatures/templates/{template_id}
+   * Get Signature Template
+   * tier: read · scope: signatures:read
+   */
+  get_signature_template_signatures_templates__template_id__get: {
+    input: {
+    path: {
+      /** Signature template id */
+      template_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_SignatureTemplateResponse_;
+  };
+  /**
+   * GET /signatures/campaigns
+   * List Signature Campaigns
+   * tier: read · scope: signatures:read
+   */
+  list_signature_campaigns_signatures_campaigns_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_SignatureCampaignResponse__;
+  };
+  /**
+   * GET /signatures/mailboxes
+   * List Signature Deployments
+   * tier: read · scope: signatures:read
+   */
+  list_signature_deployments_signatures_mailboxes_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_dict__;
+  };
+  /**
+   * GET /signatures/members
+   * List Signature Members
+   * tier: read · scope: signatures:read
+   */
+  list_signature_members_signatures_members_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_SignatureMember__;
+  };
+  /**
+   * GET /signatures/templates
+   * List Signature Templates
+   * tier: read · scope: signatures:read
+   */
+  list_signature_templates_signatures_templates_get: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+  };
+    output: ApiResponse_list_SignatureTemplateResponse__;
+  };
+  /**
+   * POST /signatures/templates/{template_id}/preview
+   * Preview Saved Signature Template
+   * tier: write · scope: signatures:write
+   */
+  preview_saved_signature_template_signatures_templates__template_id__preview_post: {
+    input: {
+    path: {
+      /** Signature template id */
+      template_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureSavedPreviewRequest;
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /signatures/campaigns/preview
+   * Preview Signature Campaign
+   * tier: write · scope: signatures:write
+   */
+  preview_signature_campaign_signatures_campaigns_preview_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureCampaignPreviewRequest;
+  };
+    output: ApiResponse_SignatureCampaignPreviewResponse_;
+  };
+  /**
+   * POST /signatures/setup-preview
+   * Preview Signature Setup
+   * tier: write · scope: signatures:write
+   */
+  preview_signature_setup_signatures_setup_preview_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureSetupPreviewRequest;
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /signatures/preview
+   * Preview Signature Template
+   * tier: write · scope: signatures:write
+   */
+  preview_signature_template_signatures_preview_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignaturePreviewRequest;
+  };
+    output: ApiResponse_dict_;
+  };
+  /**
+   * POST /signatures/mailboxes/{mailbox_id}/push
+   * Push Signature
+   * tier: write · scope: signatures:write
+   */
+  push_signature_signatures_mailboxes__mailbox_id__push_post: {
+    input: {
+    path: {
+      /** Mailbox id (mailboxes.id) — from GET /signatures/mailboxes */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureRevision;
+  };
+    output: ApiResponse_SignatureDeploymentStatus_;
+  };
+  /**
+   * POST /signatures/mailboxes/push
+   * Push Signatures
+   * tier: write · scope: signatures:write
+   */
+  push_signatures_signatures_mailboxes_push_post: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureBulkPushRequest;
+  };
+    output: ApiResponse_SignatureDeploymentStatus_;
+  };
+  /**
+   * POST /signatures/mailboxes/{mailbox_id}/restore
+   * Restore Signature
+   * tier: write · scope: signatures:write
+   */
+  restore_signature_signatures_mailboxes__mailbox_id__restore_post: {
+    input: {
+    path: {
+      /** Mailbox id (mailboxes.id) — from GET /signatures/mailboxes */
+      mailbox_id: number;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureRevision;
+  };
+    output: ApiResponse_SignatureDeploymentStatus_;
+  };
+  /**
+   * POST /signatures/templates/{template_id}/set-default
+   * Set Default Signature Template
+   * tier: write · scope: signatures:write
+   */
+  set_default_signature_template_signatures_templates__template_id__set_default_post: {
+    input: {
+    path: {
+      /** Signature template id */
+      template_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureRevision;
+  };
+    output: ApiResponse_SignatureVersionResponse_;
+  };
+  /**
+   * PATCH /signatures/campaigns/{campaign_id}
+   * Update Signature Campaign
+   * tier: write · scope: signatures:write
+   */
+  update_signature_campaign_signatures_campaigns__campaign_id__patch: {
+    input: {
+    path: {
+      /** Signature campaign id */
+      campaign_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureCampaignWrite;
+  };
+    output: ApiResponse_SignatureCampaignResponse_;
+  };
+  /**
+   * PUT /signatures/settings
+   * Update Signature Settings
+   * tier: write · scope: signatures:write
+   */
+  update_signature_settings_signatures_settings_put: {
+    input: {
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureSettingsWrite;
+  };
+    output: ApiResponse_SignatureSettingsResponse_;
+  };
+  /**
+   * PATCH /signatures/templates/{template_id}
+   * Update Signature Template
+   * tier: write · scope: signatures:write
+   */
+  update_signature_template_signatures_templates__template_id__patch: {
+    input: {
+    path: {
+      /** Signature template id */
+      template_id: string;
+    };
+    headers?: {
+      "X-Target-Org-Id"?: string | null;
+    };
+    body: SignatureTemplateWrite;
+  };
+    output: ApiResponse_SignatureTemplateResponse_;
+  };
+}
+
+// 42 schemas referenced above (the same as G8Contract.<Name>).
+
+export interface ApiResponse_SignatureArchiveResponse_ {
+  data: SignatureArchiveResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SignatureBulkTemplateResponse_ {
+  data: SignatureBulkTemplateResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SignatureCampaignPreviewResponse_ {
+  data: SignatureCampaignPreviewResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SignatureCampaignResponse_ {
+  data: SignatureCampaignResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SignatureDeploymentStatus_ {
+  data: SignatureDeploymentStatus;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SignatureSettingsResponse_ {
+  data: SignatureSettingsResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SignatureTemplateResponse_ {
+  data: SignatureTemplateResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_SignatureVersionResponse_ {
+  data: SignatureVersionResponse;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_dict_ {
+  data: Record<string, unknown>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_SignatureAssignmentResult__ {
+  data: Array<SignatureAssignmentResult>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_SignatureCampaignResponse__ {
+  data: Array<SignatureCampaignResponse>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_SignatureMember__ {
+  data: Array<SignatureMember>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_SignatureTemplateResponse__ {
+  data: Array<SignatureTemplateResponse>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface ApiResponse_list_dict__ {
+  data: Array<Record<string, unknown>>;
+  pagination?: PaginationMeta | null;
+}
+
+export interface Block {
+  id: string;
+  image?: string;
+  kind: "identity" | "contact" | "photo" | "logo" | "social" | "cta" | "banner" | "divider" | "disclaimer" | "green_footer" | "custom_html";
+  locked?: boolean;
+  required?: boolean;
+  text?: string;
+  url?: string;
+}
+
+export interface PaginationMeta {
+  /** Whether there are more pages */
+  has_next: boolean;
+  /** Items per page */
+  limit: number;
+  /** Opaque cursor for the next page; null when there are no more items. Pass it back as the `cursor` query param to fetch the following page without computing page numbers. */
+  next_cursor?: string | null;
+  /** Current page number (1-indexed) */
+  page: number;
+  /** Total number of items */
+  total: number;
+}
+
+export interface SignatureArchiveResponse {
+  archived: boolean;
+}
+
+/** Which employee a mailbox signs as, and which template it renders. */
+export interface SignatureAssignment {
+  account_subject: string;
+  integration_id?: string | null;
+  member_id: string;
+  native_requested?: boolean;
+  overrides?: Record<string, string>;
+  send_as_email: string;
+  template_id?: string | null;
+}
+
+export interface SignatureAssignmentResult {
+  mailbox_id: number;
+  revision: number;
+}
+
+/**
+ * Bind an employee identity to one or more mailboxes.
+ *
+ * ``confirm_takeover`` must be ``true``: assignment replaces whatever signature
+ * those mailboxes send today, and the original is captured for restore.
+ */
+export interface SignatureAssignmentWrite {
+  /** Must be true. Acknowledges that the mailbox's current signature is replaced. */
+  confirm_takeover: true;
+  data: SignatureAssignment;
+  /** mailbox_id -> revision you last read. Use 0 for a mailbox with no assignment yet. */
+  expected_revisions: Record<string, number>;
+  mailbox_ids: Array<number>;
+}
+
+export interface SignatureBulkPushRequest {
+  mailbox_ids: Array<number>;
+}
+
+export interface SignatureBulkTemplateResponse {
+  count: number;
+  results: Array<Record<string, unknown>>;
+}
+
+/** A time-boxed banner campaign injected into managed signatures. */
+export interface SignatureCampaign {
+  block: Block;
+  departments?: Array<string>;
+  ends_at: string;
+  excluded_domains?: Array<string>;
+  external_only?: boolean;
+  mailbox_ids?: Array<number>;
+  name: string;
+  native_static?: boolean;
+  priority?: number;
+  recipient_domains?: Array<string>;
+  recipient_list_ids?: Array<number>;
+  starts_at: string;
+  status?: "draft" | "scheduled" | "paused";
+}
+
+/** Render a campaign banner without saving it, optionally against a mailbox. */
+export interface SignatureCampaignPreviewRequest {
+  /** Exclude this campaign from the priority comparison when previewing an edit. */
+  campaign_id?: string | null;
+  data: SignatureCampaign;
+  /** Evaluate the campaign's targeting rules against this mailbox. Omit to render only. */
+  mailbox_id?: number | null;
+  /** Candidate recipient addresses to test the targeting rules against. */
+  recipients?: Array<string>;
+  /** Revision you last read. Ignored on create. */
+  version?: number;
+}
+
+export interface SignatureCampaignPreviewResponse {
+  html: string;
+  /** Targeting evaluation. Null unless mailbox_id was supplied. */
+  matching?: Record<string, unknown> | null;
+  native_static: boolean;
+  plain: string;
+}
+
+export interface SignatureCampaignResponse {
+  /** The stored campaign document. */
+  data: Record<string, unknown>;
+  id: string;
+  revision: number;
+}
+
+/** Create or update a signature banner campaign. */
+export interface SignatureCampaignWrite {
+  data: SignatureCampaign;
+  /** Revision you last read. Ignored on create. */
+  version?: number;
+}
+
+/** The outcome of a deployment-changing operation. */
+export interface SignatureDeploymentStatus {
+  message?: string | null;
+  revision?: number | null;
+  status: string;
+}
+
+/** A directory employee who can be assigned a managed signature. */
+export interface SignatureMember {
+  department?: string | null;
+  email?: string | null;
+  id: string;
+  name?: string | null;
+}
+
+/** Render an unsaved template draft. */
+export interface SignaturePreviewRequest {
+  data: SignatureTemplate;
+  mailbox_id?: number | null;
+  /** Render with this employee's real details. Requires mailbox_id; otherwise sample data is used. */
+  member_id?: string | null;
+  overrides?: Record<string, string>;
+}
+
+/** Optimistic-concurrency token for a per-mailbox deployment or a template. */
+export interface SignatureRevision {
+  /** Revision you last read. A mismatch is a 409. */
+  version: number;
+}
+
+/** Render a template that is already stored. */
+export interface SignatureSavedPreviewRequest {
+  mailbox_id?: number | null;
+  member_id?: string | null;
+}
+
+/** Org-wide signature policy document. Same contract as the in-app editor. */
+export interface SignatureSettings {
+  allow_employee_overrides?: boolean;
+  cold_sends_variant?: "full" | "compact";
+  default_template_id?: string | null;
+  department_templates?: Record<string, string>;
+  mode?: "off" | "default" | "enforced";
+  native_enabled?: boolean;
+}
+
+export interface SignatureSettingsResponse {
+  /** The stored policy document. */
+  data: Record<string, unknown>;
+  /** Version after the write; pass it to the next update. */
+  version: number;
+}
+
+/** Replace the org-wide signature policy. Optimistic-concurrency checked. */
+export interface SignatureSettingsWrite {
+  data: SignatureSettings;
+  /** Version you last read. A mismatch is a 409. */
+  version: number;
+}
+
+/** Check that a mailbox's provider account and send-as alias are usable. */
+export interface SignatureSetupPreviewRequest {
+  data: SignatureAssignment;
+  mailbox_id: number;
+}
+
+/** Switch which signature a mailbox sends: org default, a named template, or its own. */
+export interface SignatureSourceWrite {
+  source: "org" | "template" | "custom";
+  /** Required when source is 'template'. */
+  template_id?: string | null;
+  /** Revision you last read. A mismatch is a 409. */
+  version: number;
+}
+
+/** A signature template's blocks, layout and branding. */
+export interface SignatureTemplate {
+  blocks: Array<Block>;
+  brand_source?: "brand_kit" | "custom";
+  font?: "Arial" | "Verdana" | "Georgia" | "Tahoma";
+  layout?: "classic-stacked" | "photo-left" | "logo-left" | "two-column" | "compact-inline" | "banner-hero";
+  name: string;
+  primary_color?: string;
+}
+
+export interface SignatureTemplateResponse {
+  /** The stored template document. */
+  data: Record<string, unknown>;
+  id: string;
+  version: number;
+}
+
+/** Apply one template across mailboxes. Choose exactly one targeting mode. */
+export interface SignatureTemplateTargets {
+  /** Every active, assigned mailbox. */
+  all_mailboxes?: boolean;
+  /** Every assigned mailbox whose employee is in this department. */
+  department?: string | null;
+  mailbox_ids?: Array<number>;
+}
+
+/** Create or update a signature template. */
+export interface SignatureTemplateWrite {
+  data: SignatureTemplate;
+  /** Version you last read. Ignored on create. */
+  version?: number;
+}
+
+export interface SignatureVersionResponse {
+  version: number;
+}