@siglume/api-sdk 0.10.0 → 0.10.2

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.
@@ -136,13 +136,6 @@ declare const AppCategory: {
136
136
  type AppCategory = (typeof AppCategory)[keyof typeof AppCategory];
137
137
  interface AppManifest {
138
138
  capability_key: string;
139
- /**
140
- * LOCAL-ONLY identification. The Siglume platform never reads this on
141
- * auto_register / confirm_auto_register and rejects submissions that
142
- * declare a version — the authoritative `release_semver` is controlled
143
- * by the platform per the bump rules on the confirm endpoint
144
- * (see `confirm_registration({ version_bump: ... })`).
145
- */
146
139
  version?: string;
147
140
  name: string;
148
141
  job_to_be_done: string;
@@ -150,7 +143,7 @@ interface AppManifest {
150
143
  permission_class: PermissionClass;
151
144
  approval_mode?: ApprovalMode;
152
145
  dry_run_supported?: boolean;
153
- required_connected_accounts?: string[];
146
+ required_connected_accounts?: unknown[];
154
147
  permission_scopes?: string[];
155
148
  price_model?: PriceModel;
156
149
  price_value_minor?: number;
@@ -159,13 +152,6 @@ interface AppManifest {
159
152
  applicable_regulations?: string[];
160
153
  data_residency?: string;
161
154
  short_description?: string;
162
- /**
163
- * Long-form sales description shown on the buyer-facing API detail
164
- * page. Complements `short_description` (one-liner) with a fuller
165
- * pitch: who this is for, what it can / cannot do, limits, required
166
- * connected accounts. The Tool Manual is agent-facing and not shown
167
- * to buyers; put buyer-facing story here.
168
- */
169
155
  description?: string;
170
156
  docs_url?: string;
171
157
  support_contact?: string;
@@ -260,6 +246,7 @@ interface AppListingRecord {
260
246
  price_value_minor: number;
261
247
  currency: string;
262
248
  short_description?: string | null;
249
+ description?: string | null;
263
250
  docs_url?: string | null;
264
251
  support_contact?: string | null;
265
252
  seller_display_name?: string | null;
@@ -272,17 +259,6 @@ interface AppListingRecord {
272
259
  updated_at?: string | null;
273
260
  raw: Record<string, unknown>;
274
261
  }
275
- interface ConnectedAccountProvider {
276
- provider_key: string;
277
- display_name: string;
278
- auth_type: string;
279
- refresh_supported: boolean;
280
- pkce_required: boolean;
281
- default_scopes: string[];
282
- available_scopes: string[];
283
- scope_separator: string;
284
- notes?: string | null;
285
- }
286
262
  interface ConnectedAccountOAuthStart {
287
263
  authorize_url: string;
288
264
  state: string;
@@ -1201,61 +1177,8 @@ interface AgentThreadRecord {
1201
1177
  items: NetworkContentDetail[];
1202
1178
  raw: Record<string, unknown>;
1203
1179
  }
1204
- declare const RefundReason: {
1205
- readonly CUSTOMER_REQUEST: "customer-request";
1206
- readonly DUPLICATE: "duplicate";
1207
- readonly FRAUDULENT: "fraudulent";
1208
- readonly SERVICE_FAILURE: "service-failure";
1209
- readonly GOODWILL: "goodwill";
1210
- };
1211
- type RefundReason = (typeof RefundReason)[keyof typeof RefundReason];
1212
- declare const DisputeResponse: {
1213
- readonly ACCEPT: "accept";
1214
- readonly CONTEST: "contest";
1215
- };
1216
- type DisputeResponse = (typeof DisputeResponse)[keyof typeof DisputeResponse];
1217
- interface RefundRecord {
1218
- refund_id: string;
1219
- receipt_id: string;
1220
- owner_user_id?: string | null;
1221
- payment_mandate_id?: string | null;
1222
- usage_event_id?: string | null;
1223
- chain_receipt_id?: string | null;
1224
- amount_minor: number;
1225
- currency: string;
1226
- status: string;
1227
- reason_code: string;
1228
- note?: string | null;
1229
- idempotency_key?: string | null;
1230
- on_chain_tx_hash?: string | null;
1231
- metadata: Record<string, unknown>;
1232
- idempotent_replay: boolean;
1233
- created_at?: string | null;
1234
- updated_at?: string | null;
1235
- raw: Record<string, unknown>;
1236
- }
1237
- interface DisputeRecord {
1238
- dispute_id: string;
1239
- receipt_id: string;
1240
- owner_user_id?: string | null;
1241
- payment_mandate_id?: string | null;
1242
- usage_event_id?: string | null;
1243
- external_dispute_id?: string | null;
1244
- status: string;
1245
- reason_code: string;
1246
- description?: string | null;
1247
- evidence: Record<string, unknown>;
1248
- response_decision?: string | null;
1249
- response_note?: string | null;
1250
- responded_at?: string | null;
1251
- metadata: Record<string, unknown>;
1252
- idempotent_replay: boolean;
1253
- created_at?: string | null;
1254
- updated_at?: string | null;
1255
- raw: Record<string, unknown>;
1256
- }
1257
1180
 
1258
- declare const WEBHOOK_EVENT_TYPES: readonly ["subscription.created", "subscription.renewed", "subscription.cancelled", "subscription.paused", "subscription.reinstated", "refund.issued", "payment.succeeded", "payment.failed", "payment.disputed", "capability.published", "capability.delisted", "execution.completed", "execution.failed"];
1181
+ declare const WEBHOOK_EVENT_TYPES: readonly ["subscription.created", "subscription.renewed", "subscription.cancelled", "subscription.paused", "subscription.reinstated", "payment.succeeded", "payment.failed", "capability.published", "capability.delisted", "execution.completed", "execution.failed"];
1259
1182
  type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
1260
1183
  interface WebhookSubscriptionRecord {
1261
1184
  subscription_id: string;
@@ -1317,15 +1240,6 @@ interface SubscriptionLifecycleEventData extends Record<string, unknown> {
1317
1240
  currency?: string;
1318
1241
  amount_minor?: number;
1319
1242
  }
1320
- interface RefundIssuedEventData extends Record<string, unknown> {
1321
- refund_id?: string;
1322
- receipt_id?: string;
1323
- amount_minor?: number;
1324
- currency?: string;
1325
- status?: string;
1326
- payment_mandate_id?: string;
1327
- on_chain_tx_hash?: string;
1328
- }
1329
1243
  interface PaymentEventData extends SubscriptionLifecycleEventData {
1330
1244
  payment_status?: string;
1331
1245
  }
@@ -1360,14 +1274,10 @@ interface SubscriptionPausedEvent extends WebhookEventBase<"subscription.paused"
1360
1274
  }
1361
1275
  interface SubscriptionReinstatedEvent extends WebhookEventBase<"subscription.reinstated", SubscriptionLifecycleEventData> {
1362
1276
  }
1363
- interface RefundIssuedEvent extends WebhookEventBase<"refund.issued", RefundIssuedEventData> {
1364
- }
1365
1277
  interface PaymentSucceededEvent extends WebhookEventBase<"payment.succeeded", PaymentEventData> {
1366
1278
  }
1367
1279
  interface PaymentFailedEvent extends WebhookEventBase<"payment.failed", PaymentEventData> {
1368
1280
  }
1369
- interface PaymentDisputedEvent extends WebhookEventBase<"payment.disputed", PaymentEventData> {
1370
- }
1371
1281
  interface CapabilityPublishedEvent extends WebhookEventBase<"capability.published", CapabilityEventData> {
1372
1282
  }
1373
1283
  interface CapabilityDelistedEvent extends WebhookEventBase<"capability.delisted", CapabilityEventData> {
@@ -1376,7 +1286,7 @@ interface ExecutionCompletedEvent extends WebhookEventBase<"execution.completed"
1376
1286
  }
1377
1287
  interface ExecutionFailedEvent extends WebhookEventBase<"execution.failed", ExecutionFailedEventData> {
1378
1288
  }
1379
- type SiglumeWebhookEvent = SubscriptionCreatedEvent | SubscriptionRenewedEvent | SubscriptionCancelledEvent | SubscriptionPausedEvent | SubscriptionReinstatedEvent | RefundIssuedEvent | PaymentSucceededEvent | PaymentFailedEvent | PaymentDisputedEvent | CapabilityPublishedEvent | CapabilityDelistedEvent | ExecutionCompletedEvent | ExecutionFailedEvent;
1289
+ type SiglumeWebhookEvent = SubscriptionCreatedEvent | SubscriptionRenewedEvent | SubscriptionCancelledEvent | SubscriptionPausedEvent | SubscriptionReinstatedEvent | PaymentSucceededEvent | PaymentFailedEvent | CapabilityPublishedEvent | CapabilityDelistedEvent | ExecutionCompletedEvent | ExecutionFailedEvent;
1380
1290
  interface QueuedWebhookEvent {
1381
1291
  queued: boolean;
1382
1292
  event: SiglumeWebhookEvent;
@@ -1423,7 +1333,6 @@ interface SiglumeClientShape {
1423
1333
  source_url?: string;
1424
1334
  runtime_validation?: Record<string, unknown>;
1425
1335
  oauth_credentials?: Record<string, unknown> | unknown[];
1426
- metadata?: Record<string, unknown>;
1427
1336
  source_context?: Record<string, unknown>;
1428
1337
  input_form_spec?: Record<string, unknown>;
1429
1338
  }): Promise<AutoRegistrationReceipt>;
@@ -1479,7 +1388,6 @@ interface SiglumeClientShape {
1479
1388
  }): Promise<BundleListingRecord>;
1480
1389
  remove_bundle_capability(bundle_id: string, capability_listing_id: string): Promise<BundleListingRecord>;
1481
1390
  submit_bundle_for_review(bundle_id: string): Promise<BundleListingRecord>;
1482
- list_connected_account_providers(): Promise<ConnectedAccountProvider[]>;
1483
1391
  start_connected_account_oauth(input: {
1484
1392
  listing_id: string;
1485
1393
  redirect_uri: string;
@@ -1490,6 +1398,15 @@ interface SiglumeClientShape {
1490
1398
  provider_key: string;
1491
1399
  client_id: string;
1492
1400
  client_secret: string;
1401
+ authorize_url: string;
1402
+ token_url: string;
1403
+ revoke_url?: string;
1404
+ display_name?: string;
1405
+ scope_separator?: string;
1406
+ token_endpoint_auth?: string;
1407
+ pkce_required?: boolean;
1408
+ refresh_supported?: boolean;
1409
+ available_scopes?: string[];
1493
1410
  required_scopes?: string[];
1494
1411
  }): Promise<Record<string, unknown>>;
1495
1412
  get_listing_oauth_credentials_status(listing_id: string): Promise<Record<string, unknown>>;
@@ -1865,39 +1782,6 @@ interface SiglumeClientShape {
1865
1782
  limit?: number;
1866
1783
  cursor?: string;
1867
1784
  }): Promise<CursorPage<SupportCaseRecord>>;
1868
- issue_partial_refund(options: {
1869
- receipt_id: string;
1870
- amount_minor: number;
1871
- reason?: RefundReason | string;
1872
- note?: string;
1873
- idempotency_key: string;
1874
- original_amount_minor?: number;
1875
- }): Promise<RefundRecord>;
1876
- issue_full_refund(options: {
1877
- receipt_id: string;
1878
- reason?: RefundReason | string;
1879
- note?: string;
1880
- idempotency_key?: string;
1881
- }): Promise<RefundRecord>;
1882
- list_refunds(options?: {
1883
- receipt_id?: string;
1884
- limit?: number;
1885
- }): Promise<RefundRecord[]>;
1886
- get_refund(refund_id: string): Promise<RefundRecord>;
1887
- get_refunds_for_receipt(receipt_id: string, options?: {
1888
- limit?: number;
1889
- }): Promise<RefundRecord[]>;
1890
- list_disputes(options?: {
1891
- receipt_id?: string;
1892
- limit?: number;
1893
- }): Promise<DisputeRecord[]>;
1894
- get_dispute(dispute_id: string): Promise<DisputeRecord>;
1895
- respond_to_dispute(options: {
1896
- dispute_id: string;
1897
- response: DisputeResponse | string;
1898
- evidence: Record<string, unknown>;
1899
- note?: string;
1900
- }): Promise<DisputeRecord>;
1901
1785
  create_webhook_subscription(options: {
1902
1786
  callback_url: string;
1903
1787
  description?: string;
@@ -136,13 +136,6 @@ declare const AppCategory: {
136
136
  type AppCategory = (typeof AppCategory)[keyof typeof AppCategory];
137
137
  interface AppManifest {
138
138
  capability_key: string;
139
- /**
140
- * LOCAL-ONLY identification. The Siglume platform never reads this on
141
- * auto_register / confirm_auto_register and rejects submissions that
142
- * declare a version — the authoritative `release_semver` is controlled
143
- * by the platform per the bump rules on the confirm endpoint
144
- * (see `confirm_registration({ version_bump: ... })`).
145
- */
146
139
  version?: string;
147
140
  name: string;
148
141
  job_to_be_done: string;
@@ -150,7 +143,7 @@ interface AppManifest {
150
143
  permission_class: PermissionClass;
151
144
  approval_mode?: ApprovalMode;
152
145
  dry_run_supported?: boolean;
153
- required_connected_accounts?: string[];
146
+ required_connected_accounts?: unknown[];
154
147
  permission_scopes?: string[];
155
148
  price_model?: PriceModel;
156
149
  price_value_minor?: number;
@@ -159,13 +152,6 @@ interface AppManifest {
159
152
  applicable_regulations?: string[];
160
153
  data_residency?: string;
161
154
  short_description?: string;
162
- /**
163
- * Long-form sales description shown on the buyer-facing API detail
164
- * page. Complements `short_description` (one-liner) with a fuller
165
- * pitch: who this is for, what it can / cannot do, limits, required
166
- * connected accounts. The Tool Manual is agent-facing and not shown
167
- * to buyers; put buyer-facing story here.
168
- */
169
155
  description?: string;
170
156
  docs_url?: string;
171
157
  support_contact?: string;
@@ -260,6 +246,7 @@ interface AppListingRecord {
260
246
  price_value_minor: number;
261
247
  currency: string;
262
248
  short_description?: string | null;
249
+ description?: string | null;
263
250
  docs_url?: string | null;
264
251
  support_contact?: string | null;
265
252
  seller_display_name?: string | null;
@@ -272,17 +259,6 @@ interface AppListingRecord {
272
259
  updated_at?: string | null;
273
260
  raw: Record<string, unknown>;
274
261
  }
275
- interface ConnectedAccountProvider {
276
- provider_key: string;
277
- display_name: string;
278
- auth_type: string;
279
- refresh_supported: boolean;
280
- pkce_required: boolean;
281
- default_scopes: string[];
282
- available_scopes: string[];
283
- scope_separator: string;
284
- notes?: string | null;
285
- }
286
262
  interface ConnectedAccountOAuthStart {
287
263
  authorize_url: string;
288
264
  state: string;
@@ -1201,61 +1177,8 @@ interface AgentThreadRecord {
1201
1177
  items: NetworkContentDetail[];
1202
1178
  raw: Record<string, unknown>;
1203
1179
  }
1204
- declare const RefundReason: {
1205
- readonly CUSTOMER_REQUEST: "customer-request";
1206
- readonly DUPLICATE: "duplicate";
1207
- readonly FRAUDULENT: "fraudulent";
1208
- readonly SERVICE_FAILURE: "service-failure";
1209
- readonly GOODWILL: "goodwill";
1210
- };
1211
- type RefundReason = (typeof RefundReason)[keyof typeof RefundReason];
1212
- declare const DisputeResponse: {
1213
- readonly ACCEPT: "accept";
1214
- readonly CONTEST: "contest";
1215
- };
1216
- type DisputeResponse = (typeof DisputeResponse)[keyof typeof DisputeResponse];
1217
- interface RefundRecord {
1218
- refund_id: string;
1219
- receipt_id: string;
1220
- owner_user_id?: string | null;
1221
- payment_mandate_id?: string | null;
1222
- usage_event_id?: string | null;
1223
- chain_receipt_id?: string | null;
1224
- amount_minor: number;
1225
- currency: string;
1226
- status: string;
1227
- reason_code: string;
1228
- note?: string | null;
1229
- idempotency_key?: string | null;
1230
- on_chain_tx_hash?: string | null;
1231
- metadata: Record<string, unknown>;
1232
- idempotent_replay: boolean;
1233
- created_at?: string | null;
1234
- updated_at?: string | null;
1235
- raw: Record<string, unknown>;
1236
- }
1237
- interface DisputeRecord {
1238
- dispute_id: string;
1239
- receipt_id: string;
1240
- owner_user_id?: string | null;
1241
- payment_mandate_id?: string | null;
1242
- usage_event_id?: string | null;
1243
- external_dispute_id?: string | null;
1244
- status: string;
1245
- reason_code: string;
1246
- description?: string | null;
1247
- evidence: Record<string, unknown>;
1248
- response_decision?: string | null;
1249
- response_note?: string | null;
1250
- responded_at?: string | null;
1251
- metadata: Record<string, unknown>;
1252
- idempotent_replay: boolean;
1253
- created_at?: string | null;
1254
- updated_at?: string | null;
1255
- raw: Record<string, unknown>;
1256
- }
1257
1180
 
1258
- declare const WEBHOOK_EVENT_TYPES: readonly ["subscription.created", "subscription.renewed", "subscription.cancelled", "subscription.paused", "subscription.reinstated", "refund.issued", "payment.succeeded", "payment.failed", "payment.disputed", "capability.published", "capability.delisted", "execution.completed", "execution.failed"];
1181
+ declare const WEBHOOK_EVENT_TYPES: readonly ["subscription.created", "subscription.renewed", "subscription.cancelled", "subscription.paused", "subscription.reinstated", "payment.succeeded", "payment.failed", "capability.published", "capability.delisted", "execution.completed", "execution.failed"];
1259
1182
  type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
1260
1183
  interface WebhookSubscriptionRecord {
1261
1184
  subscription_id: string;
@@ -1317,15 +1240,6 @@ interface SubscriptionLifecycleEventData extends Record<string, unknown> {
1317
1240
  currency?: string;
1318
1241
  amount_minor?: number;
1319
1242
  }
1320
- interface RefundIssuedEventData extends Record<string, unknown> {
1321
- refund_id?: string;
1322
- receipt_id?: string;
1323
- amount_minor?: number;
1324
- currency?: string;
1325
- status?: string;
1326
- payment_mandate_id?: string;
1327
- on_chain_tx_hash?: string;
1328
- }
1329
1243
  interface PaymentEventData extends SubscriptionLifecycleEventData {
1330
1244
  payment_status?: string;
1331
1245
  }
@@ -1360,14 +1274,10 @@ interface SubscriptionPausedEvent extends WebhookEventBase<"subscription.paused"
1360
1274
  }
1361
1275
  interface SubscriptionReinstatedEvent extends WebhookEventBase<"subscription.reinstated", SubscriptionLifecycleEventData> {
1362
1276
  }
1363
- interface RefundIssuedEvent extends WebhookEventBase<"refund.issued", RefundIssuedEventData> {
1364
- }
1365
1277
  interface PaymentSucceededEvent extends WebhookEventBase<"payment.succeeded", PaymentEventData> {
1366
1278
  }
1367
1279
  interface PaymentFailedEvent extends WebhookEventBase<"payment.failed", PaymentEventData> {
1368
1280
  }
1369
- interface PaymentDisputedEvent extends WebhookEventBase<"payment.disputed", PaymentEventData> {
1370
- }
1371
1281
  interface CapabilityPublishedEvent extends WebhookEventBase<"capability.published", CapabilityEventData> {
1372
1282
  }
1373
1283
  interface CapabilityDelistedEvent extends WebhookEventBase<"capability.delisted", CapabilityEventData> {
@@ -1376,7 +1286,7 @@ interface ExecutionCompletedEvent extends WebhookEventBase<"execution.completed"
1376
1286
  }
1377
1287
  interface ExecutionFailedEvent extends WebhookEventBase<"execution.failed", ExecutionFailedEventData> {
1378
1288
  }
1379
- type SiglumeWebhookEvent = SubscriptionCreatedEvent | SubscriptionRenewedEvent | SubscriptionCancelledEvent | SubscriptionPausedEvent | SubscriptionReinstatedEvent | RefundIssuedEvent | PaymentSucceededEvent | PaymentFailedEvent | PaymentDisputedEvent | CapabilityPublishedEvent | CapabilityDelistedEvent | ExecutionCompletedEvent | ExecutionFailedEvent;
1289
+ type SiglumeWebhookEvent = SubscriptionCreatedEvent | SubscriptionRenewedEvent | SubscriptionCancelledEvent | SubscriptionPausedEvent | SubscriptionReinstatedEvent | PaymentSucceededEvent | PaymentFailedEvent | CapabilityPublishedEvent | CapabilityDelistedEvent | ExecutionCompletedEvent | ExecutionFailedEvent;
1380
1290
  interface QueuedWebhookEvent {
1381
1291
  queued: boolean;
1382
1292
  event: SiglumeWebhookEvent;
@@ -1423,7 +1333,6 @@ interface SiglumeClientShape {
1423
1333
  source_url?: string;
1424
1334
  runtime_validation?: Record<string, unknown>;
1425
1335
  oauth_credentials?: Record<string, unknown> | unknown[];
1426
- metadata?: Record<string, unknown>;
1427
1336
  source_context?: Record<string, unknown>;
1428
1337
  input_form_spec?: Record<string, unknown>;
1429
1338
  }): Promise<AutoRegistrationReceipt>;
@@ -1479,7 +1388,6 @@ interface SiglumeClientShape {
1479
1388
  }): Promise<BundleListingRecord>;
1480
1389
  remove_bundle_capability(bundle_id: string, capability_listing_id: string): Promise<BundleListingRecord>;
1481
1390
  submit_bundle_for_review(bundle_id: string): Promise<BundleListingRecord>;
1482
- list_connected_account_providers(): Promise<ConnectedAccountProvider[]>;
1483
1391
  start_connected_account_oauth(input: {
1484
1392
  listing_id: string;
1485
1393
  redirect_uri: string;
@@ -1490,6 +1398,15 @@ interface SiglumeClientShape {
1490
1398
  provider_key: string;
1491
1399
  client_id: string;
1492
1400
  client_secret: string;
1401
+ authorize_url: string;
1402
+ token_url: string;
1403
+ revoke_url?: string;
1404
+ display_name?: string;
1405
+ scope_separator?: string;
1406
+ token_endpoint_auth?: string;
1407
+ pkce_required?: boolean;
1408
+ refresh_supported?: boolean;
1409
+ available_scopes?: string[];
1493
1410
  required_scopes?: string[];
1494
1411
  }): Promise<Record<string, unknown>>;
1495
1412
  get_listing_oauth_credentials_status(listing_id: string): Promise<Record<string, unknown>>;
@@ -1865,39 +1782,6 @@ interface SiglumeClientShape {
1865
1782
  limit?: number;
1866
1783
  cursor?: string;
1867
1784
  }): Promise<CursorPage<SupportCaseRecord>>;
1868
- issue_partial_refund(options: {
1869
- receipt_id: string;
1870
- amount_minor: number;
1871
- reason?: RefundReason | string;
1872
- note?: string;
1873
- idempotency_key: string;
1874
- original_amount_minor?: number;
1875
- }): Promise<RefundRecord>;
1876
- issue_full_refund(options: {
1877
- receipt_id: string;
1878
- reason?: RefundReason | string;
1879
- note?: string;
1880
- idempotency_key?: string;
1881
- }): Promise<RefundRecord>;
1882
- list_refunds(options?: {
1883
- receipt_id?: string;
1884
- limit?: number;
1885
- }): Promise<RefundRecord[]>;
1886
- get_refund(refund_id: string): Promise<RefundRecord>;
1887
- get_refunds_for_receipt(receipt_id: string, options?: {
1888
- limit?: number;
1889
- }): Promise<RefundRecord[]>;
1890
- list_disputes(options?: {
1891
- receipt_id?: string;
1892
- limit?: number;
1893
- }): Promise<DisputeRecord[]>;
1894
- get_dispute(dispute_id: string): Promise<DisputeRecord>;
1895
- respond_to_dispute(options: {
1896
- dispute_id: string;
1897
- response: DisputeResponse | string;
1898
- evidence: Record<string, unknown>;
1899
- note?: string;
1900
- }): Promise<DisputeRecord>;
1901
1785
  create_webhook_subscription(options: {
1902
1786
  callback_url: string;
1903
1787
  description?: string;