@siglume/api-sdk 0.10.8 → 1.1.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 +148 -99
- package/dist/bin/siglume.cjs +232 -334
- package/dist/bin/siglume.cjs.map +1 -1
- package/dist/bin/siglume.js +232 -334
- package/dist/bin/siglume.js.map +1 -1
- package/dist/cli/index.cjs +232 -334
- package/dist/cli/index.cjs.map +1 -1
- package/dist/cli/index.d.cts +24 -67
- package/dist/cli/index.d.ts +24 -67
- package/dist/cli/index.js +232 -334
- package/dist/cli/index.js.map +1 -1
- package/dist/index.cjs +214 -202
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +27 -112
- package/dist/index.d.ts +27 -112
- package/dist/index.js +214 -202
- package/dist/index.js.map +1 -1
- package/package.json +58 -58
package/dist/index.d.cts
CHANGED
|
@@ -190,6 +190,7 @@ declare const ListingCurrency: {
|
|
|
190
190
|
readonly JPY: "JPY";
|
|
191
191
|
};
|
|
192
192
|
type ListingCurrency = (typeof ListingCurrency)[keyof typeof ListingCurrency];
|
|
193
|
+
declare const MINIMUM_JPY_OPERATION_PRICE_MINOR = 15;
|
|
193
194
|
declare const PersistenceMode: {
|
|
194
195
|
readonly NONE: "none";
|
|
195
196
|
readonly LOCAL: "local";
|
|
@@ -211,12 +212,6 @@ interface CapabilityPersistencePolicy {
|
|
|
211
212
|
*/
|
|
212
213
|
save_data_schema?: Record<string, unknown>;
|
|
213
214
|
}
|
|
214
|
-
interface ConnectedAccountRef {
|
|
215
|
-
provider_key: string;
|
|
216
|
-
session_token: string;
|
|
217
|
-
scopes?: string[];
|
|
218
|
-
environment?: Environment;
|
|
219
|
-
}
|
|
220
215
|
interface AppManifest {
|
|
221
216
|
capability_key: string;
|
|
222
217
|
version?: string;
|
|
@@ -230,6 +225,7 @@ interface AppManifest {
|
|
|
230
225
|
permission_scopes?: string[];
|
|
231
226
|
price_model?: PriceModel;
|
|
232
227
|
price_value_minor?: number;
|
|
228
|
+
pricing_plan?: PricingPlan;
|
|
233
229
|
currency: ListingCurrency;
|
|
234
230
|
allow_free_trial: boolean;
|
|
235
231
|
free_trial_duration_days?: number;
|
|
@@ -259,7 +255,6 @@ interface ExecutionContext {
|
|
|
259
255
|
source_type?: string;
|
|
260
256
|
environment?: Environment;
|
|
261
257
|
execution_kind?: ExecutionKind;
|
|
262
|
-
connected_accounts?: Record<string, ConnectedAccountRef>;
|
|
263
258
|
budget_remaining_minor?: number | null;
|
|
264
259
|
trace_id?: string;
|
|
265
260
|
idempotency_key?: string;
|
|
@@ -382,6 +377,28 @@ interface EnvelopeMeta {
|
|
|
382
377
|
request_id?: string | null;
|
|
383
378
|
trace_id?: string | null;
|
|
384
379
|
}
|
|
380
|
+
interface PricingPlanItem {
|
|
381
|
+
key?: string | null;
|
|
382
|
+
label?: string | null;
|
|
383
|
+
price_minor?: number | null;
|
|
384
|
+
amount_minor?: number | null;
|
|
385
|
+
currency?: string | null;
|
|
386
|
+
unit_label?: string | null;
|
|
387
|
+
description?: string | null;
|
|
388
|
+
conditions?: unknown;
|
|
389
|
+
receipt_code?: string | null;
|
|
390
|
+
}
|
|
391
|
+
interface PricingPlan {
|
|
392
|
+
billing_model?: string | null;
|
|
393
|
+
display_name?: string | null;
|
|
394
|
+
summary?: string | null;
|
|
395
|
+
description?: string | null;
|
|
396
|
+
currency?: string | null;
|
|
397
|
+
unit_label?: string | null;
|
|
398
|
+
free_upfront_invocation?: boolean | null;
|
|
399
|
+
fallback_note?: string | null;
|
|
400
|
+
items?: PricingPlanItem[];
|
|
401
|
+
}
|
|
385
402
|
interface CursorPage<T> {
|
|
386
403
|
items: T[];
|
|
387
404
|
next_cursor?: string | null;
|
|
@@ -403,6 +420,7 @@ interface AppListingRecord {
|
|
|
403
420
|
dry_run_supported: boolean;
|
|
404
421
|
price_model?: string | null;
|
|
405
422
|
price_value_minor: number;
|
|
423
|
+
pricing_plan?: PricingPlan | null;
|
|
406
424
|
currency: string;
|
|
407
425
|
allow_free_trial: boolean;
|
|
408
426
|
free_trial_duration_days: number;
|
|
@@ -460,23 +478,6 @@ interface CapabilitySaveStateRecord {
|
|
|
460
478
|
exists: boolean;
|
|
461
479
|
raw: Record<string, unknown>;
|
|
462
480
|
}
|
|
463
|
-
interface ConnectedAccountOAuthStart {
|
|
464
|
-
authorize_url: string;
|
|
465
|
-
state: string;
|
|
466
|
-
provider_key: string;
|
|
467
|
-
scopes: string[];
|
|
468
|
-
pkce_method?: string | null;
|
|
469
|
-
}
|
|
470
|
-
interface ConnectedAccountLifecycleResult {
|
|
471
|
-
connected_account_id: string;
|
|
472
|
-
provider_key: string;
|
|
473
|
-
expires_at?: string | null;
|
|
474
|
-
scopes: string[];
|
|
475
|
-
refreshed_at?: string | null;
|
|
476
|
-
connection_status?: string | null;
|
|
477
|
-
provider_revoked?: boolean | null;
|
|
478
|
-
revoked_at?: string | null;
|
|
479
|
-
}
|
|
480
481
|
interface BundleMember {
|
|
481
482
|
capability_listing_id: string;
|
|
482
483
|
capability_key?: string | null;
|
|
@@ -512,7 +513,6 @@ interface AutoRegistrationReceipt {
|
|
|
512
513
|
auto_manifest: Record<string, unknown>;
|
|
513
514
|
confidence: Record<string, unknown>;
|
|
514
515
|
validation_report?: Record<string, unknown>;
|
|
515
|
-
oauth_status?: Record<string, unknown>;
|
|
516
516
|
review_url?: string | null;
|
|
517
517
|
trace_id?: string | null;
|
|
518
518
|
request_id?: string | null;
|
|
@@ -557,7 +557,6 @@ interface SandboxSession {
|
|
|
557
557
|
dry_run_supported: boolean;
|
|
558
558
|
approval_mode?: string | null;
|
|
559
559
|
required_connected_accounts: unknown[];
|
|
560
|
-
connected_accounts: Array<Record<string, unknown>>;
|
|
561
560
|
stub_providers_enabled: boolean;
|
|
562
561
|
simulated_receipts: boolean;
|
|
563
562
|
approval_simulator: boolean;
|
|
@@ -593,19 +592,6 @@ interface GrantBindingResult {
|
|
|
593
592
|
request_id?: string | null;
|
|
594
593
|
raw: Record<string, unknown>;
|
|
595
594
|
}
|
|
596
|
-
interface ConnectedAccountRecord {
|
|
597
|
-
connected_account_id: string;
|
|
598
|
-
provider_key: string;
|
|
599
|
-
account_role: string;
|
|
600
|
-
display_name?: string | null;
|
|
601
|
-
environment?: string | null;
|
|
602
|
-
connection_status?: string | null;
|
|
603
|
-
scopes: string[];
|
|
604
|
-
metadata: Record<string, unknown>;
|
|
605
|
-
created_at?: string | null;
|
|
606
|
-
updated_at?: string | null;
|
|
607
|
-
raw: Record<string, unknown>;
|
|
608
|
-
}
|
|
609
595
|
interface UsageEventRecord {
|
|
610
596
|
usage_event_id: string;
|
|
611
597
|
capability_key?: string | null;
|
|
@@ -1627,7 +1613,6 @@ interface SiglumeClientShape {
|
|
|
1627
1613
|
source_code?: string;
|
|
1628
1614
|
source_url?: string;
|
|
1629
1615
|
runtime_validation?: Record<string, unknown>;
|
|
1630
|
-
oauth_credentials?: Record<string, unknown> | unknown[];
|
|
1631
1616
|
source_context?: Record<string, unknown>;
|
|
1632
1617
|
input_form_spec?: Record<string, unknown>;
|
|
1633
1618
|
}): Promise<AutoRegistrationReceipt>;
|
|
@@ -1696,34 +1681,6 @@ interface SiglumeClientShape {
|
|
|
1696
1681
|
}): Promise<BundleListingRecord>;
|
|
1697
1682
|
remove_bundle_capability(bundle_id: string, capability_listing_id: string): Promise<BundleListingRecord>;
|
|
1698
1683
|
submit_bundle_for_review(bundle_id: string): Promise<BundleListingRecord>;
|
|
1699
|
-
start_connected_account_oauth(input: {
|
|
1700
|
-
listing_id: string;
|
|
1701
|
-
redirect_uri: string;
|
|
1702
|
-
scopes?: string[];
|
|
1703
|
-
account_role?: string;
|
|
1704
|
-
}): Promise<ConnectedAccountOAuthStart>;
|
|
1705
|
-
set_listing_oauth_credentials(listing_id: string, input: {
|
|
1706
|
-
provider_key: string;
|
|
1707
|
-
client_id: string;
|
|
1708
|
-
client_secret: string;
|
|
1709
|
-
authorize_url: string;
|
|
1710
|
-
token_url: string;
|
|
1711
|
-
revoke_url?: string;
|
|
1712
|
-
display_name?: string;
|
|
1713
|
-
scope_separator?: string;
|
|
1714
|
-
token_endpoint_auth?: string;
|
|
1715
|
-
pkce_required?: boolean;
|
|
1716
|
-
refresh_supported?: boolean;
|
|
1717
|
-
available_scopes?: string[];
|
|
1718
|
-
required_scopes?: string[];
|
|
1719
|
-
}): Promise<Record<string, unknown>>;
|
|
1720
|
-
get_listing_oauth_credentials_status(listing_id: string): Promise<Record<string, unknown>>;
|
|
1721
|
-
complete_connected_account_oauth(input: {
|
|
1722
|
-
state: string;
|
|
1723
|
-
code: string;
|
|
1724
|
-
}): Promise<Record<string, unknown>>;
|
|
1725
|
-
refresh_connected_account(account_id: string): Promise<ConnectedAccountLifecycleResult>;
|
|
1726
|
-
revoke_connected_account(account_id: string): Promise<ConnectedAccountLifecycleResult>;
|
|
1727
1684
|
get_developer_portal(): Promise<DeveloperPortalSummary>;
|
|
1728
1685
|
create_sandbox_session(options: {
|
|
1729
1686
|
agent_id: string;
|
|
@@ -2070,12 +2027,6 @@ interface SiglumeClientShape {
|
|
|
2070
2027
|
agent_id: string;
|
|
2071
2028
|
binding_status?: string;
|
|
2072
2029
|
}): Promise<GrantBindingResult>;
|
|
2073
|
-
list_connected_accounts(options?: {
|
|
2074
|
-
provider_key?: string;
|
|
2075
|
-
environment?: string;
|
|
2076
|
-
limit?: number;
|
|
2077
|
-
cursor?: string;
|
|
2078
|
-
}): Promise<CursorPage<ConnectedAccountRecord>>;
|
|
2079
2030
|
create_support_case(subject: string, body: string, options?: {
|
|
2080
2031
|
trace_id?: string;
|
|
2081
2032
|
case_type?: string;
|
|
@@ -2175,7 +2126,6 @@ declare class SiglumeClient implements SiglumeClientShape {
|
|
|
2175
2126
|
source_code?: string;
|
|
2176
2127
|
source_url?: string;
|
|
2177
2128
|
runtime_validation?: Record<string, unknown>;
|
|
2178
|
-
oauth_credentials?: Record<string, unknown> | unknown[];
|
|
2179
2129
|
source_context?: Record<string, unknown>;
|
|
2180
2130
|
input_form_spec?: Record<string, unknown>;
|
|
2181
2131
|
}): Promise<AutoRegistrationReceipt>;
|
|
@@ -2245,34 +2195,6 @@ declare class SiglumeClient implements SiglumeClientShape {
|
|
|
2245
2195
|
}): Promise<BundleListingRecord>;
|
|
2246
2196
|
remove_bundle_capability(bundle_id: string, capability_listing_id: string): Promise<BundleListingRecord>;
|
|
2247
2197
|
submit_bundle_for_review(bundle_id: string): Promise<BundleListingRecord>;
|
|
2248
|
-
start_connected_account_oauth(input: {
|
|
2249
|
-
listing_id: string;
|
|
2250
|
-
redirect_uri: string;
|
|
2251
|
-
scopes?: string[];
|
|
2252
|
-
account_role?: string;
|
|
2253
|
-
}): Promise<ConnectedAccountOAuthStart>;
|
|
2254
|
-
complete_connected_account_oauth(input: {
|
|
2255
|
-
state: string;
|
|
2256
|
-
code: string;
|
|
2257
|
-
}): Promise<Record<string, unknown>>;
|
|
2258
|
-
refresh_connected_account(account_id: string): Promise<ConnectedAccountLifecycleResult>;
|
|
2259
|
-
revoke_connected_account(account_id: string): Promise<ConnectedAccountLifecycleResult>;
|
|
2260
|
-
set_listing_oauth_credentials(listing_id: string, input: {
|
|
2261
|
-
provider_key: string;
|
|
2262
|
-
client_id: string;
|
|
2263
|
-
client_secret: string;
|
|
2264
|
-
authorize_url: string;
|
|
2265
|
-
token_url: string;
|
|
2266
|
-
revoke_url?: string;
|
|
2267
|
-
display_name?: string;
|
|
2268
|
-
scope_separator?: string;
|
|
2269
|
-
token_endpoint_auth?: string;
|
|
2270
|
-
pkce_required?: boolean;
|
|
2271
|
-
refresh_supported?: boolean;
|
|
2272
|
-
available_scopes?: string[];
|
|
2273
|
-
required_scopes?: string[];
|
|
2274
|
-
}): Promise<Record<string, unknown>>;
|
|
2275
|
-
get_listing_oauth_credentials_status(listing_id: string): Promise<Record<string, unknown>>;
|
|
2276
2198
|
get_developer_portal(): Promise<DeveloperPortalSummary>;
|
|
2277
2199
|
create_sandbox_session(options: {
|
|
2278
2200
|
agent_id: string;
|
|
@@ -2619,12 +2541,6 @@ declare class SiglumeClient implements SiglumeClientShape {
|
|
|
2619
2541
|
agent_id: string;
|
|
2620
2542
|
binding_status?: string;
|
|
2621
2543
|
}): Promise<GrantBindingResult>;
|
|
2622
|
-
list_connected_accounts(options?: {
|
|
2623
|
-
provider_key?: string;
|
|
2624
|
-
environment?: string;
|
|
2625
|
-
limit?: number;
|
|
2626
|
-
cursor?: string;
|
|
2627
|
-
}): Promise<CursorPageResult<ConnectedAccountRecord>>;
|
|
2628
2544
|
create_support_case(subject: string, body: string, options?: {
|
|
2629
2545
|
trace_id?: string;
|
|
2630
2546
|
case_type?: string;
|
|
@@ -2916,7 +2832,7 @@ interface MeteringSimulationResult {
|
|
|
2916
2832
|
}
|
|
2917
2833
|
type MeterClientOptions = SiglumeClientOptions;
|
|
2918
2834
|
/**
|
|
2919
|
-
*
|
|
2835
|
+
* Analytics wrapper for usage-event ingest and invoice previews.
|
|
2920
2836
|
*/
|
|
2921
2837
|
declare class MeterClient {
|
|
2922
2838
|
readonly experimental = true;
|
|
@@ -2969,7 +2885,6 @@ declare class AppTestHarness {
|
|
|
2969
2885
|
validate_manifest(): Promise<string[]>;
|
|
2970
2886
|
validate_tool_manual(manual?: ToolManual | Record<string, unknown>): [boolean, ToolManualIssue[]];
|
|
2971
2887
|
validate_receipt(result: ExecutionResult): string[];
|
|
2972
|
-
simulate_connected_account_missing(task_type?: string, options?: Parameters<AppTestHarness["executeWithKind"]>[2]): Promise<ExecutionResult>;
|
|
2973
2888
|
simulate_metering(record: UsageRecord, options?: {
|
|
2974
2889
|
execution_result?: ExecutionResult | null;
|
|
2975
2890
|
}): Promise<MeteringSimulationResult>;
|
|
@@ -3183,4 +3098,4 @@ declare function validate_tool_manual(manualInput: ManualInput): [boolean, ToolM
|
|
|
3183
3098
|
|
|
3184
3099
|
declare function renderJson(value: unknown): string;
|
|
3185
3100
|
|
|
3186
|
-
export { type AccessGrantRecord, type AccountAlert, type AccountContentDeleteResult, type AccountContentPostResult, type AccountDigest, type AccountDigestItem, type AccountDigestSummary, type AccountFeedbackSubmission, type AccountPlan, type AccountPlanCancellation, type AccountPreferences, type AccountWatchlist, type AdsBilling, type AdsBillingSettlement, type AdsCampaignPostRecord, type AdsCampaignRecord, type AdsProfile, type AgentCharter, type AgentRecord, type AgentThreadRecord, type AgentTopicSubscription, AnthropicProvider, type AnthropicToolDefinition, AppAdapter, AppCategory, type AppListingRecord, type AppManifest, AppTestHarness, ApprovalMode, type ApprovalPolicy, type ApprovalRequestHint, type AutoRegistrationReceipt, type Awaitable, type BillingPortalLink, BreakingChange, type BudgetPolicy, type BundleListingRecord, type BundleMember, type CapabilityBindingRecord, type CapabilityDelistedEvent, type CapabilityEventData, type CapabilityListing, type CapabilityPersistencePolicy, type CapabilityPublishedEvent, type CapabilitySaveStateRecord, type CassetteFile, type CassetteInteraction, type Change, ChangeLevel, type CompanyPublisherRecord, type
|
|
3101
|
+
export { type AccessGrantRecord, type AccountAlert, type AccountContentDeleteResult, type AccountContentPostResult, type AccountDigest, type AccountDigestItem, type AccountDigestSummary, type AccountFeedbackSubmission, type AccountPlan, type AccountPlanCancellation, type AccountPreferences, type AccountWatchlist, type AdsBilling, type AdsBillingSettlement, type AdsCampaignPostRecord, type AdsCampaignRecord, type AdsProfile, type AgentCharter, type AgentRecord, type AgentThreadRecord, type AgentTopicSubscription, AnthropicProvider, type AnthropicToolDefinition, AppAdapter, AppCategory, type AppListingRecord, type AppManifest, AppTestHarness, ApprovalMode, type ApprovalPolicy, type ApprovalRequestHint, type AutoRegistrationReceipt, type Awaitable, type BillingPortalLink, BreakingChange, type BudgetPolicy, type BundleListingRecord, type BundleMember, type CapabilityBindingRecord, type CapabilityDelistedEvent, type CapabilityEventData, type CapabilityListing, type CapabilityPersistencePolicy, type CapabilityPublishedEvent, type CapabilitySaveStateRecord, type CassetteFile, type CassetteInteraction, type Change, ChangeLevel, type CompanyPublisherRecord, type CrossCurrencyQuote, type CursorPage, DEFAULT_OPERATION_AGENT_ID, DEFAULT_SIGLUME_API_BASE, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type DeveloperPortalSummary, type EmbeddedWalletCharge, type EnvelopeMeta, Environment, type ExecutionArtifact, type ExecutionCompletedEvent, type ExecutionCompletedEventData, type ExecutionContext, type ExecutionFailedEvent, type ExecutionFailedEventData, ExecutionKind, type ExecutionResult, type ExpressLikeRequest, type ExpressLikeResponse, type FavoriteAgent, type FavoriteAgentMutation, type GrantBindingResult, type HeaderLike, type HealthCheckResult, InMemoryWebhookDedupe, type InstalledToolBindingPolicyRecord, type InstalledToolConnectionReadiness, type InstalledToolExecutionRecord, type InstalledToolPolicyUpdateResult, type InstalledToolReceiptRecord, type InstalledToolReceiptStepRecord, type InstalledToolRecord, type JsonObject, type JsonPrimitive, type JsonValue, LLMProvider, ListingCurrency, MINIMUM_JPY_OPERATION_PRICE_MINOR, type MarketNeedRecord, type MarketProposalActionResult, type MarketProposalRecord, type McpToolDescriptor, MeterClient, type MeterClientOptions, type MeterRecordResult, type MeteringInvoiceLinePreview, type MeteringSimulationResult, type NetworkClaimRecord, type NetworkContentDetail, type NetworkContentSummary, type NetworkEvidenceRecord, type NetworkRepliesPage, type OpenAIFunctionDefinition, OpenAIProvider, type OpenAIResponsesToolDefinition, type OperationExecution, type OperationMetadata, type PartnerApiKeyHandle, type PartnerApiKeyRecord, type PartnerDashboard, type PartnerUsage, type PaymentEventData, type PaymentFailedEvent, type PaymentSucceededEvent, PermissionClass, PersistenceMode, type PlanCheckoutSession, type PlanWeb3Mandate, type PolygonMandate, PriceModel, type PricingPlan, type PricingPlanItem, type QueuedWebhookEvent, type ReceiptRef, RecordMode, Recorder, type RecorderOptions, type RegistrationConfirmation, type RegistrationQuality, type SandboxSession, SettlementMode, type SettlementReceipt, type SideEffectRecord, SiglumeAPIError, SiglumeAssistError, SiglumeBuyerClient, type SiglumeBuyerClientOptions, SiglumeClient, SiglumeClientError, type SiglumeClientOptions, type SiglumeClientShape, SiglumeError, SiglumeExperimentalError, SiglumeExperimentalWarning, SiglumeNotFoundError, SiglumeProjectError, SiglumeValidationError, SiglumeWebhookError, type SiglumeWebhookEvent, SiglumeWebhookPayloadError, SiglumeWebhookReplayError, SiglumeWebhookSignatureError, StoreVertical, type StructuredGenerationUsage, StubProvider, type Subscription, type SubscriptionCancelledEvent, type SubscriptionCreatedEvent, type SubscriptionLifecycleEventData, type SubscriptionPausedEvent, type SubscriptionReinstatedEvent, type SubscriptionRenewedEvent, type SupportCaseRecord, TOOL_MANUAL_DRAFT_PROMPT, type ToolManual, type ToolManualAssistAttempt, type ToolManualAssistMetadata, type ToolManualAssistResult, type ToolManualGrade, type ToolManualIssue, type ToolManualIssueSeverity, ToolManualPermissionClass, type ToolManualQualityReport, type ToolSchemaExport, type UsageEventRecord, type UsageRecord, WEBHOOK_EVENT_ID_HEADER, WEBHOOK_EVENT_TYPES, WEBHOOK_EVENT_TYPE_HEADER, WEBHOOK_SIGNATURE_HEADER, type WebhookCallback, type WebhookDeliveryRecord, type WebhookDispatchResult, type WebhookEventBase, type WebhookEventType, WebhookHandler, type WebhookSignatureVerification, type WebhookSubscriptionRecord, type WorksCategoryRecord, type WorksOwnerDashboard, type WorksOwnerDashboardAgent, type WorksOwnerDashboardOrder, type WorksOwnerDashboardPitch, type WorksOwnerDashboardStats, type WorksPosterDashboard, type WorksPosterDashboardJob, type WorksPosterDashboardOrder, type WorksPosterDashboardStats, type WorksRegistrationRecord, buildOperationMetadata, build_webhook_signature_header, compute_webhook_signature, defaultCapabilityKeyForOperation, defaultOperationOutputSchema, diff_manifest, diff_tool_manual, draft_tool_manual, fallbackOperationCatalog, fill_tool_manual_gaps, normalizeUsageRecord, parse_cross_currency_quote, parse_embedded_wallet_charge, parse_polygon_mandate, parse_queued_webhook_event, parse_settlement_receipt, parse_webhook_delivery, parse_webhook_event, parse_webhook_subscription, renderJson as render_json, score_tool_manual_offline, score_tool_manual_remote, simulate_embedded_wallet_charge, simulate_polygon_mandate, to_anthropic_tool, to_mcp_tool, to_openai_function, to_openai_responses_tool, tool_manual_to_dict, validate_tool_manual, verify_webhook_signature };
|
package/dist/index.d.ts
CHANGED
|
@@ -190,6 +190,7 @@ declare const ListingCurrency: {
|
|
|
190
190
|
readonly JPY: "JPY";
|
|
191
191
|
};
|
|
192
192
|
type ListingCurrency = (typeof ListingCurrency)[keyof typeof ListingCurrency];
|
|
193
|
+
declare const MINIMUM_JPY_OPERATION_PRICE_MINOR = 15;
|
|
193
194
|
declare const PersistenceMode: {
|
|
194
195
|
readonly NONE: "none";
|
|
195
196
|
readonly LOCAL: "local";
|
|
@@ -211,12 +212,6 @@ interface CapabilityPersistencePolicy {
|
|
|
211
212
|
*/
|
|
212
213
|
save_data_schema?: Record<string, unknown>;
|
|
213
214
|
}
|
|
214
|
-
interface ConnectedAccountRef {
|
|
215
|
-
provider_key: string;
|
|
216
|
-
session_token: string;
|
|
217
|
-
scopes?: string[];
|
|
218
|
-
environment?: Environment;
|
|
219
|
-
}
|
|
220
215
|
interface AppManifest {
|
|
221
216
|
capability_key: string;
|
|
222
217
|
version?: string;
|
|
@@ -230,6 +225,7 @@ interface AppManifest {
|
|
|
230
225
|
permission_scopes?: string[];
|
|
231
226
|
price_model?: PriceModel;
|
|
232
227
|
price_value_minor?: number;
|
|
228
|
+
pricing_plan?: PricingPlan;
|
|
233
229
|
currency: ListingCurrency;
|
|
234
230
|
allow_free_trial: boolean;
|
|
235
231
|
free_trial_duration_days?: number;
|
|
@@ -259,7 +255,6 @@ interface ExecutionContext {
|
|
|
259
255
|
source_type?: string;
|
|
260
256
|
environment?: Environment;
|
|
261
257
|
execution_kind?: ExecutionKind;
|
|
262
|
-
connected_accounts?: Record<string, ConnectedAccountRef>;
|
|
263
258
|
budget_remaining_minor?: number | null;
|
|
264
259
|
trace_id?: string;
|
|
265
260
|
idempotency_key?: string;
|
|
@@ -382,6 +377,28 @@ interface EnvelopeMeta {
|
|
|
382
377
|
request_id?: string | null;
|
|
383
378
|
trace_id?: string | null;
|
|
384
379
|
}
|
|
380
|
+
interface PricingPlanItem {
|
|
381
|
+
key?: string | null;
|
|
382
|
+
label?: string | null;
|
|
383
|
+
price_minor?: number | null;
|
|
384
|
+
amount_minor?: number | null;
|
|
385
|
+
currency?: string | null;
|
|
386
|
+
unit_label?: string | null;
|
|
387
|
+
description?: string | null;
|
|
388
|
+
conditions?: unknown;
|
|
389
|
+
receipt_code?: string | null;
|
|
390
|
+
}
|
|
391
|
+
interface PricingPlan {
|
|
392
|
+
billing_model?: string | null;
|
|
393
|
+
display_name?: string | null;
|
|
394
|
+
summary?: string | null;
|
|
395
|
+
description?: string | null;
|
|
396
|
+
currency?: string | null;
|
|
397
|
+
unit_label?: string | null;
|
|
398
|
+
free_upfront_invocation?: boolean | null;
|
|
399
|
+
fallback_note?: string | null;
|
|
400
|
+
items?: PricingPlanItem[];
|
|
401
|
+
}
|
|
385
402
|
interface CursorPage<T> {
|
|
386
403
|
items: T[];
|
|
387
404
|
next_cursor?: string | null;
|
|
@@ -403,6 +420,7 @@ interface AppListingRecord {
|
|
|
403
420
|
dry_run_supported: boolean;
|
|
404
421
|
price_model?: string | null;
|
|
405
422
|
price_value_minor: number;
|
|
423
|
+
pricing_plan?: PricingPlan | null;
|
|
406
424
|
currency: string;
|
|
407
425
|
allow_free_trial: boolean;
|
|
408
426
|
free_trial_duration_days: number;
|
|
@@ -460,23 +478,6 @@ interface CapabilitySaveStateRecord {
|
|
|
460
478
|
exists: boolean;
|
|
461
479
|
raw: Record<string, unknown>;
|
|
462
480
|
}
|
|
463
|
-
interface ConnectedAccountOAuthStart {
|
|
464
|
-
authorize_url: string;
|
|
465
|
-
state: string;
|
|
466
|
-
provider_key: string;
|
|
467
|
-
scopes: string[];
|
|
468
|
-
pkce_method?: string | null;
|
|
469
|
-
}
|
|
470
|
-
interface ConnectedAccountLifecycleResult {
|
|
471
|
-
connected_account_id: string;
|
|
472
|
-
provider_key: string;
|
|
473
|
-
expires_at?: string | null;
|
|
474
|
-
scopes: string[];
|
|
475
|
-
refreshed_at?: string | null;
|
|
476
|
-
connection_status?: string | null;
|
|
477
|
-
provider_revoked?: boolean | null;
|
|
478
|
-
revoked_at?: string | null;
|
|
479
|
-
}
|
|
480
481
|
interface BundleMember {
|
|
481
482
|
capability_listing_id: string;
|
|
482
483
|
capability_key?: string | null;
|
|
@@ -512,7 +513,6 @@ interface AutoRegistrationReceipt {
|
|
|
512
513
|
auto_manifest: Record<string, unknown>;
|
|
513
514
|
confidence: Record<string, unknown>;
|
|
514
515
|
validation_report?: Record<string, unknown>;
|
|
515
|
-
oauth_status?: Record<string, unknown>;
|
|
516
516
|
review_url?: string | null;
|
|
517
517
|
trace_id?: string | null;
|
|
518
518
|
request_id?: string | null;
|
|
@@ -557,7 +557,6 @@ interface SandboxSession {
|
|
|
557
557
|
dry_run_supported: boolean;
|
|
558
558
|
approval_mode?: string | null;
|
|
559
559
|
required_connected_accounts: unknown[];
|
|
560
|
-
connected_accounts: Array<Record<string, unknown>>;
|
|
561
560
|
stub_providers_enabled: boolean;
|
|
562
561
|
simulated_receipts: boolean;
|
|
563
562
|
approval_simulator: boolean;
|
|
@@ -593,19 +592,6 @@ interface GrantBindingResult {
|
|
|
593
592
|
request_id?: string | null;
|
|
594
593
|
raw: Record<string, unknown>;
|
|
595
594
|
}
|
|
596
|
-
interface ConnectedAccountRecord {
|
|
597
|
-
connected_account_id: string;
|
|
598
|
-
provider_key: string;
|
|
599
|
-
account_role: string;
|
|
600
|
-
display_name?: string | null;
|
|
601
|
-
environment?: string | null;
|
|
602
|
-
connection_status?: string | null;
|
|
603
|
-
scopes: string[];
|
|
604
|
-
metadata: Record<string, unknown>;
|
|
605
|
-
created_at?: string | null;
|
|
606
|
-
updated_at?: string | null;
|
|
607
|
-
raw: Record<string, unknown>;
|
|
608
|
-
}
|
|
609
595
|
interface UsageEventRecord {
|
|
610
596
|
usage_event_id: string;
|
|
611
597
|
capability_key?: string | null;
|
|
@@ -1627,7 +1613,6 @@ interface SiglumeClientShape {
|
|
|
1627
1613
|
source_code?: string;
|
|
1628
1614
|
source_url?: string;
|
|
1629
1615
|
runtime_validation?: Record<string, unknown>;
|
|
1630
|
-
oauth_credentials?: Record<string, unknown> | unknown[];
|
|
1631
1616
|
source_context?: Record<string, unknown>;
|
|
1632
1617
|
input_form_spec?: Record<string, unknown>;
|
|
1633
1618
|
}): Promise<AutoRegistrationReceipt>;
|
|
@@ -1696,34 +1681,6 @@ interface SiglumeClientShape {
|
|
|
1696
1681
|
}): Promise<BundleListingRecord>;
|
|
1697
1682
|
remove_bundle_capability(bundle_id: string, capability_listing_id: string): Promise<BundleListingRecord>;
|
|
1698
1683
|
submit_bundle_for_review(bundle_id: string): Promise<BundleListingRecord>;
|
|
1699
|
-
start_connected_account_oauth(input: {
|
|
1700
|
-
listing_id: string;
|
|
1701
|
-
redirect_uri: string;
|
|
1702
|
-
scopes?: string[];
|
|
1703
|
-
account_role?: string;
|
|
1704
|
-
}): Promise<ConnectedAccountOAuthStart>;
|
|
1705
|
-
set_listing_oauth_credentials(listing_id: string, input: {
|
|
1706
|
-
provider_key: string;
|
|
1707
|
-
client_id: string;
|
|
1708
|
-
client_secret: string;
|
|
1709
|
-
authorize_url: string;
|
|
1710
|
-
token_url: string;
|
|
1711
|
-
revoke_url?: string;
|
|
1712
|
-
display_name?: string;
|
|
1713
|
-
scope_separator?: string;
|
|
1714
|
-
token_endpoint_auth?: string;
|
|
1715
|
-
pkce_required?: boolean;
|
|
1716
|
-
refresh_supported?: boolean;
|
|
1717
|
-
available_scopes?: string[];
|
|
1718
|
-
required_scopes?: string[];
|
|
1719
|
-
}): Promise<Record<string, unknown>>;
|
|
1720
|
-
get_listing_oauth_credentials_status(listing_id: string): Promise<Record<string, unknown>>;
|
|
1721
|
-
complete_connected_account_oauth(input: {
|
|
1722
|
-
state: string;
|
|
1723
|
-
code: string;
|
|
1724
|
-
}): Promise<Record<string, unknown>>;
|
|
1725
|
-
refresh_connected_account(account_id: string): Promise<ConnectedAccountLifecycleResult>;
|
|
1726
|
-
revoke_connected_account(account_id: string): Promise<ConnectedAccountLifecycleResult>;
|
|
1727
1684
|
get_developer_portal(): Promise<DeveloperPortalSummary>;
|
|
1728
1685
|
create_sandbox_session(options: {
|
|
1729
1686
|
agent_id: string;
|
|
@@ -2070,12 +2027,6 @@ interface SiglumeClientShape {
|
|
|
2070
2027
|
agent_id: string;
|
|
2071
2028
|
binding_status?: string;
|
|
2072
2029
|
}): Promise<GrantBindingResult>;
|
|
2073
|
-
list_connected_accounts(options?: {
|
|
2074
|
-
provider_key?: string;
|
|
2075
|
-
environment?: string;
|
|
2076
|
-
limit?: number;
|
|
2077
|
-
cursor?: string;
|
|
2078
|
-
}): Promise<CursorPage<ConnectedAccountRecord>>;
|
|
2079
2030
|
create_support_case(subject: string, body: string, options?: {
|
|
2080
2031
|
trace_id?: string;
|
|
2081
2032
|
case_type?: string;
|
|
@@ -2175,7 +2126,6 @@ declare class SiglumeClient implements SiglumeClientShape {
|
|
|
2175
2126
|
source_code?: string;
|
|
2176
2127
|
source_url?: string;
|
|
2177
2128
|
runtime_validation?: Record<string, unknown>;
|
|
2178
|
-
oauth_credentials?: Record<string, unknown> | unknown[];
|
|
2179
2129
|
source_context?: Record<string, unknown>;
|
|
2180
2130
|
input_form_spec?: Record<string, unknown>;
|
|
2181
2131
|
}): Promise<AutoRegistrationReceipt>;
|
|
@@ -2245,34 +2195,6 @@ declare class SiglumeClient implements SiglumeClientShape {
|
|
|
2245
2195
|
}): Promise<BundleListingRecord>;
|
|
2246
2196
|
remove_bundle_capability(bundle_id: string, capability_listing_id: string): Promise<BundleListingRecord>;
|
|
2247
2197
|
submit_bundle_for_review(bundle_id: string): Promise<BundleListingRecord>;
|
|
2248
|
-
start_connected_account_oauth(input: {
|
|
2249
|
-
listing_id: string;
|
|
2250
|
-
redirect_uri: string;
|
|
2251
|
-
scopes?: string[];
|
|
2252
|
-
account_role?: string;
|
|
2253
|
-
}): Promise<ConnectedAccountOAuthStart>;
|
|
2254
|
-
complete_connected_account_oauth(input: {
|
|
2255
|
-
state: string;
|
|
2256
|
-
code: string;
|
|
2257
|
-
}): Promise<Record<string, unknown>>;
|
|
2258
|
-
refresh_connected_account(account_id: string): Promise<ConnectedAccountLifecycleResult>;
|
|
2259
|
-
revoke_connected_account(account_id: string): Promise<ConnectedAccountLifecycleResult>;
|
|
2260
|
-
set_listing_oauth_credentials(listing_id: string, input: {
|
|
2261
|
-
provider_key: string;
|
|
2262
|
-
client_id: string;
|
|
2263
|
-
client_secret: string;
|
|
2264
|
-
authorize_url: string;
|
|
2265
|
-
token_url: string;
|
|
2266
|
-
revoke_url?: string;
|
|
2267
|
-
display_name?: string;
|
|
2268
|
-
scope_separator?: string;
|
|
2269
|
-
token_endpoint_auth?: string;
|
|
2270
|
-
pkce_required?: boolean;
|
|
2271
|
-
refresh_supported?: boolean;
|
|
2272
|
-
available_scopes?: string[];
|
|
2273
|
-
required_scopes?: string[];
|
|
2274
|
-
}): Promise<Record<string, unknown>>;
|
|
2275
|
-
get_listing_oauth_credentials_status(listing_id: string): Promise<Record<string, unknown>>;
|
|
2276
2198
|
get_developer_portal(): Promise<DeveloperPortalSummary>;
|
|
2277
2199
|
create_sandbox_session(options: {
|
|
2278
2200
|
agent_id: string;
|
|
@@ -2619,12 +2541,6 @@ declare class SiglumeClient implements SiglumeClientShape {
|
|
|
2619
2541
|
agent_id: string;
|
|
2620
2542
|
binding_status?: string;
|
|
2621
2543
|
}): Promise<GrantBindingResult>;
|
|
2622
|
-
list_connected_accounts(options?: {
|
|
2623
|
-
provider_key?: string;
|
|
2624
|
-
environment?: string;
|
|
2625
|
-
limit?: number;
|
|
2626
|
-
cursor?: string;
|
|
2627
|
-
}): Promise<CursorPageResult<ConnectedAccountRecord>>;
|
|
2628
2544
|
create_support_case(subject: string, body: string, options?: {
|
|
2629
2545
|
trace_id?: string;
|
|
2630
2546
|
case_type?: string;
|
|
@@ -2916,7 +2832,7 @@ interface MeteringSimulationResult {
|
|
|
2916
2832
|
}
|
|
2917
2833
|
type MeterClientOptions = SiglumeClientOptions;
|
|
2918
2834
|
/**
|
|
2919
|
-
*
|
|
2835
|
+
* Analytics wrapper for usage-event ingest and invoice previews.
|
|
2920
2836
|
*/
|
|
2921
2837
|
declare class MeterClient {
|
|
2922
2838
|
readonly experimental = true;
|
|
@@ -2969,7 +2885,6 @@ declare class AppTestHarness {
|
|
|
2969
2885
|
validate_manifest(): Promise<string[]>;
|
|
2970
2886
|
validate_tool_manual(manual?: ToolManual | Record<string, unknown>): [boolean, ToolManualIssue[]];
|
|
2971
2887
|
validate_receipt(result: ExecutionResult): string[];
|
|
2972
|
-
simulate_connected_account_missing(task_type?: string, options?: Parameters<AppTestHarness["executeWithKind"]>[2]): Promise<ExecutionResult>;
|
|
2973
2888
|
simulate_metering(record: UsageRecord, options?: {
|
|
2974
2889
|
execution_result?: ExecutionResult | null;
|
|
2975
2890
|
}): Promise<MeteringSimulationResult>;
|
|
@@ -3183,4 +3098,4 @@ declare function validate_tool_manual(manualInput: ManualInput): [boolean, ToolM
|
|
|
3183
3098
|
|
|
3184
3099
|
declare function renderJson(value: unknown): string;
|
|
3185
3100
|
|
|
3186
|
-
export { type AccessGrantRecord, type AccountAlert, type AccountContentDeleteResult, type AccountContentPostResult, type AccountDigest, type AccountDigestItem, type AccountDigestSummary, type AccountFeedbackSubmission, type AccountPlan, type AccountPlanCancellation, type AccountPreferences, type AccountWatchlist, type AdsBilling, type AdsBillingSettlement, type AdsCampaignPostRecord, type AdsCampaignRecord, type AdsProfile, type AgentCharter, type AgentRecord, type AgentThreadRecord, type AgentTopicSubscription, AnthropicProvider, type AnthropicToolDefinition, AppAdapter, AppCategory, type AppListingRecord, type AppManifest, AppTestHarness, ApprovalMode, type ApprovalPolicy, type ApprovalRequestHint, type AutoRegistrationReceipt, type Awaitable, type BillingPortalLink, BreakingChange, type BudgetPolicy, type BundleListingRecord, type BundleMember, type CapabilityBindingRecord, type CapabilityDelistedEvent, type CapabilityEventData, type CapabilityListing, type CapabilityPersistencePolicy, type CapabilityPublishedEvent, type CapabilitySaveStateRecord, type CassetteFile, type CassetteInteraction, type Change, ChangeLevel, type CompanyPublisherRecord, type
|
|
3101
|
+
export { type AccessGrantRecord, type AccountAlert, type AccountContentDeleteResult, type AccountContentPostResult, type AccountDigest, type AccountDigestItem, type AccountDigestSummary, type AccountFeedbackSubmission, type AccountPlan, type AccountPlanCancellation, type AccountPreferences, type AccountWatchlist, type AdsBilling, type AdsBillingSettlement, type AdsCampaignPostRecord, type AdsCampaignRecord, type AdsProfile, type AgentCharter, type AgentRecord, type AgentThreadRecord, type AgentTopicSubscription, AnthropicProvider, type AnthropicToolDefinition, AppAdapter, AppCategory, type AppListingRecord, type AppManifest, AppTestHarness, ApprovalMode, type ApprovalPolicy, type ApprovalRequestHint, type AutoRegistrationReceipt, type Awaitable, type BillingPortalLink, BreakingChange, type BudgetPolicy, type BundleListingRecord, type BundleMember, type CapabilityBindingRecord, type CapabilityDelistedEvent, type CapabilityEventData, type CapabilityListing, type CapabilityPersistencePolicy, type CapabilityPublishedEvent, type CapabilitySaveStateRecord, type CassetteFile, type CassetteInteraction, type Change, ChangeLevel, type CompanyPublisherRecord, type CrossCurrencyQuote, type CursorPage, DEFAULT_OPERATION_AGENT_ID, DEFAULT_SIGLUME_API_BASE, DEFAULT_WEBHOOK_TOLERANCE_SECONDS, type DeveloperPortalSummary, type EmbeddedWalletCharge, type EnvelopeMeta, Environment, type ExecutionArtifact, type ExecutionCompletedEvent, type ExecutionCompletedEventData, type ExecutionContext, type ExecutionFailedEvent, type ExecutionFailedEventData, ExecutionKind, type ExecutionResult, type ExpressLikeRequest, type ExpressLikeResponse, type FavoriteAgent, type FavoriteAgentMutation, type GrantBindingResult, type HeaderLike, type HealthCheckResult, InMemoryWebhookDedupe, type InstalledToolBindingPolicyRecord, type InstalledToolConnectionReadiness, type InstalledToolExecutionRecord, type InstalledToolPolicyUpdateResult, type InstalledToolReceiptRecord, type InstalledToolReceiptStepRecord, type InstalledToolRecord, type JsonObject, type JsonPrimitive, type JsonValue, LLMProvider, ListingCurrency, MINIMUM_JPY_OPERATION_PRICE_MINOR, type MarketNeedRecord, type MarketProposalActionResult, type MarketProposalRecord, type McpToolDescriptor, MeterClient, type MeterClientOptions, type MeterRecordResult, type MeteringInvoiceLinePreview, type MeteringSimulationResult, type NetworkClaimRecord, type NetworkContentDetail, type NetworkContentSummary, type NetworkEvidenceRecord, type NetworkRepliesPage, type OpenAIFunctionDefinition, OpenAIProvider, type OpenAIResponsesToolDefinition, type OperationExecution, type OperationMetadata, type PartnerApiKeyHandle, type PartnerApiKeyRecord, type PartnerDashboard, type PartnerUsage, type PaymentEventData, type PaymentFailedEvent, type PaymentSucceededEvent, PermissionClass, PersistenceMode, type PlanCheckoutSession, type PlanWeb3Mandate, type PolygonMandate, PriceModel, type PricingPlan, type PricingPlanItem, type QueuedWebhookEvent, type ReceiptRef, RecordMode, Recorder, type RecorderOptions, type RegistrationConfirmation, type RegistrationQuality, type SandboxSession, SettlementMode, type SettlementReceipt, type SideEffectRecord, SiglumeAPIError, SiglumeAssistError, SiglumeBuyerClient, type SiglumeBuyerClientOptions, SiglumeClient, SiglumeClientError, type SiglumeClientOptions, type SiglumeClientShape, SiglumeError, SiglumeExperimentalError, SiglumeExperimentalWarning, SiglumeNotFoundError, SiglumeProjectError, SiglumeValidationError, SiglumeWebhookError, type SiglumeWebhookEvent, SiglumeWebhookPayloadError, SiglumeWebhookReplayError, SiglumeWebhookSignatureError, StoreVertical, type StructuredGenerationUsage, StubProvider, type Subscription, type SubscriptionCancelledEvent, type SubscriptionCreatedEvent, type SubscriptionLifecycleEventData, type SubscriptionPausedEvent, type SubscriptionReinstatedEvent, type SubscriptionRenewedEvent, type SupportCaseRecord, TOOL_MANUAL_DRAFT_PROMPT, type ToolManual, type ToolManualAssistAttempt, type ToolManualAssistMetadata, type ToolManualAssistResult, type ToolManualGrade, type ToolManualIssue, type ToolManualIssueSeverity, ToolManualPermissionClass, type ToolManualQualityReport, type ToolSchemaExport, type UsageEventRecord, type UsageRecord, WEBHOOK_EVENT_ID_HEADER, WEBHOOK_EVENT_TYPES, WEBHOOK_EVENT_TYPE_HEADER, WEBHOOK_SIGNATURE_HEADER, type WebhookCallback, type WebhookDeliveryRecord, type WebhookDispatchResult, type WebhookEventBase, type WebhookEventType, WebhookHandler, type WebhookSignatureVerification, type WebhookSubscriptionRecord, type WorksCategoryRecord, type WorksOwnerDashboard, type WorksOwnerDashboardAgent, type WorksOwnerDashboardOrder, type WorksOwnerDashboardPitch, type WorksOwnerDashboardStats, type WorksPosterDashboard, type WorksPosterDashboardJob, type WorksPosterDashboardOrder, type WorksPosterDashboardStats, type WorksRegistrationRecord, buildOperationMetadata, build_webhook_signature_header, compute_webhook_signature, defaultCapabilityKeyForOperation, defaultOperationOutputSchema, diff_manifest, diff_tool_manual, draft_tool_manual, fallbackOperationCatalog, fill_tool_manual_gaps, normalizeUsageRecord, parse_cross_currency_quote, parse_embedded_wallet_charge, parse_polygon_mandate, parse_queued_webhook_event, parse_settlement_receipt, parse_webhook_delivery, parse_webhook_event, parse_webhook_subscription, renderJson as render_json, score_tool_manual_offline, score_tool_manual_remote, simulate_embedded_wallet_charge, simulate_polygon_mandate, to_anthropic_tool, to_mcp_tool, to_openai_function, to_openai_responses_tool, tool_manual_to_dict, validate_tool_manual, verify_webhook_signature };
|