@assinafy/sdk 2.3.0 → 2.4.0

package/CHANGELOG.md

@@ -7,6 +7,38 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [2.4.0] - 2026-09-21
+
+### Fixed
+
+- **`assignments.estimateCost` now sends `signers` for `collect` too.** The
+  published contract marks `signers` as required only for `virtual`, but the
+  API rejects *any* estimate without it — `collect` requests came back as
+  `400 Pelo menos um signatários precisa ser informado.` Pricing is per signer
+  in both modes (`Whatsapp` costs 0.45 credits per signer,
+  `DigitalCertificate` two), so a signer-less body could never be priced.
+
+### Changed
+
+- `IEstimateAssignmentCostPayload.signers` is now required. TypeScript callers
+  that omitted it for `collect` will stop compiling; those calls were already
+  failing at runtime, so no working code changes behaviour. Pass one descriptor
+  per signer —
+  `{}` prices the default Email channel:
+
+  ```ts
+  await client.assignments.estimateCost(documentId, {
+    method: 'collect',
+    signers: [{}, { verification_method: 'Whatsapp' }],
+    entries,
+  });
+  ```
+
+- `buildAssignmentEstimatePayload` throws `ValidationError` for an empty
+  signer list in either mode, so JavaScript callers get a local error instead
+  of an opaque upstream rejection. The message is now method-neutral:
+  `At least one signer is required for a cost estimate`.
+
 ## [2.3.0] - 2026-09-20
 
 ### Added
@@ -621,7 +653,8 @@ fields (`cpf`, `whatsapp_phone_number`) with the PHP SDK and n8n node.
 - High-level `uploadAndRequestSignatures` helper on `AssinafyClient`.
 - `PaginatedResult<T>` with parsed `X-Pagination-*` header meta.
 
-[Unreleased]: https://github.com/assinafy/typescript-sdk/compare/v2.3.0...HEAD
+[Unreleased]: https://github.com/assinafy/typescript-sdk/compare/v2.4.0...HEAD
+[2.4.0]: https://github.com/assinafy/typescript-sdk/compare/v2.3.0...v2.4.0
 [2.3.0]: https://github.com/assinafy/typescript-sdk/compare/v2.2.0...v2.3.0
 [2.2.0]: https://github.com/assinafy/typescript-sdk/compare/v2.1.2...v2.2.0
 [2.1.2]: https://github.com/assinafy/typescript-sdk/compare/v2.1.1...v2.1.2

package/dist/index.d.mts

@@ -303,9 +303,13 @@ interface IAssignmentCostSigner {
  */
 interface IEstimateAssignmentCostPayload {
     method?: AssignmentMethod;
-    /** Required for `virtual`; `{}` prices the default Email channel. */
-    signers?: IAssignmentCostSigner[];
-    /** Required for `collect`; signer descriptors are optional in that mode. */
+    /**
+     * Required for both methods — the API rejects an estimate without it, and
+     * per-signer `verification_method` is what the estimate prices. `{}` prices
+     * the default Email channel.
+     */
+    signers: IAssignmentCostSigner[];
+    /** Required for `collect`. */
     entries?: IAssignmentEntry[];
 }
 /** A signer as embedded inside an assignment (richer than the bare {@link ISigner}). */
@@ -2933,7 +2937,8 @@ declare class AssignmentResource extends BaseResource {
      * }
      * ```
      * @throws {ValidationError} If `documentId` is missing, a `virtual` request
-     * has no signer entry, or a `collect` request has no field-placement entry.
+     * has no signer entry, or a `collect` request has no signer entry or no
+     * field-placement entry.
      * @throws {ApiError} If the API rejects the request.
      *
      * @example

package/dist/index.d.ts

@@ -303,9 +303,13 @@ interface IAssignmentCostSigner {
  */
 interface IEstimateAssignmentCostPayload {
     method?: AssignmentMethod;
-    /** Required for `virtual`; `{}` prices the default Email channel. */
-    signers?: IAssignmentCostSigner[];
-    /** Required for `collect`; signer descriptors are optional in that mode. */
+    /**
+     * Required for both methods — the API rejects an estimate without it, and
+     * per-signer `verification_method` is what the estimate prices. `{}` prices
+     * the default Email channel.
+     */
+    signers: IAssignmentCostSigner[];
+    /** Required for `collect`. */
     entries?: IAssignmentEntry[];
 }
 /** A signer as embedded inside an assignment (richer than the bare {@link ISigner}). */
@@ -2933,7 +2937,8 @@ declare class AssignmentResource extends BaseResource {
      * }
      * ```
      * @throws {ValidationError} If `documentId` is missing, a `virtual` request
-     * has no signer entry, or a `collect` request has no field-placement entry.
+     * has no signer entry, or a `collect` request has no signer entry or no
+     * field-placement entry.
      * @throws {ApiError} If the API rejects the request.
      *
      * @example

package/dist/index.js

@@ -634,7 +634,7 @@ var import_axios2 = __toESM(require("axios"));
 // package.json
 var package_default = {
   name: "@assinafy/sdk",
-  version: "2.3.0",
+  version: "2.4.0",
   packageManager: "bun@1.4.0",
   description: "TypeScript SDK for Assinafy API - Digital signature platform",
   type: "commonjs",
@@ -1071,8 +1071,8 @@ function buildAssignmentEstimatePayload(payload) {
     throw new ValidationError("method must be virtual or collect");
   }
   const signers = Array.isArray(payload.signers) ? payload.signers : [];
-  if (method === "virtual" && signers.length === 0) {
-    throw new ValidationError("At least one signer is required for a virtual cost estimate");
+  if (signers.length === 0) {
+    throw new ValidationError("At least one signer is required for a cost estimate");
   }
   const entries = payload.entries === void 0 ? void 0 : normaliseAssignmentEntries(payload.entries);
   if (method === "collect" && (!entries || entries.length === 0)) {
@@ -1080,7 +1080,7 @@ function buildAssignmentEstimatePayload(payload) {
   }
   return cleanParams({
     method,
-    signers: signers.length > 0 ? signers.map((signer) => normaliseEstimateSigner(signer)) : void 0,
+    signers: signers.map((signer) => normaliseEstimateSigner(signer)),
     entries
   });
 }
@@ -1461,7 +1461,8 @@ var AssignmentResource = class extends BaseResource {
    * }
    * ```
    * @throws {ValidationError} If `documentId` is missing, a `virtual` request
-   * has no signer entry, or a `collect` request has no field-placement entry.
+   * has no signer entry, or a `collect` request has no signer entry or no
+   * field-placement entry.
    * @throws {ApiError} If the API rejects the request.
    *
    * @example

package/dist/index.mjs

@@ -574,7 +574,7 @@ import axios2 from "axios";
 // package.json
 var package_default = {
   name: "@assinafy/sdk",
-  version: "2.3.0",
+  version: "2.4.0",
   packageManager: "bun@1.4.0",
   description: "TypeScript SDK for Assinafy API - Digital signature platform",
   type: "commonjs",
@@ -1011,8 +1011,8 @@ function buildAssignmentEstimatePayload(payload) {
     throw new ValidationError("method must be virtual or collect");
   }
   const signers = Array.isArray(payload.signers) ? payload.signers : [];
-  if (method === "virtual" && signers.length === 0) {
-    throw new ValidationError("At least one signer is required for a virtual cost estimate");
+  if (signers.length === 0) {
+    throw new ValidationError("At least one signer is required for a cost estimate");
   }
   const entries = payload.entries === void 0 ? void 0 : normaliseAssignmentEntries(payload.entries);
   if (method === "collect" && (!entries || entries.length === 0)) {
@@ -1020,7 +1020,7 @@ function buildAssignmentEstimatePayload(payload) {
   }
   return cleanParams({
     method,
-    signers: signers.length > 0 ? signers.map((signer) => normaliseEstimateSigner(signer)) : void 0,
+    signers: signers.map((signer) => normaliseEstimateSigner(signer)),
     entries
   });
 }
@@ -1401,7 +1401,8 @@ var AssignmentResource = class extends BaseResource {
    * }
    * ```
    * @throws {ValidationError} If `documentId` is missing, a `virtual` request
-   * has no signer entry, or a `collect` request has no field-placement entry.
+   * has no signer entry, or a `collect` request has no signer entry or no
+   * field-placement entry.
    * @throws {ApiError} If the API rejects the request.
    *
    * @example

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@assinafy/sdk",
-    "version": "2.3.0",
+    "version": "2.4.0",
     "packageManager": "bun@1.4.0",
     "description": "TypeScript SDK for Assinafy API - Digital signature platform",
     "type": "commonjs",