@signa-so/sdk 0.2.1 → 0.4.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.
- package/README.md +21 -13
- package/dist/_internals/fetch-with-retry.js +1 -1
- package/dist/_internals/fetch-with-retry.js.map +1 -1
- package/dist/_internals/query-string.d.ts +5 -4
- package/dist/_internals/query-string.d.ts.map +1 -1
- package/dist/_internals/query-string.js +6 -14
- package/dist/_internals/query-string.js.map +1 -1
- package/dist/client.d.ts +54 -10
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +76 -13
- package/dist/client.js.map +1 -1
- package/dist/errors.d.ts +7 -0
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +10 -1
- package/dist/errors.js.map +1 -1
- package/dist/generated/api-types.d.ts +3608 -2393
- package/dist/generated/api-types.d.ts.map +1 -1
- package/dist/index.d.ts +3 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +2 -0
- package/dist/index.js.map +1 -1
- package/dist/pagination.d.ts +1 -1
- package/dist/pagination.js +1 -1
- package/dist/resources/alerts.d.ts +18 -13
- package/dist/resources/alerts.d.ts.map +1 -1
- package/dist/resources/alerts.js +29 -19
- package/dist/resources/alerts.js.map +1 -1
- package/dist/resources/attorneys.d.ts +5 -2
- package/dist/resources/attorneys.d.ts.map +1 -1
- package/dist/resources/attorneys.js +6 -5
- package/dist/resources/attorneys.js.map +1 -1
- package/dist/resources/entities.d.ts +52 -0
- package/dist/resources/entities.d.ts.map +1 -0
- package/dist/resources/entities.js +70 -0
- package/dist/resources/entities.js.map +1 -0
- package/dist/resources/firms.d.ts +5 -5
- package/dist/resources/firms.js +5 -5
- package/dist/resources/goods-services.d.ts +56 -0
- package/dist/resources/goods-services.d.ts.map +1 -0
- package/dist/resources/goods-services.js +60 -0
- package/dist/resources/goods-services.js.map +1 -0
- package/dist/resources/{platform.d.ts → organization.d.ts} +24 -3
- package/dist/resources/organization.d.ts.map +1 -0
- package/dist/resources/organization.js +81 -0
- package/dist/resources/organization.js.map +1 -0
- package/dist/resources/owners.d.ts +5 -2
- package/dist/resources/owners.d.ts.map +1 -1
- package/dist/resources/owners.js +6 -5
- package/dist/resources/owners.js.map +1 -1
- package/dist/resources/portfolios.d.ts +3 -3
- package/dist/resources/portfolios.d.ts.map +1 -1
- package/dist/resources/portfolios.js +4 -4
- package/dist/resources/portfolios.js.map +1 -1
- package/dist/resources/proceedings.d.ts +1 -1
- package/dist/resources/proceedings.js +1 -1
- package/dist/resources/references.d.ts +51 -12
- package/dist/resources/references.d.ts.map +1 -1
- package/dist/resources/references.js +33 -15
- package/dist/resources/references.js.map +1 -1
- package/dist/resources/suggest.d.ts +16 -0
- package/dist/resources/suggest.d.ts.map +1 -0
- package/dist/resources/suggest.js +18 -0
- package/dist/resources/suggest.js.map +1 -0
- package/dist/resources/trademarks.d.ts +47 -5
- package/dist/resources/trademarks.d.ts.map +1 -1
- package/dist/resources/trademarks.js +53 -5
- package/dist/resources/trademarks.js.map +1 -1
- package/dist/resources/watches.d.ts +56 -9
- package/dist/resources/watches.d.ts.map +1 -1
- package/dist/resources/watches.js +91 -12
- package/dist/resources/watches.js.map +1 -1
- package/dist/resources/webhooks.d.ts +57 -0
- package/dist/resources/webhooks.d.ts.map +1 -0
- package/dist/resources/webhooks.js +86 -0
- package/dist/resources/webhooks.js.map +1 -0
- package/dist/types.d.ts +1163 -213
- package/dist/types.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/dist/webhooks.d.ts +57 -0
- package/dist/webhooks.d.ts.map +1 -0
- package/dist/webhooks.js +76 -0
- package/dist/webhooks.js.map +1 -0
- package/package.json +7 -2
- package/dist/resources/platform.d.ts.map +0 -1
- package/dist/resources/platform.js +0 -50
- package/dist/resources/platform.js.map +0 -1
- package/dist/resources/search.d.ts +0 -27
- package/dist/resources/search.d.ts.map +0 -1
- package/dist/resources/search.js +0 -36
- package/dist/resources/search.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -2,5 +2,7 @@ export { Signa } from './client.js';
|
|
|
2
2
|
export { Signa as default } from './client.js';
|
|
3
3
|
export { SignaError, SignaAPIError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, RateLimitError, InternalServerError, ConnectionError, TimeoutError, } from './errors.js';
|
|
4
4
|
export { SignaList } from './pagination.js';
|
|
5
|
-
export
|
|
5
|
+
export { verifyWebhookSignature } from './webhooks.js';
|
|
6
|
+
export type { WebhookSignatureHeaders } from './webhooks.js';
|
|
7
|
+
export type { Trademark, TrademarkSummary, Event, Owner, OwnerSummary, EntitySummary, EntityDetail, EntityMember, EntityMemberLink, EntityCompany, EntityFamily, EntityFamilyNode, Attorney, AttorneySummary, Firm, FirmSummary, Proceeding, ProceedingDetail, SearchV2Result, CrossEntitySuggestion, Classification, ClassificationDetail, AcceptedTerm, ClassificationSuggestionLite, ClassificationSuggestResult, GoodsServicesSuggestionClass, GoodsServicesSuggestResult, GoodsServicesTerm, Office, OfficeDetail, Jurisdiction, JurisdictionDetail, DeadlineRule, OppositionRule, RuleSource, Status, EventType, DesignCode, DesignCodeDetail, TrademarkSource, TrademarkCoverage, TrademarkProceeding, OwnerRelated, Portfolio, SavedSearch, Watch, WatchType, WatchStatus, WatchDeliveryMode, WatchTriggerEvent, WatchQuery, WatchPreviewResponse, WatchDiagnostics, WatchDiagnosticsLeaseState, WatchDiagnosticsWindowStatus, Alert, AlertEventType, AlertSeverity, OppositionWindowStatus, Webhook, WebhookDisabledReason, WebhookEvent, WebhookEventType, WebhookStatus, WebhookDelivery, WebhookDeliveryStatus, WebhookTestResponse, WebhookRedeliveryResponse, AlertCreatedPayload, AlertCreatedEvent, OrgEvent, OrgEventDetail, Identity, Usage, ApiKey, ApiKeyWithRawKey, RequestLog, RequestLogDetail, UsageSummaryResponse, UsageSummaryItem, UsageBillingPeriod, DeletedResponse, SearchMeta, APIErrorBody, AttorneyStats, OwnerStats, FirmStats, TrademarkBatchBody, TrademarkBatchResponse, TrademarkChange, TrademarkRelationship, TrademarkSuggestion, AttorneyClient, TrademarkRetrieveParams, TrademarkListParams, TrademarkHistoryParams, TrademarkChangesParams, TrademarkRelatedParams, TrademarkSuggestParams, TrademarkCoverageParams, TrademarkProceedingsParams, OwnerRetrieveParams, OwnerListParams, OwnerTrademarksParams, OwnerRelatedParams, EntityRetrieveParams, EntityListParams, EntityTrademarksParams, EntityFamilyParams, AttorneyRetrieveParams, AttorneyListParams, AttorneyTrademarksParams, AttorneyClientsParams, FirmRetrieveParams, FirmListParams, FirmAttorneysParams, FirmTrademarksParams, ProceedingListParams, TrademarkSearchBody, SearchV2Body, CrossEntitySuggestParams, ClassificationListParams, ClassificationSuggestParams, DesignCodeListParams, GoodsServicesListParams, GoodsServicesSuggestParams, PortfolioCreateParams, PortfolioUpdateParams, PortfolioListParams, PortfolioRetrieveParams, PortfolioAddTrademarksBody, PortfolioRemoveTrademarksBody, PortfolioDeadlineParams, PortfolioDeadlinesIcalParams, SavedSearchCreateParams, SavedSearchUpdateParams, SavedSearchListParams, SavedSearchExecuteParams, WatchCreateParams, WatchCreateQueryParams, WatchUpdateParams, WatchListParams, WatchReplayParams, WatchPreviewParams, WatchBulkParams, WatchDiagnosticsParams, AlertListParams, AlertLookupParams, WebhookCreateParams, WebhookUpdateParams, WebhookListParams, WebhookDeliveryListParams, OrgEventListParams, ApiKeyCreateParams, ApiKeyUpdateParams, LogListParams, UsageSummaryParams, RequestOptions, ClientOptions, } from './types.js';
|
|
6
8
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,KAAK,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC;AAG/C,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,YAAY,GACb,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,YAAY,EAEV,SAAS,EACT,gBAAgB,EAChB,KAAK,EACL,KAAK,EACL,YAAY,EACZ,QAAQ,EACR,eAAe,EACf,IAAI,EACJ,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,iBAAiB,EACjB,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,KAAK,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC;AAG/C,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,YAAY,GACb,MAAM,aAAa,CAAC;AAGrB,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAG5C,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC;AACvD,YAAY,EAAE,uBAAuB,EAAE,MAAM,eAAe,CAAC;AAG7D,YAAY,EAEV,SAAS,EACT,gBAAgB,EAChB,KAAK,EACL,KAAK,EACL,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,QAAQ,EACR,eAAe,EACf,IAAI,EACJ,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,cAAc,EACd,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,YAAY,EACZ,4BAA4B,EAC5B,2BAA2B,EAC3B,4BAA4B,EAC5B,0BAA0B,EAC1B,iBAAiB,EACjB,MAAM,EACN,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,cAAc,EACd,UAAU,EACV,MAAM,EACN,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,SAAS,EACT,WAAW,EACX,KAAK,EACL,SAAS,EACT,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,UAAU,EACV,oBAAoB,EACpB,gBAAgB,EAChB,0BAA0B,EAC1B,4BAA4B,EAC5B,KAAK,EACL,cAAc,EACd,aAAa,EACb,sBAAsB,EACtB,OAAO,EACP,qBAAqB,EACrB,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,mBAAmB,EACnB,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,QAAQ,EACR,KAAK,EACL,MAAM,EACN,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,eAAe,EACf,UAAU,EACV,YAAY,EAEZ,aAAa,EACb,UAAU,EACV,SAAS,EAET,kBAAkB,EAClB,sBAAsB,EACtB,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,cAAc,EACd,uBAAuB,EACvB,mBAAmB,EACnB,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACtB,sBAAsB,EACtB,uBAAuB,EACvB,0BAA0B,EAE1B,mBAAmB,EACnB,eAAe,EACf,qBAAqB,EACrB,kBAAkB,EAClB,oBAAoB,EACpB,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,sBAAsB,EACtB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EACnB,oBAAoB,EACpB,oBAAoB,EAEpB,mBAAmB,EACnB,YAAY,EACZ,wBAAwB,EAExB,wBAAwB,EACxB,2BAA2B,EAC3B,oBAAoB,EAEpB,uBAAuB,EACvB,0BAA0B,EAE1B,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,uBAAuB,EACvB,0BAA0B,EAC1B,6BAA6B,EAC7B,uBAAuB,EACvB,4BAA4B,EAE5B,uBAAuB,EACvB,uBAAuB,EACvB,qBAAqB,EACrB,wBAAwB,EAExB,iBAAiB,EACjB,sBAAsB,EACtB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,kBAAkB,EAClB,eAAe,EACf,sBAAsB,EAEtB,eAAe,EACf,iBAAiB,EAEjB,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,yBAAyB,EAEzB,kBAAkB,EAElB,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACb,kBAAkB,EAElB,cAAc,EACd,aAAa,GACd,MAAM,YAAY,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -4,4 +4,6 @@ export { Signa as default } from './client.js';
|
|
|
4
4
|
export { SignaError, SignaAPIError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, RateLimitError, InternalServerError, ConnectionError, TimeoutError, } from './errors.js';
|
|
5
5
|
// ── Pagination ──────────────────────────────────────────────────────
|
|
6
6
|
export { SignaList } from './pagination.js';
|
|
7
|
+
// ── Webhooks helper ─────────────────────────────────────────────────
|
|
8
|
+
export { verifyWebhookSignature } from './webhooks.js';
|
|
7
9
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,KAAK,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC;AAE/C,uEAAuE;AACvE,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,YAAY,GACb,MAAM,aAAa,CAAC;AAErB,uEAAuE;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACpC,OAAO,EAAE,KAAK,IAAI,OAAO,EAAE,MAAM,aAAa,CAAC;AAE/C,uEAAuE;AACvE,OAAO,EACL,UAAU,EACV,aAAa,EACb,eAAe,EACf,mBAAmB,EACnB,eAAe,EACf,aAAa,EACb,aAAa,EACb,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,YAAY,GACb,MAAM,aAAa,CAAC;AAErB,uEAAuE;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,uEAAuE;AACvE,OAAO,EAAE,sBAAsB,EAAE,MAAM,eAAe,CAAC"}
|
package/dist/pagination.d.ts
CHANGED
|
@@ -36,7 +36,7 @@ export declare class SignaList<T> implements AsyncIterable<T> {
|
|
|
36
36
|
* Async iterator that yields items across all pages.
|
|
37
37
|
*
|
|
38
38
|
* ```typescript
|
|
39
|
-
* for await (const trademark of signa.trademarks.list({
|
|
39
|
+
* for await (const trademark of signa.trademarks.list({ jurisdictions: ['US'] })) {
|
|
40
40
|
* console.log(trademark.mark_text);
|
|
41
41
|
* }
|
|
42
42
|
* ```
|
package/dist/pagination.js
CHANGED
|
@@ -55,7 +55,7 @@ export class SignaList {
|
|
|
55
55
|
* Async iterator that yields items across all pages.
|
|
56
56
|
*
|
|
57
57
|
* ```typescript
|
|
58
|
-
* for await (const trademark of signa.trademarks.list({
|
|
58
|
+
* for await (const trademark of signa.trademarks.list({ jurisdictions: ['US'] })) {
|
|
59
59
|
* console.log(trademark.mark_text);
|
|
60
60
|
* }
|
|
61
61
|
* ```
|
|
@@ -1,20 +1,25 @@
|
|
|
1
1
|
import { BaseResource } from '../resource.js';
|
|
2
2
|
import { type SignaList } from '../pagination.js';
|
|
3
|
-
import type { Alert, AlertListParams,
|
|
3
|
+
import type { Alert, AlertListParams, RequestOptions } from '../types.js';
|
|
4
|
+
/**
|
|
5
|
+
* Alert operations — monitoring v1 (TSK-111).
|
|
6
|
+
*
|
|
7
|
+
* **Read-only.** Alerts are immutable in the canonical layer (VAL-API-018b).
|
|
8
|
+
* The legacy `acknowledge` / `dismiss` / batch routes were removed in
|
|
9
|
+
* Phase 4. Customers track open work in their own systems (or our
|
|
10
|
+
* dashboard's saved-view layer); the canonical alert is the immutable
|
|
11
|
+
* fact of "this watch matched this trademark version at this time."
|
|
12
|
+
*/
|
|
4
13
|
export declare class Alerts extends BaseResource {
|
|
5
|
-
/** List
|
|
14
|
+
/** List alerts for the calling org (cursor pagination, max 100/page). */
|
|
6
15
|
list(params?: AlertListParams, options?: RequestOptions): Promise<SignaList<Alert>>;
|
|
7
|
-
/** Retrieve
|
|
16
|
+
/** Retrieve a single alert. */
|
|
8
17
|
retrieve(id: string, options?: RequestOptions): Promise<Alert>;
|
|
9
|
-
/**
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
/** Batch update alert statuses. */
|
|
16
|
-
batchUpdate(body: AlertBatchUpdateBody, options?: RequestOptions): Promise<{
|
|
17
|
-
updated: number;
|
|
18
|
-
}>;
|
|
18
|
+
/**
|
|
19
|
+
* Bulk-fetch alerts by ID (max 100). Useful for polling clients that
|
|
20
|
+
* want to confirm a batch of `webhook-id` values. Org-scoped — alerts
|
|
21
|
+
* belonging to other orgs are silently dropped from the result.
|
|
22
|
+
*/
|
|
23
|
+
lookup(ids: string[], options?: RequestOptions): Promise<Alert[]>;
|
|
19
24
|
}
|
|
20
25
|
//# sourceMappingURL=alerts.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../../src/resources/alerts.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,eAAe,
|
|
1
|
+
{"version":3,"file":"alerts.d.ts","sourceRoot":"","sources":["../../src/resources/alerts.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,eAAe,EAEf,cAAc,EACf,MAAM,aAAa,CAAC;AAErB;;;;;;;;GAQG;AACH,qBAAa,MAAO,SAAQ,YAAY;IACtC,yEAAyE;IACnE,IAAI,CAAC,MAAM,CAAC,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;IAOzF,+BAA+B;IACzB,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,CAAC;IAKpE;;;;OAIG;IACG,MAAM,CAAC,GAAG,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,KAAK,EAAE,CAAC;CAaxE"}
|
package/dist/resources/alerts.js
CHANGED
|
@@ -1,30 +1,40 @@
|
|
|
1
1
|
import { BaseResource } from '../resource.js';
|
|
2
2
|
import { createList } from '../pagination.js';
|
|
3
|
+
/**
|
|
4
|
+
* Alert operations — monitoring v1 (TSK-111).
|
|
5
|
+
*
|
|
6
|
+
* **Read-only.** Alerts are immutable in the canonical layer (VAL-API-018b).
|
|
7
|
+
* The legacy `acknowledge` / `dismiss` / batch routes were removed in
|
|
8
|
+
* Phase 4. Customers track open work in their own systems (or our
|
|
9
|
+
* dashboard's saved-view layer); the canonical alert is the immutable
|
|
10
|
+
* fact of "this watch matched this trademark version at this time."
|
|
11
|
+
*/
|
|
3
12
|
export class Alerts extends BaseResource {
|
|
4
|
-
/** List
|
|
13
|
+
/** List alerts for the calling org (cursor pagination, max 100/page). */
|
|
5
14
|
async list(params, options) {
|
|
6
|
-
const
|
|
7
|
-
|
|
15
|
+
const fetchPage = async (cursor) => this._getListResponse('/v1/alerts', { ...params, cursor }, options);
|
|
16
|
+
const firstPage = await fetchPage(params?.cursor);
|
|
17
|
+
return createList(firstPage, fetchPage);
|
|
8
18
|
}
|
|
9
|
-
/** Retrieve
|
|
19
|
+
/** Retrieve a single alert. */
|
|
10
20
|
async retrieve(id, options) {
|
|
21
|
+
this._validateId(id);
|
|
11
22
|
return this._get(`/v1/alerts/${encodeURIComponent(id)}`, undefined, options);
|
|
12
23
|
}
|
|
13
|
-
/**
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
async
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
return this._post('/v1/alerts/batch', body, options);
|
|
24
|
+
/**
|
|
25
|
+
* Bulk-fetch alerts by ID (max 100). Useful for polling clients that
|
|
26
|
+
* want to confirm a batch of `webhook-id` values. Org-scoped — alerts
|
|
27
|
+
* belonging to other orgs are silently dropped from the result.
|
|
28
|
+
*/
|
|
29
|
+
async lookup(ids, options) {
|
|
30
|
+
if (!Array.isArray(ids) || ids.length === 0)
|
|
31
|
+
return [];
|
|
32
|
+
if (ids.length > 100) {
|
|
33
|
+
throw new Error('alerts.lookup() accepts at most 100 IDs per call.');
|
|
34
|
+
}
|
|
35
|
+
const body = { ids };
|
|
36
|
+
const res = await this._post('/v1/alerts/lookup', body, options);
|
|
37
|
+
return res.data;
|
|
28
38
|
}
|
|
29
39
|
}
|
|
30
40
|
//# sourceMappingURL=alerts.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../../src/resources/alerts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;
|
|
1
|
+
{"version":3,"file":"alerts.js","sourceRoot":"","sources":["../../src/resources/alerts.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAQ9D;;;;;;;;GAQG;AACH,MAAM,OAAO,MAAO,SAAQ,YAAY;IACtC,yEAAyE;IACzE,KAAK,CAAC,IAAI,CAAC,MAAwB,EAAE,OAAwB;QAC3D,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE,CAC1C,IAAI,CAAC,gBAAgB,CAAQ,YAAY,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC7E,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;IAED,+BAA+B;IAC/B,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAwB;QACjD,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;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,GAAa,EAAE,OAAwB;QAClD,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO,EAAE,CAAC;QACvD,IAAI,GAAG,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,mDAAmD,CAAC,CAAC;QACvE,CAAC;QACD,MAAM,IAAI,GAAsB,EAAE,GAAG,EAAE,CAAC;QACxC,MAAM,GAAG,GAAG,MAAM,IAAI,CAAC,KAAK,CAC1B,mBAAmB,EACnB,IAAI,EACJ,OAAO,CACR,CAAC;QACF,OAAO,GAAG,CAAC,IAAI,CAAC;IAClB,CAAC;CACF"}
|
|
@@ -5,12 +5,15 @@ export declare class Attorneys extends BaseResource {
|
|
|
5
5
|
/**
|
|
6
6
|
* Retrieve a single attorney by ID.
|
|
7
7
|
*
|
|
8
|
+
* Always returns the full detail tier: canonical name, firm linkage,
|
|
9
|
+
* country, address, aliases, identifiers, and scalar stats when computed.
|
|
10
|
+
* There are no optional `include` relations on attorney detail.
|
|
11
|
+
*
|
|
8
12
|
* ```typescript
|
|
9
13
|
* const attorney = await signa.attorneys.retrieve('att_abc123');
|
|
10
|
-
* const attorney = await signa.attorneys.retrieve('att_abc123', { include: ['recent_trademarks', 'stats', 'specializations'] });
|
|
11
14
|
* ```
|
|
12
15
|
*/
|
|
13
|
-
retrieve(id: string,
|
|
16
|
+
retrieve(id: string, _params?: AttorneyRetrieveParams, options?: RequestOptions): Promise<Attorney>;
|
|
14
17
|
/**
|
|
15
18
|
* List attorneys with optional search and filters.
|
|
16
19
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"attorneys.d.ts","sourceRoot":"","sources":["../../src/resources/attorneys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,SAAU,SAAQ,YAAY;IACzC
|
|
1
|
+
{"version":3,"file":"attorneys.d.ts","sourceRoot":"","sources":["../../src/resources/attorneys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,QAAQ,EACR,eAAe,EACf,cAAc,EACd,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,wBAAwB,EACxB,qBAAqB,EACrB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;OAUG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,sBAAsB,EAChC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,QAAQ,CAAC;IAKpB;;;;;;OAMG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAQtC;;;;;;OAMG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,wBAAwB,EACjC,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAavC;;;;;;OAMG;IACG,OAAO,CACX,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,qBAAqB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,cAAc,CAAC,CAAC;CAetC"}
|
|
@@ -4,16 +4,17 @@ export class Attorneys extends BaseResource {
|
|
|
4
4
|
/**
|
|
5
5
|
* Retrieve a single attorney by ID.
|
|
6
6
|
*
|
|
7
|
+
* Always returns the full detail tier: canonical name, firm linkage,
|
|
8
|
+
* country, address, aliases, identifiers, and scalar stats when computed.
|
|
9
|
+
* There are no optional `include` relations on attorney detail.
|
|
10
|
+
*
|
|
7
11
|
* ```typescript
|
|
8
12
|
* const attorney = await signa.attorneys.retrieve('att_abc123');
|
|
9
|
-
* const attorney = await signa.attorneys.retrieve('att_abc123', { include: ['recent_trademarks', 'stats', 'specializations'] });
|
|
10
13
|
* ```
|
|
11
14
|
*/
|
|
12
|
-
async retrieve(id,
|
|
15
|
+
async retrieve(id, _params, options) {
|
|
13
16
|
this._validateId(id);
|
|
14
|
-
return this._get(`/v1/attorneys/${encodeURIComponent(id)}`,
|
|
15
|
-
include: params?.include,
|
|
16
|
-
}, options);
|
|
17
|
+
return this._get(`/v1/attorneys/${encodeURIComponent(id)}`, undefined, options);
|
|
17
18
|
}
|
|
18
19
|
/**
|
|
19
20
|
* List attorneys with optional search and filters.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"attorneys.js","sourceRoot":"","sources":["../../src/resources/attorneys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAa9D,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC
|
|
1
|
+
{"version":3,"file":"attorneys.js","sourceRoot":"","sources":["../../src/resources/attorneys.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAa9D,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,OAAgC,EAChC,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAW,iBAAiB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;OAMG;IACH,KAAK,CAAC,IAAI,CACR,MAA2B,EAC3B,OAAwB;QAExB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAkB,eAAe,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QACjG,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,MAAiC,EACjC,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAC1B,iBAAiB,kBAAkB,CAAC,EAAE,CAAC,aAAa,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;;;;;;OAMG;IACH,KAAK,CAAC,OAAO,CACX,EAAU,EACV,MAA8B,EAC9B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAC1C,iBAAiB,kBAAkB,CAAC,EAAE,CAAC,UAAU,EACjD,MAAiC,EACjC,OAAO,CACR,CAAC;QACF,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,IAAI,CAAC,gBAAgB,CACnB,iBAAiB,kBAAkB,CAAC,EAAE,CAAC,UAAU,EACjD,EAAE,GAAG,MAAM,EAAE,MAAM,EAA6B,EAChD,OAAO,CACR,CACF,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { type SignaList } from '../pagination.js';
|
|
3
|
+
import type { EntityDetail, EntitySummary, EntityFamily, TrademarkSummary, EntityRetrieveParams, EntityListParams, EntityTrademarksParams, EntityFamilyParams, RequestOptions } from '../types.js';
|
|
4
|
+
/**
|
|
5
|
+
* Resolved entities (PLN-118 "link, don't merge") — the cross-office identity
|
|
6
|
+
* layer over per-office owner clusters. An `ent_*` id is either a RESOLVED
|
|
7
|
+
* (materialized) entity or a DERIVED `ent_<owner-uuid>` singleton; the API
|
|
8
|
+
* resolves both, so a derived id of a since-linked owner returns the real
|
|
9
|
+
* entity (its `id` may differ from the one requested).
|
|
10
|
+
*/
|
|
11
|
+
export declare class Entities extends BaseResource {
|
|
12
|
+
/**
|
|
13
|
+
* Retrieve a single entity by ID.
|
|
14
|
+
*
|
|
15
|
+
* Resolved entities embed `members[]` with per-link evidence; derived
|
|
16
|
+
* singletons carry a member-of-one. Passing a derived `ent_<owner-uuid>` for
|
|
17
|
+
* an owner that has since been linked resolves to the real entity.
|
|
18
|
+
*
|
|
19
|
+
* ```typescript
|
|
20
|
+
* const entity = await signa.entities.retrieve('ent_abc123');
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
retrieve(id: string, _params?: EntityRetrieveParams, options?: RequestOptions): Promise<EntityDetail>;
|
|
24
|
+
/**
|
|
25
|
+
* List + search resolved entities. OpenSearch-backed for both text and
|
|
26
|
+
* filter-only queries.
|
|
27
|
+
*
|
|
28
|
+
* ```typescript
|
|
29
|
+
* const entities = await signa.entities.list({ q: '8x8', publicly_traded: true });
|
|
30
|
+
* ```
|
|
31
|
+
*/
|
|
32
|
+
list(params?: EntityListParams, options?: RequestOptions): Promise<SignaList<EntitySummary>>;
|
|
33
|
+
/**
|
|
34
|
+
* List trademarks across ALL member owners of the entity (summary tier).
|
|
35
|
+
*
|
|
36
|
+
* ```typescript
|
|
37
|
+
* const tms = await signa.entities.trademarks('ent_abc123', { status_primary: 'active' });
|
|
38
|
+
* ```
|
|
39
|
+
*/
|
|
40
|
+
trademarks(id: string, params?: EntityTrademarksParams, options?: RequestOptions): Promise<SignaList<TrademarkSummary>>;
|
|
41
|
+
/**
|
|
42
|
+
* GLEIF-curated direct family — parent + direct children (1 level). Sourced
|
|
43
|
+
* from GLEIF Level 2; an absent edge does not imply no relationship (see the
|
|
44
|
+
* response `coverage_caveat`).
|
|
45
|
+
*
|
|
46
|
+
* ```typescript
|
|
47
|
+
* const family = await signa.entities.family('ent_abc123');
|
|
48
|
+
* ```
|
|
49
|
+
*/
|
|
50
|
+
family(id: string, _params?: EntityFamilyParams, options?: RequestOptions): Promise<EntityFamily>;
|
|
51
|
+
}
|
|
52
|
+
//# sourceMappingURL=entities.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"entities.d.ts","sourceRoot":"","sources":["../../src/resources/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,sBAAsB,EACtB,kBAAkB,EAClB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,YAAY;IACxC;;;;;;;;;;OAUG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,oBAAoB,EAC9B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC;IAKxB;;;;;;;OAOG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,gBAAgB,EACzB,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,aAAa,CAAC,CAAC;IAQpC;;;;;;OAMG;IACG,UAAU,CACd,EAAE,EAAE,MAAM,EACV,MAAM,CAAC,EAAE,sBAAsB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,gBAAgB,CAAC,CAAC;IAavC;;;;;;;;OAQG;IACG,MAAM,CACV,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,kBAAkB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,YAAY,CAAC;CAIzB"}
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { createList } from '../pagination.js';
|
|
3
|
+
/**
|
|
4
|
+
* Resolved entities (PLN-118 "link, don't merge") — the cross-office identity
|
|
5
|
+
* layer over per-office owner clusters. An `ent_*` id is either a RESOLVED
|
|
6
|
+
* (materialized) entity or a DERIVED `ent_<owner-uuid>` singleton; the API
|
|
7
|
+
* resolves both, so a derived id of a since-linked owner returns the real
|
|
8
|
+
* entity (its `id` may differ from the one requested).
|
|
9
|
+
*/
|
|
10
|
+
export class Entities extends BaseResource {
|
|
11
|
+
/**
|
|
12
|
+
* Retrieve a single entity by ID.
|
|
13
|
+
*
|
|
14
|
+
* Resolved entities embed `members[]` with per-link evidence; derived
|
|
15
|
+
* singletons carry a member-of-one. Passing a derived `ent_<owner-uuid>` for
|
|
16
|
+
* an owner that has since been linked resolves to the real entity.
|
|
17
|
+
*
|
|
18
|
+
* ```typescript
|
|
19
|
+
* const entity = await signa.entities.retrieve('ent_abc123');
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
async retrieve(id, _params, options) {
|
|
23
|
+
this._validateId(id);
|
|
24
|
+
return this._get(`/v1/entities/${encodeURIComponent(id)}`, undefined, options);
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* List + search resolved entities. OpenSearch-backed for both text and
|
|
28
|
+
* filter-only queries.
|
|
29
|
+
*
|
|
30
|
+
* ```typescript
|
|
31
|
+
* const entities = await signa.entities.list({ q: '8x8', publicly_traded: true });
|
|
32
|
+
* ```
|
|
33
|
+
*/
|
|
34
|
+
async list(params, options) {
|
|
35
|
+
const fetchPage = async (cursor) => {
|
|
36
|
+
return this._getListResponse('/v1/entities', { ...params, cursor }, options);
|
|
37
|
+
};
|
|
38
|
+
const firstPage = await fetchPage(params?.cursor);
|
|
39
|
+
return createList(firstPage, fetchPage);
|
|
40
|
+
}
|
|
41
|
+
/**
|
|
42
|
+
* List trademarks across ALL member owners of the entity (summary tier).
|
|
43
|
+
*
|
|
44
|
+
* ```typescript
|
|
45
|
+
* const tms = await signa.entities.trademarks('ent_abc123', { status_primary: 'active' });
|
|
46
|
+
* ```
|
|
47
|
+
*/
|
|
48
|
+
async trademarks(id, params, options) {
|
|
49
|
+
this._validateId(id);
|
|
50
|
+
const fetchPage = async (cursor) => {
|
|
51
|
+
return this._getListResponse(`/v1/entities/${encodeURIComponent(id)}/trademarks`, { ...params, cursor }, options);
|
|
52
|
+
};
|
|
53
|
+
const firstPage = await fetchPage(params?.cursor);
|
|
54
|
+
return createList(firstPage, fetchPage);
|
|
55
|
+
}
|
|
56
|
+
/**
|
|
57
|
+
* GLEIF-curated direct family — parent + direct children (1 level). Sourced
|
|
58
|
+
* from GLEIF Level 2; an absent edge does not imply no relationship (see the
|
|
59
|
+
* response `coverage_caveat`).
|
|
60
|
+
*
|
|
61
|
+
* ```typescript
|
|
62
|
+
* const family = await signa.entities.family('ent_abc123');
|
|
63
|
+
* ```
|
|
64
|
+
*/
|
|
65
|
+
async family(id, _params, options) {
|
|
66
|
+
this._validateId(id);
|
|
67
|
+
return this._get(`/v1/entities/${encodeURIComponent(id)}/family`, undefined, options);
|
|
68
|
+
}
|
|
69
|
+
}
|
|
70
|
+
//# sourceMappingURL=entities.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"entities.js","sourceRoot":"","sources":["../../src/resources/entities.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAa9D;;;;;;GAMG;AACH,MAAM,OAAO,QAAS,SAAQ,YAAY;IACxC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,OAA8B,EAC9B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAe,gBAAgB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC/F,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,IAAI,CACR,MAAyB,EACzB,OAAwB;QAExB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAgB,cAAc,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC9F,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,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,gBAAgB,kBAAkB,CAAC,EAAE,CAAC,aAAa,EACnD,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;;;;;;;;OAQG;IACH,KAAK,CAAC,MAAM,CACV,EAAU,EACV,OAA4B,EAC5B,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAe,gBAAgB,kBAAkB,CAAC,EAAE,CAAC,SAAS,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;CACF"}
|
|
@@ -6,8 +6,8 @@ export declare class Firms extends BaseResource {
|
|
|
6
6
|
* Retrieve a single firm by ID.
|
|
7
7
|
*
|
|
8
8
|
* ```typescript
|
|
9
|
-
* const firm = await signa.firms.retrieve('
|
|
10
|
-
* const firm = await signa.firms.retrieve('
|
|
9
|
+
* const firm = await signa.firms.retrieve('firm_abc123');
|
|
10
|
+
* const firm = await signa.firms.retrieve('firm_abc123', { include: ['stats', 'specializations', 'trend'] });
|
|
11
11
|
* ```
|
|
12
12
|
*/
|
|
13
13
|
retrieve(id: string, params?: FirmRetrieveParams, options?: RequestOptions): Promise<Firm>;
|
|
@@ -23,8 +23,8 @@ export declare class Firms extends BaseResource {
|
|
|
23
23
|
* List a firm's attorneys.
|
|
24
24
|
*
|
|
25
25
|
* ```typescript
|
|
26
|
-
* const attorneys = await signa.firms.attorneys('
|
|
27
|
-
* const attorneys = await signa.firms.attorneys('
|
|
26
|
+
* const attorneys = await signa.firms.attorneys('firm_abc123');
|
|
27
|
+
* const attorneys = await signa.firms.attorneys('firm_abc123', { sort: '-trademark_count' });
|
|
28
28
|
* ```
|
|
29
29
|
*/
|
|
30
30
|
attorneys(id: string, params?: FirmAttorneysParams, options?: RequestOptions): Promise<SignaList<AttorneySummary>>;
|
|
@@ -32,7 +32,7 @@ export declare class Firms extends BaseResource {
|
|
|
32
32
|
* List a firm's trademarks.
|
|
33
33
|
*
|
|
34
34
|
* ```typescript
|
|
35
|
-
* const tms = await signa.firms.trademarks('
|
|
35
|
+
* const tms = await signa.firms.trademarks('firm_abc123', { status: 'registered' });
|
|
36
36
|
* ```
|
|
37
37
|
*/
|
|
38
38
|
trademarks(id: string, params?: FirmTrademarksParams, options?: RequestOptions): Promise<SignaList<TrademarkSummary>>;
|
package/dist/resources/firms.js
CHANGED
|
@@ -5,8 +5,8 @@ export class Firms extends BaseResource {
|
|
|
5
5
|
* Retrieve a single firm by ID.
|
|
6
6
|
*
|
|
7
7
|
* ```typescript
|
|
8
|
-
* const firm = await signa.firms.retrieve('
|
|
9
|
-
* const firm = await signa.firms.retrieve('
|
|
8
|
+
* const firm = await signa.firms.retrieve('firm_abc123');
|
|
9
|
+
* const firm = await signa.firms.retrieve('firm_abc123', { include: ['stats', 'specializations', 'trend'] });
|
|
10
10
|
* ```
|
|
11
11
|
*/
|
|
12
12
|
async retrieve(id, params, options) {
|
|
@@ -33,8 +33,8 @@ export class Firms extends BaseResource {
|
|
|
33
33
|
* List a firm's attorneys.
|
|
34
34
|
*
|
|
35
35
|
* ```typescript
|
|
36
|
-
* const attorneys = await signa.firms.attorneys('
|
|
37
|
-
* const attorneys = await signa.firms.attorneys('
|
|
36
|
+
* const attorneys = await signa.firms.attorneys('firm_abc123');
|
|
37
|
+
* const attorneys = await signa.firms.attorneys('firm_abc123', { sort: '-trademark_count' });
|
|
38
38
|
* ```
|
|
39
39
|
*/
|
|
40
40
|
async attorneys(id, params, options) {
|
|
@@ -49,7 +49,7 @@ export class Firms extends BaseResource {
|
|
|
49
49
|
* List a firm's trademarks.
|
|
50
50
|
*
|
|
51
51
|
* ```typescript
|
|
52
|
-
* const tms = await signa.firms.trademarks('
|
|
52
|
+
* const tms = await signa.firms.trademarks('firm_abc123', { status: 'registered' });
|
|
53
53
|
* ```
|
|
54
54
|
*/
|
|
55
55
|
async trademarks(id, params, options) {
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { type SignaList } from '../pagination.js';
|
|
3
|
+
import type { GoodsServicesTerm, GoodsServicesListParams, GoodsServicesSuggestParams, GoodsServicesSuggestResult, RequestOptions } from '../types.js';
|
|
4
|
+
/**
|
|
5
|
+
* Goods & services — the pre-approved-terms catalog (Harmonised Database +
|
|
6
|
+
* USPTO ID Manual) and the AI-assisted G&S specification drafter.
|
|
7
|
+
*
|
|
8
|
+
* - {@link GoodsServices.list} — browse/search the term catalog. At least
|
|
9
|
+
* one of `q` or `class` must be provided.
|
|
10
|
+
* - {@link GoodsServices.suggest} — draft a filing-ready goods/services
|
|
11
|
+
* specification from a natural-language description. Pass `class_number`
|
|
12
|
+
* to scope the output to a single, already-chosen class.
|
|
13
|
+
*/
|
|
14
|
+
export declare class GoodsServices extends BaseResource {
|
|
15
|
+
/**
|
|
16
|
+
* Browse/search accepted goods & services terms. At least one of `q` or
|
|
17
|
+
* `class` must be provided.
|
|
18
|
+
*
|
|
19
|
+
* Scope: `trademarks:read`. Not billed (reference data).
|
|
20
|
+
*
|
|
21
|
+
* ```typescript
|
|
22
|
+
* // Scoped — autocomplete inside a class the user already selected
|
|
23
|
+
* const terms = await signa.goodsServices.list({ q: 'software', class: 9 });
|
|
24
|
+
*
|
|
25
|
+
* // Cross-class — "which classes accept this term?"
|
|
26
|
+
* const poster = await signa.goodsServices.list({ q: 'poster' });
|
|
27
|
+
* ```
|
|
28
|
+
*/
|
|
29
|
+
list(params: GoodsServicesListParams, options?: RequestOptions): Promise<SignaList<GoodsServicesTerm>>;
|
|
30
|
+
/**
|
|
31
|
+
* Draft a goods/services specification for a natural-language description.
|
|
32
|
+
* Returns ranked Nice classes with filing-ready wording per class, grounded
|
|
33
|
+
* in the pre-approved term catalog (Harmonised Database + USPTO ID Manual).
|
|
34
|
+
*
|
|
35
|
+
* Pass `class_number` to restrict the response to a single, already-chosen
|
|
36
|
+
* class (useful when refining wording inside a class the caller has already
|
|
37
|
+
* picked).
|
|
38
|
+
*
|
|
39
|
+
* Scope: `trademarks:read`. Billed as 2 units.
|
|
40
|
+
*
|
|
41
|
+
* ```typescript
|
|
42
|
+
* // Full draft across all relevant classes
|
|
43
|
+
* const spec = await signa.goodsServices.suggest({
|
|
44
|
+
* description: 'e-commerce company selling sneakers',
|
|
45
|
+
* });
|
|
46
|
+
*
|
|
47
|
+
* // Refine wording for a known class
|
|
48
|
+
* const refined = await signa.goodsServices.suggest({
|
|
49
|
+
* description: 'running shoes',
|
|
50
|
+
* class_number: 25,
|
|
51
|
+
* });
|
|
52
|
+
* ```
|
|
53
|
+
*/
|
|
54
|
+
suggest(body: GoodsServicesSuggestParams, options?: RequestOptions): Promise<GoodsServicesSuggestResult>;
|
|
55
|
+
}
|
|
56
|
+
//# sourceMappingURL=goods-services.d.ts.map
|
|
@@ -0,0 +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"}
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { createList } from '../pagination.js';
|
|
3
|
+
/**
|
|
4
|
+
* Goods & services — the pre-approved-terms catalog (Harmonised Database +
|
|
5
|
+
* USPTO ID Manual) and the AI-assisted G&S specification drafter.
|
|
6
|
+
*
|
|
7
|
+
* - {@link GoodsServices.list} — browse/search the term catalog. At least
|
|
8
|
+
* one of `q` or `class` must be provided.
|
|
9
|
+
* - {@link GoodsServices.suggest} — draft a filing-ready goods/services
|
|
10
|
+
* specification from a natural-language description. Pass `class_number`
|
|
11
|
+
* to scope the output to a single, already-chosen class.
|
|
12
|
+
*/
|
|
13
|
+
export class GoodsServices extends BaseResource {
|
|
14
|
+
/**
|
|
15
|
+
* Browse/search accepted goods & services terms. At least one of `q` or
|
|
16
|
+
* `class` must be provided.
|
|
17
|
+
*
|
|
18
|
+
* Scope: `trademarks:read`. Not billed (reference data).
|
|
19
|
+
*
|
|
20
|
+
* ```typescript
|
|
21
|
+
* // Scoped — autocomplete inside a class the user already selected
|
|
22
|
+
* const terms = await signa.goodsServices.list({ q: 'software', class: 9 });
|
|
23
|
+
*
|
|
24
|
+
* // Cross-class — "which classes accept this term?"
|
|
25
|
+
* const poster = await signa.goodsServices.list({ q: 'poster' });
|
|
26
|
+
* ```
|
|
27
|
+
*/
|
|
28
|
+
async list(params, options) {
|
|
29
|
+
const response = await this._getListResponse('/v1/goods-services', params, options);
|
|
30
|
+
return createList(response, (cursor) => this._getListResponse('/v1/goods-services', { ...params, cursor }, options));
|
|
31
|
+
}
|
|
32
|
+
/**
|
|
33
|
+
* Draft a goods/services specification for a natural-language description.
|
|
34
|
+
* Returns ranked Nice classes with filing-ready wording per class, grounded
|
|
35
|
+
* in the pre-approved term catalog (Harmonised Database + USPTO ID Manual).
|
|
36
|
+
*
|
|
37
|
+
* Pass `class_number` to restrict the response to a single, already-chosen
|
|
38
|
+
* class (useful when refining wording inside a class the caller has already
|
|
39
|
+
* picked).
|
|
40
|
+
*
|
|
41
|
+
* Scope: `trademarks:read`. Billed as 2 units.
|
|
42
|
+
*
|
|
43
|
+
* ```typescript
|
|
44
|
+
* // Full draft across all relevant classes
|
|
45
|
+
* const spec = await signa.goodsServices.suggest({
|
|
46
|
+
* description: 'e-commerce company selling sneakers',
|
|
47
|
+
* });
|
|
48
|
+
*
|
|
49
|
+
* // Refine wording for a known class
|
|
50
|
+
* const refined = await signa.goodsServices.suggest({
|
|
51
|
+
* description: 'running shoes',
|
|
52
|
+
* class_number: 25,
|
|
53
|
+
* });
|
|
54
|
+
* ```
|
|
55
|
+
*/
|
|
56
|
+
async suggest(body, options) {
|
|
57
|
+
return this._post('/v1/goods-services/suggest', body, options);
|
|
58
|
+
}
|
|
59
|
+
}
|
|
60
|
+
//# sourceMappingURL=goods-services.js.map
|
|
@@ -0,0 +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,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, RequestOptions } from '../types.js';
|
|
4
|
+
import type { Identity, Usage, ApiKey, ApiKeyWithRawKey, DeletedResponse, ApiKeyCreateParams, ApiKeyUpdateParams, RequestLog, RequestLogDetail, UsageSummaryParams, UsageSummaryResponse, 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>;
|
|
@@ -16,14 +16,35 @@ declare class ApiKeys extends BaseResource {
|
|
|
16
16
|
/** Rotate an API key. Old key expires in 24h. Returns new raw key. */
|
|
17
17
|
rotate(id: string, options?: RequestOptions): Promise<ApiKeyWithRawKey>;
|
|
18
18
|
}
|
|
19
|
-
|
|
19
|
+
declare class Logs extends BaseResource {
|
|
20
|
+
/**
|
|
21
|
+
* List request logs for the org (paginated).
|
|
22
|
+
*
|
|
23
|
+
* Per-plan retention limits apply: `free` → 7 days, `starter` → 30 days,
|
|
24
|
+
* `beta`/`pro`/`enterprise` → 90 days. Defaults to the last 24 hours.
|
|
25
|
+
*/
|
|
26
|
+
list(params?: LogListParams, options?: RequestOptions): Promise<SignaList<RequestLog>>;
|
|
27
|
+
/** Retrieve a single request log by request_id. */
|
|
28
|
+
retrieve(requestId: string, options?: RequestOptions): Promise<RequestLogDetail>;
|
|
29
|
+
}
|
|
30
|
+
export declare class Organization extends BaseResource {
|
|
20
31
|
/** API key management. */
|
|
21
32
|
readonly apiKeys: ApiKeys;
|
|
33
|
+
/** Request log access. */
|
|
34
|
+
readonly logs: Logs;
|
|
22
35
|
constructor(config: FetchConfig);
|
|
23
36
|
/** Get the authenticated identity (org, plan, key info). */
|
|
24
37
|
me(options?: RequestOptions): Promise<Identity>;
|
|
25
38
|
/** Get billing period usage and rate limit info. */
|
|
26
39
|
usage(options?: RequestOptions): Promise<Usage>;
|
|
40
|
+
/**
|
|
41
|
+
* Get daily usage breakdown from pre-aggregated rollups plus current
|
|
42
|
+
* billing period quota context.
|
|
43
|
+
*
|
|
44
|
+
* Named `usageSummary` (not nested under `usage`) because `usage` is a
|
|
45
|
+
* method on this class, not a namespace.
|
|
46
|
+
*/
|
|
47
|
+
usageSummary(params: UsageSummaryParams, options?: RequestOptions): Promise<UsageSummaryResponse>;
|
|
27
48
|
}
|
|
28
49
|
export {};
|
|
29
|
-
//# sourceMappingURL=
|
|
50
|
+
//# sourceMappingURL=organization.d.ts.map
|