@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.
- package/README.md +4 -4
- package/dist/_internals/fetch-with-retry.d.ts.map +1 -1
- package/dist/_internals/fetch-with-retry.js +10 -2
- package/dist/_internals/fetch-with-retry.js.map +1 -1
- package/dist/_internals/query-string.d.ts +1 -1
- package/dist/_internals/query-string.js +1 -1
- package/dist/category-nice.d.ts +22 -0
- package/dist/category-nice.d.ts.map +1 -0
- package/dist/category-nice.js +109 -0
- package/dist/category-nice.js.map +1 -0
- package/dist/client.d.ts +26 -0
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +34 -0
- package/dist/client.js.map +1 -1
- package/dist/generated/api-types.d.ts +7780 -2215
- package/dist/generated/api-types.d.ts.map +1 -1
- package/dist/index.d.ts +4 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -0
- package/dist/index.js.map +1 -1
- package/dist/pagination.d.ts +23 -1
- package/dist/pagination.d.ts.map +1 -1
- package/dist/pagination.js +27 -0
- package/dist/pagination.js.map +1 -1
- package/dist/resources/analytics.d.ts +8 -0
- package/dist/resources/analytics.d.ts.map +1 -0
- package/dist/resources/analytics.js +13 -0
- package/dist/resources/analytics.js.map +1 -0
- package/dist/resources/assignments.d.ts +25 -0
- package/dist/resources/assignments.d.ts.map +1 -0
- package/dist/resources/assignments.js +33 -0
- package/dist/resources/assignments.js.map +1 -0
- package/dist/resources/attorneys.d.ts +2 -1
- package/dist/resources/attorneys.d.ts.map +1 -1
- package/dist/resources/attorneys.js +4 -0
- package/dist/resources/attorneys.js.map +1 -1
- package/dist/resources/compare.d.ts +29 -0
- package/dist/resources/compare.d.ts.map +1 -0
- package/dist/resources/compare.js +30 -0
- package/dist/resources/compare.js.map +1 -0
- package/dist/resources/deadlines.d.ts +24 -0
- package/dist/resources/deadlines.d.ts.map +1 -0
- package/dist/resources/deadlines.js +26 -0
- package/dist/resources/deadlines.js.map +1 -0
- package/dist/resources/entities.d.ts +2 -1
- package/dist/resources/entities.d.ts.map +1 -1
- package/dist/resources/entities.js +4 -0
- package/dist/resources/entities.js.map +1 -1
- package/dist/resources/events.d.ts +2 -2
- package/dist/resources/events.d.ts.map +1 -1
- package/dist/resources/events.js +2 -2
- package/dist/resources/events.js.map +1 -1
- package/dist/resources/feedback.d.ts +19 -0
- package/dist/resources/feedback.d.ts.map +1 -0
- package/dist/resources/feedback.js +29 -0
- package/dist/resources/feedback.js.map +1 -0
- package/dist/resources/firms.d.ts +3 -2
- package/dist/resources/firms.d.ts.map +1 -1
- package/dist/resources/firms.js +5 -1
- package/dist/resources/firms.js.map +1 -1
- package/dist/resources/goods-services.d.ts +1 -1
- package/dist/resources/goods-services.js +1 -1
- package/dist/resources/oppositions.d.ts +18 -0
- package/dist/resources/oppositions.d.ts.map +1 -0
- package/dist/resources/oppositions.js +20 -0
- package/dist/resources/oppositions.js.map +1 -0
- package/dist/resources/organization.d.ts +7 -1
- package/dist/resources/organization.d.ts.map +1 -1
- package/dist/resources/organization.js +8 -0
- package/dist/resources/organization.js.map +1 -1
- package/dist/resources/owners.d.ts +2 -1
- package/dist/resources/owners.d.ts.map +1 -1
- package/dist/resources/owners.js +4 -0
- package/dist/resources/owners.js.map +1 -1
- package/dist/resources/reconcile.d.ts +22 -0
- package/dist/resources/reconcile.d.ts.map +1 -0
- package/dist/resources/reconcile.js +24 -0
- package/dist/resources/reconcile.js.map +1 -0
- package/dist/resources/references.d.ts +2 -2
- package/dist/resources/references.js +2 -2
- package/dist/resources/screening.d.ts +63 -0
- package/dist/resources/screening.d.ts.map +1 -0
- package/dist/resources/screening.js +66 -0
- package/dist/resources/screening.js.map +1 -0
- package/dist/resources/trademarks.d.ts +42 -8
- package/dist/resources/trademarks.d.ts.map +1 -1
- package/dist/resources/trademarks.js +85 -6
- package/dist/resources/trademarks.js.map +1 -1
- package/dist/resources/watches.d.ts +14 -2
- package/dist/resources/watches.d.ts.map +1 -1
- package/dist/resources/watches.js +21 -1
- package/dist/resources/watches.js.map +1 -1
- package/dist/types.d.ts +1707 -115
- package/dist/types.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/package.json +3 -2
package/dist/index.d.ts
CHANGED
|
@@ -1,8 +1,11 @@
|
|
|
1
1
|
export { Signa } from './client.js';
|
|
2
2
|
export { Signa as default } from './client.js';
|
|
3
|
+
export { primaryOwnerName } from './resources/trademarks.js';
|
|
4
|
+
export { Analytics } from './resources/analytics.js';
|
|
5
|
+
export { categoryToNiceClasses, CATEGORY_NICE_TABLE } from './category-nice.js';
|
|
3
6
|
export { SignaError, SignaAPIError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, RateLimitError, InternalServerError, ConnectionError, TimeoutError, } from './errors.js';
|
|
4
7
|
export { SignaList } from './pagination.js';
|
|
5
8
|
export { verifyWebhookSignature } from './webhooks.js';
|
|
6
9
|
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,
|
|
10
|
+
export type { Trademark, TrademarkSummary, Event, Owner, OwnerSummary, EntitySummary, EntityDetail, EntityMember, EntityMemberLink, EntityCompany, EntityListing, EntityListedAncestor, EntityFamily, EntityFamilyNode, Attorney, AttorneySummary, Firm, FirmSummary, Proceeding, ProceedingDetail, Assignment, AssignmentDetail, TrademarkAssignment, TrademarkSearchResult, CrossEntitySuggestion, Classification, ClassificationDetail, AcceptedTerm, ClassificationSuggestionLite, ClassificationSuggestResult, GoodsServicesSuggestionClass, GoodsServicesSuggestResult, GoodsServicesTerm, Office, OfficeDetail, OfficeAnalytics, MarketAnalytics, ClassificationAnalytics, AnalyticsReport, TrademarkAggregationName, Jurisdiction, JurisdictionDetail, DeadlineRule, ComputedDeadline, DeadlineComputation, DeadlineComputeItem, DeadlineComputeResponse, OppositionRule, OppositionCommonExtension, OppositionWindowSource, OppositionWindowComputation, OppositionComputeItem, OppositionComputeResponse, ReconcileFieldDiff, ReconcileYourFields, ReconcileItem, Reconciliation, ReconcileResponse, RuleSource, Status, EventType, DesignCode, DesignCodeDetail, TrademarkSource, TrademarkCoverage, TrademarkProceeding, OwnerRelated, Portfolio, SavedSearch, Feedback, FeedbackType, FeedbackStatus, FeedbackCreateParams, FeedbackListParams, Watch, WatchType, WatchStatus, WatchDeliveryMode, WatchTriggerEvent, WatchQuery, WatchPreviewResponse, WatchDiagnostics, WatchDiagnosticsLeaseState, WatchDiagnosticsWindowStatus, WatchAttestation, WatchAttestationOffice, WatchAttestationGap, Alert, AlertEventType, AlertSeverity, OppositionWindowStatus, Webhook, WebhookDisabledReason, WebhookEvent, WebhookEventType, WebhookStatus, WebhookDelivery, WebhookDeliveryStatus, WebhookTestResponse, WebhookRedeliveryResponse, AlertCreatedPayload, AlertCreatedFlatFields, AlertCreatedEvent, OrgEvent, OrgEventDetail, Identity, Usage, ApiKey, ApiKeyWithRawKey, RequestLog, RequestLogDetail, UsageSummaryResponse, UsageSummaryItem, UsageBillingPeriod, CreditBalance, CreditGrantBreakdown, CreditExpiryScheduleEntry, DeletedResponse, SearchMeta, SearchWarning, APIErrorBody, MatchMode, OppositionStatus, SeniorityClaims, TrademarkSearchInclude, TrademarkDetailInclude, AttorneyStats, OwnerStats, TrademarkBatchBody, TrademarkBatchResponse, TrademarkChange, TrademarkRelationship, TrademarkSuggestion, AttorneyClient, TrademarkRetrieveParams, TrademarkListParams, TrademarkHistoryParams, TrademarkChangesParams, TrademarkRelatedParams, TrademarkSuggestParams, TrademarkCoverageParams, TrademarkProceedingsParams, TrademarkAssignmentsParams, OwnerRetrieveParams, OwnerListParams, OwnerTrademarksParams, OwnerRelatedParams, EntityRetrieveParams, EntityListParams, EntityTrademarksParams, EntityFamilyParams, AttorneyRetrieveParams, AttorneyListParams, AttorneyTrademarksParams, AttorneyClientsParams, FirmRetrieveParams, FirmListParams, FirmAttorneysParams, FirmTrademarksParams, ProceedingListParams, ConveyanceType, AssignmentListParams, TrademarkSearchBody, SearchV2Body, CrossEntitySuggestParams, ClassificationListParams, ClassificationSuggestParams, DesignCodeListParams, DeadlineComputeParams, OppositionComputeParams, ReconcileParams, GoodsServicesListParams, GoodsServicesSuggestParams, PortfolioCreateParams, PortfolioUpdateParams, PortfolioListParams, PortfolioRetrieveParams, PortfolioAddTrademarksBody, PortfolioRemoveTrademarksBody, PortfolioDeadlineParams, PortfolioDeadlinesIcalParams, SavedSearchCreateParams, SavedSearchUpdateParams, SavedSearchListParams, SavedSearchExecuteParams, WatchCreateParams, WatchCreateQueryParams, WatchUpdateParams, WatchListParams, WatchReplayParams, WatchPreviewParams, WatchBulkParams, WatchDiagnosticsParams, WatchAttestationParams, AlertListParams, AlertLookupParams, WebhookCreateParams, WebhookUpdateParams, WebhookListParams, WebhookDeliveryListParams, OrgEventListParams, ApiKeyCreateParams, ApiKeyUpdateParams, LogListParams, UsageSummaryParams, ScreenParams, ScreenOptions, ScreenResult, ScreeningHit, ScreeningRiskLevel, ScreeningVerdict, ScreeningMarkMatchLevel, ScreeningGoodsServicesMatchLevel, ScreeningLitigationRiskLevel, CompareUseProfile, CompareCandidate, CompareConflict, CompareConflicts, CompareParams, CompareResult, ComparisonResult, ComparisonStatus, CompareRiskLevel, CompareMarkMatchLevel, CompareGoodsServicesLevel, ListingVerdict, ListingCheckParams, ListingCheckResult, ListingCandidate, ListingCandidateHit, SuppressedListingCandidate, RequestOptions, ClientOptions, } from './types.js';
|
|
8
11
|
//# 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;
|
|
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;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAGhF,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,aAAa,EACb,oBAAoB,EACpB,YAAY,EACZ,gBAAgB,EAChB,QAAQ,EACR,eAAe,EACf,IAAI,EACJ,WAAW,EACX,UAAU,EACV,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,YAAY,EACZ,4BAA4B,EAC5B,2BAA2B,EAC3B,4BAA4B,EAC5B,0BAA0B,EAC1B,iBAAiB,EACjB,MAAM,EACN,YAAY,EACZ,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,eAAe,EACf,wBAAwB,EACxB,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,uBAAuB,EACvB,cAAc,EACd,yBAAyB,EACzB,sBAAsB,EACtB,2BAA2B,EAC3B,qBAAqB,EACrB,yBAAyB,EACzB,kBAAkB,EAClB,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,iBAAiB,EACjB,UAAU,EACV,MAAM,EACN,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,YAAY,EACZ,SAAS,EACT,WAAW,EACX,QAAQ,EACR,YAAY,EACZ,cAAc,EACd,oBAAoB,EACpB,kBAAkB,EAClB,KAAK,EACL,SAAS,EACT,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,UAAU,EACV,oBAAoB,EACpB,gBAAgB,EAChB,0BAA0B,EAC1B,4BAA4B,EAC5B,gBAAgB,EAChB,sBAAsB,EACtB,mBAAmB,EACnB,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,sBAAsB,EACtB,iBAAiB,EACjB,QAAQ,EACR,cAAc,EACd,QAAQ,EACR,KAAK,EACL,MAAM,EACN,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,oBAAoB,EACpB,yBAAyB,EACzB,eAAe,EACf,UAAU,EACV,aAAa,EACb,YAAY,EAEZ,SAAS,EACT,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,sBAAsB,EAEtB,aAAa,EACb,UAAU,EAEV,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,EAC1B,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,EACpB,cAAc,EACd,oBAAoB,EAEpB,mBAAmB,EACnB,YAAY,EACZ,wBAAwB,EAExB,wBAAwB,EACxB,2BAA2B,EAC3B,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,eAAe,EAEf,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,EACtB,sBAAsB,EAEtB,eAAe,EACf,iBAAiB,EAEjB,mBAAmB,EACnB,mBAAmB,EACnB,iBAAiB,EACjB,yBAAyB,EAEzB,kBAAkB,EAElB,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACb,kBAAkB,EAElB,YAAY,EACZ,aAAa,EACb,YAAY,EACZ,YAAY,EACZ,kBAAkB,EAClB,gBAAgB,EAChB,uBAAuB,EACvB,gCAAgC,EAChC,4BAA4B,EAE5B,iBAAiB,EACjB,gBAAgB,EAChB,eAAe,EACf,gBAAgB,EAChB,aAAa,EACb,aAAa,EACb,gBAAgB,EAChB,gBAAgB,EAChB,gBAAgB,EAChB,qBAAqB,EACrB,yBAAyB,EAEzB,cAAc,EACd,kBAAkB,EAClB,kBAAkB,EAClB,gBAAgB,EAChB,mBAAmB,EACnB,0BAA0B,EAE1B,cAAc,EACd,aAAa,GACd,MAAM,YAAY,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,5 +1,8 @@
|
|
|
1
1
|
export { Signa } from './client.js';
|
|
2
2
|
export { Signa as default } from './client.js';
|
|
3
|
+
export { primaryOwnerName } from './resources/trademarks.js';
|
|
4
|
+
export { Analytics } from './resources/analytics.js';
|
|
5
|
+
export { categoryToNiceClasses, CATEGORY_NICE_TABLE } from './category-nice.js';
|
|
3
6
|
// ── Error classes (for instanceof checks) ───────────────────────────
|
|
4
7
|
export { SignaError, SignaAPIError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, RateLimitError, InternalServerError, ConnectionError, TimeoutError, } from './errors.js';
|
|
5
8
|
// ── Pagination ──────────────────────────────────────────────────────
|
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;
|
|
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;AAC/C,OAAO,EAAE,gBAAgB,EAAE,MAAM,2BAA2B,CAAC;AAC7D,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AACrD,OAAO,EAAE,qBAAqB,EAAE,mBAAmB,EAAE,MAAM,oBAAoB,CAAC;AAEhF,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
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import type { ListResponseBody, SearchMeta } from './types.js';
|
|
1
|
+
import type { ListResponseBody, SearchMeta, TrademarkDocumentSourceSync } from './types.js';
|
|
2
2
|
type PageFetcher<T> = (cursor?: string) => Promise<ListResponseBody<T>>;
|
|
3
3
|
/**
|
|
4
4
|
* A list response that supports three consumption patterns:
|
|
@@ -17,10 +17,32 @@ export declare class SignaList<T> implements AsyncIterable<T> {
|
|
|
17
17
|
readonly has_more: boolean;
|
|
18
18
|
/** Request ID from the API response. */
|
|
19
19
|
readonly request_id: string;
|
|
20
|
+
/**
|
|
21
|
+
* Total matching-result count for the query. Present only when the request
|
|
22
|
+
* opted in via `include_total` (search + list endpoints). This is the
|
|
23
|
+
* canonical location for the count — the former `search_meta.total_results`
|
|
24
|
+
* was removed in the ENG-14 beta break. Capped at 10,000; see
|
|
25
|
+
* `total_count_approximate`.
|
|
26
|
+
*/
|
|
27
|
+
readonly total_count?: number;
|
|
28
|
+
/**
|
|
29
|
+
* `true` when `total_count` is a capped estimate (the count hit the 10,000
|
|
30
|
+
* ceiling and the true total is higher) rather than exact. Present only
|
|
31
|
+
* when `total_count` is.
|
|
32
|
+
*/
|
|
33
|
+
readonly total_count_approximate?: boolean;
|
|
20
34
|
/** Search metadata (only present on search responses). */
|
|
21
35
|
readonly search_meta?: SearchMeta;
|
|
36
|
+
/** Source sync metadata (only present on lazy-backed document lists). */
|
|
37
|
+
readonly source_sync?: TrademarkDocumentSourceSync;
|
|
22
38
|
/** Faceted aggregation buckets (only present on search responses). */
|
|
23
39
|
readonly aggregations?: Record<string, Record<string, number>>;
|
|
40
|
+
/**
|
|
41
|
+
* Display-name labels for aggregation bucket keys (TSK-127), shaped
|
|
42
|
+
* `{ <aggName>: { <bucketKey>: name } }`. Currently populated for the
|
|
43
|
+
* `entity_id` facet. Only present on search responses with aggregations.
|
|
44
|
+
*/
|
|
45
|
+
readonly aggregation_metadata?: Record<string, Record<string, string>>;
|
|
24
46
|
/** @internal */
|
|
25
47
|
private readonly _fetchPage;
|
|
26
48
|
/** @internal Cursor for the next page (null if no more). */
|
package/dist/pagination.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,MAAM,YAAY,CAAC;
|
|
1
|
+
{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,UAAU,EAAE,2BAA2B,EAAE,MAAM,YAAY,CAAC;AAI5F,KAAK,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,KAAK,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CAAC;AAExE;;;;;;;;;GASG;AACH,qBAAa,SAAS,CAAC,CAAC,CAAE,YAAW,aAAa,CAAC,CAAC,CAAC;IACnD,iCAAiC;IACjC,QAAQ,CAAC,IAAI,EAAE,CAAC,EAAE,CAAC;IAEnB,+CAA+C;IAC/C,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAE3B,wCAAwC;IACxC,QAAQ,CAAC,UAAU,EAAE,MAAM,CAAC;IAE5B;;;;;;OAMG;IACH,QAAQ,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;IAE9B;;;;OAIG;IACH,QAAQ,CAAC,uBAAuB,CAAC,EAAE,OAAO,CAAC;IAE3C,0DAA0D;IAC1D,QAAQ,CAAC,WAAW,CAAC,EAAE,UAAU,CAAC;IAElC,yEAAyE;IACzE,QAAQ,CAAC,WAAW,CAAC,EAAE,2BAA2B,CAAC;IAEnD,sEAAsE;IACtE,QAAQ,CAAC,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAE/D;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEvE,gBAAgB;IAChB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAiB;IAE5C,4DAA4D;IAC5D,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAgB;IAExC,gBAAgB;gBACJ,QAAQ,EAAE,gBAAgB,CAAC,CAAC,CAAC,EAAE,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;IAcpE;;;OAGG;IACG,WAAW,IAAI,OAAO,CAAC,SAAS,CAAC,CAAC,CAAC,CAAC;IAkB1C;;;;;;;;OAQG;IACI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,aAAa,CAAC,CAAC,CAAC;IAYjD;;;;OAIG;IACG,OAAO,CAAC,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;CAWvD;AAED;;;GAGG;AACH,wBAAgB,UAAU,CAAC,CAAC,EAC1B,eAAe,EAAE,gBAAgB,CAAC,CAAC,CAAC,EACpC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC,GACxB,SAAS,CAAC,CAAC,CAAC,CAEd"}
|
package/dist/pagination.js
CHANGED
|
@@ -16,10 +16,32 @@ export class SignaList {
|
|
|
16
16
|
has_more;
|
|
17
17
|
/** Request ID from the API response. */
|
|
18
18
|
request_id;
|
|
19
|
+
/**
|
|
20
|
+
* Total matching-result count for the query. Present only when the request
|
|
21
|
+
* opted in via `include_total` (search + list endpoints). This is the
|
|
22
|
+
* canonical location for the count — the former `search_meta.total_results`
|
|
23
|
+
* was removed in the ENG-14 beta break. Capped at 10,000; see
|
|
24
|
+
* `total_count_approximate`.
|
|
25
|
+
*/
|
|
26
|
+
total_count;
|
|
27
|
+
/**
|
|
28
|
+
* `true` when `total_count` is a capped estimate (the count hit the 10,000
|
|
29
|
+
* ceiling and the true total is higher) rather than exact. Present only
|
|
30
|
+
* when `total_count` is.
|
|
31
|
+
*/
|
|
32
|
+
total_count_approximate;
|
|
19
33
|
/** Search metadata (only present on search responses). */
|
|
20
34
|
search_meta;
|
|
35
|
+
/** Source sync metadata (only present on lazy-backed document lists). */
|
|
36
|
+
source_sync;
|
|
21
37
|
/** Faceted aggregation buckets (only present on search responses). */
|
|
22
38
|
aggregations;
|
|
39
|
+
/**
|
|
40
|
+
* Display-name labels for aggregation bucket keys (TSK-127), shaped
|
|
41
|
+
* `{ <aggName>: { <bucketKey>: name } }`. Currently populated for the
|
|
42
|
+
* `entity_id` facet. Only present on search responses with aggregations.
|
|
43
|
+
*/
|
|
44
|
+
aggregation_metadata;
|
|
23
45
|
/** @internal */
|
|
24
46
|
_fetchPage;
|
|
25
47
|
/** @internal Cursor for the next page (null if no more). */
|
|
@@ -29,8 +51,12 @@ export class SignaList {
|
|
|
29
51
|
this.data = response.data;
|
|
30
52
|
this.has_more = response.has_more;
|
|
31
53
|
this.request_id = response.request_id;
|
|
54
|
+
this.total_count = response.pagination.total_count;
|
|
55
|
+
this.total_count_approximate = response.pagination.total_count_approximate;
|
|
32
56
|
this.search_meta = response.search_meta;
|
|
57
|
+
this.source_sync = response.source_sync;
|
|
33
58
|
this.aggregations = response.aggregations;
|
|
59
|
+
this.aggregation_metadata = response.aggregation_metadata;
|
|
34
60
|
this._cursor = response.pagination.cursor;
|
|
35
61
|
this._fetchPage = fetchPage;
|
|
36
62
|
}
|
|
@@ -46,6 +72,7 @@ export class SignaList {
|
|
|
46
72
|
has_more: false,
|
|
47
73
|
pagination: { cursor: null },
|
|
48
74
|
request_id: this.request_id,
|
|
75
|
+
source_sync: this.source_sync,
|
|
49
76
|
}, this._fetchPage);
|
|
50
77
|
}
|
|
51
78
|
const response = await this._fetchPage(this._cursor);
|
package/dist/pagination.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AAEA,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAItC;;;;;;;;;GASG;AACH,MAAM,OAAO,SAAS;IACpB,iCAAiC;IACxB,IAAI,CAAM;IAEnB,+CAA+C;IACtC,QAAQ,CAAU;IAE3B,wCAAwC;IAC/B,UAAU,CAAS;IAE5B,0DAA0D;IACjD,WAAW,CAAc;IAElC,sEAAsE;IAC7D,YAAY,CAA0C;IAE/D,gBAAgB;IACC,UAAU,CAAiB;IAE5C,4DAA4D;IAC3C,OAAO,CAAgB;IAExC,gBAAgB;IAChB,YAAY,QAA6B,EAAE,SAAyB;QAClE,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAClC,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC;QAC1C,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACpC,OAAO,IAAI,SAAS,CAClB;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,EAAE;gBACR,QAAQ,EAAE,KAAK;gBACf,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;gBAC5B,UAAU,EAAE,IAAI,CAAC,UAAU;
|
|
1
|
+
{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AAEA,MAAM,sBAAsB,GAAG,MAAM,CAAC;AAItC;;;;;;;;;GASG;AACH,MAAM,OAAO,SAAS;IACpB,iCAAiC;IACxB,IAAI,CAAM;IAEnB,+CAA+C;IACtC,QAAQ,CAAU;IAE3B,wCAAwC;IAC/B,UAAU,CAAS;IAE5B;;;;;;OAMG;IACM,WAAW,CAAU;IAE9B;;;;OAIG;IACM,uBAAuB,CAAW;IAE3C,0DAA0D;IACjD,WAAW,CAAc;IAElC,yEAAyE;IAChE,WAAW,CAA+B;IAEnD,sEAAsE;IAC7D,YAAY,CAA0C;IAE/D;;;;OAIG;IACM,oBAAoB,CAA0C;IAEvE,gBAAgB;IACC,UAAU,CAAiB;IAE5C,4DAA4D;IAC3C,OAAO,CAAgB;IAExC,gBAAgB;IAChB,YAAY,QAA6B,EAAE,SAAyB;QAClE,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC1B,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC,QAAQ,CAAC;QAClC,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;QACtC,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,UAAU,CAAC,WAAW,CAAC;QACnD,IAAI,CAAC,uBAAuB,GAAG,QAAQ,CAAC,UAAU,CAAC,uBAAuB,CAAC;QAC3E,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,WAAW,GAAG,QAAQ,CAAC,WAAW,CAAC;QACxC,IAAI,CAAC,YAAY,GAAG,QAAQ,CAAC,YAAY,CAAC;QAC1C,IAAI,CAAC,oBAAoB,GAAG,QAAQ,CAAC,oBAAoB,CAAC;QAC1D,IAAI,CAAC,OAAO,GAAG,QAAQ,CAAC,UAAU,CAAC,MAAM,CAAC;QAC1C,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;IAC9B,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,WAAW;QACf,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YACpC,OAAO,IAAI,SAAS,CAClB;gBACE,MAAM,EAAE,MAAM;gBACd,IAAI,EAAE,EAAE;gBACR,QAAQ,EAAE,KAAK;gBACf,UAAU,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE;gBAC5B,UAAU,EAAE,IAAI,CAAC,UAAU;gBAC3B,WAAW,EAAE,IAAI,CAAC,WAAW;aAC9B,EACD,IAAI,CAAC,UAAU,CAChB,CAAC;QACJ,CAAC;QACD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;QACrD,OAAO,IAAI,SAAS,CAAI,QAAQ,EAAE,IAAI,CAAC,UAAU,CAAC,CAAC;IACrD,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,aAAa,CAAC;QAC3B,4DAA4D;QAC5D,IAAI,IAAI,GAAiB,IAAI,CAAC;QAC9B,OAAO,IAAI,EAAE,CAAC;YACZ,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC7B,MAAM,IAAI,CAAC;YACb,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,MAAM;YAC1B,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAClC,CAAC;IACH,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,OAAO,CAAC,IAAyB;QACrC,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,sBAAsB,CAAC;QACpD,MAAM,KAAK,GAAQ,EAAE,CAAC;QAEtB,IAAI,KAAK,EAAE,MAAM,IAAI,IAAI,IAAI,EAAE,CAAC;YAC9B,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;YACjB,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK;gBAAE,MAAM;QACnC,CAAC;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,eAAoC,EACpC,SAAyB;IAEzB,OAAO,IAAI,SAAS,CAAI,eAAe,EAAE,SAAS,CAAC,CAAC;AACtD,CAAC"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import type { ClassificationAnalytics, MarketAnalytics, OfficeAnalytics, RequestOptions } from '../types.js';
|
|
3
|
+
export declare class Analytics extends BaseResource {
|
|
4
|
+
market(options?: RequestOptions): Promise<MarketAnalytics>;
|
|
5
|
+
office(code: string, options?: RequestOptions): Promise<OfficeAnalytics>;
|
|
6
|
+
classification(niceClass: number, options?: RequestOptions): Promise<ClassificationAnalytics>;
|
|
7
|
+
}
|
|
8
|
+
//# sourceMappingURL=analytics.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"analytics.d.ts","sourceRoot":"","sources":["../../src/resources/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,uBAAuB,EAAE,eAAe,EAAE,eAAe,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAE7G,qBAAa,SAAU,SAAQ,YAAY;IACzC,MAAM,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAG1D,MAAM,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAGxE,cAAc,CAAC,SAAS,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,uBAAuB,CAAC;CAG9F"}
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
export class Analytics extends BaseResource {
|
|
3
|
+
market(options) {
|
|
4
|
+
return this._get('/v1/analytics/market', undefined, options);
|
|
5
|
+
}
|
|
6
|
+
office(code, options) {
|
|
7
|
+
return this._get(`/v1/analytics/offices/${encodeURIComponent(code)}`, undefined, options);
|
|
8
|
+
}
|
|
9
|
+
classification(niceClass, options) {
|
|
10
|
+
return this._get(`/v1/analytics/classifications/${niceClass}`, undefined, options);
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
//# sourceMappingURL=analytics.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"analytics.js","sourceRoot":"","sources":["../../src/resources/analytics.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC,MAAM,CAAC,OAAwB;QAC7B,OAAO,IAAI,CAAC,IAAI,CAAC,sBAAsB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC/D,CAAC;IACD,MAAM,CAAC,IAAY,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,IAAI,CAAC,yBAAyB,kBAAkB,CAAC,IAAI,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC5F,CAAC;IACD,cAAc,CAAC,SAAiB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,IAAI,CAAC,iCAAiC,SAAS,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;CACF"}
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { type SignaList } from '../pagination.js';
|
|
3
|
+
import type { Assignment, AssignmentDetail, AssignmentListParams, RequestOptions } from '../types.js';
|
|
4
|
+
export declare class Assignments extends BaseResource {
|
|
5
|
+
/**
|
|
6
|
+
* Retrieve a single recorded assignment by ID.
|
|
7
|
+
*
|
|
8
|
+
* ```typescript
|
|
9
|
+
* const assignment = await signa.assignments.retrieve('asg_abc123');
|
|
10
|
+
* ```
|
|
11
|
+
*/
|
|
12
|
+
retrieve(id: string, options?: RequestOptions): Promise<AssignmentDetail>;
|
|
13
|
+
/**
|
|
14
|
+
* List recorded assignments with required filters.
|
|
15
|
+
*
|
|
16
|
+
* ```typescript
|
|
17
|
+
* const liens = await signa.assignments.list({
|
|
18
|
+
* owner_id: 'own_abc123',
|
|
19
|
+
* type: 'security_interest',
|
|
20
|
+
* });
|
|
21
|
+
* ```
|
|
22
|
+
*/
|
|
23
|
+
list(params?: AssignmentListParams, options?: RequestOptions): Promise<SignaList<Assignment>>;
|
|
24
|
+
}
|
|
25
|
+
//# sourceMappingURL=assignments.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"assignments.d.ts","sourceRoot":"","sources":["../../src/resources/assignments.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,WAAY,SAAQ,YAAY;IAC3C;;;;;;OAMG;IACG,QAAQ,CACZ,EAAE,EAAE,MAAM,EACV,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,gBAAgB,CAAC;IAK5B;;;;;;;;;OASG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,oBAAoB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,UAAU,CAAC,CAAC;CAOlC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { createList } from '../pagination.js';
|
|
3
|
+
export class Assignments extends BaseResource {
|
|
4
|
+
/**
|
|
5
|
+
* Retrieve a single recorded assignment by ID.
|
|
6
|
+
*
|
|
7
|
+
* ```typescript
|
|
8
|
+
* const assignment = await signa.assignments.retrieve('asg_abc123');
|
|
9
|
+
* ```
|
|
10
|
+
*/
|
|
11
|
+
async retrieve(id, options) {
|
|
12
|
+
this._validateId(id);
|
|
13
|
+
return this._get(`/v1/assignments/${encodeURIComponent(id)}`, undefined, options);
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* List recorded assignments with required filters.
|
|
17
|
+
*
|
|
18
|
+
* ```typescript
|
|
19
|
+
* const liens = await signa.assignments.list({
|
|
20
|
+
* owner_id: 'own_abc123',
|
|
21
|
+
* type: 'security_interest',
|
|
22
|
+
* });
|
|
23
|
+
* ```
|
|
24
|
+
*/
|
|
25
|
+
async list(params, options) {
|
|
26
|
+
const fetchPage = async (cursor) => {
|
|
27
|
+
return this._getListResponse('/v1/assignments', { ...params, cursor }, options);
|
|
28
|
+
};
|
|
29
|
+
const firstPage = await fetchPage(params?.cursor);
|
|
30
|
+
return createList(firstPage, fetchPage);
|
|
31
|
+
}
|
|
32
|
+
}
|
|
33
|
+
//# sourceMappingURL=assignments.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"assignments.js","sourceRoot":"","sources":["../../src/resources/assignments.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;;;;;;OAMG;IACH,KAAK,CAAC,QAAQ,CACZ,EAAU,EACV,OAAwB;QAExB,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAmB,mBAAmB,kBAAkB,CAAC,EAAE,CAAC,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,IAAI,CACR,MAA6B,EAC7B,OAAwB;QAExB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAa,iBAAiB,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;CACF"}
|
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
import { BaseResource } from '../resource.js';
|
|
2
2
|
import { type SignaList } from '../pagination.js';
|
|
3
|
-
import type { Attorney, AttorneySummary, AttorneyClient, TrademarkSummary, AttorneyRetrieveParams, AttorneyListParams, AttorneyTrademarksParams, AttorneyClientsParams, RequestOptions } from '../types.js';
|
|
3
|
+
import type { Attorney, AttorneySummary, AttorneyClient, TrademarkSummary, AttorneyRetrieveParams, AttorneyListParams, AttorneyTrademarksParams, AttorneyClientsParams, RequestOptions, AnalyticsReport } from '../types.js';
|
|
4
4
|
export declare class Attorneys extends BaseResource {
|
|
5
|
+
analytics(id: string, options?: RequestOptions): Promise<AnalyticsReport>;
|
|
5
6
|
/**
|
|
6
7
|
* Retrieve a single attorney by ID.
|
|
7
8
|
*
|
|
@@ -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,
|
|
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,EACd,eAAe,EAChB,MAAM,aAAa,CAAC;AAErB,qBAAa,SAAU,SAAQ,YAAY;IACnC,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,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"}
|
|
@@ -1,6 +1,10 @@
|
|
|
1
1
|
import { BaseResource } from '../resource.js';
|
|
2
2
|
import { createList } from '../pagination.js';
|
|
3
3
|
export class Attorneys extends BaseResource {
|
|
4
|
+
async analytics(id, options) {
|
|
5
|
+
this._validateId(id);
|
|
6
|
+
return this._get(`/v1/attorneys/${encodeURIComponent(id)}/analytics`, undefined, options);
|
|
7
|
+
}
|
|
4
8
|
/**
|
|
5
9
|
* Retrieve a single attorney by ID.
|
|
6
10
|
*
|
|
@@ -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;
|
|
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;AAc9D,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC,KAAK,CAAC,SAAS,CAAC,EAAU,EAAE,OAAwB;QAClD,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAkB,iBAAiB,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC7G,CAAC;IACD;;;;;;;;;;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,29 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import type { CompareParams, CompareResult, RequestOptions } from '../types.js';
|
|
3
|
+
/**
|
|
4
|
+
* Pair comparison operations — PUBLIC beta (requires the `screening:read`
|
|
5
|
+
* scope, granted to design partners during beta).
|
|
6
|
+
*/
|
|
7
|
+
export declare class Compare extends BaseResource {
|
|
8
|
+
/**
|
|
9
|
+
* Compare one candidate against 1-10 specific conflicts — `POST /v1/compare`.
|
|
10
|
+
*
|
|
11
|
+
* PUBLIC beta. Requires the `screening:read` scope, granted to design partners
|
|
12
|
+
* during beta. Returns a coarse risk band plus numeric similarity dimensions
|
|
13
|
+
* for each pair. Billed at 10 units per request. Not legal advice.
|
|
14
|
+
*
|
|
15
|
+
* ```typescript
|
|
16
|
+
* const result = await signa.compare.compare({
|
|
17
|
+
* candidate: {
|
|
18
|
+
* mark: 'KOFEE',
|
|
19
|
+
* use: { nice_classes: [30, 43], business_description: 'Coffee and cafe services' },
|
|
20
|
+
* },
|
|
21
|
+
* conflicts: [{ trademark_id: 'tm_abc123' }],
|
|
22
|
+
* jurisdictions: ['US'],
|
|
23
|
+
* });
|
|
24
|
+
* // result.data[0].similarity?.string → 0..1
|
|
25
|
+
* ```
|
|
26
|
+
*/
|
|
27
|
+
compare(params: CompareParams, options?: RequestOptions): Promise<CompareResult>;
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=compare.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"compare.d.ts","sourceRoot":"","sources":["../../src/resources/compare.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,aAAa,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAEhF;;;GAGG;AACH,qBAAa,OAAQ,SAAQ,YAAY;IACvC;;;;;;;;;;;;;;;;;;OAkBG;IACG,OAAO,CAAC,MAAM,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,aAAa,CAAC;CAGvF"}
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
/**
|
|
3
|
+
* Pair comparison operations — PUBLIC beta (requires the `screening:read`
|
|
4
|
+
* scope, granted to design partners during beta).
|
|
5
|
+
*/
|
|
6
|
+
export class Compare extends BaseResource {
|
|
7
|
+
/**
|
|
8
|
+
* Compare one candidate against 1-10 specific conflicts — `POST /v1/compare`.
|
|
9
|
+
*
|
|
10
|
+
* PUBLIC beta. Requires the `screening:read` scope, granted to design partners
|
|
11
|
+
* during beta. Returns a coarse risk band plus numeric similarity dimensions
|
|
12
|
+
* for each pair. Billed at 10 units per request. Not legal advice.
|
|
13
|
+
*
|
|
14
|
+
* ```typescript
|
|
15
|
+
* const result = await signa.compare.compare({
|
|
16
|
+
* candidate: {
|
|
17
|
+
* mark: 'KOFEE',
|
|
18
|
+
* use: { nice_classes: [30, 43], business_description: 'Coffee and cafe services' },
|
|
19
|
+
* },
|
|
20
|
+
* conflicts: [{ trademark_id: 'tm_abc123' }],
|
|
21
|
+
* jurisdictions: ['US'],
|
|
22
|
+
* });
|
|
23
|
+
* // result.data[0].similarity?.string → 0..1
|
|
24
|
+
* ```
|
|
25
|
+
*/
|
|
26
|
+
async compare(params, options) {
|
|
27
|
+
return this._post('/v1/compare', params, options);
|
|
28
|
+
}
|
|
29
|
+
}
|
|
30
|
+
//# sourceMappingURL=compare.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"compare.js","sourceRoot":"","sources":["../../src/resources/compare.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C;;;GAGG;AACH,MAAM,OAAO,OAAQ,SAAQ,YAAY;IACvC;;;;;;;;;;;;;;;;;;OAkBG;IACH,KAAK,CAAC,OAAO,CAAC,MAAqB,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,KAAK,CAAgB,aAAa,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;IACnE,CAAC;CACF"}
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { type SignaList } from '../pagination.js';
|
|
3
|
+
import type { DeadlineComputation, DeadlineComputeParams, RequestOptions } from '../types.js';
|
|
4
|
+
export declare class Deadlines extends BaseResource {
|
|
5
|
+
/**
|
|
6
|
+
* Compute trademark maintenance deadlines for one or more marks.
|
|
7
|
+
*
|
|
8
|
+
* Scope: `trademarks:read`. Billed as 1 unit per item.
|
|
9
|
+
*
|
|
10
|
+
* ```typescript
|
|
11
|
+
* const results = await signa.deadlines.compute({
|
|
12
|
+
* items: [{
|
|
13
|
+
* jurisdiction: 'US',
|
|
14
|
+
* filing_route: 'national',
|
|
15
|
+
* status: 'registered',
|
|
16
|
+
* filing_date: '2019-01-15',
|
|
17
|
+
* registration_date: '2020-03-10',
|
|
18
|
+
* }],
|
|
19
|
+
* });
|
|
20
|
+
* ```
|
|
21
|
+
*/
|
|
22
|
+
compute(body: DeadlineComputeParams, options?: RequestOptions): Promise<SignaList<DeadlineComputation>>;
|
|
23
|
+
}
|
|
24
|
+
//# sourceMappingURL=deadlines.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deadlines.d.ts","sourceRoot":"","sources":["../../src/resources/deadlines.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,mBAAmB,EACnB,qBAAqB,EAErB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;;;;;;;OAgBG;IACG,OAAO,CACX,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,mBAAmB,CAAC,CAAC;CAU3C"}
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { createList } from '../pagination.js';
|
|
3
|
+
export class Deadlines extends BaseResource {
|
|
4
|
+
/**
|
|
5
|
+
* Compute trademark maintenance deadlines for one or more marks.
|
|
6
|
+
*
|
|
7
|
+
* Scope: `trademarks:read`. Billed as 1 unit per item.
|
|
8
|
+
*
|
|
9
|
+
* ```typescript
|
|
10
|
+
* const results = await signa.deadlines.compute({
|
|
11
|
+
* items: [{
|
|
12
|
+
* jurisdiction: 'US',
|
|
13
|
+
* filing_route: 'national',
|
|
14
|
+
* status: 'registered',
|
|
15
|
+
* filing_date: '2019-01-15',
|
|
16
|
+
* registration_date: '2020-03-10',
|
|
17
|
+
* }],
|
|
18
|
+
* });
|
|
19
|
+
* ```
|
|
20
|
+
*/
|
|
21
|
+
async compute(body, options) {
|
|
22
|
+
const response = await this._post('/v1/deadlines/compute', body, options);
|
|
23
|
+
return createList({ ...response, has_more: false }, () => Promise.resolve({ ...response, data: [], has_more: false }));
|
|
24
|
+
}
|
|
25
|
+
}
|
|
26
|
+
//# sourceMappingURL=deadlines.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"deadlines.js","sourceRoot":"","sources":["../../src/resources/deadlines.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;;;;;;;;;;;;;;;;OAgBG;IACH,KAAK,CAAC,OAAO,CACX,IAA2B,EAC3B,OAAwB;QAExB,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,KAAK,CAC/B,uBAAuB,EACvB,IAAI,EACJ,OAAO,CACR,CAAC;QACF,OAAO,UAAU,CAAC,EAAE,GAAG,QAAQ,EAAE,QAAQ,EAAE,KAAK,EAAE,EAAE,GAAG,EAAE,CACvD,OAAO,CAAC,OAAO,CAAC,EAAE,GAAG,QAAQ,EAAE,IAAI,EAAE,EAAE,EAAE,QAAQ,EAAE,KAAK,EAAE,CAAC,CAC5D,CAAC;IACJ,CAAC;CACF"}
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { BaseResource } from '../resource.js';
|
|
2
2
|
import { type SignaList } from '../pagination.js';
|
|
3
|
-
import type { EntityDetail, EntitySummary, EntityFamily, TrademarkSummary, EntityRetrieveParams, EntityListParams, EntityTrademarksParams, EntityFamilyParams, RequestOptions } from '../types.js';
|
|
3
|
+
import type { EntityDetail, EntitySummary, EntityFamily, TrademarkSummary, EntityRetrieveParams, EntityListParams, EntityTrademarksParams, EntityFamilyParams, AnalyticsReport, RequestOptions } from '../types.js';
|
|
4
4
|
/**
|
|
5
5
|
* Resolved entities (PLN-118 "link, don't merge") — the cross-office identity
|
|
6
6
|
* layer over per-office owner clusters. An `ent_*` id is either a RESOLVED
|
|
@@ -9,6 +9,7 @@ import type { EntityDetail, EntitySummary, EntityFamily, TrademarkSummary, Entit
|
|
|
9
9
|
* entity (its `id` may differ from the one requested).
|
|
10
10
|
*/
|
|
11
11
|
export declare class Entities extends BaseResource {
|
|
12
|
+
analytics(id: string, options?: RequestOptions): Promise<AnalyticsReport>;
|
|
12
13
|
/**
|
|
13
14
|
* Retrieve a single entity by ID.
|
|
14
15
|
*
|
|
@@ -1 +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;
|
|
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,eAAe,EACf,cAAc,EACf,MAAM,aAAa,CAAC;AAErB;;;;;;GAMG;AACH,qBAAa,QAAS,SAAQ,YAAY;IAClC,SAAS,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,eAAe,CAAC;IAK/E;;;;;;;;;;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"}
|
|
@@ -8,6 +8,10 @@ import { createList } from '../pagination.js';
|
|
|
8
8
|
* entity (its `id` may differ from the one requested).
|
|
9
9
|
*/
|
|
10
10
|
export class Entities extends BaseResource {
|
|
11
|
+
async analytics(id, options) {
|
|
12
|
+
this._validateId(id);
|
|
13
|
+
return this._get(`/v1/entities/${encodeURIComponent(id)}/analytics`, undefined, options);
|
|
14
|
+
}
|
|
11
15
|
/**
|
|
12
16
|
* Retrieve a single entity by ID.
|
|
13
17
|
*
|
|
@@ -1 +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;
|
|
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;AAc9D;;;;;;GAMG;AACH,MAAM,OAAO,QAAS,SAAQ,YAAY;IACxC,KAAK,CAAC,SAAS,CAAC,EAAU,EAAE,OAAwB;QAClD,IAAI,CAAC,WAAW,CAAC,EAAE,CAAC,CAAC;QACrB,OAAO,IAAI,CAAC,IAAI,CAAkB,gBAAgB,kBAAkB,CAAC,EAAE,CAAC,YAAY,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC5G,CAAC;IAED;;;;;;;;;;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"}
|
|
@@ -4,7 +4,7 @@ import type { OrgEvent, OrgEventDetail, OrgEventListParams, RequestOptions } fro
|
|
|
4
4
|
export declare class Events extends BaseResource {
|
|
5
5
|
/** List organization events. */
|
|
6
6
|
list(params?: OrgEventListParams, options?: RequestOptions): Promise<SignaList<OrgEvent>>;
|
|
7
|
-
/** Retrieve an event with before/after diffs. IDs are
|
|
8
|
-
retrieve(id:
|
|
7
|
+
/** Retrieve an event with before/after diffs. IDs are evt_-prefixed strings. */
|
|
8
|
+
retrieve(id: string, options?: RequestOptions): Promise<OrgEventDetail>;
|
|
9
9
|
}
|
|
10
10
|
//# sourceMappingURL=events.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/resources/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE9D,OAAO,KAAK,EACV,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,MAAO,SAAQ,YAAY;IACtC,gCAAgC;IAC1B,IAAI,CAAC,MAAM,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAe/F,
|
|
1
|
+
{"version":3,"file":"events.d.ts","sourceRoot":"","sources":["../../src/resources/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE9D,OAAO,KAAK,EACV,QAAQ,EACR,cAAc,EACd,kBAAkB,EAClB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,MAAO,SAAQ,YAAY;IACtC,gCAAgC;IAC1B,IAAI,CAAC,MAAM,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAe/F,gFAAgF;IAC1E,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,cAAc,CAAC;CAM9E"}
|
package/dist/resources/events.js
CHANGED
|
@@ -7,12 +7,12 @@ export class Events extends BaseResource {
|
|
|
7
7
|
const response = await this._getListResponse('/v1/events', params, options);
|
|
8
8
|
return createList(response, (cursor) => this._getListResponse('/v1/events', { ...params, cursor }, options));
|
|
9
9
|
}
|
|
10
|
-
/** Retrieve an event with before/after diffs. IDs are
|
|
10
|
+
/** Retrieve an event with before/after diffs. IDs are evt_-prefixed strings. */
|
|
11
11
|
async retrieve(id, options) {
|
|
12
12
|
if (id === undefined || id === null || id === '') {
|
|
13
13
|
throw new SignaError('id is required and must be a non-empty string');
|
|
14
14
|
}
|
|
15
|
-
return this._get(`/v1/events/${
|
|
15
|
+
return this._get(`/v1/events/${id}`, undefined, options);
|
|
16
16
|
}
|
|
17
17
|
}
|
|
18
18
|
//# sourceMappingURL=events.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/resources/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAQ1C,MAAM,OAAO,MAAO,SAAQ,YAAY;IACtC,gCAAgC;IAChC,KAAK,CAAC,IAAI,CAAC,MAA2B,EAAE,OAAwB;QAC9D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAC1C,YAAY,EACZ,MAAiC,EACjC,OAAO,CACR,CAAC;QACF,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,IAAI,CAAC,gBAAgB,CACnB,YAAY,EACZ,EAAE,GAAG,MAAM,EAAE,MAAM,EAA6B,EAChD,OAAO,CACR,CACF,CAAC;IACJ,CAAC;IAED,
|
|
1
|
+
{"version":3,"file":"events.js","sourceRoot":"","sources":["../../src/resources/events.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAQ1C,MAAM,OAAO,MAAO,SAAQ,YAAY;IACtC,gCAAgC;IAChC,KAAK,CAAC,IAAI,CAAC,MAA2B,EAAE,OAAwB;QAC9D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAC1C,YAAY,EACZ,MAAiC,EACjC,OAAO,CACR,CAAC;QACF,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,IAAI,CAAC,gBAAgB,CACnB,YAAY,EACZ,EAAE,GAAG,MAAM,EAAE,MAAM,EAA6B,EAChD,OAAO,CACR,CACF,CAAC;IACJ,CAAC;IAED,gFAAgF;IAChF,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAwB;QACjD,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACjD,MAAM,IAAI,UAAU,CAAC,+CAA+C,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAiB,cAAc,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAC3E,CAAC;CACF"}
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { type SignaList } from '../pagination.js';
|
|
3
|
+
import type { Feedback, FeedbackCreateParams, FeedbackListParams, RequestOptions } from '../types.js';
|
|
4
|
+
export declare class FeedbackResource extends BaseResource {
|
|
5
|
+
/**
|
|
6
|
+
* Submit structured customer feedback (data issue, bug, feature request, or
|
|
7
|
+
* other). Free (never billed), org-scoped, idempotent via the standard
|
|
8
|
+
* Idempotency-Key header (auto-injected by the SDK).
|
|
9
|
+
*/
|
|
10
|
+
create(body: FeedbackCreateParams, options?: RequestOptions): Promise<Feedback>;
|
|
11
|
+
/**
|
|
12
|
+
* List feedback submitted by the authenticated organization. Cursor-paginated,
|
|
13
|
+
* newest-first. Filterable by type, status, and created-at range.
|
|
14
|
+
*/
|
|
15
|
+
list(params?: FeedbackListParams, options?: RequestOptions): Promise<SignaList<Feedback>>;
|
|
16
|
+
/** Retrieve a single feedback item by its fbk_-prefixed ID. */
|
|
17
|
+
retrieve(id: string, options?: RequestOptions): Promise<Feedback>;
|
|
18
|
+
}
|
|
19
|
+
//# sourceMappingURL=feedback.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feedback.d.ts","sourceRoot":"","sources":["../../src/resources/feedback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAE9D,OAAO,KAAK,EACV,QAAQ,EACR,oBAAoB,EACpB,kBAAkB,EAClB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,gBAAiB,SAAQ,YAAY;IAChD;;;;OAIG;IACG,MAAM,CAAC,IAAI,EAAE,oBAAoB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;IAIrF;;;OAGG;IACG,IAAI,CAAC,MAAM,CAAC,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;IAe/F,+DAA+D;IACzD,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,QAAQ,CAAC;CAMxE"}
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { createList } from '../pagination.js';
|
|
3
|
+
import { SignaError } from '../errors.js';
|
|
4
|
+
export class FeedbackResource extends BaseResource {
|
|
5
|
+
/**
|
|
6
|
+
* Submit structured customer feedback (data issue, bug, feature request, or
|
|
7
|
+
* other). Free (never billed), org-scoped, idempotent via the standard
|
|
8
|
+
* Idempotency-Key header (auto-injected by the SDK).
|
|
9
|
+
*/
|
|
10
|
+
async create(body, options) {
|
|
11
|
+
return this._post('/v1/feedback', body, options);
|
|
12
|
+
}
|
|
13
|
+
/**
|
|
14
|
+
* List feedback submitted by the authenticated organization. Cursor-paginated,
|
|
15
|
+
* newest-first. Filterable by type, status, and created-at range.
|
|
16
|
+
*/
|
|
17
|
+
async list(params, options) {
|
|
18
|
+
const response = await this._getListResponse('/v1/feedback', params, options);
|
|
19
|
+
return createList(response, (cursor) => this._getListResponse('/v1/feedback', { ...params, cursor }, options));
|
|
20
|
+
}
|
|
21
|
+
/** Retrieve a single feedback item by its fbk_-prefixed ID. */
|
|
22
|
+
async retrieve(id, options) {
|
|
23
|
+
if (id === undefined || id === null || id === '') {
|
|
24
|
+
throw new SignaError('id is required and must be a non-empty string');
|
|
25
|
+
}
|
|
26
|
+
return this._get(`/v1/feedback/${id}`, undefined, options);
|
|
27
|
+
}
|
|
28
|
+
}
|
|
29
|
+
//# sourceMappingURL=feedback.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"feedback.js","sourceRoot":"","sources":["../../src/resources/feedback.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAC9D,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAC;AAQ1C,MAAM,OAAO,gBAAiB,SAAQ,YAAY;IAChD;;;;OAIG;IACH,KAAK,CAAC,MAAM,CAAC,IAA0B,EAAE,OAAwB;QAC/D,OAAO,IAAI,CAAC,KAAK,CAAW,cAAc,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IAC7D,CAAC;IAED;;;OAGG;IACH,KAAK,CAAC,IAAI,CAAC,MAA2B,EAAE,OAAwB;QAC9D,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAC1C,cAAc,EACd,MAAiC,EACjC,OAAO,CACR,CAAC;QACF,OAAO,UAAU,CAAC,QAAQ,EAAE,CAAC,MAAM,EAAE,EAAE,CACrC,IAAI,CAAC,gBAAgB,CACnB,cAAc,EACd,EAAE,GAAG,MAAM,EAAE,MAAM,EAA6B,EAChD,OAAO,CACR,CACF,CAAC;IACJ,CAAC;IAED,+DAA+D;IAC/D,KAAK,CAAC,QAAQ,CAAC,EAAU,EAAE,OAAwB;QACjD,IAAI,EAAE,KAAK,SAAS,IAAI,EAAE,KAAK,IAAI,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC;YACjD,MAAM,IAAI,UAAU,CAAC,+CAA+C,CAAC,CAAC;QACxE,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAW,gBAAgB,EAAE,EAAE,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACvE,CAAC;CACF"}
|