@beeperbot/sdk 0.2.0 → 0.2.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/dist/index.d.cts CHANGED
@@ -1545,6 +1545,154 @@ declare function getApiKeyEnvironment(apiKey: string): 'production' | 'test' | n
1545
1545
  */
1546
1546
  declare function maskApiKey(apiKey: string): string;
1547
1547
 
1548
+ /**
1549
+ * Mission & Bonus Reward Types for beeper-sdk
1550
+ *
1551
+ * Types for configuring bonus missions (CTAs + reward distribution)
1552
+ * on beeps and campaigns.
1553
+ */
1554
+ /** Farcaster: Follow a profile */
1555
+ interface FollowProfileCTA {
1556
+ type: 'follow_profile';
1557
+ profileFid: number;
1558
+ profileUsername?: string;
1559
+ profileDisplayName?: string;
1560
+ }
1561
+ /** Farcaster: Like a specific cast */
1562
+ interface LikeCastCTA {
1563
+ type: 'like_cast';
1564
+ castHash: string;
1565
+ castUrl?: string;
1566
+ castAuthorFid?: number;
1567
+ castAuthorUsername?: string;
1568
+ }
1569
+ /** Farcaster: Recast a specific cast */
1570
+ interface RecastCTA {
1571
+ type: 'recast';
1572
+ castHash: string;
1573
+ castUrl?: string;
1574
+ castAuthorFid?: number;
1575
+ castAuthorUsername?: string;
1576
+ }
1577
+ /** Farcaster: Post a quote cast with requirements */
1578
+ interface ShareCastCTA {
1579
+ type: 'share_cast';
1580
+ requirements?: {
1581
+ textIncludes?: string[];
1582
+ mentions?: string[];
1583
+ embeds?: string[];
1584
+ };
1585
+ }
1586
+ /** Universal: Visit a link */
1587
+ interface VisitLinkCTA {
1588
+ type: 'visit_link';
1589
+ url: string;
1590
+ label?: string;
1591
+ }
1592
+ /** Universal: Answer quiz questions */
1593
+ interface QuizCTA {
1594
+ type: 'quiz';
1595
+ questions: QuizQuestion[];
1596
+ }
1597
+ interface QuizQuestion {
1598
+ question: string;
1599
+ answers: string[];
1600
+ correctAnswerIndex: number;
1601
+ }
1602
+ /** Universal: Custom verification via external endpoint */
1603
+ interface ExternalVerifyCTA {
1604
+ type: 'external_verify';
1605
+ endpointUrl: string;
1606
+ appUrl: string;
1607
+ appIsMiniApp?: boolean;
1608
+ guideUrl?: string;
1609
+ guideLabel?: string;
1610
+ description?: string;
1611
+ }
1612
+ /** X (Twitter): Follow a profile */
1613
+ interface XFollowCTA {
1614
+ type: 'x_follow';
1615
+ handle: string;
1616
+ profileUrl: string;
1617
+ displayName?: string;
1618
+ }
1619
+ /** X (Twitter): Like a tweet */
1620
+ interface XLikeCTA {
1621
+ type: 'x_like';
1622
+ tweetId: string;
1623
+ tweetUrl: string;
1624
+ authorHandle?: string;
1625
+ tweetText?: string;
1626
+ }
1627
+ /** X (Twitter): Repost a tweet */
1628
+ interface XRecastCTA {
1629
+ type: 'x_recast';
1630
+ tweetId: string;
1631
+ tweetUrl: string;
1632
+ authorHandle?: string;
1633
+ tweetText?: string;
1634
+ }
1635
+ /** All CTA types */
1636
+ type MissionCTA = FollowProfileCTA | LikeCastCTA | RecastCTA | ShareCastCTA | VisitLinkCTA | QuizCTA | ExternalVerifyCTA | XFollowCTA | XLikeCTA | XRecastCTA;
1637
+ /** CTA type strings */
1638
+ type CTAType = MissionCTA['type'];
1639
+ /** Lottery prize tier */
1640
+ interface PrizeTier {
1641
+ prizeAmount: number;
1642
+ winnerCount: number;
1643
+ }
1644
+ /** Lottery distribution config */
1645
+ interface LotteryConfig {
1646
+ prizeTiers: PrizeTier[];
1647
+ durationSeconds?: number;
1648
+ }
1649
+ /** FCFS distribution config */
1650
+ interface FCFSConfig {
1651
+ amountPerClaim: number;
1652
+ maxClaims: number;
1653
+ startDelaySeconds?: number;
1654
+ }
1655
+ /** Bonus reward configuration */
1656
+ interface BonusConfig {
1657
+ type: 'lottery' | 'fcfs';
1658
+ ctas?: MissionCTA[];
1659
+ lotteryConfig?: LotteryConfig;
1660
+ fcfsConfig?: FCFSConfig;
1661
+ }
1662
+ /** How budget is split between payout and bonus pool */
1663
+ type GoalType = 'max_reach' | 'lil_mission' | 'hard_mission';
1664
+ /** Fine-tune the budget split */
1665
+ type SplitPreset = 'balanced' | 'more_reach' | 'more_action';
1666
+ /** Computed budget split */
1667
+ interface BudgetSplit {
1668
+ totalUsd: number;
1669
+ payoutUsd: number;
1670
+ bonusUsd: number;
1671
+ platformFeeUsd: number;
1672
+ userPaysUsd: number;
1673
+ goalType: GoalType;
1674
+ splitPreset: SplitPreset;
1675
+ payoutPercent: number;
1676
+ bonusPercent: number;
1677
+ }
1678
+ /** Campaign input extending estimate with mission support */
1679
+ interface CampaignInput {
1680
+ filters: Record<string, unknown>;
1681
+ budget: string;
1682
+ message?: string;
1683
+ goalType?: GoalType;
1684
+ splitPreset?: SplitPreset;
1685
+ bonusConfig?: BonusConfig;
1686
+ }
1687
+
1688
+ /**
1689
+ * Core types for the Beeper SDK
1690
+ *
1691
+ * These types are the canonical API contract types matching the BeeperClient
1692
+ * and the backend HTTP contract. Legacy types from the old schema-based API
1693
+ * have been removed or replaced.
1694
+ */
1695
+
1548
1696
  /**
1549
1697
  * Draft input - what the user provides to create a draft
1550
1698
  */
@@ -4344,4 +4492,4 @@ declare function validateFilterHasTargeting(filter: RecipientFilter): boolean;
4344
4492
  */
4345
4493
  declare function describeFilters(filter: RecipientFilter): string[];
4346
4494
 
4347
- export { API_BASE_URLS, API_KEY_PREFIXES, ActiveInLastDaysFilterSchema, AgentClient, type AgentClientConfig, type User as AgentUser, type ApiQuoteResponse, ApiQuoteResponseSchema, type ApiReceiptResponse, ApiReceiptResponseSchema, type AttentionPrice, type AttentionQuoteInput, BeeperClient, type BeeperClientConfig, type BeeperConfig, BeeperEconomicsFilterSchema, type BeeperEconomicsFilter as BeeperEconomicsFilterSchemaType, BeeperError, type BeeperErrorOptions, type BulkIntentInput, type BulkIntentResult, CachedTokenHolderFilterSchema, CachedTokenHolderSchema, type CachedTokenHolder as CachedTokenHolderSchemaType, type ConfirmDeploymentInput, type ConfirmDeploymentResult, type ConfirmDepositParams, type ConfirmDepositResponse, ConfirmDepositResponseSchema, type ConfirmResult, ConfirmResultSchema, CountryFilterSchema, type CreateIntentInput, DistributionStrategySchema, type Draft, type DraftInput, DraftInputSchema, DraftSchema, DraftStatusSchema, DraftUpdateSchema, type Environment, type ErrorCode, ErrorCodes, type ErrorContext, type EstimateInput, type EstimateResult, ExcludePingedTodayFilterSchema, ExcludeUsersFilterSchema, type ExecuteResult, ExecuteResultSchema, type ExecuteSendParams, type ExecuteSendResponse, ExecuteSendResponseSchema, ExecuteStatusSchema, FILTER_SCHEMA, FieldComparisonSchema, FilterBuilder, type FilterCategory, FilterExpression$1 as FilterExpression, type FilterExpressionJSON, FilterExpressionSchema, type FilterExpression as FilterExpressionSchemaType, type FilterFieldSchema, FilterOperatorSchema, FilterValueSchema, FollowersOfFilterSchema, FollowingOfFilterSchema, GasTierSchema, HEADERS, HTTP_STATUS_TO_ERROR_CODE, HasBaseWalletFilterSchema, HasRechargedInLastDaysFilterSchema, HasTierFilterSchema, HasVerifiedWalletFilterSchema, type Health, HttpClient, type HttpClientConfig, type HttpRequestOptions, type HttpResponse, IsWaitlistedFilterSchema, type LegacyFieldComparison, LegacyFieldComparisonSchema, type LegacyFilterOperator, LegacyFilterOperatorSchema, type LegacyFilterValue, LegacyFilterValueSchema, LegacyRecipientFilterDSLSchema, MaxAttentionPriceFilterSchema, MaxFidFilterSchema, MaxFollowersFilterSchema, MaxFollowingFilterSchema, MinAttentionPriceFilterSchema, MinBatteryPercentageFilterSchema, MinCastCountFilterSchema, MinClickThroughRateFilterSchema, MinFidFilterSchema, MinFollowersFilterSchema, MinFollowingFilterSchema, MinProTenureDaysFilterSchema, MinTenureDaysFilterSchema, MutualsWithFilterSchema, NetworkSchema, NeynarScoreMaxFilterSchema, NeynarScoreMinFilterSchema, OnchainFilterSchema, type OnchainFilter as OnchainFilterSchemaType, type OrderByOption, OrderBySchema, type OrderBy as OrderBySchemaType, type PaginatedResponse, type PaginationOptions, type PaymentIntent, type Platform, PlatformFilterSchema, type PlatformFilter as PlatformFilterSchemaType, type PollOptions$1 as PollOptions, type PreviewInput, type PreviewResult, type PreviewUser, ProSubscriptionFilterSchema, QUOTE_EXPIRATION_SECONDS, type Quote, type QuoteOptions, QuoteOptionsSchema, QuoteRecipientSchema, QuoteSchema, type QuoteStatus$2 as QuoteStatus, QuotientScoreMaxFilterSchema, QuotientScoreMinFilterSchema, RETRYABLE_ERROR_CODES, RETRY_CONFIG, type Receipt, ReceiptSchema, type ReceiptStatus, type ReceiptTransaction, ReceiptTransactionSchema, ReceiptTransferSchema, RecipientFilterDSLSchema, RecipientFilterSchema, type RecipientFilter as RecipientFilterSchemaType, ReputationFilterSchema, type ReputationFilter as ReputationFilterSchemaType, RequireLotteryOptInFilterSchema, RequireQuizOptInFilterSchema, type RetryOptions, RolesFilterSchema, SDK_VERSION, type PollOptions as SendPollOptions, type QuoteStatus$1 as SendQuoteStatus, type ReceiptTransaction$1 as SendReceiptTransaction, SignalTokenFilterSchema, type SimpleFilters, SocialFilterSchema, type SocialFilter as SocialFilterSchemaType, type SpamLabel, SpamLabelFilterSchema, type SpamLabelOption, SpecificUsersFilterSchema, TIMEOUTS, TimezoneFilterSchema, type TimezoneOptions, TokenHolderDiscoverySchema, type TokenHolderDiscovery as TokenHolderDiscoverySchemaType, TokenHolderFilterSchema, type TokenHolderOptions, TokenTypeSchema, TransferStatusSchema, type QuoteStatus as TypesQuoteStatus, VerifiedOnlyFilterSchema, type WalletChain, createHttpConfig, BeeperClient as default, describeFilters, generateDepositIdempotencyKey, generateExecuteIdempotencyKey, generateFilterDocumentation, generateIdempotencyKey, getAllFilterNames, getApiKeyEnvironment, getFilterSchema, isRetryableCode, isValidApiKeyFormat, maskApiKey, parseDraft, parseDraftInput, parseExecuteResult, parseFilter, parseQuote, parseQuoteOptions, parseReceipt, parseRecipientFilter, safeParseFilter, safeParseRecipientFilter, confirmDeposit as sendConfirmDeposit, createDraft as sendCreateDraft, createQuote as sendCreateQuote, executeSend as sendExecuteSend, getEstimatedTimeRemaining as sendGetEstimatedTimeRemaining, getFailedTransactions as sendGetFailedTransactions, getQuote as sendGetQuote, getReceipt as sendGetReceipt, getSuccessRate as sendGetSuccessRate, isComplete as sendIsComplete, isDepositSufficient as sendIsDepositSufficient, isExecuting as sendIsExecuting, isQuoteExpired as sendIsQuoteExpired, isReadyForDeposit as sendIsReadyForDeposit, isReadyForQuote as sendIsReadyForQuote, isSuccess as sendIsSuccess, pollUntilComplete as sendPollUntilComplete, updateDraft as sendUpdateDraft, validateDraftInput as sendValidateDraftInput, validateDraft, validateDraftInput$1 as validateDraftInput, validateExecuteResult, validateFilter, validateFilterHasTargeting, validateQuote, validateQuoteOptions, validateReceipt, validateRecipientFilter };
4495
+ export { API_BASE_URLS, API_KEY_PREFIXES, ActiveInLastDaysFilterSchema, AgentClient, type AgentClientConfig, type User as AgentUser, type ApiQuoteResponse, ApiQuoteResponseSchema, type ApiReceiptResponse, ApiReceiptResponseSchema, type AttentionPrice, type AttentionQuoteInput, BeeperClient, type BeeperClientConfig, type BeeperConfig, BeeperEconomicsFilterSchema, type BeeperEconomicsFilter as BeeperEconomicsFilterSchemaType, BeeperError, type BeeperErrorOptions, type BonusConfig, type BudgetSplit, type BulkIntentInput, type BulkIntentResult, type CTAType, CachedTokenHolderFilterSchema, CachedTokenHolderSchema, type CachedTokenHolder as CachedTokenHolderSchemaType, type CampaignInput, type ConfirmDeploymentInput, type ConfirmDeploymentResult, type ConfirmDepositParams, type ConfirmDepositResponse, ConfirmDepositResponseSchema, type ConfirmResult, ConfirmResultSchema, CountryFilterSchema, type CreateIntentInput, DistributionStrategySchema, type Draft, type DraftInput, DraftInputSchema, DraftSchema, DraftStatusSchema, DraftUpdateSchema, type Environment, type ErrorCode, ErrorCodes, type ErrorContext, type EstimateInput, type EstimateResult, ExcludePingedTodayFilterSchema, ExcludeUsersFilterSchema, type ExecuteResult, ExecuteResultSchema, type ExecuteSendParams, type ExecuteSendResponse, ExecuteSendResponseSchema, ExecuteStatusSchema, type ExternalVerifyCTA, type FCFSConfig, FILTER_SCHEMA, FieldComparisonSchema, FilterBuilder, type FilterCategory, FilterExpression$1 as FilterExpression, type FilterExpressionJSON, FilterExpressionSchema, type FilterExpression as FilterExpressionSchemaType, type FilterFieldSchema, FilterOperatorSchema, FilterValueSchema, type FollowProfileCTA, FollowersOfFilterSchema, FollowingOfFilterSchema, GasTierSchema, type GoalType, HEADERS, HTTP_STATUS_TO_ERROR_CODE, HasBaseWalletFilterSchema, HasRechargedInLastDaysFilterSchema, HasTierFilterSchema, HasVerifiedWalletFilterSchema, type Health, HttpClient, type HttpClientConfig, type HttpRequestOptions, type HttpResponse, IsWaitlistedFilterSchema, type LegacyFieldComparison, LegacyFieldComparisonSchema, type LegacyFilterOperator, LegacyFilterOperatorSchema, type LegacyFilterValue, LegacyFilterValueSchema, LegacyRecipientFilterDSLSchema, type LikeCastCTA, type LotteryConfig, MaxAttentionPriceFilterSchema, MaxFidFilterSchema, MaxFollowersFilterSchema, MaxFollowingFilterSchema, MinAttentionPriceFilterSchema, MinBatteryPercentageFilterSchema, MinCastCountFilterSchema, MinClickThroughRateFilterSchema, MinFidFilterSchema, MinFollowersFilterSchema, MinFollowingFilterSchema, MinProTenureDaysFilterSchema, MinTenureDaysFilterSchema, type MissionCTA, MutualsWithFilterSchema, NetworkSchema, NeynarScoreMaxFilterSchema, NeynarScoreMinFilterSchema, OnchainFilterSchema, type OnchainFilter as OnchainFilterSchemaType, type OrderByOption, OrderBySchema, type OrderBy as OrderBySchemaType, type PaginatedResponse, type PaginationOptions, type PaymentIntent, type Platform, PlatformFilterSchema, type PlatformFilter as PlatformFilterSchemaType, type PollOptions$1 as PollOptions, type PreviewInput, type PreviewResult, type PreviewUser, type PrizeTier, ProSubscriptionFilterSchema, QUOTE_EXPIRATION_SECONDS, type QuizCTA, type QuizQuestion, type Quote, type QuoteOptions, QuoteOptionsSchema, QuoteRecipientSchema, QuoteSchema, type QuoteStatus$2 as QuoteStatus, QuotientScoreMaxFilterSchema, QuotientScoreMinFilterSchema, RETRYABLE_ERROR_CODES, RETRY_CONFIG, type RecastCTA, type Receipt, ReceiptSchema, type ReceiptStatus, type ReceiptTransaction, ReceiptTransactionSchema, ReceiptTransferSchema, RecipientFilterDSLSchema, RecipientFilterSchema, type RecipientFilter as RecipientFilterSchemaType, ReputationFilterSchema, type ReputationFilter as ReputationFilterSchemaType, RequireLotteryOptInFilterSchema, RequireQuizOptInFilterSchema, type RetryOptions, RolesFilterSchema, SDK_VERSION, type PollOptions as SendPollOptions, type QuoteStatus$1 as SendQuoteStatus, type ReceiptTransaction$1 as SendReceiptTransaction, type ShareCastCTA, SignalTokenFilterSchema, type SimpleFilters, SocialFilterSchema, type SocialFilter as SocialFilterSchemaType, type SpamLabel, SpamLabelFilterSchema, type SpamLabelOption, SpecificUsersFilterSchema, type SplitPreset, TIMEOUTS, TimezoneFilterSchema, type TimezoneOptions, TokenHolderDiscoverySchema, type TokenHolderDiscovery as TokenHolderDiscoverySchemaType, TokenHolderFilterSchema, type TokenHolderOptions, TokenTypeSchema, TransferStatusSchema, type QuoteStatus as TypesQuoteStatus, VerifiedOnlyFilterSchema, type VisitLinkCTA, type WalletChain, type XFollowCTA, type XLikeCTA, type XRecastCTA, createHttpConfig, BeeperClient as default, describeFilters, generateDepositIdempotencyKey, generateExecuteIdempotencyKey, generateFilterDocumentation, generateIdempotencyKey, getAllFilterNames, getApiKeyEnvironment, getFilterSchema, isRetryableCode, isValidApiKeyFormat, maskApiKey, parseDraft, parseDraftInput, parseExecuteResult, parseFilter, parseQuote, parseQuoteOptions, parseReceipt, parseRecipientFilter, safeParseFilter, safeParseRecipientFilter, confirmDeposit as sendConfirmDeposit, createDraft as sendCreateDraft, createQuote as sendCreateQuote, executeSend as sendExecuteSend, getEstimatedTimeRemaining as sendGetEstimatedTimeRemaining, getFailedTransactions as sendGetFailedTransactions, getQuote as sendGetQuote, getReceipt as sendGetReceipt, getSuccessRate as sendGetSuccessRate, isComplete as sendIsComplete, isDepositSufficient as sendIsDepositSufficient, isExecuting as sendIsExecuting, isQuoteExpired as sendIsQuoteExpired, isReadyForDeposit as sendIsReadyForDeposit, isReadyForQuote as sendIsReadyForQuote, isSuccess as sendIsSuccess, pollUntilComplete as sendPollUntilComplete, updateDraft as sendUpdateDraft, validateDraftInput as sendValidateDraftInput, validateDraft, validateDraftInput$1 as validateDraftInput, validateExecuteResult, validateFilter, validateFilterHasTargeting, validateQuote, validateQuoteOptions, validateReceipt, validateRecipientFilter };
package/dist/index.d.ts CHANGED
@@ -1545,6 +1545,154 @@ declare function getApiKeyEnvironment(apiKey: string): 'production' | 'test' | n
1545
1545
  */
1546
1546
  declare function maskApiKey(apiKey: string): string;
1547
1547
 
1548
+ /**
1549
+ * Mission & Bonus Reward Types for beeper-sdk
1550
+ *
1551
+ * Types for configuring bonus missions (CTAs + reward distribution)
1552
+ * on beeps and campaigns.
1553
+ */
1554
+ /** Farcaster: Follow a profile */
1555
+ interface FollowProfileCTA {
1556
+ type: 'follow_profile';
1557
+ profileFid: number;
1558
+ profileUsername?: string;
1559
+ profileDisplayName?: string;
1560
+ }
1561
+ /** Farcaster: Like a specific cast */
1562
+ interface LikeCastCTA {
1563
+ type: 'like_cast';
1564
+ castHash: string;
1565
+ castUrl?: string;
1566
+ castAuthorFid?: number;
1567
+ castAuthorUsername?: string;
1568
+ }
1569
+ /** Farcaster: Recast a specific cast */
1570
+ interface RecastCTA {
1571
+ type: 'recast';
1572
+ castHash: string;
1573
+ castUrl?: string;
1574
+ castAuthorFid?: number;
1575
+ castAuthorUsername?: string;
1576
+ }
1577
+ /** Farcaster: Post a quote cast with requirements */
1578
+ interface ShareCastCTA {
1579
+ type: 'share_cast';
1580
+ requirements?: {
1581
+ textIncludes?: string[];
1582
+ mentions?: string[];
1583
+ embeds?: string[];
1584
+ };
1585
+ }
1586
+ /** Universal: Visit a link */
1587
+ interface VisitLinkCTA {
1588
+ type: 'visit_link';
1589
+ url: string;
1590
+ label?: string;
1591
+ }
1592
+ /** Universal: Answer quiz questions */
1593
+ interface QuizCTA {
1594
+ type: 'quiz';
1595
+ questions: QuizQuestion[];
1596
+ }
1597
+ interface QuizQuestion {
1598
+ question: string;
1599
+ answers: string[];
1600
+ correctAnswerIndex: number;
1601
+ }
1602
+ /** Universal: Custom verification via external endpoint */
1603
+ interface ExternalVerifyCTA {
1604
+ type: 'external_verify';
1605
+ endpointUrl: string;
1606
+ appUrl: string;
1607
+ appIsMiniApp?: boolean;
1608
+ guideUrl?: string;
1609
+ guideLabel?: string;
1610
+ description?: string;
1611
+ }
1612
+ /** X (Twitter): Follow a profile */
1613
+ interface XFollowCTA {
1614
+ type: 'x_follow';
1615
+ handle: string;
1616
+ profileUrl: string;
1617
+ displayName?: string;
1618
+ }
1619
+ /** X (Twitter): Like a tweet */
1620
+ interface XLikeCTA {
1621
+ type: 'x_like';
1622
+ tweetId: string;
1623
+ tweetUrl: string;
1624
+ authorHandle?: string;
1625
+ tweetText?: string;
1626
+ }
1627
+ /** X (Twitter): Repost a tweet */
1628
+ interface XRecastCTA {
1629
+ type: 'x_recast';
1630
+ tweetId: string;
1631
+ tweetUrl: string;
1632
+ authorHandle?: string;
1633
+ tweetText?: string;
1634
+ }
1635
+ /** All CTA types */
1636
+ type MissionCTA = FollowProfileCTA | LikeCastCTA | RecastCTA | ShareCastCTA | VisitLinkCTA | QuizCTA | ExternalVerifyCTA | XFollowCTA | XLikeCTA | XRecastCTA;
1637
+ /** CTA type strings */
1638
+ type CTAType = MissionCTA['type'];
1639
+ /** Lottery prize tier */
1640
+ interface PrizeTier {
1641
+ prizeAmount: number;
1642
+ winnerCount: number;
1643
+ }
1644
+ /** Lottery distribution config */
1645
+ interface LotteryConfig {
1646
+ prizeTiers: PrizeTier[];
1647
+ durationSeconds?: number;
1648
+ }
1649
+ /** FCFS distribution config */
1650
+ interface FCFSConfig {
1651
+ amountPerClaim: number;
1652
+ maxClaims: number;
1653
+ startDelaySeconds?: number;
1654
+ }
1655
+ /** Bonus reward configuration */
1656
+ interface BonusConfig {
1657
+ type: 'lottery' | 'fcfs';
1658
+ ctas?: MissionCTA[];
1659
+ lotteryConfig?: LotteryConfig;
1660
+ fcfsConfig?: FCFSConfig;
1661
+ }
1662
+ /** How budget is split between payout and bonus pool */
1663
+ type GoalType = 'max_reach' | 'lil_mission' | 'hard_mission';
1664
+ /** Fine-tune the budget split */
1665
+ type SplitPreset = 'balanced' | 'more_reach' | 'more_action';
1666
+ /** Computed budget split */
1667
+ interface BudgetSplit {
1668
+ totalUsd: number;
1669
+ payoutUsd: number;
1670
+ bonusUsd: number;
1671
+ platformFeeUsd: number;
1672
+ userPaysUsd: number;
1673
+ goalType: GoalType;
1674
+ splitPreset: SplitPreset;
1675
+ payoutPercent: number;
1676
+ bonusPercent: number;
1677
+ }
1678
+ /** Campaign input extending estimate with mission support */
1679
+ interface CampaignInput {
1680
+ filters: Record<string, unknown>;
1681
+ budget: string;
1682
+ message?: string;
1683
+ goalType?: GoalType;
1684
+ splitPreset?: SplitPreset;
1685
+ bonusConfig?: BonusConfig;
1686
+ }
1687
+
1688
+ /**
1689
+ * Core types for the Beeper SDK
1690
+ *
1691
+ * These types are the canonical API contract types matching the BeeperClient
1692
+ * and the backend HTTP contract. Legacy types from the old schema-based API
1693
+ * have been removed or replaced.
1694
+ */
1695
+
1548
1696
  /**
1549
1697
  * Draft input - what the user provides to create a draft
1550
1698
  */
@@ -4344,4 +4492,4 @@ declare function validateFilterHasTargeting(filter: RecipientFilter): boolean;
4344
4492
  */
4345
4493
  declare function describeFilters(filter: RecipientFilter): string[];
4346
4494
 
4347
- export { API_BASE_URLS, API_KEY_PREFIXES, ActiveInLastDaysFilterSchema, AgentClient, type AgentClientConfig, type User as AgentUser, type ApiQuoteResponse, ApiQuoteResponseSchema, type ApiReceiptResponse, ApiReceiptResponseSchema, type AttentionPrice, type AttentionQuoteInput, BeeperClient, type BeeperClientConfig, type BeeperConfig, BeeperEconomicsFilterSchema, type BeeperEconomicsFilter as BeeperEconomicsFilterSchemaType, BeeperError, type BeeperErrorOptions, type BulkIntentInput, type BulkIntentResult, CachedTokenHolderFilterSchema, CachedTokenHolderSchema, type CachedTokenHolder as CachedTokenHolderSchemaType, type ConfirmDeploymentInput, type ConfirmDeploymentResult, type ConfirmDepositParams, type ConfirmDepositResponse, ConfirmDepositResponseSchema, type ConfirmResult, ConfirmResultSchema, CountryFilterSchema, type CreateIntentInput, DistributionStrategySchema, type Draft, type DraftInput, DraftInputSchema, DraftSchema, DraftStatusSchema, DraftUpdateSchema, type Environment, type ErrorCode, ErrorCodes, type ErrorContext, type EstimateInput, type EstimateResult, ExcludePingedTodayFilterSchema, ExcludeUsersFilterSchema, type ExecuteResult, ExecuteResultSchema, type ExecuteSendParams, type ExecuteSendResponse, ExecuteSendResponseSchema, ExecuteStatusSchema, FILTER_SCHEMA, FieldComparisonSchema, FilterBuilder, type FilterCategory, FilterExpression$1 as FilterExpression, type FilterExpressionJSON, FilterExpressionSchema, type FilterExpression as FilterExpressionSchemaType, type FilterFieldSchema, FilterOperatorSchema, FilterValueSchema, FollowersOfFilterSchema, FollowingOfFilterSchema, GasTierSchema, HEADERS, HTTP_STATUS_TO_ERROR_CODE, HasBaseWalletFilterSchema, HasRechargedInLastDaysFilterSchema, HasTierFilterSchema, HasVerifiedWalletFilterSchema, type Health, HttpClient, type HttpClientConfig, type HttpRequestOptions, type HttpResponse, IsWaitlistedFilterSchema, type LegacyFieldComparison, LegacyFieldComparisonSchema, type LegacyFilterOperator, LegacyFilterOperatorSchema, type LegacyFilterValue, LegacyFilterValueSchema, LegacyRecipientFilterDSLSchema, MaxAttentionPriceFilterSchema, MaxFidFilterSchema, MaxFollowersFilterSchema, MaxFollowingFilterSchema, MinAttentionPriceFilterSchema, MinBatteryPercentageFilterSchema, MinCastCountFilterSchema, MinClickThroughRateFilterSchema, MinFidFilterSchema, MinFollowersFilterSchema, MinFollowingFilterSchema, MinProTenureDaysFilterSchema, MinTenureDaysFilterSchema, MutualsWithFilterSchema, NetworkSchema, NeynarScoreMaxFilterSchema, NeynarScoreMinFilterSchema, OnchainFilterSchema, type OnchainFilter as OnchainFilterSchemaType, type OrderByOption, OrderBySchema, type OrderBy as OrderBySchemaType, type PaginatedResponse, type PaginationOptions, type PaymentIntent, type Platform, PlatformFilterSchema, type PlatformFilter as PlatformFilterSchemaType, type PollOptions$1 as PollOptions, type PreviewInput, type PreviewResult, type PreviewUser, ProSubscriptionFilterSchema, QUOTE_EXPIRATION_SECONDS, type Quote, type QuoteOptions, QuoteOptionsSchema, QuoteRecipientSchema, QuoteSchema, type QuoteStatus$2 as QuoteStatus, QuotientScoreMaxFilterSchema, QuotientScoreMinFilterSchema, RETRYABLE_ERROR_CODES, RETRY_CONFIG, type Receipt, ReceiptSchema, type ReceiptStatus, type ReceiptTransaction, ReceiptTransactionSchema, ReceiptTransferSchema, RecipientFilterDSLSchema, RecipientFilterSchema, type RecipientFilter as RecipientFilterSchemaType, ReputationFilterSchema, type ReputationFilter as ReputationFilterSchemaType, RequireLotteryOptInFilterSchema, RequireQuizOptInFilterSchema, type RetryOptions, RolesFilterSchema, SDK_VERSION, type PollOptions as SendPollOptions, type QuoteStatus$1 as SendQuoteStatus, type ReceiptTransaction$1 as SendReceiptTransaction, SignalTokenFilterSchema, type SimpleFilters, SocialFilterSchema, type SocialFilter as SocialFilterSchemaType, type SpamLabel, SpamLabelFilterSchema, type SpamLabelOption, SpecificUsersFilterSchema, TIMEOUTS, TimezoneFilterSchema, type TimezoneOptions, TokenHolderDiscoverySchema, type TokenHolderDiscovery as TokenHolderDiscoverySchemaType, TokenHolderFilterSchema, type TokenHolderOptions, TokenTypeSchema, TransferStatusSchema, type QuoteStatus as TypesQuoteStatus, VerifiedOnlyFilterSchema, type WalletChain, createHttpConfig, BeeperClient as default, describeFilters, generateDepositIdempotencyKey, generateExecuteIdempotencyKey, generateFilterDocumentation, generateIdempotencyKey, getAllFilterNames, getApiKeyEnvironment, getFilterSchema, isRetryableCode, isValidApiKeyFormat, maskApiKey, parseDraft, parseDraftInput, parseExecuteResult, parseFilter, parseQuote, parseQuoteOptions, parseReceipt, parseRecipientFilter, safeParseFilter, safeParseRecipientFilter, confirmDeposit as sendConfirmDeposit, createDraft as sendCreateDraft, createQuote as sendCreateQuote, executeSend as sendExecuteSend, getEstimatedTimeRemaining as sendGetEstimatedTimeRemaining, getFailedTransactions as sendGetFailedTransactions, getQuote as sendGetQuote, getReceipt as sendGetReceipt, getSuccessRate as sendGetSuccessRate, isComplete as sendIsComplete, isDepositSufficient as sendIsDepositSufficient, isExecuting as sendIsExecuting, isQuoteExpired as sendIsQuoteExpired, isReadyForDeposit as sendIsReadyForDeposit, isReadyForQuote as sendIsReadyForQuote, isSuccess as sendIsSuccess, pollUntilComplete as sendPollUntilComplete, updateDraft as sendUpdateDraft, validateDraftInput as sendValidateDraftInput, validateDraft, validateDraftInput$1 as validateDraftInput, validateExecuteResult, validateFilter, validateFilterHasTargeting, validateQuote, validateQuoteOptions, validateReceipt, validateRecipientFilter };
4495
+ export { API_BASE_URLS, API_KEY_PREFIXES, ActiveInLastDaysFilterSchema, AgentClient, type AgentClientConfig, type User as AgentUser, type ApiQuoteResponse, ApiQuoteResponseSchema, type ApiReceiptResponse, ApiReceiptResponseSchema, type AttentionPrice, type AttentionQuoteInput, BeeperClient, type BeeperClientConfig, type BeeperConfig, BeeperEconomicsFilterSchema, type BeeperEconomicsFilter as BeeperEconomicsFilterSchemaType, BeeperError, type BeeperErrorOptions, type BonusConfig, type BudgetSplit, type BulkIntentInput, type BulkIntentResult, type CTAType, CachedTokenHolderFilterSchema, CachedTokenHolderSchema, type CachedTokenHolder as CachedTokenHolderSchemaType, type CampaignInput, type ConfirmDeploymentInput, type ConfirmDeploymentResult, type ConfirmDepositParams, type ConfirmDepositResponse, ConfirmDepositResponseSchema, type ConfirmResult, ConfirmResultSchema, CountryFilterSchema, type CreateIntentInput, DistributionStrategySchema, type Draft, type DraftInput, DraftInputSchema, DraftSchema, DraftStatusSchema, DraftUpdateSchema, type Environment, type ErrorCode, ErrorCodes, type ErrorContext, type EstimateInput, type EstimateResult, ExcludePingedTodayFilterSchema, ExcludeUsersFilterSchema, type ExecuteResult, ExecuteResultSchema, type ExecuteSendParams, type ExecuteSendResponse, ExecuteSendResponseSchema, ExecuteStatusSchema, type ExternalVerifyCTA, type FCFSConfig, FILTER_SCHEMA, FieldComparisonSchema, FilterBuilder, type FilterCategory, FilterExpression$1 as FilterExpression, type FilterExpressionJSON, FilterExpressionSchema, type FilterExpression as FilterExpressionSchemaType, type FilterFieldSchema, FilterOperatorSchema, FilterValueSchema, type FollowProfileCTA, FollowersOfFilterSchema, FollowingOfFilterSchema, GasTierSchema, type GoalType, HEADERS, HTTP_STATUS_TO_ERROR_CODE, HasBaseWalletFilterSchema, HasRechargedInLastDaysFilterSchema, HasTierFilterSchema, HasVerifiedWalletFilterSchema, type Health, HttpClient, type HttpClientConfig, type HttpRequestOptions, type HttpResponse, IsWaitlistedFilterSchema, type LegacyFieldComparison, LegacyFieldComparisonSchema, type LegacyFilterOperator, LegacyFilterOperatorSchema, type LegacyFilterValue, LegacyFilterValueSchema, LegacyRecipientFilterDSLSchema, type LikeCastCTA, type LotteryConfig, MaxAttentionPriceFilterSchema, MaxFidFilterSchema, MaxFollowersFilterSchema, MaxFollowingFilterSchema, MinAttentionPriceFilterSchema, MinBatteryPercentageFilterSchema, MinCastCountFilterSchema, MinClickThroughRateFilterSchema, MinFidFilterSchema, MinFollowersFilterSchema, MinFollowingFilterSchema, MinProTenureDaysFilterSchema, MinTenureDaysFilterSchema, type MissionCTA, MutualsWithFilterSchema, NetworkSchema, NeynarScoreMaxFilterSchema, NeynarScoreMinFilterSchema, OnchainFilterSchema, type OnchainFilter as OnchainFilterSchemaType, type OrderByOption, OrderBySchema, type OrderBy as OrderBySchemaType, type PaginatedResponse, type PaginationOptions, type PaymentIntent, type Platform, PlatformFilterSchema, type PlatformFilter as PlatformFilterSchemaType, type PollOptions$1 as PollOptions, type PreviewInput, type PreviewResult, type PreviewUser, type PrizeTier, ProSubscriptionFilterSchema, QUOTE_EXPIRATION_SECONDS, type QuizCTA, type QuizQuestion, type Quote, type QuoteOptions, QuoteOptionsSchema, QuoteRecipientSchema, QuoteSchema, type QuoteStatus$2 as QuoteStatus, QuotientScoreMaxFilterSchema, QuotientScoreMinFilterSchema, RETRYABLE_ERROR_CODES, RETRY_CONFIG, type RecastCTA, type Receipt, ReceiptSchema, type ReceiptStatus, type ReceiptTransaction, ReceiptTransactionSchema, ReceiptTransferSchema, RecipientFilterDSLSchema, RecipientFilterSchema, type RecipientFilter as RecipientFilterSchemaType, ReputationFilterSchema, type ReputationFilter as ReputationFilterSchemaType, RequireLotteryOptInFilterSchema, RequireQuizOptInFilterSchema, type RetryOptions, RolesFilterSchema, SDK_VERSION, type PollOptions as SendPollOptions, type QuoteStatus$1 as SendQuoteStatus, type ReceiptTransaction$1 as SendReceiptTransaction, type ShareCastCTA, SignalTokenFilterSchema, type SimpleFilters, SocialFilterSchema, type SocialFilter as SocialFilterSchemaType, type SpamLabel, SpamLabelFilterSchema, type SpamLabelOption, SpecificUsersFilterSchema, type SplitPreset, TIMEOUTS, TimezoneFilterSchema, type TimezoneOptions, TokenHolderDiscoverySchema, type TokenHolderDiscovery as TokenHolderDiscoverySchemaType, TokenHolderFilterSchema, type TokenHolderOptions, TokenTypeSchema, TransferStatusSchema, type QuoteStatus as TypesQuoteStatus, VerifiedOnlyFilterSchema, type VisitLinkCTA, type WalletChain, type XFollowCTA, type XLikeCTA, type XRecastCTA, createHttpConfig, BeeperClient as default, describeFilters, generateDepositIdempotencyKey, generateExecuteIdempotencyKey, generateFilterDocumentation, generateIdempotencyKey, getAllFilterNames, getApiKeyEnvironment, getFilterSchema, isRetryableCode, isValidApiKeyFormat, maskApiKey, parseDraft, parseDraftInput, parseExecuteResult, parseFilter, parseQuote, parseQuoteOptions, parseReceipt, parseRecipientFilter, safeParseFilter, safeParseRecipientFilter, confirmDeposit as sendConfirmDeposit, createDraft as sendCreateDraft, createQuote as sendCreateQuote, executeSend as sendExecuteSend, getEstimatedTimeRemaining as sendGetEstimatedTimeRemaining, getFailedTransactions as sendGetFailedTransactions, getQuote as sendGetQuote, getReceipt as sendGetReceipt, getSuccessRate as sendGetSuccessRate, isComplete as sendIsComplete, isDepositSufficient as sendIsDepositSufficient, isExecuting as sendIsExecuting, isQuoteExpired as sendIsQuoteExpired, isReadyForDeposit as sendIsReadyForDeposit, isReadyForQuote as sendIsReadyForQuote, isSuccess as sendIsSuccess, pollUntilComplete as sendPollUntilComplete, updateDraft as sendUpdateDraft, validateDraftInput as sendValidateDraftInput, validateDraft, validateDraftInput$1 as validateDraftInput, validateExecuteResult, validateFilter, validateFilterHasTargeting, validateQuote, validateQuoteOptions, validateReceipt, validateRecipientFilter };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@beeperbot/sdk",
3
- "version": "0.2.0",
3
+ "version": "0.2.1",
4
4
  "description": "TypeScript SDK for Beeper payment distribution",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",