@signa-so/sdk 0.9.0 → 0.15.0

package/dist/resources/goods-services.d.ts

@@ -1,6 +1,6 @@
 import { BaseResource } from '../resource.js';
 import { type SignaList } from '../pagination.js';
-import type { GoodsServicesTerm, GoodsServicesListParams, GoodsServicesSuggestParams, GoodsServicesSuggestResult, RequestOptions } from '../types.js';
+import type { GoodsServicesTerm, GoodsServicesListParams, GoodsServicesSuggestParams, GoodsServicesSuggestResult, GoodsServicesValidateParams, GoodsServicesValidationResponse, RequestOptions } from '../types.js';
 /**
  * Goods & services — the pre-approved-terms catalog (Harmonised Database +
  * USPTO ID Manual) and the AI-assisted G&S specification drafter.
@@ -10,10 +10,14 @@ import type { GoodsServicesTerm, GoodsServicesListParams, GoodsServicesSuggestPa
  * - {@link GoodsServices.suggest} — draft a filing-ready goods/services
  *   specification from a natural-language description. Pass `class_number`
  *   to scope the output to a single, already-chosen class.
+ * - {@link GoodsServices.validate} — report whether submitted wording appears
+ *   in each requested office's pre-approved catalog, with descriptive wording
+ *   coverage, drafting candidates, inferred-class suggestions, cited warnings,
+ *   catalog freshness, and candidate-search completeness.
  */
 export declare class GoodsServices extends BaseResource {
     /**
-     * Browse/search accepted goods & services terms. At least one of `q` or
+     * Browse/search pre-approved goods & services terms. At least one of `q` or
      * `class` must be provided.
      *
      * Scope: `trademarks:read`. Not billed (reference data).
@@ -52,5 +56,35 @@ export declare class GoodsServices extends BaseResource {
      * ```
      */
     suggest(body: GoodsServicesSuggestParams, options?: RequestOptions): Promise<GoodsServicesSuggestResult>;
+    /**
+     * Check submitted wording against the pre-approved catalogs we hold.
+     * `listed` means the wording appears in that office's catalog;
+     * `not_listed` is an absence of evidence, not a refusal.
+     *
+     * Only US, EM, JP, KR, and CN have catalog answers. Other recognized offices
+     * return `unsupported_office` with reason `no_catalog_data`.
+     *
+     * Coverage describes which tokens are supported by returned catalog wording;
+     * it is not an acceptance verdict. Template candidates are drafting aids and
+     * are never themselves `listed`. An inferred class is a suggestion that the
+     * caller can override by supplying `class_number`. Warnings cite office
+     * guidance about indefinite wording and do not predict refusal.
+     *
+     * Check `candidate_search`: `complete` makes an empty candidate list
+     * meaningful, while `truncated` and `degraded` mean the search was incomplete.
+     * `summary.offices[].catalog_freshness[].as_of` reports catalog freshness; null means
+     * unknown, not current.
+     *
+     * Scope: `trademarks:read`. Billed per item. `Idempotency-Key` is optional
+     * and can be supplied through `options.idempotency_key` for replay.
+     *
+     * ```typescript
+     * const result = await signa.goodsServices.validate({
+     *   offices: ['US', 'EM'],
+     *   items: [{ term: 'coffee', class_number: 30 }],
+     * });
+     * ```
+     */
+    validate(body: GoodsServicesValidateParams, options?: RequestOptions): Promise<GoodsServicesValidationResponse>;
 }
 //# sourceMappingURL=goods-services.d.ts.map

package/dist/resources/goods-services.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"goods-services.d.ts","sourceRoot":"","sources":["../../src/resources/goods-services.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,iBAAiB,EACjB,uBAAuB,EACvB,0BAA0B,EAC1B,0BAA0B,EAC1B,cAAc,EACf,MAAM,aAAa,CAAC;AAErB;;;;;;;;;GASG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C;;;;;;;;;;;;;OAaG;IACG,IAAI,CACR,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAexC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,OAAO,CACX,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,0BAA0B,CAAC;CAOvC"}
+{"version":3,"file":"goods-services.d.ts","sourceRoot":"","sources":["../../src/resources/goods-services.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,iBAAiB,EACjB,uBAAuB,EACvB,0BAA0B,EAC1B,0BAA0B,EAC1B,2BAA2B,EAC3B,+BAA+B,EAC/B,cAAc,EACf,MAAM,aAAa,CAAC;AAErB;;;;;;;;;;;;;GAaG;AACH,qBAAa,aAAc,SAAQ,YAAY;IAC7C;;;;;;;;;;;;;OAaG;IACG,IAAI,CACR,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAexC;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,OAAO,CACX,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,0BAA0B,CAAC;IAQtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACG,QAAQ,CACZ,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,+BAA+B,CAAC;CAO5C"}

package/dist/resources/goods-services.js

@@ -9,10 +9,14 @@ import { createList } from '../pagination.js';
  * - {@link GoodsServices.suggest} — draft a filing-ready goods/services
  *   specification from a natural-language description. Pass `class_number`
  *   to scope the output to a single, already-chosen class.
+ * - {@link GoodsServices.validate} — report whether submitted wording appears
+ *   in each requested office's pre-approved catalog, with descriptive wording
+ *   coverage, drafting candidates, inferred-class suggestions, cited warnings,
+ *   catalog freshness, and candidate-search completeness.
  */
 export class GoodsServices extends BaseResource {
     /**
-     * Browse/search accepted goods & services terms. At least one of `q` or
+     * Browse/search pre-approved goods & services terms. At least one of `q` or
      * `class` must be provided.
      *
      * Scope: `trademarks:read`. Not billed (reference data).
@@ -56,5 +60,37 @@ export class GoodsServices extends BaseResource {
     async suggest(body, options) {
         return this._post('/v1/goods-services/suggest', body, options);
     }
+    /**
+     * Check submitted wording against the pre-approved catalogs we hold.
+     * `listed` means the wording appears in that office's catalog;
+     * `not_listed` is an absence of evidence, not a refusal.
+     *
+     * Only US, EM, JP, KR, and CN have catalog answers. Other recognized offices
+     * return `unsupported_office` with reason `no_catalog_data`.
+     *
+     * Coverage describes which tokens are supported by returned catalog wording;
+     * it is not an acceptance verdict. Template candidates are drafting aids and
+     * are never themselves `listed`. An inferred class is a suggestion that the
+     * caller can override by supplying `class_number`. Warnings cite office
+     * guidance about indefinite wording and do not predict refusal.
+     *
+     * Check `candidate_search`: `complete` makes an empty candidate list
+     * meaningful, while `truncated` and `degraded` mean the search was incomplete.
+     * `summary.offices[].catalog_freshness[].as_of` reports catalog freshness; null means
+     * unknown, not current.
+     *
+     * Scope: `trademarks:read`. Billed per item. `Idempotency-Key` is optional
+     * and can be supplied through `options.idempotency_key` for replay.
+     *
+     * ```typescript
+     * const result = await signa.goodsServices.validate({
+     *   offices: ['US', 'EM'],
+     *   items: [{ term: 'coffee', class_number: 30 }],
+     * });
+     * ```
+     */
+    async validate(body, options) {
+        return this._post('/v1/goods-services/validate', body, options);
+    }
 }
 //# sourceMappingURL=goods-services.js.map

package/dist/resources/goods-services.js.map

@@ -1 +1 @@
-{"version":3,"file":"goods-services.js","sourceRoot":"","sources":["../../src/resources/goods-services.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAS9D;;;;;;;;;GASG;AACH,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CACR,MAA+B,EAC/B,OAAwB;QAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAC1C,oBAAoB,EACpB,MAA4C,EAC5C,OAAO,CACR,CAAC;QACF,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,IAAI,CAAC,gBAAgB,CACnB,oBAAoB,EACpB,EAAE,GAAG,MAAM,EAAE,MAAM,EAAwC,EAC3D,OAAO,CACR,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,OAAO,CACX,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,KAAK,CACf,4BAA4B,EAC5B,IAAI,EACJ,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"goods-services.js","sourceRoot":"","sources":["../../src/resources/goods-services.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAW9D;;;;;;;;;;;;;GAaG;AACH,MAAM,OAAO,aAAc,SAAQ,YAAY;IAC7C;;;;;;;;;;;;;OAaG;IACH,KAAK,CAAC,IAAI,CACR,MAA+B,EAC/B,OAAwB;QAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAC1C,oBAAoB,EACpB,MAA4C,EAC5C,OAAO,CACR,CAAC;QACF,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,IAAI,CAAC,gBAAgB,CACnB,oBAAoB,EACpB,EAAE,GAAG,MAAM,EAAE,MAAM,EAAwC,EAC3D,OAAO,CACR,CACF,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,OAAO,CACX,IAAgC,EAChC,OAAwB;QAExB,OAAO,IAAI,CAAC,KAAK,CACf,4BAA4B,EAC5B,IAAI,EACJ,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA4BG;IACH,KAAK,CAAC,QAAQ,CACZ,IAAiC,EACjC,OAAwB;QAExB,OAAO,IAAI,CAAC,KAAK,CACf,6BAA6B,EAC7B,IAAI,EACJ,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}

package/dist/resources/organization.d.ts

@@ -1,7 +1,7 @@
 import { BaseResource } from '../resource.js';
 import { type SignaList } from '../pagination.js';
 import type { FetchConfig } from '../_internals/fetch-with-retry.js';
-import type { Identity, Usage, ApiKey, ApiKeyWithRawKey, DeletedResponse, ApiKeyCreateParams, ApiKeyUpdateParams, RequestLog, RequestLogDetail, UsageSummaryParams, UsageSummaryResponse, CreditBalance, LogListParams, RequestOptions } from '../types.js';
+import type { Identity, Usage, ApiKey, ApiKeyWithRawKey, DeletedResponse, ApiKeyCreateParams, ApiKeyUpdateParams, RequestLog, RequestLogDetail, UsageSummaryParams, UsageSummaryResponse, UsageEstimate, UsageEstimateParams, CreditBalance, LogListParams, RequestOptions } from '../types.js';
 declare class ApiKeys extends BaseResource {
     /** Create a new API key. Returns the raw key once. */
     create(body: ApiKeyCreateParams, options?: RequestOptions): Promise<ApiKeyWithRawKey>;
@@ -51,6 +51,13 @@ export declare class Organization extends BaseResource {
      * method on this class, not a namespace.
      */
     usageSummary(params: UsageSummaryParams, options?: RequestOptions): Promise<UsageSummaryResponse>;
+    /**
+     * Price the org's recorded traffic at the published credit schedule, broken
+     * down by action, with the plan that traffic lands on.
+     *
+     * An estimate of past traffic, not a bill. Defaults to the last 30 days.
+     */
+    usageEstimate(params?: UsageEstimateParams, options?: RequestOptions): Promise<UsageEstimate>;
 }
 export {};
 //# sourceMappingURL=organization.d.ts.map

package/dist/resources/organization.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"organization.d.ts","sourceRoot":"","sources":["../../src/resources/organization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,KAAK,EACV,QAAQ,EACR,KAAK,EACL,MAAM,EACN,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,EACb,aAAa,EACb,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,cAAM,OAAQ,SAAQ,YAAY;IAChC,sDAAsD;IAChD,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI3F,2CAA2C;IACrC,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAOhE,2BAA2B;IACrB,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAKrE,yBAAyB;IACnB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAK7F,uCAAuC;IACjC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAK5E,sEAAsE;IAChE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAI9E;AAED,cAAM,IAAK,SAAQ,YAAY;IAC7B;;;;;OAKG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAO5F,mDAAmD;IAC7C,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAQvF;AAED,qBAAa,YAAa,SAAQ,YAAY;IAC5C,0BAA0B;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,0BAA0B;IAC1B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;gBAER,MAAM,EAAE,WAAW;IAM/B,4DAA4D;IACtD,EAAE,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIrD,oDAAoD;IAC9C,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC;IAIrD;;;;OAIG;IACG,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAI/D;;;;;;OAMG;IACG,YAAY,CAChB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC;CAGjC"}
+{"version":3,"file":"organization.d.ts","sourceRoot":"","sources":["../../src/resources/organization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mCAAmC,CAAC;AACrE,OAAO,KAAK,EACV,QAAQ,EACR,KAAK,EACL,MAAM,EACN,gBAAgB,EAChB,eAAe,EACf,kBAAkB,EAClB,kBAAkB,EAClB,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,oBAAoB,EACpB,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,aAAa,EACb,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,cAAM,OAAQ,SAAQ,YAAY;IAChC,sDAAsD;IAChD,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAI3F,2CAA2C;IACrC,IAAI,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAOhE,2BAA2B;IACrB,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAKrE,yBAAyB;IACnB,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,MAAM,CAAC;IAK7F,uCAAuC;IACjC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAK5E,sEAAsE;IAChE,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAI9E;AAED,cAAM,IAAK,SAAQ,YAAY;IAC7B;;;;;OAKG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAO5F,mDAAmD;IAC7C,QAAQ,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,gBAAgB,CAAC;CAQvF;AAED,qBAAa,YAAa,SAAQ,YAAY;IAC5C,0BAA0B;IAC1B,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAC;IAE1B,0BAA0B;IAC1B,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC;gBAER,MAAM,EAAE,WAAW;IAM/B,4DAA4D;IACtD,EAAE,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIrD,oDAAoD;IAC9C,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC;IAIrD;;;;OAIG;IACG,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;IAI/D;;;;;;OAMG;IACG,YAAY,CAChB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC;IAIhC;;;;;OAKG;IACG,aAAa,CACjB,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,aAAa,CAAC;CAG1B"}

package/dist/resources/organization.js

@@ -85,5 +85,14 @@ export class Organization extends BaseResource {
     async usageSummary(params, options) {
         return this._get('/v1/organization/usage/summary', { ...params }, options);
     }
+    /**
+     * Price the org's recorded traffic at the published credit schedule, broken
+     * down by action, with the plan that traffic lands on.
+     *
+     * An estimate of past traffic, not a bill. Defaults to the last 30 days.
+     */
+    async usageEstimate(params, options) {
+        return this._get('/v1/organization/usage/estimate', { ...params }, options);
+    }
 }
 //# sourceMappingURL=organization.js.map

package/dist/resources/organization.js.map

@@ -1 +1 @@
-{"version":3,"file":"organization.js","sourceRoot":"","sources":["../../src/resources/organization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAmB9D,MAAM,OAAQ,SAAQ,YAAY;IAChC,sDAAsD;IACtD,KAAK,CAAC,MAAM,CAAC,IAAwB,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,KAAK,CAAmB,2BAA2B,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED,2CAA2C;IAC3C,KAAK,CAAC,IAAI,CAAC,OAAwB;QACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAS,2BAA2B,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACtG,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,IAAI,CAAC,gBAAgB,CAAS,2BAA2B,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAChF,CAAC;IACJ,CAAC;IAED,2BAA2B;IAC3B,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAwB;QACjD,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAS,6BAA6B,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED,yBAAyB;IACzB,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACzE,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,MAAM,CAAS,6BAA6B,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;IAED,uCAAuC;IACvC,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAwB;QAC/C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,OAAO,CAAkB,6BAA6B,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAwB;QAC/C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,KAAK,CAAmB,6BAA6B,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjH,CAAC;CACF;AAED,MAAM,IAAK,SAAQ,YAAY;IAC7B;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,MAAsB,EAAE,OAAwB;QACzD,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE,CAC1C,IAAI,CAAC,gBAAgB,CAAa,uBAAuB,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC7F,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED,mDAAmD;IACnD,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QACxD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,IAAI,CACd,yBAAyB,kBAAkB,CAAC,SAAS,CAAC,EAAE,EACxD,SAAS,EACT,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,0BAA0B;IACjB,OAAO,CAAU;IAE1B,0BAA0B;IACjB,IAAI,CAAO;IAEpB,YAAY,MAAmB;QAC7B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,EAAE,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAW,qBAAqB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,oDAAoD;IACpD,KAAK,CAAC,KAAK,CAAC,OAAwB;QAClC,OAAO,IAAI,CAAC,IAAI,CAAQ,wBAAwB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,OAAwB;QACpC,OAAO,IAAI,CAAC,IAAI,CAAgB,0BAA0B,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAChB,MAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,IAAI,CAAuB,gCAAgC,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;CACF"}
+{"version":3,"file":"organization.js","sourceRoot":"","sources":["../../src/resources/organization.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAqB9D,MAAM,OAAQ,SAAQ,YAAY;IAChC,sDAAsD;IACtD,KAAK,CAAC,MAAM,CAAC,IAAwB,EAAE,OAAwB;QAC7D,OAAO,IAAI,CAAC,KAAK,CAAmB,2BAA2B,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED,2CAA2C;IAC3C,KAAK,CAAC,IAAI,CAAC,OAAwB;QACjC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAS,2BAA2B,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;QACtG,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,IAAI,CAAC,gBAAgB,CAAS,2BAA2B,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAChF,CAAC;IACJ,CAAC;IAED,2BAA2B;IAC3B,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAwB;QACjD,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAS,6BAA6B,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED,yBAAyB;IACzB,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,IAAwB,EAAE,OAAwB;QACzE,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,MAAM,CAAS,6BAA6B,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;IAED,uCAAuC;IACvC,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAwB;QAC/C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,OAAO,CAAkB,6BAA6B,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IACvG,CAAC;IAED,sEAAsE;IACtE,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAwB;QAC/C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,KAAK,CAAmB,6BAA6B,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACjH,CAAC;CACF;AAED,MAAM,IAAK,SAAQ,YAAY;IAC7B;;;;;OAKG;IACH,KAAK,CAAC,IAAI,CAAC,MAAsB,EAAE,OAAwB;QACzD,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE,CAC1C,IAAI,CAAC,gBAAgB,CAAa,uBAAuB,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC7F,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED,mDAAmD;IACnD,KAAK,CAAC,QAAQ,CAAC,SAAiB,EAAE,OAAwB;QACxD,IAAI,CAAC,WAAW,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;QAC1C,OAAO,IAAI,CAAC,IAAI,CACd,yBAAyB,kBAAkB,CAAC,SAAS,CAAC,EAAE,EACxD,SAAS,EACT,OAAO,CACR,CAAC;IACJ,CAAC;CACF;AAED,MAAM,OAAO,YAAa,SAAQ,YAAY;IAC5C,0BAA0B;IACjB,OAAO,CAAU;IAE1B,0BAA0B;IACjB,IAAI,CAAO;IAEpB,YAAY,MAAmB;QAC7B,KAAK,CAAC,MAAM,CAAC,CAAC;QACd,IAAI,CAAC,OAAO,GAAG,IAAI,OAAO,CAAC,MAAM,CAAC,CAAC;QACnC,IAAI,CAAC,IAAI,GAAG,IAAI,IAAI,CAAC,MAAM,CAAC,CAAC;IAC/B,CAAC;IAED,4DAA4D;IAC5D,KAAK,CAAC,EAAE,CAAC,OAAwB;QAC/B,OAAO,IAAI,CAAC,IAAI,CAAW,qBAAqB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,oDAAoD;IACpD,KAAK,CAAC,KAAK,CAAC,OAAwB;QAClC,OAAO,IAAI,CAAC,IAAI,CAAQ,wBAAwB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,OAAwB;QACpC,OAAO,IAAI,CAAC,IAAI,CAAgB,0BAA0B,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,YAAY,CAChB,MAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,IAAI,CAAuB,gCAAgC,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,aAAa,CACjB,MAA4B,EAC5B,OAAwB;QAExB,OAAO,IAAI,CAAC,IAAI,CAAgB,iCAAiC,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC7F,CAAC;CACF"}

package/dist/resources/portfolios.d.ts

@@ -1,32 +1,58 @@
 import { BaseResource } from '../resource.js';
 import { type SignaList } from '../pagination.js';
-import type { Portfolio, DeletedResponse, PortfolioCreateParams, PortfolioUpdateParams, PortfolioListParams, PortfolioRetrieveParams, PortfolioAddTrademarksBody, PortfolioRemoveTrademarksBody, PortfolioDeadlineParams, PortfolioDeadlinesIcalParams, RequestOptions } from '../types.js';
+import type { Portfolio, PortfolioResponse, PortfolioDetail, PortfolioMarksAddResult, PortfolioMarksRemoveResult, DeletedResponse, PortfolioCreateParams, PortfolioUpdateParams, PortfolioListParams, PortfolioRetrieveParams, PortfolioAddTrademarksBody, PortfolioRemoveTrademarksBody, PortfolioDeadlineParams, PortfolioDeadlinesIcalParams, RequestOptions } from '../types.js';
 export declare class Portfolios extends BaseResource {
     /** Create a portfolio. */
-    create(body: PortfolioCreateParams, options?: RequestOptions): Promise<Portfolio>;
+    create(body: PortfolioCreateParams, options?: RequestOptions): Promise<PortfolioResponse>;
     /** List organization's portfolios. */
     list(params?: PortfolioListParams, options?: RequestOptions): Promise<SignaList<Portfolio>>;
-    /** Retrieve a portfolio with embedded marks. */
-    retrieve(id: string, params?: PortfolioRetrieveParams, options?: RequestOptions): Promise<Portfolio>;
+    /**
+     * Retrieve a portfolio with its embedded membership page.
+     *
+     * Pass `external_ref` to return only the membership carrying that docketing
+     * reference (at most one row), or `limit: 0` to skip the marks entirely.
+     */
+    retrieve(id: string, params?: PortfolioRetrieveParams, options?: RequestOptions): Promise<PortfolioDetail>;
     /** Update a portfolio (merge semantics for metadata). */
-    update(id: string, body: PortfolioUpdateParams, options?: RequestOptions): Promise<Portfolio>;
+    update(id: string, body: PortfolioUpdateParams, options?: RequestOptions): Promise<PortfolioResponse>;
     /** Delete a portfolio (cascades marks). */
     delete(id: string, options?: RequestOptions): Promise<DeletedResponse>;
-    /** Add trademarks to a portfolio (idempotent). */
-    addTrademarks(id: string, body: PortfolioAddTrademarksBody, options?: RequestOptions): Promise<{
-        object: string;
-        added: number;
-        already_in_portfolio: number;
-        not_found: number;
-    }>;
-    /** Remove trademarks from a portfolio. */
-    removeTrademarks(id: string, body: PortfolioRemoveTrademarksBody, options?: RequestOptions): Promise<{
-        object: string;
-        removed: number;
-    }>;
-    /** List computed deadlines for portfolio marks. */
-    deadlines(id: string, params: PortfolioDeadlineParams, options?: RequestOptions): Promise<SignaList<unknown>>;
-    /** Get an iCal calendar feed of portfolio deadlines. */
+    /**
+     * Add trademarks to a portfolio (idempotent per distinct input mark).
+     *
+     * Supply exactly one of `trademark_ids` (plain ids, LENIENT on duplicates)
+     * or `items` (ids plus optional `external_ref`, STRICT on duplicates) — see
+     * {@link PortfolioAddTrademarksBody}. Passing both is a compile error and a
+     * `400` at the API.
+     *
+     * Up to 100 entries per request. Any `409` — {@link isExternalRefConflict}
+     * or the managed-marks {@link isResourceQuotaExceeded} cap — rolls the whole
+     * batch back; unknown ids are lenient and counted under `not_found`.
+     */
+    addTrademarks(id: string, body: PortfolioAddTrademarksBody, options?: RequestOptions): Promise<PortfolioMarksAddResult>;
+    /**
+     * Remove trademarks from a portfolio, by id or by your own reference.
+     *
+     * Supply exactly one of `trademark_ids` or `external_refs` (up to 100) — see
+     * {@link PortfolioRemoveTrademarksBody}. Entries that match no membership
+     * are simply skipped.
+     */
+    removeTrademarks(id: string, body: PortfolioRemoveTrademarksBody, options?: RequestOptions): Promise<PortfolioMarksRemoveResult>;
+    /**
+     * List computed deadlines for portfolio marks.
+     *
+     * `due_before` is optional — omit `params` entirely to take the API's own
+     * horizon of 24 months from now.
+     */
+    deadlines(id: string, params?: PortfolioDeadlineParams, options?: RequestOptions): Promise<SignaList<unknown>>;
+    /**
+     * Download the portfolio's deadlines as an iCal (RFC 5545) calendar file.
+     *
+     * An authenticated ONE-TIME download, not a subscribable calendar URL: the
+     * endpoint requires the same bearer token as every other call and responds
+     * with `Content-Disposition: attachment`, so the returned string is a
+     * snapshot. Re-call it to refresh.
+     */
     deadlinesIcal(id: string, params?: PortfolioDeadlinesIcalParams, options?: RequestOptions): Promise<string>;
 }
 //# sourceMappingURL=portfolios.d.ts.map

package/dist/resources/portfolios.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"portfolios.d.ts","sourceRoot":"","sources":["../../src/resources/portfolios.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,SAAS,EACT,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,uBAAuB,EACvB,0BAA0B,EAC1B,6BAA6B,EAC7B,uBAAuB,EACvB,4BAA4B,EAC5B,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,UAAW,SAAQ,YAAY;IAC1C,0BAA0B;IACpB,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC;IAIvF,sCAAsC;IAChC,IAAI,CAAC,MAAM,CAAC,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAQjG,gDAAgD;IAC1C,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;IASrB,yDAAyD;IACnD,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;IAKrB,2CAA2C;IACrC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAK5E,kDAAkD;IAC5C,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAC;QAAC,oBAAoB,EAAE,MAAM,CAAC;QAAC,SAAS,EAAE,MAAM,CAAA;KAAE,CAAC;IAK9F,0CAA0C;IACpC,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,OAAO,EAAE,MAAM,CAAA;KAAE,CAAC;IAK/C,mDAAmD;IAC7C,SAAS,CACb,EAAE,EAAE,MAAM,EACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAa9B,wDAAwD;IAClD,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,4BAA4B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;CAQnB"}
+{"version":3,"file":"portfolios.d.ts","sourceRoot":"","sources":["../../src/resources/portfolios.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,SAAS,EACT,iBAAiB,EACjB,eAAe,EACf,uBAAuB,EACvB,0BAA0B,EAC1B,eAAe,EACf,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,uBAAuB,EACvB,0BAA0B,EAC1B,6BAA6B,EAC7B,uBAAuB,EACvB,4BAA4B,EAC5B,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,UAAW,SAAQ,YAAY;IAC1C,0BAA0B;IACpB,MAAM,CAAC,IAAI,EAAE,qBAAqB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAI/F,sCAAsC;IAChC,IAAI,CAAC,MAAM,CAAC,EAAE,mBAAmB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAQjG;;;;;OAKG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC;IAS3B,yDAAyD;IACnD,MAAM,CACV,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,iBAAiB,CAAC;IAK7B,2CAA2C;IACrC,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAK5E;;;;;;;;;;;OAWG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,0BAA0B,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,uBAAuB,CAAC;IASnC;;;;;;OAMG;IACG,gBAAgB,CACpB,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,6BAA6B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,0BAA0B,CAAC;IAStC;;;;;OAKG;IACG,SAAS,CACb,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAa9B;;;;;;;OAOG;IACG,aAAa,CACjB,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,4BAA4B,EACrC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;CAQnB"}

package/dist/resources/portfolios.js

@@ -13,7 +13,12 @@ export class Portfolios extends BaseResource {
         const firstPage = await fetchPage(params?.cursor);
         return createList(firstPage, fetchPage);
     }
-    /** Retrieve a portfolio with embedded marks. */
+    /**
+     * Retrieve a portfolio with its embedded membership page.
+     *
+     * Pass `external_ref` to return only the membership carrying that docketing
+     * reference (at most one row), or `limit: 0` to skip the marks entirely.
+     */
     async retrieve(id, params, options) {
         this._validateId(id);
         return this._get(`/v1/portfolios/${encodeURIComponent(id)}`, params, options);
@@ -28,17 +33,39 @@ export class Portfolios extends BaseResource {
         this._validateId(id);
         return this._delete(`/v1/portfolios/${encodeURIComponent(id)}`, options);
     }
-    /** Add trademarks to a portfolio (idempotent). */
+    /**
+     * Add trademarks to a portfolio (idempotent per distinct input mark).
+     *
+     * Supply exactly one of `trademark_ids` (plain ids, LENIENT on duplicates)
+     * or `items` (ids plus optional `external_ref`, STRICT on duplicates) — see
+     * {@link PortfolioAddTrademarksBody}. Passing both is a compile error and a
+     * `400` at the API.
+     *
+     * Up to 100 entries per request. Any `409` — {@link isExternalRefConflict}
+     * or the managed-marks {@link isResourceQuotaExceeded} cap — rolls the whole
+     * batch back; unknown ids are lenient and counted under `not_found`.
+     */
     async addTrademarks(id, body, options) {
         this._validateId(id);
         return this._post(`/v1/portfolios/${encodeURIComponent(id)}/trademarks`, body, options);
     }
-    /** Remove trademarks from a portfolio. */
+    /**
+     * Remove trademarks from a portfolio, by id or by your own reference.
+     *
+     * Supply exactly one of `trademark_ids` or `external_refs` (up to 100) — see
+     * {@link PortfolioRemoveTrademarksBody}. Entries that match no membership
+     * are simply skipped.
+     */
     async removeTrademarks(id, body, options) {
         this._validateId(id);
         return this._post(`/v1/portfolios/${encodeURIComponent(id)}/trademarks/remove`, body, options);
     }
-    /** List computed deadlines for portfolio marks. */
+    /**
+     * List computed deadlines for portfolio marks.
+     *
+     * `due_before` is optional — omit `params` entirely to take the API's own
+     * horizon of 24 months from now.
+     */
     async deadlines(id, params, options) {
         this._validateId(id);
         const fetchPage = async (cursor) => {
@@ -47,7 +74,14 @@ export class Portfolios extends BaseResource {
         const firstPage = await fetchPage(params?.cursor);
         return createList(firstPage, fetchPage);
     }
-    /** Get an iCal calendar feed of portfolio deadlines. */
+    /**
+     * Download the portfolio's deadlines as an iCal (RFC 5545) calendar file.
+     *
+     * An authenticated ONE-TIME download, not a subscribable calendar URL: the
+     * endpoint requires the same bearer token as every other call and responds
+     * with `Content-Disposition: attachment`, so the returned string is a
+     * snapshot. Re-call it to refresh.
+     */
     async deadlinesIcal(id, params, options) {
         this._validateId(id);
         return this._getRaw(`/v1/portfolios/${encodeURIComponent(id)}/deadlines.ics`, params, options);

package/dist/resources/portfolios.js.map

@@ -1 +1 @@
-{"version":3,"file":"portfolios.js","sourceRoot":"","sources":["../../src/resources/portfolios.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAe9D,MAAM,OAAO,UAAW,SAAQ,YAAY;IAC1C,0BAA0B;IAC1B,KAAK,CAAC,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,KAAK,CAAY,gBAAgB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAChE,CAAC;IAED,sCAAsC;IACtC,KAAK,CAAC,IAAI,CAAC,MAA4B,EAAE,OAAwB;QAC/D,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAY,gBAAgB,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC5F,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED,gDAAgD;IAChD,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CACd,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC1C,MAAiC,EACjC,OAAO,CACR,CAAC;IACJ,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAA2B,EAC3B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,MAAM,CAAY,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC3F,CAAC;IAED,2CAA2C;IAC3C,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAwB;QAC/C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,OAAO,CAAkB,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED,kDAAkD;IAClD,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,IAAgC,EAChC,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,aAAa,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC1F,CAAC;IAED,0CAA0C;IAC1C,KAAK,CAAC,gBAAgB,CACpB,EAAU,EACV,IAAmC,EACnC,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,KAAK,CAAC,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,oBAAoB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACjG,CAAC;IAED,mDAAmD;IACnD,KAAK,CAAC,SAAS,CACb,EAAU,EACV,MAA+B,EAC/B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAC1B,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,YAAY,EACpD,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EACrB,OAAO,CACR,CAAC;QACJ,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED,wDAAwD;IACxD,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,MAAqC,EACrC,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,OAAO,CACjB,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,gBAAgB,EACxD,MAAiC,EACjC,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"portfolios.js","sourceRoot":"","sources":["../../src/resources/portfolios.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAmB9D,MAAM,OAAO,UAAW,SAAQ,YAAY;IAC1C,0BAA0B;IAC1B,KAAK,CAAC,MAAM,CAAC,IAA2B,EAAE,OAAwB;QAChE,OAAO,IAAI,CAAC,KAAK,CAAoB,gBAAgB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACxE,CAAC;IAED,sCAAsC;IACtC,KAAK,CAAC,IAAI,CAAC,MAA4B,EAAE,OAAwB;QAC/D,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAY,gBAAgB,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC5F,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CACd,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAC1C,MAAiC,EACjC,OAAO,CACR,CAAC;IACJ,CAAC;IAED,yDAAyD;IACzD,KAAK,CAAC,MAAM,CACV,EAAU,EACV,IAA2B,EAC3B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,MAAM,CAAoB,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACnG,CAAC;IAED,2CAA2C;IAC3C,KAAK,CAAC,MAAM,CAAC,EAAU,EAAE,OAAwB;QAC/C,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,OAAO,CAAkB,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,IAAgC,EAChC,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,KAAK,CACf,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,aAAa,EACrD,IAAI,EACJ,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,gBAAgB,CACpB,EAAU,EACV,IAAmC,EACnC,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,KAAK,CACf,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,oBAAoB,EAC5D,IAAI,EACJ,OAAO,CACR,CAAC;IACJ,CAAC;IAED;;;;;OAKG;IACH,KAAK,CAAC,SAAS,CACb,EAAU,EACV,MAAgC,EAChC,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAC1B,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,YAAY,EACpD,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EACrB,OAAO,CACR,CAAC;QACJ,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,aAAa,CACjB,EAAU,EACV,MAAqC,EACrC,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,OAAO,CACjB,kBAAkB,kBAAkB,CAAC,EAAE,CAAC,gBAAgB,EACxD,MAAiC,EACjC,OAAO,CACR,CAAC;IACJ,CAAC;CACF"}

package/dist/resources/reconcile.d.ts

@@ -5,7 +5,8 @@ export declare class Reconcile extends BaseResource {
     /**
      * Compare your trademark record fields against Signa's register data.
      *
-     * Scope: `trademarks:read`. Billed as 1 unit per item.
+     * Scope: `trademarks:read`. Billed as 1 unit per item — `verdict_detail`
+     * does not change billing.
      *
      * ```typescript
      * const results = await signa.reconcile.run({
@@ -15,6 +16,25 @@ export declare class Reconcile extends BaseResource {
      *     your_fields: { status: 'active' },
      *   }],
      * });
+     *
+     * // Docket audit: opt in to three-source per-field verdicts (your value
+     * // vs the register vs the rulebook-computed schedule).
+     * const audit = await signa.reconcile.run({
+     *   verdict_detail: true,
+     *   items: [{
+     *     office: 'US',
+     *     application_number: '88123456',
+     *     your_fields: {
+     *       renewal_due_date: '2030-03-10',
+     *       docketed_deadlines: [{ type: 'renewal', date: '2030-03-10' }],
+     *     },
+     *   }],
+     * });
+     * for (const item of audit.data) {
+     *   for (const verdict of item.field_verdicts ?? []) {
+     *     console.log(verdict.field, verdict.verdict, verdict.computed_value);
+     *   }
+     * }
      * ```
      */
     run(body: ReconcileParams, options?: RequestOptions): Promise<SignaList<Reconciliation>>;

package/dist/resources/reconcile.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"reconcile.d.ts","sourceRoot":"","sources":["../../src/resources/reconcile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EAEf,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;;;;;OAcG;IACG,GAAG,CACP,IAAI,EAAE,eAAe,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;CAUtC"}
+{"version":3,"file":"reconcile.d.ts","sourceRoot":"","sources":["../../src/resources/reconcile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,cAAc,EACd,eAAe,EAEf,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,GAAG,CACP,IAAI,EAAE,eAAe,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;CAUtC"}

package/dist/resources/reconcile.js

@@ -4,7 +4,8 @@ export class Reconcile extends BaseResource {
     /**
      * Compare your trademark record fields against Signa's register data.
      *
-     * Scope: `trademarks:read`. Billed as 1 unit per item.
+     * Scope: `trademarks:read`. Billed as 1 unit per item — `verdict_detail`
+     * does not change billing.
      *
      * ```typescript
      * const results = await signa.reconcile.run({
@@ -14,6 +15,25 @@ export class Reconcile extends BaseResource {
      *     your_fields: { status: 'active' },
      *   }],
      * });
+     *
+     * // Docket audit: opt in to three-source per-field verdicts (your value
+     * // vs the register vs the rulebook-computed schedule).
+     * const audit = await signa.reconcile.run({
+     *   verdict_detail: true,
+     *   items: [{
+     *     office: 'US',
+     *     application_number: '88123456',
+     *     your_fields: {
+     *       renewal_due_date: '2030-03-10',
+     *       docketed_deadlines: [{ type: 'renewal', date: '2030-03-10' }],
+     *     },
+     *   }],
+     * });
+     * for (const item of audit.data) {
+     *   for (const verdict of item.field_verdicts ?? []) {
+     *     console.log(verdict.field, verdict.verdict, verdict.computed_value);
+     *   }
+     * }
      * ```
      */
     async run(body, options) {

package/dist/resources/reconcile.js.map

@@ -1 +1 @@
-{"version":3,"file":"reconcile.js","sourceRoot":"","sources":["../../src/resources/reconcile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAQ9D,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;;;;;OAcG;IACH,KAAK,CAAC,GAAG,CACP,IAAqB,EACrB,OAAwB;QAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAC/B,eAAe,EACf,IAAI,EACJ,OAAO,CACR,CAAC;QACF,OAAO,UAAU,CAAC,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CACvD,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAC5D,CAAC;IACJ,CAAC;CACF"}
+{"version":3,"file":"reconcile.js","sourceRoot":"","sources":["../../src/resources/reconcile.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAQ9D,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACH,KAAK,CAAC,GAAG,CACP,IAAqB,EACrB,OAAwB;QAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAC/B,eAAe,EACf,IAAI,EACJ,OAAO,CACR,CAAC;QACF,OAAO,UAAU,CAAC,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CACvD,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAC5D,CAAC;IACJ,CAAC;CACF"}

package/dist/resources/references.d.ts

@@ -1,6 +1,6 @@
 import { BaseResource } from '../resource.js';
 import { type SignaList } from '../pagination.js';
-import type { Classification, ClassificationDetail, ClassificationSuggestParams, ClassificationSuggestResult, Office, OfficeDetail, OfficeVote, OfficeVoteDeleted, CastOfficeVotesParams, Jurisdiction, JurisdictionDetail, DeadlineRule, OppositionRule, EventType, DesignCode, DesignCodeDetail, DesignCodeListParams, ClassificationListParams, RequestOptions } from '../types.js';
+import type { Classification, ClassificationDetail, ClassificationSuggestParams, ClassificationSuggestResult, Office, OfficeDetail, OfficeVote, OfficeVoteDeleted, CastOfficeVotesParams, Jurisdiction, JurisdictionDetail, DeadlineRule, OppositionRule, EventType, StatusCode, StatusCodeListParams, EventTypeListParams, DesignCode, DesignCodeDetail, DesignCodeListParams, ClassificationListParams, RequestOptions } from '../types.js';
 /** Filters accepted by {@link References#deadlineRules}. */
 export interface DeadlineRulesListParams {
     /** Filter by jurisdiction code (uppercase ISO-2 + WIPO). Single value or array. */
@@ -66,15 +66,13 @@ export declare class References extends BaseResource {
      */
     offices(options?: RequestOptions): Promise<SignaList<Office>>;
     /**
-     * Retrieve a single office, optionally with status mappings.
+     * Retrieve a single office.
      *
      * ```typescript
      * const office = await signa.references.office('US');
      * ```
      */
-    office(code: string, params?: {
-        include?: Array<'status_mappings'>;
-    }, options?: RequestOptions): Promise<OfficeDetail>;
+    office(code: string, options?: RequestOptions): Promise<OfficeDetail>;
     /**
      * List your organization's office-coverage votes, alphabetical by office
      * code. The votable vocabulary is bounded, so the list is always a single
@@ -101,7 +99,7 @@ export declare class References extends BaseResource {
      * rejected with `no_trademark_register`.
      *
      * ```typescript
-     * const votes = await signa.references.castOfficeVotes({ office_codes: ['BR', 'MX'] });
+     * const votes = await signa.references.castOfficeVotes({ office_codes: ['CL', 'MX'] });
      * ```
      */
     castOfficeVotes(body: CastOfficeVotesParams, options?: RequestOptions): Promise<SignaList<OfficeVote>>;
@@ -161,13 +159,27 @@ export declare class References extends BaseResource {
      */
     oppositionRules(params?: OppositionRulesListParams, options?: RequestOptions): Promise<SignaList<OppositionRule>>;
     /**
-     * List all event type codes used in trademark history.
+     * List event type codes used in trademark history (`GET /v1/event-types`):
+     * each office code with its verbatim label and the canonical event type
+     * Signa maps it to. Auto-paginates.
      *
      * ```typescript
-     * const eventTypes = await signa.references.eventTypes();
+     * const types = await signa.references.eventTypes({ office_code: 'US' });
+     * for await (const t of types) console.log(t.raw.code, t.event_type);
      * ```
      */
-    eventTypes(options?: RequestOptions): Promise<SignaList<EventType>>;
+    eventTypes(params?: EventTypeListParams, options?: RequestOptions): Promise<SignaList<EventType>>;
+    /**
+     * List office status codes (`GET /v1/status-codes`): each office code with
+     * its verbatim label and the normalised status Signa maps it to. Decode a
+     * trademark's `status.raw.code` with it. Auto-paginates.
+     *
+     * ```typescript
+     * const codes = await signa.references.statusCodes({ office_code: 'US' });
+     * for await (const code of codes) console.log(code.raw?.code, code.stage);
+     * ```
+     */
+    statusCodes(params?: StatusCodeListParams, options?: RequestOptions): Promise<SignaList<StatusCode>>;
     /**
      * List Vienna classification design codes.
      *

package/dist/resources/references.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"references.d.ts","sourceRoot":"","sources":["../../src/resources/references.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACpB,2BAA2B,EAC3B,2BAA2B,EAC3B,MAAM,EACN,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,wBAAwB,EAExB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,4DAA4D;AAC5D,MAAM,WAAW,uBAAuB;IACtC,mFAAmF;IACnF,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACjC;;;OAGG;IACH,YAAY,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,CAAC,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAC,CAAC;CAC/F;AAED,8DAA8D;AAC9D,MAAM,WAAW,yBAAyB;IACxC,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACjC,uEAAuE;IACvE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,uDAAuD;IACvD,YAAY,CAAC,EACT,UAAU,GACV,oBAAoB,GACpB,KAAK,CAAC,UAAU,GAAG,oBAAoB,CAAC,CAAC;IAC7C,+BAA+B;IAC/B,aAAa,CAAC,EACV,yBAAyB,GACzB,0BAA0B,GAC1B,uCAAuC,GACvC,KAAK,CACD,yBAAyB,GACzB,0BAA0B,GAC1B,uCAAuC,CAC1C,CAAC;CACP;AAED,qBAAa,UAAW,SAAQ,YAAY;IAC1C;;;;;;;OAOG;IACG,eAAe,CACnB,MAAM,CAAC,EAAE,wBAAwB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAWrC;;;;;;OAMG;IACG,cAAc,CAClB,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC;IAQhC;;;;;;;;;;;;;;;OAeG;IACG,sBAAsB,CAC1B,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,2BAA2B,CAAC;IAQvC;;;;;;OAMG;IACG,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAOnE;;;;;;OAMG;IACG,MAAM,CACV,IAAI,EAAE,MAAM,EACZ,MAAM,CAAC,EAAE;QAAE,OAAO,CAAC,EAAE,KAAK,CAAC,iBAAiB,CAAC,CAAA;KAAE,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC;IAMxB;;;;;;;;;OASG;IACG,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAW3E;;;;;;;;;;;;;;;;;OAiBG;IACG,eAAe,CACnB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAWjC;;;;;;;;;;;OAWG;IACG,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQ3F;;;;;;OAMG;IACG,aAAa,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAW/E;;;;;;OAMG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAQvF;;;;;;;;;;;;OAYG;IACG,aAAa,CACjB,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAWnC;;;;;;;;;;OAUG;IACG,eAAe,CACnB,MAAM,CAAC,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAWrC;;;;;;OAMG;IACG,UAAU,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAWzE;;;;;;OAMG;IACG,WAAW,CACf,MAAM,CAAC,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAejC;;;;;;OAMG;IACG,UAAU,CACd,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;CAO7B"}
+{"version":3,"file":"references.d.ts","sourceRoot":"","sources":["../../src/resources/references.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,cAAc,EACd,oBAAoB,EACpB,2BAA2B,EAC3B,2BAA2B,EAC3B,MAAM,EACN,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,SAAS,EACT,UAAU,EACV,oBAAoB,EACpB,mBAAmB,EACnB,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,wBAAwB,EAExB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,4DAA4D;AAC5D,MAAM,WAAW,uBAAuB;IACtC,mFAAmF;IACnF,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACjC;;;OAGG;IACH,YAAY,CAAC,EAAE,UAAU,GAAG,UAAU,GAAG,QAAQ,GAAG,KAAK,CAAC,UAAU,GAAG,UAAU,GAAG,QAAQ,CAAC,CAAC;CAC/F;AAED,8DAA8D;AAC9D,MAAM,WAAW,yBAAyB;IACxC,qDAAqD;IACrD,YAAY,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACjC,uEAAuE;IACvE,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IAC3B,uDAAuD;IACvD,YAAY,CAAC,EACT,UAAU,GACV,oBAAoB,GACpB,KAAK,CAAC,UAAU,GAAG,oBAAoB,CAAC,CAAC;IAC7C,+BAA+B;IAC/B,aAAa,CAAC,EACV,yBAAyB,GACzB,0BAA0B,GAC1B,uCAAuC,GACvC,KAAK,CACD,yBAAyB,GACzB,0BAA0B,GAC1B,uCAAuC,CAC1C,CAAC;CACP;AAED,qBAAa,UAAW,SAAQ,YAAY;IAC1C;;;;;;;OAOG;IACG,eAAe,CACnB,MAAM,CAAC,EAAE,wBAAwB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAWrC;;;;;;OAMG;IACG,cAAc,CAClB,WAAW,EAAE,MAAM,EACnB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,oBAAoB,CAAC;IAQhC;;;;;;;;;;;;;;;OAeG;IACG,sBAAsB,CAC1B,IAAI,EAAE,2BAA2B,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,2BAA2B,CAAC;IAQvC;;;;;;OAMG;IACG,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAOnE;;;;;;OAMG;IACG,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAI3E;;;;;;;;;OASG;IACG,WAAW,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAW3E;;;;;;;;;;;;;;;;;OAiBG;IACG,eAAe,CACnB,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAWjC;;;;;;;;;;;OAWG;IACG,iBAAiB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAQ3F;;;;;;OAMG;IACG,aAAa,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAW/E;;;;;;OAMG;IACG,YAAY,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,kBAAkB,CAAC;IAQvF;;;;;;;;;;;;OAYG;IACG,aAAa,CACjB,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAWnC;;;;;;;;;;OAUG;IACG,eAAe,CACnB,MAAM,CAAC,EAAE,yBAAyB,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAWrC;;;;;;;;;OASG;IACG,UAAU,CACd,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAMhC;;;;;;;;;OASG;IACG,WAAW,CACf,MAAM,CAAC,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAMjC;;;;;;OAMG;IACG,WAAW,CACf,MAAM,CAAC,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;IAejC;;;;;;OAMG;IACG,UAAU,CACd,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;CAO7B"}

package/dist/resources/references.js

@@ -54,16 +54,14 @@ export class References extends BaseResource {
         return createList({ ...response, has_more: false }, () => Promise.resolve({ ...response, data: [], has_more: false }));
     }
     /**
-     * Retrieve a single office, optionally with status mappings.
+     * Retrieve a single office.
      *
      * ```typescript
      * const office = await signa.references.office('US');
      * ```
      */
-    async office(code, params, options) {
-        return this._get(`/v1/offices/${encodeURIComponent(code)}`, {
-            include: params?.include,
-        }, options);
+    async office(code, options) {
+        return this._get(`/v1/offices/${encodeURIComponent(code)}`, undefined, options);
     }
     /**
      * List your organization's office-coverage votes, alphabetical by office
@@ -94,7 +92,7 @@ export class References extends BaseResource {
      * rejected with `no_trademark_register`.
      *
      * ```typescript
-     * const votes = await signa.references.castOfficeVotes({ office_codes: ['BR', 'MX'] });
+     * const votes = await signa.references.castOfficeVotes({ office_codes: ['CL', 'MX'] });
      * ```
      */
     async castOfficeVotes(body, options) {
@@ -171,15 +169,32 @@ export class References extends BaseResource {
         return createList({ ...response, has_more: false }, () => Promise.resolve({ ...response, data: [], has_more: false }));
     }
     /**
-     * List all event type codes used in trademark history.
+     * List event type codes used in trademark history (`GET /v1/event-types`):
+     * each office code with its verbatim label and the canonical event type
+     * Signa maps it to. Auto-paginates.
      *
      * ```typescript
-     * const eventTypes = await signa.references.eventTypes();
+     * const types = await signa.references.eventTypes({ office_code: 'US' });
+     * for await (const t of types) console.log(t.raw.code, t.event_type);
      * ```
      */
-    async eventTypes(options) {
-        const response = await this._getListResponse('/v1/event-types', undefined, options);
-        return createList({ ...response, has_more: false }, () => Promise.resolve({ ...response, data: [], has_more: false }));
+    async eventTypes(params, options) {
+        const fetchPage = (cursor) => this._getListResponse('/v1/event-types', { ...params, cursor }, options);
+        return createList(await fetchPage(params?.cursor), fetchPage);
+    }
+    /**
+     * List office status codes (`GET /v1/status-codes`): each office code with
+     * its verbatim label and the normalised status Signa maps it to. Decode a
+     * trademark's `status.raw.code` with it. Auto-paginates.
+     *
+     * ```typescript
+     * const codes = await signa.references.statusCodes({ office_code: 'US' });
+     * for await (const code of codes) console.log(code.raw?.code, code.stage);
+     * ```
+     */
+    async statusCodes(params, options) {
+        const fetchPage = (cursor) => this._getListResponse('/v1/status-codes', { ...params, cursor }, options);
+        return createList(await fetchPage(params?.cursor), fetchPage);
     }
     /**
      * List Vienna classification design codes.