@assinafy/sdk 2.1.1 → 2.1.2

package/dist/index.d.ts

@@ -3,7 +3,9 @@ import { AxiosInstance, AxiosResponse } from 'axios';
 /** Document lifecycle states emitted by the API. */
 type DocumentStatus = 'uploading' | 'uploaded' | 'metadata_processing' | 'metadata_ready' | 'pending_signature' | 'expired' | 'certificating' | 'certificated' | 'rejected_by_signer' | 'rejected_by_user' | 'failed';
 /** Artifact names available for document download. */
-type DocumentArtifactName = 'original' | 'certificated' | 'certificate-page' | 'bundle';
+type DocumentArtifactName = 'original' | 'certificated' | 'certificate-page' | 'pades' | 'bundle';
+/** Server-defined signature image category, with known values suggested. */
+type SignatureImageType = 'signature' | 'initial' | AnyString;
 /**
  * Any string, while keeping editor autocomplete for the literals it is unioned
  * with.
@@ -21,9 +23,9 @@ type AnyString = string & {};
 /** Assignment methods supported by the API. */
 type AssignmentMethod = 'virtual' | 'collect';
 /** Verification methods accepted by assignment signer entries. */
-type AssignmentVerificationMethod = 'Email' | 'Whatsapp' | AnyString;
+type AssignmentVerificationMethod = 'Email' | 'Whatsapp' | 'DigitalCertificate';
 /** Notification methods accepted by assignment signer entries. */
-type AssignmentNotificationMethod = 'Email' | 'Whatsapp' | AnyString;
+type AssignmentNotificationMethod = 'Email' | 'Whatsapp';
 /** Minimal logger contract (compatible with console, pino, winston, etc.). */
 interface Logger {
     debug: (message: string, context?: Record<string, unknown>) => void;
@@ -42,7 +44,10 @@ interface AssinafyClientOptions {
     token?: string;
     /** Default account (workspace) ID applied to account-scoped endpoints. */
     accountId?: string;
-    /** Override the API base URL. Defaults to https://api.assinafy.com.br/v1. */
+    /**
+     * Override the API base URL. Defaults to https://api.assinafy.com.br/v1.
+     * Must be absolute HTTP(S) without credentials, a query, or a fragment.
+     */
     baseUrl?: string;
     /**
      * Secret for an opt-in HMAC-SHA256 convention implemented by your own
@@ -54,8 +59,10 @@ interface AssinafyClientOptions {
     timeout?: number;
     /**
      * Max automatic retries on HTTP 429 (rate limit), honoring `Retry-After`.
-     * Automatic retries are limited to idempotent GET, HEAD, OPTIONS, PUT, and
-     * DELETE requests, plus requests carrying an explicit `Idempotency-Key`.
+     * Automatic retries are limited to replay-safe GET, HEAD, OPTIONS, and
+     * DELETE requests. `GET /sign` is excluded because it records a signer
+     * view. An explicit `Idempotency-Key` opts other requests into SDK replay;
+     * callers must confirm server-side deduplication for the target route.
      * Defaults to `2`. Set to `0` to disable retrying.
      */
     maxRetries?: number;
@@ -74,9 +81,9 @@ interface ICreateSignerPayload {
     whatsapp_phone_number?: string;
     /** Compatibility alias normalized to `whatsapp_phone_number` before sending. */
     phone?: string;
-    /** Unverified request extension. Brazilian CPF; non-digits are stripped. */
+    /** Compatibility extension. Brazilian CPF; non-digits are stripped. */
     cpf?: string;
-    /** Unverified request extension retained for existing integrations. */
+    /** Compatibility extension retained for existing integrations. */
     metadata?: Record<string, unknown>;
 }
 /** Payload for updating a signer. */
@@ -86,8 +93,10 @@ interface IUpdateSignerPayload {
     whatsapp_phone_number?: string;
     /** Compatibility alias normalized to `whatsapp_phone_number` before sending. */
     phone?: string;
-    /** Unverified request extension. Brazilian CPF; non-digits are stripped. */
+    /** Compatibility extension. Brazilian CPF; non-digits are stripped. */
     cpf?: string;
+    /** Official CPF/CNPJ field; non-digits are stripped before sending. */
+    government_id?: string;
 }
 /** Signer object as returned by the API. */
 interface ISigner {
@@ -112,9 +121,12 @@ interface ISigner {
 }
 /** Signer profile returned by the signer-code-authenticated `GET /signers/self`. */
 interface ISignerSelf extends ISigner {
-    has_signature: boolean;
-    has_initial: boolean;
-    is_signature_reusable: boolean;
+    /** Optional for compatibility with deployments that omit this field. */
+    has_signature?: boolean;
+    /** Optional for compatibility with deployments that omit this field. */
+    has_initial?: boolean;
+    /** Optional for compatibility with deployments that omit this field. */
+    is_signature_reusable?: boolean;
 }
 /** Official identity fields accepted by the signer `confirm-data` operation. */
 interface IConfirmSignerDataPayload {
@@ -123,28 +135,27 @@ interface IConfirmSignerDataPayload {
     email?: string;
     /** Government-issued identifier recorded with the signature. */
     government_id?: string;
+    /**
+     * Accept terms atomically with identity confirmation. Required before
+     * opening a DigitalCertificate assignment unless `acceptTerms()` was called.
+     */
+    has_accepted_terms?: boolean;
 }
 /**
  * Compatibility input retained for integrations written against older
- * Assinafy deployments. Neither extra property belongs to the current
+ * Assinafy deployments. The extra phone property does not belong to the current
  * `confirm-data` request schema.
  */
 interface ILegacyConfirmSignerDataPayload extends IConfirmSignerDataPayload {
     /**
-     * @deprecated Unverified legacy field. Prefer updating the account signer
+     * @deprecated Compatibility field. Prefer updating the account signer
      * record before starting the signing flow.
      */
     whatsapp_phone_number?: string;
-    /**
-     * @deprecated Unverified legacy pass-through. It does not replace the
-     * official `acceptTerms()` operation and must not be treated as proof of
-     * legal consent.
-     */
-    has_accepted_terms?: boolean;
 }
 /** Official options for uploading the PNG signature image described by OpenAPI. */
 interface IUploadSignatureOptions {
-    imageType?: 'signature' | 'initial';
+    imageType?: SignatureImageType;
     /** Persist this image so it is reused on future documents. */
     reuse?: boolean;
 }
@@ -152,10 +163,11 @@ interface IUploadSignatureOptions {
 interface ILegacyUploadSignatureOptions extends IUploadSignatureOptions {
     /**
      * @deprecated The current API contract accepts only `image/png`. Non-PNG
-     * values are retained as an unverified compatibility escape hatch.
+     * values are retained as a compatibility escape hatch.
      */
     contentType?: string;
 }
+/** Signer returned after create or update. */
 type ICreateSignerResponse = ISigner;
 /** Pagination metadata extracted from `X-Pagination-*` response headers. */
 interface PaginationMeta {
@@ -171,6 +183,7 @@ interface PaginatedResult<T> {
 }
 /** @deprecated use {@link PaginatedResult} — retained for existing type imports. */
 type IPaginatedResponse<T> = PaginatedResult<T>;
+/** Paginated signer-list response. */
 type ISignerListResponse = PaginatedResult<ISigner>;
 /** Signer reference accepted by the assignment endpoints. */
 type SignerReference = string | {
@@ -198,30 +211,42 @@ interface ICreateAssignmentPayload {
      * shape before sending.
      */
     signers?: SignerReference[];
-    /** Legacy field still accepted by the API docs and used by the PHP SDK. */
+    /** Compatibility alias rewritten by the SDK to the official `signers` field. */
     signer_ids?: string[];
     /** Camel-case legacy alias used by the quick-start docs. */
     signerIds?: string[];
     message?: string;
     expires_at?: string;
     /**
-     * Recipients CC'd on the signature request.
-     *
-     * ⚠️ Observed to be **silently dropped** on the sandbox plan: values sent
-     * here came back as `[]` from `assignments.create`, `assignments.list` and
-     * `documents.details().assignment` alike, for both email addresses and
-     * signer IDs. The field is accepted (no error) but nothing is persisted.
+     * Existing signer IDs to CC on the signature request (not email addresses).
      *
-     * It is retained because this was verified on a single sandbox account and
-     * may be plan-gated — the WhatsApp channel on the same account is rejected
-     * with an explicit plan error, so silent no-ops for un-provisioned features
-     * are plausible. **Do not rely on it without verifying against your own
-     * account**, and do not treat a CC as delivered.
+     * This can be plan-dependent. Confirm that returned assignment data retains
+     * the IDs before treating a copy as delivered; unsupported plans may accept
+     * the field but return an empty array.
      */
     copy_receivers?: string[];
     /** Field placement entries used when `method` is `collect`. */
     entries?: IAssignmentEntry[];
 }
+/**
+ * Field rectangle used by collect assignments. Coordinates are pixels in the
+ * API's 150-DPI page image, measured from the upper-left corner.
+ */
+interface IDisplaySettings {
+    left: number;
+    top: number;
+    width: number;
+    height: number;
+    fontSize: number;
+    fontFamily?: string;
+    backgroundColor?: string;
+}
+/**
+ * Assignment-item rendering metadata. Collect items use
+ * {@link IDisplaySettings}; older virtual responses can contain an empty array
+ * or another JSON primitive instead.
+ */
+type AssignmentDisplaySettings = IDisplaySettings | unknown[] | string | number | boolean | null;
 /**
  * A field-placement entry for a `collect`-method assignment: one page and the
  * per-signer fields positioned on it.
@@ -231,12 +256,8 @@ interface IAssignmentEntry {
     fields: Array<{
         signer_id: string;
         field_id: string;
-        /**
-         * Opaque, server-defined placement settings (position, size, …). Left
-         * loosely typed: the spec models it as a bare object and the live API
-         * returns an unstable shape (an empty array on assignment items).
-         */
-        display_settings?: Record<string, unknown>;
+        /** Rectangle and presentation metadata for this field. */
+        display_settings?: IDisplaySettings;
     }>;
 }
 /** Channel descriptor accepted by assignment cost estimation. */
@@ -259,9 +280,12 @@ interface IEstimateAssignmentCostPayload {
 interface IAssignmentSigner extends ISigner {
     /** Only present in account-owner contexts; omitted from signer-code responses. */
     completed?: boolean | null;
-    notification_history: INotificationHistoryEntry[] | null;
-    verification_method: AssignmentVerificationMethod | null;
-    notification_methods: AssignmentNotificationMethod[] | null;
+    /** Optional because some deployments omit notification history. */
+    notification_history?: INotificationHistoryEntry[] | null;
+    /** Server-controlled response value; request payloads use the strict request enum. */
+    verification_method: AssignmentVerificationMethod | AnyString | null;
+    /** Server-controlled response values; request payloads use the strict request enum. */
+    notification_methods: Array<AssignmentNotificationMethod | AnyString> | null;
     /** 1-based signing order. See {@link SignerReference.step}. */
     step: number | null;
     notified: boolean | null;
@@ -287,6 +311,8 @@ interface IAssignmentItem {
     } | null;
     signer: ISigner;
     field: IFieldDefinition | null;
+    /** Collect settings or a documented legacy/non-object wire value. */
+    display_settings?: AssignmentDisplaySettings;
     /** Captured field value; its wire type depends on the field definition. */
     value: unknown | null;
     completed?: boolean;
@@ -318,7 +344,9 @@ interface IAssignment {
         url: string;
     }>;
 }
+/** Assignment returned after requesting signatures. */
 type ICreateAssignmentResponse = IAssignment;
+/** Acknowledgement returned after resending a signature notification. */
 interface IResendEmailResponse {
     is_sent: boolean;
     document_id: string;
@@ -344,17 +372,15 @@ interface ICostEstimate {
     document_balance: number;
     credit_balance: number;
     has_sufficient_resources: boolean;
-    /** `null` when the operation can proceed; otherwise a reason code. */
-    blocking_reason: string | null;
+    /** `null` when the operation can proceed; otherwise the documented reason code. */
+    blocking_reason: 'PendingPayment' | 'InsufficientDocuments' | 'InsufficientCredits' | null;
     message: string | null;
 }
 /**
  * Legacy resend-cost payload still returned by some Assinafy environments.
  *
- * The current OpenAPI contract declares {@link ICostEstimate} for this route,
- * while the sandbox has also returned this smaller, resend-specific shape.
- * The SDK models both wire formats instead of promising fields that may be
- * absent at runtime.
+ * This smaller, resend-specific compatibility shape can be returned instead of
+ * {@link ICostEstimate}; the SDK models both wire formats.
  */
 interface ILegacyResendCostEstimate {
     total: number;
@@ -396,7 +422,7 @@ type WebhookEventType = 'document_uploaded' | 'document_metadata_ready' | 'docum
 interface IDocumentListItem {
     id: string;
     name: string;
-    status: DocumentStatus;
+    status: DocumentStatus | AnyString;
     account_id?: string;
     template_id?: string | null;
     /** Artifact download URLs keyed by name (`original`, `thumbnail`, …). */
@@ -413,9 +439,14 @@ interface IDocumentListItem {
     updated_at?: string;
     is_closed?: boolean;
 }
+/** Paginated document-list/search response. */
 type IDocumentListResponse = PaginatedResult<IDocumentListItem>;
 /** Query parameters accepted by `documents.list`. */
 interface IDocumentListParams extends IListParams {
+    /** Free-text term matched against document fields. */
+    search?: string;
+    /** Sort expression accepted by the document list endpoint. */
+    sort?: string;
     /** Filter by document status, e.g. `pending_signature`. */
     status?: DocumentStatus | AnyString;
     /** Filter by signature method (`virtual` or `collect`). */
@@ -426,15 +457,14 @@ interface IDocumentListParams extends IListParams {
 /**
  * Response of `documents.rename` (`PATCH /documents/{documentId}`).
  *
- * The rename endpoint returns the document **without** `pages` or
- * `assignment` — verified against the live API, which echoes only
+ * The response can omit `pages` and `assignment` and return only
  * `resource`, `id`, `account_id`, `template_id`, `name`, `status`,
  * `artifacts`, `signing_url`, `is_closed`, `decline_reason`, `declined_by`,
- * `tags`, `created_at` and `updated_at`. Typing it as a full
- * {@link IDocumentDetailsResponse} would promise a required `pages` array that
- * is absent at runtime, so `result.pages.length` would throw.
+ * `tags`, `created_at` and `updated_at`. The two fields are therefore optional:
+ * callers get the complete document fields without being promised values that
+ * can be absent at runtime.
  */
-type IRenameDocumentResponse = Omit<IDocumentDetailsResponse, 'pages' | 'assignment'>;
+type IRenameDocumentResponse = Omit<IDocumentDetailsResponse, 'pages' | 'assignment'> & Partial<Pick<IDocumentDetailsResponse, 'pages' | 'assignment'>>;
 /** Query parameters accepted by `documents.search`. */
 interface IDocumentSearchParams extends IListParams {
     /** Free-text term matched against the document name. */
@@ -462,13 +492,14 @@ interface IDocumentUploadResponse {
     account_id: string;
     template_id: string | null;
     name: string;
-    status: DocumentStatus;
+    status: DocumentStatus | AnyString;
     /** Absent on a fresh upload; an {@link IAssignment} (or `null`) once one exists. */
     assignment?: IAssignment | null;
     artifacts: {
         original: string;
         certificated?: string;
         'certificate-page'?: string;
+        pades?: string;
         bundle?: string;
         thumbnail?: string;
     };
@@ -498,7 +529,7 @@ interface IDocumentDetailsResponse {
     account_id: string;
     template_id?: string | null;
     name: string;
-    status: DocumentStatus;
+    status: DocumentStatus | AnyString;
     assignment: IAssignment | null;
     download_url?: string;
     download_final_url?: string;
@@ -507,6 +538,7 @@ interface IDocumentDetailsResponse {
         original: string;
         certificated?: string;
         'certificate-page'?: string;
+        pades?: string;
         bundle?: string;
         thumbnail?: string;
     };
@@ -521,11 +553,12 @@ interface IDocumentDetailsResponse {
     declined_by?: ISigner | null;
     activities?: Array<IDocumentActivity>;
 }
+/** One immutable activity event returned by `documents.activities()`. */
 interface IDocumentActivity {
     id: number;
     event: string;
     message: string;
-    /** Event-specific payload snapshot. Object for most events, occasionally `[]` or `null`. */
+    /** Event-specific payload. Object for most events, occasionally `[]` or `null`. */
     payload?: Record<string, unknown> | unknown[] | null;
     /** Request origin (`ip` / `user-agent`) when available; `null` for system events. */
     origin: {
@@ -546,10 +579,21 @@ interface IListParams {
     page?: number;
     per_page?: number;
     'per-page'?: number;
+    /** Compatibility filter used by several list endpoints. */
     search?: string;
+    /** Compatibility sort expression retained for existing integrations. */
     sort?: string;
+    /** Deployment-specific list filters retained for backwards compatibility. */
     [key: string]: string | number | boolean | undefined;
 }
+/** Query parameters accepted by `signers.list`. */
+interface ISignerListParams extends IListParams {
+    search?: string;
+}
+/** Query parameters accepted by `templates.list`. */
+interface ITemplateListParams extends IListParams {
+    search?: string;
+}
 /**
  * Workspace creation payload.
  *
@@ -557,7 +601,7 @@ interface IListParams {
  * which accept a leading `#` and strip it — the account endpoints require an
  * **exactly 6-character hex string with NO leading `#`** (`'ff0066'`, not
  * `'#ff0066'`); a 7-character `#`-prefixed value is rejected with `400`
- * ("Primary Color" deve conter 6 caracteres). Verified live against the API.
+ * ("Primary Color" deve conter 6 caracteres).
  */
 interface ICreateWorkspacePayload {
     name: string;
@@ -578,6 +622,7 @@ interface IUpdateWorkspacePayload {
     /** 6-char hex, no leading `#`. */
     secondary_color?: string | null;
 }
+/** Workspace returned by account create/get/update operations. */
 interface IWorkspaceResponse {
     resource?: string;
     id: string;
@@ -591,10 +636,12 @@ interface IWorkspaceResponse {
 }
 /** Notification sender identity accepted by account create/update operations. */
 type NotificationSenderType = 'User' | 'Account';
+/** Workspace list item with the caller's roles and deletion permission. */
 interface IWorkspaceListItem extends IWorkspaceResponse {
     is_delete_allowed: boolean;
     roles: string[];
 }
+/** Paginated workspace-list response. */
 type IWorkspaceListResponse = PaginatedResult<IWorkspaceListItem>;
 /** Branding returned by `GET /accounts/{accountId}/theme`. */
 interface IAccountTheme {
@@ -614,18 +661,31 @@ interface IDocumentStatsParams {
     /** Target `YYYY-MM`; required when `granularity` is `daily`. */
     month?: string;
 }
-/** One zero-filled document-funnel KPI period. */
+/**
+ * One zero-filled document-funnel KPI period. Notification counters are not
+ * mutually exclusive; verification counters are and sum to
+ * `signature_requests`.
+ */
 interface IDocumentStatsRow {
     /** `YYYY-MM` for monthly results or `YYYY-MM-DD` for daily results. */
     period: string;
     documents_uploaded: number;
     documents_sent: number;
     signature_requests: number;
-    signature_requests_email: number;
-    signature_requests_whatsapp: number;
+    signature_requests_notification_email: number;
+    signature_requests_notification_whatsapp: number;
+    signature_requests_notification_bypass: number;
+    signature_requests_verification_email: number;
+    signature_requests_verification_whatsapp: number;
+    signature_requests_verification_bypass: number;
+    signature_requests_verification_digital_certificate: number;
     signature_requests_viewed: number;
     signature_requests_completed: number;
     documents_certified: number;
+    /** @deprecated Older deployment field; use `signature_requests_notification_email`. */
+    signature_requests_email?: number;
+    /** @deprecated Older deployment field; use `signature_requests_notification_whatsapp`. */
+    signature_requests_whatsapp?: number;
 }
 /** Webhook subscription payload. */
 interface IWebhookRegisterPayload {
@@ -651,10 +711,12 @@ interface IWebhookSubscription {
     is_active: boolean;
     updated_at?: string | null;
 }
+/** Event code and human-readable description from the webhook event catalog. */
 interface IWebhookEventTypeInfo {
     id: WebhookEventType | AnyString;
     description: string;
 }
+/** One webhook delivery attempt returned by the delivery-history endpoints. */
 interface IWebhookDispatch {
     resource?: string;
     id: string;
@@ -664,6 +726,7 @@ interface IWebhookDispatch {
     payload: IWebhookPayload | Record<string, unknown> | null;
     delivered: boolean;
     http_status: number | null;
+    /** Receiving endpoint body, truncated by Assinafy to 2,000 characters. */
     response_body: string | null;
     error: string | null;
     /** ISO-8601 UTC timestamp, e.g. `'2026-07-15T20:04:36Z'`. */
@@ -671,6 +734,7 @@ interface IWebhookDispatch {
     /** ISO-8601 UTC timestamp, e.g. `'2026-07-15T20:04:36Z'`. */
     updated_at?: string;
 }
+/** Filters accepted by `webhooks.listDispatches()`. */
 interface IWebhookDispatchListParams extends IListParams {
     event?: WebhookEventType | AnyString;
     delivered?: boolean | 'true' | 'false';
@@ -684,7 +748,7 @@ interface IUploadAndRequestSignaturesResult {
      * fully-processed {@link IDocumentDetailsResponse} re-fetched after the
      * assignment is created — so `status`, `pages` and the embedded `assignment`
      * are current. When `waitForReady` is `false` it is the raw
-     * {@link IDocumentUploadResponse} upload snapshot (`status: 'uploaded'`).
+     * {@link IDocumentUploadResponse} upload response (`status: 'uploaded'`).
      */
     document: IDocumentUploadResponse | IDocumentDetailsResponse;
     assignment: IAssignment;
@@ -728,7 +792,8 @@ interface ITemplateListItem {
      * Rendered pages, each with a `download_url`. Empty until the template
      * finishes processing (`status: 'Ready'`). Both the list and get endpoints
      * return `pages`, so there is no need to fetch a template again just to read
-     * them.
+     * them. The URL requires API-key authentication; prefer
+     * `templates.downloadPage()` to fetch its bytes.
      */
     pages?: IPage[];
     roles?: ITemplateRole[];
@@ -737,8 +802,8 @@ interface ITemplateListItem {
     created_at: string;
     updated_at?: string;
 }
+/** Paginated template-list response. */
 type ITemplateListResponse = PaginatedResult<ITemplateListItem>;
-/** Full template details. */
 /**
  * A rendered page of a document or template.
  *
@@ -766,7 +831,7 @@ interface IPage {
     height: number;
     /** Rendered width in pixels (150 DPI). */
     width: number;
-    /** Absolute URL of the page's JPEG rendering. */
+    /** Absolute API-key-authenticated URL of the page's JPEG rendering. */
     download_url?: string;
     /** Fields positioned on this page. Present on templates; absent on documents. */
     fields?: ITemplateFieldPlacement[];
@@ -782,6 +847,7 @@ interface ITemplateFieldPlacement {
     created_at?: string;
     updated_at?: string;
 }
+/** Full template details returned by `templates.get()`. */
 interface ITemplateDetailsResponse {
     resource?: string;
     id: string;
@@ -804,8 +870,8 @@ interface ITemplateDetailsResponse {
 interface ITemplateSigner {
     role_id: string;
     id: string;
-    verification_method?: string;
-    notification_methods?: string[];
+    verification_method?: AssignmentVerificationMethod;
+    notification_methods?: AssignmentNotificationMethod[];
     /** Positive integer controlling signing order (see {@link SignerReference}). */
     step?: number;
 }
@@ -815,8 +881,8 @@ interface ITemplateSigner {
  */
 interface ITemplateCostSigner {
     role_id: string;
-    verification_method?: string;
-    notification_methods?: string[];
+    verification_method?: AssignmentVerificationMethod;
+    notification_methods?: AssignmentNotificationMethod[];
 }
 /** Options for creating a document from a template. */
 interface ICreateDocumentFromTemplateOptions {
@@ -837,7 +903,7 @@ interface ICreateDocumentFromTemplateOptions {
  * Item returned by `GET /documents/statuses`.
  *
  * The API uses `code` (the status name); we mirror that field. `description`
- * is documented in the table but is not currently present in the JSON payload.
+ * is optional because responses can omit it.
  */
 interface IDocumentStatusInfo {
     code: DocumentStatus | AnyString;
@@ -849,9 +915,9 @@ interface IPublicDocumentInfo extends Partial<Omit<IDocumentDetailsResponse, 'id
     resource?: string;
     id: string;
     name: string;
-    /** Observed legacy/public response field; not present in the current schema. */
+    /** Optional compatibility response field. */
     page_count?: string | number;
-    /** Observed legacy/public response field; not present in the current schema. */
+    /** Optional compatibility response field. */
     created_by?: string;
     [key: string]: unknown;
 }
@@ -870,7 +936,6 @@ interface IDocumentVerification {
 }
 /** Channel accepted by the `send-token` endpoint. */
 type SendTokenChannel = 'email' | 'whatsapp' | AnyString;
-/** Authentication: login response (also returned by social login). */
 /** Authenticated user profile returned by login and `users.getCurrent()`. */
 interface IAuthenticatedUser {
     id: string;
@@ -880,11 +945,30 @@ interface IAuthenticatedUser {
     government_id: string | null;
     is_email_verified: boolean;
     has_accepted_terms: boolean;
-    /** Live compatibility field; absent from the current OpenAPI `AuthUser` schema. */
+    /** Compatibility field. */
     is_password_set?: boolean;
     created_at: string;
     to_be_deleted_at: string | null;
 }
+/**
+ * Owner-facing document e-mail preferences returned by
+ * `GET /users/self/notification-preferences`. The API always returns all nine
+ * keys; `true` means that notification is enabled.
+ */
+interface INotificationPreferences {
+    DocumentCompleted: boolean;
+    SignerDeclined: boolean;
+    DocumentCancelled: boolean;
+    DocumentAboutToExpire: boolean;
+    DocumentExpired: boolean;
+    DocumentExpirationReset: boolean;
+    DocumentProcessingFailed: boolean;
+    TemplateProcessingFailed: boolean;
+    SignerWhatsappFailed: boolean;
+}
+/** Partial preference map accepted by `PUT /users/self/notification-preferences`. */
+type IUpdateNotificationPreferences = Partial<INotificationPreferences>;
+/** Login/social-login response containing the bearer token, user, and accounts. */
 interface ILoginResponse {
     access_token: string;
     user: IAuthenticatedUser;
@@ -924,16 +1008,16 @@ interface ICreateFieldPayload {
     name: string;
     regex?: string | null;
     is_required?: boolean;
-    /** Live compatibility extension; absent from the current create schema. */
+    /** Compatibility extension. */
     is_active?: boolean;
 }
 /** Payload for updating a field definition. */
 interface IUpdateFieldPayload {
-    /** Live compatibility extension; absent from the current update schema. */
+    /** Compatibility extension. */
     type?: string;
     name?: string;
     regex?: string | null;
-    /** Live compatibility extension; absent from the current update schema. */
+    /** Compatibility extension. */
     is_required?: boolean;
     is_active?: boolean;
 }
@@ -942,13 +1026,28 @@ interface IFieldType {
     type: string;
     name: string;
 }
-/** Single result returned by `POST /accounts/{id}/fields/{id}/validate`. */
+/**
+ * @deprecated Compatibility shape previously shared by both field-validation
+ * endpoints. Prefer {@link IFieldValidationResponse} for a single value or
+ * {@link IFieldValidationMultipleResult} for one item in a batch response.
+ */
 interface IFieldValidationResult {
     type?: string;
     field_id?: string;
     success: boolean;
     error_message: string;
 }
+/** Result returned by `POST /accounts/{id}/fields/{id}/validate`. */
+interface IFieldValidationResponse extends IFieldValidationResult {
+    type: string;
+    /** The single-value endpoint does not return a field ID. */
+    field_id?: never;
+}
+/** One item returned by `POST /accounts/{id}/fields/validate-multiple`. */
+interface IFieldValidationMultipleResult extends IFieldValidationResult {
+    type: string;
+    field_id: string;
+}
 /** Payload entry for `POST /accounts/{id}/fields/validate-multiple`. */
 interface IFieldValidateMultipleEntry {
     field_id: string;
@@ -985,6 +1084,14 @@ interface ITag {
     created_at: string;
     updated_at: string;
 }
+/** Acknowledgement returned after detaching a tag from a document. */
+interface IDetachDocumentTagResponse {
+    detached: boolean;
+}
+/** Acknowledgement returned after deleting a workspace tag. */
+interface IDeleteTagResponse {
+    deleted: boolean;
+}
 /** Inline tag shape embedded inside documents/templates (`{ id, name, color? }`). */
 interface IInlineTag {
     id: string;
@@ -1127,7 +1234,8 @@ declare class DocumentResource extends BaseResource {
      * }
      * ```
      * @throws {ValidationError} If the file is empty, not a `.pdf`, exceeds
-     * 25 MB, or the API returns no document ID.
+     * 25 MB, or the API returns no document ID. The API rejects PDFs over
+     * 2,000 pages.
      * @throws {ApiError} If the API rejects the upload.
      *
      * @example
@@ -1150,8 +1258,10 @@ declare class DocumentResource extends BaseResource {
      * so prefer it when you need signing state or page geometry. Pagination
      * info (if any) is attached in `meta`.
      *
-     * @param params - Filters and pagination: `status`, `method`, `tags`
-     * (comma-separated tag IDs), `search`, `sort`, `page`, `per-page`.
+     * @param params - Filters and pagination: `status`; `method` (`virtual` or
+     * `collect`); `tags` (comma-separated IDs, all of which must match);
+     * `search` (document name, signer name, or signer email); `sort` (`name` or
+     * `updated_at`); `page`; and `per-page` (maximum 100).
      * @param accountId - Override the client's default account ID.
      * @returns Matching documents, with pagination in `meta`. Each item:
      * ```jsonc
@@ -1254,10 +1364,29 @@ declare class DocumentResource extends BaseResource {
      *
      * @param documentId - The document to rename.
      * @param name - The new display name (max 255 chars), e.g.
-     * `'Service agreement.pdf'`.
-     * @returns The updated document — **without** `pages` or `assignment`,
-     * which this endpoint does not return (unlike
-     * {@link DocumentResource.details}). Call `details()` if you need them.
+     * `'Service agreement.pdf'`. The API removes diacritics and replaces
+     * unsupported characters with dashes.
+     * @returns The updated document. `pages` and `assignment` are optional on
+     * this response; call {@link DocumentResource.details} when they are
+     * required:
+     * ```jsonc
+     * {
+     *   "resource": "document",
+     *   "id": "103ad216846e6b90710cb9acef59",
+     *   "account_id": "acc_example",
+     *   "template_id": null,
+     *   "name": "Service agreement.pdf",
+     *   "status": "metadata_ready",
+     *   "artifacts": { "original": "https://…/download/original" },
+     *   "signing_url": "https://…/sign/103ad216…",
+     *   "is_closed": false,
+     *   "decline_reason": null,
+     *   "declined_by": null,
+     *   "tags": [],
+     *   "created_at": "2026-07-19T17:24:43Z",
+     *   "updated_at": "2026-07-19T17:24:46Z"
+     * }
+     * ```
      * @throws {ValidationError} If `documentId` or `name` is missing.
      * @throws {ApiError} `400` if the document is processing or already in
      * signing; `404` if it does not exist.
@@ -1274,7 +1403,8 @@ declare class DocumentResource extends BaseResource {
      * Get document details (`GET /documents/{documentId}`).
      *
      * The full single-document view, including the embedded `assignment` (or
-     * `null`), rendered `pages`, and `artifacts`.
+     * `null`), rendered `pages`, and `artifacts`. `decline_reason` is returned
+     * only when the access token belongs to the document creator.
      *
      * @param documentId - The document to fetch.
      * @returns The document. Response shape (once `metadata_ready`):
@@ -1284,7 +1414,7 @@ declare class DocumentResource extends BaseResource {
      *   "id": "103ad216846e6b90710cb9acef59",
      *   "account_id": "acc_example",
      *   "template_id": null,
-     *   "name": "audit-test.pdf",
+     *   "name": "service-agreement.pdf",
      *   "status": "metadata_ready",
      *   "artifacts": {
      *     "original": "https://…/documents/103ad216…/download/original",
@@ -1309,7 +1439,8 @@ declare class DocumentResource extends BaseResource {
      *   "updated_at": "2026-07-19T17:24:46Z"
      * }
      * ```
-     * @throws {ValidationError} If `documentId` is missing.
+     * @throws {ValidationError} If `documentId` is missing or `artifactName` is
+     * not one of the five documented artifact names.
      * @throws {ApiError} `404` if the document does not exist.
      *
      * @example
@@ -1319,6 +1450,7 @@ declare class DocumentResource extends BaseResource {
      * ```
      */
     details(documentId: string): Promise<IDocumentDetailsResponse>;
+    private fetchDetails;
     /**
      * Alias for {@link DocumentResource.details}
      * (`GET /documents/{documentId}`).
@@ -1376,9 +1508,11 @@ declare class DocumentResource extends BaseResource {
      *
      * @param documentId - The document to download from.
      * @param artifactName - Which artifact to fetch: `original`,
-     * `certificated` (the default — the signed PDF), `certificate-page`, or
-     * `bundle`.
-     * @returns A {@link Buffer} of the artifact's bytes (PDF).
+     * `certificated` (the default — the signed PDF), `certificate-page`,
+     * `pades`, or `bundle` (ZIP). `pades` exists only when the document had a
+     * Digital Certificate signer. `bundle` contains the original, certificated,
+     * and certificate-page artifacts, plus PAdES when present.
+     * @returns A {@link Buffer} containing the raw PDF or ZIP bytes.
      * @throws {ValidationError} If `documentId` is missing.
      * @throws {ApiError} `404` if the document or artifact does not exist (e.g.
      * requesting `certificated` before signing completes).
@@ -1387,6 +1521,7 @@ declare class DocumentResource extends BaseResource {
      * ```ts
      * const pdf = await client.documents.download('doc-1'); // signed PDF
      * const original = await client.documents.download('doc-1', 'original');
+     * const pades = await client.documents.download('doc-1', 'pades');
      * await fs.promises.writeFile('signed.pdf', pdf);
      * ```
      */
@@ -1432,7 +1567,7 @@ declare class DocumentResource extends BaseResource {
      * Fetch the document activity log
      * (`GET /documents/{documentId}/activities`).
      *
-     * Returns a chronological audit trail of lifecycle events. Normalises an
+     * Returns a chronological history of lifecycle events. Normalises an
      * absent body to `[]`.
      *
      * @param documentId - The document whose activity log to fetch.
@@ -1452,7 +1587,7 @@ declare class DocumentResource extends BaseResource {
      *     "event": "document_uploaded",
      *     "message": "Documento criado.",
      *     "payload": [],
-     *     "origin": { "ip": "99.75.13.162", "user-agent": "assinafy-webforms-java-client-sdk" },
+     *     "origin": { "ip": "192.0.2.10", "user-agent": "assinafy-webforms-java-client-sdk" },
      *     "created_at": "2026-07-19T14:56:55Z"
      *   }
      * ]
@@ -1476,7 +1611,7 @@ declare class DocumentResource extends BaseResource {
      * certificated.
      *
      * @param documentId - The document to delete.
-     * @returns Nothing on success.
+     * @returns Nothing; resolves when the document is deleted.
      * @throws {ValidationError} If `documentId` is missing.
      * @throws {ApiError} `400` if the document is not in a deletable status;
      * `404` if it does not exist.
@@ -1520,10 +1655,9 @@ declare class DocumentResource extends BaseResource {
      * Replace the document's tag set
      * (`PUT /accounts/{accountId}/documents/{documentId}/tags`).
      *
-     * The official contract defines `tags` as an array of tag **IDs**. An empty
-     * array detaches all tags. Some environments have also accepted names and
-     * auto-created missing tags, but that is an undocumented extension and
-     * should not be relied on. This overwrites the existing set — use
+     * `tags` is an array of tag **IDs**. An empty array detaches all tags. Tag
+     * names are not portable identifiers and should not be used here. This
+     * overwrites the existing set — use
      * {@link DocumentResource.addTags} to append.
      *
      * @param documentId - The document to retag.
@@ -1586,29 +1720,34 @@ declare class DocumentResource extends BaseResource {
      * @param documentId - The document to detach from.
      * @param tagId - The ID of the tag to detach.
      * @param accountId - Override the client's default account ID.
-     * @returns Nothing on success.
+     * @returns `{ detached: true }` when the association was removed.
      * @throws {ValidationError} If `documentId` or `tagId` is missing, or no
      * account ID is available.
      * @throws {ApiError} If the API rejects the request.
      *
      * @example
      * ```ts
-     * await client.documents.detachTag('doc-1', 'tag-1');
+     * const { detached } = await client.documents.detachTag('doc-1', 'tag-1');
      * ```
      */
-    detachTag(documentId: string, tagId: string, accountId?: string): Promise<void>;
+    detachTag(documentId: string, tagId: string, accountId?: string): Promise<IDetachDocumentTagResponse>;
     /**
      * Create a document from a template
      * (`POST /accounts/{accountId}/templates/{templateId}/documents`).
      *
      * Instantiates the template, binding each role to a signer, and returns the
      * new document. The request body is `{ signers, ...options }` — `signers`
-     * maps template `role_id` → signer `id`, and `options` may add `name`,
-     * `message`, `expires_at`, `editor_fields`, and `tags`.
+     * maps every template `role_id` to an existing account signer `id`, and
+     * `options` may add `name`, `message`, `expires_at`, `editor_fields`, and
+     * tag names in `tags` (unknown names are created automatically).
      *
      * @param templateId - The template to instantiate.
      * @param signers - Role-to-signer bindings (each with `role_id` and `id`,
      * plus optional `verification_method`, `notification_methods`, `step`).
+     * Only one notification method is allowed per signer; when only one of the
+     * verification/notification fields is supplied, the API infers the other.
+     * `DigitalCertificate` costs two credits, requires the feature plus a
+     * signer `government_id`, and that signer must be alone in its step.
      * @param options - Optional `name`, `message`, `expires_at`,
      * `editor_fields`, `tags`.
      * @param accountId - Override the client's default account ID.
@@ -1620,12 +1759,12 @@ declare class DocumentResource extends BaseResource {
      *   "id": "19f675b761b392a48b8642503bb",
      *   "account_id": "acc_example",
      *   "template_id": "103a0991a5cde83518e5672aa9aa",
-     *   "name": "Audit From Template",
+     *   "name": "Service agreement from template",
      *   "status": "pending_signature",
      *   "artifacts": { "original": "https://…/download/original", "thumbnail": "https://…/thumbnail" },
      *   "is_closed": false,
      *   "signing_url": "https://app-sandbox.assinafy.com.br/sign/19f675b7…",
-     *   "tags": [{ "id": "103a0992…", "name": "audit-tmp-fromtmpl", "color": null }],
+     *   "tags": [{ "id": "103a0992…", "name": "agreements", "color": null }],
      *   "assignment": { "id": "103a09a1…", "method": "virtual", "summary": { "signer_count": 1, "completed_count": 0 } },
      *   "pages": [{ "id": "103a0992…", "number": 1, "height": 1651, "width": 1275, "download_url": "https://…/download" }],
      *   "created_at": "2026-07-15T19:57:55Z",
@@ -1640,7 +1779,7 @@ declare class DocumentResource extends BaseResource {
      * @example
      * ```ts
      * await client.documents.createFromTemplate('tmpl_id', [
-     *   { role_id: 'role_id', id: 'signer_id', verification_method: 'Email', notification_methods: ['Email'] },
+     *   { role_id: 'role_id', id: 'signer_id', verification_method: 'DigitalCertificate' },
      * ], { name: 'My Contract' });
      * ```
      */
@@ -1651,11 +1790,14 @@ declare class DocumentResource extends BaseResource {
      *
      * A dry run: sends only `{ signers }` and consumes nothing. Use it to check
      * balances before calling {@link DocumentResource.createFromTemplate}.
+     * `DigitalCertificate` adds two credits per signer and has the same feature,
+     * `government_id`, and signing-step prerequisites as document creation.
      *
      * @param templateId - The template that would be instantiated.
      * @param signers - One channel descriptor per template role. Cost requests
      * use only `role_id`, `verification_method`, and `notification_methods`;
-     * they do not send a signer ID or signing-order step.
+     * they do not send a signer ID or signing-order step, and editor roles are
+     * ignored by the cost calculation.
      * @param accountId - Override the client's default account ID.
      * @returns An {@link ICostEstimate}: `total_credits`, balances, and a
      * per-line `breakdown` of what the operation would consume:
@@ -1683,7 +1825,7 @@ declare class DocumentResource extends BaseResource {
      * @example
      * ```ts
      * const estimate = await client.documents.estimateCostFromTemplate('tmpl_id', [
-     *   { role_id: 'role_id', verification_method: 'Email' },
+     *   { role_id: 'role_id', verification_method: 'DigitalCertificate' },
      * ]);
      * if (!estimate.has_sufficient_resources) throw new Error(estimate.blocking_reason ?? 'insufficient');
      * ```
@@ -1699,8 +1841,21 @@ declare class DocumentResource extends BaseResource {
      *
      * @param hash - The document's signature hash (the
      * `documentSignatureHash` path segment).
-     * @returns `{ hash, id, status, page_count, signer_count, completed_count,
-     * completed_at, verified_at, is_valid, message }`.
+     * @returns The verification record:
+     * ```jsonc
+     * {
+     *   "hash": "FE32EDDADE7CBDDCBB934E7402047450B0E59C02",
+     *   "id": "63ddb172402799bfc991d10d",
+     *   "status": "certificated",
+     *   "page_count": "1",
+     *   "signer_count": "1",
+     *   "completed_count": 1,
+     *   "completed_at": "2023-01-27T19:27:44Z",
+     *   "verified_at": "2023-01-27T19:27:46Z",
+     *   "is_valid": true,
+     *   "message": ""
+     * }
+     * ```
      * @throws {ValidationError} If `hash` is missing.
      * @throws {ApiError} If the API rejects the request.
      *
@@ -1711,11 +1866,12 @@ declare class DocumentResource extends BaseResource {
      */
     verify(hash: string): Promise<IDocumentVerification>;
     /**
-     * List every possible document status (`GET /documents/statuses`).
+     * List the server's document-status catalog (`GET /documents/statuses`).
      *
-     * A static catalog (11 entries) of each status `code` and whether documents
-     * in that status can be deleted (`deletable`). This catalog requires the
-     * same API-key or Bearer authentication as other workspace operations.
+     * A server-controlled catalog of each status `code` and whether documents
+     * in that status can be deleted (`deletable`). New statuses may be added,
+     * so callers should not depend on a fixed count or order. This catalog
+     * requires the same API-key or Bearer authentication as workspace calls.
      *
      * @returns The status catalog:
      * ```jsonc
@@ -1725,9 +1881,12 @@ declare class DocumentResource extends BaseResource {
      *   { "code": "metadata_processing", "deletable": false },
      *   { "code": "metadata_ready", "deletable": true },
      *   { "code": "pending_signature", "deletable": true },
-     *   { "code": "certificated", "deletable": false }
-     *   // …11 total: also expired, certificating, rejected_by_signer,
-     *   //            rejected_by_user, failed
+     *   { "code": "expired", "deletable": false },
+     *   { "code": "certificating", "deletable": false },
+     *   { "code": "certificated", "deletable": false },
+     *   { "code": "rejected_by_signer", "deletable": false },
+     *   { "code": "rejected_by_user", "deletable": false },
+     *   { "code": "failed", "deletable": false }
      * ]
      * ```
      * @throws {ApiError} If the API rejects the request.
@@ -1740,21 +1899,32 @@ declare class DocumentResource extends BaseResource {
      */
     statuses(): Promise<IDocumentStatusInfo[]>;
     /**
-     * Public, unauthenticated lookup of basic document info
+     * Public, unauthenticated lookup of a document
      * (`GET /public/documents/{documentId}`).
      *
-     * Used by the signing portal before the signer authenticates via the access
-     * code, so it returns only non-sensitive fields.
+     * Returns either the full document response or a compact `page_count` /
+     * `created_by` compatibility variant.
      *
      * @param documentId - The document to look up.
-     * @returns Basic public info for the document:
+     * @returns The current document representation:
      * ```jsonc
      * {
      *   "resource": "document",
      *   "id": "103ad216846e6b90710cb9acef59",
+     *   "account_id": "acc_example",
+     *   "template_id": null,
      *   "name": "Service agreement.pdf",
-     *   "page_count": 1,
-     *   "created_by": "Multica Test"
+     *   "status": "pending_signature",
+     *   "artifacts": { "original": "https://…/download/original" },
+     *   "is_closed": false,
+     *   "signing_url": "https://…/sign/103ad216…",
+     *   "decline_reason": null,
+     *   "declined_by": null,
+     *   "tags": [],
+     *   "assignment": null,
+     *   "pages": [],
+     *   "created_at": "2026-07-19T17:24:43Z",
+     *   "updated_at": "2026-07-19T17:24:46Z"
      * }
      * ```
      * @throws {ValidationError} If `documentId` is missing.
@@ -1783,7 +1953,9 @@ declare class DocumentResource extends BaseResource {
      * explicit channel is supplied).
      * @param channel - Optional legacy delivery channel.
      * @returns Nothing after the API's empty acknowledgement.
-     * @throws {ValidationError} If `documentId` or `recipient` is missing.
+     * @throws {ValidationError} If `documentId` or `recipient` is missing, the
+     * official two-argument form does not receive a valid email address, or a
+     * supplied `channel` is not a non-empty string.
      * @throws {ApiError} If the API rejects the request.
      *
      * @example
@@ -1853,10 +2025,13 @@ declare class SignerResource extends BaseResource {
      * an existing signer with that address is reused instead of duplicated (a
      * duplicate POST is answered by the API with `400 "Um signatário com este
      * e-mail já existe."`, which this method recovers from transparently).
+     * A reused signer is returned unchanged; this method does not overwrite its
+     * existing name, phone, CPF, or metadata with the create payload.
      *
-     * @param payload - The signer to create. Only `full_name` is required.
-     * Optional `email`, `whatsapp_phone_number`/`phone`, and `cpf` are normalized
-     * before sending.
+     * @param payload - The signer to create. The official fields are required
+     * `full_name` plus optional `email` and E.164 `whatsapp_phone_number`.
+     * `phone`, `cpf`, and `metadata` are compatibility extensions; the SDK
+     * normalizes the phone alias and strips non-digits from CPF before sending.
      * @param accountId - Override the client's default account ID.
      * @returns The created (or reused) signer. Note the response **never echoes
      * `cpf` back**, even when one was sent:
@@ -1923,8 +2098,8 @@ declare class SignerResource extends BaseResource {
      * List signers for the workspace (`GET /accounts/{accountId}/signers`).
      * Pagination info (if any) is attached in `meta`.
      *
-     * @param params - `page`, `per-page`, `search`, `sort`. `per-page` is
-     * clamped to the API maximum of 50.
+     * @param params - `page`, `per-page`, and `search` (matches `full_name` or
+     * `email`). The API maximum is 100 items per page.
      * @param accountId - Override the client's default account ID.
      * @returns The matching signers, with pagination in `meta`. Each item:
      * ```jsonc
@@ -1947,14 +2122,16 @@ declare class SignerResource extends BaseResource {
      * });
      * ```
      */
-    list(params?: IListParams, accountId?: string): Promise<ISignerListResponse>;
+    list(params?: ISignerListParams, accountId?: string): Promise<ISignerListResponse>;
     /**
-     * Update a signer (`PUT /accounts/{accountId}/signers/{signerId}`). Fails
-     * if the signer has active assignments.
+     * Update a signer (`PUT /accounts/{accountId}/signers/{signerId}`). A name
+     * can always be updated. A verified email or WhatsApp channel cannot change
+     * while it belongs to an in-flight document; changing an unverified channel
+     * rotates its access/verification codes, so resend the notification.
      *
      * @param signerId - The signer to update.
-     * @param payload - Fields to change. Any `cpf` is stripped to digits before
-     * sending.
+     * @param payload - Fields to change. The official `government_id` field and
+     * legacy `cpf` extension are stripped to digits before sending.
      * @param accountId - Override the client's default account ID.
      * @returns The updated signer (as with create, `cpf` is never echoed back):
      * ```jsonc
@@ -1968,13 +2145,14 @@ declare class SignerResource extends BaseResource {
      * }
      * ```
      * @throws {ValidationError} If `signerId` is missing or no account ID is available.
-     * @throws {ApiError} `400` if the signer has active assignments; `404` if it
-     * does not exist.
+     * @throws {ApiError} `400` if a verified contact channel is in use by an
+     * in-flight document; `404` if the signer does not exist.
      *
      * @example
      * ```ts
      * await client.signers.update('19e6b92e7895332ed9708535d8c', {
      *   full_name: 'Ana Souza Lima',
+     *   government_id: '390.533.447-05',
      * });
      * ```
      */
@@ -2003,10 +2181,9 @@ declare class SignerResource extends BaseResource {
      * `search` is a substring match across signer fields, so the result is
      * re-filtered here for an exact, case-insensitive email match.
      *
-     * Page size is pinned to the API's maximum of 50: larger values are
-     * silently clamped to 50 by the server, so asking for more is misleading.
+     * Page size is pinned to the API's maximum of 100.
      * An exact address realistically matches one signer, but a search term that
-     * matched more than 50 could in principle miss one — the API exposes no
+     * matched more than 100 could in principle miss one — the API exposes no
      * exact-email filter to rule that out.
      *
      * A `404` from the underlying list is treated as "no match" and mapped to
@@ -2053,10 +2230,9 @@ type AccountLogoUploadSource = {
  * signer, template, tag, field, and webhook. Each endpoint lives under
  * `/accounts`, and the `accountId` used elsewhere in the SDK is a workspace id.
  *
- * Colours (`primary_color` / `secondary_color`) are stored on the workspace and
- * echoed back on the response. They must be an **exactly 6-character hex string
- * with NO leading `#`** (`'ff0066'`, not `'#ff0066'`); a `#`-prefixed value is
- * rejected with `400`. Verified live against the API.
+ * Requests accept `name`, `notification_sender_type`, `primary_color`, and
+ * `secondary_color`. Colours are always modeled on responses. When
+ * sent, they must be exactly six hex characters with no leading `#`.
  *
  * @example
  * ```ts
@@ -2068,18 +2244,25 @@ declare class WorkspaceResource extends BaseResource {
     /**
      * Create a new workspace (`POST /accounts`).
      *
-     * @param payload - The workspace `name` (required) plus optional brand
-     * colours. Colours are 6-char hex **without** a leading `#`.
+     * @param payload - Official fields are workspace `name` (required) and
+     * optional `notification_sender_type` (`User` or `Account`). Optional brand
+     * colours use six hex characters without
+     * a leading `#`.
      * @returns The created workspace. Response shape:
      * ```jsonc
      * {
+     *   "resource": "account",
      *   "id": "acc_example",
      *   "name": "Acme Legal",
+     *   "notification_sender_type": "Account",
      *   "primary_color": "ff0066",
      *   "secondary_color": "0066ff",
+     *   "roles": ["owner"],
+     *   "is_delete_allowed": true,
      *   "created_at": "2026-05-12T18:05:11Z"
      * }
      * ```
+     * @throws {ValidationError} If `payload` is not an object.
      * @throws {ApiError} If the API rejects the request — e.g. `400` when a
      * colour is not exactly 6 hex characters (or carries a leading `#`).
      *
@@ -2087,6 +2270,7 @@ declare class WorkspaceResource extends BaseResource {
      * ```ts
      * const ws = await client.workspaces.create({
      *   name: 'Acme Legal',
+     *   notification_sender_type: 'Account',
      *   primary_color: 'ff0066',
      *   secondary_color: '0066ff',
      * });
@@ -2102,8 +2286,12 @@ declare class WorkspaceResource extends BaseResource {
      * {
      *   "data": [
      *     {
+     *       "resource": "account",
      *       "id": "acc_example",
      *       "name": "MT",
+     *       "primary_color": null,
+     *       "secondary_color": null,
+     *       "notification_sender_type": "User",
      *       "roles": ["owner"],
      *       "is_delete_allowed": true,
      *       "created_at": "2026-05-12T18:05:11Z"
@@ -2128,10 +2316,14 @@ declare class WorkspaceResource extends BaseResource {
      * until brand colours are set (6-char hex, no `#`, when present):
      * ```jsonc
      * {
+     *   "resource": "account",
      *   "id": "acc_example",
      *   "name": "MT",
      *   "primary_color": null,
      *   "secondary_color": null,
+     *   "notification_sender_type": "User",
+     *   "roles": ["owner"],
+     *   "is_delete_allowed": true,
      *   "created_at": "2026-05-12T18:05:11Z"
      * }
      * ```
@@ -2216,6 +2408,8 @@ declare class WorkspaceResource extends BaseResource {
      *
      * @param accountId - Account whose logo should be removed.
      * @returns Resolves when the API acknowledges deletion.
+     * @throws {ValidationError} If `accountId` is empty.
+     * @throws {ApiError} If the API rejects the request.
      * @example
      * ```ts
      * await client.workspaces.deleteLogo('acc_example');
@@ -2236,8 +2430,13 @@ declare class WorkspaceResource extends BaseResource {
      *   "documents_uploaded": 42,
      *   "documents_sent": 37,
      *   "signature_requests": 61,
-     *   "signature_requests_email": 55,
-     *   "signature_requests_whatsapp": 18,
+     *   "signature_requests_notification_email": 55,
+     *   "signature_requests_notification_whatsapp": 18,
+     *   "signature_requests_notification_bypass": 3,
+     *   "signature_requests_verification_email": 48,
+     *   "signature_requests_verification_whatsapp": 6,
+     *   "signature_requests_verification_bypass": 3,
+     *   "signature_requests_verification_digital_certificate": 4,
      *   "signature_requests_viewed": 44,
      *   "signature_requests_completed": 52,
      *   "documents_certified": 30
@@ -2262,19 +2461,26 @@ declare class WorkspaceResource extends BaseResource {
      * Update a workspace (`PUT /accounts/{accountId}`).
      *
      * @param accountId - The workspace to update.
-     * @param payload - The fields to change (`name` and/or brand colours).
-     * Colours are 6-char hex **without** a leading `#`; pass `null` to clear one.
+     * @param payload - Official fields are `name` and
+     * `notification_sender_type` (`User` or `Account`). Brand colours use six
+     * hex characters without a leading `#`;
+     * pass `null` to clear one.
      * @returns The updated workspace. Response shape:
      * ```jsonc
      * {
+     *   "resource": "account",
      *   "id": "acc_example",
      *   "name": "Acme Legal (Renamed)",
+     *   "notification_sender_type": "Account",
      *   "primary_color": "ff0066",
      *   "secondary_color": "0066ff",
+     *   "roles": ["owner"],
+     *   "is_delete_allowed": true,
      *   "created_at": "2026-05-12T18:05:11Z"
      * }
      * ```
-     * @throws {ValidationError} If `accountId` is missing.
+     * @throws {ValidationError} If `accountId` is missing or `payload` is not
+     * an object.
      * @throws {ApiError} `400` for an invalid colour; `404` if the workspace
      * does not exist.
      *
@@ -2282,6 +2488,7 @@ declare class WorkspaceResource extends BaseResource {
      * ```ts
      * await client.workspaces.update('acc_example', {
      *   name: 'Acme Legal (Renamed)',
+     *   notification_sender_type: 'Account',
      *   primary_color: 'ff0066',
      * });
      * ```
@@ -2290,12 +2497,14 @@ declare class WorkspaceResource extends BaseResource {
     /**
      * Delete a workspace (`DELETE /accounts/{accountId}`).
      *
-     * A workspace with restrictions (e.g. remaining documents) is rejected with
-     * `400` and a `restrictions` list; pass `{ force: true }` to override and
-     * delete it anyway. The flag is sent in the request body, per the API.
+     * A workspace with an active paid subscription is rejected with `400` and
+     * a `restrictions` list. `{ force: true }` cancels that subscription and
+     * proceeds with deletion; it is not documented as a blanket override for
+     * unrelated restrictions. The flag is sent in the request body.
      *
      * @param accountId - The workspace to delete.
-     * @param options - Set `force: true` to delete despite restrictions.
+     * @param options - Set `force: true` to cancel an active paid subscription
+     * and proceed with deletion.
      * @returns Nothing on success (`200` with no meaningful body).
      * @throws {ValidationError} If `accountId` is missing.
      * @throws {ApiError} `400` (with a `restrictions` list) when the workspace
@@ -2304,7 +2513,7 @@ declare class WorkspaceResource extends BaseResource {
      * @example
      * ```ts
      * await client.workspaces.delete('acc_example');
-     * // override restrictions:
+     * // cancel an active paid subscription, then delete:
      * await client.workspaces.delete('acc_example', { force: true });
      * ```
      */
@@ -2319,7 +2528,7 @@ declare class WorkspaceResource extends BaseResource {
  * values are removed, and collect assignments must include placement entries.
  *
  * @param payload - Assignment method, signer references, and optional message,
- * expiration, copy receivers, or collect-field placements.
+ * expiration, copy-receiver signer IDs, or collect-field placements.
  * @returns A JSON-ready body shaped as
  * `{ method, signers: [{ id, verification_method?, notification_methods?, step? }], message?, expires_at?, copy_receivers?, entries? }`.
  * @throws {ValidationError} If no signer is present, a signer reference is
@@ -2352,6 +2561,7 @@ declare class AssignmentResource extends BaseResource {
      * returns):
      * ```jsonc
      * {
+     *   "resource": "assignment",
      *   "id": "103033c9d2cec233bf65eea04999",
      *   "sender_email": "sender@example.com",
      *   "method": "virtual",
@@ -2390,6 +2600,7 @@ declare class AssignmentResource extends BaseResource {
      *         "type": "virtual",
      *         "is_active": true
      *       },
+     *       "display_settings": [],
      *       "value": null,
      *       "completed": false
      *     }
@@ -2432,17 +2643,22 @@ declare class AssignmentResource extends BaseResource {
      * Signers may be passed as bare id strings or as objects
      * (`{ id, verification_method, notification_methods, step }`); the SDK
      * normalises them to the docs-sanctioned `signers: [{ ... }]` shape via
-     * {@link buildAssignmentPayload}. The document must have reached
-     * `metadata_ready` before an assignment can be created.
+     * {@link buildAssignmentPayload}. A `virtual` assignment may be created at
+     * `uploaded`, `metadata_processing`, or `metadata_ready` and is promoted
+     * automatically; `collect` requires rendered pages at `metadata_ready`.
+     * `DigitalCertificate` costs two credits, requires the feature plus a
+     * signer `government_id`, and that signer must be alone in its step.
      *
      * @param documentId - The document to request signatures on.
      * @param payload - Signers plus optional `method` (defaults to `virtual`),
-     * `message`, `expires_at`, `copy_receivers`, and `collect`-mode `entries`.
+     * `message`, `expires_at`, `copy_receivers` (existing signer IDs, not
+     * addresses), and `collect`-mode `entries` with page-image geometry.
      * @returns The created {@link IAssignment}: `signers` (rich, with `step` /
      * `notified` / `verification_method`), `items` (one row per signer × field),
      * a `summary` count block, and per-signer `signing_urls`. Response shape:
      * ```jsonc
      * {
+     *   "resource": "assignment",
      *   "id": "103033c9d2cec233bf65eea04999",
      *   "sender_email": "sender@example.com",
      *   "method": "virtual",
@@ -2479,6 +2695,7 @@ declare class AssignmentResource extends BaseResource {
      *         "type": "virtual",
      *         "is_active": true
      *       },
+     *       "display_settings": [],
      *       "value": null,
      *       "completed": false
      *     }
@@ -2507,9 +2724,8 @@ declare class AssignmentResource extends BaseResource {
      * ```
      * @throws {ValidationError} If `documentId` is missing, no signer is
      * supplied, or a signer reference is invalid.
-     * @throws {ApiError} If the API rejects the request — e.g. `400`
-     * ("Um signatário com este e-mail já existe.") when a signer email already
-     * exists on the account.
+     * @throws {ApiError} `400` for an invalid assignment or unmet verification
+     * precondition; otherwise if the API rejects the request.
      *
      * @example
      * ```ts
@@ -2518,7 +2734,7 @@ declare class AssignmentResource extends BaseResource {
      *   message: 'Please sign this contract',
      * });
      * // → wire body: { method: 'virtual', signers: [{ id: '19e6…' }], message: 'Please sign this contract' }
-     * assignment.signing_urls?.forEach((s) => console.log(s.signer_id, s.url));
+     * console.log(assignment.signing_urls?.length); // one protected link per signer
      * ```
      */
     create(documentId: string, payload: ICreateAssignmentPayload): Promise<ICreateAssignmentResponse>;
@@ -2530,11 +2746,17 @@ declare class AssignmentResource extends BaseResource {
      * only `verification_method` / `notification_methods` (or `{}` for the
      * default Email channel). {@link buildAssignmentEstimatePayload} projects
      * exactly the fields permitted by the estimate schema.
+     * `DigitalCertificate` is priced at two credits per signer and remains
+     * subject to the feature, identity, and one-signer-per-step requirements.
+     * Current documented unit prices are 1 credit for an extra document, 0 for
+     * email notification, and 0.45 for WhatsApp notification; a digital
+     * certificate charge is added on top of its notification cost.
      *
      * @param documentId - The document the assignment would be created on.
      * @param payload - `method` plus channel-only signer descriptors and/or
      * `collect`-mode `entries`. Create-only fields and signer IDs are not part
-     * of this request schema.
+     * of this request schema. `blocking_reason` may be `PendingPayment`,
+     * `InsufficientDocuments`, or `InsufficientCredits`.
      * @returns an {@link ICostEstimate} with `total_credits`, balances, a
      * line-item `breakdown`, and a `has_sufficient_resources` gate. Response
      * shape:
@@ -2571,15 +2793,14 @@ declare class AssignmentResource extends BaseResource {
      * Update the expiration date of an existing assignment
      * (`PUT /documents/{documentId}/assignments/{assignmentId}/reset-expiration`).
      *
-     * Sends `{ expires_at }` verbatim. The official contract accepts an ISO-8601
-     * date/time string. `null` is retained as a live-unverified compatibility
-     * value used by older integrations and, unlike ordinary nullable inputs, is
-     * intentionally not stripped from the body.
+     * Sends `{ expires_at }` verbatim. Use an ISO-8601 date/time string; `null`
+     * is retained as a compatibility value and, unlike ordinary nullable
+     * inputs, is intentionally not stripped from the body.
      *
      * @param documentId - The document the assignment belongs to.
      * @param assignmentId - The assignment to update.
      * @param expiresAt - New expiry as an ISO-8601 date/time string. `null` is
-     * an unverified compatibility value intended to clear it.
+     * a compatibility value intended to clear it.
      * @returns The updated {@link IAssignment} — the same full shape
      * {@link AssignmentResource.create} returns (`signers`, `items`, `summary`,
      * `signing_urls`), with `expires_at` reflecting the new value:
@@ -2588,7 +2809,7 @@ declare class AssignmentResource extends BaseResource {
      *   "id": "103033c9d2cec233bf65eea04999",
      *   "sender_email": "sender@example.com",
      *   "method": "virtual",
-     *   "expires_at": "2026-12-31T23:59:59Z",
+     *   "expires_at": "2027-12-31T23:59:59Z",
      *   "message": "Please sign this contract",
      *   "copy_receivers": [],
      *   "signers": [
@@ -2615,7 +2836,7 @@ declare class AssignmentResource extends BaseResource {
      * @example
      * ```ts
      * // Extend the deadline …
-     * await client.assignments.resetExpiration('doc-1', 'asg-1', '2026-12-31T23:59:59Z');
+     * await client.assignments.resetExpiration('doc-1', 'asg-1', '2027-12-31T23:59:59Z');
      * // … or remove it entirely (sends { expires_at: null }).
      * await client.assignments.resetExpiration('doc-1', 'asg-1', null);
      * ```
@@ -2660,17 +2881,22 @@ declare class AssignmentResource extends BaseResource {
      * @param documentId - The document the assignment belongs to.
      * @param assignmentId - The assignment containing the signer.
      * @param signerId - The signer whose notification would be resent.
-     * @returns An {@link IResendCostEstimate}. The published contract returns
-     * the full {@link ICostEstimate}; older deployments may return the compact
-     * `total` / `has_sufficient_credits` shape shown below:
+     * @returns An {@link IResendCostEstimate}: either the full
+     * {@link ICostEstimate} or the compact `total` /
+     * `has_sufficient_credits` compatibility shape:
      * ```jsonc
      * {
-     *   "total": 0,
-     *   "breakdown": [
-     *     { "code": "NotificationEmailResend", "name": "Email Notification Resend", "cost": 0 }
-     *   ],
+     *   "documents": 1,
+     *   "credits": 0,
+     *   "needs_extra_document": false,
+     *   "extra_document_cost": 0,
+     *   "total_credits": 0,
+     *   "breakdown": [],
+     *   "document_balance": 67,
      *   "credit_balance": 0,
-     *   "has_sufficient_credits": true
+     *   "has_sufficient_resources": true,
+     *   "blocking_reason": null,
+     *   "message": null
      * }
      * ```
      * @throws {ValidationError} If any of the three IDs is missing.
@@ -2719,7 +2945,7 @@ declare class AssignmentResource extends BaseResource {
      * @example
      * ```ts
      * const notifications = await client.assignments.listWhatsAppNotifications('doc-1', 'asg-1');
-     * notifications.forEach((n) => console.log(n.phone_number, n.body));
+     * console.log(notifications.length);
      * ```
      */
     listWhatsAppNotifications(documentId: string, assignmentId: string): Promise<IWhatsAppNotification[]>;
@@ -2760,7 +2986,8 @@ declare class WebhookResource extends BaseResource {
      *   "updated_at": "2026-07-18T02:36:02Z" // no `id` / `created_at` are returned
      * }
      * ```
-     * @throws {ValidationError} If `url` or `email` is missing.
+     * @throws {ValidationError} If `url` / `email` is invalid, `events` /
+     * `is_active` has the wrong type, or no account ID is available.
      * @throws {ApiError} If the API rejects the subscription.
      *
      * @example
@@ -2787,7 +3014,7 @@ declare class WebhookResource extends BaseResource {
      * present:
      * ```jsonc
      * {
-     *   "url": "https://hooks.zapier.com/hooks/standard/27880178/bbe9b90c.../",
+     *   "url": "https://webhooks.example.com/assinafy",
      *   "email": "ops@example.com",
      *   "events": [
      *     "document_ready",
@@ -2798,6 +3025,7 @@ declare class WebhookResource extends BaseResource {
      *   "updated_at": "2026-07-18T02:36:02Z"
      * }
      * ```
+     * @throws {ValidationError} If no account ID is available.
      * @throws {ApiError} If the API fails for a reason other than `404`.
      *
      * @example
@@ -2838,6 +3066,7 @@ declare class WebhookResource extends BaseResource {
      *   "updated_at": "2026-07-18T02:36:02Z"
      * }
      * ```
+     * @throws {ValidationError} If no account ID is available.
      * @throws {ApiError} If the API rejects the request.
      *
      * @example
@@ -2852,14 +3081,9 @@ declare class WebhookResource extends BaseResource {
      * (`GET /webhooks/event-types`). This is a global, account-independent
      * catalog.
      *
-     * @returns The full list of event types with human-readable descriptions.
-     * Live, the API returns exactly 15 entries (in this order):
-     * `document_uploaded`, `document_metadata_ready`, `document_prepared`,
-     * `assignment_created`, `signature_requested`, `document_ready`,
-     * `signer_created`, `signer_email_verified`, `signer_whatsapp_verified`,
-     * `signer_data_confirmed`, `signer_signed_document`, `signer_viewed_document`,
-     * `signer_rejected_document`, `user_rejected_document`,
-     * `document_processing_failed`. Response shape:
+     * @returns The server-controlled event catalog with human-readable
+     * descriptions. Event types can be added over time, so callers should not
+     * depend on a fixed count or order. Response shape:
      * ```jsonc
      * [
      *   {
@@ -2870,7 +3094,6 @@ declare class WebhookResource extends BaseResource {
      *     "id": "document_metadata_ready",
      *     "description": "Triggered when the document is ready to be prepared. The document has been normalized to PDF and its pages are available."
      *   }
-     *   // …13 more (15 total)
      * ]
      * ```
      * @throws {ApiError} If the API rejects the request.
@@ -2887,6 +3110,12 @@ declare class WebhookResource extends BaseResource {
      * (`GET /accounts/{accountId}/webhooks`). Pagination info (if any) is
      * attached in `meta`.
      *
+     * Assinafy treats any `2xx` response as success. It makes at most two
+     * attempts per event with a three-second wait. After ten consecutive failed
+     * events, the circuit breaker pauses normal delivery and sends roughly 5%
+     * as recovery checks until one succeeds. The stored `response_body` is
+     * truncated to 2,000 characters.
+     *
      * @param params - Optional filters and pagination:
      *   - `event` — restrict to a single {@link WebhookEventType}
      *     (e.g. `'signer_signed_document'`).
@@ -2898,6 +3127,7 @@ declare class WebhookResource extends BaseResource {
      * @returns Delivery records, with pagination in `meta`. Each item:
      * ```jsonc
      * {
+     *   "resource": "activity_dispatching_history",
      *   "id": "103a09cfce51319dd3b3f72ffcdf",
      *   "event": "signature_requested",
      *   "activity_id": 8629,
@@ -2910,12 +3140,13 @@ declare class WebhookResource extends BaseResource {
      *   },
      *   "delivered": true,
      *   "http_status": 200,
-     *   "response_body": "{ ... }", // body returned by the receiving endpoint
+     *   "response_body": "{ ... }", // receiving endpoint body, max 2,000 chars
      *   "error": null,
      *   "created_at": "2026-07-15T20:04:36Z",
      *   "updated_at": "2026-07-15T20:04:36Z"
      * }
      * ```
+     * @throws {ValidationError} If no account ID is available.
      * @throws {ApiError} If the API rejects the request.
      *
      * @example
@@ -2944,6 +3175,7 @@ declare class WebhookResource extends BaseResource {
      * shape:
      * ```jsonc
      * {
+     *   "resource": "activity_dispatching_history",
      *   "id": "103a09cfce51319dd3b3f72ffcdf",
      *   "event": "signature_requested",
      *   "activity_id": 8629,
@@ -2951,13 +3183,14 @@ declare class WebhookResource extends BaseResource {
      *   "payload": { }, // the original event body that was re-POSTed
      *   "delivered": true,
      *   "http_status": 200,
-     *   "response_body": "{ ... }",
+     *   "response_body": "{ ... }", // max 2,000 characters
      *   "error": null,
      *   "created_at": "2026-07-15T20:04:36Z",
      *   "updated_at": "2026-07-15T20:05:10Z"
      * }
      * ```
-     * @throws {ValidationError} If `dispatchId` is empty.
+     * @throws {ValidationError} If `dispatchId` is empty or no account ID is
+     * available.
      * @throws {ApiError} If the dispatch is not found (`404`) or the retry fails.
      *
      * @example
@@ -2970,17 +3203,18 @@ declare class WebhookResource extends BaseResource {
 }
 
 /**
- * Live-API compatibility endpoints for managing reusable templates.
+ * Manage reusable templates.
  *
- * These CRUD routes are operational in the Assinafy sandbox but are not
- * described by the current published OpenAPI document. They are retained for
- * compatibility and should be integration-tested against the target Assinafy
- * environment before a production rollout.
+ * Provides template listing plus compatibility methods for upload,
+ * single-template get/update/delete, and page download. Confirm compatibility
+ * method availability on the configured host.
  */
 declare class TemplateResource extends BaseResource {
     /**
      * Create a template by uploading a PDF (`POST /accounts/{id}/templates`).
      *
+     * Compatibility endpoint; confirm availability on the configured host.
+     *
      * The template is created in `Uploaded` status and transitions to `Ready`
      * once the platform finishes processing its pages (`pages` stays empty until
      * then). Configure roles/fields afterwards in the Assinafy editor. As with
@@ -3035,9 +3269,11 @@ declare class TemplateResource extends BaseResource {
      * List templates for the workspace (`GET /accounts/{id}/templates`).
      *
      * Pagination lives in the response **headers** and is surfaced on `meta`.
-     * Each item is an {@link ITemplateListItem} carrying `pages[]` (each with a
-     * `download_url`), so there is no need to `get()` a template again just to
-     * read its rendered pages.
+     * Each item is an {@link ITemplateListItem} carrying `pages[]` (each with an
+     * API-key-authenticated `download_url`), so there is no need to `get()` a
+     * template again just to read its rendered pages. Prefer
+     * {@link TemplateResource.downloadPage} to download the image bytes.
+     * Lifecycle values may be lowercase or title case (`ready` / `Ready`).
      *
      * @param params - `search`, `page`, and `per-page` (the SDK normalizes
      * `per_page` → `per-page`, the only spelling the API honors).
@@ -3049,7 +3285,7 @@ declare class TemplateResource extends BaseResource {
      *   "name": "NDA template.pdf",
      *   "document_name": "nda.pdf",
      *   "message": null,
-     *   "status": "Ready",
+     *   "status": "ready",
      *   "pages": [
      *     {
      *       "id": "103ad217673e1f978cb86179e8f8",
@@ -3076,15 +3312,18 @@ declare class TemplateResource extends BaseResource {
      * const { data, meta } = await client.templates.list({ search: 'nda', 'per-page': 20 });
      * ```
      */
-    list(params?: IListParams, accountId?: string): Promise<ITemplateListResponse>;
+    list(params?: ITemplateListParams, accountId?: string): Promise<ITemplateListResponse>;
     /**
      * Get a template by ID (`GET /accounts/{id}/templates/{template_id}`).
      *
+     * Compatibility endpoint; confirm availability on the configured host.
+     *
      * Returns the same shape as {@link TemplateResource.list} plus
      * `default_document_tags` (the tags auto-applied to every document created
      * from this template) and `resource`. Both endpoints return `pages` with
-     * per-page `download_url`, so fetching a template again purely to read its
-     * pages is unnecessary.
+     * per-page API-key-authenticated `download_url`, so fetching a template
+     * again purely to read its pages is unnecessary. Prefer
+     * {@link TemplateResource.downloadPage} to download the image bytes.
      *
      * @param templateId - The template to fetch.
      * @param accountId - Override the client's default account ID.
@@ -3136,6 +3375,8 @@ declare class TemplateResource extends BaseResource {
      * Update a template's `name` and/or default `message`
      * (`PUT /accounts/{id}/templates/{template_id}`).
      *
+     * Compatibility endpoint; confirm availability on the configured host.
+     *
      * `message` is the default invitation message applied to documents created
      * from this template. Omit a field to leave it unchanged — the SDK strips
      * `undefined` keys before sending. Unlike uploads, `name` here is a plain
@@ -3177,6 +3418,8 @@ declare class TemplateResource extends BaseResource {
     /**
      * Delete a template (`DELETE /accounts/{id}/templates/{template_id}`).
      *
+     * Compatibility endpoint; confirm availability on the configured host.
+     *
      * The API responds with an empty `data` payload; this method resolves to
      * `void`.
      *
@@ -3196,9 +3439,11 @@ declare class TemplateResource extends BaseResource {
      * Download a template page as a JPEG
      * (`GET /accounts/{id}/templates/{template_id}/pages/{page_id}/download`).
      *
+     * Compatibility endpoint; confirm availability on the configured host.
+     *
      * Used by template editors to render page thumbnails on the client. The
-     * matching `download_url` is also returned on each `template.pages[]` entry,
-     * so if you already hold the template you can fetch that URL directly.
+     * matching API-key-authenticated `download_url` is also returned on each
+     * `template.pages[]` entry; this wrapper supplies the required credentials.
      *
      * @param templateId - The template that owns the page.
      * @param pageId - The page to download (`pages[].id` from `get()`/`list()`).
@@ -3276,10 +3521,11 @@ declare class TagResource extends BaseResource {
      *
      * `color` is an optional 6-char hex string; the API accepts it **with or
      * without** a leading `#` and always stores it **without** — `'#ff8800'`
-     * and `'ff8800'` both persist as `'ff8800'` (verified live). Omit `color`
+     * and `'ff8800'` both persist as `'ff8800'`. Omit `color`
      * (or pass `null`) for no color.
      *
-     * @param payload - `name` (required) and optional `color`.
+     * @param payload - `name` (required, max 64 characters; trimmed with
+     * internal whitespace collapsed) and optional `color`.
      * @param accountId - Override the client's default account ID.
      * @returns The created tag:
      * ```jsonc
@@ -3292,7 +3538,8 @@ declare class TagResource extends BaseResource {
      *   "updated_at": "2026-07-19T17:24:46Z"
      * }
      * ```
-     * @throws {ValidationError} If `name` is empty, or no account ID is available.
+     * @throws {ValidationError} If `payload` is not an object, `name` is empty,
+     * or no account ID is available.
      * @throws {ApiError} `409` if a tag with the same name already exists
      * (case-insensitive).
      *
@@ -3327,7 +3574,8 @@ declare class TagResource extends BaseResource {
      *   "updated_at": "2026-07-19T17:24:47Z"
      * }
      * ```
-     * @throws {ValidationError} If `tagId` is missing, or no account ID is available.
+     * @throws {ValidationError} If `payload` is not an object, `tagId` is
+     * missing, or no account ID is available.
      * @throws {ApiError} `404` if the tag does not exist; `409` if another tag
      * already uses the new name.
      *
@@ -3348,20 +3596,19 @@ declare class TagResource extends BaseResource {
      *
      * By default the API returns `409` if the tag is still attached to any
      * document or template. Pass `{ force: true }` to detach it everywhere
-     * first — that adds a `?force=true` query param. Resolves to `void` on
-     * success (the endpoint's `{ "deleted": true }` body is discarded).
+     * first — that adds a `?force=true` query param.
      *
      * @param tagId - The tag to delete.
      * @param options - `force` to detach-and-delete when the tag is still in
      * use, and `accountId` to override the client's default account ID.
-     * @returns Nothing; resolves once the tag is deleted.
+     * @returns `{ deleted: true }` when the tag was deleted.
      * @throws {ValidationError} If `tagId` is missing, or no account ID is available.
      * @throws {ApiError} `404` if the tag does not exist; `409` if the tag is
      * still in use and `force` was not set.
      *
      * @example
      * ```ts
-     * await client.tags.delete('103ad216fdc641c8f0465678c813');
+     * const { deleted } = await client.tags.delete('103ad216fdc641c8f0465678c813');
      * // detach from every document/template, then delete
      * await client.tags.delete('103ad216fdc641c8f0465678c813', { force: true });
      * ```
@@ -3369,7 +3616,7 @@ declare class TagResource extends BaseResource {
     delete(tagId: string, options?: {
         force?: boolean;
         accountId?: string;
-    }): Promise<void>;
+    }): Promise<IDeleteTagResponse>;
 }
 
 /**
@@ -3387,6 +3634,9 @@ declare class AuthenticationResource extends BaseResource {
      * Build the browser-facing OAuth start URL
      * (`GET /auth/authenticate?authclient=…`).
      *
+     * This is a compatibility browser route. Confirm availability on the
+     * configured host before exposing it in a login flow.
+     *
      * This endpoint responds with `302` to the provider consent screen, so the
      * SDK returns the URL for your web framework to redirect to instead of
      * following the redirect inside the Node process.
@@ -3394,17 +3644,20 @@ declare class AuthenticationResource extends BaseResource {
      * @param authClient - Provider key; currently `google`.
      * @returns An absolute URL, for example
      * `https://api.assinafy.com.br/v1/auth/authenticate?authclient=google`.
-     * @throws {ValidationError} If `authClient` is empty.
+     * @throws {ValidationError} If `authClient` is not `google`.
      *
      * @example
      * ```ts
      * response.redirect(client.auth.getSocialLoginUrl('google'));
      * ```
      */
-    getSocialLoginUrl(authClient?: 'google' | AnyString): string;
+    getSocialLoginUrl(authClient?: 'google'): string;
     /**
      * Return the Assinafy browser callback URL (`GET /login-callback`).
      *
+     * This is a compatibility browser route. Confirm availability on the
+     * configured host before use.
+     *
      * The callback response payload is intentionally unspecified by the API;
      * OAuth providers call it in a browser. Use this URL when a provider setup
      * asks for Assinafy's callback/redirect URI.
@@ -3475,8 +3728,7 @@ declare class AuthenticationResource extends BaseResource {
      * {@link AuthenticationResource.login}.
      *
      * @param payload - The social-login body.
-     * @param payload.provider - OAuth provider. The API currently accepts
-     * `'google'`; the type is left open for forward-compatibility.
+     * @param payload.provider - OAuth provider; currently exactly `'google'`.
      * @param payload.token - The provider-issued OAuth/ID token.
      * @param payload.has_accepted_terms - Whether the user has accepted the
      * terms of service.
@@ -3489,8 +3741,12 @@ declare class AuthenticationResource extends BaseResource {
      *     "id": "md3j6p9w8b7y6qvqaoy5er42",
      *     "name": "Multica Test",
      *     "email": "user@example.com",
+     *     "telephone": null,
+     *     "government_id": "",
      *     "is_email_verified": true,
-     *     "has_accepted_terms": true
+     *     "has_accepted_terms": true,
+     *     "created_at": "2026-05-12T13:45:11Z",
+     *     "to_be_deleted_at": null
      *   },
      *   "accounts": [
      *     {
@@ -3503,7 +3759,8 @@ declare class AuthenticationResource extends BaseResource {
      *   ]
      * }
      * ```
-     * @throws {ValidationError} If `provider` or `token` is missing.
+     * @throws {ValidationError} If `provider` is not `google`, `token` is
+     * missing, or `has_accepted_terms` is not a boolean.
      * @throws {ApiError} `400` if the provider token is rejected.
      *
      * @example
@@ -3516,8 +3773,8 @@ declare class AuthenticationResource extends BaseResource {
      * ```
      */
     socialLogin(payload: {
-        /** OAuth provider. The API currently accepts `google`; typed open for forward-compat. */
-        provider: 'google' | AnyString;
+        /** OAuth provider. The current API accepts only `google`. */
+        provider: 'google';
         token: string;
         has_accepted_terms: boolean;
     }): Promise<ILoginResponse>;
@@ -3534,7 +3791,7 @@ declare class AuthenticationResource extends BaseResource {
      *
      * @param payload - Social provider and provider-issued access/ID token.
      * @returns Resolves when the API acknowledges that the identity was linked.
-     * @throws {ValidationError} If either field is empty.
+     * @throws {ValidationError} If `provider` is not `google` or `token` is empty.
      * @throws {ApiError} `400` for an invalid provider token or `401` for
      * missing/invalid Assinafy credentials.
      *
@@ -3547,7 +3804,7 @@ declare class AuthenticationResource extends BaseResource {
      * ```
      */
     linkSocialLogin(payload: {
-        provider: 'google' | AnyString;
+        provider: 'google';
         token: string;
     }): Promise<void>;
     /**
@@ -3696,7 +3953,9 @@ declare class AuthenticationResource extends BaseResource {
      *
      * @param payload - The reset-password body.
      * @param payload.email - The user's email address.
-     * @param payload.token - The reset token from the emailed link.
+     * @param payload.token - The reset token from the emailed link. The current
+     * schema leaves it optional even though the operation description says the
+     * reset uses that token.
      * @param payload.new_password - The new password to set.
      * @returns `{ email }` — the address whose password was reset. Response
      * shape:
@@ -3747,7 +4006,7 @@ declare class FieldsResource extends BaseResource {
      * @param payload - The field to create. `type` and `name` are required;
      *   `type` must be one of the platform field types (see
      *   {@link FieldsResource.listTypes}); `regex` may be a string or `null`,
-     *   and `is_required` is optional. `is_active` is a tested live extension.
+     *   and `is_required` is optional. `is_active` is a compatibility extension.
      * @param accountId - Override the client's default account ID.
      * @returns The created field definition. Response shape:
      * ```jsonc
@@ -3852,9 +4111,8 @@ declare class FieldsResource extends BaseResource {
      * (`PUT /accounts/{accountId}/fields/{fieldId}`).
      *
      * @param fieldId - The field definition to update.
-     * @param payload - Official fields are `name`, nullable `regex`, and
-     * `is_active`. The sandbox also accepts `type` and `is_required` as live
-     * compatibility extensions.
+     * @param payload - Fields are `name`, nullable `regex`, and `is_active`;
+     * `type` and `is_required` are compatibility extensions.
      * @param accountId - Override the client's default account ID.
      * @returns The updated field definition. Response shape:
      * ```jsonc
@@ -3907,9 +4165,9 @@ declare class FieldsResource extends BaseResource {
      * Validate a single value against a field definition
      * (`POST /accounts/{accountId}/fields/{fieldId}/validate`).
      *
-     * The official operation uses the client's API-key/Bearer authentication.
-     * `signerAccessCode` is retained as a deployment-specific, live-unverified
-     * compatibility query and is sent as `signer-access-code` when supplied.
+     * The operation uses the client's API-key/Bearer authentication.
+     * `signerAccessCode` is a compatibility query and is sent as
+     * `signer-access-code` when supplied.
      *
      * @param fieldId - The field definition to validate against.
      * @param value - The value to check (validated against the field's
@@ -3923,7 +4181,8 @@ declare class FieldsResource extends BaseResource {
      *   "error_message": ""
      * }
      * ```
-     * @throws {ValidationError} If `fieldId` or the account ID is missing.
+     * @throws {ValidationError} If `fieldId` or the account ID is missing, or
+     * `value` is `undefined`.
      * @throws {ApiError} If the API rejects the request.
      *
      * @example
@@ -3938,14 +4197,14 @@ declare class FieldsResource extends BaseResource {
     validate(fieldId: string, value: unknown, options?: {
         signerAccessCode?: string;
         accountId?: string;
-    }): Promise<IFieldValidationResult>;
+    }): Promise<IFieldValidationResponse>;
     /**
      * Validate multiple values at once
      * (`POST /accounts/{accountId}/fields/validate-multiple`).
      *
      * The request body is the array of `{ field_id, value }` entries itself
      * (not wrapped in an object). The optional `signerAccessCode` query is the
-     * same live-unverified compatibility extension described on
+     * same compatibility extension described on
      * {@link FieldsResource.validate}.
      *
      * @param entries - Non-empty array of `{ field_id, value }` pairs.
@@ -3953,8 +4212,8 @@ declare class FieldsResource extends BaseResource {
      * @returns One validation result per entry. Response shape:
      * ```jsonc
      * [
-     *   { "type": "cpf", "success": true, "error_message": "" },
-     *   { "type": "text", "success": true, "error_message": "" }
+     *   { "field_id": "field-cpf", "type": "cpf", "success": true, "error_message": "" },
+     *   { "field_id": "field-name", "type": "text", "success": true, "error_message": "" }
      * ]
      * ```
      * @throws {ValidationError} If `entries` is empty or the account ID is missing.
@@ -3973,11 +4232,15 @@ declare class FieldsResource extends BaseResource {
     validateMultiple(entries: IFieldValidateMultipleEntry[], options?: {
         signerAccessCode?: string;
         accountId?: string;
-    }): Promise<IFieldValidationResult[]>;
+    }): Promise<IFieldValidationMultipleResult[]>;
     /**
      * List the platform's supported field types (`GET /field-types`).
      *
-     * @returns The catalogue of field types (11 live entries). Response shape:
+     * The catalog is server-controlled. CPF validation expects 11 digits;
+     * CNPJ accepts 14 characters, including letters A–Z in positions 1–12,
+     * with numeric check digits in positions 13–14. Punctuation is ignored.
+     *
+     * @returns The current catalogue of field types. Response shape:
      * ```jsonc
      * [
      *   { "type": "personName", "name": "Nome" },
@@ -4004,6 +4267,7 @@ declare class FieldsResource extends BaseResource {
  * public exception and can be called without an access code.
  */
 declare class SignerDocumentsResource extends BaseResource {
+    constructor(http: AxiosInstance, defaultAccountId?: string, logger?: Logger, publicHttp?: AxiosInstance);
     /**
      * Fetch the document currently awaiting a given signer
      * (`GET /signers/{signer_id}/document?signer-access-code=…`).
@@ -4040,7 +4304,8 @@ declare class SignerDocumentsResource extends BaseResource {
      *   "updated_at": "2026-07-19T14:56:56Z"
      * }
      * ```
-     * @throws {ValidationError} If `signerId` or `signerAccessCode` is missing.
+     * @throws {ValidationError} If `signerId` or `signerAccessCode` is missing,
+     * or a supplied `search` value is not a string.
      * @throws {ApiError} If the access code is invalid or expired.
      *
      * @example
@@ -4103,9 +4368,8 @@ declare class SignerDocumentsResource extends BaseResource {
      *
      * The signer-side counterpart of {@link DocumentResource.search}, scoped to
      * one signer and authorised by their access code rather than the API key.
-     * Like {@link SignerDocumentsResource.list}, it requires
-     * `signer-access-code`; the published spec omits that parameter, but the
-     * endpoint is not usable without it.
+     * Like {@link SignerDocumentsResource.list}, it requires the
+     * `signer-access-code` query parameter.
      *
      * @param signerId - The signer whose documents are searched.
      * @param signerAccessCode - The signer's access code, from their signing link.
@@ -4133,19 +4397,22 @@ declare class SignerDocumentsResource extends BaseResource {
      * artifact names, exposed by the API as a public signer-link endpoint. The
      * optional access-code argument is retained for compatibility with deployed
      * environments that still accept or require the legacy query parameter. The
-     * `certificated` and `bundle` artifacts only exist once the document is fully
-     * signed.
+     * `certificated` and `bundle` exist only once the document is fully signed.
+     * `pades` exists only when the document had a Digital Certificate signer.
+     * A bundle contains original, certificated, and certificate-page artifacts,
+     * plus PAdES when present.
      *
      * @param signerId - The signer requesting the download.
      * @param documentId - The document to download.
      * @param artifactName - Which artifact to fetch (`original`, `certificated`,
-     *   `certificate-page`, or `bundle`).
+     *   `certificate-page`, `pades`, or `bundle`).
      * @param signerAccessCode - Optional legacy signer access code. Omit it for
      *   the official public request shape.
-     * @returns The artifact bytes as a Node `Buffer` (PDF for `original` /
-     *   `certificated` / `bundle`).
-     * @throws {ValidationError} If `signerId` or `documentId` is missing, or if
-     *   an explicitly supplied legacy `signerAccessCode` is blank.
+     * @returns The raw artifact bytes as a Node `Buffer` (PDF except for the
+     *   ZIP `bundle`).
+     * @throws {ValidationError} If `signerId` or `documentId` is missing,
+     *   `artifactName` is not one of the five documented names, or an explicitly
+     *   supplied legacy `signerAccessCode` is blank.
      * @throws {ApiError} `404` if the artifact does not exist yet.
      *
      * @example
@@ -4166,6 +4433,7 @@ declare class SignerDocumentsResource extends BaseResource {
      * Batch shortcut for a signer who has multiple pending documents under the
      * same access code — it signs each with their stored signature/initials
      * rather than field-by-field (contrast {@link SignerDocumentsResource.sign}).
+     * Every document must use the `virtual` assignment method.
      * The `document_ids` array goes in the request body; the access code
      * authenticates via the `signer-access-code` query param.
      *
@@ -4226,8 +4494,8 @@ declare class SignerDocumentsResource extends BaseResource {
      * prompt for {@link SignerDocumentsResource.uploadSignature} before signing.
      *
      * @param signerAccessCode - The signer's access code, from their signing link.
-     * @returns The signer profile. Unlike the workspace-side signer object, this
-     * also reports `has_signature` / `has_initial`:
+     * @returns The signer profile. `has_signature`, `has_initial`, and
+     * `is_signature_reusable` are optional compatibility flags:
      * ```jsonc
      * {
      *   "resource": "signer",
@@ -4316,34 +4584,35 @@ declare class SignerDocumentsResource extends BaseResource {
      * the signed document. Only the provided fields are sent — `undefined`/`null`
      * entries are stripped by {@link cleanParams} before the request — so you can
      * pass just the fields the signer changed. The access code authenticates via
-     * the `signer-access-code` query param. Legal terms are accepted separately
-     * with {@link SignerDocumentsResource.acceptTerms}; they are never asserted
-     * by this identity-data request.
+     * the `signer-access-code` query param. For `DigitalCertificate`, pass
+     * `has_accepted_terms: true` here or call
+     * {@link SignerDocumentsResource.acceptTerms} before fetching the assignment.
      *
      * @param documentId - The document the signer is confirming data for.
      * @param signerAccessCode - The signer's access code, from their signing link.
      * @param payload - Any of the official `full_name`, `email`, or
-     *   `government_id` fields. Fields left out are not sent.
+     *   `government_id`, or `has_accepted_terms` fields. Fields left out are not
+     *   sent.
      * @returns The confirmed signer in the full {@link ISigner} response shape.
-     * @throws {ValidationError} If `documentId` or `signerAccessCode` is missing.
+     * @throws {ValidationError} If `documentId` or `signerAccessCode` is missing,
+     * or a supplied identity value is malformed.
      * @throws {ApiError} If the access code is invalid/expired or a value fails
      *   validation.
      *
      * @example
      * ```ts
-     * // body → { full_name: 'Example Signer', government_id: '123.456.789-00' }
+     * // body → { full_name: 'Example Signer', government_id: '123.456.789-00', has_accepted_terms: true }
      * await client.signerDocuments.confirmData(documentId, accessCode, {
      *   full_name: 'Example Signer',
      *   government_id: '123.456.789-00',
+     *   has_accepted_terms: true,
      * });
-     * await client.signerDocuments.acceptTerms(accessCode);
      * ```
      */
     confirmData(documentId: string, signerAccessCode: string, payload: IConfirmSignerDataPayload): Promise<ISigner>;
     /**
      * @deprecated Compatibility overload preserving the previous wire shape.
-     * `whatsapp_phone_number` and `has_accepted_terms` are unverified legacy
-     * pass-through fields. Call `acceptTerms()` explicitly for legal consent.
+     * `whatsapp_phone_number` is a compatibility pass-through field.
      */
     confirmData(documentId: string, signerAccessCode: string, payload: ILegacyConfirmSignerDataPayload): Promise<ISigner>;
     /**
@@ -4391,8 +4660,8 @@ declare class SignerDocumentsResource extends BaseResource {
      * custom signing UI). Returns bytes, not JSON.
      *
      * @param signerAccessCode - The signer's access code, from their signing link.
-     * @param imageType - Which image to fetch: `'signature'` (default) or
-     *   `'initial'`.
+     * @param imageType - Server-defined image category; known values are
+     *   `'signature'` (default) and `'initial'`.
      * @returns The image bytes as a Node `Buffer` (PNG by default).
      * @throws {ValidationError} If `signerAccessCode` is missing.
      * @throws {ApiError} `404` if the signer has no such image stored; `401`/`403`
@@ -4404,16 +4673,22 @@ declare class SignerDocumentsResource extends BaseResource {
      * await fs.writeFile('signature.png', png);
      * ```
      */
-    downloadSignature(signerAccessCode: string, imageType?: 'signature' | 'initial'): Promise<Buffer>;
+    downloadSignature(signerAccessCode: string, imageType?: SignatureImageType): Promise<Buffer>;
     /**
      * Fetch the assignment (document + fields) as the signer sees it
      * (`GET /sign?signer-access-code=…`).
      *
      * The entry point for a custom signing UI: resolves the access code to the
      * document, its pages, and the {@link ISignFieldEntry}-addressable items the
-     * signer must fill. Before terms are accepted the server may answer `409`, so
-     * call {@link SignerDocumentsResource.acceptTerms} first (or pass
-     * `hasAcceptedTerms: true` once accepted).
+     * signer must fill. The server answers `409` while the document is still
+     * being prepared; retry that response with backoff. For ordinary signers,
+     * `hasAcceptedTerms: true` records terms acceptance on this request.
+     * Digital-certificate signers must confirm their data and accept terms
+     * before this request; otherwise it returns `400`. The query flag is too
+     * late to open that gate, so use `confirmData(..., { has_accepted_terms:
+     * true })` or `acceptTerms()` first.
+     * The API records this read as the signer having viewed the assignment, so
+     * the SDK never automatically replays this particular `GET` after a `429`.
      *
      * @param signerAccessCode - The signer's access code, from their signing link.
      * @param hasAcceptedTerms - Maps to the `has_accepted_terms` query param
@@ -4425,8 +4700,9 @@ declare class SignerDocumentsResource extends BaseResource {
      *   from which the `itemId` / `fieldId` / `pageId` values for
      *   {@link SignerDocumentsResource.sign} are read.
      * @throws {ValidationError} If `signerAccessCode` is missing.
-     * @throws {ApiError} `401`/`403` if the access code is invalid or expired;
-     *   `409` if terms have not yet been accepted.
+     * @throws {ApiError} `400` when DigitalCertificate identity/terms are not
+     *   confirmed; `401`/`403` if the access code is invalid or expired; `409`
+     *   while the document is still being prepared.
      *
      * @example
      * ```ts
@@ -4444,6 +4720,9 @@ declare class SignerDocumentsResource extends BaseResource {
      * the request body, each entry addressing one item resolved from
      * {@link SignerDocumentsResource.getAssignment}. The access code
      * authenticates via the `signer-access-code` query param.
+     * Virtual signers must call {@link SignerDocumentsResource.confirmData}
+     * first. Digital Certificate signers cannot use this endpoint; use the
+     * certificate start/complete API flow instead.
      *
      * @param documentId - The document being signed.
      * @param assignmentId - The assignment within that document.
@@ -4545,8 +4824,13 @@ declare class UserResource extends BaseResource {
      *   "documents_uploaded": 42,
      *   "documents_sent": 37,
      *   "signature_requests": 61,
-     *   "signature_requests_email": 55,
-     *   "signature_requests_whatsapp": 18,
+     *   "signature_requests_notification_email": 55,
+     *   "signature_requests_notification_whatsapp": 18,
+     *   "signature_requests_notification_bypass": 3,
+     *   "signature_requests_verification_email": 48,
+     *   "signature_requests_verification_whatsapp": 6,
+     *   "signature_requests_verification_bypass": 3,
+     *   "signature_requests_verification_digital_certificate": 4,
      *   "signature_requests_viewed": 44,
      *   "signature_requests_completed": 52,
      *   "documents_certified": 30
@@ -4566,6 +4850,61 @@ declare class UserResource extends BaseResource {
      * ```
      */
     getStats(params?: IDocumentStatsParams): Promise<IDocumentStatsRow[]>;
+    /**
+     * Return the authenticated user's owner-facing document e-mail settings
+     * (`GET /users/self/notification-preferences`).
+     *
+     * Request body: none. Authentication: `X-Api-Key` or Bearer token.
+     *
+     * @returns The complete nine-key preference map:
+     * ```json
+     * {
+     *   "DocumentCompleted": true,
+     *   "SignerDeclined": true,
+     *   "DocumentCancelled": true,
+     *   "DocumentAboutToExpire": true,
+     *   "DocumentExpired": true,
+     *   "DocumentExpirationReset": true,
+     *   "DocumentProcessingFailed": true,
+     *   "TemplateProcessingFailed": true,
+     *   "SignerWhatsappFailed": true
+     * }
+     * ```
+     * @throws {ApiError} `401` when credentials are missing/invalid, or `500`
+     * when the API cannot load the preferences.
+     *
+     * @example
+     * ```ts
+     * const preferences = await client.users.getNotificationPreferences();
+     * ```
+     */
+    getNotificationPreferences(): Promise<INotificationPreferences>;
+    /**
+     * Merge owner-facing document e-mail settings for the authenticated user
+     * (`PUT /users/self/notification-preferences`). Omitted keys retain their
+     * current values; account/security e-mails are not configurable here.
+     *
+     * @param preferences - One or more of the nine documented keys, each with
+     * a boolean value. Request example:
+     * ```json
+     * { "DocumentCompleted": true, "SignerDeclined": false }
+     * ```
+     * @returns The complete updated map; its shape is identical to
+     * {@link UserResource.getNotificationPreferences}.
+     * @throws {ValidationError} Before requesting when the map is empty, has an
+     * unknown key, or contains a non-boolean value.
+     * @throws {ApiError} `400` if the API rejects the map, `401` for invalid
+     * credentials, or `500` on a server error.
+     *
+     * @example
+     * ```ts
+     * await client.users.updateNotificationPreferences({
+     *   SignerDeclined: false,
+     *   DocumentExpired: false,
+     * });
+     * ```
+     */
+    updateNotificationPreferences(preferences: IUpdateNotificationPreferences): Promise<INotificationPreferences>;
 }
 
 /**
@@ -4608,9 +4947,8 @@ declare class WebhookVerifier {
      */
     verify(payload: string | Buffer, signature: string): boolean;
     /**
-     * Parse the raw webhook body into a JSON object. Inbound webhook bodies are
-     * not described by the current OpenAPI, so this remains deliberately
-     * tolerant of both the observed rich envelope and legacy `{ type, data }`.
+     * Parse the raw webhook body into a JSON object. Both the rich envelope and
+     * compatibility `{ type, data }` form are accepted.
      *
      * @param payload - Raw UTF-8 JSON request body.
      * @returns The object envelope, or `null` for malformed JSON, primitives,
@@ -4713,11 +5051,16 @@ declare class AssinafyClient {
      * authenticates protected operations; `accountId` sets the default
      * workspace used by every account-scoped resource; `baseUrl` (default the
      * production API), `timeout`
-     * (default 30 s), `maxRetries` (default 2, for HTTP 429 on idempotent
+     * (default 30 s), `maxRetries` (default 2, for HTTP 429 on replay-safe
      * requests), `webhookSecret` (enables
      * {@link AssinafyClient.webhookVerifier}) and `logger` are optional.
-     * Non-idempotent requests are retried only when they explicitly carry an
-     * `Idempotency-Key` header.
+     * Automatic retries cover `GET`, `HEAD`, `OPTIONS`, and `DELETE`, except
+     * `GET /sign` because that read records a signer view. An
+     * `Idempotency-Key` opts advanced/custom requests into SDK replay only;
+     * confirm that the target route actually deduplicates that key first.
+     *
+     * @throws {ValidationError} If `timeout` / `maxRetries` is invalid or
+     * `baseUrl` is not an absolute HTTP(S) URL.
      *
      * @example
      * ```ts
@@ -4736,6 +5079,7 @@ declare class AssinafyClient {
      * @param options - Extra client options (`baseUrl`, `timeout`, `maxRetries`,
      * `webhookSecret`, `logger`), minus `apiKey`/`accountId`.
      * @returns A configured {@link AssinafyClient}.
+     * @throws {ValidationError} If an extra client option is invalid.
      *
      * @example
      * ```ts
@@ -4755,6 +5099,8 @@ declare class AssinafyClient {
      *
      * @param config - Loosely-typed configuration ({@link ClientConfigInput}).
      * @returns A configured {@link AssinafyClient}.
+     * @throws {ValidationError} If `config` is not an object or contains an
+     * invalid timeout, retry count, or base URL.
      *
      * @example
      * ```ts
@@ -4766,23 +5112,20 @@ declare class AssinafyClient {
      */
     static fromConfig(config: ClientConfigInput): AssinafyClient;
     /**
-     * Flagship helper: upload a PDF, wait for it to process, ensure each signer
-     * exists, and open a **virtual** signature assignment — the whole "send this
+     * Flagship helper: upload a PDF, ensure each signer exists, and open a
+     * **virtual** signature assignment — the whole "send this
      * document for signature" flow in a single call.
      *
      * Sequence of API calls:
      * 1. `POST /accounts/{accountId}/documents` — upload the PDF
      *    ({@link DocumentResource.upload}).
-     * 2. Poll `GET /documents/{id}` until the document reaches a ready status
-     *    ({@link DocumentResource.waitUntilReady}).
-     * 3. For each signer, reuse an existing signer by email or
+     * 2. For each signer, reuse an existing signer by email or
      *    `POST /accounts/{accountId}/signers` to create one
      *    ({@link SignerResource.create} — idempotent by email).
-     * 4. `POST /documents/{id}/assignments` with `method: 'virtual'` and the
+     * 3. `POST /documents/{id}/assignments` with `method: 'virtual'` and the
      *    collected signer IDs ({@link AssignmentResource.create}).
-     * 5. When `waitForReady` is not `false`, re-fetch `GET /documents/{id}` so
-     *    the returned document reflects the just-created assignment; otherwise
-     *    the upload snapshot is returned, avoiding only this final round-trip.
+     * 4. When `waitForReady` is not `false`, poll `GET /documents/{id}` until
+     *    processing finishes; otherwise return the upload response immediately.
      *
      * @param options - Workflow options.
      * @param options.source - The PDF to upload, as a file path or in-memory
@@ -4790,24 +5133,29 @@ declare class AssinafyClient {
      * @param options.signers - Signers to request signatures from — at least one
      * is required. Each is `{ name, email?, whatsapp_phone_number? | phone?,
      * cpf?, metadata? }`; a signer needs an email or a WhatsApp number to be
-     * notified.
+     * notified. Phone-only signers automatically use WhatsApp for verification
+     * and notification, which requires a paid plan and incurs the channel cost;
+     * signers with e-mail default to the e-mail channel.
      * @param options.message - Optional invitation message attached to the
      * assignment.
      * @param options.metadata - Optional metadata attached to the uploaded
      * document.
-     * @param options.waitForReady - Controls the final document re-fetch and
-     * return shape. Defaults to `true`. The workflow always waits for
-     * `metadata_ready` before creating an assignment because the API rejects
-     * assignments for documents that are still being processed.
+     * @param options.waitForReady - Wait for document processing before
+     * returning. Defaults to `true`. Virtual assignments are created directly
+     * from `uploaded`, `metadata_processing`, or `metadata_ready`, as allowed by
+     * the API; only `collect` assignments require pre-rendered pages.
+     * @param options.waitOptions - Optional `maxWaitMs` / `pollIntervalMs`
+     * forwarded to {@link DocumentResource.waitUntilReady}.
      * @param options.expiresAt - Optional ISO-8601 assignment expiry, e.g.
      * `'2026-08-01T00:00:00Z'`.
-     * @param options.copyReceivers - Optional CC recipients (see the caveat on
-     * {@link ICreateAssignmentPayload.copy_receivers} — silently dropped on some
-     * plans).
+     * @param options.copyReceivers - Optional existing signer IDs (not email
+     * addresses) that receive a copy. See the caveat on
+     * {@link ICreateAssignmentPayload.copy_receivers}; some plans silently drop
+     * the field.
      * @param options.accountId - Override the client's default account ID.
      * @returns `{ document, assignment, signer_ids }`. `document` is the
      * re-fetched {@link IDocumentDetailsResponse} when `waitForReady` (the
-     * default), otherwise the {@link IDocumentUploadResponse} upload snapshot;
+     * default), otherwise the {@link IDocumentUploadResponse} upload response;
      * `signer_ids` are the created/reused signer IDs in signer order:
      * ```jsonc
      * {
@@ -4838,10 +5186,16 @@ declare class AssinafyClient {
      *   "signer_ids": ["1032becb82a279550bc3e5df9bbb"]
      * }
      * ```
-     * @throws {ValidationError} If `signers` is empty, the upload fails
-     * validation (empty / non-PDF / larger than 25 MB), or the document never
-     * reaches a ready status before the
-     * {@link DocumentResource.waitUntilReady} timeout.
+     * This workflow is not transactional. If any post-upload step fails, its
+     * {@link AssinafyError} includes the uploaded `documentId`, accumulated
+     * `signerIds`, and `assignmentId` (once created) in `context`; a
+     * {@link ValidationError} also exposes them in `errors`. Inspect those IDs
+     * before retrying. The SDK does not auto-delete successfully created data.
+     *
+     * @throws {ValidationError} If the workflow/options or a signer is invalid,
+     * the upload is empty / non-PDF / larger than 25 MB, or `waitForReady` is
+     * enabled and processing exceeds the {@link DocumentResource.waitUntilReady}
+     * timeout.
      * @throws {ApiError} If any underlying API call is rejected.
      *
      * @example
@@ -4854,9 +5208,9 @@ declare class AssinafyClient {
      *   ],
      *   message: 'Please sign the attached agreement.',
      * });
-     * console.log(document.status);          // 'metadata_ready'
+     * console.log(document.status);          // usually 'pending_signature'
      * console.log(signer_ids.length);        // 2
-     * console.log(assignment.signing_urls);  // per-signer signing links
+     * console.log(assignment.signing_urls?.length); // one protected link per signer
      * ```
      */
     uploadAndRequestSignatures(options: {
@@ -4865,6 +5219,10 @@ declare class AssinafyClient {
         message?: string;
         metadata?: Record<string, unknown>;
         waitForReady?: boolean;
+        waitOptions?: {
+            maxWaitMs?: number;
+            pollIntervalMs?: number;
+        };
         expiresAt?: string;
         copyReceivers?: string[];
         accountId?: string;
@@ -4876,8 +5234,13 @@ declare class AssinafyClient {
      *
      * @returns The configured `AxiosInstance` — auth headers, base URL, timeout,
      * and the HTTP 429 retry interceptor are already applied. Automatic retries
-     * are limited to `GET`, `HEAD`, `OPTIONS`, `PUT`, and `DELETE`; add a unique
-     * `Idempotency-Key` header to explicitly permit replay of another method.
+     * are limited to read-safe `GET`, `HEAD`, `OPTIONS`, and `DELETE` requests;
+     * `GET /sign` is excluded because it records that the assignment was viewed.
+     * An `Idempotency-Key` opts a custom request into SDK replay only after the
+     * caller confirms that the target route deduplicates it server-side.
+     * Same-origin absolute URLs are supported; cross-origin requests are
+     * rejected before dispatch, and credentials are removed from cross-origin
+     * redirects. Use a separate axios client for unrelated hosts.
      *
      * @example
      * ```ts
@@ -4936,11 +5299,11 @@ declare class ApiError extends AssinafyError {
      */
     static fromResponse(statusCode: number, responseData: unknown): ApiError;
 }
-/** Thrown when client-side validation fails before the request is sent. */
+/** Thrown when SDK validation fails, including invalid input or workflow state. */
 declare class ValidationError extends AssinafyError {
     readonly errors: Record<string, unknown>;
     /**
-     * Create a client-side validation failure raised before network I/O.
+     * Create an SDK validation failure.
      *
      * @param message - Human-readable validation summary.
      * @param errors - Field/value diagnostics for programmatic handling.
@@ -4968,4 +5331,6 @@ declare class NetworkError extends AssinafyError {
     constructor(message: string, options?: ErrorOptions);
 }
 
-export { type AccountLogoUploadSource, type AnyString, ApiError, type AssignmentMethod, type AssignmentNotificationMethod, AssignmentResource, type AssignmentVerificationMethod, AssinafyClient, type AssinafyClientOptions, AssinafyError, AuthenticationResource, type ClientConfigInput, DEFAULT_WEBHOOK_EVENTS, type DocumentArtifactName, DocumentResource, type DocumentStatsGranularity, type DocumentStatus, type DocumentUploadSource, FieldsResource, type IAccountTheme, type IApiKeyResponse, type IAssignment, type IAssignmentCostSigner, type IAssignmentEntry, type IAssignmentItem, type IAssignmentListParams, type IAssignmentListResponse, type IAssignmentSigner, type IAuthenticatedUser, type IConfirmSignerDataPayload, type ICostEstimate, type ICreateAssignmentPayload, type ICreateAssignmentResponse, type ICreateDocumentFromTemplateOptions, type ICreateFieldPayload, type ICreateSignerPayload, type ICreateSignerResponse, type ICreateTagPayload, type ICreateWorkspacePayload, type IDocumentActivity, type IDocumentDetailsResponse, type IDocumentListItem, type IDocumentListParams, type IDocumentListResponse, type IDocumentSearchParams, type IDocumentStatsParams, type IDocumentStatsRow, type IDocumentStatusInfo, type IDocumentUploadOptions, type IDocumentUploadResponse, type IDocumentVerification, type IEstimateAssignmentCostPayload, type IFieldDefinition, type IFieldType, type IFieldValidateMultipleEntry, type IFieldValidationResult, type IInlineTag, type ILegacyConfirmSignerDataPayload, type ILegacyResendCostEstimate, type ILegacyUploadSignatureOptions, type IListParams, type ILoginResponse, type IMaskedApiKeyResponse, type INotificationHistoryEntry, type IPage, type IPaginatedResponse, type IPublicDocumentInfo, type IRenameDocumentResponse, type IResendCostEstimate, type IResendEmailResponse, type ISignFieldEntry, type ISigner, type ISignerListResponse, type ISignerSelf, type ISigningProgress, type ITag, type ITemplateCostSigner, type ITemplateDetailsResponse, type ITemplateFieldPlacement, type ITemplateListItem, type ITemplateListResponse, type ITemplateRole, type ITemplateSigner, type IUpdateFieldPayload, type IUpdateSignerPayload, type IUpdateTagPayload, type IUpdateTemplatePayload, type IUpdateWorkspacePayload, type IUploadAndRequestSignaturesResult, type IUploadAndRequestSignaturesSigner, type IUploadSignatureOptions, type IWebhookDispatch, type IWebhookDispatchListParams, type IWebhookEventTypeInfo, type IWebhookPayload, type IWebhookRegisterPayload, type IWebhookSubscription, type IWhatsAppNotification, type IWorkspaceListItem, type IWorkspaceListResponse, type IWorkspaceResponse, type Logger, MAX_UPLOAD_BYTES, NetworkError, type NotificationSenderType, type PaginatedResult, type PaginationMeta, type SendTokenChannel, SignerDocumentsResource, type SignerReference, SignerResource, TagResource, TemplateResource, UserResource, ValidationError, type WebhookEventType, WebhookResource, WebhookVerifier, WorkspaceResource, buildAssignmentPayload };
+declare const SDK_USER_AGENT: string;
+
+export { type AccountLogoUploadSource, type AnyString, ApiError, type AssignmentDisplaySettings, type AssignmentMethod, type AssignmentNotificationMethod, AssignmentResource, type AssignmentVerificationMethod, AssinafyClient, type AssinafyClientOptions, AssinafyError, AuthenticationResource, type ClientConfigInput, DEFAULT_WEBHOOK_EVENTS, type DocumentArtifactName, DocumentResource, type DocumentStatsGranularity, type DocumentStatus, type DocumentUploadSource, FieldsResource, type IAccountTheme, type IApiKeyResponse, type IAssignment, type IAssignmentCostSigner, type IAssignmentEntry, type IAssignmentItem, type IAssignmentListParams, type IAssignmentListResponse, type IAssignmentSigner, type IAuthenticatedUser, type IConfirmSignerDataPayload, type ICostEstimate, type ICreateAssignmentPayload, type ICreateAssignmentResponse, type ICreateDocumentFromTemplateOptions, type ICreateFieldPayload, type ICreateSignerPayload, type ICreateSignerResponse, type ICreateTagPayload, type ICreateWorkspacePayload, type IDeleteTagResponse, type IDetachDocumentTagResponse, type IDisplaySettings, type IDocumentActivity, type IDocumentDetailsResponse, type IDocumentListItem, type IDocumentListParams, type IDocumentListResponse, type IDocumentSearchParams, type IDocumentStatsParams, type IDocumentStatsRow, type IDocumentStatusInfo, type IDocumentUploadOptions, type IDocumentUploadResponse, type IDocumentVerification, type IEstimateAssignmentCostPayload, type IFieldDefinition, type IFieldType, type IFieldValidateMultipleEntry, type IFieldValidationMultipleResult, type IFieldValidationResponse, type IFieldValidationResult, type IInlineTag, type ILegacyConfirmSignerDataPayload, type ILegacyResendCostEstimate, type ILegacyUploadSignatureOptions, type IListParams, type ILoginResponse, type IMaskedApiKeyResponse, type INotificationHistoryEntry, type INotificationPreferences, type IPage, type IPaginatedResponse, type IPublicDocumentInfo, type IRenameDocumentResponse, type IResendCostEstimate, type IResendEmailResponse, type ISignFieldEntry, type ISigner, type ISignerListParams, type ISignerListResponse, type ISignerSelf, type ISigningProgress, type ITag, type ITemplateCostSigner, type ITemplateDetailsResponse, type ITemplateFieldPlacement, type ITemplateListItem, type ITemplateListParams, type ITemplateListResponse, type ITemplateRole, type ITemplateSigner, type IUpdateFieldPayload, type IUpdateNotificationPreferences, type IUpdateSignerPayload, type IUpdateTagPayload, type IUpdateTemplatePayload, type IUpdateWorkspacePayload, type IUploadAndRequestSignaturesResult, type IUploadAndRequestSignaturesSigner, type IUploadSignatureOptions, type IWebhookDispatch, type IWebhookDispatchListParams, type IWebhookEventTypeInfo, type IWebhookPayload, type IWebhookRegisterPayload, type IWebhookSubscription, type IWhatsAppNotification, type IWorkspaceListItem, type IWorkspaceListResponse, type IWorkspaceResponse, type Logger, MAX_UPLOAD_BYTES, NetworkError, type NotificationSenderType, type PaginatedResult, type PaginationMeta, SDK_USER_AGENT, type SendTokenChannel, type SignatureImageType, SignerDocumentsResource, type SignerReference, SignerResource, TagResource, TemplateResource, UserResource, ValidationError, type WebhookEventType, WebhookResource, WebhookVerifier, WorkspaceResource, buildAssignmentPayload };