@signa-so/sdk 0.9.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -7
- package/dist/client.d.ts +11 -8
- package/dist/client.d.ts.map +1 -1
- package/dist/client.js +14 -10
- package/dist/client.js.map +1 -1
- package/dist/errors.d.ts +54 -1
- package/dist/errors.d.ts.map +1 -1
- package/dist/errors.js +80 -3
- package/dist/errors.js.map +1 -1
- package/dist/generated/api-types.d.ts +13251 -6295
- package/dist/generated/api-types.d.ts.map +1 -1
- package/dist/index.d.ts +2 -2
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/pagination.d.ts +23 -2
- package/dist/pagination.d.ts.map +1 -1
- package/dist/pagination.js +45 -4
- package/dist/pagination.js.map +1 -1
- package/dist/resources/citations.d.ts +33 -0
- package/dist/resources/citations.d.ts.map +1 -0
- package/dist/resources/citations.js +38 -0
- package/dist/resources/citations.js.map +1 -0
- package/dist/resources/credits.d.ts +7 -0
- package/dist/resources/credits.d.ts.map +1 -0
- package/dist/resources/credits.js +8 -0
- package/dist/resources/credits.js.map +1 -0
- package/dist/resources/deadlines.d.ts +38 -4
- package/dist/resources/deadlines.d.ts.map +1 -1
- package/dist/resources/deadlines.js +39 -2
- package/dist/resources/deadlines.js.map +1 -1
- package/dist/resources/entities.d.ts +6 -7
- package/dist/resources/entities.d.ts.map +1 -1
- package/dist/resources/entities.js +6 -7
- package/dist/resources/entities.js.map +1 -1
- package/dist/resources/events.d.ts.map +1 -1
- package/dist/resources/events.js +4 -1
- package/dist/resources/events.js.map +1 -1
- package/dist/resources/fees.d.ts +10 -0
- package/dist/resources/fees.d.ts.map +1 -0
- package/dist/resources/fees.js +14 -0
- package/dist/resources/fees.js.map +1 -0
- package/dist/resources/goods-services.d.ts +36 -2
- package/dist/resources/goods-services.d.ts.map +1 -1
- package/dist/resources/goods-services.js +37 -1
- package/dist/resources/goods-services.js.map +1 -1
- package/dist/resources/organization.d.ts +8 -1
- package/dist/resources/organization.d.ts.map +1 -1
- package/dist/resources/organization.js +9 -0
- package/dist/resources/organization.js.map +1 -1
- package/dist/resources/portfolios.d.ts +46 -20
- package/dist/resources/portfolios.d.ts.map +1 -1
- package/dist/resources/portfolios.js +39 -5
- package/dist/resources/portfolios.js.map +1 -1
- package/dist/resources/reconcile.d.ts +21 -1
- package/dist/resources/reconcile.d.ts.map +1 -1
- package/dist/resources/reconcile.js +21 -1
- package/dist/resources/reconcile.js.map +1 -1
- package/dist/resources/references.d.ts +21 -9
- package/dist/resources/references.d.ts.map +1 -1
- package/dist/resources/references.js +26 -11
- package/dist/resources/references.js.map +1 -1
- package/dist/resources/trademarks.d.ts +42 -4
- package/dist/resources/trademarks.d.ts.map +1 -1
- package/dist/resources/trademarks.js +284 -3
- package/dist/resources/trademarks.js.map +1 -1
- package/dist/resources/watches.d.ts +3 -7
- package/dist/resources/watches.d.ts.map +1 -1
- package/dist/resources/watches.js +2 -16
- package/dist/resources/watches.js.map +1 -1
- package/dist/types.d.ts +1187 -573
- package/dist/types.d.ts.map +1 -1
- package/dist/version.d.ts +1 -1
- package/dist/version.d.ts.map +1 -1
- package/dist/version.js +1 -1
- package/dist/version.js.map +1 -1
- package/package.json +3 -3
- package/dist/resources/saved-searches.d.ts +0 -22
- package/dist/resources/saved-searches.d.ts.map +0 -1
- package/dist/resources/saved-searches.js +0 -39
- package/dist/resources/saved-searches.js.map +0 -1
- package/dist/resources/suggest.d.ts +0 -16
- package/dist/resources/suggest.d.ts.map +0 -1
- package/dist/resources/suggest.js +0 -18
- package/dist/resources/suggest.js.map +0 -1
package/dist/index.d.ts
CHANGED
|
@@ -3,9 +3,9 @@ export { Signa as default } from './client.js';
|
|
|
3
3
|
export { primaryOwnerName } from './resources/trademarks.js';
|
|
4
4
|
export { Analytics } from './resources/analytics.js';
|
|
5
5
|
export { categoryToNiceClasses, CATEGORY_NICE_TABLE } from './category-nice.js';
|
|
6
|
-
export { SignaError, SignaAPIError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, RateLimitError, InternalServerError, ConnectionError, TimeoutError, } from './errors.js';
|
|
6
|
+
export { SignaError, SignaAPIError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, GoneError, RateLimitError, InternalServerError, ConnectionError, TimeoutError, SignaTruncatedError, isExternalRefConflict, isResourceQuotaExceeded, } from './errors.js';
|
|
7
7
|
export { SignaList } from './pagination.js';
|
|
8
8
|
export { verifyWebhookSignature } from './webhooks.js';
|
|
9
9
|
export type { WebhookSignatureHeaders } from './webhooks.js';
|
|
10
|
-
export type { Trademark, TrademarkSummary, TrademarkRelationship, TrademarkDocument, TrademarkDocumentSourceSync, Event, Owner, OwnerSummary, EntitySummary, EntityDetail, EntityMember, EntityMemberLink, EntityCompany, EntityListing, EntityListedAncestor, EntityFamily, EntityFamilyNode, Attorney, AttorneySummary, Firm, FirmSummary, Proceeding, ProceedingDetail, Assignment, AssignmentDetail, TrademarkAssignment, TrademarkSearchResult,
|
|
10
|
+
export type { FeeRule, FeeSource, FeeEstimateLine, FeeEstimateParams, FeeEstimate, FeeListParams, FeeListResponse, Trademark, TrademarkSummary, TrademarkGrain, TrademarkEvent, Address, StatusCode, StatusCodeListParams, EventTypeListParams, TrademarkRelationship, TrademarkDocument, TrademarkDocumentSourceSync, Event, Owner, OwnerSummary, EntitySummary, EntityDetail, EntityMember, EntityMemberLink, EntityCompany, EntityListing, EntityListedAncestor, EntityFamily, EntityFamilyNode, Attorney, AttorneySummary, Firm, FirmSummary, Proceeding, ProceedingDetail, Citation, CitationTrademarkSummary, CitationDisposition, CitationActionStage, CitationRefusalType, Assignment, AssignmentDetail, TrademarkAssignment, TrademarkSearchResult, Classification, ClassificationDetail, AcceptedTerm, ClassificationSuggestionLite, ClassificationSuggestResult, GoodsServicesSuggestionClass, GoodsServicesSuggestResult, GoodsServicesTerm, GoodsServicesValidation, GoodsServicesValidationCandidate, GoodsServicesValidationSpan, GoodsServicesValidationTemplate, GoodsServicesValidationTemplateSlot, GoodsServicesValidationCoverage, CandidateSearch, CandidateSearchReason, GoodsServicesClassInference, GoodsServicesClassSource, WordingWarning, GoodsServicesValidationCatalogFreshness, GoodsServicesValidationSummaryCandidateSearch, GoodsServicesValidationSummaryWarningCount, GoodsServicesValidationResponse, ValidationItemStatus, OfficeVerdictStatus, Office, OfficeDetail, OfficeVote, OfficeVoteDeleted, CastOfficeVotesParams, OfficeAnalytics, MarketAnalytics, ClassificationAnalytics, AnalyticsReport, TrademarkAggregationName, TrademarkAggregationMode, Jurisdiction, JurisdictionDetail, DeadlineRule, ComputedDeadline, DeadlineComputation, DeadlineComputeItem, DeadlineComputeResult, DeadlineListParams, DeadlineListRow, DeadlineUnsupportedMark, UnsupportedDeadlineRule, DeadlineComputeResponse, DeadlineUnsupportedReason, DeadlineSupport, ProsecutionFact, ProsecutionMaintenanceFiling, ProsecutionDeadline, ProsecutionRuleIdentity, ProsecutionRuleSource, OppositionRule, OppositionCommonExtension, OppositionWindowSource, OppositionWindowComputation, OppositionComputeItem, OppositionComputeResponse, ReconcileFieldDiff, ReconcileYourFields, ReconcileItem, Reconciliation, ReconcileResponse, FieldVerdict, ReconcileVerdict, VerdictBasis, DocketedDeadline, ReconcileLookup, ReconcileComputedContext, ReconcileVerdictCounts, RuleSource, EventType, DesignCode, DesignCodeDetail, TrademarkProceeding, OwnerRelated, Portfolio, PortfolioResponse, PortfolioDetail, PortfolioMark, PortfolioMarkList, PortfolioMarksAddResult, PortfolioMarksRemoveResult, Feedback, FeedbackType, FeedbackStatus, FeedbackCreateParams, FeedbackListParams, Watch, WatchType, WatchStatus, WatchDeliveryMode, WatchTriggerEvent, WatchQuery, WatchPreviewResponse, WatchDiagnostics, WatchDiagnosticsLeaseState, WatchDiagnosticsWindowStatus, WatchAttestation, WatchAttestationOffice, WatchAttestationGap, Alert, AlertEventType, AlertSeverity, OppositionWindowStatus, HolidayAdjustment, Webhook, WebhookDisabledReason, WebhookEvent, WebhookEventType, WebhookStatus, WebhookDelivery, WebhookDeliveryStatus, WebhookTestResponse, WebhookRedeliveryResponse, AlertCreatedData, AlertCreatedPayload, AlertCreatedFlatFields, AlertCreatedEvent, EventPortfolioRef, TrademarkStatusChangedData, TrademarkStatusChangedEvent, OfficeActionIssuedData, OfficeActionIssuedDataV1, OfficeActionIssuedDataV2, OfficeActionIssuedEvent, OfficeActionIssuedOrgEventDetail, OrgEvent, OrgEventDetail, TrademarkOrgEventDetail, AlertCreatedOrgEventDetail, Identity, Usage, ApiKey, ApiKeyWithRawKey, RequestLog, RequestLogDetail, UsageSummaryResponse, UsageSummaryItem, UsageBillingPeriod, UsageEstimate, UsageEstimateAction, UsageEstimateUnmapped, UsageEstimatePlan, UsageEstimateOffer, UsageEstimatePacks, CreditBalance, CreditPrice, CreditPricingResponse, CreditGrantBreakdown, CreditExpiryScheduleEntry, DeletedResponse, SearchMeta, SearchWarning, APIErrorBody, ExternalRefConflictErrorBody, ResourceQuotaExceededErrorBody, QuotaScope, MatchMode, OppositionStatus, SeniorityClaims, TrademarkSearchInclude, TrademarkDetailInclude, AttorneyStats, OwnerStats, TrademarkBatchBody, TrademarkBatchResponse, TrademarkSuggestion, AttorneyClient, TrademarkRetrieveParams, TrademarkListParams, TrademarkEventsParams, TrademarkSuggestParams, TrademarkProceedingsParams, TrademarkAssignmentsParams, TrademarkDocumentParams, TrademarkCitationsParams, TrademarkCitedByParams, OwnerRetrieveParams, OwnerListParams, OwnerTrademarksParams, OwnerRelatedParams, EntityRetrieveParams, EntityListParams, EntityTrademarksParams, EntityFamilyParams, AttorneyRetrieveParams, AttorneyListParams, AttorneyTrademarksParams, AttorneyClientsParams, FirmRetrieveParams, FirmListParams, FirmAttorneysParams, FirmTrademarksParams, ProceedingListParams, CitationListParams, ConveyanceType, AssignmentListParams, TrademarkSearchBody, SearchV2Body, ClassificationListParams, ClassificationSuggestParams, DesignCodeListParams, DeadlineComputeParams, OppositionComputeParams, ReconcileParams, GoodsServicesListParams, GoodsServicesSuggestParams, GoodsServicesValidateParams, GoodsServicesValidateItem, PortfolioCreateParams, PortfolioUpdateParams, PortfolioListParams, PortfolioRetrieveParams, PortfolioAddTrademarksBody, PortfolioAddTrademarkItem, PortfolioRemoveTrademarksBody, PortfolioDeadlineParams, PortfolioDeadlinesIcalParams, WatchCreateParams, WatchUpdateParams, WatchListParams, WatchReplayParams, WatchPreviewParams, WatchBulkParams, WatchDiagnosticsParams, WatchAttestationParams, AlertListParams, AlertLookupParams, WebhookCreateParams, WebhookUpdateParams, WebhookListParams, WebhookDeliveryListParams, OrgEventListParams, ApiKeyCreateParams, ApiKeyUpdateParams, LogListParams, UsageSummaryParams, UsageEstimateParams, 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';
|
|
11
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;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,
|
|
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,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,GACxB,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,OAAO,EACP,SAAS,EACT,eAAe,EACf,iBAAiB,EACjB,WAAW,EACX,aAAa,EACb,eAAe,EACf,SAAS,EACT,gBAAgB,EAChB,cAAc,EACd,cAAc,EACd,OAAO,EACP,UAAU,EACV,oBAAoB,EACpB,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,2BAA2B,EAC3B,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,QAAQ,EACR,wBAAwB,EACxB,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,UAAU,EACV,gBAAgB,EAChB,mBAAmB,EACnB,qBAAqB,EACrB,cAAc,EACd,oBAAoB,EACpB,YAAY,EACZ,4BAA4B,EAC5B,2BAA2B,EAC3B,4BAA4B,EAC5B,0BAA0B,EAC1B,iBAAiB,EACjB,uBAAuB,EACvB,gCAAgC,EAChC,2BAA2B,EAC3B,+BAA+B,EAC/B,mCAAmC,EACnC,+BAA+B,EAC/B,eAAe,EACf,qBAAqB,EACrB,2BAA2B,EAC3B,wBAAwB,EACxB,cAAc,EACd,uCAAuC,EACvC,6CAA6C,EAC7C,0CAA0C,EAC1C,+BAA+B,EAC/B,oBAAoB,EACpB,mBAAmB,EACnB,MAAM,EACN,YAAY,EACZ,UAAU,EACV,iBAAiB,EACjB,qBAAqB,EACrB,eAAe,EACf,eAAe,EACf,uBAAuB,EACvB,eAAe,EACf,wBAAwB,EACxB,wBAAwB,EACxB,YAAY,EACZ,kBAAkB,EAClB,YAAY,EACZ,gBAAgB,EAChB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACrB,kBAAkB,EAClB,eAAe,EACf,uBAAuB,EACvB,uBAAuB,EACvB,uBAAuB,EACvB,yBAAyB,EACzB,eAAe,EACf,eAAe,EACf,4BAA4B,EAC5B,mBAAmB,EACnB,uBAAuB,EACvB,qBAAqB,EACrB,cAAc,EACd,yBAAyB,EACzB,sBAAsB,EACtB,2BAA2B,EAC3B,qBAAqB,EACrB,yBAAyB,EACzB,kBAAkB,EAClB,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,iBAAiB,EACjB,YAAY,EACZ,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,wBAAwB,EACxB,sBAAsB,EACtB,UAAU,EACV,SAAS,EACT,UAAU,EACV,gBAAgB,EAChB,mBAAmB,EACnB,YAAY,EACZ,SAAS,EACT,iBAAiB,EACjB,eAAe,EACf,aAAa,EACb,iBAAiB,EACjB,uBAAuB,EACvB,0BAA0B,EAC1B,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,iBAAiB,EACjB,OAAO,EACP,qBAAqB,EACrB,YAAY,EACZ,gBAAgB,EAChB,aAAa,EACb,eAAe,EACf,qBAAqB,EACrB,mBAAmB,EACnB,yBAAyB,EACzB,gBAAgB,EAChB,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,EACjB,iBAAiB,EACjB,0BAA0B,EAC1B,2BAA2B,EAC3B,sBAAsB,EACtB,wBAAwB,EACxB,wBAAwB,EACxB,uBAAuB,EACvB,gCAAgC,EAChC,QAAQ,EACR,cAAc,EACd,uBAAuB,EACvB,0BAA0B,EAC1B,QAAQ,EACR,KAAK,EACL,MAAM,EACN,gBAAgB,EAChB,UAAU,EACV,gBAAgB,EAChB,oBAAoB,EACpB,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACnB,qBAAqB,EACrB,iBAAiB,EACjB,kBAAkB,EAClB,kBAAkB,EAClB,aAAa,EACb,WAAW,EACX,qBAAqB,EACrB,oBAAoB,EACpB,yBAAyB,EACzB,eAAe,EACf,UAAU,EACV,aAAa,EACb,YAAY,EACZ,4BAA4B,EAC5B,8BAA8B,EAC9B,UAAU,EAEV,SAAS,EACT,gBAAgB,EAChB,eAAe,EACf,sBAAsB,EACtB,sBAAsB,EAEtB,aAAa,EACb,UAAU,EAEV,kBAAkB,EAClB,sBAAsB,EACtB,mBAAmB,EACnB,cAAc,EACd,uBAAuB,EACvB,mBAAmB,EACnB,qBAAqB,EACrB,sBAAsB,EACtB,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB,EACvB,wBAAwB,EACxB,sBAAsB,EAEtB,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,kBAAkB,EAClB,cAAc,EACd,oBAAoB,EAEpB,mBAAmB,EACnB,YAAY,EAEZ,wBAAwB,EACxB,2BAA2B,EAC3B,oBAAoB,EACpB,qBAAqB,EACrB,uBAAuB,EACvB,eAAe,EAEf,uBAAuB,EACvB,0BAA0B,EAC1B,2BAA2B,EAC3B,yBAAyB,EAEzB,qBAAqB,EACrB,qBAAqB,EACrB,mBAAmB,EACnB,uBAAuB,EACvB,0BAA0B,EAC1B,yBAAyB,EACzB,6BAA6B,EAC7B,uBAAuB,EACvB,4BAA4B,EAE5B,iBAAiB,EACjB,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,EAClB,mBAAmB,EAEnB,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
|
@@ -4,7 +4,7 @@ export { primaryOwnerName } from './resources/trademarks.js';
|
|
|
4
4
|
export { Analytics } from './resources/analytics.js';
|
|
5
5
|
export { categoryToNiceClasses, CATEGORY_NICE_TABLE } from './category-nice.js';
|
|
6
6
|
// ── Error classes (for instanceof checks) ───────────────────────────
|
|
7
|
-
export { SignaError, SignaAPIError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, RateLimitError, InternalServerError, ConnectionError, TimeoutError, } from './errors.js';
|
|
7
|
+
export { SignaError, SignaAPIError, BadRequestError, AuthenticationError, PermissionError, NotFoundError, ConflictError, GoneError, RateLimitError, InternalServerError, ConnectionError, TimeoutError, SignaTruncatedError, isExternalRefConflict, isResourceQuotaExceeded, } from './errors.js';
|
|
8
8
|
// ── Pagination ──────────────────────────────────────────────────────
|
|
9
9
|
export { SignaList } from './pagination.js';
|
|
10
10
|
// ── Webhooks helper ─────────────────────────────────────────────────
|
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;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,
|
|
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,SAAS,EACT,cAAc,EACd,mBAAmB,EACnB,eAAe,EACf,YAAY,EACZ,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,GACxB,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, TrademarkDocumentSourceSync } from './types.js';
|
|
1
|
+
import type { DeadlineUnsupportedMark, 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:
|
|
@@ -43,6 +43,14 @@ export declare class SignaList<T> implements AsyncIterable<T> {
|
|
|
43
43
|
* `entity_id` facet. Only present on search responses with aggregations.
|
|
44
44
|
*/
|
|
45
45
|
readonly aggregation_metadata?: Record<string, Record<string, string>>;
|
|
46
|
+
/**
|
|
47
|
+
* Deadline lists only: marks in the requested portfolio or trademark whose
|
|
48
|
+
* deadlines could not be computed (no rows) or were computed only in part
|
|
49
|
+
* (some rules declined), for the whole scope. Set on the FIRST page (a
|
|
50
|
+
* request without a cursor); `null` on continuation pages; absent on every
|
|
51
|
+
* other list.
|
|
52
|
+
*/
|
|
53
|
+
readonly unsupported_marks?: DeadlineUnsupportedMark[] | null;
|
|
46
54
|
/** @internal */
|
|
47
55
|
private readonly _fetchPage;
|
|
48
56
|
/** @internal Cursor for the next page (null if no more). */
|
|
@@ -67,7 +75,20 @@ export declare class SignaList<T> implements AsyncIterable<T> {
|
|
|
67
75
|
/**
|
|
68
76
|
* Collect items across pages into a single array.
|
|
69
77
|
*
|
|
70
|
-
*
|
|
78
|
+
* With `limit`, returns at most that many items (`Infinity` for every item).
|
|
79
|
+
* Without it, a 10,000-item safety cap applies. Neither cap is silent:
|
|
80
|
+
*
|
|
81
|
+
* - More than 10,000 items and no `limit`: throws {@link SignaTruncatedError}
|
|
82
|
+
* with `reason: 'client_limit'` (its `items` carry the first 10,000).
|
|
83
|
+
* - The API ended the walk at its 10,000-row search window while more rows
|
|
84
|
+
* match (a relevance-ranked or sorted trademark search): throws with
|
|
85
|
+
* `reason: 'server_window'` unless `limit` was already reached. The
|
|
86
|
+
* signal is the API's `result_window_reached` warning in the last page's
|
|
87
|
+
* `search_meta.warnings[]`; counts alone never trigger it. A filter-only
|
|
88
|
+
* browse sorted by `family_updated_at` pages past the window and never
|
|
89
|
+
* carries it.
|
|
90
|
+
*
|
|
91
|
+
* @param opts.limit Maximum items to collect.
|
|
71
92
|
*/
|
|
72
93
|
toArray(opts?: {
|
|
73
94
|
limit?: number;
|
package/dist/pagination.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"pagination.d.ts","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EACV,uBAAuB,EACvB,gBAAgB,EAChB,UAAU,EACV,2BAA2B,EAC5B,MAAM,YAAY,CAAC;AAIpB,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;;;;;;OAMG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,uBAAuB,EAAE,GAAG,IAAI,CAAC;IAE9D,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;IAepE;;;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;;;;;;;;;;;;;;;;;OAiBG;IACG,OAAO,CAAC,IAAI,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,EAAE,CAAC;CAwBvD;AAKD;;;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
|
@@ -1,3 +1,4 @@
|
|
|
1
|
+
import { SignaTruncatedError } from './errors.js';
|
|
1
2
|
const DEFAULT_TO_ARRAY_LIMIT = 10_000;
|
|
2
3
|
/**
|
|
3
4
|
* A list response that supports three consumption patterns:
|
|
@@ -42,6 +43,14 @@ export class SignaList {
|
|
|
42
43
|
* `entity_id` facet. Only present on search responses with aggregations.
|
|
43
44
|
*/
|
|
44
45
|
aggregation_metadata;
|
|
46
|
+
/**
|
|
47
|
+
* Deadline lists only: marks in the requested portfolio or trademark whose
|
|
48
|
+
* deadlines could not be computed (no rows) or were computed only in part
|
|
49
|
+
* (some rules declined), for the whole scope. Set on the FIRST page (a
|
|
50
|
+
* request without a cursor); `null` on continuation pages; absent on every
|
|
51
|
+
* other list.
|
|
52
|
+
*/
|
|
53
|
+
unsupported_marks;
|
|
45
54
|
/** @internal */
|
|
46
55
|
_fetchPage;
|
|
47
56
|
/** @internal Cursor for the next page (null if no more). */
|
|
@@ -57,6 +66,7 @@ export class SignaList {
|
|
|
57
66
|
this.source_sync = response.source_sync;
|
|
58
67
|
this.aggregations = response.aggregations;
|
|
59
68
|
this.aggregation_metadata = response.aggregation_metadata;
|
|
69
|
+
this.unsupported_marks = response.unsupported_marks;
|
|
60
70
|
this._cursor = response.pagination.cursor;
|
|
61
71
|
this._fetchPage = fetchPage;
|
|
62
72
|
}
|
|
@@ -102,19 +112,50 @@ export class SignaList {
|
|
|
102
112
|
/**
|
|
103
113
|
* Collect items across pages into a single array.
|
|
104
114
|
*
|
|
105
|
-
*
|
|
115
|
+
* With `limit`, returns at most that many items (`Infinity` for every item).
|
|
116
|
+
* Without it, a 10,000-item safety cap applies. Neither cap is silent:
|
|
117
|
+
*
|
|
118
|
+
* - More than 10,000 items and no `limit`: throws {@link SignaTruncatedError}
|
|
119
|
+
* with `reason: 'client_limit'` (its `items` carry the first 10,000).
|
|
120
|
+
* - The API ended the walk at its 10,000-row search window while more rows
|
|
121
|
+
* match (a relevance-ranked or sorted trademark search): throws with
|
|
122
|
+
* `reason: 'server_window'` unless `limit` was already reached. The
|
|
123
|
+
* signal is the API's `result_window_reached` warning in the last page's
|
|
124
|
+
* `search_meta.warnings[]`; counts alone never trigger it. A filter-only
|
|
125
|
+
* browse sorted by `family_updated_at` pages past the window and never
|
|
126
|
+
* carries it.
|
|
127
|
+
*
|
|
128
|
+
* @param opts.limit Maximum items to collect.
|
|
106
129
|
*/
|
|
107
130
|
async toArray(opts) {
|
|
131
|
+
const explicit = opts?.limit !== undefined;
|
|
108
132
|
const limit = opts?.limit ?? DEFAULT_TO_ARRAY_LIMIT;
|
|
109
133
|
const items = [];
|
|
110
|
-
|
|
111
|
-
items
|
|
112
|
-
|
|
134
|
+
if (limit <= 0)
|
|
135
|
+
return items;
|
|
136
|
+
// eslint-disable-next-line @typescript-eslint/no-this-alias
|
|
137
|
+
let page = this;
|
|
138
|
+
while (true) {
|
|
139
|
+
for (const item of page.data) {
|
|
140
|
+
// Reaching the default cap is only an error if another item follows.
|
|
141
|
+
if (items.length >= limit)
|
|
142
|
+
throw new SignaTruncatedError(items, limit);
|
|
143
|
+
items.push(item);
|
|
144
|
+
if (explicit && items.length >= limit)
|
|
145
|
+
return items;
|
|
146
|
+
}
|
|
147
|
+
if (!page.has_more)
|
|
113
148
|
break;
|
|
149
|
+
page = await page.getNextPage();
|
|
150
|
+
}
|
|
151
|
+
if (page.search_meta?.warnings?.some((w) => w.code === 'result_window_reached')) {
|
|
152
|
+
throw new SignaTruncatedError(items, SERVER_SEARCH_WINDOW, 'server_window');
|
|
114
153
|
}
|
|
115
154
|
return items;
|
|
116
155
|
}
|
|
117
156
|
}
|
|
157
|
+
/** The API's pagination window for relevance-ranked and sorted trademark searches. */
|
|
158
|
+
const SERVER_SEARCH_WINDOW = 10_000;
|
|
118
159
|
/**
|
|
119
160
|
* Create a SignaList from the initial page fetch.
|
|
120
161
|
* @internal
|
package/dist/pagination.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"pagination.js","sourceRoot":"","sources":["../src/pagination.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,EAAE,MAAM,aAAa,CAAC;AAQlD,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;;;;;;OAMG;IACM,iBAAiB,CAAoC;IAE9D,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,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,CAAC;QACpD,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;;;;;;;;;;;;;;;;;OAiBG;IACH,KAAK,CAAC,OAAO,CAAC,IAAyB;QACrC,MAAM,QAAQ,GAAG,IAAI,EAAE,KAAK,KAAK,SAAS,CAAC;QAC3C,MAAM,KAAK,GAAG,IAAI,EAAE,KAAK,IAAI,sBAAsB,CAAC;QACpD,MAAM,KAAK,GAAQ,EAAE,CAAC;QACtB,IAAI,KAAK,IAAI,CAAC;YAAE,OAAO,KAAK,CAAC;QAE7B,4DAA4D;QAC5D,IAAI,IAAI,GAAiB,IAAI,CAAC;QAC9B,OAAO,IAAI,EAAE,CAAC;YACZ,KAAK,MAAM,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;gBAC7B,qEAAqE;gBACrE,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK;oBAAE,MAAM,IAAI,mBAAmB,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;gBACvE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;gBACjB,IAAI,QAAQ,IAAI,KAAK,CAAC,MAAM,IAAI,KAAK;oBAAE,OAAO,KAAK,CAAC;YACtD,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,QAAQ;gBAAE,MAAM;YAC1B,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;QAClC,CAAC;QAED,IAAI,IAAI,CAAC,WAAW,EAAE,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,uBAAuB,CAAC,EAAE,CAAC;YAChF,MAAM,IAAI,mBAAmB,CAAC,KAAK,EAAE,oBAAoB,EAAE,eAAe,CAAC,CAAC;QAC9E,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED,sFAAsF;AACtF,MAAM,oBAAoB,GAAG,MAAM,CAAC;AAEpC;;;GAGG;AACH,MAAM,UAAU,UAAU,CACxB,eAAoC,EACpC,SAAyB;IAEzB,OAAO,IAAI,SAAS,CAAI,eAAe,EAAE,SAAS,CAAC,CAAC;AACtD,CAAC"}
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { type SignaList } from '../pagination.js';
|
|
3
|
+
import type { Citation, CitationListParams, RequestOptions } from '../types.js';
|
|
4
|
+
export declare class Citations extends BaseResource {
|
|
5
|
+
/**
|
|
6
|
+
* List office-action citations across marks (ENG-338).
|
|
7
|
+
*
|
|
8
|
+
* A citation is a prior mark an examiner cited against a pending
|
|
9
|
+
* application (USPTO §2(d) refusals today — check `capabilities.citations`
|
|
10
|
+
* on `signa.references.offices()` for per-office coverage).
|
|
11
|
+
*
|
|
12
|
+
* `cited_ref` requires `offices`: an office-less reference lookup is
|
|
13
|
+
* unindexable and the API rejects it with a 400.
|
|
14
|
+
*
|
|
15
|
+
* ```typescript
|
|
16
|
+
* const citations = await signa.citations.list({ offices: 'US', disposition: 'maintained' });
|
|
17
|
+
*
|
|
18
|
+
* // Active blockers only
|
|
19
|
+
* const blockers = await signa.citations.list({
|
|
20
|
+
* offices: 'US',
|
|
21
|
+
* disposition: ['maintained', 'abandoned_after'],
|
|
22
|
+
* action_date_gte: '2026-01-01',
|
|
23
|
+
* });
|
|
24
|
+
*
|
|
25
|
+
* // Auto-pagination
|
|
26
|
+
* for await (const citation of await signa.citations.list({ offices: 'US' })) {
|
|
27
|
+
* console.log(citation.cited_ref, citation.disposition);
|
|
28
|
+
* }
|
|
29
|
+
* ```
|
|
30
|
+
*/
|
|
31
|
+
list(params?: CitationListParams, options?: RequestOptions): Promise<SignaList<Citation>>;
|
|
32
|
+
}
|
|
33
|
+
//# sourceMappingURL=citations.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"citations.d.ts","sourceRoot":"","sources":["../../src/resources/citations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EAAE,QAAQ,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAEhF,qBAAa,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACG,IAAI,CACR,MAAM,CAAC,EAAE,kBAAkB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC;CAOhC"}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { createList } from '../pagination.js';
|
|
3
|
+
export class Citations extends BaseResource {
|
|
4
|
+
/**
|
|
5
|
+
* List office-action citations across marks (ENG-338).
|
|
6
|
+
*
|
|
7
|
+
* A citation is a prior mark an examiner cited against a pending
|
|
8
|
+
* application (USPTO §2(d) refusals today — check `capabilities.citations`
|
|
9
|
+
* on `signa.references.offices()` for per-office coverage).
|
|
10
|
+
*
|
|
11
|
+
* `cited_ref` requires `offices`: an office-less reference lookup is
|
|
12
|
+
* unindexable and the API rejects it with a 400.
|
|
13
|
+
*
|
|
14
|
+
* ```typescript
|
|
15
|
+
* const citations = await signa.citations.list({ offices: 'US', disposition: 'maintained' });
|
|
16
|
+
*
|
|
17
|
+
* // Active blockers only
|
|
18
|
+
* const blockers = await signa.citations.list({
|
|
19
|
+
* offices: 'US',
|
|
20
|
+
* disposition: ['maintained', 'abandoned_after'],
|
|
21
|
+
* action_date_gte: '2026-01-01',
|
|
22
|
+
* });
|
|
23
|
+
*
|
|
24
|
+
* // Auto-pagination
|
|
25
|
+
* for await (const citation of await signa.citations.list({ offices: 'US' })) {
|
|
26
|
+
* console.log(citation.cited_ref, citation.disposition);
|
|
27
|
+
* }
|
|
28
|
+
* ```
|
|
29
|
+
*/
|
|
30
|
+
async list(params, options) {
|
|
31
|
+
const fetchPage = async (cursor) => {
|
|
32
|
+
return this._getListResponse('/v1/citations', { ...params, cursor }, options);
|
|
33
|
+
};
|
|
34
|
+
const firstPage = await fetchPage(params?.cursor);
|
|
35
|
+
return createList(firstPage, fetchPage);
|
|
36
|
+
}
|
|
37
|
+
}
|
|
38
|
+
//# sourceMappingURL=citations.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"citations.js","sourceRoot":"","sources":["../../src/resources/citations.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAG9D,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC;;;;;;;;;;;;;;;;;;;;;;;;;OAyBG;IACH,KAAK,CAAC,IAAI,CACR,MAA2B,EAC3B,OAAwB;QAExB,MAAM,SAAS,GAAG,KAAK,EAAE,MAAe,EAAE,EAAE;YAC1C,OAAO,IAAI,CAAC,gBAAgB,CAAW,eAAe,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC1F,CAAC,CAAC;QACF,MAAM,SAAS,GAAG,MAAM,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;QAClD,OAAO,UAAU,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;IAC1C,CAAC;CACF"}
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import type { CreditPricingResponse, RequestOptions } from '../types.js';
|
|
3
|
+
export declare class Credits extends BaseResource {
|
|
4
|
+
/** How many credits each API action costs. This call consumes no credits. */
|
|
5
|
+
pricing(options?: RequestOptions): Promise<CreditPricingResponse>;
|
|
6
|
+
}
|
|
7
|
+
//# sourceMappingURL=credits.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../../src/resources/credits.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,KAAK,EAAE,qBAAqB,EAAE,cAAc,EAAE,MAAM,aAAa,CAAC;AAEzE,qBAAa,OAAQ,SAAQ,YAAY;IACvC,6EAA6E;IACvE,OAAO,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,qBAAqB,CAAC;CAGxE"}
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
export class Credits extends BaseResource {
|
|
3
|
+
/** How many credits each API action costs. This call consumes no credits. */
|
|
4
|
+
async pricing(options) {
|
|
5
|
+
return this._get('/v1/credits/pricing', undefined, options);
|
|
6
|
+
}
|
|
7
|
+
}
|
|
8
|
+
//# sourceMappingURL=credits.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"credits.js","sourceRoot":"","sources":["../../src/resources/credits.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAG9C,MAAM,OAAO,OAAQ,SAAQ,YAAY;IACvC,6EAA6E;IAC7E,KAAK,CAAC,OAAO,CAAC,OAAwB;QACpC,OAAO,IAAI,CAAC,IAAI,CAAwB,qBAAqB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IACrF,CAAC;CACF"}
|
|
@@ -1,11 +1,15 @@
|
|
|
1
1
|
import { BaseResource } from '../resource.js';
|
|
2
2
|
import { type SignaList } from '../pagination.js';
|
|
3
|
-
import type {
|
|
3
|
+
import type { DeadlineComputeResult, DeadlineListParams, DeadlineListRow, DeadlineComputeParams, RequestOptions } from '../types.js';
|
|
4
4
|
export declare class Deadlines extends BaseResource {
|
|
5
|
+
/** List computed maintenance deadlines for exactly one portfolio or trademark. One read unit/page. */
|
|
6
|
+
list(params: DeadlineListParams, options?: RequestOptions): Promise<SignaList<DeadlineListRow>>;
|
|
5
7
|
/**
|
|
6
|
-
* Compute trademark maintenance deadlines for one or more marks
|
|
8
|
+
* Compute trademark maintenance deadlines for one or more marks, and
|
|
9
|
+
* optionally prosecution deadlines from caller-supplied facts.
|
|
7
10
|
*
|
|
8
|
-
* Scope: `trademarks:read`. Billed as 1 unit per
|
|
11
|
+
* Scope: `trademarks:read`. Billed as 1 unit per ITEM — supplying `facts`
|
|
12
|
+
* costs nothing extra.
|
|
9
13
|
*
|
|
10
14
|
* ```typescript
|
|
11
15
|
* const results = await signa.deadlines.compute({
|
|
@@ -18,7 +22,37 @@ export declare class Deadlines extends BaseResource {
|
|
|
18
22
|
* }],
|
|
19
23
|
* });
|
|
20
24
|
* ```
|
|
25
|
+
*
|
|
26
|
+
* Add `facts` to an item to also compute prosecution deadlines. Every
|
|
27
|
+
* computed date cites the rule, era and sources behind it, and `support[]`
|
|
28
|
+
* reports per-deadline-type capability (`computed` / `stated` /
|
|
29
|
+
* `facts_required` / `unsupported`). Omit `facts` and the item carries
|
|
30
|
+
* neither `prosecution_deadlines` nor `support` — those two fields, and
|
|
31
|
+
* only those two, are conditional. Item-level rule identity (`sources`,
|
|
32
|
+
* `as_of`, `computed_at`) and the per-row provenance on `deadlines[]`
|
|
33
|
+
* (`rule_id`, `effective_from`, `last_verified`, the two adjustment
|
|
34
|
+
* outcomes, `holiday_calendar`) ship on every response either way, so a
|
|
35
|
+
* no-`facts` request is NOT identical to a pre-ENG-343 one.
|
|
36
|
+
*
|
|
37
|
+
* ```typescript
|
|
38
|
+
* const results = await signa.deadlines.compute({
|
|
39
|
+
* as_of_date: '2024-03-01',
|
|
40
|
+
* items: [{
|
|
41
|
+
* jurisdiction: 'US',
|
|
42
|
+
* filing_route: 'national',
|
|
43
|
+
* status: 'examining',
|
|
44
|
+
* filing_date: '2023-01-15',
|
|
45
|
+
* facts: [{
|
|
46
|
+
* kind: 'office_action',
|
|
47
|
+
* id: 'oa-1',
|
|
48
|
+
* family: 'nonfinal',
|
|
49
|
+
* operative_date: '2024-02-01',
|
|
50
|
+
* operative_date_basis: 'mailed_row',
|
|
51
|
+
* }],
|
|
52
|
+
* }],
|
|
53
|
+
* });
|
|
54
|
+
* ```
|
|
21
55
|
*/
|
|
22
|
-
compute(body: DeadlineComputeParams, options?: RequestOptions): Promise<SignaList<
|
|
56
|
+
compute(body: DeadlineComputeParams, options?: RequestOptions): Promise<SignaList<DeadlineComputeResult>>;
|
|
23
57
|
}
|
|
24
58
|
//# sourceMappingURL=deadlines.d.ts.map
|
|
@@ -1 +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,
|
|
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,qBAAqB,EACrB,kBAAkB,EAClB,eAAe,EACf,qBAAqB,EAErB,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,SAAU,SAAQ,YAAY;IACzC,sGAAsG;IAChG,IAAI,CACR,MAAM,EAAE,kBAAkB,EAC1B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,eAAe,CAAC,CAAC;IAMtC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;IACG,OAAO,CACX,IAAI,EAAE,qBAAqB,EAC3B,OAAO,CAAC,EAAE,cAAc,GACvB,OAAO,CAAC,SAAS,CAAC,qBAAqB,CAAC,CAAC;CAU7C"}
|
|
@@ -1,10 +1,17 @@
|
|
|
1
1
|
import { BaseResource } from '../resource.js';
|
|
2
2
|
import { createList } from '../pagination.js';
|
|
3
3
|
export class Deadlines extends BaseResource {
|
|
4
|
+
/** List computed maintenance deadlines for exactly one portfolio or trademark. One read unit/page. */
|
|
5
|
+
async list(params, options) {
|
|
6
|
+
const fetchPage = (cursor) => this._getListResponse('/v1/deadlines', { ...params, cursor }, options);
|
|
7
|
+
return createList(await fetchPage(params.cursor), fetchPage);
|
|
8
|
+
}
|
|
4
9
|
/**
|
|
5
|
-
* Compute trademark maintenance deadlines for one or more marks
|
|
10
|
+
* Compute trademark maintenance deadlines for one or more marks, and
|
|
11
|
+
* optionally prosecution deadlines from caller-supplied facts.
|
|
6
12
|
*
|
|
7
|
-
* Scope: `trademarks:read`. Billed as 1 unit per
|
|
13
|
+
* Scope: `trademarks:read`. Billed as 1 unit per ITEM — supplying `facts`
|
|
14
|
+
* costs nothing extra.
|
|
8
15
|
*
|
|
9
16
|
* ```typescript
|
|
10
17
|
* const results = await signa.deadlines.compute({
|
|
@@ -17,6 +24,36 @@ export class Deadlines extends BaseResource {
|
|
|
17
24
|
* }],
|
|
18
25
|
* });
|
|
19
26
|
* ```
|
|
27
|
+
*
|
|
28
|
+
* Add `facts` to an item to also compute prosecution deadlines. Every
|
|
29
|
+
* computed date cites the rule, era and sources behind it, and `support[]`
|
|
30
|
+
* reports per-deadline-type capability (`computed` / `stated` /
|
|
31
|
+
* `facts_required` / `unsupported`). Omit `facts` and the item carries
|
|
32
|
+
* neither `prosecution_deadlines` nor `support` — those two fields, and
|
|
33
|
+
* only those two, are conditional. Item-level rule identity (`sources`,
|
|
34
|
+
* `as_of`, `computed_at`) and the per-row provenance on `deadlines[]`
|
|
35
|
+
* (`rule_id`, `effective_from`, `last_verified`, the two adjustment
|
|
36
|
+
* outcomes, `holiday_calendar`) ship on every response either way, so a
|
|
37
|
+
* no-`facts` request is NOT identical to a pre-ENG-343 one.
|
|
38
|
+
*
|
|
39
|
+
* ```typescript
|
|
40
|
+
* const results = await signa.deadlines.compute({
|
|
41
|
+
* as_of_date: '2024-03-01',
|
|
42
|
+
* items: [{
|
|
43
|
+
* jurisdiction: 'US',
|
|
44
|
+
* filing_route: 'national',
|
|
45
|
+
* status: 'examining',
|
|
46
|
+
* filing_date: '2023-01-15',
|
|
47
|
+
* facts: [{
|
|
48
|
+
* kind: 'office_action',
|
|
49
|
+
* id: 'oa-1',
|
|
50
|
+
* family: 'nonfinal',
|
|
51
|
+
* operative_date: '2024-02-01',
|
|
52
|
+
* operative_date_basis: 'mailed_row',
|
|
53
|
+
* }],
|
|
54
|
+
* }],
|
|
55
|
+
* });
|
|
56
|
+
* ```
|
|
20
57
|
*/
|
|
21
58
|
async compute(body, options) {
|
|
22
59
|
const response = await this._post('/v1/deadlines/compute', body, options);
|
|
@@ -1 +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;
|
|
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;AAU9D,MAAM,OAAO,SAAU,SAAQ,YAAY;IACzC,sGAAsG;IACtG,KAAK,CAAC,IAAI,CACR,MAA0B,EAC1B,OAAwB;QAExB,MAAM,SAAS,GAAG,CAAC,MAAe,EAAE,EAAE,CACpC,IAAI,CAAC,gBAAgB,CAAkB,eAAe,EAAE,EAAE,GAAG,MAAM,EAAE,MAAM,EAAE,EAAE,OAAO,CAAC,CAAC;QAC1F,OAAO,UAAU,CAAC,MAAM,SAAS,CAAC,MAAM,CAAC,MAAM,CAAC,EAAE,SAAS,CAAC,CAAC;IAC/D,CAAC;IAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAgDG;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"}
|
|
@@ -3,19 +3,18 @@ import { type SignaList } from '../pagination.js';
|
|
|
3
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
|
-
* layer over per-office owner clusters. An `ent_*` id is
|
|
7
|
-
*
|
|
8
|
-
*
|
|
9
|
-
* entity
|
|
6
|
+
* layer over per-office owner clusters. An `ent_*` id is a materialized
|
|
7
|
+
* entity. Since 0.14.0 an owner id in entity form (`ent_<owner-uuid>`) is a
|
|
8
|
+
* 404 on every entity route (a merged entity stays 410); an owner that is not
|
|
9
|
+
* linked to an entity has `entity_id: null` and is read through `owners`.
|
|
10
10
|
*/
|
|
11
11
|
export declare class Entities extends BaseResource {
|
|
12
12
|
analytics(id: string, options?: RequestOptions): Promise<AnalyticsReport>;
|
|
13
13
|
/**
|
|
14
14
|
* Retrieve a single entity by ID.
|
|
15
15
|
*
|
|
16
|
-
*
|
|
17
|
-
*
|
|
18
|
-
* an owner that has since been linked resolves to the real entity.
|
|
16
|
+
* Embeds `members[]` with per-link evidence. An `ent_<owner-uuid>` id is a
|
|
17
|
+
* `NotFoundError` (404); a merged entity is a `GoneError` (410).
|
|
19
18
|
*
|
|
20
19
|
* ```typescript
|
|
21
20
|
* const entity = await signa.entities.retrieve('ent_abc123');
|
|
@@ -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,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
|
|
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;;;;;;;;;OASG;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"}
|
|
@@ -2,10 +2,10 @@ import { BaseResource } from '../resource.js';
|
|
|
2
2
|
import { createList } from '../pagination.js';
|
|
3
3
|
/**
|
|
4
4
|
* Resolved entities (PLN-118 "link, don't merge") — the cross-office identity
|
|
5
|
-
* layer over per-office owner clusters. An `ent_*` id is
|
|
6
|
-
*
|
|
7
|
-
*
|
|
8
|
-
* entity
|
|
5
|
+
* layer over per-office owner clusters. An `ent_*` id is a materialized
|
|
6
|
+
* entity. Since 0.14.0 an owner id in entity form (`ent_<owner-uuid>`) is a
|
|
7
|
+
* 404 on every entity route (a merged entity stays 410); an owner that is not
|
|
8
|
+
* linked to an entity has `entity_id: null` and is read through `owners`.
|
|
9
9
|
*/
|
|
10
10
|
export class Entities extends BaseResource {
|
|
11
11
|
async analytics(id, options) {
|
|
@@ -15,9 +15,8 @@ export class Entities extends BaseResource {
|
|
|
15
15
|
/**
|
|
16
16
|
* Retrieve a single entity by ID.
|
|
17
17
|
*
|
|
18
|
-
*
|
|
19
|
-
*
|
|
20
|
-
* an owner that has since been linked resolves to the real entity.
|
|
18
|
+
* Embeds `members[]` with per-link evidence. An `ent_<owner-uuid>` id is a
|
|
19
|
+
* `NotFoundError` (404); a merged entity is a `GoneError` (410).
|
|
21
20
|
*
|
|
22
21
|
* ```typescript
|
|
23
22
|
* const entity = await signa.entities.retrieve('ent_abc123');
|
|
@@ -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;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
|
|
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;;;;;;;;;OASG;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"}
|
|
@@ -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;
|
|
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;IAgB/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
|
@@ -5,7 +5,10 @@ export class Events extends BaseResource {
|
|
|
5
5
|
/** List organization events. */
|
|
6
6
|
async list(params, options) {
|
|
7
7
|
const response = await this._getListResponse('/v1/events', params, options);
|
|
8
|
-
return createList(response, (cursor) =>
|
|
8
|
+
return createList(response, (cursor) => {
|
|
9
|
+
const { after: _checkpoint, ...continuationParams } = params ?? {};
|
|
10
|
+
return this._getListResponse('/v1/events', { ...continuationParams, cursor }, options);
|
|
11
|
+
});
|
|
9
12
|
}
|
|
10
13
|
/** Retrieve an event with before/after diffs. IDs are evt_-prefixed strings. */
|
|
11
14
|
async retrieve(id, options) {
|
|
@@ -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,
|
|
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;YACrC,MAAM,EAAE,KAAK,EAAE,WAAW,EAAE,GAAG,kBAAkB,EAAE,GAAG,MAAM,IAAI,EAAE,CAAC;YACnE,OAAO,IAAI,CAAC,gBAAgB,CAC1B,YAAY,EACZ,EAAE,GAAG,kBAAkB,EAAE,MAAM,EAA6B,EAC5D,OAAO,CACR,CAAC;QACJ,CAAC,CAAC,CAAC;IACL,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,10 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { type SignaList } from '../pagination.js';
|
|
3
|
+
import type { FeeRule, FeeListParams, FeeEstimateParams, FeeEstimate, RequestOptions } from '../types.js';
|
|
4
|
+
export declare class Fees extends BaseResource {
|
|
5
|
+
/** Complete, unpaginated catalog of verified official fees. Unbilled reference data. */
|
|
6
|
+
list(params?: FeeListParams, options?: RequestOptions): Promise<SignaList<FeeRule>>;
|
|
7
|
+
/** One estimate per request, billed as one check unit. Amounts use native currency minor units. */
|
|
8
|
+
estimate(body: FeeEstimateParams, options?: RequestOptions): Promise<FeeEstimate>;
|
|
9
|
+
}
|
|
10
|
+
//# sourceMappingURL=fees.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fees.d.ts","sourceRoot":"","sources":["../../src/resources/fees.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAc,KAAK,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9D,OAAO,KAAK,EACV,OAAO,EACP,aAAa,EACb,iBAAiB,EACjB,WAAW,EACX,cAAc,EACf,MAAM,aAAa,CAAC;AAErB,qBAAa,IAAK,SAAQ,YAAY;IACpC,wFAAwF;IAClF,IAAI,CAAC,MAAM,CAAC,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC;IAOzF,mGAAmG;IAC7F,QAAQ,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,OAAO,CAAC,WAAW,CAAC;CAGxF"}
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
import { BaseResource } from '../resource.js';
|
|
2
|
+
import { createList } from '../pagination.js';
|
|
3
|
+
export class Fees extends BaseResource {
|
|
4
|
+
/** Complete, unpaginated catalog of verified official fees. Unbilled reference data. */
|
|
5
|
+
async list(params, options) {
|
|
6
|
+
const response = await this._getListResponse('/v1/fees', params, options);
|
|
7
|
+
return createList({ ...response, has_more: false }, () => Promise.resolve({ ...response, data: [], has_more: false }));
|
|
8
|
+
}
|
|
9
|
+
/** One estimate per request, billed as one check unit. Amounts use native currency minor units. */
|
|
10
|
+
async estimate(body, options) {
|
|
11
|
+
return this._post('/v1/fees/estimate', body, options);
|
|
12
|
+
}
|
|
13
|
+
}
|
|
14
|
+
//# sourceMappingURL=fees.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"fees.js","sourceRoot":"","sources":["../../src/resources/fees.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,gBAAgB,CAAC;AAC9C,OAAO,EAAE,UAAU,EAAkB,MAAM,kBAAkB,CAAC;AAS9D,MAAM,OAAO,IAAK,SAAQ,YAAY;IACpC,wFAAwF;IACxF,KAAK,CAAC,IAAI,CAAC,MAAsB,EAAE,OAAwB;QACzD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAU,UAAU,EAAE,MAAM,EAAE,OAAO,CAAC,CAAC;QACnF,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;IAED,mGAAmG;IACnG,KAAK,CAAC,QAAQ,CAAC,IAAuB,EAAE,OAAwB;QAC9D,OAAO,IAAI,CAAC,KAAK,CAAc,mBAAmB,EAAE,IAAI,EAAE,OAAO,CAAC,CAAC;IACrE,CAAC;CACF"}
|