@signa-so/sdk 0.4.0 → 0.7.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 (97) hide show
  1. package/README.md +4 -4
  2. package/dist/_internals/fetch-with-retry.d.ts.map +1 -1
  3. package/dist/_internals/fetch-with-retry.js +10 -2
  4. package/dist/_internals/fetch-with-retry.js.map +1 -1
  5. package/dist/_internals/query-string.d.ts +1 -1
  6. package/dist/_internals/query-string.js +1 -1
  7. package/dist/category-nice.d.ts +22 -0
  8. package/dist/category-nice.d.ts.map +1 -0
  9. package/dist/category-nice.js +109 -0
  10. package/dist/category-nice.js.map +1 -0
  11. package/dist/client.d.ts +26 -0
  12. package/dist/client.d.ts.map +1 -1
  13. package/dist/client.js +34 -0
  14. package/dist/client.js.map +1 -1
  15. package/dist/generated/api-types.d.ts +7780 -2215
  16. package/dist/generated/api-types.d.ts.map +1 -1
  17. package/dist/index.d.ts +4 -1
  18. package/dist/index.d.ts.map +1 -1
  19. package/dist/index.js +3 -0
  20. package/dist/index.js.map +1 -1
  21. package/dist/pagination.d.ts +23 -1
  22. package/dist/pagination.d.ts.map +1 -1
  23. package/dist/pagination.js +27 -0
  24. package/dist/pagination.js.map +1 -1
  25. package/dist/resources/analytics.d.ts +8 -0
  26. package/dist/resources/analytics.d.ts.map +1 -0
  27. package/dist/resources/analytics.js +13 -0
  28. package/dist/resources/analytics.js.map +1 -0
  29. package/dist/resources/assignments.d.ts +25 -0
  30. package/dist/resources/assignments.d.ts.map +1 -0
  31. package/dist/resources/assignments.js +33 -0
  32. package/dist/resources/assignments.js.map +1 -0
  33. package/dist/resources/attorneys.d.ts +2 -1
  34. package/dist/resources/attorneys.d.ts.map +1 -1
  35. package/dist/resources/attorneys.js +4 -0
  36. package/dist/resources/attorneys.js.map +1 -1
  37. package/dist/resources/compare.d.ts +29 -0
  38. package/dist/resources/compare.d.ts.map +1 -0
  39. package/dist/resources/compare.js +30 -0
  40. package/dist/resources/compare.js.map +1 -0
  41. package/dist/resources/deadlines.d.ts +24 -0
  42. package/dist/resources/deadlines.d.ts.map +1 -0
  43. package/dist/resources/deadlines.js +26 -0
  44. package/dist/resources/deadlines.js.map +1 -0
  45. package/dist/resources/entities.d.ts +2 -1
  46. package/dist/resources/entities.d.ts.map +1 -1
  47. package/dist/resources/entities.js +4 -0
  48. package/dist/resources/entities.js.map +1 -1
  49. package/dist/resources/events.d.ts +2 -2
  50. package/dist/resources/events.d.ts.map +1 -1
  51. package/dist/resources/events.js +2 -2
  52. package/dist/resources/events.js.map +1 -1
  53. package/dist/resources/feedback.d.ts +19 -0
  54. package/dist/resources/feedback.d.ts.map +1 -0
  55. package/dist/resources/feedback.js +29 -0
  56. package/dist/resources/feedback.js.map +1 -0
  57. package/dist/resources/firms.d.ts +3 -2
  58. package/dist/resources/firms.d.ts.map +1 -1
  59. package/dist/resources/firms.js +5 -1
  60. package/dist/resources/firms.js.map +1 -1
  61. package/dist/resources/goods-services.d.ts +1 -1
  62. package/dist/resources/goods-services.js +1 -1
  63. package/dist/resources/oppositions.d.ts +18 -0
  64. package/dist/resources/oppositions.d.ts.map +1 -0
  65. package/dist/resources/oppositions.js +20 -0
  66. package/dist/resources/oppositions.js.map +1 -0
  67. package/dist/resources/organization.d.ts +7 -1
  68. package/dist/resources/organization.d.ts.map +1 -1
  69. package/dist/resources/organization.js +8 -0
  70. package/dist/resources/organization.js.map +1 -1
  71. package/dist/resources/owners.d.ts +2 -1
  72. package/dist/resources/owners.d.ts.map +1 -1
  73. package/dist/resources/owners.js +4 -0
  74. package/dist/resources/owners.js.map +1 -1
  75. package/dist/resources/reconcile.d.ts +22 -0
  76. package/dist/resources/reconcile.d.ts.map +1 -0
  77. package/dist/resources/reconcile.js +24 -0
  78. package/dist/resources/reconcile.js.map +1 -0
  79. package/dist/resources/references.d.ts +2 -2
  80. package/dist/resources/references.js +2 -2
  81. package/dist/resources/screening.d.ts +63 -0
  82. package/dist/resources/screening.d.ts.map +1 -0
  83. package/dist/resources/screening.js +66 -0
  84. package/dist/resources/screening.js.map +1 -0
  85. package/dist/resources/trademarks.d.ts +42 -8
  86. package/dist/resources/trademarks.d.ts.map +1 -1
  87. package/dist/resources/trademarks.js +85 -6
  88. package/dist/resources/trademarks.js.map +1 -1
  89. package/dist/resources/watches.d.ts +14 -2
  90. package/dist/resources/watches.d.ts.map +1 -1
  91. package/dist/resources/watches.js +21 -1
  92. package/dist/resources/watches.js.map +1 -1
  93. package/dist/types.d.ts +1707 -115
  94. package/dist/types.d.ts.map +1 -1
  95. package/dist/version.d.ts +1 -1
  96. package/dist/version.js +1 -1
  97. package/package.json +3 -2
@@ -1,13 +1,14 @@
1
1
  import { BaseResource } from '../resource.js';
2
2
  import { type SignaList } from '../pagination.js';
3
- import type { Firm, FirmSummary, AttorneySummary, TrademarkSummary, FirmRetrieveParams, FirmListParams, FirmAttorneysParams, FirmTrademarksParams, RequestOptions } from '../types.js';
3
+ import type { Firm, FirmSummary, AttorneySummary, TrademarkSummary, FirmRetrieveParams, FirmListParams, FirmAttorneysParams, FirmTrademarksParams, RequestOptions, AnalyticsReport } from '../types.js';
4
4
  export declare class Firms extends BaseResource {
5
+ analytics(id: string, options?: RequestOptions): Promise<AnalyticsReport>;
5
6
  /**
6
7
  * Retrieve a single firm by ID.
7
8
  *
8
9
  * ```typescript
9
10
  * const firm = await signa.firms.retrieve('firm_abc123');
10
- * const firm = await signa.firms.retrieve('firm_abc123', { include: ['stats', 'specializations', 'trend'] });
11
+ * const firm = await signa.firms.retrieve('firm_abc123', { include: ['attorneys'] });
11
12
  * ```
12
13
  */
13
14
  retrieve(id: string, params?: FirmRetrieveParams, options?: RequestOptions): Promise<Firm>;
@@ -1 +1 @@
1
- {"version":3,"file":"firms.d.ts","sourceRoot":"","sources":["../../src/resources/firms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,IAAI,EACJ,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EACnB,oBAAoB,EACpB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,KAAM,SAAQ,YAAY;IACrC;;;;;;;OAOG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;OAMG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,cAAc,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAQlC;;;;;;;OAOG;IACG,SAAS,CACb,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAatC;;;;;;OAMG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;CAYxC"}
1
+ {"version":3,"file":"firms.d.ts","sourceRoot":"","sources":["../../src/resources/firms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,IAAI,EACJ,WAAW,EACX,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EACnB,oBAAoB,EACpB,cAAc,EACd,eAAe,EAChB,MAAM,aAAa,CAAC;AAErB,qBAAa,KAAM,SAAQ,YAAY;IAC/B,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAI/E;;;;;;;OAOG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,IAAI,CAAC;IAOhB;;;;;;OAMG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,cAAc,EACvB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,WAAW,CAAC,CAAC;IAQlC;;;;;;;OAOG;IACG,SAAS,CACb,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAatC;;;;;;OAMG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;CAYxC"}
@@ -1,12 +1,16 @@
1
1
  import { BaseResource } from '../resource.js';
2
2
  import { createList } from '../pagination.js';
3
3
  export class Firms extends BaseResource {
4
+ async analytics(id, options) {
5
+ this._validateId(id);
6
+ return this._get(`/v1/firms/${encodeURIComponent(id)}/analytics`, undefined, options);
7
+ }
4
8
  /**
5
9
  * Retrieve a single firm by ID.
6
10
  *
7
11
  * ```typescript
8
12
  * const firm = await signa.firms.retrieve('firm_abc123');
9
- * const firm = await signa.firms.retrieve('firm_abc123', { include: ['stats', 'specializations', 'trend'] });
13
+ * const firm = await signa.firms.retrieve('firm_abc123', { include: ['attorneys'] });
10
14
  * ```
11
15
  */
12
16
  async retrieve(id, params, options) {
@@ -1 +1 @@
1
- {"version":3,"file":"firms.js","sourceRoot":"","sources":["../../src/resources/firms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAa9D,MAAM,OAAO,KAAM,SAAQ,YAAY;IACrC;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAO,aAAa,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE;YAC5D,OAAO,EAAE,MAAM,EAAE,OAAO;SACzB,EAAE,OAAO,CAAC,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,MAAuB,EACvB,OAAwB;QAExB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAc,WAAW,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QACzF,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,SAAS,CACb,EAAU,EACV,MAA4B,EAC5B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAC1B,aAAa,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAC/C,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;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CACd,EAAU,EACV,MAA6B,EAC7B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAC1B,aAAa,kBAAkB,CAAC,EAAE,CAAC,aAAa,EAChD,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;CACF"}
1
+ {"version":3,"file":"firms.js","sourceRoot":"","sources":["../../src/resources/firms.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAc9D,MAAM,OAAO,KAAM,SAAQ,YAAY;IACrC,KAAK,CAAC,SAAS,CAAC,EAAU,EAAE,OAAwB;QAClD,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAkB,aAAa,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACzG,CAAC;IACD;;;;;;;OAOG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAO,aAAa,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE;YAC5D,OAAO,EAAE,MAAM,EAAE,OAAO;SACzB,EAAE,OAAO,CAAC,CAAC;IACd,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,MAAuB,EACvB,OAAwB;QAExB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAc,WAAW,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QACzF,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,SAAS,CACb,EAAU,EACV,MAA4B,EAC5B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAC1B,aAAa,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAC/C,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;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CACd,EAAU,EACV,MAA6B,EAC7B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAC1B,aAAa,kBAAkB,CAAC,EAAE,CAAC,aAAa,EAChD,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;CACF"}
@@ -36,7 +36,7 @@ export declare class GoodsServices extends BaseResource {
36
36
  * class (useful when refining wording inside a class the caller has already
37
37
  * picked).
38
38
  *
39
- * Scope: `trademarks:read`. Billed as 2 units.
39
+ * Scope: `trademarks:read`. Billed as 2 credits.
40
40
  *
41
41
  * ```typescript
42
42
  * // Full draft across all relevant classes
@@ -38,7 +38,7 @@ export class GoodsServices extends BaseResource {
38
38
  * class (useful when refining wording inside a class the caller has already
39
39
  * picked).
40
40
  *
41
- * Scope: `trademarks:read`. Billed as 2 units.
41
+ * Scope: `trademarks:read`. Billed as 2 credits.
42
42
  *
43
43
  * ```typescript
44
44
  * // Full draft across all relevant classes
@@ -0,0 +1,18 @@
1
+ import { BaseResource } from '../resource.js';
2
+ import { type SignaList } from '../pagination.js';
3
+ import type { OppositionComputeParams, OppositionWindowComputation, RequestOptions } from '../types.js';
4
+ export declare class Oppositions extends BaseResource {
5
+ /**
6
+ * Compute opposition windows for one or more published marks.
7
+ *
8
+ * Scope: `trademarks:read`. Billed as 1 unit per item.
9
+ *
10
+ * ```typescript
11
+ * const windows = await signa.oppositions.compute({
12
+ * items: [{ office: 'EM', publication_date: '2026-05-01' }],
13
+ * });
14
+ * ```
15
+ */
16
+ compute(body: OppositionComputeParams, options?: RequestOptions): Promise<SignaList<OppositionWindowComputation>>;
17
+ }
18
+ //# sourceMappingURL=oppositions.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"oppositions.d.ts","sourceRoot":"","sources":["../../src/resources/oppositions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,uBAAuB,EAEvB,2BAA2B,EAC3B,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,WAAY,SAAQ,YAAY;IAC3C;;;;;;;;;;OAUG;IACG,OAAO,CACX,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,2BAA2B,CAAC,CAAC;CAUnD"}
@@ -0,0 +1,20 @@
1
+ import { BaseResource } from '../resource.js';
2
+ import { createList } from '../pagination.js';
3
+ export class Oppositions extends BaseResource {
4
+ /**
5
+ * Compute opposition windows for one or more published marks.
6
+ *
7
+ * Scope: `trademarks:read`. Billed as 1 unit per item.
8
+ *
9
+ * ```typescript
10
+ * const windows = await signa.oppositions.compute({
11
+ * items: [{ office: 'EM', publication_date: '2026-05-01' }],
12
+ * });
13
+ * ```
14
+ */
15
+ async compute(body, options) {
16
+ const response = await this._post('/v1/oppositions/compute', body, options);
17
+ return createList({ ...response, has_more: false }, () => Promise.resolve({ ...response, data: [], has_more: false }));
18
+ }
19
+ }
20
+ //# sourceMappingURL=oppositions.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"oppositions.js","sourceRoot":"","sources":["../../src/resources/oppositions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAQ9D,MAAM,OAAO,WAAY,SAAQ,YAAY;IAC3C;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,CACX,IAA6B,EAC7B,OAAwB;QAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAC/B,yBAAyB,EACzB,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,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, LogListParams, RequestOptions } from '../types.js';
4
+ import type { Identity, Usage, ApiKey, ApiKeyWithRawKey, DeletedResponse, ApiKeyCreateParams, ApiKeyUpdateParams, RequestLog, RequestLogDetail, UsageSummaryParams, UsageSummaryResponse, 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>;
@@ -37,6 +37,12 @@ export declare class Organization extends BaseResource {
37
37
  me(options?: RequestOptions): Promise<Identity>;
38
38
  /** Get billing period usage and rate limit info. */
39
39
  usage(options?: RequestOptions): Promise<Usage>;
40
+ /**
41
+ * Get the pooled credit balance: the spendable balance, a breakdown of
42
+ * remaining credits by grant type (plan vs addon vs promo), and the
43
+ * per-grant expiry schedule in consumption order.
44
+ */
45
+ credits(options?: RequestOptions): Promise<CreditBalance>;
40
46
  /**
41
47
  * Get daily usage breakdown from pre-aggregated rollups plus current
42
48
  * billing period quota context.
@@ -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,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;;;;;;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,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"}
@@ -67,6 +67,14 @@ export class Organization extends BaseResource {
67
67
  async usage(options) {
68
68
  return this._get('/v1/organization/usage', undefined, options);
69
69
  }
70
+ /**
71
+ * Get the pooled credit balance: the spendable balance, a breakdown of
72
+ * remaining credits by grant type (plan vs addon vs promo), and the
73
+ * per-grant expiry schedule in consumption order.
74
+ */
75
+ async credits(options) {
76
+ return this._get('/v1/organization/credits', undefined, options);
77
+ }
70
78
  /**
71
79
  * Get daily usage breakdown from pre-aggregated rollups plus current
72
80
  * billing period quota context.
@@ -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;AAkB9D,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;;;;;;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;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,7 +1,8 @@
1
1
  import { BaseResource } from '../resource.js';
2
2
  import { type SignaList } from '../pagination.js';
3
- import type { Owner, OwnerSummary, TrademarkSummary, OwnerRetrieveParams, OwnerListParams, OwnerTrademarksParams, OwnerRelated, OwnerRelatedParams, RequestOptions } from '../types.js';
3
+ import type { Owner, OwnerSummary, TrademarkSummary, OwnerRetrieveParams, OwnerListParams, OwnerTrademarksParams, OwnerRelated, OwnerRelatedParams, AnalyticsReport, RequestOptions } from '../types.js';
4
4
  export declare class Owners extends BaseResource {
5
+ analytics(id: string, options?: RequestOptions): Promise<AnalyticsReport>;
5
6
  /**
6
7
  * Retrieve a single owner by ID.
7
8
  *
@@ -1 +1 @@
1
- {"version":3,"file":"owners.d.ts","sourceRoot":"","sources":["../../src/resources/owners.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,KAAK,EACL,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,MAAO,SAAQ,YAAY;IACtC;;;;;;;;;;OAUG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,mBAAmB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,KAAK,CAAC;IAKjB;;;;;;OAMG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAQnC;;;;;;OAMG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAavC;;;;;;OAMG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;CAYpC"}
1
+ {"version":3,"file":"owners.d.ts","sourceRoot":"","sources":["../../src/resources/owners.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,KAAK,EACL,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,eAAe,EACf,qBAAqB,EACrB,YAAY,EACZ,kBAAkB,EAClB,eAAe,EACf,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,MAAO,SAAQ,YAAY;IAChC,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAI/E;;;;;;;;;;OAUG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,mBAAmB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,KAAK,CAAC;IAKjB;;;;;;OAMG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,eAAe,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;IAQnC;;;;;;OAMG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAavC;;;;;;OAMG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,YAAY,CAAC,CAAC;CAYpC"}
@@ -1,6 +1,10 @@
1
1
  import { BaseResource } from '../resource.js';
2
2
  import { createList } from '../pagination.js';
3
3
  export class Owners extends BaseResource {
4
+ async analytics(id, options) {
5
+ this._validateId(id);
6
+ return this._get(`/v1/owners/${encodeURIComponent(id)}/analytics`, undefined, options);
7
+ }
4
8
  /**
5
9
  * Retrieve a single owner by ID.
6
10
  *
@@ -1 +1 @@
1
- {"version":3,"file":"owners.js","sourceRoot":"","sources":["../../src/resources/owners.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAa9D,MAAM,OAAO,MAAO,SAAQ,YAAY;IACtC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,OAA6B,EAC7B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAQ,cAAc,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,MAAwB,EACxB,OAAwB;QAExB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAe,YAAY,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3F,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;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CACd,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAC1B,cAAc,kBAAkB,CAAC,EAAE,CAAC,aAAa,EACjD,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;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CACX,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAC1B,cAAc,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC9C,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;CACF"}
1
+ {"version":3,"file":"owners.js","sourceRoot":"","sources":["../../src/resources/owners.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAc9D,MAAM,OAAO,MAAO,SAAQ,YAAY;IACtC,KAAK,CAAC,SAAS,CAAC,EAAU,EAAE,OAAwB;QAClD,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAkB,cAAc,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC1G,CAAC;IACD;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,OAA6B,EAC7B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAQ,cAAc,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACtF,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,MAAwB,EACxB,OAAwB;QAExB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAe,YAAY,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC3F,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;;;;;;OAMG;IACH,KAAK,CAAC,UAAU,CACd,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAC1B,cAAc,kBAAkB,CAAC,EAAE,CAAC,aAAa,EACjD,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;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CACX,EAAU,EACV,MAA2B,EAC3B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAC1B,cAAc,kBAAkB,CAAC,EAAE,CAAC,UAAU,EAC9C,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;CACF"}
@@ -0,0 +1,22 @@
1
+ import { BaseResource } from '../resource.js';
2
+ import { type SignaList } from '../pagination.js';
3
+ import type { Reconciliation, ReconcileParams, RequestOptions } from '../types.js';
4
+ export declare class Reconcile extends BaseResource {
5
+ /**
6
+ * Compare your trademark record fields against Signa's register data.
7
+ *
8
+ * Scope: `trademarks:read`. Billed as 1 unit per item.
9
+ *
10
+ * ```typescript
11
+ * const results = await signa.reconcile.run({
12
+ * items: [{
13
+ * office: 'US',
14
+ * application_number: '88123456',
15
+ * your_fields: { status: 'active' },
16
+ * }],
17
+ * });
18
+ * ```
19
+ */
20
+ run(body: ReconcileParams, options?: RequestOptions): Promise<SignaList<Reconciliation>>;
21
+ }
22
+ //# sourceMappingURL=reconcile.d.ts.map
@@ -0,0 +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"}
@@ -0,0 +1,24 @@
1
+ import { BaseResource } from '../resource.js';
2
+ import { createList } from '../pagination.js';
3
+ export class Reconcile extends BaseResource {
4
+ /**
5
+ * Compare your trademark record fields against Signa's register data.
6
+ *
7
+ * Scope: `trademarks:read`. Billed as 1 unit per item.
8
+ *
9
+ * ```typescript
10
+ * const results = await signa.reconcile.run({
11
+ * items: [{
12
+ * office: 'US',
13
+ * application_number: '88123456',
14
+ * your_fields: { status: 'active' },
15
+ * }],
16
+ * });
17
+ * ```
18
+ */
19
+ async run(body, options) {
20
+ const response = await this._post('/v1/reconcile', body, options);
21
+ return createList({ ...response, has_more: false }, () => Promise.resolve({ ...response, data: [], has_more: false }));
22
+ }
23
+ }
24
+ //# sourceMappingURL=reconcile.js.map
@@ -0,0 +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"}
@@ -69,7 +69,7 @@ export declare class References extends BaseResource {
69
69
  * Retrieve a single office, optionally with status mappings.
70
70
  *
71
71
  * ```typescript
72
- * const office = await signa.references.office('uspto');
72
+ * const office = await signa.references.office('US');
73
73
  * ```
74
74
  */
75
75
  office(code: string, params?: {
@@ -113,7 +113,7 @@ export declare class References extends BaseResource {
113
113
  * Filter by `office`, `jurisdiction`, `filing_route`, or `trigger_event`.
114
114
  *
115
115
  * ```typescript
116
- * const rules = await signa.references.oppositionRules({ office: 'euipo' });
116
+ * const rules = await signa.references.oppositionRules({ office: 'EM' });
117
117
  * ```
118
118
  */
119
119
  oppositionRules(params?: OppositionRulesListParams, options?: RequestOptions): Promise<SignaList<OppositionRule>>;
@@ -57,7 +57,7 @@ export class References extends BaseResource {
57
57
  * Retrieve a single office, optionally with status mappings.
58
58
  *
59
59
  * ```typescript
60
- * const office = await signa.references.office('uspto');
60
+ * const office = await signa.references.office('US');
61
61
  * ```
62
62
  */
63
63
  async office(code, params, options) {
@@ -111,7 +111,7 @@ export class References extends BaseResource {
111
111
  * Filter by `office`, `jurisdiction`, `filing_route`, or `trigger_event`.
112
112
  *
113
113
  * ```typescript
114
- * const rules = await signa.references.oppositionRules({ office: 'euipo' });
114
+ * const rules = await signa.references.oppositionRules({ office: 'EM' });
115
115
  * ```
116
116
  */
117
117
  async oppositionRules(params, options) {
@@ -0,0 +1,63 @@
1
+ import { BaseResource } from '../resource.js';
2
+ import type { ListingCheckParams, ListingCheckResult, RequestOptions, ScreenParams, ScreenResult } from '../types.js';
3
+ /**
4
+ * Screening operations — PUBLIC beta (requires the `screening:read` scope,
5
+ * granted to design partners during beta).
6
+ *
7
+ * Public exposure of the single-name screening surface was authorized by the
8
+ * founder's 2026-07-10 public-beta decision. `checkListing` is the listing-check
9
+ * surface (ENG-30): extract candidate marks from commerce text and fan them out
10
+ * through the screening core.
11
+ */
12
+ export declare class Screening extends BaseResource {
13
+ /**
14
+ * Screen a single candidate name — `GET /v1/screening`.
15
+ *
16
+ * PUBLIC beta. Requires the `screening:read` scope, granted to design partners
17
+ * during beta. Returns coarse risk bands and a verdict, never a numeric score.
18
+ * Billed at 10 units per request. Not legal advice.
19
+ *
20
+ * ```typescript
21
+ * const result = await signa.screening.screen({
22
+ * q: 'KOFEE',
23
+ * nice_classes: [30, 43],
24
+ * jurisdictions: ['US', 'EU'],
25
+ * });
26
+ * // result.screening.verdict → 'clear' | 'caution' | 'needs_review' | 'high_risk'
27
+ * ```
28
+ * `needs_review` is a would-be `clear` the screen could not complete to `clear`
29
+ * standard, most often incomplete register coverage for a requested territory
30
+ * but also a stale corpus, capped horizon, failed lane, unsupported language,
31
+ * or low-confidence class inference. Inspect `result.screening.coverage` for the
32
+ * details when present (it can be absent if the coverage assessment failed).
33
+ * Pass `trademark_id` instead of `q` to screen an existing register record;
34
+ * its own collapsed family is excluded from the returned conflicts.
35
+ */
36
+ screen(params: ScreenParams, options?: RequestOptions): Promise<ScreenResult>;
37
+ /**
38
+ * Screen a whole LISTING — `POST /v1/screening/listings`.
39
+ *
40
+ * Deterministic + synchronous. Extracts candidate marks from `title` / `brand`
41
+ * / `description` / `keywords`, fans them out through the screening core, and
42
+ * returns a listing-level verdict with per-candidate conflicts. Billed flat at
43
+ * 25 units per listing regardless of internal fan-out. Not legal advice.
44
+ * Beta limitation: common-word listings are over-flagged, so treat `caution`
45
+ * as no-signal pending the ENG-199 verdict-separation redesign.
46
+ * Supply `nice_classes` whenever possible: caller-provided classes are the only
47
+ * high-quality class signal that may corroborate a conflict upward. If your
48
+ * platform has only a category label, derive them explicitly with
49
+ * `categoryToNiceClasses(category)` from `@signa-so/sdk`.
50
+ *
51
+ * ```typescript
52
+ * import { categoryToNiceClasses } from '@signa-so/sdk';
53
+ *
54
+ * const result = await signa.screening.checkListing({
55
+ * title: 'Vintage AirPods Case — Handmade Leather',
56
+ * nice_classes: categoryToNiceClasses('handbags'),
57
+ * });
58
+ * // result.listing.verdict → 'clear' | 'caution' | 'high_risk'
59
+ * ```
60
+ */
61
+ checkListing(params: ListingCheckParams, options?: RequestOptions): Promise<ListingCheckResult>;
62
+ }
63
+ //# sourceMappingURL=screening.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"screening.d.ts","sourceRoot":"","sources":["../../src/resources/screening.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EACV,kBAAkB,EAClB,kBAAkB,EAClB,cAAc,EACd,YAAY,EACZ,YAAY,EACb,MAAM,aAAa,CAAC;AAErB;;;;;;;;GAQG;AACH,qBAAa,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,MAAM,CAAC,MAAM,EAAE,YAAY,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,YAAY,CAAC;IAInF;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACG,YAAY,CAChB,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,kBAAkB,CAAC;CAG/B"}
@@ -0,0 +1,66 @@
1
+ import { BaseResource } from '../resource.js';
2
+ /**
3
+ * Screening operations — PUBLIC beta (requires the `screening:read` scope,
4
+ * granted to design partners during beta).
5
+ *
6
+ * Public exposure of the single-name screening surface was authorized by the
7
+ * founder's 2026-07-10 public-beta decision. `checkListing` is the listing-check
8
+ * surface (ENG-30): extract candidate marks from commerce text and fan them out
9
+ * through the screening core.
10
+ */
11
+ export class Screening extends BaseResource {
12
+ /**
13
+ * Screen a single candidate name — `GET /v1/screening`.
14
+ *
15
+ * PUBLIC beta. Requires the `screening:read` scope, granted to design partners
16
+ * during beta. Returns coarse risk bands and a verdict, never a numeric score.
17
+ * Billed at 10 units per request. Not legal advice.
18
+ *
19
+ * ```typescript
20
+ * const result = await signa.screening.screen({
21
+ * q: 'KOFEE',
22
+ * nice_classes: [30, 43],
23
+ * jurisdictions: ['US', 'EU'],
24
+ * });
25
+ * // result.screening.verdict → 'clear' | 'caution' | 'needs_review' | 'high_risk'
26
+ * ```
27
+ * `needs_review` is a would-be `clear` the screen could not complete to `clear`
28
+ * standard, most often incomplete register coverage for a requested territory
29
+ * but also a stale corpus, capped horizon, failed lane, unsupported language,
30
+ * or low-confidence class inference. Inspect `result.screening.coverage` for the
31
+ * details when present (it can be absent if the coverage assessment failed).
32
+ * Pass `trademark_id` instead of `q` to screen an existing register record;
33
+ * its own collapsed family is excluded from the returned conflicts.
34
+ */
35
+ async screen(params, options) {
36
+ return this._get('/v1/screening', { ...params }, options);
37
+ }
38
+ /**
39
+ * Screen a whole LISTING — `POST /v1/screening/listings`.
40
+ *
41
+ * Deterministic + synchronous. Extracts candidate marks from `title` / `brand`
42
+ * / `description` / `keywords`, fans them out through the screening core, and
43
+ * returns a listing-level verdict with per-candidate conflicts. Billed flat at
44
+ * 25 units per listing regardless of internal fan-out. Not legal advice.
45
+ * Beta limitation: common-word listings are over-flagged, so treat `caution`
46
+ * as no-signal pending the ENG-199 verdict-separation redesign.
47
+ * Supply `nice_classes` whenever possible: caller-provided classes are the only
48
+ * high-quality class signal that may corroborate a conflict upward. If your
49
+ * platform has only a category label, derive them explicitly with
50
+ * `categoryToNiceClasses(category)` from `@signa-so/sdk`.
51
+ *
52
+ * ```typescript
53
+ * import { categoryToNiceClasses } from '@signa-so/sdk';
54
+ *
55
+ * const result = await signa.screening.checkListing({
56
+ * title: 'Vintage AirPods Case — Handmade Leather',
57
+ * nice_classes: categoryToNiceClasses('handbags'),
58
+ * });
59
+ * // result.listing.verdict → 'clear' | 'caution' | 'high_risk'
60
+ * ```
61
+ */
62
+ async checkListing(params, options) {
63
+ return this._post('/v1/screening/listings', params, options);
64
+ }
65
+ }
66
+ //# sourceMappingURL=screening.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"screening.js","sourceRoot":"","sources":["../../src/resources/screening.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAS9C;;;;;;;;GAQG;AACH,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,KAAK,CAAC,MAAM,CAAC,MAAoB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,IAAI,CAAe,eAAe,EAAE,EAAE,GAAG,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;IAC1E,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;OAuBG;IACH,KAAK,CAAC,YAAY,CAChB,MAA0B,EAC1B,OAAwB;QAExB,OAAO,IAAI,CAAC,KAAK,CAAqB,wBAAwB,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACnF,CAAC;CACF"}
@@ -1,18 +1,26 @@
1
1
  import { BaseResource } from '../resource.js';
2
2
  import { type SignaList } from '../pagination.js';
3
- import type { Trademark, TrademarkSummary, SearchV2Result, Event, TrademarkRetrieveParams, TrademarkListParams, TrademarkSearchBody, TrademarkHistoryParams, TrademarkBatchBody, TrademarkBatchResponse, TrademarkChangesParams, TrademarkChange, TrademarkRelatedParams, TrademarkRelationship, TrademarkCoverageParams, TrademarkCoverage, TrademarkProceedingsParams, TrademarkProceeding, TrademarkSource, TrademarkSuggestParams, TrademarkSuggestion, RequestOptions } from '../types.js';
3
+ import type { Trademark, TrademarkSummary, TrademarkSearchResult, Event, TrademarkRetrieveParams, TrademarkListParams, TrademarkSearchBody, TrademarkHistoryParams, TrademarkBatchBody, TrademarkBatchResponse, TrademarkChangesParams, TrademarkChange, TrademarkRelatedParams, TrademarkRelationship, TrademarkCoverageParams, TrademarkCoverage, TrademarkProceedingsParams, TrademarkProceeding, TrademarkAssignmentsParams, TrademarkAssignment, TrademarkDocumentParams, TrademarkDocument, TrademarkSource, TrademarkSuggestParams, TrademarkSuggestion, TrademarkImageSearchParams, ImageSearchResults, RequestOptions } from '../types.js';
4
+ type TrademarkWithOwners = {
5
+ owners?: Array<{
6
+ name?: string | null;
7
+ }> | null;
8
+ };
9
+ export declare function primaryOwnerName(trademark: TrademarkWithOwners): string | null;
4
10
  export declare class Trademarks extends BaseResource {
5
11
  /**
6
12
  * Retrieve a single trademark by ID.
7
13
  *
8
14
  * The full detail tier (owners, classifications, attorneys, media,
9
15
  * priorities, proceedings, Madrid coverage) is always returned inline.
10
- * Pass `include: ['history']` to embed the 50 most recent prosecution
11
- * events alongside the detail object.
16
+ * Pass `include: ['office_extensions']` to add the raw office-specific
17
+ * extension blob (omitted by default). Pass `language` to prefer matching
18
+ * goods/services classification variants without filtering unmatched groups.
12
19
  *
13
20
  * ```typescript
14
21
  * const tm = await signa.trademarks.retrieve('tm_abc123');
15
- * const tm = await signa.trademarks.retrieve('tm_abc123', { include: ['history'] });
22
+ * const tm = await signa.trademarks.retrieve('tm_abc123', { include: ['office_extensions'] });
23
+ * const tm = await signa.trademarks.retrieve('tm_abc123', { language: 'en' });
16
24
  * ```
17
25
  */
18
26
  retrieve(id: string, params?: TrademarkRetrieveParams, options?: RequestOptions): Promise<Trademark>;
@@ -31,7 +39,7 @@ export declare class Trademarks extends BaseResource {
31
39
  * const results = await signa.trademarks.list({ q: 'SIGNA', jurisdictions: ['US'] });
32
40
  *
33
41
  * // Explicit sort
34
- * const sorted = await signa.trademarks.list({ offices: ['uspto'], sort: '-registration_date' });
42
+ * const sorted = await signa.trademarks.list({ offices: ['US'], sort: '-registration_date' });
35
43
  *
36
44
  * // Auto-pagination
37
45
  * for await (const tm of signa.trademarks.list({ jurisdictions: ['US'] })) {
@@ -59,13 +67,34 @@ export declare class Trademarks extends BaseResource {
59
67
  *
60
68
  * // Filter-only POST (no text query)
61
69
  * const filtered = await signa.trademarks.search({
62
- * filters: { offices: ['uspto'], status_primary: 'active' },
70
+ * filters: { offices: ['US'], status_primary: 'active' },
63
71
  * sort: '-filing_date',
64
72
  * options: { include_total: true },
65
73
  * });
66
74
  * ```
67
75
  */
68
- search(params: TrademarkSearchBody, options?: RequestOptions): Promise<SignaList<SearchV2Result>>;
76
+ search(params: TrademarkSearchBody, options?: RequestOptions): Promise<SignaList<TrademarkSearchResult>>;
77
+ /**
78
+ * Search trademarks by logo/image similarity (beta, internal). Requires the
79
+ * `image-search:read` scope. Provide EXACTLY ONE image source:
80
+ * - `image`: raw bytes (multipart upload — Blob / ArrayBuffer / Uint8Array)
81
+ * - `image_url`: an https URL (fetched + SSRF-guarded server-side)
82
+ * - `media_id`: an existing mark's media id (reuses its stored vector)
83
+ *
84
+ * Returns mark-level hits, each with the §3.5 signal channels + a
85
+ * `thumbnail_url`. Results are a bounded top-K (limit ≤ 100, not paginable).
86
+ *
87
+ * ```typescript
88
+ * const bytes = await fs.readFile('logo.png');
89
+ * const res = await signa.trademarks.searchByImage({
90
+ * image: bytes,
91
+ * filters: { offices: ['US'], nice_classes: [9] },
92
+ * channels: ['visual', 'exact_dup'],
93
+ * });
94
+ * for (const hit of res.data) console.log(hit.trademark.mark_text, hit.band);
95
+ * ```
96
+ */
97
+ searchByImage(params: TrademarkImageSearchParams, options?: RequestOptions): Promise<ImageSearchResults>;
69
98
  /**
70
99
  * List event history for a trademark.
71
100
  *
@@ -81,7 +110,7 @@ export declare class Trademarks extends BaseResource {
81
110
  * ```typescript
82
111
  * const result = await signa.trademarks.batch({ ids: ['tm_abc', 'tm_def'] });
83
112
  * const result = await signa.trademarks.batch({
84
- * identifiers: [{ application_number: '97123456', office: 'uspto' }],
113
+ * identifiers: [{ application_number: '97123456', office: 'US' }],
85
114
  * });
86
115
  * ```
87
116
  */
@@ -116,7 +145,12 @@ export declare class Trademarks extends BaseResource {
116
145
  coverage(id: string, params?: TrademarkCoverageParams, options?: RequestOptions): Promise<SignaList<TrademarkCoverage>>;
117
146
  /** Proceedings (oppositions, cancellations) linked to a trademark. */
118
147
  proceedings(id: string, params?: TrademarkProceedingsParams, options?: RequestOptions): Promise<SignaList<TrademarkProceeding>>;
148
+ /** Recorded assignment chain of title linked to a trademark. */
149
+ assignments(id: string, params?: TrademarkAssignmentsParams, options?: RequestOptions): Promise<SignaList<TrademarkAssignment>>;
150
+ /** Office documents linked to a trademark. */
151
+ documents(id: string, params?: TrademarkDocumentParams, options?: RequestOptions): Promise<SignaList<TrademarkDocument>>;
119
152
  /** Get the redirect URL for a trademark media asset (image, sound, etc). */
120
153
  media(id: string, mediaId: string, options?: RequestOptions): Promise<string>;
121
154
  }
155
+ export {};
122
156
  //# sourceMappingURL=trademarks.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"trademarks.d.ts","sourceRoot":"","sources":["../../src/resources/trademarks.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,gBAAgB,EAChB,cAAc,EACd,KAAK,EACL,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,EACnB,sBAAsB,EACtB,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,EAC1B,mBAAmB,EACnB,eAAe,EACf,sBAAsB,EACtB,mBAAmB,EACnB,cAAc,EAEf,MAAM,aAAa,CAAC;AAErB,qBAAa,UAAW,SAAQ,YAAY;IAC1C;;;;;;;;;;;;OAYG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;IAOrB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAQvC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,MAAM,CACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;IAiBrC;;;;;;;OAOG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,sBAAsB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAa5B;;;;;;;;;OASG;IACG,KAAK,CACT,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,sBAAsB,CAAC;IAIlC;;;;;;OAMG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,sBAAsB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAgBtC;;;;;;OAMG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,sBAAsB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAgB5C;;;;;;OAMG;IACG,OAAO,CACX,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;IAW1C,kDAAkD;IAC5C,MAAM,CACV,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC;IAS3B,oEAAoE;IAC9D,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAgBxC,sEAAsE;IAChE,WAAW,CACf,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,0BAA0B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;IAgB1C,4EAA4E;IACtE,KAAK,CACT,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;CAQnB"}
1
+ {"version":3,"file":"trademarks.d.ts","sourceRoot":"","sources":["../../src/resources/trademarks.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,gBAAgB,EAChB,qBAAqB,EACrB,KAAK,EACL,uBAAuB,EACvB,mBAAmB,EACnB,mBAAmB,EACnB,sBAAsB,EACtB,kBAAkB,EAClB,sBAAsB,EACtB,sBAAsB,EACtB,eAAe,EACf,sBAAsB,EACtB,qBAAqB,EACrB,uBAAuB,EACvB,iBAAiB,EACjB,0BAA0B,EAC1B,mBAAmB,EACnB,0BAA0B,EAC1B,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,eAAe,EACf,sBAAsB,EACtB,mBAAmB,EACnB,0BAA0B,EAC1B,kBAAkB,EAClB,cAAc,EAEf,MAAM,aAAa,CAAC;AAErB,KAAK,mBAAmB,GAAG;IACzB,MAAM,CAAC,EAAE,KAAK,CAAC;QAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;KAAE,CAAC,GAAG,IAAI,CAAC;CACjD,CAAC;AAEF,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,mBAAmB,GAAG,MAAM,GAAG,IAAI,CAE9E;AAED,qBAAa,UAAW,SAAQ,YAAY;IAC1C;;;;;;;;;;;;;;OAcG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC;IASrB;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,mBAAmB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAQvC;;;;;;;;;;;;;;;;;;;;;;;;OAwBG;IACG,MAAM,CACV,MAAM,EAAE,mBAAmB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAiB5C;;;;;;;;;;;;;;;;;;;OAmBG;IACG,aAAa,CACjB,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,kBAAkB,CAAC;IA+B9B;;;;;;;OAOG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,sBAAsB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAa5B;;;;;;;;;OASG;IACG,KAAK,CACT,IAAI,EAAE,kBAAkB,EACxB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,sBAAsB,CAAC;IAIlC;;;;;;OAMG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,sBAAsB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAgBtC;;;;;;OAMG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,sBAAsB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;IAgB5C;;;;;;OAMG;IACG,OAAO,CACX,MAAM,EAAE,sBAAsB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;IAW1C,kDAAkD;IAC5C,MAAM,CACV,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,eAAe,CAAC;IAS3B,oEAAoE;IAC9D,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAgBxC,sEAAsE;IAChE,WAAW,CACf,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,0BAA0B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;IAgB1C,gEAAgE;IAC1D,WAAW,CACf,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,0BAA0B,EACnC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;IAgB1C,8CAA8C;IACxC,SAAS,CACb,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,uBAAuB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,iBAAiB,CAAC,CAAC;IAgBxC,4EAA4E;IACtE,KAAK,CACT,EAAE,EAAE,MAAM,EACV,OAAO,EAAE,MAAM,EACf,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,MAAM,CAAC;CAQnB"}