Client Surface
Main Factories
Section titled “Main Factories”| Factory | Description |
|---|---|
createTipplyClient(options?) | Creates the authenticated client. |
createTipplyPublicClient(options?) | Creates the public client from tipply-sdk-ts/public. |
Authenticated Client Methods
Section titled “Authenticated Client Methods”| Method | Description |
|---|---|
client.withSession(session) | Clones the client with another session strategy. |
client.withAuthCookie(authCookie) | Clones the client with a static cookie value. |
client.close() | Stops background refresh timers owned by the client. |
Authenticated Namespaces
Section titled “Authenticated Namespaces”medashboardprofilepaymentMethodssettingsgoalstemplatestipsmoderatorsmediawithdrawalsreportstipAlertspublic
See Authenticated Resources for the full method list.
Public Client Surface
Section titled “Public Client Surface”| Method | Returns |
|---|---|
client.user(userId) | PublicUserScope |
client.tipAlerts.fromWidgetUrl(widgetUrl, options?) | TipAlertsListener |
The per-user public methods are documented in Public Resources.
client.user(userId) requires a previously known internal Tipply userId. Public profile reads by slug do not expose it anymore.
Package Exports
Section titled “Package Exports”The main package exports:
createTipplyClient- ID helpers such as
asUserId,asGoalId, andasTipId - all exported error classes
- all exported SDK types
The public entrypoint exports:
createTipplyPublicClient- the same shared ID helpers
- shared types
- shared errors