@signa-so/sdk 0.8.0 → 0.14.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (85) hide show
  1. package/README.md +2 -7
  2. package/dist/client.d.ts +11 -8
  3. package/dist/client.d.ts.map +1 -1
  4. package/dist/client.js +14 -10
  5. package/dist/client.js.map +1 -1
  6. package/dist/errors.d.ts +54 -1
  7. package/dist/errors.d.ts.map +1 -1
  8. package/dist/errors.js +80 -3
  9. package/dist/errors.js.map +1 -1
  10. package/dist/generated/api-types.d.ts +13861 -6608
  11. package/dist/generated/api-types.d.ts.map +1 -1
  12. package/dist/index.d.ts +2 -2
  13. package/dist/index.d.ts.map +1 -1
  14. package/dist/index.js +1 -1
  15. package/dist/index.js.map +1 -1
  16. package/dist/pagination.d.ts +23 -2
  17. package/dist/pagination.d.ts.map +1 -1
  18. package/dist/pagination.js +45 -4
  19. package/dist/pagination.js.map +1 -1
  20. package/dist/resources/citations.d.ts +33 -0
  21. package/dist/resources/citations.d.ts.map +1 -0
  22. package/dist/resources/citations.js +38 -0
  23. package/dist/resources/citations.js.map +1 -0
  24. package/dist/resources/credits.d.ts +7 -0
  25. package/dist/resources/credits.d.ts.map +1 -0
  26. package/dist/resources/credits.js +8 -0
  27. package/dist/resources/credits.js.map +1 -0
  28. package/dist/resources/deadlines.d.ts +38 -4
  29. package/dist/resources/deadlines.d.ts.map +1 -1
  30. package/dist/resources/deadlines.js +39 -2
  31. package/dist/resources/deadlines.js.map +1 -1
  32. package/dist/resources/entities.d.ts +6 -7
  33. package/dist/resources/entities.d.ts.map +1 -1
  34. package/dist/resources/entities.js +6 -7
  35. package/dist/resources/entities.js.map +1 -1
  36. package/dist/resources/events.d.ts.map +1 -1
  37. package/dist/resources/events.js +4 -1
  38. package/dist/resources/events.js.map +1 -1
  39. package/dist/resources/fees.d.ts +10 -0
  40. package/dist/resources/fees.d.ts.map +1 -0
  41. package/dist/resources/fees.js +14 -0
  42. package/dist/resources/fees.js.map +1 -0
  43. package/dist/resources/goods-services.d.ts +36 -2
  44. package/dist/resources/goods-services.d.ts.map +1 -1
  45. package/dist/resources/goods-services.js +37 -1
  46. package/dist/resources/goods-services.js.map +1 -1
  47. package/dist/resources/organization.d.ts +8 -1
  48. package/dist/resources/organization.d.ts.map +1 -1
  49. package/dist/resources/organization.js +9 -0
  50. package/dist/resources/organization.js.map +1 -1
  51. package/dist/resources/portfolios.d.ts +46 -20
  52. package/dist/resources/portfolios.d.ts.map +1 -1
  53. package/dist/resources/portfolios.js +39 -5
  54. package/dist/resources/portfolios.js.map +1 -1
  55. package/dist/resources/reconcile.d.ts +21 -1
  56. package/dist/resources/reconcile.d.ts.map +1 -1
  57. package/dist/resources/reconcile.js +21 -1
  58. package/dist/resources/reconcile.js.map +1 -1
  59. package/dist/resources/references.d.ts +63 -8
  60. package/dist/resources/references.d.ts.map +1 -1
  61. package/dist/resources/references.js +77 -10
  62. package/dist/resources/references.js.map +1 -1
  63. package/dist/resources/trademarks.d.ts +42 -4
  64. package/dist/resources/trademarks.d.ts.map +1 -1
  65. package/dist/resources/trademarks.js +284 -3
  66. package/dist/resources/trademarks.js.map +1 -1
  67. package/dist/resources/watches.d.ts +3 -7
  68. package/dist/resources/watches.d.ts.map +1 -1
  69. package/dist/resources/watches.js +2 -16
  70. package/dist/resources/watches.js.map +1 -1
  71. package/dist/types.d.ts +1202 -573
  72. package/dist/types.d.ts.map +1 -1
  73. package/dist/version.d.ts +1 -1
  74. package/dist/version.d.ts.map +1 -1
  75. package/dist/version.js +1 -1
  76. package/dist/version.js.map +1 -1
  77. package/package.json +3 -3
  78. package/dist/resources/saved-searches.d.ts +0 -22
  79. package/dist/resources/saved-searches.d.ts.map +0 -1
  80. package/dist/resources/saved-searches.js +0 -39
  81. package/dist/resources/saved-searches.js.map +0 -1
  82. package/dist/resources/suggest.d.ts +0 -16
  83. package/dist/resources/suggest.d.ts.map +0 -1
  84. package/dist/resources/suggest.js +0 -18
  85. package/dist/resources/suggest.js.map +0 -1
@@ -1,6 +1,6 @@
1
1
  import { BaseResource } from '../resource.js';
2
2
  import { type SignaList } from '../pagination.js';
3
- import type { GoodsServicesTerm, GoodsServicesListParams, GoodsServicesSuggestParams, GoodsServicesSuggestResult, RequestOptions } from '../types.js';
3
+ import type { GoodsServicesTerm, GoodsServicesListParams, GoodsServicesSuggestParams, GoodsServicesSuggestResult, GoodsServicesValidateParams, GoodsServicesValidationResponse, RequestOptions } from '../types.js';
4
4
  /**
5
5
  * Goods & services — the pre-approved-terms catalog (Harmonised Database +
6
6
  * USPTO ID Manual) and the AI-assisted G&S specification drafter.
@@ -10,10 +10,14 @@ import type { GoodsServicesTerm, GoodsServicesListParams, GoodsServicesSuggestPa
10
10
  * - {@link GoodsServices.suggest} — draft a filing-ready goods/services
11
11
  * specification from a natural-language description. Pass `class_number`
12
12
  * to scope the output to a single, already-chosen class.
13
+ * - {@link GoodsServices.validate} — report whether submitted wording appears
14
+ * in each requested office's pre-approved catalog, with descriptive wording
15
+ * coverage, drafting candidates, inferred-class suggestions, cited warnings,
16
+ * catalog freshness, and candidate-search completeness.
13
17
  */
14
18
  export declare class GoodsServices extends BaseResource {
15
19
  /**
16
- * Browse/search accepted goods & services terms. At least one of `q` or
20
+ * Browse/search pre-approved goods & services terms. At least one of `q` or
17
21
  * `class` must be provided.
18
22
  *
19
23
  * Scope: `trademarks:read`. Not billed (reference data).
@@ -52,5 +56,35 @@ export declare class GoodsServices extends BaseResource {
52
56
  * ```
53
57
  */
54
58
  suggest(body: GoodsServicesSuggestParams, options?: RequestOptions): Promise<GoodsServicesSuggestResult>;
59
+ /**
60
+ * Check submitted wording against the pre-approved catalogs we hold.
61
+ * `listed` means the wording appears in that office's catalog;
62
+ * `not_listed` is an absence of evidence, not a refusal.
63
+ *
64
+ * Only US, EM, JP, KR, and CN have catalog answers. Other recognized offices
65
+ * return `unsupported_office` with reason `no_catalog_data`.
66
+ *
67
+ * Coverage describes which tokens are supported by returned catalog wording;
68
+ * it is not an acceptance verdict. Template candidates are drafting aids and
69
+ * are never themselves `listed`. An inferred class is a suggestion that the
70
+ * caller can override by supplying `class_number`. Warnings cite office
71
+ * guidance about indefinite wording and do not predict refusal.
72
+ *
73
+ * Check `candidate_search`: `complete` makes an empty candidate list
74
+ * meaningful, while `truncated` and `degraded` mean the search was incomplete.
75
+ * `summary.offices[].catalog_freshness[].as_of` reports catalog freshness; null means
76
+ * unknown, not current.
77
+ *
78
+ * Scope: `trademarks:read`. Billed per item. `Idempotency-Key` is optional
79
+ * and can be supplied through `options.idempotency_key` for replay.
80
+ *
81
+ * ```typescript
82
+ * const result = await signa.goodsServices.validate({
83
+ * offices: ['US', 'EM'],
84
+ * items: [{ term: 'coffee', class_number: 30 }],
85
+ * });
86
+ * ```
87
+ */
88
+ validate(body: GoodsServicesValidateParams, options?: RequestOptions): Promise<GoodsServicesValidationResponse>;
55
89
  }
56
90
  //# sourceMappingURL=goods-services.d.ts.map
@@ -1 +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"}
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,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"}
@@ -9,10 +9,14 @@ import { createList } from '../pagination.js';
9
9
  * - {@link GoodsServices.suggest} — draft a filing-ready goods/services
10
10
  * specification from a natural-language description. Pass `class_number`
11
11
  * to scope the output to a single, already-chosen class.
12
+ * - {@link GoodsServices.validate} — report whether submitted wording appears
13
+ * in each requested office's pre-approved catalog, with descriptive wording
14
+ * coverage, drafting candidates, inferred-class suggestions, cited warnings,
15
+ * catalog freshness, and candidate-search completeness.
12
16
  */
13
17
  export class GoodsServices extends BaseResource {
14
18
  /**
15
- * Browse/search accepted goods & services terms. At least one of `q` or
19
+ * Browse/search pre-approved goods & services terms. At least one of `q` or
16
20
  * `class` must be provided.
17
21
  *
18
22
  * Scope: `trademarks:read`. Not billed (reference data).
@@ -56,5 +60,37 @@ export class GoodsServices extends BaseResource {
56
60
  async suggest(body, options) {
57
61
  return this._post('/v1/goods-services/suggest', body, options);
58
62
  }
63
+ /**
64
+ * Check submitted wording against the pre-approved catalogs we hold.
65
+ * `listed` means the wording appears in that office's catalog;
66
+ * `not_listed` is an absence of evidence, not a refusal.
67
+ *
68
+ * Only US, EM, JP, KR, and CN have catalog answers. Other recognized offices
69
+ * return `unsupported_office` with reason `no_catalog_data`.
70
+ *
71
+ * Coverage describes which tokens are supported by returned catalog wording;
72
+ * it is not an acceptance verdict. Template candidates are drafting aids and
73
+ * are never themselves `listed`. An inferred class is a suggestion that the
74
+ * caller can override by supplying `class_number`. Warnings cite office
75
+ * guidance about indefinite wording and do not predict refusal.
76
+ *
77
+ * Check `candidate_search`: `complete` makes an empty candidate list
78
+ * meaningful, while `truncated` and `degraded` mean the search was incomplete.
79
+ * `summary.offices[].catalog_freshness[].as_of` reports catalog freshness; null means
80
+ * unknown, not current.
81
+ *
82
+ * Scope: `trademarks:read`. Billed per item. `Idempotency-Key` is optional
83
+ * and can be supplied through `options.idempotency_key` for replay.
84
+ *
85
+ * ```typescript
86
+ * const result = await signa.goodsServices.validate({
87
+ * offices: ['US', 'EM'],
88
+ * items: [{ term: 'coffee', class_number: 30 }],
89
+ * });
90
+ * ```
91
+ */
92
+ async validate(body, options) {
93
+ return this._post('/v1/goods-services/validate', body, options);
94
+ }
59
95
  }
60
96
  //# sourceMappingURL=goods-services.js.map
@@ -1 +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"}
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;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"}
@@ -1,7 +1,7 @@
1
1
  import { BaseResource } from '../resource.js';
2
2
  import { type SignaList } from '../pagination.js';
3
3
  import type { FetchConfig } from '../_internals/fetch-with-retry.js';
4
- import type { Identity, Usage, ApiKey, ApiKeyWithRawKey, DeletedResponse, ApiKeyCreateParams, ApiKeyUpdateParams, RequestLog, RequestLogDetail, UsageSummaryParams, UsageSummaryResponse, CreditBalance, LogListParams, RequestOptions } from '../types.js';
4
+ import type { Identity, Usage, ApiKey, ApiKeyWithRawKey, DeletedResponse, ApiKeyCreateParams, ApiKeyUpdateParams, RequestLog, RequestLogDetail, UsageSummaryParams, UsageSummaryResponse, UsageEstimate, UsageEstimateParams, CreditBalance, LogListParams, RequestOptions } from '../types.js';
5
5
  declare class ApiKeys extends BaseResource {
6
6
  /** Create a new API key. Returns the raw key once. */
7
7
  create(body: ApiKeyCreateParams, options?: RequestOptions): Promise<ApiKeyWithRawKey>;
@@ -51,6 +51,13 @@ export declare class Organization extends BaseResource {
51
51
  * method on this class, not a namespace.
52
52
  */
53
53
  usageSummary(params: UsageSummaryParams, options?: RequestOptions): Promise<UsageSummaryResponse>;
54
+ /**
55
+ * Price the org's recorded traffic at the published credit schedule, broken
56
+ * down by action, with the plan that traffic lands on.
57
+ *
58
+ * An estimate of past traffic, not a bill. Defaults to the last 30 days.
59
+ */
60
+ usageEstimate(params?: UsageEstimateParams, options?: RequestOptions): Promise<UsageEstimate>;
54
61
  }
55
62
  export {};
56
63
  //# sourceMappingURL=organization.d.ts.map
@@ -1 +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"}
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,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"}
@@ -85,5 +85,14 @@ export class Organization extends BaseResource {
85
85
  async usageSummary(params, options) {
86
86
  return this._get('/v1/organization/usage/summary', { ...params }, options);
87
87
  }
88
+ /**
89
+ * Price the org's recorded traffic at the published credit schedule, broken
90
+ * down by action, with the plan that traffic lands on.
91
+ *
92
+ * An estimate of past traffic, not a bill. Defaults to the last 30 days.
93
+ */
94
+ async usageEstimate(params, options) {
95
+ return this._get('/v1/organization/usage/estimate', { ...params }, options);
96
+ }
88
97
  }
89
98
  //# sourceMappingURL=organization.js.map
@@ -1 +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"}
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;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"}
@@ -1,32 +1,58 @@
1
1
  import { BaseResource } from '../resource.js';
2
2
  import { type SignaList } from '../pagination.js';
3
- import type { Portfolio, DeletedResponse, PortfolioCreateParams, PortfolioUpdateParams, PortfolioListParams, PortfolioRetrieveParams, PortfolioAddTrademarksBody, PortfolioRemoveTrademarksBody, PortfolioDeadlineParams, PortfolioDeadlinesIcalParams, RequestOptions } from '../types.js';
3
+ import type { Portfolio, PortfolioResponse, PortfolioDetail, PortfolioMarksAddResult, PortfolioMarksRemoveResult, DeletedResponse, PortfolioCreateParams, PortfolioUpdateParams, PortfolioListParams, PortfolioRetrieveParams, PortfolioAddTrademarksBody, PortfolioRemoveTrademarksBody, PortfolioDeadlineParams, PortfolioDeadlinesIcalParams, RequestOptions } from '../types.js';
4
4
  export declare class Portfolios extends BaseResource {
5
5
  /** Create a portfolio. */
6
- create(body: PortfolioCreateParams, options?: RequestOptions): Promise<Portfolio>;
6
+ create(body: PortfolioCreateParams, options?: RequestOptions): Promise<PortfolioResponse>;
7
7
  /** List organization's portfolios. */
8
8
  list(params?: PortfolioListParams, options?: RequestOptions): Promise<SignaList<Portfolio>>;
9
- /** Retrieve a portfolio with embedded marks. */
10
- retrieve(id: string, params?: PortfolioRetrieveParams, options?: RequestOptions): Promise<Portfolio>;
9
+ /**
10
+ * Retrieve a portfolio with its embedded membership page.
11
+ *
12
+ * Pass `external_ref` to return only the membership carrying that docketing
13
+ * reference (at most one row), or `limit: 0` to skip the marks entirely.
14
+ */
15
+ retrieve(id: string, params?: PortfolioRetrieveParams, options?: RequestOptions): Promise<PortfolioDetail>;
11
16
  /** Update a portfolio (merge semantics for metadata). */
12
- update(id: string, body: PortfolioUpdateParams, options?: RequestOptions): Promise<Portfolio>;
17
+ update(id: string, body: PortfolioUpdateParams, options?: RequestOptions): Promise<PortfolioResponse>;
13
18
  /** Delete a portfolio (cascades marks). */
14
19
  delete(id: string, options?: RequestOptions): Promise<DeletedResponse>;
15
- /** Add trademarks to a portfolio (idempotent). */
16
- addTrademarks(id: string, body: PortfolioAddTrademarksBody, options?: RequestOptions): Promise<{
17
- object: string;
18
- added: number;
19
- already_in_portfolio: number;
20
- not_found: number;
21
- }>;
22
- /** Remove trademarks from a portfolio. */
23
- removeTrademarks(id: string, body: PortfolioRemoveTrademarksBody, options?: RequestOptions): Promise<{
24
- object: string;
25
- removed: number;
26
- }>;
27
- /** List computed deadlines for portfolio marks. */
28
- deadlines(id: string, params: PortfolioDeadlineParams, options?: RequestOptions): Promise<SignaList<unknown>>;
29
- /** Get an iCal calendar feed of portfolio deadlines. */
20
+ /**
21
+ * Add trademarks to a portfolio (idempotent per distinct input mark).
22
+ *
23
+ * Supply exactly one of `trademark_ids` (plain ids, LENIENT on duplicates)
24
+ * or `items` (ids plus optional `external_ref`, STRICT on duplicates) — see
25
+ * {@link PortfolioAddTrademarksBody}. Passing both is a compile error and a
26
+ * `400` at the API.
27
+ *
28
+ * Up to 100 entries per request. Any `409` — {@link isExternalRefConflict}
29
+ * or the managed-marks {@link isResourceQuotaExceeded} cap — rolls the whole
30
+ * batch back; unknown ids are lenient and counted under `not_found`.
31
+ */
32
+ addTrademarks(id: string, body: PortfolioAddTrademarksBody, options?: RequestOptions): Promise<PortfolioMarksAddResult>;
33
+ /**
34
+ * Remove trademarks from a portfolio, by id or by your own reference.
35
+ *
36
+ * Supply exactly one of `trademark_ids` or `external_refs` (up to 100) — see
37
+ * {@link PortfolioRemoveTrademarksBody}. Entries that match no membership
38
+ * are simply skipped.
39
+ */
40
+ removeTrademarks(id: string, body: PortfolioRemoveTrademarksBody, options?: RequestOptions): Promise<PortfolioMarksRemoveResult>;
41
+ /**
42
+ * List computed deadlines for portfolio marks.
43
+ *
44
+ * `due_before` is optional — omit `params` entirely to take the API's own
45
+ * horizon of 24 months from now.
46
+ */
47
+ deadlines(id: string, params?: PortfolioDeadlineParams, options?: RequestOptions): Promise<SignaList<unknown>>;
48
+ /**
49
+ * Download the portfolio's deadlines as an iCal (RFC 5545) calendar file.
50
+ *
51
+ * An authenticated ONE-TIME download, not a subscribable calendar URL: the
52
+ * endpoint requires the same bearer token as every other call and responds
53
+ * with `Content-Disposition: attachment`, so the returned string is a
54
+ * snapshot. Re-call it to refresh.
55
+ */
30
56
  deadlinesIcal(id: string, params?: PortfolioDeadlinesIcalParams, options?: RequestOptions): Promise<string>;
31
57
  }
32
58
  //# sourceMappingURL=portfolios.d.ts.map
@@ -1 +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"}
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,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"}
@@ -13,7 +13,12 @@ export class Portfolios extends BaseResource {
13
13
  const firstPage = await fetchPage(params?.cursor);
14
14
  return createList(firstPage, fetchPage);
15
15
  }
16
- /** Retrieve a portfolio with embedded marks. */
16
+ /**
17
+ * Retrieve a portfolio with its embedded membership page.
18
+ *
19
+ * Pass `external_ref` to return only the membership carrying that docketing
20
+ * reference (at most one row), or `limit: 0` to skip the marks entirely.
21
+ */
17
22
  async retrieve(id, params, options) {
18
23
  this._validateId(id);
19
24
  return this._get(`/v1/portfolios/${encodeURIComponent(id)}`, params, options);
@@ -28,17 +33,39 @@ export class Portfolios extends BaseResource {
28
33
  this._validateId(id);
29
34
  return this._delete(`/v1/portfolios/${encodeURIComponent(id)}`, options);
30
35
  }
31
- /** Add trademarks to a portfolio (idempotent). */
36
+ /**
37
+ * Add trademarks to a portfolio (idempotent per distinct input mark).
38
+ *
39
+ * Supply exactly one of `trademark_ids` (plain ids, LENIENT on duplicates)
40
+ * or `items` (ids plus optional `external_ref`, STRICT on duplicates) — see
41
+ * {@link PortfolioAddTrademarksBody}. Passing both is a compile error and a
42
+ * `400` at the API.
43
+ *
44
+ * Up to 100 entries per request. Any `409` — {@link isExternalRefConflict}
45
+ * or the managed-marks {@link isResourceQuotaExceeded} cap — rolls the whole
46
+ * batch back; unknown ids are lenient and counted under `not_found`.
47
+ */
32
48
  async addTrademarks(id, body, options) {
33
49
  this._validateId(id);
34
50
  return this._post(`/v1/portfolios/${encodeURIComponent(id)}/trademarks`, body, options);
35
51
  }
36
- /** Remove trademarks from a portfolio. */
52
+ /**
53
+ * Remove trademarks from a portfolio, by id or by your own reference.
54
+ *
55
+ * Supply exactly one of `trademark_ids` or `external_refs` (up to 100) — see
56
+ * {@link PortfolioRemoveTrademarksBody}. Entries that match no membership
57
+ * are simply skipped.
58
+ */
37
59
  async removeTrademarks(id, body, options) {
38
60
  this._validateId(id);
39
61
  return this._post(`/v1/portfolios/${encodeURIComponent(id)}/trademarks/remove`, body, options);
40
62
  }
41
- /** List computed deadlines for portfolio marks. */
63
+ /**
64
+ * List computed deadlines for portfolio marks.
65
+ *
66
+ * `due_before` is optional — omit `params` entirely to take the API's own
67
+ * horizon of 24 months from now.
68
+ */
42
69
  async deadlines(id, params, options) {
43
70
  this._validateId(id);
44
71
  const fetchPage = async (cursor) => {
@@ -47,7 +74,14 @@ export class Portfolios extends BaseResource {
47
74
  const firstPage = await fetchPage(params?.cursor);
48
75
  return createList(firstPage, fetchPage);
49
76
  }
50
- /** Get an iCal calendar feed of portfolio deadlines. */
77
+ /**
78
+ * Download the portfolio's deadlines as an iCal (RFC 5545) calendar file.
79
+ *
80
+ * An authenticated ONE-TIME download, not a subscribable calendar URL: the
81
+ * endpoint requires the same bearer token as every other call and responds
82
+ * with `Content-Disposition: attachment`, so the returned string is a
83
+ * snapshot. Re-call it to refresh.
84
+ */
51
85
  async deadlinesIcal(id, params, options) {
52
86
  this._validateId(id);
53
87
  return this._getRaw(`/v1/portfolios/${encodeURIComponent(id)}/deadlines.ics`, params, options);
@@ -1 +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"}
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;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"}
@@ -5,7 +5,8 @@ export declare class Reconcile extends BaseResource {
5
5
  /**
6
6
  * Compare your trademark record fields against Signa's register data.
7
7
  *
8
- * Scope: `trademarks:read`. Billed as 1 unit per item.
8
+ * Scope: `trademarks:read`. Billed as 1 unit per item — `verdict_detail`
9
+ * does not change billing.
9
10
  *
10
11
  * ```typescript
11
12
  * const results = await signa.reconcile.run({
@@ -15,6 +16,25 @@ export declare class Reconcile extends BaseResource {
15
16
  * your_fields: { status: 'active' },
16
17
  * }],
17
18
  * });
19
+ *
20
+ * // Docket audit: opt in to three-source per-field verdicts (your value
21
+ * // vs the register vs the rulebook-computed schedule).
22
+ * const audit = await signa.reconcile.run({
23
+ * verdict_detail: true,
24
+ * items: [{
25
+ * office: 'US',
26
+ * application_number: '88123456',
27
+ * your_fields: {
28
+ * renewal_due_date: '2030-03-10',
29
+ * docketed_deadlines: [{ type: 'renewal', date: '2030-03-10' }],
30
+ * },
31
+ * }],
32
+ * });
33
+ * for (const item of audit.data) {
34
+ * for (const verdict of item.field_verdicts ?? []) {
35
+ * console.log(verdict.field, verdict.verdict, verdict.computed_value);
36
+ * }
37
+ * }
18
38
  * ```
19
39
  */
20
40
  run(body: ReconcileParams, options?: RequestOptions): Promise<SignaList<Reconciliation>>;
@@ -1 +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"}
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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAkCG;IACG,GAAG,CACP,IAAI,EAAE,eAAe,EACrB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;CAUtC"}
@@ -4,7 +4,8 @@ export class Reconcile extends BaseResource {
4
4
  /**
5
5
  * Compare your trademark record fields against Signa's register data.
6
6
  *
7
- * Scope: `trademarks:read`. Billed as 1 unit per item.
7
+ * Scope: `trademarks:read`. Billed as 1 unit per item — `verdict_detail`
8
+ * does not change billing.
8
9
  *
9
10
  * ```typescript
10
11
  * const results = await signa.reconcile.run({
@@ -14,6 +15,25 @@ export class Reconcile extends BaseResource {
14
15
  * your_fields: { status: 'active' },
15
16
  * }],
16
17
  * });
18
+ *
19
+ * // Docket audit: opt in to three-source per-field verdicts (your value
20
+ * // vs the register vs the rulebook-computed schedule).
21
+ * const audit = await signa.reconcile.run({
22
+ * verdict_detail: true,
23
+ * items: [{
24
+ * office: 'US',
25
+ * application_number: '88123456',
26
+ * your_fields: {
27
+ * renewal_due_date: '2030-03-10',
28
+ * docketed_deadlines: [{ type: 'renewal', date: '2030-03-10' }],
29
+ * },
30
+ * }],
31
+ * });
32
+ * for (const item of audit.data) {
33
+ * for (const verdict of item.field_verdicts ?? []) {
34
+ * console.log(verdict.field, verdict.verdict, verdict.computed_value);
35
+ * }
36
+ * }
17
37
  * ```
18
38
  */
19
39
  async run(body, options) {
@@ -1 +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"}
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;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;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"}
@@ -1,6 +1,6 @@
1
1
  import { BaseResource } from '../resource.js';
2
2
  import { type SignaList } from '../pagination.js';
3
- import type { Classification, ClassificationDetail, ClassificationSuggestParams, ClassificationSuggestResult, Office, OfficeDetail, Jurisdiction, JurisdictionDetail, DeadlineRule, OppositionRule, EventType, DesignCode, DesignCodeDetail, DesignCodeListParams, ClassificationListParams, RequestOptions } from '../types.js';
3
+ 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';
4
4
  /** Filters accepted by {@link References#deadlineRules}. */
5
5
  export interface DeadlineRulesListParams {
6
6
  /** Filter by jurisdiction code (uppercase ISO-2 + WIPO). Single value or array. */
@@ -66,15 +66,56 @@ export declare class References extends BaseResource {
66
66
  */
67
67
  offices(options?: RequestOptions): Promise<SignaList<Office>>;
68
68
  /**
69
- * Retrieve a single office, optionally with status mappings.
69
+ * Retrieve a single office.
70
70
  *
71
71
  * ```typescript
72
72
  * const office = await signa.references.office('US');
73
73
  * ```
74
74
  */
75
- office(code: string, params?: {
76
- include?: Array<'status_mappings'>;
77
- }, options?: RequestOptions): Promise<OfficeDetail>;
75
+ office(code: string, options?: RequestOptions): Promise<OfficeDetail>;
76
+ /**
77
+ * List your organization's office-coverage votes, alphabetical by office
78
+ * code. The votable vocabulary is bounded, so the list is always a single
79
+ * page (`has_more: false`) — the endpoint accepts `limit`/`cursor` for
80
+ * list-client compatibility but they cannot change the response.
81
+ *
82
+ * ```typescript
83
+ * const votes = await signa.references.officeVotes();
84
+ * ```
85
+ */
86
+ officeVotes(options?: RequestOptions): Promise<SignaList<OfficeVote>>;
87
+ /**
88
+ * Vote for trademark offices your organization wants on Signa. One vote per
89
+ * office per organization — re-votes are no-ops, so the call is safely
90
+ * retryable (idempotent via the standard Idempotency-Key header,
91
+ * auto-injected by the SDK). Returns the stored votes for every requested
92
+ * code, newly cast or pre-existing.
93
+ *
94
+ * Offices already covered by Signa are not votable — casting one returns a
95
+ * `400` with an `office_already_live` entry in `errors[]`, and the whole
96
+ * batch is rejected. A territory of a covered office (`PR` → USPTO,
97
+ * `RE` → INPI-FR) counts as its parent office and is rejected the same way,
98
+ * and codes with no trademark register of their own (`AQ`, `BV`, …) are
99
+ * rejected with `no_trademark_register`.
100
+ *
101
+ * ```typescript
102
+ * const votes = await signa.references.castOfficeVotes({ office_codes: ['CL', 'MX'] });
103
+ * ```
104
+ */
105
+ castOfficeVotes(body: CastOfficeVotesParams, options?: RequestOptions): Promise<SignaList<OfficeVote>>;
106
+ /**
107
+ * Retract your organization's vote for an office. Accepts a WIDER code
108
+ * vocabulary than {@link References#castOfficeVotes}: only an unrecognizable
109
+ * token is rejected, so a vote for an office Signa has since covered — or a
110
+ * code with no trademark register of its own (`AQ`, `BV`, …) — still
111
+ * retracts. When you have no vote for the code the call returns `404`, not
112
+ * `400`. Territory codes canonicalize to their parent office (`PR` → `US`).
113
+ *
114
+ * ```typescript
115
+ * await signa.references.retractOfficeVote('BR');
116
+ * ```
117
+ */
118
+ retractOfficeVote(code: string, options?: RequestOptions): Promise<OfficeVoteDeleted>;
78
119
  /**
79
120
  * List all supported jurisdictions.
80
121
  *
@@ -118,13 +159,27 @@ export declare class References extends BaseResource {
118
159
  */
119
160
  oppositionRules(params?: OppositionRulesListParams, options?: RequestOptions): Promise<SignaList<OppositionRule>>;
120
161
  /**
121
- * List all event type codes used in trademark history.
162
+ * List event type codes used in trademark history (`GET /v1/event-types`):
163
+ * each office code with its verbatim label and the canonical event type
164
+ * Signa maps it to. Auto-paginates.
165
+ *
166
+ * ```typescript
167
+ * const types = await signa.references.eventTypes({ office_code: 'US' });
168
+ * for await (const t of types) console.log(t.raw.code, t.event_type);
169
+ * ```
170
+ */
171
+ eventTypes(params?: EventTypeListParams, options?: RequestOptions): Promise<SignaList<EventType>>;
172
+ /**
173
+ * List office status codes (`GET /v1/status-codes`): each office code with
174
+ * its verbatim label and the normalised status Signa maps it to. Decode a
175
+ * trademark's `status.raw.code` with it. Auto-paginates.
122
176
  *
123
177
  * ```typescript
124
- * const eventTypes = await signa.references.eventTypes();
178
+ * const codes = await signa.references.statusCodes({ office_code: 'US' });
179
+ * for await (const code of codes) console.log(code.raw?.code, code.stage);
125
180
  * ```
126
181
  */
127
- eventTypes(options?: RequestOptions): Promise<SignaList<EventType>>;
182
+ statusCodes(params?: StatusCodeListParams, options?: RequestOptions): Promise<SignaList<StatusCode>>;
128
183
  /**
129
184
  * List Vienna classification design codes.
130
185
  *
@@ -1 +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,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,wBAAwB,EACxB,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;;;;;;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"}
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,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"}