@siglume/api-sdk 1.2.2 → 2.0.1
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 +19 -2
- package/dist/bin/siglume.cjs +63 -470
- package/dist/bin/siglume.cjs.map +1 -1
- package/dist/bin/siglume.js +63 -470
- package/dist/bin/siglume.js.map +1 -1
- package/dist/cli/index.cjs +63 -470
- package/dist/cli/index.cjs.map +1 -1
- package/dist/cli/index.d.cts +29 -268
- package/dist/cli/index.d.ts +29 -268
- package/dist/cli/index.js +63 -470
- package/dist/cli/index.js.map +1 -1
- package/dist/index.cjs +35 -454
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +30 -332
- package/dist/index.d.ts +30 -332
- package/dist/index.js +35 -454
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
package/dist/cli/index.d.cts
CHANGED
|
@@ -170,6 +170,7 @@ interface AppManifest {
|
|
|
170
170
|
capability_key: string;
|
|
171
171
|
version?: string;
|
|
172
172
|
name: string;
|
|
173
|
+
/** Buyer-facing task summary, max 240 characters. */
|
|
173
174
|
job_to_be_done: string;
|
|
174
175
|
category?: AppCategory;
|
|
175
176
|
permission_class: PermissionClass;
|
|
@@ -187,7 +188,9 @@ interface AppManifest {
|
|
|
187
188
|
jurisdiction: string;
|
|
188
189
|
applicable_regulations?: string[];
|
|
189
190
|
data_residency?: string;
|
|
191
|
+
/** Catalog tagline shown on cards and the detail header, max 60 characters. */
|
|
190
192
|
short_description?: string;
|
|
193
|
+
/** Detail-page copy for limits, approval behavior, pricing notes, and expected results, max 1000 characters. */
|
|
191
194
|
description?: string;
|
|
192
195
|
docs_url?: string;
|
|
193
196
|
support_contact?: string;
|
|
@@ -761,209 +764,6 @@ interface InstalledToolReceiptStepRecord {
|
|
|
761
764
|
created_at?: string | null;
|
|
762
765
|
raw: Record<string, unknown>;
|
|
763
766
|
}
|
|
764
|
-
interface WorksCategoryRecord {
|
|
765
|
-
key: string;
|
|
766
|
-
name_ja?: string | null;
|
|
767
|
-
name_en?: string | null;
|
|
768
|
-
description_ja?: string | null;
|
|
769
|
-
description_en?: string | null;
|
|
770
|
-
icon_url?: string | null;
|
|
771
|
-
open_job_count: number;
|
|
772
|
-
display_order: number;
|
|
773
|
-
raw: Record<string, unknown>;
|
|
774
|
-
}
|
|
775
|
-
interface WorksRegistrationRecord {
|
|
776
|
-
agent_id: string;
|
|
777
|
-
works_registered: boolean;
|
|
778
|
-
tagline?: string | null;
|
|
779
|
-
categories: string[];
|
|
780
|
-
capabilities: string[];
|
|
781
|
-
description?: string | null;
|
|
782
|
-
execution_status: string;
|
|
783
|
-
approval_required: boolean;
|
|
784
|
-
intent_id?: string | null;
|
|
785
|
-
approval_status?: string | null;
|
|
786
|
-
approval_snapshot_hash?: string | null;
|
|
787
|
-
approval_preview: Record<string, unknown>;
|
|
788
|
-
raw: Record<string, unknown>;
|
|
789
|
-
}
|
|
790
|
-
interface WorksOwnerDashboardAgent {
|
|
791
|
-
agent_id: string;
|
|
792
|
-
name?: string | null;
|
|
793
|
-
reputation: Record<string, unknown>;
|
|
794
|
-
capabilities: string[];
|
|
795
|
-
raw: Record<string, unknown>;
|
|
796
|
-
}
|
|
797
|
-
interface WorksOwnerDashboardPitch {
|
|
798
|
-
proposal_id: string;
|
|
799
|
-
need_id?: string | null;
|
|
800
|
-
title?: string | null;
|
|
801
|
-
title_en?: string | null;
|
|
802
|
-
status?: string | null;
|
|
803
|
-
raw: Record<string, unknown>;
|
|
804
|
-
}
|
|
805
|
-
interface WorksOwnerDashboardOrder {
|
|
806
|
-
order_id: string;
|
|
807
|
-
need_id?: string | null;
|
|
808
|
-
title?: string | null;
|
|
809
|
-
title_en?: string | null;
|
|
810
|
-
status?: string | null;
|
|
811
|
-
raw: Record<string, unknown>;
|
|
812
|
-
}
|
|
813
|
-
interface WorksOwnerDashboardStats {
|
|
814
|
-
total_agents: number;
|
|
815
|
-
total_pending: number;
|
|
816
|
-
total_active: number;
|
|
817
|
-
raw: Record<string, unknown>;
|
|
818
|
-
}
|
|
819
|
-
interface WorksOwnerDashboard {
|
|
820
|
-
agents: WorksOwnerDashboardAgent[];
|
|
821
|
-
pending_pitches: WorksOwnerDashboardPitch[];
|
|
822
|
-
active_orders: WorksOwnerDashboardOrder[];
|
|
823
|
-
completed_orders: WorksOwnerDashboardOrder[];
|
|
824
|
-
stats: WorksOwnerDashboardStats;
|
|
825
|
-
raw: Record<string, unknown>;
|
|
826
|
-
}
|
|
827
|
-
interface WorksPosterDashboardJob {
|
|
828
|
-
job_id: string;
|
|
829
|
-
title?: string | null;
|
|
830
|
-
title_en?: string | null;
|
|
831
|
-
proposal_count: number;
|
|
832
|
-
created_at?: string | null;
|
|
833
|
-
raw: Record<string, unknown>;
|
|
834
|
-
}
|
|
835
|
-
interface WorksPosterDashboardOrder {
|
|
836
|
-
order_id: string;
|
|
837
|
-
need_id?: string | null;
|
|
838
|
-
title?: string | null;
|
|
839
|
-
title_en?: string | null;
|
|
840
|
-
status?: string | null;
|
|
841
|
-
has_deliverable: boolean;
|
|
842
|
-
deliverable_count: number;
|
|
843
|
-
awaiting_buyer_action: boolean;
|
|
844
|
-
raw: Record<string, unknown>;
|
|
845
|
-
}
|
|
846
|
-
interface WorksPosterDashboardStats {
|
|
847
|
-
total_posted: number;
|
|
848
|
-
total_completed: number;
|
|
849
|
-
raw: Record<string, unknown>;
|
|
850
|
-
}
|
|
851
|
-
interface WorksPosterDashboard {
|
|
852
|
-
open_jobs: WorksPosterDashboardJob[];
|
|
853
|
-
in_progress_orders: WorksPosterDashboardOrder[];
|
|
854
|
-
completed_orders: WorksPosterDashboardOrder[];
|
|
855
|
-
stats: WorksPosterDashboardStats;
|
|
856
|
-
raw: Record<string, unknown>;
|
|
857
|
-
}
|
|
858
|
-
interface PartnerDashboard {
|
|
859
|
-
partner_id: string;
|
|
860
|
-
company_name?: string | null;
|
|
861
|
-
plan?: string | null;
|
|
862
|
-
plan_label?: string | null;
|
|
863
|
-
month_bytes_used: number;
|
|
864
|
-
month_bytes_limit: number;
|
|
865
|
-
month_usage_pct: number;
|
|
866
|
-
total_source_items: number;
|
|
867
|
-
has_billing: boolean;
|
|
868
|
-
has_subscription: boolean;
|
|
869
|
-
raw: Record<string, unknown>;
|
|
870
|
-
}
|
|
871
|
-
interface PartnerUsage {
|
|
872
|
-
plan?: string | null;
|
|
873
|
-
month_bytes_used: number;
|
|
874
|
-
month_bytes_limit: number;
|
|
875
|
-
month_bytes_remaining: number;
|
|
876
|
-
month_usage_pct: number;
|
|
877
|
-
raw: Record<string, unknown>;
|
|
878
|
-
}
|
|
879
|
-
interface PartnerApiKeyRecord {
|
|
880
|
-
credential_id: string;
|
|
881
|
-
name?: string | null;
|
|
882
|
-
key_id?: string | null;
|
|
883
|
-
allowed_source_types: string[];
|
|
884
|
-
last_used_at?: string | null;
|
|
885
|
-
created_at?: string | null;
|
|
886
|
-
revoked: boolean;
|
|
887
|
-
raw: Record<string, unknown>;
|
|
888
|
-
}
|
|
889
|
-
interface PartnerApiKeyHandle {
|
|
890
|
-
credential_id: string;
|
|
891
|
-
name?: string | null;
|
|
892
|
-
key_id?: string | null;
|
|
893
|
-
allowed_source_types: string[];
|
|
894
|
-
masked_key_hint?: string | null;
|
|
895
|
-
raw: Record<string, unknown>;
|
|
896
|
-
}
|
|
897
|
-
interface AdsBilling {
|
|
898
|
-
currency?: string | null;
|
|
899
|
-
billing_mode?: string | null;
|
|
900
|
-
month_spend_jpy: number;
|
|
901
|
-
month_spend_usd: number;
|
|
902
|
-
all_time_spend_jpy: number;
|
|
903
|
-
all_time_spend_usd: number;
|
|
904
|
-
total_impressions: number;
|
|
905
|
-
total_replies: number;
|
|
906
|
-
has_billing: boolean;
|
|
907
|
-
has_subscription: boolean;
|
|
908
|
-
invoices: Array<Record<string, unknown>>;
|
|
909
|
-
wallet?: Record<string, unknown> | null;
|
|
910
|
-
balances: Array<Record<string, unknown>>;
|
|
911
|
-
supported_tokens: Array<Record<string, unknown>>;
|
|
912
|
-
funding_instructions?: Record<string, unknown> | null;
|
|
913
|
-
mandate?: PlanWeb3Mandate | null;
|
|
914
|
-
raw: Record<string, unknown>;
|
|
915
|
-
}
|
|
916
|
-
interface AdsBillingSettlement {
|
|
917
|
-
status?: string | null;
|
|
918
|
-
message?: string | null;
|
|
919
|
-
settles_automatically?: boolean | null;
|
|
920
|
-
cycle_key?: string | null;
|
|
921
|
-
settled_at?: string | null;
|
|
922
|
-
raw: Record<string, unknown>;
|
|
923
|
-
}
|
|
924
|
-
interface AdsProfile {
|
|
925
|
-
has_profile: boolean;
|
|
926
|
-
company_name?: string | null;
|
|
927
|
-
ad_currency?: string | null;
|
|
928
|
-
has_billing: boolean;
|
|
929
|
-
raw: Record<string, unknown>;
|
|
930
|
-
}
|
|
931
|
-
interface AdsCampaignRecord {
|
|
932
|
-
campaign_id: string;
|
|
933
|
-
name?: string | null;
|
|
934
|
-
target_url?: string | null;
|
|
935
|
-
content_brief?: string | null;
|
|
936
|
-
target_topics: string[];
|
|
937
|
-
posting_interval_minutes: number;
|
|
938
|
-
max_posts_per_day: number;
|
|
939
|
-
currency?: string | null;
|
|
940
|
-
monthly_budget_jpy: number;
|
|
941
|
-
cpm_jpy: number;
|
|
942
|
-
cpr_jpy: number;
|
|
943
|
-
monthly_budget_usd: number;
|
|
944
|
-
cpm_usd: number;
|
|
945
|
-
cpr_usd: number;
|
|
946
|
-
status: string;
|
|
947
|
-
month_spend_jpy: number;
|
|
948
|
-
month_spend_usd: number;
|
|
949
|
-
total_posts: number;
|
|
950
|
-
total_impressions: number;
|
|
951
|
-
total_replies: number;
|
|
952
|
-
next_post_at?: string | null;
|
|
953
|
-
created_at?: string | null;
|
|
954
|
-
raw: Record<string, unknown>;
|
|
955
|
-
}
|
|
956
|
-
interface AdsCampaignPostRecord {
|
|
957
|
-
post_id: string;
|
|
958
|
-
content_id?: string | null;
|
|
959
|
-
cost_jpy: number;
|
|
960
|
-
cost_usd: number;
|
|
961
|
-
impressions: number;
|
|
962
|
-
replies: number;
|
|
963
|
-
status?: string | null;
|
|
964
|
-
created_at?: string | null;
|
|
965
|
-
raw: Record<string, unknown>;
|
|
966
|
-
}
|
|
967
767
|
interface MarketProposalRecord {
|
|
968
768
|
proposal_id: string;
|
|
969
769
|
parent_proposal_id?: string | null;
|
|
@@ -1253,7 +1053,7 @@ interface AgentThreadRecord {
|
|
|
1253
1053
|
raw: Record<string, unknown>;
|
|
1254
1054
|
}
|
|
1255
1055
|
|
|
1256
|
-
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"];
|
|
1056
|
+
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"];
|
|
1257
1057
|
type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
|
|
1258
1058
|
interface WebhookSubscriptionRecord {
|
|
1259
1059
|
subscription_id: string;
|
|
@@ -1339,6 +1139,20 @@ interface ExecutionFailedEventData extends ExecutionCompletedEventData {
|
|
|
1339
1139
|
reason_code?: string;
|
|
1340
1140
|
reason?: string;
|
|
1341
1141
|
}
|
|
1142
|
+
interface RewardPayoutEventData extends Record<string, unknown> {
|
|
1143
|
+
reward_payout_request_id?: string;
|
|
1144
|
+
app_id?: string;
|
|
1145
|
+
developer_id?: string;
|
|
1146
|
+
recipient_subject?: string;
|
|
1147
|
+
amount_minor?: number;
|
|
1148
|
+
display_currency?: string;
|
|
1149
|
+
token_symbol?: string;
|
|
1150
|
+
reward_event_id?: string;
|
|
1151
|
+
status?: string;
|
|
1152
|
+
tx_hash?: string | null;
|
|
1153
|
+
failure_code?: string | null;
|
|
1154
|
+
failure_reason?: string | null;
|
|
1155
|
+
}
|
|
1342
1156
|
interface SubscriptionCreatedEvent extends WebhookEventBase<"subscription.created", SubscriptionLifecycleEventData> {
|
|
1343
1157
|
}
|
|
1344
1158
|
interface SubscriptionRenewedEvent extends WebhookEventBase<"subscription.renewed", SubscriptionLifecycleEventData> {
|
|
@@ -1361,7 +1175,17 @@ interface ExecutionCompletedEvent extends WebhookEventBase<"execution.completed"
|
|
|
1361
1175
|
}
|
|
1362
1176
|
interface ExecutionFailedEvent extends WebhookEventBase<"execution.failed", ExecutionFailedEventData> {
|
|
1363
1177
|
}
|
|
1364
|
-
|
|
1178
|
+
interface RewardPayoutCreatedEvent extends WebhookEventBase<"reward_payout.created", RewardPayoutEventData> {
|
|
1179
|
+
}
|
|
1180
|
+
interface RewardPayoutProviderPendingEvent extends WebhookEventBase<"reward_payout.provider_pending", RewardPayoutEventData> {
|
|
1181
|
+
}
|
|
1182
|
+
interface RewardPaidEvent extends WebhookEventBase<"reward_paid", RewardPayoutEventData> {
|
|
1183
|
+
}
|
|
1184
|
+
interface RewardPayoutFailedEvent extends WebhookEventBase<"reward_payout.failed", RewardPayoutEventData> {
|
|
1185
|
+
}
|
|
1186
|
+
interface RewardPayoutCancelledEvent extends WebhookEventBase<"reward_payout.cancelled", RewardPayoutEventData> {
|
|
1187
|
+
}
|
|
1188
|
+
type SiglumeWebhookEvent = SubscriptionCreatedEvent | SubscriptionRenewedEvent | SubscriptionCancelledEvent | SubscriptionPausedEvent | SubscriptionReinstatedEvent | PaymentSucceededEvent | PaymentFailedEvent | CapabilityPublishedEvent | CapabilityDelistedEvent | ExecutionCompletedEvent | ExecutionFailedEvent | RewardPayoutCreatedEvent | RewardPayoutProviderPendingEvent | RewardPaidEvent | RewardPayoutFailedEvent | RewardPayoutCancelledEvent;
|
|
1365
1189
|
interface QueuedWebhookEvent {
|
|
1366
1190
|
queued: boolean;
|
|
1367
1191
|
event: SiglumeWebhookEvent;
|
|
@@ -1613,30 +1437,6 @@ interface SiglumeClientShape {
|
|
|
1613
1437
|
status?: string;
|
|
1614
1438
|
lang?: string;
|
|
1615
1439
|
}): Promise<MarketNeedRecord>;
|
|
1616
|
-
list_works_categories(options?: {
|
|
1617
|
-
agent_id?: string;
|
|
1618
|
-
lang?: string;
|
|
1619
|
-
}): Promise<WorksCategoryRecord[]>;
|
|
1620
|
-
get_works_registration(options?: {
|
|
1621
|
-
agent_id?: string;
|
|
1622
|
-
lang?: string;
|
|
1623
|
-
}): Promise<WorksRegistrationRecord>;
|
|
1624
|
-
register_for_works(options?: {
|
|
1625
|
-
agent_id?: string;
|
|
1626
|
-
tagline?: string;
|
|
1627
|
-
description?: string;
|
|
1628
|
-
categories?: string[];
|
|
1629
|
-
capabilities?: string[];
|
|
1630
|
-
lang?: string;
|
|
1631
|
-
}): Promise<WorksRegistrationRecord>;
|
|
1632
|
-
get_works_owner_dashboard(options?: {
|
|
1633
|
-
agent_id?: string;
|
|
1634
|
-
lang?: string;
|
|
1635
|
-
}): Promise<WorksOwnerDashboard>;
|
|
1636
|
-
get_works_poster_dashboard(options?: {
|
|
1637
|
-
agent_id?: string;
|
|
1638
|
-
lang?: string;
|
|
1639
|
-
}): Promise<WorksPosterDashboard>;
|
|
1640
1440
|
list_market_proposals(options?: {
|
|
1641
1441
|
agent_id?: string;
|
|
1642
1442
|
status?: string;
|
|
@@ -1758,45 +1558,6 @@ interface SiglumeClientShape {
|
|
|
1758
1558
|
agent_id?: string;
|
|
1759
1559
|
lang?: string;
|
|
1760
1560
|
}): Promise<InstalledToolReceiptStepRecord[]>;
|
|
1761
|
-
get_partner_dashboard(options?: {
|
|
1762
|
-
agent_id?: string;
|
|
1763
|
-
lang?: string;
|
|
1764
|
-
}): Promise<PartnerDashboard>;
|
|
1765
|
-
get_partner_usage(options?: {
|
|
1766
|
-
agent_id?: string;
|
|
1767
|
-
lang?: string;
|
|
1768
|
-
}): Promise<PartnerUsage>;
|
|
1769
|
-
list_partner_api_keys(options?: {
|
|
1770
|
-
agent_id?: string;
|
|
1771
|
-
lang?: string;
|
|
1772
|
-
}): Promise<PartnerApiKeyRecord[]>;
|
|
1773
|
-
create_partner_api_key(options?: {
|
|
1774
|
-
agent_id?: string;
|
|
1775
|
-
name?: string;
|
|
1776
|
-
allowed_source_types?: string[];
|
|
1777
|
-
lang?: string;
|
|
1778
|
-
}): Promise<PartnerApiKeyHandle>;
|
|
1779
|
-
get_ads_billing(options?: {
|
|
1780
|
-
agent_id?: string;
|
|
1781
|
-
rail?: string;
|
|
1782
|
-
lang?: string;
|
|
1783
|
-
}): Promise<AdsBilling>;
|
|
1784
|
-
settle_ads_billing(options?: {
|
|
1785
|
-
agent_id?: string;
|
|
1786
|
-
lang?: string;
|
|
1787
|
-
}): Promise<AdsBillingSettlement>;
|
|
1788
|
-
get_ads_profile(options?: {
|
|
1789
|
-
agent_id?: string;
|
|
1790
|
-
lang?: string;
|
|
1791
|
-
}): Promise<AdsProfile>;
|
|
1792
|
-
list_ads_campaigns(options?: {
|
|
1793
|
-
agent_id?: string;
|
|
1794
|
-
lang?: string;
|
|
1795
|
-
}): Promise<AdsCampaignRecord[]>;
|
|
1796
|
-
list_ads_campaign_posts(campaign_id: string, options?: {
|
|
1797
|
-
agent_id?: string;
|
|
1798
|
-
lang?: string;
|
|
1799
|
-
}): Promise<AdsCampaignPostRecord[]>;
|
|
1800
1561
|
update_agent_charter(agent_id: string, charter_text: string, options?: {
|
|
1801
1562
|
role?: string;
|
|
1802
1563
|
target_profile?: Record<string, unknown>;
|
package/dist/cli/index.d.ts
CHANGED
|
@@ -170,6 +170,7 @@ interface AppManifest {
|
|
|
170
170
|
capability_key: string;
|
|
171
171
|
version?: string;
|
|
172
172
|
name: string;
|
|
173
|
+
/** Buyer-facing task summary, max 240 characters. */
|
|
173
174
|
job_to_be_done: string;
|
|
174
175
|
category?: AppCategory;
|
|
175
176
|
permission_class: PermissionClass;
|
|
@@ -187,7 +188,9 @@ interface AppManifest {
|
|
|
187
188
|
jurisdiction: string;
|
|
188
189
|
applicable_regulations?: string[];
|
|
189
190
|
data_residency?: string;
|
|
191
|
+
/** Catalog tagline shown on cards and the detail header, max 60 characters. */
|
|
190
192
|
short_description?: string;
|
|
193
|
+
/** Detail-page copy for limits, approval behavior, pricing notes, and expected results, max 1000 characters. */
|
|
191
194
|
description?: string;
|
|
192
195
|
docs_url?: string;
|
|
193
196
|
support_contact?: string;
|
|
@@ -761,209 +764,6 @@ interface InstalledToolReceiptStepRecord {
|
|
|
761
764
|
created_at?: string | null;
|
|
762
765
|
raw: Record<string, unknown>;
|
|
763
766
|
}
|
|
764
|
-
interface WorksCategoryRecord {
|
|
765
|
-
key: string;
|
|
766
|
-
name_ja?: string | null;
|
|
767
|
-
name_en?: string | null;
|
|
768
|
-
description_ja?: string | null;
|
|
769
|
-
description_en?: string | null;
|
|
770
|
-
icon_url?: string | null;
|
|
771
|
-
open_job_count: number;
|
|
772
|
-
display_order: number;
|
|
773
|
-
raw: Record<string, unknown>;
|
|
774
|
-
}
|
|
775
|
-
interface WorksRegistrationRecord {
|
|
776
|
-
agent_id: string;
|
|
777
|
-
works_registered: boolean;
|
|
778
|
-
tagline?: string | null;
|
|
779
|
-
categories: string[];
|
|
780
|
-
capabilities: string[];
|
|
781
|
-
description?: string | null;
|
|
782
|
-
execution_status: string;
|
|
783
|
-
approval_required: boolean;
|
|
784
|
-
intent_id?: string | null;
|
|
785
|
-
approval_status?: string | null;
|
|
786
|
-
approval_snapshot_hash?: string | null;
|
|
787
|
-
approval_preview: Record<string, unknown>;
|
|
788
|
-
raw: Record<string, unknown>;
|
|
789
|
-
}
|
|
790
|
-
interface WorksOwnerDashboardAgent {
|
|
791
|
-
agent_id: string;
|
|
792
|
-
name?: string | null;
|
|
793
|
-
reputation: Record<string, unknown>;
|
|
794
|
-
capabilities: string[];
|
|
795
|
-
raw: Record<string, unknown>;
|
|
796
|
-
}
|
|
797
|
-
interface WorksOwnerDashboardPitch {
|
|
798
|
-
proposal_id: string;
|
|
799
|
-
need_id?: string | null;
|
|
800
|
-
title?: string | null;
|
|
801
|
-
title_en?: string | null;
|
|
802
|
-
status?: string | null;
|
|
803
|
-
raw: Record<string, unknown>;
|
|
804
|
-
}
|
|
805
|
-
interface WorksOwnerDashboardOrder {
|
|
806
|
-
order_id: string;
|
|
807
|
-
need_id?: string | null;
|
|
808
|
-
title?: string | null;
|
|
809
|
-
title_en?: string | null;
|
|
810
|
-
status?: string | null;
|
|
811
|
-
raw: Record<string, unknown>;
|
|
812
|
-
}
|
|
813
|
-
interface WorksOwnerDashboardStats {
|
|
814
|
-
total_agents: number;
|
|
815
|
-
total_pending: number;
|
|
816
|
-
total_active: number;
|
|
817
|
-
raw: Record<string, unknown>;
|
|
818
|
-
}
|
|
819
|
-
interface WorksOwnerDashboard {
|
|
820
|
-
agents: WorksOwnerDashboardAgent[];
|
|
821
|
-
pending_pitches: WorksOwnerDashboardPitch[];
|
|
822
|
-
active_orders: WorksOwnerDashboardOrder[];
|
|
823
|
-
completed_orders: WorksOwnerDashboardOrder[];
|
|
824
|
-
stats: WorksOwnerDashboardStats;
|
|
825
|
-
raw: Record<string, unknown>;
|
|
826
|
-
}
|
|
827
|
-
interface WorksPosterDashboardJob {
|
|
828
|
-
job_id: string;
|
|
829
|
-
title?: string | null;
|
|
830
|
-
title_en?: string | null;
|
|
831
|
-
proposal_count: number;
|
|
832
|
-
created_at?: string | null;
|
|
833
|
-
raw: Record<string, unknown>;
|
|
834
|
-
}
|
|
835
|
-
interface WorksPosterDashboardOrder {
|
|
836
|
-
order_id: string;
|
|
837
|
-
need_id?: string | null;
|
|
838
|
-
title?: string | null;
|
|
839
|
-
title_en?: string | null;
|
|
840
|
-
status?: string | null;
|
|
841
|
-
has_deliverable: boolean;
|
|
842
|
-
deliverable_count: number;
|
|
843
|
-
awaiting_buyer_action: boolean;
|
|
844
|
-
raw: Record<string, unknown>;
|
|
845
|
-
}
|
|
846
|
-
interface WorksPosterDashboardStats {
|
|
847
|
-
total_posted: number;
|
|
848
|
-
total_completed: number;
|
|
849
|
-
raw: Record<string, unknown>;
|
|
850
|
-
}
|
|
851
|
-
interface WorksPosterDashboard {
|
|
852
|
-
open_jobs: WorksPosterDashboardJob[];
|
|
853
|
-
in_progress_orders: WorksPosterDashboardOrder[];
|
|
854
|
-
completed_orders: WorksPosterDashboardOrder[];
|
|
855
|
-
stats: WorksPosterDashboardStats;
|
|
856
|
-
raw: Record<string, unknown>;
|
|
857
|
-
}
|
|
858
|
-
interface PartnerDashboard {
|
|
859
|
-
partner_id: string;
|
|
860
|
-
company_name?: string | null;
|
|
861
|
-
plan?: string | null;
|
|
862
|
-
plan_label?: string | null;
|
|
863
|
-
month_bytes_used: number;
|
|
864
|
-
month_bytes_limit: number;
|
|
865
|
-
month_usage_pct: number;
|
|
866
|
-
total_source_items: number;
|
|
867
|
-
has_billing: boolean;
|
|
868
|
-
has_subscription: boolean;
|
|
869
|
-
raw: Record<string, unknown>;
|
|
870
|
-
}
|
|
871
|
-
interface PartnerUsage {
|
|
872
|
-
plan?: string | null;
|
|
873
|
-
month_bytes_used: number;
|
|
874
|
-
month_bytes_limit: number;
|
|
875
|
-
month_bytes_remaining: number;
|
|
876
|
-
month_usage_pct: number;
|
|
877
|
-
raw: Record<string, unknown>;
|
|
878
|
-
}
|
|
879
|
-
interface PartnerApiKeyRecord {
|
|
880
|
-
credential_id: string;
|
|
881
|
-
name?: string | null;
|
|
882
|
-
key_id?: string | null;
|
|
883
|
-
allowed_source_types: string[];
|
|
884
|
-
last_used_at?: string | null;
|
|
885
|
-
created_at?: string | null;
|
|
886
|
-
revoked: boolean;
|
|
887
|
-
raw: Record<string, unknown>;
|
|
888
|
-
}
|
|
889
|
-
interface PartnerApiKeyHandle {
|
|
890
|
-
credential_id: string;
|
|
891
|
-
name?: string | null;
|
|
892
|
-
key_id?: string | null;
|
|
893
|
-
allowed_source_types: string[];
|
|
894
|
-
masked_key_hint?: string | null;
|
|
895
|
-
raw: Record<string, unknown>;
|
|
896
|
-
}
|
|
897
|
-
interface AdsBilling {
|
|
898
|
-
currency?: string | null;
|
|
899
|
-
billing_mode?: string | null;
|
|
900
|
-
month_spend_jpy: number;
|
|
901
|
-
month_spend_usd: number;
|
|
902
|
-
all_time_spend_jpy: number;
|
|
903
|
-
all_time_spend_usd: number;
|
|
904
|
-
total_impressions: number;
|
|
905
|
-
total_replies: number;
|
|
906
|
-
has_billing: boolean;
|
|
907
|
-
has_subscription: boolean;
|
|
908
|
-
invoices: Array<Record<string, unknown>>;
|
|
909
|
-
wallet?: Record<string, unknown> | null;
|
|
910
|
-
balances: Array<Record<string, unknown>>;
|
|
911
|
-
supported_tokens: Array<Record<string, unknown>>;
|
|
912
|
-
funding_instructions?: Record<string, unknown> | null;
|
|
913
|
-
mandate?: PlanWeb3Mandate | null;
|
|
914
|
-
raw: Record<string, unknown>;
|
|
915
|
-
}
|
|
916
|
-
interface AdsBillingSettlement {
|
|
917
|
-
status?: string | null;
|
|
918
|
-
message?: string | null;
|
|
919
|
-
settles_automatically?: boolean | null;
|
|
920
|
-
cycle_key?: string | null;
|
|
921
|
-
settled_at?: string | null;
|
|
922
|
-
raw: Record<string, unknown>;
|
|
923
|
-
}
|
|
924
|
-
interface AdsProfile {
|
|
925
|
-
has_profile: boolean;
|
|
926
|
-
company_name?: string | null;
|
|
927
|
-
ad_currency?: string | null;
|
|
928
|
-
has_billing: boolean;
|
|
929
|
-
raw: Record<string, unknown>;
|
|
930
|
-
}
|
|
931
|
-
interface AdsCampaignRecord {
|
|
932
|
-
campaign_id: string;
|
|
933
|
-
name?: string | null;
|
|
934
|
-
target_url?: string | null;
|
|
935
|
-
content_brief?: string | null;
|
|
936
|
-
target_topics: string[];
|
|
937
|
-
posting_interval_minutes: number;
|
|
938
|
-
max_posts_per_day: number;
|
|
939
|
-
currency?: string | null;
|
|
940
|
-
monthly_budget_jpy: number;
|
|
941
|
-
cpm_jpy: number;
|
|
942
|
-
cpr_jpy: number;
|
|
943
|
-
monthly_budget_usd: number;
|
|
944
|
-
cpm_usd: number;
|
|
945
|
-
cpr_usd: number;
|
|
946
|
-
status: string;
|
|
947
|
-
month_spend_jpy: number;
|
|
948
|
-
month_spend_usd: number;
|
|
949
|
-
total_posts: number;
|
|
950
|
-
total_impressions: number;
|
|
951
|
-
total_replies: number;
|
|
952
|
-
next_post_at?: string | null;
|
|
953
|
-
created_at?: string | null;
|
|
954
|
-
raw: Record<string, unknown>;
|
|
955
|
-
}
|
|
956
|
-
interface AdsCampaignPostRecord {
|
|
957
|
-
post_id: string;
|
|
958
|
-
content_id?: string | null;
|
|
959
|
-
cost_jpy: number;
|
|
960
|
-
cost_usd: number;
|
|
961
|
-
impressions: number;
|
|
962
|
-
replies: number;
|
|
963
|
-
status?: string | null;
|
|
964
|
-
created_at?: string | null;
|
|
965
|
-
raw: Record<string, unknown>;
|
|
966
|
-
}
|
|
967
767
|
interface MarketProposalRecord {
|
|
968
768
|
proposal_id: string;
|
|
969
769
|
parent_proposal_id?: string | null;
|
|
@@ -1253,7 +1053,7 @@ interface AgentThreadRecord {
|
|
|
1253
1053
|
raw: Record<string, unknown>;
|
|
1254
1054
|
}
|
|
1255
1055
|
|
|
1256
|
-
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"];
|
|
1056
|
+
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"];
|
|
1257
1057
|
type WebhookEventType = (typeof WEBHOOK_EVENT_TYPES)[number];
|
|
1258
1058
|
interface WebhookSubscriptionRecord {
|
|
1259
1059
|
subscription_id: string;
|
|
@@ -1339,6 +1139,20 @@ interface ExecutionFailedEventData extends ExecutionCompletedEventData {
|
|
|
1339
1139
|
reason_code?: string;
|
|
1340
1140
|
reason?: string;
|
|
1341
1141
|
}
|
|
1142
|
+
interface RewardPayoutEventData extends Record<string, unknown> {
|
|
1143
|
+
reward_payout_request_id?: string;
|
|
1144
|
+
app_id?: string;
|
|
1145
|
+
developer_id?: string;
|
|
1146
|
+
recipient_subject?: string;
|
|
1147
|
+
amount_minor?: number;
|
|
1148
|
+
display_currency?: string;
|
|
1149
|
+
token_symbol?: string;
|
|
1150
|
+
reward_event_id?: string;
|
|
1151
|
+
status?: string;
|
|
1152
|
+
tx_hash?: string | null;
|
|
1153
|
+
failure_code?: string | null;
|
|
1154
|
+
failure_reason?: string | null;
|
|
1155
|
+
}
|
|
1342
1156
|
interface SubscriptionCreatedEvent extends WebhookEventBase<"subscription.created", SubscriptionLifecycleEventData> {
|
|
1343
1157
|
}
|
|
1344
1158
|
interface SubscriptionRenewedEvent extends WebhookEventBase<"subscription.renewed", SubscriptionLifecycleEventData> {
|
|
@@ -1361,7 +1175,17 @@ interface ExecutionCompletedEvent extends WebhookEventBase<"execution.completed"
|
|
|
1361
1175
|
}
|
|
1362
1176
|
interface ExecutionFailedEvent extends WebhookEventBase<"execution.failed", ExecutionFailedEventData> {
|
|
1363
1177
|
}
|
|
1364
|
-
|
|
1178
|
+
interface RewardPayoutCreatedEvent extends WebhookEventBase<"reward_payout.created", RewardPayoutEventData> {
|
|
1179
|
+
}
|
|
1180
|
+
interface RewardPayoutProviderPendingEvent extends WebhookEventBase<"reward_payout.provider_pending", RewardPayoutEventData> {
|
|
1181
|
+
}
|
|
1182
|
+
interface RewardPaidEvent extends WebhookEventBase<"reward_paid", RewardPayoutEventData> {
|
|
1183
|
+
}
|
|
1184
|
+
interface RewardPayoutFailedEvent extends WebhookEventBase<"reward_payout.failed", RewardPayoutEventData> {
|
|
1185
|
+
}
|
|
1186
|
+
interface RewardPayoutCancelledEvent extends WebhookEventBase<"reward_payout.cancelled", RewardPayoutEventData> {
|
|
1187
|
+
}
|
|
1188
|
+
type SiglumeWebhookEvent = SubscriptionCreatedEvent | SubscriptionRenewedEvent | SubscriptionCancelledEvent | SubscriptionPausedEvent | SubscriptionReinstatedEvent | PaymentSucceededEvent | PaymentFailedEvent | CapabilityPublishedEvent | CapabilityDelistedEvent | ExecutionCompletedEvent | ExecutionFailedEvent | RewardPayoutCreatedEvent | RewardPayoutProviderPendingEvent | RewardPaidEvent | RewardPayoutFailedEvent | RewardPayoutCancelledEvent;
|
|
1365
1189
|
interface QueuedWebhookEvent {
|
|
1366
1190
|
queued: boolean;
|
|
1367
1191
|
event: SiglumeWebhookEvent;
|
|
@@ -1613,30 +1437,6 @@ interface SiglumeClientShape {
|
|
|
1613
1437
|
status?: string;
|
|
1614
1438
|
lang?: string;
|
|
1615
1439
|
}): Promise<MarketNeedRecord>;
|
|
1616
|
-
list_works_categories(options?: {
|
|
1617
|
-
agent_id?: string;
|
|
1618
|
-
lang?: string;
|
|
1619
|
-
}): Promise<WorksCategoryRecord[]>;
|
|
1620
|
-
get_works_registration(options?: {
|
|
1621
|
-
agent_id?: string;
|
|
1622
|
-
lang?: string;
|
|
1623
|
-
}): Promise<WorksRegistrationRecord>;
|
|
1624
|
-
register_for_works(options?: {
|
|
1625
|
-
agent_id?: string;
|
|
1626
|
-
tagline?: string;
|
|
1627
|
-
description?: string;
|
|
1628
|
-
categories?: string[];
|
|
1629
|
-
capabilities?: string[];
|
|
1630
|
-
lang?: string;
|
|
1631
|
-
}): Promise<WorksRegistrationRecord>;
|
|
1632
|
-
get_works_owner_dashboard(options?: {
|
|
1633
|
-
agent_id?: string;
|
|
1634
|
-
lang?: string;
|
|
1635
|
-
}): Promise<WorksOwnerDashboard>;
|
|
1636
|
-
get_works_poster_dashboard(options?: {
|
|
1637
|
-
agent_id?: string;
|
|
1638
|
-
lang?: string;
|
|
1639
|
-
}): Promise<WorksPosterDashboard>;
|
|
1640
1440
|
list_market_proposals(options?: {
|
|
1641
1441
|
agent_id?: string;
|
|
1642
1442
|
status?: string;
|
|
@@ -1758,45 +1558,6 @@ interface SiglumeClientShape {
|
|
|
1758
1558
|
agent_id?: string;
|
|
1759
1559
|
lang?: string;
|
|
1760
1560
|
}): Promise<InstalledToolReceiptStepRecord[]>;
|
|
1761
|
-
get_partner_dashboard(options?: {
|
|
1762
|
-
agent_id?: string;
|
|
1763
|
-
lang?: string;
|
|
1764
|
-
}): Promise<PartnerDashboard>;
|
|
1765
|
-
get_partner_usage(options?: {
|
|
1766
|
-
agent_id?: string;
|
|
1767
|
-
lang?: string;
|
|
1768
|
-
}): Promise<PartnerUsage>;
|
|
1769
|
-
list_partner_api_keys(options?: {
|
|
1770
|
-
agent_id?: string;
|
|
1771
|
-
lang?: string;
|
|
1772
|
-
}): Promise<PartnerApiKeyRecord[]>;
|
|
1773
|
-
create_partner_api_key(options?: {
|
|
1774
|
-
agent_id?: string;
|
|
1775
|
-
name?: string;
|
|
1776
|
-
allowed_source_types?: string[];
|
|
1777
|
-
lang?: string;
|
|
1778
|
-
}): Promise<PartnerApiKeyHandle>;
|
|
1779
|
-
get_ads_billing(options?: {
|
|
1780
|
-
agent_id?: string;
|
|
1781
|
-
rail?: string;
|
|
1782
|
-
lang?: string;
|
|
1783
|
-
}): Promise<AdsBilling>;
|
|
1784
|
-
settle_ads_billing(options?: {
|
|
1785
|
-
agent_id?: string;
|
|
1786
|
-
lang?: string;
|
|
1787
|
-
}): Promise<AdsBillingSettlement>;
|
|
1788
|
-
get_ads_profile(options?: {
|
|
1789
|
-
agent_id?: string;
|
|
1790
|
-
lang?: string;
|
|
1791
|
-
}): Promise<AdsProfile>;
|
|
1792
|
-
list_ads_campaigns(options?: {
|
|
1793
|
-
agent_id?: string;
|
|
1794
|
-
lang?: string;
|
|
1795
|
-
}): Promise<AdsCampaignRecord[]>;
|
|
1796
|
-
list_ads_campaign_posts(campaign_id: string, options?: {
|
|
1797
|
-
agent_id?: string;
|
|
1798
|
-
lang?: string;
|
|
1799
|
-
}): Promise<AdsCampaignPostRecord[]>;
|
|
1800
1561
|
update_agent_charter(agent_id: string, charter_text: string, options?: {
|
|
1801
1562
|
role?: string;
|
|
1802
1563
|
target_profile?: Record<string, unknown>;
|