@invonetwork/web-sdk 3.34.1 → 3.36.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/CHANGELOG.md +20 -0
- package/README.md +115 -4
- package/dist/chunk-B75DBT53.js +6 -0
- package/dist/{chunk-3BR7URPM.js → chunk-BGCSSWVL.js} +104 -2
- package/dist/{chunk-MJXQ3Q7C.js → chunk-J4IQ3ANY.js} +240 -70
- package/dist/{chunk-PEYWNML4.js → chunk-SCFK6IVH.js} +3 -3
- package/dist/game-server.cjs +302 -73
- package/dist/game-server.d.cts +4 -4
- package/dist/game-server.d.ts +4 -4
- package/dist/game-server.js +5 -5
- package/dist/game.cjs +103 -1
- package/dist/game.d.cts +3 -3
- package/dist/game.d.ts +3 -3
- package/dist/game.js +3 -3
- package/dist/{hosted-approval-B6yY7ExK.d.cts → hosted-approval-BKI9oHwf.d.cts} +1 -1
- package/dist/{hosted-approval-CZ5EYFlM.d.ts → hosted-approval-fgVkugRU.d.ts} +1 -1
- package/dist/index.cjs +102 -0
- package/dist/index.d.cts +4 -4
- package/dist/index.d.ts +4 -4
- package/dist/index.js +2 -2
- package/dist/{server-A1s7zqzG.d.cts → server-BMY3q2Bn.d.cts} +122 -7
- package/dist/{server-JARGQrat.d.ts → server-CSRCWgrK.d.ts} +122 -7
- package/dist/server.cjs +341 -66
- package/dist/server.d.cts +3 -3
- package/dist/server.d.ts +3 -3
- package/dist/server.js +3 -3
- package/dist/{types-B4J9Ifd2.d.ts → types-BcdXf2S5.d.cts} +173 -1
- package/dist/{types-B4J9Ifd2.d.cts → types-BcdXf2S5.d.ts} +173 -1
- package/dist/{version-DB2wgiPY.d.cts → version-QIFHOifq.d.cts} +1 -1
- package/dist/{version-DB2wgiPY.d.ts → version-QIFHOifq.d.ts} +1 -1
- package/docs/apple-in-app-purchases.md +425 -0
- package/package.json +2 -1
- package/dist/chunk-6763YM7P.js +0 -6
package/dist/server.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
export {
|
|
1
|
+
export { bB as AppleEnvironment, bC as AppleProduct, a$ as AppleProductsResult, a0 as ApplePurchaseResult, bD as ApplePurchaseStatus, bE as AppleUnavailableReason, bx as ApproveWithDeviceCodeInput, br as BeginDeviceApprovalInput, g as CallOptions, ag as CancelResult, af as CancelSubscriptionOptions, at as CardSetupConfirmInput, au as CardSetupConfirmResult, ar as CardSetupInput, as as CardSetupResult, ap as CardSetupSessionInput, aq as CardSetupSessionResult, bF as CardSetupStatus, ah as ChangeAmountResult, bG as CheckoutWarning, bi as ClaimCurrencyInput, y as ClaimDelivery, bh as ClaimResult, bg as ClaimTransferInput, bz as CompleteDeviceApprovalInput, bA as CompleteDeviceApprovalResult, bv as ConfirmDeviceEnrollmentInput, bw as ConfirmDeviceEnrollmentResult, aT as ConfirmPaymentResult, aN as CreateCheckoutInput, aO as CreateCheckoutResult, a9 as CreateSubscriptionInput, bH as CurrencyBalance, aS as CurrencyPurchaseQuote, bI as CurrencyPurchaseQuoteBreakdown, aR as CurrencyPurchaseQuoteInput, D as DestinationGame, p as DestinationsResult, bJ as DeviceApprovalChannel, bK as DeviceApprovalEnrollment, bL as DeviceApprovalFlow, bs as DeviceApprovalGrant, bu as DeviceApprovalPollResult, bM as DeviceApprovalPollStatus, by as DeviceApprovalSettleResult, bN as DeviceEnrollmentDecision, bO as DeviceEnrollmentRespond, bP as ExpiryReason, bQ as FeeTakenFrom, bR as FirstCharge, bS as FirstChargeStatus, bT as FundingSource, ab as GetSubscriptionOptions, ac as GetSubscriptionResult, bk as GuardianApprovalStatusResult, bU as InboundPendingItem, bb as InboundPendingQuery, bc as InboundPendingResult, aL as InitiateResult, aK as InitiateSendInput, aM as InitiateTransferInput, I as InvoError, z as InvoErrorInfo, F as InvoHooks, G as InvoRequestInfo, J as InvoResponseInfo, b3 as ItemHistoryQuery, b4 as ItemHistoryResult, b5 as ItemOrderQuery, bd as LinkedIdentitiesQuery, be as LinkedIdentitiesResult, bV as LinkedIdentityEmail, ad as ListSubscriptionsOptions, K as LoyaltyCard, N as LoyaltyCardReward, O as LoyaltyCardStep, q as LoyaltyCardsResult, Q as LoyaltyRewardState, S as LoyaltyStepProgress, T as LoyaltyStepState, bW as MinPurchaseWarning, aB as MintPlayerTokenInput, aU as OrderDetailsResult, bX as PhoneChangeConfirmation, aJ as PhoneChangeRequest, bY as PhoneChangeRequestStatus, bo as PhoneShareApproveInput, bp as PhoneShareApproveResult, bm as PhoneShareContact, bn as PhoneShareInitiateResult, bq as PhoneShareStatusResult, a3 as PlatformApprovalResult, a4 as PlatformOrderStatusResult, a5 as PlatformPurchaseHistoryQuery, a6 as PlatformPurchaseHistoryResult, a1 as PlatformPurchaseInput, a2 as PlatformPurchaseResult, bZ as PlatformPurchaseStatus, a7 as PlatformRefundInput, a8 as PlatformRefundResult, b8 as PlayerActivityEntry, b6 as PlayerActivityQuery, b7 as PlayerActivityResult, b_ as PlayerActivityType, b9 as PlayerBalanceQuery, ba as PlayerBalanceResult, av as PlayerCardsResult, aC as PlayerToken, bt as PollDeviceApprovalInput, aP as PurchaseInput, b1 as PurchaseItemInput, b2 as PurchaseItemResult, aQ as PurchaseResult, Z as Rail, b$ as RefundInitiation, c0 as RefundPendingApproval, c1 as RefundProcessingFeeBasis, c2 as RefundReceipt, al as RefundResult, c3 as RefundRevenueShareAttribution, ak as RefundSubscriptionInput, c4 as RefundWarning, aD as RegisterPlayerInput, aE as RegisterPlayerResult, aH as RequestPhoneChangeInput, aI as RequestPhoneChangeResult, aw as SandboxClockResult, c5 as SandboxClockState, ax as SandboxFailureOutcome, az as SandboxForceAuthChallengeOptions, ay as SandboxForceFailureOptions, c6 as SavedCard, aA as ServerConfig, bl as ServerDestinationsQuery, ai as SetPaymentMethodInput, aj as SetPaymentMethodResult, bf as SmsVerifyResult, aZ as SteamFinalizeInput, a_ as SteamFinalizeResult, ao as SteamFinalizeSubscriptionResult, aX as SteamInitPurchaseInput, aY as SteamInitPurchaseResult, an as SteamInitResult, c7 as SteamPack, aV as SteamPacksQuery, aW as SteamPacksResult, am as SteamSubscriptionInitInput, c8 as SteamUnavailableReason, c9 as SteamUserSession, ca as Subscription, cb as SubscriptionBaseInput, cc as SubscriptionConsent, cd as SubscriptionConsentInput, ce as SubscriptionFundingRail, cf as SubscriptionInterval, ae as SubscriptionListResult, aa as SubscriptionResult, cg as SubscriptionRevenueShare, ch as SubscriptionRevenueShareInput, ci as SubscriptionStatus, bj as TransactionStatusResult, cj as UnacknowledgedPurchaseOutcome, aF as UpdatePlayerPhoneInput, aG as UpdatePlayerPhoneResult, _ as VerificationMethod, b0 as VerifyApplePurchaseInput, ck as isRefundPendingApproval } from './types-BcdXf2S5.js';
|
|
2
2
|
export { G as GameEventType, R as ReportGameEventInput, a as ReportGameEventResult, b as ReportServerGameEventInput } from './loyalty-events-CmDw2ZoR.js';
|
|
3
|
-
export { C as CardsServer, D as DEMO_KEY_PREFIX, E as EnvironmentUnknownError,
|
|
4
|
-
export { S as SDK_VERSION } from './version-
|
|
3
|
+
export { A as APPLE_FINISH_ERROR_CODES, d as AppleWebhookDetails, C as CardsServer, D as DEMO_KEY_PREFIX, E as EnvironmentUnknownError, f as IdentityPasskeyResetData, a as InvoEnvironment, I as InvoServer, g as InvoWebhookEvent, h as ItemPurchasedData, K as KeyEnvironmentMismatchError, L as LIVE_KEY_PREFIX, j as ListPayeesQuery, k as ListPayeesResult, l as ListPayoutsQuery, m as ListPayoutsResult, P as PRODUCTION_BASE_URL, n as PayableBlocker, o as Payee, p as PayeeInvite, q as PayeeStatus, s as PayeeStatusChangedData, t as Payout, u as PayoutStatus, w as PayoutStatusChangedData, x as PayoutsServer, y as PlatformCommercePurchasedData, z as PlatformCommerceRefundedData, B as PlatformCommerceServer, F as PlayerPhoneChangedData, G as PurchaseCompletedData, H as PurchaseEventData, R as RegisterPayeeInput, J as RegisterPayeeResult, M as RequestPayoutInput, N as RequestPayoutResult, O as ReturnReasonCode, S as SANDBOX_BASE_URL, Q as SandboxServer, U as SandboxSubscriptionsServer, V as SubscriptionAuthenticationRequiredData, W as SubscriptionCanceledData, X as SubscriptionEventCommon, Y as SubscriptionExpiredData, Z as SubscriptionPastDueData, _ as SubscriptionPaymentFailedData, $ as SubscriptionRefundApprovedData, a0 as SubscriptionRefundDetail, a1 as SubscriptionRefundRejectedData, a2 as SubscriptionRefundRequestData, a3 as SubscriptionRefundedData, a4 as SubscriptionRenewalFunding, a5 as SubscriptionRenewalSplit, a6 as SubscriptionRenewedData, a7 as SubscriptionRevenueShareAttribution, a8 as SubscriptionTrialEventFields, a9 as SubscriptionsServer, T as TEST_KEY_PREFIX, aa as TransferEventData, ab as VerifyWebhookOptions, ac as WebhookHandlerOptions, b as baseUrlForKey, ad as createWebhookHandler, e as environmentForBaseUrl, c as environmentFromKeyPrefix, ae as isAppleCreditPending, i as isDemoKey, r as resolveEnvironment, af as shouldFinishAppleTransaction, ag as verifyWebhook, ah as verifyWebhookAsync } from './server-CSRCWgrK.js';
|
|
4
|
+
export { S as SDK_VERSION } from './version-QIFHOifq.js';
|
package/dist/server.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
export { CardsServer, DEMO_KEY_PREFIX, EnvironmentUnknownError, InvoServer, KeyEnvironmentMismatchError, LIVE_KEY_PREFIX, PRODUCTION_BASE_URL, PayoutsServer, PlatformCommerceServer, SANDBOX_BASE_URL, SandboxServer, SandboxSubscriptionsServer, SubscriptionsServer, TEST_KEY_PREFIX, baseUrlForKey, createWebhookHandler, environmentForBaseUrl, environmentFromKeyPrefix, isDemoKey, isRefundPendingApproval, resolveEnvironment, verifyWebhook, verifyWebhookAsync } from './chunk-
|
|
2
|
-
export { SDK_VERSION } from './chunk-
|
|
3
|
-
export { InvoError } from './chunk-
|
|
1
|
+
export { APPLE_FINISH_ERROR_CODES, CardsServer, DEMO_KEY_PREFIX, EnvironmentUnknownError, InvoServer, KeyEnvironmentMismatchError, LIVE_KEY_PREFIX, PRODUCTION_BASE_URL, PayoutsServer, PlatformCommerceServer, SANDBOX_BASE_URL, SandboxServer, SandboxSubscriptionsServer, SubscriptionsServer, TEST_KEY_PREFIX, baseUrlForKey, createWebhookHandler, environmentForBaseUrl, environmentFromKeyPrefix, isAppleCreditPending, isDemoKey, isRefundPendingApproval, resolveEnvironment, shouldFinishAppleTransaction, verifyWebhook, verifyWebhookAsync } from './chunk-J4IQ3ANY.js';
|
|
2
|
+
export { SDK_VERSION } from './chunk-B75DBT53.js';
|
|
3
|
+
export { InvoError } from './chunk-BGCSSWVL.js';
|
|
4
4
|
//# sourceMappingURL=server.js.map
|
|
5
5
|
//# sourceMappingURL=server.js.map
|
|
@@ -867,6 +867,65 @@ declare class InvoError extends Error {
|
|
|
867
867
|
* and send the same request again. Branch on this, not on the message.
|
|
868
868
|
*/
|
|
869
869
|
get isRateLimited(): boolean;
|
|
870
|
+
/**
|
|
871
|
+
* The body's boolean `finish` (additive, 3.35.0), sent on every `verifyApplePurchase`
|
|
872
|
+
* answer: `true` when the game should call StoreKit's `Transaction.finish()` for this
|
|
873
|
+
* refusal (nothing can ever be delivered), `false` when it should leave the transaction
|
|
874
|
+
* unfinished and retry. `undefined` when the body carries none (any other endpoint, an
|
|
875
|
+
* older backend, or a network error); `shouldFinishAppleTransaction(err)` then falls back
|
|
876
|
+
* to the error code.
|
|
877
|
+
*/
|
|
878
|
+
get finish(): boolean | undefined;
|
|
879
|
+
/** Not a genuine Apple transaction (`APPLE_SIGNATURE_INVALID`, 400). Leave it unfinished. */
|
|
880
|
+
get isAppleSignatureInvalid(): boolean;
|
|
881
|
+
/** Another app's transaction: the bundle id (or Apple ID) is not this game's
|
|
882
|
+
* (`APPLE_BUNDLE_MISMATCH`, 400). */
|
|
883
|
+
get isAppleBundleMismatch(): boolean;
|
|
884
|
+
/** The transaction's environment is not accepted here (`APPLE_ENVIRONMENT_NOT_ALLOWED`, 400).
|
|
885
|
+
* The INVO sandbox takes only Sandbox transactions; Xcode StoreKit-testing transactions are
|
|
886
|
+
* never accepted, because Apple does not sign them. */
|
|
887
|
+
get isAppleEnvironmentNotAllowed(): boolean;
|
|
888
|
+
/** Only consumable products buy currency (`APPLE_PRODUCT_TYPE_UNSUPPORTED`, 400). */
|
|
889
|
+
get isAppleProductTypeUnsupported(): boolean;
|
|
890
|
+
/** The product id is not registered for this game (`APPLE_PRODUCT_UNKNOWN`, 400). Register
|
|
891
|
+
* it in the INVO console and retry; keep the transaction unfinished meanwhile. */
|
|
892
|
+
get isAppleProductUnknown(): boolean;
|
|
893
|
+
/** `metadata` was refused (`INVALID_METADATA`, 400). Fix the request and retry. */
|
|
894
|
+
get isInvalidMetadata(): boolean;
|
|
895
|
+
/** A Sandbox purchase on INVO production by an account not on the game's App Review list
|
|
896
|
+
* (`APPLE_REVIEW_ACCOUNT_REQUIRED`, 403). */
|
|
897
|
+
get isAppleReviewAccountRequired(): boolean;
|
|
898
|
+
/** Apple refunded or revoked the transaction (`APPLE_TRANSACTION_REVOKED`, 409). Nothing can
|
|
899
|
+
* ever be delivered for it: **finish it** (`finish: true`). */
|
|
900
|
+
get isAppleTransactionRevoked(): boolean;
|
|
901
|
+
/** The transaction was already credited in another INVO game
|
|
902
|
+
* (`APPLE_TRANSACTION_ALREADY_USED`, 409). Terminal: **finish it** (`finish: true`). */
|
|
903
|
+
get isAppleTransactionAlreadyUsed(): boolean;
|
|
904
|
+
/** Bought before the game sold through INVO (`APPLE_TRANSACTION_TOO_OLD`, 409). Terminal:
|
|
905
|
+
* **finish it** (`finish: true`). */
|
|
906
|
+
get isAppleTransactionTooOld(): boolean;
|
|
907
|
+
/** The product's coins are out of proportion to its signed price, or over the per-purchase
|
|
908
|
+
* maximum (`APPLE_VALUE_EXCEEDS_PRICE`, 409). Fix the product mapping and retry. */
|
|
909
|
+
get isAppleValueExceedsPrice(): boolean;
|
|
910
|
+
/** The transaction's `appAccountToken` is not the one you sent: it was made for a
|
|
911
|
+
* different player (`APPLE_ACCOUNT_TOKEN_MISMATCH`, 409). */
|
|
912
|
+
get isAppleAccountTokenMismatch(): boolean;
|
|
913
|
+
/** The game's Apple configuration is missing or turned off (`APPLE_NOT_CONFIGURED`, 409).
|
|
914
|
+
* Retry once it is set up. */
|
|
915
|
+
get isAppleNotConfigured(): boolean;
|
|
916
|
+
/** Production has not yet confirmed you own the App Store app (`APPLE_NOT_VERIFIED`, 409).
|
|
917
|
+
* Point App Store Server Notifications at INVO; retry once verified. */
|
|
918
|
+
get isAppleNotVerified(): boolean;
|
|
919
|
+
/** Today's App Review purchase cap on production is reached (`APPLE_REVIEW_PURCHASE_LIMIT`,
|
|
920
|
+
* 429). */
|
|
921
|
+
get isAppleReviewPurchaseLimit(): boolean;
|
|
922
|
+
/** Verified and held, not refused (`APPLE_CREDIT_PENDING`, 503): the coins will credit on a
|
|
923
|
+
* later retry. Keep the transaction unfinished and retry; StoreKit also redelivers it. */
|
|
924
|
+
get isAppleCreditPending(): boolean;
|
|
925
|
+
/** A card purchase (`purchaseCurrency`) was made with a key on the Apple rail
|
|
926
|
+
* (`WRONG_RAIL_ENDPOINT`, 400, `status: "use_apple_endpoint"`). Use
|
|
927
|
+
* `verifyApplePurchase` for that key. */
|
|
928
|
+
get isAppleEndpointRequired(): boolean;
|
|
870
929
|
/** `body` as a plain object, or `{}` if it's a string/number/null (non-JSON responses).
|
|
871
930
|
* The `in` operator throws on primitives, so callers must go through this. */
|
|
872
931
|
private bodyObject;
|
|
@@ -1730,7 +1789,26 @@ interface SteamPack {
|
|
|
1730
1789
|
* cache one answer for all players.
|
|
1731
1790
|
*/
|
|
1732
1791
|
currencyAmount: string;
|
|
1792
|
+
/**
|
|
1793
|
+
* Whether INVO will sell THIS pack right now for the developer's billing
|
|
1794
|
+
* (3.36.0). Show only packs with `available: true`; a larger pack can be
|
|
1795
|
+
* unavailable while smaller ones still sell. Advisory: `steamInitPurchase()`
|
|
1796
|
+
* still decides. Absent on an older server: treat absent as available.
|
|
1797
|
+
*/
|
|
1798
|
+
available?: boolean;
|
|
1799
|
+
/** Set when `available` is `false`. */
|
|
1800
|
+
unavailableReason?: SteamUnavailableReason | null;
|
|
1733
1801
|
}
|
|
1802
|
+
/**
|
|
1803
|
+
* Why INVO will not sell a Steam pack right now (`unavailableReason`, 3.36.0).
|
|
1804
|
+
* Open-ended: treat any other value as "not available". All are fixed by the
|
|
1805
|
+
* developer in the INVO console, never by the player.
|
|
1806
|
+
*
|
|
1807
|
+
* - `PARTNER_BILLING_NOT_SET_UP`: the developer account has no INVO billing set up.
|
|
1808
|
+
* - `PARTNER_RAIL_SUSPENDED`: the developer account's settlement is suspended.
|
|
1809
|
+
* - `PARTNER_CREDIT_UNAVAILABLE`: no headroom for this pack right now.
|
|
1810
|
+
*/
|
|
1811
|
+
type SteamUnavailableReason = "PARTNER_BILLING_NOT_SET_UP" | "PARTNER_RAIL_SUSPENDED" | "PARTNER_CREDIT_UNAVAILABLE" | (string & {});
|
|
1734
1812
|
interface SteamPacksQuery {
|
|
1735
1813
|
/**
|
|
1736
1814
|
* The player's 64-bit Steam id. Optional: without it amounts are quoted with
|
|
@@ -1745,6 +1823,13 @@ interface SteamPacksResult {
|
|
|
1745
1823
|
country: string | null;
|
|
1746
1824
|
/** VAT rate (percent, string) the quote used. "0" when none applies. */
|
|
1747
1825
|
vatRatePct: string;
|
|
1826
|
+
/**
|
|
1827
|
+
* `false` when the title can sell nothing on Steam right now;
|
|
1828
|
+
* `unavailableReason` says why (3.36.0). Call `steamPacks()` before showing
|
|
1829
|
+
* the store. Absent on an older server: treat absent as `true`.
|
|
1830
|
+
*/
|
|
1831
|
+
canSell?: boolean;
|
|
1832
|
+
unavailableReason?: SteamUnavailableReason | null;
|
|
1748
1833
|
raw: Record<string, unknown>;
|
|
1749
1834
|
}
|
|
1750
1835
|
interface SteamInitPurchaseInput {
|
|
@@ -1830,6 +1915,93 @@ interface SteamFinalizeResult {
|
|
|
1830
1915
|
reasonCode?: string | null;
|
|
1831
1916
|
raw: Record<string, unknown>;
|
|
1832
1917
|
}
|
|
1918
|
+
/**
|
|
1919
|
+
* Why INVO will not sell a product through Apple right now (`unavailableReason`).
|
|
1920
|
+
* Open-ended: treat any other value as "not available".
|
|
1921
|
+
*
|
|
1922
|
+
* - `APPLE_NOT_VERIFIED`: production has not yet confirmed you own the App Store app
|
|
1923
|
+
* (adding the In-App Purchase API key in the INVO console verifies it at once; so does
|
|
1924
|
+
* any App Store Server Notification).
|
|
1925
|
+
* - `PARTNER_BILLING_NOT_SET_UP`: the developer account has no INVO billing set up.
|
|
1926
|
+
* - `PARTNER_RAIL_SUSPENDED`: the developer account's settlement is suspended.
|
|
1927
|
+
* - `PARTNER_CREDIT_UNAVAILABLE`: no headroom for this product's coins right now.
|
|
1928
|
+
*/
|
|
1929
|
+
type AppleUnavailableReason = "APPLE_NOT_VERIFIED" | "PARTNER_BILLING_NOT_SET_UP" | "PARTNER_RAIL_SUSPENDED" | "PARTNER_CREDIT_UNAVAILABLE" | (string & {});
|
|
1930
|
+
/** One App Store product registered for the game in the INVO console. */
|
|
1931
|
+
interface AppleProduct {
|
|
1932
|
+
/** The App Store Connect product id. Ask StoreKit for exactly these ids. */
|
|
1933
|
+
productId: string;
|
|
1934
|
+
/** Coins the product credits, fixed per product. */
|
|
1935
|
+
coins: number;
|
|
1936
|
+
/** Display label from the console (the product id when none was set). */
|
|
1937
|
+
label: string;
|
|
1938
|
+
/** The US App Store price registered in the console, decimal string, or `null`. */
|
|
1939
|
+
priceUsd: string | null;
|
|
1940
|
+
/** Always `true` here: retired products are not listed. */
|
|
1941
|
+
active: boolean;
|
|
1942
|
+
/** Offer the product only when this is `true`. Apple charges before INVO sees the purchase. */
|
|
1943
|
+
available: boolean;
|
|
1944
|
+
/** Set when `available` is `false`. */
|
|
1945
|
+
unavailableReason: AppleUnavailableReason | null;
|
|
1946
|
+
}
|
|
1947
|
+
interface AppleProductsResult {
|
|
1948
|
+
/** The App Store bundle id registered for the game. */
|
|
1949
|
+
bundleId: string;
|
|
1950
|
+
/** `false` when nothing can be sold right now; `unavailableReason` says why. */
|
|
1951
|
+
canSell: boolean;
|
|
1952
|
+
unavailableReason: AppleUnavailableReason | null;
|
|
1953
|
+
products: AppleProduct[];
|
|
1954
|
+
raw: Record<string, unknown>;
|
|
1955
|
+
}
|
|
1956
|
+
/** The App Store environment of a verified transaction. */
|
|
1957
|
+
type AppleEnvironment = "Production" | "Sandbox" | (string & {});
|
|
1958
|
+
interface VerifyApplePurchaseInput {
|
|
1959
|
+
playerEmail: string;
|
|
1960
|
+
/**
|
|
1961
|
+
* StoreKit 2's `Transaction.jwsRepresentation` (or `VerificationResult.jwsRepresentation`),
|
|
1962
|
+
* sent unchanged. INVO verifies Apple's signature; never decode or trust it yourself first.
|
|
1963
|
+
*/
|
|
1964
|
+
signedTransaction: string;
|
|
1965
|
+
/**
|
|
1966
|
+
* The UUID your game set as `appAccountToken` on the purchase, when it set one. INVO
|
|
1967
|
+
* refuses a transaction whose token differs (`APPLE_ACCOUNT_TOKEN_MISMATCH`).
|
|
1968
|
+
*/
|
|
1969
|
+
appAccountToken?: string;
|
|
1970
|
+
/** Used only when INVO creates the player on this purchase. */
|
|
1971
|
+
playerName?: string;
|
|
1972
|
+
/** Your own JSON, echoed on `purchase.completed` and `purchase.refunded` (`data.metadata`). */
|
|
1973
|
+
metadata?: Record<string, unknown>;
|
|
1974
|
+
}
|
|
1975
|
+
/** `credited`: added by this call. `already_credited`: a replay of a transaction INVO already credited. */
|
|
1976
|
+
type ApplePurchaseStatus = "credited" | "already_credited";
|
|
1977
|
+
interface ApplePurchaseResult {
|
|
1978
|
+
status: ApplePurchaseStatus;
|
|
1979
|
+
orderId: string;
|
|
1980
|
+
/** Apple's `transactionId`. */
|
|
1981
|
+
transactionId: string;
|
|
1982
|
+
productId: string;
|
|
1983
|
+
/** Coins credited for this transaction. */
|
|
1984
|
+
coins: number;
|
|
1985
|
+
/**
|
|
1986
|
+
* The player's balance after the credit, decimal string. On `already_credited` it is
|
|
1987
|
+
* `null` unless the call names the same player the transaction was credited to.
|
|
1988
|
+
*/
|
|
1989
|
+
balance: string | null;
|
|
1990
|
+
environment: AppleEnvironment;
|
|
1991
|
+
/**
|
|
1992
|
+
* `true` only for an App Review (Sandbox) purchase accepted on INVO production. On the INVO
|
|
1993
|
+
* sandbox, where every transaction is a Sandbox one, it is `false`.
|
|
1994
|
+
*/
|
|
1995
|
+
testMode: boolean;
|
|
1996
|
+
/**
|
|
1997
|
+
* Whether to call StoreKit's `Transaction.finish()`: INVO's `finish` flag (`true` on both
|
|
1998
|
+
* success statuses). From an older backend that sends none, `true` for `credited` and
|
|
1999
|
+
* `already_credited`. Prefer `shouldFinishAppleTransaction(resultOrError)`, which also
|
|
2000
|
+
* covers the thrown errors.
|
|
2001
|
+
*/
|
|
2002
|
+
finish: boolean;
|
|
2003
|
+
raw: Record<string, unknown>;
|
|
2004
|
+
}
|
|
1833
2005
|
interface PurchaseItemInput {
|
|
1834
2006
|
/** Idempotency key, unique per game. Required. A duplicate returns 409. */
|
|
1835
2007
|
clientRequestId: string;
|
|
@@ -3802,4 +3974,4 @@ interface RewardsPageLink {
|
|
|
3802
3974
|
raw: Record<string, unknown>;
|
|
3803
3975
|
}
|
|
3804
3976
|
|
|
3805
|
-
export { type AuthHeader as $, type ApproveResult as A, type BalanceResult as B, type CheckoutClientConfig as C, type DestinationGame as D, type EnrollmentBeginResult as E, type InvoHooks as F, type InvoRequestInfo as G, Http as H, InvoError as I, type InvoResponseInfo as J, type LoyaltyCard as K, type LinkDeviceResult as L, type MountCheckoutOptions as M, type LoyaltyCardReward as N, type LoyaltyCardStep as O, type PendingCollectItem as P, type LoyaltyRewardState as Q, type RedeemRewardResult as R, type LoyaltyStepProgress as S, type LoyaltyStepState as T, type LoyaltyVaultEntry as U, type PhoneChangeApproval as V, type WaitForPurchaseInput as W, type PhoneChangeDeviceSignal as X, type PurchaseRefusalReason as Y, type Rail as Z, type VerificationMethod as _, type PurchaseStatusResult as a, type
|
|
3977
|
+
export { type AuthHeader as $, type ApproveResult as A, type BalanceResult as B, type CheckoutClientConfig as C, type DestinationGame as D, type EnrollmentBeginResult as E, type InvoHooks as F, type InvoRequestInfo as G, Http as H, InvoError as I, type InvoResponseInfo as J, type LoyaltyCard as K, type LinkDeviceResult as L, type MountCheckoutOptions as M, type LoyaltyCardReward as N, type LoyaltyCardStep as O, type PendingCollectItem as P, type LoyaltyRewardState as Q, type RedeemRewardResult as R, type LoyaltyStepProgress as S, type LoyaltyStepState as T, type LoyaltyVaultEntry as U, type PhoneChangeApproval as V, type WaitForPurchaseInput as W, type PhoneChangeDeviceSignal as X, type PurchaseRefusalReason as Y, type Rail as Z, type VerificationMethod as _, type PurchaseStatusResult as a, type AppleProductsResult as a$, type ApplePurchaseResult as a0, type PlatformPurchaseInput as a1, type PlatformPurchaseResult as a2, type PlatformApprovalResult as a3, type PlatformOrderStatusResult as a4, type PlatformPurchaseHistoryQuery as a5, type PlatformPurchaseHistoryResult as a6, type PlatformRefundInput as a7, type PlatformRefundResult as a8, type CreateSubscriptionInput as a9, type ServerConfig as aA, type MintPlayerTokenInput as aB, type PlayerToken as aC, type RegisterPlayerInput as aD, type RegisterPlayerResult as aE, type UpdatePlayerPhoneInput as aF, type UpdatePlayerPhoneResult as aG, type RequestPhoneChangeInput as aH, type RequestPhoneChangeResult as aI, type PhoneChangeRequest as aJ, type InitiateSendInput as aK, type InitiateResult as aL, type InitiateTransferInput as aM, type CreateCheckoutInput as aN, type CreateCheckoutResult as aO, type PurchaseInput as aP, type PurchaseResult as aQ, type CurrencyPurchaseQuoteInput as aR, type CurrencyPurchaseQuote as aS, type ConfirmPaymentResult as aT, type OrderDetailsResult as aU, type SteamPacksQuery as aV, type SteamPacksResult as aW, type SteamInitPurchaseInput as aX, type SteamInitPurchaseResult as aY, type SteamFinalizeInput as aZ, type SteamFinalizeResult as a_, type SubscriptionResult as aa, type GetSubscriptionOptions as ab, type GetSubscriptionResult as ac, type ListSubscriptionsOptions as ad, type SubscriptionListResult as ae, type CancelSubscriptionOptions as af, type CancelResult as ag, type ChangeAmountResult as ah, type SetPaymentMethodInput as ai, type SetPaymentMethodResult as aj, type RefundSubscriptionInput as ak, type RefundResult as al, type SteamSubscriptionInitInput as am, type SteamInitResult as an, type SteamFinalizeSubscriptionResult as ao, type CardSetupSessionInput as ap, type CardSetupSessionResult as aq, type CardSetupInput as ar, type CardSetupResult as as, type CardSetupConfirmInput as at, type CardSetupConfirmResult as au, type PlayerCardsResult as av, type SandboxClockResult as aw, type SandboxFailureOutcome as ax, type SandboxForceFailureOptions as ay, type SandboxForceAuthChallengeOptions as az, type PurchaseCredited as b, type RefundInitiation as b$, type VerifyApplePurchaseInput as b0, type PurchaseItemInput as b1, type PurchaseItemResult as b2, type ItemHistoryQuery as b3, type ItemHistoryResult as b4, type ItemOrderQuery as b5, type PlayerActivityQuery as b6, type PlayerActivityResult as b7, type PlayerActivityEntry as b8, type PlayerBalanceQuery as b9, type CompleteDeviceApprovalResult as bA, type AppleEnvironment as bB, type AppleProduct as bC, type ApplePurchaseStatus as bD, type AppleUnavailableReason as bE, type CardSetupStatus as bF, type CheckoutWarning as bG, type CurrencyBalance as bH, type CurrencyPurchaseQuoteBreakdown as bI, type DeviceApprovalChannel as bJ, type DeviceApprovalEnrollment as bK, type DeviceApprovalFlow as bL, type DeviceApprovalPollStatus as bM, type DeviceEnrollmentDecision as bN, type DeviceEnrollmentRespond as bO, type ExpiryReason as bP, type FeeTakenFrom as bQ, type FirstCharge as bR, type FirstChargeStatus as bS, type FundingSource as bT, type InboundPendingItem as bU, type LinkedIdentityEmail as bV, type MinPurchaseWarning as bW, type PhoneChangeConfirmation as bX, type PhoneChangeRequestStatus as bY, type PlatformPurchaseStatus as bZ, type PlayerActivityType as b_, type PlayerBalanceResult as ba, type InboundPendingQuery as bb, type InboundPendingResult as bc, type LinkedIdentitiesQuery as bd, type LinkedIdentitiesResult as be, type SmsVerifyResult as bf, type ClaimTransferInput as bg, type ClaimResult as bh, type ClaimCurrencyInput as bi, type TransactionStatusResult as bj, type GuardianApprovalStatusResult as bk, type ServerDestinationsQuery as bl, type PhoneShareContact as bm, type PhoneShareInitiateResult as bn, type PhoneShareApproveInput as bo, type PhoneShareApproveResult as bp, type PhoneShareStatusResult as bq, type BeginDeviceApprovalInput as br, type DeviceApprovalGrant as bs, type PollDeviceApprovalInput as bt, type DeviceApprovalPollResult as bu, type ConfirmDeviceEnrollmentInput as bv, type ConfirmDeviceEnrollmentResult as bw, type ApproveWithDeviceCodeInput as bx, type DeviceApprovalSettleResult as by, type CompleteDeviceApprovalInput as bz, type PurchaseExpired as c, type RefundPendingApproval as c0, type RefundProcessingFeeBasis as c1, type RefundReceipt as c2, type RefundRevenueShareAttribution as c3, type RefundWarning as c4, type SandboxClockState as c5, type SavedCard as c6, type SteamPack as c7, type SteamUnavailableReason as c8, type SteamUserSession as c9, type Subscription as ca, type SubscriptionBaseInput as cb, type SubscriptionConsent as cc, type SubscriptionConsentInput as cd, type SubscriptionFundingRail as ce, type SubscriptionInterval as cf, type SubscriptionRevenueShare as cg, type SubscriptionRevenueShareInput as ch, type SubscriptionStatus as ci, type UnacknowledgedPurchaseOutcome as cj, isRefundPendingApproval as ck, type PurchaseRefunded as d, type PurchaseRefused as e, type PurchaseStatusInput as f, type CallOptions as g, type CheckoutMountHandle as h, type ClientConfig as i, type ConfirmReceiptResult as j, type PhoneChangeApprovalsResult as k, type ApprovePhoneChangeInput as l, type ApprovePhoneChangeResult as m, type PendingCollectResult as n, type DestinationsQuery as o, type DestinationsResult as p, type LoyaltyCardsResult as q, type LoyaltyVaultResult as r, type RewardsPageLink as s, type EnrollmentVerifyResult as t, type RecoveryBeginResult as u, type RecoveryCompleteResult as v, type BalanceRow as w, type CheckoutPurchaseStatus as x, type ClaimDelivery as y, type InvoErrorInfo as z };
|
|
@@ -867,6 +867,65 @@ declare class InvoError extends Error {
|
|
|
867
867
|
* and send the same request again. Branch on this, not on the message.
|
|
868
868
|
*/
|
|
869
869
|
get isRateLimited(): boolean;
|
|
870
|
+
/**
|
|
871
|
+
* The body's boolean `finish` (additive, 3.35.0), sent on every `verifyApplePurchase`
|
|
872
|
+
* answer: `true` when the game should call StoreKit's `Transaction.finish()` for this
|
|
873
|
+
* refusal (nothing can ever be delivered), `false` when it should leave the transaction
|
|
874
|
+
* unfinished and retry. `undefined` when the body carries none (any other endpoint, an
|
|
875
|
+
* older backend, or a network error); `shouldFinishAppleTransaction(err)` then falls back
|
|
876
|
+
* to the error code.
|
|
877
|
+
*/
|
|
878
|
+
get finish(): boolean | undefined;
|
|
879
|
+
/** Not a genuine Apple transaction (`APPLE_SIGNATURE_INVALID`, 400). Leave it unfinished. */
|
|
880
|
+
get isAppleSignatureInvalid(): boolean;
|
|
881
|
+
/** Another app's transaction: the bundle id (or Apple ID) is not this game's
|
|
882
|
+
* (`APPLE_BUNDLE_MISMATCH`, 400). */
|
|
883
|
+
get isAppleBundleMismatch(): boolean;
|
|
884
|
+
/** The transaction's environment is not accepted here (`APPLE_ENVIRONMENT_NOT_ALLOWED`, 400).
|
|
885
|
+
* The INVO sandbox takes only Sandbox transactions; Xcode StoreKit-testing transactions are
|
|
886
|
+
* never accepted, because Apple does not sign them. */
|
|
887
|
+
get isAppleEnvironmentNotAllowed(): boolean;
|
|
888
|
+
/** Only consumable products buy currency (`APPLE_PRODUCT_TYPE_UNSUPPORTED`, 400). */
|
|
889
|
+
get isAppleProductTypeUnsupported(): boolean;
|
|
890
|
+
/** The product id is not registered for this game (`APPLE_PRODUCT_UNKNOWN`, 400). Register
|
|
891
|
+
* it in the INVO console and retry; keep the transaction unfinished meanwhile. */
|
|
892
|
+
get isAppleProductUnknown(): boolean;
|
|
893
|
+
/** `metadata` was refused (`INVALID_METADATA`, 400). Fix the request and retry. */
|
|
894
|
+
get isInvalidMetadata(): boolean;
|
|
895
|
+
/** A Sandbox purchase on INVO production by an account not on the game's App Review list
|
|
896
|
+
* (`APPLE_REVIEW_ACCOUNT_REQUIRED`, 403). */
|
|
897
|
+
get isAppleReviewAccountRequired(): boolean;
|
|
898
|
+
/** Apple refunded or revoked the transaction (`APPLE_TRANSACTION_REVOKED`, 409). Nothing can
|
|
899
|
+
* ever be delivered for it: **finish it** (`finish: true`). */
|
|
900
|
+
get isAppleTransactionRevoked(): boolean;
|
|
901
|
+
/** The transaction was already credited in another INVO game
|
|
902
|
+
* (`APPLE_TRANSACTION_ALREADY_USED`, 409). Terminal: **finish it** (`finish: true`). */
|
|
903
|
+
get isAppleTransactionAlreadyUsed(): boolean;
|
|
904
|
+
/** Bought before the game sold through INVO (`APPLE_TRANSACTION_TOO_OLD`, 409). Terminal:
|
|
905
|
+
* **finish it** (`finish: true`). */
|
|
906
|
+
get isAppleTransactionTooOld(): boolean;
|
|
907
|
+
/** The product's coins are out of proportion to its signed price, or over the per-purchase
|
|
908
|
+
* maximum (`APPLE_VALUE_EXCEEDS_PRICE`, 409). Fix the product mapping and retry. */
|
|
909
|
+
get isAppleValueExceedsPrice(): boolean;
|
|
910
|
+
/** The transaction's `appAccountToken` is not the one you sent: it was made for a
|
|
911
|
+
* different player (`APPLE_ACCOUNT_TOKEN_MISMATCH`, 409). */
|
|
912
|
+
get isAppleAccountTokenMismatch(): boolean;
|
|
913
|
+
/** The game's Apple configuration is missing or turned off (`APPLE_NOT_CONFIGURED`, 409).
|
|
914
|
+
* Retry once it is set up. */
|
|
915
|
+
get isAppleNotConfigured(): boolean;
|
|
916
|
+
/** Production has not yet confirmed you own the App Store app (`APPLE_NOT_VERIFIED`, 409).
|
|
917
|
+
* Point App Store Server Notifications at INVO; retry once verified. */
|
|
918
|
+
get isAppleNotVerified(): boolean;
|
|
919
|
+
/** Today's App Review purchase cap on production is reached (`APPLE_REVIEW_PURCHASE_LIMIT`,
|
|
920
|
+
* 429). */
|
|
921
|
+
get isAppleReviewPurchaseLimit(): boolean;
|
|
922
|
+
/** Verified and held, not refused (`APPLE_CREDIT_PENDING`, 503): the coins will credit on a
|
|
923
|
+
* later retry. Keep the transaction unfinished and retry; StoreKit also redelivers it. */
|
|
924
|
+
get isAppleCreditPending(): boolean;
|
|
925
|
+
/** A card purchase (`purchaseCurrency`) was made with a key on the Apple rail
|
|
926
|
+
* (`WRONG_RAIL_ENDPOINT`, 400, `status: "use_apple_endpoint"`). Use
|
|
927
|
+
* `verifyApplePurchase` for that key. */
|
|
928
|
+
get isAppleEndpointRequired(): boolean;
|
|
870
929
|
/** `body` as a plain object, or `{}` if it's a string/number/null (non-JSON responses).
|
|
871
930
|
* The `in` operator throws on primitives, so callers must go through this. */
|
|
872
931
|
private bodyObject;
|
|
@@ -1730,7 +1789,26 @@ interface SteamPack {
|
|
|
1730
1789
|
* cache one answer for all players.
|
|
1731
1790
|
*/
|
|
1732
1791
|
currencyAmount: string;
|
|
1792
|
+
/**
|
|
1793
|
+
* Whether INVO will sell THIS pack right now for the developer's billing
|
|
1794
|
+
* (3.36.0). Show only packs with `available: true`; a larger pack can be
|
|
1795
|
+
* unavailable while smaller ones still sell. Advisory: `steamInitPurchase()`
|
|
1796
|
+
* still decides. Absent on an older server: treat absent as available.
|
|
1797
|
+
*/
|
|
1798
|
+
available?: boolean;
|
|
1799
|
+
/** Set when `available` is `false`. */
|
|
1800
|
+
unavailableReason?: SteamUnavailableReason | null;
|
|
1733
1801
|
}
|
|
1802
|
+
/**
|
|
1803
|
+
* Why INVO will not sell a Steam pack right now (`unavailableReason`, 3.36.0).
|
|
1804
|
+
* Open-ended: treat any other value as "not available". All are fixed by the
|
|
1805
|
+
* developer in the INVO console, never by the player.
|
|
1806
|
+
*
|
|
1807
|
+
* - `PARTNER_BILLING_NOT_SET_UP`: the developer account has no INVO billing set up.
|
|
1808
|
+
* - `PARTNER_RAIL_SUSPENDED`: the developer account's settlement is suspended.
|
|
1809
|
+
* - `PARTNER_CREDIT_UNAVAILABLE`: no headroom for this pack right now.
|
|
1810
|
+
*/
|
|
1811
|
+
type SteamUnavailableReason = "PARTNER_BILLING_NOT_SET_UP" | "PARTNER_RAIL_SUSPENDED" | "PARTNER_CREDIT_UNAVAILABLE" | (string & {});
|
|
1734
1812
|
interface SteamPacksQuery {
|
|
1735
1813
|
/**
|
|
1736
1814
|
* The player's 64-bit Steam id. Optional: without it amounts are quoted with
|
|
@@ -1745,6 +1823,13 @@ interface SteamPacksResult {
|
|
|
1745
1823
|
country: string | null;
|
|
1746
1824
|
/** VAT rate (percent, string) the quote used. "0" when none applies. */
|
|
1747
1825
|
vatRatePct: string;
|
|
1826
|
+
/**
|
|
1827
|
+
* `false` when the title can sell nothing on Steam right now;
|
|
1828
|
+
* `unavailableReason` says why (3.36.0). Call `steamPacks()` before showing
|
|
1829
|
+
* the store. Absent on an older server: treat absent as `true`.
|
|
1830
|
+
*/
|
|
1831
|
+
canSell?: boolean;
|
|
1832
|
+
unavailableReason?: SteamUnavailableReason | null;
|
|
1748
1833
|
raw: Record<string, unknown>;
|
|
1749
1834
|
}
|
|
1750
1835
|
interface SteamInitPurchaseInput {
|
|
@@ -1830,6 +1915,93 @@ interface SteamFinalizeResult {
|
|
|
1830
1915
|
reasonCode?: string | null;
|
|
1831
1916
|
raw: Record<string, unknown>;
|
|
1832
1917
|
}
|
|
1918
|
+
/**
|
|
1919
|
+
* Why INVO will not sell a product through Apple right now (`unavailableReason`).
|
|
1920
|
+
* Open-ended: treat any other value as "not available".
|
|
1921
|
+
*
|
|
1922
|
+
* - `APPLE_NOT_VERIFIED`: production has not yet confirmed you own the App Store app
|
|
1923
|
+
* (adding the In-App Purchase API key in the INVO console verifies it at once; so does
|
|
1924
|
+
* any App Store Server Notification).
|
|
1925
|
+
* - `PARTNER_BILLING_NOT_SET_UP`: the developer account has no INVO billing set up.
|
|
1926
|
+
* - `PARTNER_RAIL_SUSPENDED`: the developer account's settlement is suspended.
|
|
1927
|
+
* - `PARTNER_CREDIT_UNAVAILABLE`: no headroom for this product's coins right now.
|
|
1928
|
+
*/
|
|
1929
|
+
type AppleUnavailableReason = "APPLE_NOT_VERIFIED" | "PARTNER_BILLING_NOT_SET_UP" | "PARTNER_RAIL_SUSPENDED" | "PARTNER_CREDIT_UNAVAILABLE" | (string & {});
|
|
1930
|
+
/** One App Store product registered for the game in the INVO console. */
|
|
1931
|
+
interface AppleProduct {
|
|
1932
|
+
/** The App Store Connect product id. Ask StoreKit for exactly these ids. */
|
|
1933
|
+
productId: string;
|
|
1934
|
+
/** Coins the product credits, fixed per product. */
|
|
1935
|
+
coins: number;
|
|
1936
|
+
/** Display label from the console (the product id when none was set). */
|
|
1937
|
+
label: string;
|
|
1938
|
+
/** The US App Store price registered in the console, decimal string, or `null`. */
|
|
1939
|
+
priceUsd: string | null;
|
|
1940
|
+
/** Always `true` here: retired products are not listed. */
|
|
1941
|
+
active: boolean;
|
|
1942
|
+
/** Offer the product only when this is `true`. Apple charges before INVO sees the purchase. */
|
|
1943
|
+
available: boolean;
|
|
1944
|
+
/** Set when `available` is `false`. */
|
|
1945
|
+
unavailableReason: AppleUnavailableReason | null;
|
|
1946
|
+
}
|
|
1947
|
+
interface AppleProductsResult {
|
|
1948
|
+
/** The App Store bundle id registered for the game. */
|
|
1949
|
+
bundleId: string;
|
|
1950
|
+
/** `false` when nothing can be sold right now; `unavailableReason` says why. */
|
|
1951
|
+
canSell: boolean;
|
|
1952
|
+
unavailableReason: AppleUnavailableReason | null;
|
|
1953
|
+
products: AppleProduct[];
|
|
1954
|
+
raw: Record<string, unknown>;
|
|
1955
|
+
}
|
|
1956
|
+
/** The App Store environment of a verified transaction. */
|
|
1957
|
+
type AppleEnvironment = "Production" | "Sandbox" | (string & {});
|
|
1958
|
+
interface VerifyApplePurchaseInput {
|
|
1959
|
+
playerEmail: string;
|
|
1960
|
+
/**
|
|
1961
|
+
* StoreKit 2's `Transaction.jwsRepresentation` (or `VerificationResult.jwsRepresentation`),
|
|
1962
|
+
* sent unchanged. INVO verifies Apple's signature; never decode or trust it yourself first.
|
|
1963
|
+
*/
|
|
1964
|
+
signedTransaction: string;
|
|
1965
|
+
/**
|
|
1966
|
+
* The UUID your game set as `appAccountToken` on the purchase, when it set one. INVO
|
|
1967
|
+
* refuses a transaction whose token differs (`APPLE_ACCOUNT_TOKEN_MISMATCH`).
|
|
1968
|
+
*/
|
|
1969
|
+
appAccountToken?: string;
|
|
1970
|
+
/** Used only when INVO creates the player on this purchase. */
|
|
1971
|
+
playerName?: string;
|
|
1972
|
+
/** Your own JSON, echoed on `purchase.completed` and `purchase.refunded` (`data.metadata`). */
|
|
1973
|
+
metadata?: Record<string, unknown>;
|
|
1974
|
+
}
|
|
1975
|
+
/** `credited`: added by this call. `already_credited`: a replay of a transaction INVO already credited. */
|
|
1976
|
+
type ApplePurchaseStatus = "credited" | "already_credited";
|
|
1977
|
+
interface ApplePurchaseResult {
|
|
1978
|
+
status: ApplePurchaseStatus;
|
|
1979
|
+
orderId: string;
|
|
1980
|
+
/** Apple's `transactionId`. */
|
|
1981
|
+
transactionId: string;
|
|
1982
|
+
productId: string;
|
|
1983
|
+
/** Coins credited for this transaction. */
|
|
1984
|
+
coins: number;
|
|
1985
|
+
/**
|
|
1986
|
+
* The player's balance after the credit, decimal string. On `already_credited` it is
|
|
1987
|
+
* `null` unless the call names the same player the transaction was credited to.
|
|
1988
|
+
*/
|
|
1989
|
+
balance: string | null;
|
|
1990
|
+
environment: AppleEnvironment;
|
|
1991
|
+
/**
|
|
1992
|
+
* `true` only for an App Review (Sandbox) purchase accepted on INVO production. On the INVO
|
|
1993
|
+
* sandbox, where every transaction is a Sandbox one, it is `false`.
|
|
1994
|
+
*/
|
|
1995
|
+
testMode: boolean;
|
|
1996
|
+
/**
|
|
1997
|
+
* Whether to call StoreKit's `Transaction.finish()`: INVO's `finish` flag (`true` on both
|
|
1998
|
+
* success statuses). From an older backend that sends none, `true` for `credited` and
|
|
1999
|
+
* `already_credited`. Prefer `shouldFinishAppleTransaction(resultOrError)`, which also
|
|
2000
|
+
* covers the thrown errors.
|
|
2001
|
+
*/
|
|
2002
|
+
finish: boolean;
|
|
2003
|
+
raw: Record<string, unknown>;
|
|
2004
|
+
}
|
|
1833
2005
|
interface PurchaseItemInput {
|
|
1834
2006
|
/** Idempotency key, unique per game. Required. A duplicate returns 409. */
|
|
1835
2007
|
clientRequestId: string;
|
|
@@ -3802,4 +3974,4 @@ interface RewardsPageLink {
|
|
|
3802
3974
|
raw: Record<string, unknown>;
|
|
3803
3975
|
}
|
|
3804
3976
|
|
|
3805
|
-
export { type AuthHeader as $, type ApproveResult as A, type BalanceResult as B, type CheckoutClientConfig as C, type DestinationGame as D, type EnrollmentBeginResult as E, type InvoHooks as F, type InvoRequestInfo as G, Http as H, InvoError as I, type InvoResponseInfo as J, type LoyaltyCard as K, type LinkDeviceResult as L, type MountCheckoutOptions as M, type LoyaltyCardReward as N, type LoyaltyCardStep as O, type PendingCollectItem as P, type LoyaltyRewardState as Q, type RedeemRewardResult as R, type LoyaltyStepProgress as S, type LoyaltyStepState as T, type LoyaltyVaultEntry as U, type PhoneChangeApproval as V, type WaitForPurchaseInput as W, type PhoneChangeDeviceSignal as X, type PurchaseRefusalReason as Y, type Rail as Z, type VerificationMethod as _, type PurchaseStatusResult as a, type
|
|
3977
|
+
export { type AuthHeader as $, type ApproveResult as A, type BalanceResult as B, type CheckoutClientConfig as C, type DestinationGame as D, type EnrollmentBeginResult as E, type InvoHooks as F, type InvoRequestInfo as G, Http as H, InvoError as I, type InvoResponseInfo as J, type LoyaltyCard as K, type LinkDeviceResult as L, type MountCheckoutOptions as M, type LoyaltyCardReward as N, type LoyaltyCardStep as O, type PendingCollectItem as P, type LoyaltyRewardState as Q, type RedeemRewardResult as R, type LoyaltyStepProgress as S, type LoyaltyStepState as T, type LoyaltyVaultEntry as U, type PhoneChangeApproval as V, type WaitForPurchaseInput as W, type PhoneChangeDeviceSignal as X, type PurchaseRefusalReason as Y, type Rail as Z, type VerificationMethod as _, type PurchaseStatusResult as a, type AppleProductsResult as a$, type ApplePurchaseResult as a0, type PlatformPurchaseInput as a1, type PlatformPurchaseResult as a2, type PlatformApprovalResult as a3, type PlatformOrderStatusResult as a4, type PlatformPurchaseHistoryQuery as a5, type PlatformPurchaseHistoryResult as a6, type PlatformRefundInput as a7, type PlatformRefundResult as a8, type CreateSubscriptionInput as a9, type ServerConfig as aA, type MintPlayerTokenInput as aB, type PlayerToken as aC, type RegisterPlayerInput as aD, type RegisterPlayerResult as aE, type UpdatePlayerPhoneInput as aF, type UpdatePlayerPhoneResult as aG, type RequestPhoneChangeInput as aH, type RequestPhoneChangeResult as aI, type PhoneChangeRequest as aJ, type InitiateSendInput as aK, type InitiateResult as aL, type InitiateTransferInput as aM, type CreateCheckoutInput as aN, type CreateCheckoutResult as aO, type PurchaseInput as aP, type PurchaseResult as aQ, type CurrencyPurchaseQuoteInput as aR, type CurrencyPurchaseQuote as aS, type ConfirmPaymentResult as aT, type OrderDetailsResult as aU, type SteamPacksQuery as aV, type SteamPacksResult as aW, type SteamInitPurchaseInput as aX, type SteamInitPurchaseResult as aY, type SteamFinalizeInput as aZ, type SteamFinalizeResult as a_, type SubscriptionResult as aa, type GetSubscriptionOptions as ab, type GetSubscriptionResult as ac, type ListSubscriptionsOptions as ad, type SubscriptionListResult as ae, type CancelSubscriptionOptions as af, type CancelResult as ag, type ChangeAmountResult as ah, type SetPaymentMethodInput as ai, type SetPaymentMethodResult as aj, type RefundSubscriptionInput as ak, type RefundResult as al, type SteamSubscriptionInitInput as am, type SteamInitResult as an, type SteamFinalizeSubscriptionResult as ao, type CardSetupSessionInput as ap, type CardSetupSessionResult as aq, type CardSetupInput as ar, type CardSetupResult as as, type CardSetupConfirmInput as at, type CardSetupConfirmResult as au, type PlayerCardsResult as av, type SandboxClockResult as aw, type SandboxFailureOutcome as ax, type SandboxForceFailureOptions as ay, type SandboxForceAuthChallengeOptions as az, type PurchaseCredited as b, type RefundInitiation as b$, type VerifyApplePurchaseInput as b0, type PurchaseItemInput as b1, type PurchaseItemResult as b2, type ItemHistoryQuery as b3, type ItemHistoryResult as b4, type ItemOrderQuery as b5, type PlayerActivityQuery as b6, type PlayerActivityResult as b7, type PlayerActivityEntry as b8, type PlayerBalanceQuery as b9, type CompleteDeviceApprovalResult as bA, type AppleEnvironment as bB, type AppleProduct as bC, type ApplePurchaseStatus as bD, type AppleUnavailableReason as bE, type CardSetupStatus as bF, type CheckoutWarning as bG, type CurrencyBalance as bH, type CurrencyPurchaseQuoteBreakdown as bI, type DeviceApprovalChannel as bJ, type DeviceApprovalEnrollment as bK, type DeviceApprovalFlow as bL, type DeviceApprovalPollStatus as bM, type DeviceEnrollmentDecision as bN, type DeviceEnrollmentRespond as bO, type ExpiryReason as bP, type FeeTakenFrom as bQ, type FirstCharge as bR, type FirstChargeStatus as bS, type FundingSource as bT, type InboundPendingItem as bU, type LinkedIdentityEmail as bV, type MinPurchaseWarning as bW, type PhoneChangeConfirmation as bX, type PhoneChangeRequestStatus as bY, type PlatformPurchaseStatus as bZ, type PlayerActivityType as b_, type PlayerBalanceResult as ba, type InboundPendingQuery as bb, type InboundPendingResult as bc, type LinkedIdentitiesQuery as bd, type LinkedIdentitiesResult as be, type SmsVerifyResult as bf, type ClaimTransferInput as bg, type ClaimResult as bh, type ClaimCurrencyInput as bi, type TransactionStatusResult as bj, type GuardianApprovalStatusResult as bk, type ServerDestinationsQuery as bl, type PhoneShareContact as bm, type PhoneShareInitiateResult as bn, type PhoneShareApproveInput as bo, type PhoneShareApproveResult as bp, type PhoneShareStatusResult as bq, type BeginDeviceApprovalInput as br, type DeviceApprovalGrant as bs, type PollDeviceApprovalInput as bt, type DeviceApprovalPollResult as bu, type ConfirmDeviceEnrollmentInput as bv, type ConfirmDeviceEnrollmentResult as bw, type ApproveWithDeviceCodeInput as bx, type DeviceApprovalSettleResult as by, type CompleteDeviceApprovalInput as bz, type PurchaseExpired as c, type RefundPendingApproval as c0, type RefundProcessingFeeBasis as c1, type RefundReceipt as c2, type RefundRevenueShareAttribution as c3, type RefundWarning as c4, type SandboxClockState as c5, type SavedCard as c6, type SteamPack as c7, type SteamUnavailableReason as c8, type SteamUserSession as c9, type Subscription as ca, type SubscriptionBaseInput as cb, type SubscriptionConsent as cc, type SubscriptionConsentInput as cd, type SubscriptionFundingRail as ce, type SubscriptionInterval as cf, type SubscriptionRevenueShare as cg, type SubscriptionRevenueShareInput as ch, type SubscriptionStatus as ci, type UnacknowledgedPurchaseOutcome as cj, isRefundPendingApproval as ck, type PurchaseRefunded as d, type PurchaseRefused as e, type PurchaseStatusInput as f, type CallOptions as g, type CheckoutMountHandle as h, type ClientConfig as i, type ConfirmReceiptResult as j, type PhoneChangeApprovalsResult as k, type ApprovePhoneChangeInput as l, type ApprovePhoneChangeResult as m, type PendingCollectResult as n, type DestinationsQuery as o, type DestinationsResult as p, type LoyaltyCardsResult as q, type LoyaltyVaultResult as r, type RewardsPageLink as s, type EnrollmentVerifyResult as t, type RecoveryBeginResult as u, type RecoveryCompleteResult as v, type BalanceRow as w, type CheckoutPurchaseStatus as x, type ClaimDelivery as y, type InvoErrorInfo as z };
|