@invonetwork/web-sdk 3.24.0 → 3.25.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/server.d.cts CHANGED
@@ -1,12 +1,5 @@
1
- import { I as InvoError, H as Http, $ as AuthHeader, a0 as CardSetupSessionInput, g as CallOptions, a1 as CardSetupSessionResult, a2 as CardSetupInput, a3 as CardSetupResult, a4 as CardSetupConfirmInput, a5 as CardSetupConfirmResult, a6 as PlayerCardsResult, a7 as PlatformPurchaseInput, a8 as PlatformPurchaseResult, a9 as PlatformOrderStatusResult, aa as PlatformPurchaseHistoryQuery, ab as PlatformPurchaseHistoryResult, ac as PlatformRefundInput, ad as PlatformRefundResult, ae as CreateSubscriptionInput, af as SubscriptionResult, ag as GetSubscriptionOptions, ah as GetSubscriptionResult, ai as ListSubscriptionsOptions, aj as SubscriptionListResult, ak as CancelSubscriptionOptions, al as CancelResult, am as ChangeAmountResult, an as SetPaymentMethodInput, ao as SetPaymentMethodResult, ap as RefundSubscriptionInput, aq as RefundResult, ar as SteamSubscriptionInitInput, as as SteamInitResult, at as SteamFinalizeSubscriptionResult, au as SandboxClockResult, av as SandboxFailureOutcome, aw as SandboxForceFailureOptions, ax as SandboxForceAuthChallengeOptions, ay as ServerConfig, az as MintPlayerTokenInput, aA as PlayerToken, aB as RegisterPlayerInput, aC as RegisterPlayerResult, aD as UpdatePlayerPhoneInput, aE as UpdatePlayerPhoneResult, aF as RequestPhoneChangeInput, aG as RequestPhoneChangeResult, aH as PhoneChangeRequest, aI as InitiateSendInput, aJ as InitiateResult, aK as InitiateTransferInput, aL as CreateCheckoutInput, aM as CreateCheckoutResult, aN as PurchaseInput, aO as PurchaseResult, aP as CurrencyPurchaseQuoteInput, aQ as CurrencyPurchaseQuote, aR as ConfirmPaymentResult, aS as OrderDetailsResult, aT as SteamPacksQuery, aU as SteamPacksResult, aV as SteamInitPurchaseInput, aW as SteamInitPurchaseResult, aX as SteamFinalizeInput, aY as SteamFinalizeResult, aZ as PurchaseItemInput, a_ as PurchaseItemResult, a$ as ItemHistoryQuery, b0 as ItemHistoryResult, b1 as ItemOrderQuery, b2 as PlayerActivityQuery, b3 as PlayerActivityResult, b4 as PlayerActivityEntry, b5 as PlayerBalanceQuery, b6 as PlayerBalanceResult, o as LoyaltyCardsResult, b7 as InboundPendingQuery, b8 as InboundPendingResult, b9 as LinkedIdentitiesQuery, ba as LinkedIdentitiesResult, bb as SmsVerifyResult, bc as ClaimTransferInput, bd as ClaimResult, be as ClaimCurrencyInput, bf as TransactionStatusResult, bg as GuardianApprovalStatusResult, bh as ServerDestinationsQuery, n as DestinationsResult, bi as PhoneShareContact, bj as PhoneShareInitiateResult, bk as PhoneShareApproveInput, bl as PhoneShareApproveResult, bm as PhoneShareStatusResult, bn as BeginDeviceApprovalInput, bo as DeviceApprovalGrant, bp as PollDeviceApprovalInput, bq as DeviceApprovalPollResult, br as ConfirmDeviceEnrollmentInput, bs as ConfirmDeviceEnrollmentResult, bt as ApproveWithDeviceCodeInput, bu as DeviceApprovalSettleResult, bv as CompleteDeviceApprovalInput, bw as CompleteDeviceApprovalResult } from './types-DKiV5V0B.cjs';
2
- export { bx as CardSetupStatus, by as CheckoutWarning, w as ClaimDelivery, bz as CurrencyBalance, bA as CurrencyPurchaseQuoteBreakdown, x as DestinationGame, bB as DeviceApprovalChannel, bC as DeviceApprovalEnrollment, bD as DeviceApprovalFlow, bE as DeviceApprovalPollStatus, bF as DeviceEnrollmentDecision, bG as DeviceEnrollmentRespond, bH as ExpiryReason, bI as FeeTakenFrom, bJ as FirstCharge, bK as FirstChargeStatus, bL as FundingSource, bM as InboundPendingItem, y as InvoErrorInfo, z as InvoHooks, F as InvoRequestInfo, G as InvoResponseInfo, bN as LinkedIdentityEmail, J as LoyaltyCard, K as LoyaltyCardReward, N as LoyaltyCardStep, O as LoyaltyRewardState, Q as LoyaltyStepProgress, S as LoyaltyStepState, bO as MinPurchaseWarning, bP as PhoneChangeConfirmation, bQ as PhoneChangeRequestStatus, bR as PlatformPurchaseStatus, bS as PlayerActivityType, Z as Rail, bT as RefundInitiation, bU as RefundPendingApproval, bV as RefundProcessingFeeBasis, bW as RefundReceipt, bX as RefundRevenueShareAttribution, bY as RefundWarning, bZ as SandboxClockState, b_ as SavedCard, b$ as SteamPack, c0 as SteamUserSession, c1 as Subscription, c2 as SubscriptionBaseInput, c3 as SubscriptionConsent, c4 as SubscriptionConsentInput, c5 as SubscriptionFundingRail, c6 as SubscriptionInterval, c7 as SubscriptionRevenueShare, c8 as SubscriptionRevenueShareInput, c9 as SubscriptionStatus, ca as UnacknowledgedPurchaseOutcome, _ as VerificationMethod, cb as isRefundPendingApproval } from './types-DKiV5V0B.cjs';
3
-
4
- /**
5
- * The package version, as sent in the server User-Agent. A test pins this to
6
- * `package.json` so it cannot drift silently (it did: the UA read 3.0.0 through 3.7.0).
7
- * Bump it with the changeset flow.
8
- */
9
- declare const SDK_VERSION = "3.24.0";
1
+ import { I as InvoError, H as Http, $ as AuthHeader, g as CallOptions, a0 as CardSetupSessionInput, a1 as CardSetupSessionResult, a2 as CardSetupInput, a3 as CardSetupResult, a4 as CardSetupConfirmInput, a5 as CardSetupConfirmResult, a6 as PlayerCardsResult, a7 as PlatformPurchaseInput, a8 as PlatformPurchaseResult, a9 as PlatformOrderStatusResult, aa as PlatformPurchaseHistoryQuery, ab as PlatformPurchaseHistoryResult, ac as PlatformRefundInput, ad as PlatformRefundResult, ae as CreateSubscriptionInput, af as SubscriptionResult, ag as GetSubscriptionOptions, ah as GetSubscriptionResult, ai as ListSubscriptionsOptions, aj as SubscriptionListResult, ak as CancelSubscriptionOptions, al as CancelResult, am as ChangeAmountResult, an as SetPaymentMethodInput, ao as SetPaymentMethodResult, ap as RefundSubscriptionInput, aq as RefundResult, ar as SteamSubscriptionInitInput, as as SteamInitResult, at as SteamFinalizeSubscriptionResult, au as SandboxClockResult, av as SandboxFailureOutcome, aw as SandboxForceFailureOptions, ax as SandboxForceAuthChallengeOptions, ay as ServerConfig, az as MintPlayerTokenInput, aA as PlayerToken, aB as RegisterPlayerInput, aC as RegisterPlayerResult, aD as UpdatePlayerPhoneInput, aE as UpdatePlayerPhoneResult, aF as RequestPhoneChangeInput, aG as RequestPhoneChangeResult, aH as PhoneChangeRequest, aI as InitiateSendInput, aJ as InitiateResult, aK as InitiateTransferInput, aL as CreateCheckoutInput, aM as CreateCheckoutResult, aN as PurchaseInput, aO as PurchaseResult, aP as CurrencyPurchaseQuoteInput, aQ as CurrencyPurchaseQuote, aR as ConfirmPaymentResult, aS as OrderDetailsResult, aT as SteamPacksQuery, aU as SteamPacksResult, aV as SteamInitPurchaseInput, aW as SteamInitPurchaseResult, aX as SteamFinalizeInput, aY as SteamFinalizeResult, aZ as PurchaseItemInput, a_ as PurchaseItemResult, a$ as ItemHistoryQuery, b0 as ItemHistoryResult, b1 as ItemOrderQuery, b2 as PlayerActivityQuery, b3 as PlayerActivityResult, b4 as PlayerActivityEntry, b5 as PlayerBalanceQuery, b6 as PlayerBalanceResult, o as LoyaltyCardsResult, b7 as InboundPendingQuery, b8 as InboundPendingResult, b9 as LinkedIdentitiesQuery, ba as LinkedIdentitiesResult, bb as SmsVerifyResult, bc as ClaimTransferInput, bd as ClaimResult, be as ClaimCurrencyInput, bf as TransactionStatusResult, bg as GuardianApprovalStatusResult, bh as ServerDestinationsQuery, n as DestinationsResult, bi as PhoneShareContact, bj as PhoneShareInitiateResult, bk as PhoneShareApproveInput, bl as PhoneShareApproveResult, bm as PhoneShareStatusResult, bn as BeginDeviceApprovalInput, bo as DeviceApprovalGrant, bp as PollDeviceApprovalInput, bq as DeviceApprovalPollResult, br as ConfirmDeviceEnrollmentInput, bs as ConfirmDeviceEnrollmentResult, bt as ApproveWithDeviceCodeInput, bu as DeviceApprovalSettleResult, bv as CompleteDeviceApprovalInput, bw as CompleteDeviceApprovalResult } from './types-Cjd4SAR8.cjs';
2
+ export { bx as CardSetupStatus, by as CheckoutWarning, w as ClaimDelivery, bz as CurrencyBalance, bA as CurrencyPurchaseQuoteBreakdown, x as DestinationGame, bB as DeviceApprovalChannel, bC as DeviceApprovalEnrollment, bD as DeviceApprovalFlow, bE as DeviceApprovalPollStatus, bF as DeviceEnrollmentDecision, bG as DeviceEnrollmentRespond, bH as ExpiryReason, bI as FeeTakenFrom, bJ as FirstCharge, bK as FirstChargeStatus, bL as FundingSource, bM as InboundPendingItem, y as InvoErrorInfo, z as InvoHooks, F as InvoRequestInfo, G as InvoResponseInfo, bN as LinkedIdentityEmail, J as LoyaltyCard, K as LoyaltyCardReward, N as LoyaltyCardStep, O as LoyaltyRewardState, Q as LoyaltyStepProgress, S as LoyaltyStepState, bO as MinPurchaseWarning, bP as PhoneChangeConfirmation, bQ as PhoneChangeRequestStatus, bR as PlatformPurchaseStatus, bS as PlayerActivityType, Z as Rail, bT as RefundInitiation, bU as RefundPendingApproval, bV as RefundProcessingFeeBasis, bW as RefundReceipt, bX as RefundRevenueShareAttribution, bY as RefundWarning, bZ as SandboxClockState, b_ as SavedCard, b$ as SteamPack, c0 as SteamUserSession, c1 as Subscription, c2 as SubscriptionBaseInput, c3 as SubscriptionConsent, c4 as SubscriptionConsentInput, c5 as SubscriptionFundingRail, c6 as SubscriptionInterval, c7 as SubscriptionRevenueShare, c8 as SubscriptionRevenueShareInput, c9 as SubscriptionStatus, ca as UnacknowledgedPurchaseOutcome, _ as VerificationMethod, cb as isRefundPendingApproval } from './types-Cjd4SAR8.cjs';
10
3
 
11
4
  interface VerifyWebhookOptions {
12
5
  /** Max age of the signed timestamp, in seconds. Default 300 (5 min). */
@@ -340,6 +333,33 @@ interface PayoutStatusChangedData {
340
333
  net_payout_usd?: string | null;
341
334
  /** The cap on the payout fee per payout (for example `"500.00"`); `null` means no cap. */
342
335
  offboarding_fee_cap_usd?: string | null;
336
+ /**
337
+ * Additive (3.25.0). On a creator payout, the creator INVO paid (`cp_...`); `null` on a
338
+ * payout to your own bank. Never carries the creator's bank or personal details.
339
+ */
340
+ payee_id?: string | null;
341
+ /** Additive (3.25.0). `"standard"` or `"manual"`; `null` before approval. */
342
+ payout_method?: "standard" | "manual" | (string & {}) | null;
343
+ /** Additive (3.25.0). On `status: "returned"`: when the receiving bank sent it back. */
344
+ returned_at?: string | null;
345
+ [key: string]: unknown;
346
+ }
347
+ /** Creator statuses (3.25.0). */
348
+ type PayeeStatus = "invited" | "details_submitted" | "verified" | "rejected" | "suspended" | "expired" | (string & {});
349
+ /**
350
+ * `payee.status_changed` (3.25.0): a creator you registered for creator payouts was
351
+ * registered or changed status. Never carries the creator's name or email. Subscribe to it
352
+ * by name.
353
+ */
354
+ interface PayeeStatusChangedData {
355
+ payee_id: string;
356
+ partner_reference: string;
357
+ status: PayeeStatus;
358
+ previous_status: PayeeStatus | null;
359
+ payee_type: "individual" | "business" | (string & {});
360
+ country: string;
361
+ created_via: "api" | "console" | (string & {});
362
+ status_changed_at: string;
343
363
  [key: string]: unknown;
344
364
  }
345
365
  /**
@@ -824,6 +844,9 @@ type InvoWebhookEvent = (WebhookBase & {
824
844
  }) | (WebhookBase & {
825
845
  event_type: "payout.status_changed";
826
846
  data: PayoutStatusChangedData;
847
+ }) | (WebhookBase & {
848
+ event_type: "payee.status_changed";
849
+ data: PayeeStatusChangedData;
827
850
  }) | (WebhookBase & {
828
851
  event_type: "player.phone_changed";
829
852
  data: PlayerPhoneChangedData;
@@ -887,6 +910,171 @@ interface WebhookHandlerOptions {
887
910
  */
888
911
  declare function createWebhookHandler(opts: WebhookHandlerOptions): (request: Request) => Promise<Response>;
889
912
 
913
+ /**
914
+ * Partner payouts and creator payouts (3.25.0).
915
+ *
916
+ * A platform partner can ask INVO to pay out the earnings INVO owes it, and can register
917
+ * creators that INVO verifies and pays on its behalf. Creators are INVO's customers: you
918
+ * never see their documents, tax id or bank details, only their status.
919
+ *
920
+ * Fields keep the server's snake_case names, exactly as the API returns them.
921
+ */
922
+
923
+ /** Payout statuses. `cancelled` and `returned` are 3.25.0. */
924
+ type PayoutStatus = "requested" | "approved" | "processing" | "completed" | "rejected" | "failed" | "cancelled" | "returned" | (string & {});
925
+ interface Payee {
926
+ /** Opaque id, `cp_` followed by 24 hex characters. Store it as a string. */
927
+ payee_id: string;
928
+ game_id: number | string;
929
+ partner_reference: string;
930
+ legal_name: string;
931
+ email: string;
932
+ country: string;
933
+ payee_type: "individual" | "business" | (string & {});
934
+ status: PayeeStatus;
935
+ created_via: "api" | "console" | (string & {});
936
+ status_changed_at: string | null;
937
+ created_at: string | null;
938
+ updated_at: string | null;
939
+ [key: string]: unknown;
940
+ }
941
+ interface PayeeInvite {
942
+ sent: boolean;
943
+ expires_at?: string | null;
944
+ error_code?: string;
945
+ error?: string;
946
+ }
947
+ interface RegisterPayeeInput {
948
+ /** Your own id for the creator: 1 to 128 of `A-Z a-z 0-9 . _ : @ -`, unique in your account. No personal data. */
949
+ partnerReference: string;
950
+ /** The creator's legal name, or the registered business name. */
951
+ legalName: string;
952
+ email: string;
953
+ /** ISO 3166-1 alpha-2, for example `"GB"`. */
954
+ country: string;
955
+ payeeType: "individual" | "business";
956
+ }
957
+ interface RegisterPayeeResult {
958
+ payee: Payee;
959
+ /** Present on a new registration. */
960
+ invite?: PayeeInvite;
961
+ /** `true` when this `partnerReference` was already registered with the same details. */
962
+ duplicate: boolean;
963
+ raw: Record<string, unknown>;
964
+ }
965
+ interface ListPayeesQuery {
966
+ limit?: number;
967
+ offset?: number;
968
+ status?: PayeeStatus;
969
+ }
970
+ interface ListPayeesResult {
971
+ total: number;
972
+ limit: number;
973
+ offset: number;
974
+ items: Payee[];
975
+ raw: Record<string, unknown>;
976
+ }
977
+ interface Payout {
978
+ id: number;
979
+ game_id: number | string;
980
+ status: PayoutStatus;
981
+ requested_amount_usd: string | null;
982
+ offboarding_fee_pct?: string | null;
983
+ offboarding_fee_usd?: string | null;
984
+ offboarding_fee_cap_usd?: string | null;
985
+ net_payout_usd?: string | null;
986
+ /** On a creator payout, the creator INVO pays; `null` on a payout to your own bank. */
987
+ payee_id?: string | null;
988
+ /** `null` on a creator payout: INVO pays the creator's verified account. */
989
+ bank_account?: Record<string, unknown> | null;
990
+ client_request_id?: string | null;
991
+ paid_at?: string | null;
992
+ returned_at?: string | null;
993
+ created_at?: string | null;
994
+ [key: string]: unknown;
995
+ }
996
+ interface RequestPayoutInput {
997
+ /** USD, positive, at most two decimal places. */
998
+ amountUsd: string | number;
999
+ contactEmail: string;
1000
+ /** Pay a verified creator. Don't combine with `bankAccountId`. */
1001
+ payeeId?: string;
1002
+ /** Pay your own verified bank account (id from the INVO console). */
1003
+ bankAccountId?: number;
1004
+ /** Idempotency key. Reuse it to retry the same request safely. */
1005
+ clientRequestId?: string;
1006
+ partnerNote?: string;
1007
+ additionalEmails?: string[];
1008
+ }
1009
+ interface RequestPayoutResult {
1010
+ payout: Payout;
1011
+ /** `true` when `clientRequestId` matched an earlier request with the same amount and creator. */
1012
+ duplicate: boolean;
1013
+ raw: Record<string, unknown>;
1014
+ }
1015
+ interface ListPayoutsQuery {
1016
+ limit?: number;
1017
+ offset?: number;
1018
+ status?: PayoutStatus;
1019
+ /** Only this creator's payouts. */
1020
+ payeeId?: string;
1021
+ }
1022
+ interface ListPayoutsResult {
1023
+ total: number;
1024
+ items: Payout[];
1025
+ raw: Record<string, unknown>;
1026
+ }
1027
+ /** `InvoServer.payouts`: partner payouts and creator payouts. */
1028
+ declare class PayoutsServer {
1029
+ private readonly http;
1030
+ private readonly auth;
1031
+ constructor(http: Http, auth: AuthHeader);
1032
+ /**
1033
+ * Register a creator (`POST /api/partner-payees`). INVO emails the creator a link to INVO's
1034
+ * own page to give INVO their identity, tax and bank details. `invite.sent` is `false` when
1035
+ * INVO did not email the link (`invite.error_code` says why); the creator is registered
1036
+ * either way. Refusals: `409 PARTNER_REFERENCE_CONFLICT`, `400 INVALID_INPUT`,
1037
+ * `400 COUNTRY_NOT_SUPPORTED`.
1038
+ */
1039
+ registerPayee(input: RegisterPayeeInput, opts?: CallOptions): Promise<RegisterPayeeResult>;
1040
+ /** This game's creators, newest first (`GET /api/partner-payees`). */
1041
+ listPayees(q?: ListPayeesQuery, opts?: CallOptions): Promise<ListPayeesResult>;
1042
+ /** One creator (`GET /api/partner-payees/{payeeId}`); `404 NOT_FOUND` if not this game's. */
1043
+ getPayee(payeeId: string, opts?: CallOptions): Promise<Payee>;
1044
+ /**
1045
+ * Email the creator a new link (`POST /api/partner-payees/{payeeId}/resend-invite`); the old
1046
+ * link stops working. Allowed while the creator is `invited`, `rejected` or `expired`
1047
+ * (`409 INVITE_NOT_NEEDED` otherwise). Never auto-retried.
1048
+ */
1049
+ resendPayeeInvite(payeeId: string, opts?: CallOptions): Promise<PayeeInvite>;
1050
+ /**
1051
+ * Ask INVO to pay out (`POST /api/partner-payouts/request`). With `payeeId`, INVO pays that
1052
+ * verified creator's bank account; otherwise your own verified bank account. The money comes
1053
+ * from the earnings INVO owes your game, and the payout fee is taken from the payout.
1054
+ * Creator refusals: `404 PAYEE_NOT_FOUND`, `409 PAYEE_NOT_VERIFIED`,
1055
+ * `409 PAYEE_VERIFICATION_EXPIRED`, `409 PAYEE_BANK_NOT_VERIFIED`, `409 PAYEE_NOT_PAYABLE`.
1056
+ * Retried safely only when `clientRequestId` is set.
1057
+ */
1058
+ requestPayout(input: RequestPayoutInput, opts?: CallOptions): Promise<RequestPayoutResult>;
1059
+ /** One payout (`GET /api/partner-payouts/{payoutId}`). */
1060
+ getPayout(payoutIdValue: number, opts?: CallOptions): Promise<Payout>;
1061
+ /** Your payouts (`GET /api/partner-payouts`), optionally one creator's (`payeeId`). */
1062
+ listPayouts(q?: ListPayoutsQuery, opts?: CallOptions): Promise<ListPayoutsResult>;
1063
+ /**
1064
+ * Cancel a creator payout that is still `requested`
1065
+ * (`POST /api/partner-payouts/{payoutId}/cancel`). Anything past `requested` is
1066
+ * `409 PAYOUT_NOT_CANCELLABLE`.
1067
+ */
1068
+ cancelPayout(payoutIdValue: number, opts?: CallOptions): Promise<Payout>;
1069
+ }
1070
+
1071
+ /**
1072
+ * The package version, as sent in the server User-Agent. A test pins this to
1073
+ * `package.json` so it cannot drift silently (it did: the UA read 3.0.0 through 3.7.0).
1074
+ * Bump it with the changeset flow.
1075
+ */
1076
+ declare const SDK_VERSION = "3.25.0";
1077
+
890
1078
  /**
891
1079
  * @invonetwork/web-sdk/server — NODE entry.
892
1080
  *
@@ -1356,6 +1544,12 @@ declare class InvoServer {
1356
1544
  * `forceFailure` / `forceAuthChallenge`. Needs `sandboxClockKey`. See {@link SandboxSubscriptionsServer}.
1357
1545
  */
1358
1546
  readonly sandbox: SandboxServer;
1547
+ /**
1548
+ * Partner payouts and creator payouts (3.25.0): `registerPayee` / `listPayees` /
1549
+ * `getPayee` / `resendPayeeInvite` / `requestPayout` / `getPayout` / `listPayouts` /
1550
+ * `cancelPayout`. See {@link PayoutsServer}.
1551
+ */
1552
+ readonly payouts: PayoutsServer;
1359
1553
  constructor(config: ServerConfig);
1360
1554
  /**
1361
1555
  * Mint a short-lived, game-scoped player token to hand to the browser InvoClient.
@@ -1879,4 +2073,4 @@ declare class InvoServer {
1879
2073
  private toInitiateResult;
1880
2074
  }
1881
2075
 
1882
- export { ApproveWithDeviceCodeInput, BeginDeviceApprovalInput, CallOptions, CancelResult, CancelSubscriptionOptions, CardSetupConfirmInput, CardSetupConfirmResult, CardSetupInput, CardSetupResult, CardSetupSessionInput, CardSetupSessionResult, CardsServer, ChangeAmountResult, ClaimCurrencyInput, ClaimResult, ClaimTransferInput, CompleteDeviceApprovalInput, CompleteDeviceApprovalResult, ConfirmDeviceEnrollmentInput, ConfirmDeviceEnrollmentResult, ConfirmPaymentResult, CreateCheckoutInput, CreateCheckoutResult, CreateSubscriptionInput, CurrencyPurchaseQuote, CurrencyPurchaseQuoteInput, DestinationsResult, DeviceApprovalGrant, DeviceApprovalPollResult, DeviceApprovalSettleResult, GetSubscriptionOptions, GetSubscriptionResult, GuardianApprovalStatusResult, type IdentityPasskeyResetData, InboundPendingQuery, InboundPendingResult, InitiateResult, InitiateSendInput, InitiateTransferInput, InvoError, InvoServer, type InvoWebhookEvent, ItemHistoryQuery, ItemHistoryResult, ItemOrderQuery, type ItemPurchasedData, LinkedIdentitiesQuery, LinkedIdentitiesResult, ListSubscriptionsOptions, LoyaltyCardsResult, MintPlayerTokenInput, OrderDetailsResult, type PayoutStatusChangedData, PhoneChangeRequest, PhoneShareApproveInput, PhoneShareApproveResult, PhoneShareContact, PhoneShareInitiateResult, PhoneShareStatusResult, type PlatformCommercePurchasedData, type PlatformCommerceRefundedData, PlatformCommerceServer, PlatformOrderStatusResult, PlatformPurchaseHistoryQuery, PlatformPurchaseHistoryResult, PlatformPurchaseInput, PlatformPurchaseResult, PlatformRefundInput, PlatformRefundResult, PlayerActivityEntry, PlayerActivityQuery, PlayerActivityResult, PlayerBalanceQuery, PlayerBalanceResult, PlayerCardsResult, type PlayerPhoneChangedData, PlayerToken, PollDeviceApprovalInput, type PurchaseCompletedData, type PurchaseEventData, PurchaseInput, PurchaseItemInput, PurchaseItemResult, PurchaseResult, RefundResult, RefundSubscriptionInput, RegisterPlayerInput, RegisterPlayerResult, RequestPhoneChangeInput, RequestPhoneChangeResult, SDK_VERSION, SandboxClockResult, SandboxFailureOutcome, SandboxForceAuthChallengeOptions, SandboxForceFailureOptions, SandboxServer, SandboxSubscriptionsServer, ServerConfig, ServerDestinationsQuery, SetPaymentMethodInput, SetPaymentMethodResult, SmsVerifyResult, SteamFinalizeInput, SteamFinalizeResult, SteamFinalizeSubscriptionResult, SteamInitPurchaseInput, SteamInitPurchaseResult, SteamInitResult, SteamPacksQuery, SteamPacksResult, SteamSubscriptionInitInput, type SubscriptionAuthenticationRequiredData, type SubscriptionCanceledData, type SubscriptionEventCommon, type SubscriptionExpiredData, SubscriptionListResult, type SubscriptionPastDueData, type SubscriptionPaymentFailedData, type SubscriptionRefundApprovedData, type SubscriptionRefundDetail, type SubscriptionRefundRejectedData, type SubscriptionRefundRequestData, type SubscriptionRefundedData, type SubscriptionRenewalFunding, type SubscriptionRenewalSplit, type SubscriptionRenewedData, SubscriptionResult, type SubscriptionRevenueShareAttribution, type SubscriptionTrialEventFields, SubscriptionsServer, TransactionStatusResult, type TransferEventData, UpdatePlayerPhoneInput, UpdatePlayerPhoneResult, type VerifyWebhookOptions, type WebhookHandlerOptions, createWebhookHandler, verifyWebhook, verifyWebhookAsync };
2076
+ export { ApproveWithDeviceCodeInput, BeginDeviceApprovalInput, CallOptions, CancelResult, CancelSubscriptionOptions, CardSetupConfirmInput, CardSetupConfirmResult, CardSetupInput, CardSetupResult, CardSetupSessionInput, CardSetupSessionResult, CardsServer, ChangeAmountResult, ClaimCurrencyInput, ClaimResult, ClaimTransferInput, CompleteDeviceApprovalInput, CompleteDeviceApprovalResult, ConfirmDeviceEnrollmentInput, ConfirmDeviceEnrollmentResult, ConfirmPaymentResult, CreateCheckoutInput, CreateCheckoutResult, CreateSubscriptionInput, CurrencyPurchaseQuote, CurrencyPurchaseQuoteInput, DestinationsResult, DeviceApprovalGrant, DeviceApprovalPollResult, DeviceApprovalSettleResult, GetSubscriptionOptions, GetSubscriptionResult, GuardianApprovalStatusResult, type IdentityPasskeyResetData, InboundPendingQuery, InboundPendingResult, InitiateResult, InitiateSendInput, InitiateTransferInput, InvoError, InvoServer, type InvoWebhookEvent, ItemHistoryQuery, ItemHistoryResult, ItemOrderQuery, type ItemPurchasedData, LinkedIdentitiesQuery, LinkedIdentitiesResult, type ListPayeesQuery, type ListPayeesResult, type ListPayoutsQuery, type ListPayoutsResult, ListSubscriptionsOptions, LoyaltyCardsResult, MintPlayerTokenInput, OrderDetailsResult, type Payee, type PayeeInvite, type PayeeStatus, type PayeeStatusChangedData, type Payout, type PayoutStatus, type PayoutStatusChangedData, PayoutsServer, PhoneChangeRequest, PhoneShareApproveInput, PhoneShareApproveResult, PhoneShareContact, PhoneShareInitiateResult, PhoneShareStatusResult, type PlatformCommercePurchasedData, type PlatformCommerceRefundedData, PlatformCommerceServer, PlatformOrderStatusResult, PlatformPurchaseHistoryQuery, PlatformPurchaseHistoryResult, PlatformPurchaseInput, PlatformPurchaseResult, PlatformRefundInput, PlatformRefundResult, PlayerActivityEntry, PlayerActivityQuery, PlayerActivityResult, PlayerBalanceQuery, PlayerBalanceResult, PlayerCardsResult, type PlayerPhoneChangedData, PlayerToken, PollDeviceApprovalInput, type PurchaseCompletedData, type PurchaseEventData, PurchaseInput, PurchaseItemInput, PurchaseItemResult, PurchaseResult, RefundResult, RefundSubscriptionInput, type RegisterPayeeInput, type RegisterPayeeResult, RegisterPlayerInput, RegisterPlayerResult, type RequestPayoutInput, type RequestPayoutResult, RequestPhoneChangeInput, RequestPhoneChangeResult, SDK_VERSION, SandboxClockResult, SandboxFailureOutcome, SandboxForceAuthChallengeOptions, SandboxForceFailureOptions, SandboxServer, SandboxSubscriptionsServer, ServerConfig, ServerDestinationsQuery, SetPaymentMethodInput, SetPaymentMethodResult, SmsVerifyResult, SteamFinalizeInput, SteamFinalizeResult, SteamFinalizeSubscriptionResult, SteamInitPurchaseInput, SteamInitPurchaseResult, SteamInitResult, SteamPacksQuery, SteamPacksResult, SteamSubscriptionInitInput, type SubscriptionAuthenticationRequiredData, type SubscriptionCanceledData, type SubscriptionEventCommon, type SubscriptionExpiredData, SubscriptionListResult, type SubscriptionPastDueData, type SubscriptionPaymentFailedData, type SubscriptionRefundApprovedData, type SubscriptionRefundDetail, type SubscriptionRefundRejectedData, type SubscriptionRefundRequestData, type SubscriptionRefundedData, type SubscriptionRenewalFunding, type SubscriptionRenewalSplit, type SubscriptionRenewedData, SubscriptionResult, type SubscriptionRevenueShareAttribution, type SubscriptionTrialEventFields, SubscriptionsServer, TransactionStatusResult, type TransferEventData, UpdatePlayerPhoneInput, UpdatePlayerPhoneResult, type VerifyWebhookOptions, type WebhookHandlerOptions, createWebhookHandler, verifyWebhook, verifyWebhookAsync };
package/dist/server.d.ts CHANGED
@@ -1,12 +1,5 @@
1
- import { I as InvoError, H as Http, $ as AuthHeader, a0 as CardSetupSessionInput, g as CallOptions, a1 as CardSetupSessionResult, a2 as CardSetupInput, a3 as CardSetupResult, a4 as CardSetupConfirmInput, a5 as CardSetupConfirmResult, a6 as PlayerCardsResult, a7 as PlatformPurchaseInput, a8 as PlatformPurchaseResult, a9 as PlatformOrderStatusResult, aa as PlatformPurchaseHistoryQuery, ab as PlatformPurchaseHistoryResult, ac as PlatformRefundInput, ad as PlatformRefundResult, ae as CreateSubscriptionInput, af as SubscriptionResult, ag as GetSubscriptionOptions, ah as GetSubscriptionResult, ai as ListSubscriptionsOptions, aj as SubscriptionListResult, ak as CancelSubscriptionOptions, al as CancelResult, am as ChangeAmountResult, an as SetPaymentMethodInput, ao as SetPaymentMethodResult, ap as RefundSubscriptionInput, aq as RefundResult, ar as SteamSubscriptionInitInput, as as SteamInitResult, at as SteamFinalizeSubscriptionResult, au as SandboxClockResult, av as SandboxFailureOutcome, aw as SandboxForceFailureOptions, ax as SandboxForceAuthChallengeOptions, ay as ServerConfig, az as MintPlayerTokenInput, aA as PlayerToken, aB as RegisterPlayerInput, aC as RegisterPlayerResult, aD as UpdatePlayerPhoneInput, aE as UpdatePlayerPhoneResult, aF as RequestPhoneChangeInput, aG as RequestPhoneChangeResult, aH as PhoneChangeRequest, aI as InitiateSendInput, aJ as InitiateResult, aK as InitiateTransferInput, aL as CreateCheckoutInput, aM as CreateCheckoutResult, aN as PurchaseInput, aO as PurchaseResult, aP as CurrencyPurchaseQuoteInput, aQ as CurrencyPurchaseQuote, aR as ConfirmPaymentResult, aS as OrderDetailsResult, aT as SteamPacksQuery, aU as SteamPacksResult, aV as SteamInitPurchaseInput, aW as SteamInitPurchaseResult, aX as SteamFinalizeInput, aY as SteamFinalizeResult, aZ as PurchaseItemInput, a_ as PurchaseItemResult, a$ as ItemHistoryQuery, b0 as ItemHistoryResult, b1 as ItemOrderQuery, b2 as PlayerActivityQuery, b3 as PlayerActivityResult, b4 as PlayerActivityEntry, b5 as PlayerBalanceQuery, b6 as PlayerBalanceResult, o as LoyaltyCardsResult, b7 as InboundPendingQuery, b8 as InboundPendingResult, b9 as LinkedIdentitiesQuery, ba as LinkedIdentitiesResult, bb as SmsVerifyResult, bc as ClaimTransferInput, bd as ClaimResult, be as ClaimCurrencyInput, bf as TransactionStatusResult, bg as GuardianApprovalStatusResult, bh as ServerDestinationsQuery, n as DestinationsResult, bi as PhoneShareContact, bj as PhoneShareInitiateResult, bk as PhoneShareApproveInput, bl as PhoneShareApproveResult, bm as PhoneShareStatusResult, bn as BeginDeviceApprovalInput, bo as DeviceApprovalGrant, bp as PollDeviceApprovalInput, bq as DeviceApprovalPollResult, br as ConfirmDeviceEnrollmentInput, bs as ConfirmDeviceEnrollmentResult, bt as ApproveWithDeviceCodeInput, bu as DeviceApprovalSettleResult, bv as CompleteDeviceApprovalInput, bw as CompleteDeviceApprovalResult } from './types-DKiV5V0B.js';
2
- export { bx as CardSetupStatus, by as CheckoutWarning, w as ClaimDelivery, bz as CurrencyBalance, bA as CurrencyPurchaseQuoteBreakdown, x as DestinationGame, bB as DeviceApprovalChannel, bC as DeviceApprovalEnrollment, bD as DeviceApprovalFlow, bE as DeviceApprovalPollStatus, bF as DeviceEnrollmentDecision, bG as DeviceEnrollmentRespond, bH as ExpiryReason, bI as FeeTakenFrom, bJ as FirstCharge, bK as FirstChargeStatus, bL as FundingSource, bM as InboundPendingItem, y as InvoErrorInfo, z as InvoHooks, F as InvoRequestInfo, G as InvoResponseInfo, bN as LinkedIdentityEmail, J as LoyaltyCard, K as LoyaltyCardReward, N as LoyaltyCardStep, O as LoyaltyRewardState, Q as LoyaltyStepProgress, S as LoyaltyStepState, bO as MinPurchaseWarning, bP as PhoneChangeConfirmation, bQ as PhoneChangeRequestStatus, bR as PlatformPurchaseStatus, bS as PlayerActivityType, Z as Rail, bT as RefundInitiation, bU as RefundPendingApproval, bV as RefundProcessingFeeBasis, bW as RefundReceipt, bX as RefundRevenueShareAttribution, bY as RefundWarning, bZ as SandboxClockState, b_ as SavedCard, b$ as SteamPack, c0 as SteamUserSession, c1 as Subscription, c2 as SubscriptionBaseInput, c3 as SubscriptionConsent, c4 as SubscriptionConsentInput, c5 as SubscriptionFundingRail, c6 as SubscriptionInterval, c7 as SubscriptionRevenueShare, c8 as SubscriptionRevenueShareInput, c9 as SubscriptionStatus, ca as UnacknowledgedPurchaseOutcome, _ as VerificationMethod, cb as isRefundPendingApproval } from './types-DKiV5V0B.js';
3
-
4
- /**
5
- * The package version, as sent in the server User-Agent. A test pins this to
6
- * `package.json` so it cannot drift silently (it did: the UA read 3.0.0 through 3.7.0).
7
- * Bump it with the changeset flow.
8
- */
9
- declare const SDK_VERSION = "3.24.0";
1
+ import { I as InvoError, H as Http, $ as AuthHeader, g as CallOptions, a0 as CardSetupSessionInput, a1 as CardSetupSessionResult, a2 as CardSetupInput, a3 as CardSetupResult, a4 as CardSetupConfirmInput, a5 as CardSetupConfirmResult, a6 as PlayerCardsResult, a7 as PlatformPurchaseInput, a8 as PlatformPurchaseResult, a9 as PlatformOrderStatusResult, aa as PlatformPurchaseHistoryQuery, ab as PlatformPurchaseHistoryResult, ac as PlatformRefundInput, ad as PlatformRefundResult, ae as CreateSubscriptionInput, af as SubscriptionResult, ag as GetSubscriptionOptions, ah as GetSubscriptionResult, ai as ListSubscriptionsOptions, aj as SubscriptionListResult, ak as CancelSubscriptionOptions, al as CancelResult, am as ChangeAmountResult, an as SetPaymentMethodInput, ao as SetPaymentMethodResult, ap as RefundSubscriptionInput, aq as RefundResult, ar as SteamSubscriptionInitInput, as as SteamInitResult, at as SteamFinalizeSubscriptionResult, au as SandboxClockResult, av as SandboxFailureOutcome, aw as SandboxForceFailureOptions, ax as SandboxForceAuthChallengeOptions, ay as ServerConfig, az as MintPlayerTokenInput, aA as PlayerToken, aB as RegisterPlayerInput, aC as RegisterPlayerResult, aD as UpdatePlayerPhoneInput, aE as UpdatePlayerPhoneResult, aF as RequestPhoneChangeInput, aG as RequestPhoneChangeResult, aH as PhoneChangeRequest, aI as InitiateSendInput, aJ as InitiateResult, aK as InitiateTransferInput, aL as CreateCheckoutInput, aM as CreateCheckoutResult, aN as PurchaseInput, aO as PurchaseResult, aP as CurrencyPurchaseQuoteInput, aQ as CurrencyPurchaseQuote, aR as ConfirmPaymentResult, aS as OrderDetailsResult, aT as SteamPacksQuery, aU as SteamPacksResult, aV as SteamInitPurchaseInput, aW as SteamInitPurchaseResult, aX as SteamFinalizeInput, aY as SteamFinalizeResult, aZ as PurchaseItemInput, a_ as PurchaseItemResult, a$ as ItemHistoryQuery, b0 as ItemHistoryResult, b1 as ItemOrderQuery, b2 as PlayerActivityQuery, b3 as PlayerActivityResult, b4 as PlayerActivityEntry, b5 as PlayerBalanceQuery, b6 as PlayerBalanceResult, o as LoyaltyCardsResult, b7 as InboundPendingQuery, b8 as InboundPendingResult, b9 as LinkedIdentitiesQuery, ba as LinkedIdentitiesResult, bb as SmsVerifyResult, bc as ClaimTransferInput, bd as ClaimResult, be as ClaimCurrencyInput, bf as TransactionStatusResult, bg as GuardianApprovalStatusResult, bh as ServerDestinationsQuery, n as DestinationsResult, bi as PhoneShareContact, bj as PhoneShareInitiateResult, bk as PhoneShareApproveInput, bl as PhoneShareApproveResult, bm as PhoneShareStatusResult, bn as BeginDeviceApprovalInput, bo as DeviceApprovalGrant, bp as PollDeviceApprovalInput, bq as DeviceApprovalPollResult, br as ConfirmDeviceEnrollmentInput, bs as ConfirmDeviceEnrollmentResult, bt as ApproveWithDeviceCodeInput, bu as DeviceApprovalSettleResult, bv as CompleteDeviceApprovalInput, bw as CompleteDeviceApprovalResult } from './types-Cjd4SAR8.js';
2
+ export { bx as CardSetupStatus, by as CheckoutWarning, w as ClaimDelivery, bz as CurrencyBalance, bA as CurrencyPurchaseQuoteBreakdown, x as DestinationGame, bB as DeviceApprovalChannel, bC as DeviceApprovalEnrollment, bD as DeviceApprovalFlow, bE as DeviceApprovalPollStatus, bF as DeviceEnrollmentDecision, bG as DeviceEnrollmentRespond, bH as ExpiryReason, bI as FeeTakenFrom, bJ as FirstCharge, bK as FirstChargeStatus, bL as FundingSource, bM as InboundPendingItem, y as InvoErrorInfo, z as InvoHooks, F as InvoRequestInfo, G as InvoResponseInfo, bN as LinkedIdentityEmail, J as LoyaltyCard, K as LoyaltyCardReward, N as LoyaltyCardStep, O as LoyaltyRewardState, Q as LoyaltyStepProgress, S as LoyaltyStepState, bO as MinPurchaseWarning, bP as PhoneChangeConfirmation, bQ as PhoneChangeRequestStatus, bR as PlatformPurchaseStatus, bS as PlayerActivityType, Z as Rail, bT as RefundInitiation, bU as RefundPendingApproval, bV as RefundProcessingFeeBasis, bW as RefundReceipt, bX as RefundRevenueShareAttribution, bY as RefundWarning, bZ as SandboxClockState, b_ as SavedCard, b$ as SteamPack, c0 as SteamUserSession, c1 as Subscription, c2 as SubscriptionBaseInput, c3 as SubscriptionConsent, c4 as SubscriptionConsentInput, c5 as SubscriptionFundingRail, c6 as SubscriptionInterval, c7 as SubscriptionRevenueShare, c8 as SubscriptionRevenueShareInput, c9 as SubscriptionStatus, ca as UnacknowledgedPurchaseOutcome, _ as VerificationMethod, cb as isRefundPendingApproval } from './types-Cjd4SAR8.js';
10
3
 
11
4
  interface VerifyWebhookOptions {
12
5
  /** Max age of the signed timestamp, in seconds. Default 300 (5 min). */
@@ -340,6 +333,33 @@ interface PayoutStatusChangedData {
340
333
  net_payout_usd?: string | null;
341
334
  /** The cap on the payout fee per payout (for example `"500.00"`); `null` means no cap. */
342
335
  offboarding_fee_cap_usd?: string | null;
336
+ /**
337
+ * Additive (3.25.0). On a creator payout, the creator INVO paid (`cp_...`); `null` on a
338
+ * payout to your own bank. Never carries the creator's bank or personal details.
339
+ */
340
+ payee_id?: string | null;
341
+ /** Additive (3.25.0). `"standard"` or `"manual"`; `null` before approval. */
342
+ payout_method?: "standard" | "manual" | (string & {}) | null;
343
+ /** Additive (3.25.0). On `status: "returned"`: when the receiving bank sent it back. */
344
+ returned_at?: string | null;
345
+ [key: string]: unknown;
346
+ }
347
+ /** Creator statuses (3.25.0). */
348
+ type PayeeStatus = "invited" | "details_submitted" | "verified" | "rejected" | "suspended" | "expired" | (string & {});
349
+ /**
350
+ * `payee.status_changed` (3.25.0): a creator you registered for creator payouts was
351
+ * registered or changed status. Never carries the creator's name or email. Subscribe to it
352
+ * by name.
353
+ */
354
+ interface PayeeStatusChangedData {
355
+ payee_id: string;
356
+ partner_reference: string;
357
+ status: PayeeStatus;
358
+ previous_status: PayeeStatus | null;
359
+ payee_type: "individual" | "business" | (string & {});
360
+ country: string;
361
+ created_via: "api" | "console" | (string & {});
362
+ status_changed_at: string;
343
363
  [key: string]: unknown;
344
364
  }
345
365
  /**
@@ -824,6 +844,9 @@ type InvoWebhookEvent = (WebhookBase & {
824
844
  }) | (WebhookBase & {
825
845
  event_type: "payout.status_changed";
826
846
  data: PayoutStatusChangedData;
847
+ }) | (WebhookBase & {
848
+ event_type: "payee.status_changed";
849
+ data: PayeeStatusChangedData;
827
850
  }) | (WebhookBase & {
828
851
  event_type: "player.phone_changed";
829
852
  data: PlayerPhoneChangedData;
@@ -887,6 +910,171 @@ interface WebhookHandlerOptions {
887
910
  */
888
911
  declare function createWebhookHandler(opts: WebhookHandlerOptions): (request: Request) => Promise<Response>;
889
912
 
913
+ /**
914
+ * Partner payouts and creator payouts (3.25.0).
915
+ *
916
+ * A platform partner can ask INVO to pay out the earnings INVO owes it, and can register
917
+ * creators that INVO verifies and pays on its behalf. Creators are INVO's customers: you
918
+ * never see their documents, tax id or bank details, only their status.
919
+ *
920
+ * Fields keep the server's snake_case names, exactly as the API returns them.
921
+ */
922
+
923
+ /** Payout statuses. `cancelled` and `returned` are 3.25.0. */
924
+ type PayoutStatus = "requested" | "approved" | "processing" | "completed" | "rejected" | "failed" | "cancelled" | "returned" | (string & {});
925
+ interface Payee {
926
+ /** Opaque id, `cp_` followed by 24 hex characters. Store it as a string. */
927
+ payee_id: string;
928
+ game_id: number | string;
929
+ partner_reference: string;
930
+ legal_name: string;
931
+ email: string;
932
+ country: string;
933
+ payee_type: "individual" | "business" | (string & {});
934
+ status: PayeeStatus;
935
+ created_via: "api" | "console" | (string & {});
936
+ status_changed_at: string | null;
937
+ created_at: string | null;
938
+ updated_at: string | null;
939
+ [key: string]: unknown;
940
+ }
941
+ interface PayeeInvite {
942
+ sent: boolean;
943
+ expires_at?: string | null;
944
+ error_code?: string;
945
+ error?: string;
946
+ }
947
+ interface RegisterPayeeInput {
948
+ /** Your own id for the creator: 1 to 128 of `A-Z a-z 0-9 . _ : @ -`, unique in your account. No personal data. */
949
+ partnerReference: string;
950
+ /** The creator's legal name, or the registered business name. */
951
+ legalName: string;
952
+ email: string;
953
+ /** ISO 3166-1 alpha-2, for example `"GB"`. */
954
+ country: string;
955
+ payeeType: "individual" | "business";
956
+ }
957
+ interface RegisterPayeeResult {
958
+ payee: Payee;
959
+ /** Present on a new registration. */
960
+ invite?: PayeeInvite;
961
+ /** `true` when this `partnerReference` was already registered with the same details. */
962
+ duplicate: boolean;
963
+ raw: Record<string, unknown>;
964
+ }
965
+ interface ListPayeesQuery {
966
+ limit?: number;
967
+ offset?: number;
968
+ status?: PayeeStatus;
969
+ }
970
+ interface ListPayeesResult {
971
+ total: number;
972
+ limit: number;
973
+ offset: number;
974
+ items: Payee[];
975
+ raw: Record<string, unknown>;
976
+ }
977
+ interface Payout {
978
+ id: number;
979
+ game_id: number | string;
980
+ status: PayoutStatus;
981
+ requested_amount_usd: string | null;
982
+ offboarding_fee_pct?: string | null;
983
+ offboarding_fee_usd?: string | null;
984
+ offboarding_fee_cap_usd?: string | null;
985
+ net_payout_usd?: string | null;
986
+ /** On a creator payout, the creator INVO pays; `null` on a payout to your own bank. */
987
+ payee_id?: string | null;
988
+ /** `null` on a creator payout: INVO pays the creator's verified account. */
989
+ bank_account?: Record<string, unknown> | null;
990
+ client_request_id?: string | null;
991
+ paid_at?: string | null;
992
+ returned_at?: string | null;
993
+ created_at?: string | null;
994
+ [key: string]: unknown;
995
+ }
996
+ interface RequestPayoutInput {
997
+ /** USD, positive, at most two decimal places. */
998
+ amountUsd: string | number;
999
+ contactEmail: string;
1000
+ /** Pay a verified creator. Don't combine with `bankAccountId`. */
1001
+ payeeId?: string;
1002
+ /** Pay your own verified bank account (id from the INVO console). */
1003
+ bankAccountId?: number;
1004
+ /** Idempotency key. Reuse it to retry the same request safely. */
1005
+ clientRequestId?: string;
1006
+ partnerNote?: string;
1007
+ additionalEmails?: string[];
1008
+ }
1009
+ interface RequestPayoutResult {
1010
+ payout: Payout;
1011
+ /** `true` when `clientRequestId` matched an earlier request with the same amount and creator. */
1012
+ duplicate: boolean;
1013
+ raw: Record<string, unknown>;
1014
+ }
1015
+ interface ListPayoutsQuery {
1016
+ limit?: number;
1017
+ offset?: number;
1018
+ status?: PayoutStatus;
1019
+ /** Only this creator's payouts. */
1020
+ payeeId?: string;
1021
+ }
1022
+ interface ListPayoutsResult {
1023
+ total: number;
1024
+ items: Payout[];
1025
+ raw: Record<string, unknown>;
1026
+ }
1027
+ /** `InvoServer.payouts`: partner payouts and creator payouts. */
1028
+ declare class PayoutsServer {
1029
+ private readonly http;
1030
+ private readonly auth;
1031
+ constructor(http: Http, auth: AuthHeader);
1032
+ /**
1033
+ * Register a creator (`POST /api/partner-payees`). INVO emails the creator a link to INVO's
1034
+ * own page to give INVO their identity, tax and bank details. `invite.sent` is `false` when
1035
+ * INVO did not email the link (`invite.error_code` says why); the creator is registered
1036
+ * either way. Refusals: `409 PARTNER_REFERENCE_CONFLICT`, `400 INVALID_INPUT`,
1037
+ * `400 COUNTRY_NOT_SUPPORTED`.
1038
+ */
1039
+ registerPayee(input: RegisterPayeeInput, opts?: CallOptions): Promise<RegisterPayeeResult>;
1040
+ /** This game's creators, newest first (`GET /api/partner-payees`). */
1041
+ listPayees(q?: ListPayeesQuery, opts?: CallOptions): Promise<ListPayeesResult>;
1042
+ /** One creator (`GET /api/partner-payees/{payeeId}`); `404 NOT_FOUND` if not this game's. */
1043
+ getPayee(payeeId: string, opts?: CallOptions): Promise<Payee>;
1044
+ /**
1045
+ * Email the creator a new link (`POST /api/partner-payees/{payeeId}/resend-invite`); the old
1046
+ * link stops working. Allowed while the creator is `invited`, `rejected` or `expired`
1047
+ * (`409 INVITE_NOT_NEEDED` otherwise). Never auto-retried.
1048
+ */
1049
+ resendPayeeInvite(payeeId: string, opts?: CallOptions): Promise<PayeeInvite>;
1050
+ /**
1051
+ * Ask INVO to pay out (`POST /api/partner-payouts/request`). With `payeeId`, INVO pays that
1052
+ * verified creator's bank account; otherwise your own verified bank account. The money comes
1053
+ * from the earnings INVO owes your game, and the payout fee is taken from the payout.
1054
+ * Creator refusals: `404 PAYEE_NOT_FOUND`, `409 PAYEE_NOT_VERIFIED`,
1055
+ * `409 PAYEE_VERIFICATION_EXPIRED`, `409 PAYEE_BANK_NOT_VERIFIED`, `409 PAYEE_NOT_PAYABLE`.
1056
+ * Retried safely only when `clientRequestId` is set.
1057
+ */
1058
+ requestPayout(input: RequestPayoutInput, opts?: CallOptions): Promise<RequestPayoutResult>;
1059
+ /** One payout (`GET /api/partner-payouts/{payoutId}`). */
1060
+ getPayout(payoutIdValue: number, opts?: CallOptions): Promise<Payout>;
1061
+ /** Your payouts (`GET /api/partner-payouts`), optionally one creator's (`payeeId`). */
1062
+ listPayouts(q?: ListPayoutsQuery, opts?: CallOptions): Promise<ListPayoutsResult>;
1063
+ /**
1064
+ * Cancel a creator payout that is still `requested`
1065
+ * (`POST /api/partner-payouts/{payoutId}/cancel`). Anything past `requested` is
1066
+ * `409 PAYOUT_NOT_CANCELLABLE`.
1067
+ */
1068
+ cancelPayout(payoutIdValue: number, opts?: CallOptions): Promise<Payout>;
1069
+ }
1070
+
1071
+ /**
1072
+ * The package version, as sent in the server User-Agent. A test pins this to
1073
+ * `package.json` so it cannot drift silently (it did: the UA read 3.0.0 through 3.7.0).
1074
+ * Bump it with the changeset flow.
1075
+ */
1076
+ declare const SDK_VERSION = "3.25.0";
1077
+
890
1078
  /**
891
1079
  * @invonetwork/web-sdk/server — NODE entry.
892
1080
  *
@@ -1356,6 +1544,12 @@ declare class InvoServer {
1356
1544
  * `forceFailure` / `forceAuthChallenge`. Needs `sandboxClockKey`. See {@link SandboxSubscriptionsServer}.
1357
1545
  */
1358
1546
  readonly sandbox: SandboxServer;
1547
+ /**
1548
+ * Partner payouts and creator payouts (3.25.0): `registerPayee` / `listPayees` /
1549
+ * `getPayee` / `resendPayeeInvite` / `requestPayout` / `getPayout` / `listPayouts` /
1550
+ * `cancelPayout`. See {@link PayoutsServer}.
1551
+ */
1552
+ readonly payouts: PayoutsServer;
1359
1553
  constructor(config: ServerConfig);
1360
1554
  /**
1361
1555
  * Mint a short-lived, game-scoped player token to hand to the browser InvoClient.
@@ -1879,4 +2073,4 @@ declare class InvoServer {
1879
2073
  private toInitiateResult;
1880
2074
  }
1881
2075
 
1882
- export { ApproveWithDeviceCodeInput, BeginDeviceApprovalInput, CallOptions, CancelResult, CancelSubscriptionOptions, CardSetupConfirmInput, CardSetupConfirmResult, CardSetupInput, CardSetupResult, CardSetupSessionInput, CardSetupSessionResult, CardsServer, ChangeAmountResult, ClaimCurrencyInput, ClaimResult, ClaimTransferInput, CompleteDeviceApprovalInput, CompleteDeviceApprovalResult, ConfirmDeviceEnrollmentInput, ConfirmDeviceEnrollmentResult, ConfirmPaymentResult, CreateCheckoutInput, CreateCheckoutResult, CreateSubscriptionInput, CurrencyPurchaseQuote, CurrencyPurchaseQuoteInput, DestinationsResult, DeviceApprovalGrant, DeviceApprovalPollResult, DeviceApprovalSettleResult, GetSubscriptionOptions, GetSubscriptionResult, GuardianApprovalStatusResult, type IdentityPasskeyResetData, InboundPendingQuery, InboundPendingResult, InitiateResult, InitiateSendInput, InitiateTransferInput, InvoError, InvoServer, type InvoWebhookEvent, ItemHistoryQuery, ItemHistoryResult, ItemOrderQuery, type ItemPurchasedData, LinkedIdentitiesQuery, LinkedIdentitiesResult, ListSubscriptionsOptions, LoyaltyCardsResult, MintPlayerTokenInput, OrderDetailsResult, type PayoutStatusChangedData, PhoneChangeRequest, PhoneShareApproveInput, PhoneShareApproveResult, PhoneShareContact, PhoneShareInitiateResult, PhoneShareStatusResult, type PlatformCommercePurchasedData, type PlatformCommerceRefundedData, PlatformCommerceServer, PlatformOrderStatusResult, PlatformPurchaseHistoryQuery, PlatformPurchaseHistoryResult, PlatformPurchaseInput, PlatformPurchaseResult, PlatformRefundInput, PlatformRefundResult, PlayerActivityEntry, PlayerActivityQuery, PlayerActivityResult, PlayerBalanceQuery, PlayerBalanceResult, PlayerCardsResult, type PlayerPhoneChangedData, PlayerToken, PollDeviceApprovalInput, type PurchaseCompletedData, type PurchaseEventData, PurchaseInput, PurchaseItemInput, PurchaseItemResult, PurchaseResult, RefundResult, RefundSubscriptionInput, RegisterPlayerInput, RegisterPlayerResult, RequestPhoneChangeInput, RequestPhoneChangeResult, SDK_VERSION, SandboxClockResult, SandboxFailureOutcome, SandboxForceAuthChallengeOptions, SandboxForceFailureOptions, SandboxServer, SandboxSubscriptionsServer, ServerConfig, ServerDestinationsQuery, SetPaymentMethodInput, SetPaymentMethodResult, SmsVerifyResult, SteamFinalizeInput, SteamFinalizeResult, SteamFinalizeSubscriptionResult, SteamInitPurchaseInput, SteamInitPurchaseResult, SteamInitResult, SteamPacksQuery, SteamPacksResult, SteamSubscriptionInitInput, type SubscriptionAuthenticationRequiredData, type SubscriptionCanceledData, type SubscriptionEventCommon, type SubscriptionExpiredData, SubscriptionListResult, type SubscriptionPastDueData, type SubscriptionPaymentFailedData, type SubscriptionRefundApprovedData, type SubscriptionRefundDetail, type SubscriptionRefundRejectedData, type SubscriptionRefundRequestData, type SubscriptionRefundedData, type SubscriptionRenewalFunding, type SubscriptionRenewalSplit, type SubscriptionRenewedData, SubscriptionResult, type SubscriptionRevenueShareAttribution, type SubscriptionTrialEventFields, SubscriptionsServer, TransactionStatusResult, type TransferEventData, UpdatePlayerPhoneInput, UpdatePlayerPhoneResult, type VerifyWebhookOptions, type WebhookHandlerOptions, createWebhookHandler, verifyWebhook, verifyWebhookAsync };
2076
+ export { ApproveWithDeviceCodeInput, BeginDeviceApprovalInput, CallOptions, CancelResult, CancelSubscriptionOptions, CardSetupConfirmInput, CardSetupConfirmResult, CardSetupInput, CardSetupResult, CardSetupSessionInput, CardSetupSessionResult, CardsServer, ChangeAmountResult, ClaimCurrencyInput, ClaimResult, ClaimTransferInput, CompleteDeviceApprovalInput, CompleteDeviceApprovalResult, ConfirmDeviceEnrollmentInput, ConfirmDeviceEnrollmentResult, ConfirmPaymentResult, CreateCheckoutInput, CreateCheckoutResult, CreateSubscriptionInput, CurrencyPurchaseQuote, CurrencyPurchaseQuoteInput, DestinationsResult, DeviceApprovalGrant, DeviceApprovalPollResult, DeviceApprovalSettleResult, GetSubscriptionOptions, GetSubscriptionResult, GuardianApprovalStatusResult, type IdentityPasskeyResetData, InboundPendingQuery, InboundPendingResult, InitiateResult, InitiateSendInput, InitiateTransferInput, InvoError, InvoServer, type InvoWebhookEvent, ItemHistoryQuery, ItemHistoryResult, ItemOrderQuery, type ItemPurchasedData, LinkedIdentitiesQuery, LinkedIdentitiesResult, type ListPayeesQuery, type ListPayeesResult, type ListPayoutsQuery, type ListPayoutsResult, ListSubscriptionsOptions, LoyaltyCardsResult, MintPlayerTokenInput, OrderDetailsResult, type Payee, type PayeeInvite, type PayeeStatus, type PayeeStatusChangedData, type Payout, type PayoutStatus, type PayoutStatusChangedData, PayoutsServer, PhoneChangeRequest, PhoneShareApproveInput, PhoneShareApproveResult, PhoneShareContact, PhoneShareInitiateResult, PhoneShareStatusResult, type PlatformCommercePurchasedData, type PlatformCommerceRefundedData, PlatformCommerceServer, PlatformOrderStatusResult, PlatformPurchaseHistoryQuery, PlatformPurchaseHistoryResult, PlatformPurchaseInput, PlatformPurchaseResult, PlatformRefundInput, PlatformRefundResult, PlayerActivityEntry, PlayerActivityQuery, PlayerActivityResult, PlayerBalanceQuery, PlayerBalanceResult, PlayerCardsResult, type PlayerPhoneChangedData, PlayerToken, PollDeviceApprovalInput, type PurchaseCompletedData, type PurchaseEventData, PurchaseInput, PurchaseItemInput, PurchaseItemResult, PurchaseResult, RefundResult, RefundSubscriptionInput, type RegisterPayeeInput, type RegisterPayeeResult, RegisterPlayerInput, RegisterPlayerResult, type RequestPayoutInput, type RequestPayoutResult, RequestPhoneChangeInput, RequestPhoneChangeResult, SDK_VERSION, SandboxClockResult, SandboxFailureOutcome, SandboxForceAuthChallengeOptions, SandboxForceFailureOptions, SandboxServer, SandboxSubscriptionsServer, ServerConfig, ServerDestinationsQuery, SetPaymentMethodInput, SetPaymentMethodResult, SmsVerifyResult, SteamFinalizeInput, SteamFinalizeResult, SteamFinalizeSubscriptionResult, SteamInitPurchaseInput, SteamInitPurchaseResult, SteamInitResult, SteamPacksQuery, SteamPacksResult, SteamSubscriptionInitInput, type SubscriptionAuthenticationRequiredData, type SubscriptionCanceledData, type SubscriptionEventCommon, type SubscriptionExpiredData, SubscriptionListResult, type SubscriptionPastDueData, type SubscriptionPaymentFailedData, type SubscriptionRefundApprovedData, type SubscriptionRefundDetail, type SubscriptionRefundRejectedData, type SubscriptionRefundRequestData, type SubscriptionRefundedData, type SubscriptionRenewalFunding, type SubscriptionRenewalSplit, type SubscriptionRenewedData, SubscriptionResult, type SubscriptionRevenueShareAttribution, type SubscriptionTrialEventFields, SubscriptionsServer, TransactionStatusResult, type TransferEventData, UpdatePlayerPhoneInput, UpdatePlayerPhoneResult, type VerifyWebhookOptions, type WebhookHandlerOptions, createWebhookHandler, verifyWebhook, verifyWebhookAsync };