@siglume/api-sdk 1.2.1 → 2.0.0

package/dist/cli/index.d.cts

@@ -170,6 +170,7 @@ interface AppManifest {
     capability_key: string;
     version?: string;
     name: string;
+    /** Buyer-facing task summary, max 240 characters. */
     job_to_be_done: string;
     category?: AppCategory;
     permission_class: PermissionClass;
@@ -187,7 +188,9 @@ interface AppManifest {
     jurisdiction: string;
     applicable_regulations?: string[];
     data_residency?: string;
+    /** Catalog tagline shown on cards and the detail header, max 60 characters. */
     short_description?: string;
+    /** Detail-page copy for limits, approval behavior, pricing notes, and expected results, max 1000 characters. */
     description?: string;
     docs_url?: string;
     support_contact?: string;
@@ -855,115 +858,6 @@ interface WorksPosterDashboard {
     stats: WorksPosterDashboardStats;
     raw: Record<string, unknown>;
 }
-interface PartnerDashboard {
-    partner_id: string;
-    company_name?: string | null;
-    plan?: string | null;
-    plan_label?: string | null;
-    month_bytes_used: number;
-    month_bytes_limit: number;
-    month_usage_pct: number;
-    total_source_items: number;
-    has_billing: boolean;
-    has_subscription: boolean;
-    raw: Record<string, unknown>;
-}
-interface PartnerUsage {
-    plan?: string | null;
-    month_bytes_used: number;
-    month_bytes_limit: number;
-    month_bytes_remaining: number;
-    month_usage_pct: number;
-    raw: Record<string, unknown>;
-}
-interface PartnerApiKeyRecord {
-    credential_id: string;
-    name?: string | null;
-    key_id?: string | null;
-    allowed_source_types: string[];
-    last_used_at?: string | null;
-    created_at?: string | null;
-    revoked: boolean;
-    raw: Record<string, unknown>;
-}
-interface PartnerApiKeyHandle {
-    credential_id: string;
-    name?: string | null;
-    key_id?: string | null;
-    allowed_source_types: string[];
-    masked_key_hint?: string | null;
-    raw: Record<string, unknown>;
-}
-interface AdsBilling {
-    currency?: string | null;
-    billing_mode?: string | null;
-    month_spend_jpy: number;
-    month_spend_usd: number;
-    all_time_spend_jpy: number;
-    all_time_spend_usd: number;
-    total_impressions: number;
-    total_replies: number;
-    has_billing: boolean;
-    has_subscription: boolean;
-    invoices: Array<Record<string, unknown>>;
-    wallet?: Record<string, unknown> | null;
-    balances: Array<Record<string, unknown>>;
-    supported_tokens: Array<Record<string, unknown>>;
-    funding_instructions?: Record<string, unknown> | null;
-    mandate?: PlanWeb3Mandate | null;
-    raw: Record<string, unknown>;
-}
-interface AdsBillingSettlement {
-    status?: string | null;
-    message?: string | null;
-    settles_automatically?: boolean | null;
-    cycle_key?: string | null;
-    settled_at?: string | null;
-    raw: Record<string, unknown>;
-}
-interface AdsProfile {
-    has_profile: boolean;
-    company_name?: string | null;
-    ad_currency?: string | null;
-    has_billing: boolean;
-    raw: Record<string, unknown>;
-}
-interface AdsCampaignRecord {
-    campaign_id: string;
-    name?: string | null;
-    target_url?: string | null;
-    content_brief?: string | null;
-    target_topics: string[];
-    posting_interval_minutes: number;
-    max_posts_per_day: number;
-    currency?: string | null;
-    monthly_budget_jpy: number;
-    cpm_jpy: number;
-    cpr_jpy: number;
-    monthly_budget_usd: number;
-    cpm_usd: number;
-    cpr_usd: number;
-    status: string;
-    month_spend_jpy: number;
-    month_spend_usd: number;
-    total_posts: number;
-    total_impressions: number;
-    total_replies: number;
-    next_post_at?: string | null;
-    created_at?: string | null;
-    raw: Record<string, unknown>;
-}
-interface AdsCampaignPostRecord {
-    post_id: string;
-    content_id?: string | null;
-    cost_jpy: number;
-    cost_usd: number;
-    impressions: number;
-    replies: number;
-    status?: string | null;
-    created_at?: string | null;
-    raw: Record<string, unknown>;
-}
 interface MarketProposalRecord {
     proposal_id: string;
     parent_proposal_id?: string | null;
@@ -1253,7 +1147,7 @@ interface AgentThreadRecord {
     raw: Record<string, unknown>;
 }
 
-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"];
+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", "reward_payout.created", "reward_payout.provider_pending", "reward_paid", "reward_payout.failed", "reward_payout.cancelled"];
 type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
 interface WebhookSubscriptionRecord {
     subscription_id: string;
@@ -1339,6 +1233,20 @@ interface ExecutionFailedEventData extends ExecutionCompletedEventData {
     reason_code?: string;
     reason?: string;
 }
+interface RewardPayoutEventData extends Record<string, unknown> {
+    reward_payout_request_id?: string;
+    app_id?: string;
+    developer_id?: string;
+    recipient_subject?: string;
+    amount_minor?: number;
+    display_currency?: string;
+    token_symbol?: string;
+    reward_event_id?: string;
+    status?: string;
+    tx_hash?: string | null;
+    failure_code?: string | null;
+    failure_reason?: string | null;
+}
 interface SubscriptionCreatedEvent extends WebhookEventBase<"subscription.created", SubscriptionLifecycleEventData> {
 }
 interface SubscriptionRenewedEvent extends WebhookEventBase<"subscription.renewed", SubscriptionLifecycleEventData> {
@@ -1361,7 +1269,17 @@ interface ExecutionCompletedEvent extends WebhookEventBase<"execution.completed"
 }
 interface ExecutionFailedEvent extends WebhookEventBase<"execution.failed", ExecutionFailedEventData> {
 }
-type SiglumeWebhookEvent = SubscriptionCreatedEvent | SubscriptionRenewedEvent | SubscriptionCancelledEvent | SubscriptionPausedEvent | SubscriptionReinstatedEvent | PaymentSucceededEvent | PaymentFailedEvent | CapabilityPublishedEvent | CapabilityDelistedEvent | ExecutionCompletedEvent | ExecutionFailedEvent;
+interface RewardPayoutCreatedEvent extends WebhookEventBase<"reward_payout.created", RewardPayoutEventData> {
+}
+interface RewardPayoutProviderPendingEvent extends WebhookEventBase<"reward_payout.provider_pending", RewardPayoutEventData> {
+}
+interface RewardPaidEvent extends WebhookEventBase<"reward_paid", RewardPayoutEventData> {
+}
+interface RewardPayoutFailedEvent extends WebhookEventBase<"reward_payout.failed", RewardPayoutEventData> {
+}
+interface RewardPayoutCancelledEvent extends WebhookEventBase<"reward_payout.cancelled", RewardPayoutEventData> {
+}
+type SiglumeWebhookEvent = SubscriptionCreatedEvent | SubscriptionRenewedEvent | SubscriptionCancelledEvent | SubscriptionPausedEvent | SubscriptionReinstatedEvent | PaymentSucceededEvent | PaymentFailedEvent | CapabilityPublishedEvent | CapabilityDelistedEvent | ExecutionCompletedEvent | ExecutionFailedEvent | RewardPayoutCreatedEvent | RewardPayoutProviderPendingEvent | RewardPaidEvent | RewardPayoutFailedEvent | RewardPayoutCancelledEvent;
 interface QueuedWebhookEvent {
     queued: boolean;
     event: SiglumeWebhookEvent;
@@ -1758,45 +1676,6 @@ interface SiglumeClientShape {
         agent_id?: string;
         lang?: string;
     }): Promise<InstalledToolReceiptStepRecord[]>;
-    get_partner_dashboard(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<PartnerDashboard>;
-    get_partner_usage(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<PartnerUsage>;
-    list_partner_api_keys(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<PartnerApiKeyRecord[]>;
-    create_partner_api_key(options?: {
-        agent_id?: string;
-        name?: string;
-        allowed_source_types?: string[];
-        lang?: string;
-    }): Promise<PartnerApiKeyHandle>;
-    get_ads_billing(options?: {
-        agent_id?: string;
-        rail?: string;
-        lang?: string;
-    }): Promise<AdsBilling>;
-    settle_ads_billing(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<AdsBillingSettlement>;
-    get_ads_profile(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<AdsProfile>;
-    list_ads_campaigns(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<AdsCampaignRecord[]>;
-    list_ads_campaign_posts(campaign_id: string, options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<AdsCampaignPostRecord[]>;
     update_agent_charter(agent_id: string, charter_text: string, options?: {
         role?: string;
         target_profile?: Record<string, unknown>;

package/dist/cli/index.d.ts

@@ -170,6 +170,7 @@ interface AppManifest {
     capability_key: string;
     version?: string;
     name: string;
+    /** Buyer-facing task summary, max 240 characters. */
     job_to_be_done: string;
     category?: AppCategory;
     permission_class: PermissionClass;
@@ -187,7 +188,9 @@ interface AppManifest {
     jurisdiction: string;
     applicable_regulations?: string[];
     data_residency?: string;
+    /** Catalog tagline shown on cards and the detail header, max 60 characters. */
     short_description?: string;
+    /** Detail-page copy for limits, approval behavior, pricing notes, and expected results, max 1000 characters. */
     description?: string;
     docs_url?: string;
     support_contact?: string;
@@ -855,115 +858,6 @@ interface WorksPosterDashboard {
     stats: WorksPosterDashboardStats;
     raw: Record<string, unknown>;
 }
-interface PartnerDashboard {
-    partner_id: string;
-    company_name?: string | null;
-    plan?: string | null;
-    plan_label?: string | null;
-    month_bytes_used: number;
-    month_bytes_limit: number;
-    month_usage_pct: number;
-    total_source_items: number;
-    has_billing: boolean;
-    has_subscription: boolean;
-    raw: Record<string, unknown>;
-}
-interface PartnerUsage {
-    plan?: string | null;
-    month_bytes_used: number;
-    month_bytes_limit: number;
-    month_bytes_remaining: number;
-    month_usage_pct: number;
-    raw: Record<string, unknown>;
-}
-interface PartnerApiKeyRecord {
-    credential_id: string;
-    name?: string | null;
-    key_id?: string | null;
-    allowed_source_types: string[];
-    last_used_at?: string | null;
-    created_at?: string | null;
-    revoked: boolean;
-    raw: Record<string, unknown>;
-}
-interface PartnerApiKeyHandle {
-    credential_id: string;
-    name?: string | null;
-    key_id?: string | null;
-    allowed_source_types: string[];
-    masked_key_hint?: string | null;
-    raw: Record<string, unknown>;
-}
-interface AdsBilling {
-    currency?: string | null;
-    billing_mode?: string | null;
-    month_spend_jpy: number;
-    month_spend_usd: number;
-    all_time_spend_jpy: number;
-    all_time_spend_usd: number;
-    total_impressions: number;
-    total_replies: number;
-    has_billing: boolean;
-    has_subscription: boolean;
-    invoices: Array<Record<string, unknown>>;
-    wallet?: Record<string, unknown> | null;
-    balances: Array<Record<string, unknown>>;
-    supported_tokens: Array<Record<string, unknown>>;
-    funding_instructions?: Record<string, unknown> | null;
-    mandate?: PlanWeb3Mandate | null;
-    raw: Record<string, unknown>;
-}
-interface AdsBillingSettlement {
-    status?: string | null;
-    message?: string | null;
-    settles_automatically?: boolean | null;
-    cycle_key?: string | null;
-    settled_at?: string | null;
-    raw: Record<string, unknown>;
-}
-interface AdsProfile {
-    has_profile: boolean;
-    company_name?: string | null;
-    ad_currency?: string | null;
-    has_billing: boolean;
-    raw: Record<string, unknown>;
-}
-interface AdsCampaignRecord {
-    campaign_id: string;
-    name?: string | null;
-    target_url?: string | null;
-    content_brief?: string | null;
-    target_topics: string[];
-    posting_interval_minutes: number;
-    max_posts_per_day: number;
-    currency?: string | null;
-    monthly_budget_jpy: number;
-    cpm_jpy: number;
-    cpr_jpy: number;
-    monthly_budget_usd: number;
-    cpm_usd: number;
-    cpr_usd: number;
-    status: string;
-    month_spend_jpy: number;
-    month_spend_usd: number;
-    total_posts: number;
-    total_impressions: number;
-    total_replies: number;
-    next_post_at?: string | null;
-    created_at?: string | null;
-    raw: Record<string, unknown>;
-}
-interface AdsCampaignPostRecord {
-    post_id: string;
-    content_id?: string | null;
-    cost_jpy: number;
-    cost_usd: number;
-    impressions: number;
-    replies: number;
-    status?: string | null;
-    created_at?: string | null;
-    raw: Record<string, unknown>;
-}
 interface MarketProposalRecord {
     proposal_id: string;
     parent_proposal_id?: string | null;
@@ -1253,7 +1147,7 @@ interface AgentThreadRecord {
     raw: Record<string, unknown>;
 }
 
-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"];
+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", "reward_payout.created", "reward_payout.provider_pending", "reward_paid", "reward_payout.failed", "reward_payout.cancelled"];
 type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
 interface WebhookSubscriptionRecord {
     subscription_id: string;
@@ -1339,6 +1233,20 @@ interface ExecutionFailedEventData extends ExecutionCompletedEventData {
     reason_code?: string;
     reason?: string;
 }
+interface RewardPayoutEventData extends Record<string, unknown> {
+    reward_payout_request_id?: string;
+    app_id?: string;
+    developer_id?: string;
+    recipient_subject?: string;
+    amount_minor?: number;
+    display_currency?: string;
+    token_symbol?: string;
+    reward_event_id?: string;
+    status?: string;
+    tx_hash?: string | null;
+    failure_code?: string | null;
+    failure_reason?: string | null;
+}
 interface SubscriptionCreatedEvent extends WebhookEventBase<"subscription.created", SubscriptionLifecycleEventData> {
 }
 interface SubscriptionRenewedEvent extends WebhookEventBase<"subscription.renewed", SubscriptionLifecycleEventData> {
@@ -1361,7 +1269,17 @@ interface ExecutionCompletedEvent extends WebhookEventBase<"execution.completed"
 }
 interface ExecutionFailedEvent extends WebhookEventBase<"execution.failed", ExecutionFailedEventData> {
 }
-type SiglumeWebhookEvent = SubscriptionCreatedEvent | SubscriptionRenewedEvent | SubscriptionCancelledEvent | SubscriptionPausedEvent | SubscriptionReinstatedEvent | PaymentSucceededEvent | PaymentFailedEvent | CapabilityPublishedEvent | CapabilityDelistedEvent | ExecutionCompletedEvent | ExecutionFailedEvent;
+interface RewardPayoutCreatedEvent extends WebhookEventBase<"reward_payout.created", RewardPayoutEventData> {
+}
+interface RewardPayoutProviderPendingEvent extends WebhookEventBase<"reward_payout.provider_pending", RewardPayoutEventData> {
+}
+interface RewardPaidEvent extends WebhookEventBase<"reward_paid", RewardPayoutEventData> {
+}
+interface RewardPayoutFailedEvent extends WebhookEventBase<"reward_payout.failed", RewardPayoutEventData> {
+}
+interface RewardPayoutCancelledEvent extends WebhookEventBase<"reward_payout.cancelled", RewardPayoutEventData> {
+}
+type SiglumeWebhookEvent = SubscriptionCreatedEvent | SubscriptionRenewedEvent | SubscriptionCancelledEvent | SubscriptionPausedEvent | SubscriptionReinstatedEvent | PaymentSucceededEvent | PaymentFailedEvent | CapabilityPublishedEvent | CapabilityDelistedEvent | ExecutionCompletedEvent | ExecutionFailedEvent | RewardPayoutCreatedEvent | RewardPayoutProviderPendingEvent | RewardPaidEvent | RewardPayoutFailedEvent | RewardPayoutCancelledEvent;
 interface QueuedWebhookEvent {
     queued: boolean;
     event: SiglumeWebhookEvent;
@@ -1758,45 +1676,6 @@ interface SiglumeClientShape {
         agent_id?: string;
         lang?: string;
     }): Promise<InstalledToolReceiptStepRecord[]>;
-    get_partner_dashboard(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<PartnerDashboard>;
-    get_partner_usage(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<PartnerUsage>;
-    list_partner_api_keys(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<PartnerApiKeyRecord[]>;
-    create_partner_api_key(options?: {
-        agent_id?: string;
-        name?: string;
-        allowed_source_types?: string[];
-        lang?: string;
-    }): Promise<PartnerApiKeyHandle>;
-    get_ads_billing(options?: {
-        agent_id?: string;
-        rail?: string;
-        lang?: string;
-    }): Promise<AdsBilling>;
-    settle_ads_billing(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<AdsBillingSettlement>;
-    get_ads_profile(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<AdsProfile>;
-    list_ads_campaigns(options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<AdsCampaignRecord[]>;
-    list_ads_campaign_posts(campaign_id: string, options?: {
-        agent_id?: string;
-        lang?: string;
-    }): Promise<AdsCampaignPostRecord[]>;
     update_agent_charter(agent_id: string, charter_text: string, options?: {
         role?: string;
         target_profile?: Record<string, unknown>;