@bikefinder/api-client 0.1.0 → 0.2.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/README.md +21 -12
- package/dist/generated/index.d.ts +1 -1
- package/dist/generated/index.d.ts.map +1 -1
- package/dist/generated/sdk.gen.d.ts +128 -2
- package/dist/generated/sdk.gen.d.ts.map +1 -1
- package/dist/generated/sdk.gen.js +468 -5
- package/dist/generated/sdk.gen.js.map +1 -1
- package/dist/generated/types.gen.d.ts +1867 -0
- package/dist/generated/types.gen.d.ts.map +1 -1
- package/dist/generated/zod.gen.d.ts +1063 -0
- package/dist/generated/zod.gen.d.ts.map +1 -1
- package/dist/generated/zod.gen.js +801 -0
- package/dist/generated/zod.gen.js.map +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3 -2
- package/dist/index.js.map +1 -1
- package/dist/realtime/watch.d.ts +21 -0
- package/dist/realtime/watch.d.ts.map +1 -0
- package/dist/realtime/{watch-trackers.js → watch.js} +12 -10
- package/dist/realtime/watch.js.map +1 -0
- package/package.json +1 -1
- package/src/generated/index.ts +232 -0
- package/src/generated/sdk.gen.ts +1072 -11
- package/src/generated/types.gen.ts +2215 -42
- package/src/generated/zod.gen.ts +968 -14
- package/src/index.ts +10 -2
- package/src/realtime/watch.ts +151 -0
- package/dist/realtime/watch-trackers.d.ts +0 -10
- package/dist/realtime/watch-trackers.d.ts.map +0 -1
- package/dist/realtime/watch-trackers.js.map +0 -1
- package/src/realtime/watch-trackers.ts +0 -114
package/README.md
CHANGED
|
@@ -2,6 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
TypeScript client for BikeFinder's authenticated API. Hey API generates REST and SSE operations, payload types and Zod validators from the server's OpenAPI document. RxJS adds shared subscriptions and reconnect policy around the generated stream. The package has no Firebase, React or Expo dependency. Configure custom transports on `createBikeFinderClient({ fetch })`; per-request `fetch` overrides are rejected so authentication and transport policy cannot be bypassed.
|
|
4
4
|
|
|
5
|
+
Public npm version `0.1.0` contains the initial tracker metadata API. This checkout is preparing the expanded `0.2.0` candidate: account preferences, notifications, subscriptions, tracker telemetry/history/photos and commands. The new endpoints and matching SDK still need deployment/publication before releasing their app integration. Examples of the expanded operations below describe that candidate.
|
|
6
|
+
|
|
5
7
|
## Use the client
|
|
6
8
|
|
|
7
9
|
```ts
|
|
@@ -32,7 +34,19 @@ subscription.unsubscribe();
|
|
|
32
34
|
|
|
33
35
|
`getToken` supplies the consumer's current Firebase **ID token**, not an Auth0 access token or Firebase custom sign-in token. `true` requests a forced refresh after a rejected token. The SDK gets a current token for every REST call and stream connection and performs at most one forced refresh after a `401`. Provider errors are exposed as `AuthenticationError` without their original message or cause. REST HTTP errors are returned as typed `error` results with an optional `response`; transport, cancellation and token-provider failures reject the promise. Generated validators reject malformed successful JSON responses. A supplied per-call `throwOnError: true` also throws HTTP errors.
|
|
34
36
|
|
|
35
|
-
All endpoint paths, query/path parameters, payload types and validators come from the generated contract. `api.requests` exposes the generated methods, including `getTracker({ path: { trackerId } })
|
|
37
|
+
All endpoint paths, query/path parameters, payload types and validators come from the generated contract. `api.requests` exposes the generated methods, including `getTracker({ path: { trackerId } })`, account and tracker commands, observation/history reads, gallery uploads and native SSE methods. `api.watch(operation, options)` adds sharing, authentication recovery and reconnection around any generated subscription operation; `api.watchTrackers(query)` remains a convenience for tracker pages.
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
const positions = api.watch("subscribeTrackerPositions", {
|
|
41
|
+
path: { trackerId },
|
|
42
|
+
});
|
|
43
|
+
const subscription = positions.subscribe((state) => {
|
|
44
|
+
replacePositions(state.latest, state.lastPrecise);
|
|
45
|
+
});
|
|
46
|
+
subscription.unsubscribe();
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
The API resolves legacy and split device layouts to the same public contracts. Consumers do not select Firestore document paths or inspect layout markers. Existing Firebase paths and callable functions remain available for older app versions; adopting this SDK does not migrate device data. A command being exposed through HTTP does not imply its business logic has moved out of existing backend functions.
|
|
36
50
|
|
|
37
51
|
## Expo and browsers
|
|
38
52
|
|
|
@@ -53,11 +67,11 @@ Expo's [Fetch and Web Streams documentation](https://docs.expo.dev/versions/v57.
|
|
|
53
67
|
|
|
54
68
|
## Realtime behavior
|
|
55
69
|
|
|
56
|
-
A returned observable shares one connection across its subscribers and replays its current snapshot to new subscribers. Reuse that observable when multiple consumers need the same
|
|
70
|
+
A returned observable shares one connection across its subscribers and replays its current snapshot to new subscribers. Reuse that observable when multiple consumers need the same view. Separate calls to `watch` or `watchTrackers` create separate observables. The last unsubscribe cancels the connection and reconnect timer; a later subscription starts fresh. Unsubscribe on logout or account changes, and bind the token provider to that identity so an old subscription cannot reconnect as another user.
|
|
57
71
|
|
|
58
|
-
Each `snapshot` replaces the full
|
|
72
|
+
Each `snapshot` replaces the full subscribed view. Tracker streams are paged: follow every returned cursor to display all trackers, and discard an old tail when a page boundary changes. Position snapshots contain both `latest` and `lastPrecise`; gallery, account preference and subscription streams have their own generated response types. Heartbeats are ignored. The client never sends `Last-Event-ID` or promises historical replay. When disconnected, its internal replay cache is cleared; a new subscriber waits for a fresh snapshot. Existing screens can choose whether to keep their last rendered view while reconnecting.
|
|
59
73
|
|
|
60
|
-
Normal server closure, network errors, HTTP `408`, `429` and `5xx` responses reconnect with a jittered exponential delay capped at 30 seconds. Eight consecutive retries exhaust the budget and error the observable; a valid snapshot resets the budget. Subscribe again to retry after exhaustion. Invalid payloads/content types and other HTTP errors stop immediately. `ApiStreamError` exposes safe `code` and optional HTTP `status` values. Additional snapshot fields are stripped for compatibility; required fields are validated with the generated Zod schema.
|
|
74
|
+
Normal server closure, network errors, HTTP `408`, `429` and `5xx` responses reconnect with a jittered exponential delay capped at 30 seconds. Eight consecutive retries exhaust the budget and error the observable; a valid snapshot resets the budget. Subscribe again to retry after exhaustion. Invalid payloads/content types and other HTTP errors stop immediately. `ApiStreamError` exposes safe `code` and optional HTTP `status` values. Additional snapshot fields are stripped for compatibility; required fields are validated with the generated Zod schema. Generated SSE response types include null for heartbeat payloads; `watch()` emits only validated snapshots. The API closes connections at token expiry or after 15 minutes, so consumers must expect reconnects during normal use.
|
|
61
75
|
|
|
62
76
|
REST requests accept an `AbortSignal` through their normal request options. Realtime connections stop through RxJS unsubscription. Token-provider calls already in progress cannot themselves be cancelled, but no connection is opened after unsubscription.
|
|
63
77
|
|
|
@@ -82,7 +96,7 @@ Source responsibilities:
|
|
|
82
96
|
| `src/options.ts` | Client configuration and authentication-provider boundary |
|
|
83
97
|
| `src/http-client.ts` | Generated client setup and error/interceptor policy |
|
|
84
98
|
| `src/transport.ts` | Shared bearer refresh, origin restriction and Expo transport policy |
|
|
85
|
-
| `src/realtime/` |
|
|
99
|
+
| `src/realtime/` | Generic generated-stream adapter, RxJS sharing, heartbeat filtering and reconnect policy |
|
|
86
100
|
| `src/index.ts` | Public factory and package exports |
|
|
87
101
|
| `tests/` | Authentication, REST, stream/reconnect and cancellation checks |
|
|
88
102
|
|
|
@@ -98,13 +112,8 @@ npm install @bikefinder/api-client@0.1.0
|
|
|
98
112
|
|
|
99
113
|
Remove any previous `@bikefinder:registry=https://npm.pkg.github.com` npm configuration so the scope resolves through the public npm registry. Public installation does not grant access to tracker data: callers still supply an authenticated API token.
|
|
100
114
|
|
|
101
|
-
Change `client/package.json` and its lockfile together, then publish a GitHub release with matching tag `client-v<version>`. The release workflow validates generated output and tests before publishing. Prereleases use the `next` npm tag. Main-branch pushes do not publish npm packages.
|
|
102
|
-
|
|
103
|
-
### Initial npm setup
|
|
115
|
+
Change `client/package.json` and its lockfile together, then publish a GitHub release with matching tag `client-v<version>`. The release workflow validates generated output and tests before publishing. Prereleases use the `next` npm tag. Main-branch pushes do not publish npm packages. The candidate's API deployment and SDK publication are separate prerequisites for its app release; publishing types alone does not deploy endpoints.
|
|
104
116
|
|
|
105
|
-
|
|
106
|
-
2. For the first publication from GitHub Actions, add a short-lived granular npm token with permission to publish this package as the repository Actions secret `NPM_TOKEN`. Direct token publishing requires bypass 2FA permission. Never put credentials in source or chat.
|
|
107
|
-
3. Publish the matching GitHub release. After the package exists, open its npm settings and add a GitHub Actions trusted publisher with organization `bikefinder`, repository `bikefinder-api`, workflow filename `publish-client.yml`, and no environment name. Enable direct `npm publish` for that publisher.
|
|
108
|
-
4. Delete the `NPM_TOKEN` repository secret and revoke the bootstrap token. Subsequent releases use short-lived OIDC credentials through the workflow's `id-token: write` permission. Complete the next successful OIDC publication within npm's two-day validation window after configuring the publisher.
|
|
117
|
+
The package already exists on public npm. Its trusted-publisher configuration uses GitHub organization `bikefinder`, repository `bikefinder-api` and workflow `publish-client.yml`, with no environment name. OIDC publishing uses the workflow's `id-token: write` permission; any bootstrap token should be removed and revoked after trusted publishing is verified.
|
|
109
118
|
|
|
110
119
|
npm's [trusted publishing documentation](https://docs.npmjs.com/trusted-publishers/) describes setup and authentication. The workflow uses Node 24 with a compatible npm CLI. Provenance is not generated for private GitHub repositories; publishing the SDK does not require changing repository visibility. The package remains `UNLICENSED`; public availability does not add an open-source license.
|
|
@@ -1,3 +1,3 @@
|
|
|
1
1
|
export { BikeFinderSdk, type Options } from "./sdk.gen.js";
|
|
2
|
-
export type { ClientOptions, GetHealthData, GetHealthResponse, GetHealthResponses, GetTrackerData, GetTrackerError, GetTrackerErrors, GetTrackerResponse, GetTrackerResponses, HealthStatus, ListTrackersData, ListTrackersError, ListTrackersErrors, ListTrackersResponse, ListTrackersResponses, ProblemDetails, SubscribeTrackersData, SubscribeTrackersError, SubscribeTrackersErrors, SubscribeTrackersResponse, SubscribeTrackersResponses, TrackerPage, TrackerSummary, TrackingMode, } from "./types.gen.js";
|
|
2
|
+
export type { AccountDeletionRequest, AccountNotification, AccountPreferences, BluetoothBatteryRequest, BluetoothCommandReport, BluetoothObservationBattery, BluetoothObservationRequest, BluetoothObservationResult, BluetoothReportingPolicy, CheckTrackerClaimabilityData, CheckTrackerClaimabilityError, CheckTrackerClaimabilityErrors, CheckTrackerClaimabilityResponse, CheckTrackerClaimabilityResponses, ClaimTrackerGuestAccessData, ClaimTrackerGuestAccessError, ClaimTrackerGuestAccessErrors, ClaimTrackerGuestAccessRequest, ClaimTrackerGuestAccessResponse, ClaimTrackerGuestAccessResponses, ClaimTrackerOwnershipData, ClaimTrackerOwnershipError, ClaimTrackerOwnershipErrors, ClaimTrackerOwnershipRequest, ClaimTrackerOwnershipResponse, ClaimTrackerOwnershipResponses, ClientOptions, CommandSuccess, CompleteFirmwareRequest, CompleteTrackerFirmwareUpdateData, CompleteTrackerFirmwareUpdateError, CompleteTrackerFirmwareUpdateErrors, CompleteTrackerFirmwareUpdateResponse, CompleteTrackerFirmwareUpdateResponses, CreateTrackerInvitationData, CreateTrackerInvitationError, CreateTrackerInvitationErrors, CreateTrackerInvitationResponse, CreateTrackerInvitationResponses, DeleteTrackerPhotoData, DeleteTrackerPhotoError, DeleteTrackerPhotoErrors, DeleteTrackerPhotoResponse, DeleteTrackerPhotoResponses, FactoryResetResult, GetAccountPreferencesData, GetAccountPreferencesError, GetAccountPreferencesErrors, GetAccountPreferencesResponse, GetAccountPreferencesResponses, GetBluetoothReportingPolicyData, GetBluetoothReportingPolicyError, GetBluetoothReportingPolicyErrors, GetBluetoothReportingPolicyResponse, GetBluetoothReportingPolicyResponses, GetHealthData, GetHealthResponse, GetHealthResponses, GetTrackerBluetoothCredentialsData, GetTrackerBluetoothCredentialsError, GetTrackerBluetoothCredentialsErrors, GetTrackerBluetoothCredentialsResponse, GetTrackerBluetoothCredentialsResponses, GetTrackerData, GetTrackerError, GetTrackerErrors, GetTrackerFirmwarePlanData, GetTrackerFirmwarePlanError, GetTrackerFirmwarePlanErrors, GetTrackerFirmwarePlanResponse, GetTrackerFirmwarePlanResponses, GetTrackerPositionsData, GetTrackerPositionsError, GetTrackerPositionsErrors, GetTrackerPositionsResponse, GetTrackerPositionsResponses, GetTrackerResponse, GetTrackerResponses, HealthStatus, HistoryPage, IFormFile, LegacyDevicePreferences, LinkTrackerSubscriptionData, LinkTrackerSubscriptionError, LinkTrackerSubscriptionErrors, LinkTrackerSubscriptionResponse, LinkTrackerSubscriptionResponses, ListNotificationsData, ListNotificationsError, ListNotificationsErrors, ListNotificationsResponse, ListNotificationsResponses, ListSubscriptionsData, ListSubscriptionsError, ListSubscriptionsErrors, ListSubscriptionsResponse, ListSubscriptionsResponses, ListTrackerHistoryData, ListTrackerHistoryError, ListTrackerHistoryErrors, ListTrackerHistoryResponse, ListTrackerHistoryResponses, ListTrackerPhotosData, ListTrackerPhotosError, ListTrackerPhotosErrors, ListTrackerPhotosResponse, ListTrackerPhotosResponses, ListTrackersData, ListTrackersError, ListTrackersErrors, ListTrackersResponse, ListTrackersResponses, NotificationPage, PhotoUploadResult, PlanStatus, ProblemDetails, RecordFirmwareAttemptRequest, RecordFirmwareAttemptResult, RecordTrackerFirmwareAttemptData, RecordTrackerFirmwareAttemptError, RecordTrackerFirmwareAttemptErrors, RecordTrackerFirmwareAttemptResponse, RecordTrackerFirmwareAttemptResponses, RegisterPushRegistrationData, RegisterPushRegistrationError, RegisterPushRegistrationErrors, RegisterPushRegistrationRequest, RegisterPushRegistrationResponse, RegisterPushRegistrationResponses, RemovePushRegistrationData, RemovePushRegistrationError, RemovePushRegistrationErrors, RemovePushRegistrationRequest, RemovePushRegistrationResponse, RemovePushRegistrationResponses, RemoveTrackerMembershipData, RemoveTrackerMembershipError, RemoveTrackerMembershipErrors, RemoveTrackerMembershipRequest, RemoveTrackerMembershipResponse, RemoveTrackerMembershipResponses, ReportTrackerBluetoothBatteryData, ReportTrackerBluetoothBatteryError, ReportTrackerBluetoothBatteryErrors, ReportTrackerBluetoothBatteryResponse, ReportTrackerBluetoothBatteryResponses, ReportTrackerBluetoothCommandData, ReportTrackerBluetoothCommandError, ReportTrackerBluetoothCommandErrors, ReportTrackerBluetoothCommandResponse, ReportTrackerBluetoothCommandResponses, ReportTrackerFactoryResetData, ReportTrackerFactoryResetError, ReportTrackerFactoryResetErrors, ReportTrackerFactoryResetResponse, ReportTrackerFactoryResetResponses, RequestAccountDeletionData, RequestAccountDeletionError, RequestAccountDeletionErrors, RequestAccountDeletionResponse, RequestAccountDeletionResponses, RequestTrackerModeData, RequestTrackerModeError, RequestTrackerModeErrors, RequestTrackerModeResponse, RequestTrackerModeResponses, RevokeTrackerInvitationData, RevokeTrackerInvitationError, RevokeTrackerInvitationErrors, RevokeTrackerInvitationResponse, RevokeTrackerInvitationResponses, SubmitTrackerTheftReportData, SubmitTrackerTheftReportError, SubmitTrackerTheftReportErrors, SubmitTrackerTheftReportRequest, SubmitTrackerTheftReportResponse, SubmitTrackerTheftReportResponses, SubscribeAccountPreferencesData, SubscribeAccountPreferencesError, SubscribeAccountPreferencesErrors, SubscribeAccountPreferencesResponse, SubscribeAccountPreferencesResponses, SubscribeSubscriptionsData, SubscribeSubscriptionsError, SubscribeSubscriptionsErrors, SubscribeSubscriptionsResponse, SubscribeSubscriptionsResponses, SubscribeTrackerPhotosData, SubscribeTrackerPhotosError, SubscribeTrackerPhotosErrors, SubscribeTrackerPhotosResponse, SubscribeTrackerPhotosResponses, SubscribeTrackerPositionsData, SubscribeTrackerPositionsError, SubscribeTrackerPositionsErrors, SubscribeTrackerPositionsResponse, SubscribeTrackerPositionsResponses, SubscribeTrackersData, SubscribeTrackersError, SubscribeTrackersErrors, SubscribeTrackersResponse, SubscribeTrackersResponses, SubscriptionChangeRequest, SubscriptionList, SubscriptionPlan, TrackerBattery, TrackerBikeDetails, TrackerBluetoothCredentials, TrackerClaimabilityRequest, TrackerFirmwarePlan, TrackerFirmwareVersions, TrackerInvitation, TrackerModeRequest, TrackerModeResult, TrackerPage, TrackerPhoto, TrackerPhotoList, TrackerPosition, TrackerPositionState, TrackerSubscription, TrackerSummary, TrackerTheftReportResult, TrackingMode, UnlinkTrackerSubscriptionData, UnlinkTrackerSubscriptionError, UnlinkTrackerSubscriptionErrors, UnlinkTrackerSubscriptionResponse, UnlinkTrackerSubscriptionResponses, UpdateAccountPreferencesData, UpdateAccountPreferencesError, UpdateAccountPreferencesErrors, UpdateAccountPreferencesRequest, UpdateAccountPreferencesResponse, UpdateAccountPreferencesResponses, UpdateBluetoothPinRequest, UpdateTrackerBikeData, UpdateTrackerBikeError, UpdateTrackerBikeErrors, UpdateTrackerBikeRequest, UpdateTrackerBikeResponse, UpdateTrackerBikeResponses, UpdateTrackerBluetoothPinData, UpdateTrackerBluetoothPinError, UpdateTrackerBluetoothPinErrors, UpdateTrackerBluetoothPinResponse, UpdateTrackerBluetoothPinResponses, UploadTrackerBluetoothObservationData, UploadTrackerBluetoothObservationError, UploadTrackerBluetoothObservationErrors, UploadTrackerBluetoothObservationResponse, UploadTrackerBluetoothObservationResponses, UploadTrackerPhotoData, UploadTrackerPhotoError, UploadTrackerPhotoErrors, UploadTrackerPhotoResponse, UploadTrackerPhotoResponses, } from "./types.gen.js";
|
|
3
3
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,KAAK,OAAO,EAAE,MAAM,cAAc,CAAC;AAC3D,YAAY,EACV,aAAa,EACb,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,kBAAkB,EAClB,mBAAmB,EACnB,YAAY,EACZ,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,cAAc,EACd,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,WAAW,EACX,cAAc,EACd,YAAY,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/generated/index.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,KAAK,OAAO,EAAE,MAAM,cAAc,CAAC;AAC3D,YAAY,EACV,sBAAsB,EACtB,mBAAmB,EACnB,kBAAkB,EAClB,uBAAuB,EACvB,sBAAsB,EACtB,2BAA2B,EAC3B,2BAA2B,EAC3B,0BAA0B,EAC1B,wBAAwB,EACxB,4BAA4B,EAC5B,6BAA6B,EAC7B,8BAA8B,EAC9B,gCAAgC,EAChC,iCAAiC,EACjC,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAC/B,gCAAgC,EAChC,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,8BAA8B,EAC9B,aAAa,EACb,cAAc,EACd,uBAAuB,EACvB,iCAAiC,EACjC,kCAAkC,EAClC,mCAAmC,EACnC,qCAAqC,EACrC,sCAAsC,EACtC,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,gCAAgC,EAChC,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,2BAA2B,EAC3B,kBAAkB,EAClB,yBAAyB,EACzB,0BAA0B,EAC1B,2BAA2B,EAC3B,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAC/B,gCAAgC,EAChC,iCAAiC,EACjC,mCAAmC,EACnC,oCAAoC,EACpC,aAAa,EACb,iBAAiB,EACjB,kBAAkB,EAClB,kCAAkC,EAClC,mCAAmC,EACnC,oCAAoC,EACpC,sCAAsC,EACtC,uCAAuC,EACvC,cAAc,EACd,eAAe,EACf,gBAAgB,EAChB,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,8BAA8B,EAC9B,+BAA+B,EAC/B,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EACzB,2BAA2B,EAC3B,4BAA4B,EAC5B,kBAAkB,EAClB,mBAAmB,EACnB,YAAY,EACZ,WAAW,EACX,SAAS,EACT,uBAAuB,EACvB,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,gCAAgC,EAChC,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,2BAA2B,EAC3B,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,qBAAqB,EACrB,gBAAgB,EAChB,iBAAiB,EACjB,UAAU,EACV,cAAc,EACd,4BAA4B,EAC5B,2BAA2B,EAC3B,gCAAgC,EAChC,iCAAiC,EACjC,kCAAkC,EAClC,oCAAoC,EACpC,qCAAqC,EACrC,4BAA4B,EAC5B,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAC/B,gCAAgC,EAChC,iCAAiC,EACjC,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAC/B,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAC/B,gCAAgC,EAChC,iCAAiC,EACjC,kCAAkC,EAClC,mCAAmC,EACnC,qCAAqC,EACrC,sCAAsC,EACtC,iCAAiC,EACjC,kCAAkC,EAClC,mCAAmC,EACnC,qCAAqC,EACrC,sCAAsC,EACtC,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAC/B,iCAAiC,EACjC,kCAAkC,EAClC,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,8BAA8B,EAC9B,+BAA+B,EAC/B,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,2BAA2B,EAC3B,2BAA2B,EAC3B,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,gCAAgC,EAChC,4BAA4B,EAC5B,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAC/B,gCAAgC,EAChC,iCAAiC,EACjC,+BAA+B,EAC/B,gCAAgC,EAChC,iCAAiC,EACjC,mCAAmC,EACnC,oCAAoC,EACpC,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,8BAA8B,EAC9B,+BAA+B,EAC/B,0BAA0B,EAC1B,2BAA2B,EAC3B,4BAA4B,EAC5B,8BAA8B,EAC9B,+BAA+B,EAC/B,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAC/B,iCAAiC,EACjC,kCAAkC,EAClC,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,yBAAyB,EACzB,0BAA0B,EAC1B,yBAAyB,EACzB,gBAAgB,EAChB,gBAAgB,EAChB,cAAc,EACd,kBAAkB,EAClB,2BAA2B,EAC3B,0BAA0B,EAC1B,mBAAmB,EACnB,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,iBAAiB,EACjB,WAAW,EACX,YAAY,EACZ,gBAAgB,EAChB,eAAe,EACf,oBAAoB,EACpB,mBAAmB,EACnB,cAAc,EACd,wBAAwB,EACxB,YAAY,EACZ,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAC/B,iCAAiC,EACjC,kCAAkC,EAClC,4BAA4B,EAC5B,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAC/B,gCAAgC,EAChC,iCAAiC,EACjC,yBAAyB,EACzB,qBAAqB,EACrB,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,yBAAyB,EACzB,0BAA0B,EAC1B,6BAA6B,EAC7B,8BAA8B,EAC9B,+BAA+B,EAC/B,iCAAiC,EACjC,kCAAkC,EAClC,qCAAqC,EACrC,sCAAsC,EACtC,uCAAuC,EACvC,yCAAyC,EACzC,0CAA0C,EAC1C,sBAAsB,EACtB,uBAAuB,EACvB,wBAAwB,EACxB,0BAA0B,EAC1B,2BAA2B,GAC5B,MAAM,gBAAgB,CAAC"}
|
|
@@ -1,5 +1,5 @@
|
|
|
1
|
-
import type
|
|
2
|
-
import type { GetHealthData, GetHealthResponses, GetTrackerData, GetTrackerErrors, GetTrackerResponses, ListTrackersData, ListTrackersErrors, ListTrackersResponses, SubscribeTrackersData, SubscribeTrackersResponse, SubscribeTrackersResponses } from "./types.gen.js";
|
|
1
|
+
import { type Client, type ClientMeta, type Options as Options2, type RequestResult, type ServerSentEventsResult, type TDataShape } from "./client/index.js";
|
|
2
|
+
import type { CheckTrackerClaimabilityData, CheckTrackerClaimabilityErrors, CheckTrackerClaimabilityResponses, ClaimTrackerGuestAccessData, ClaimTrackerGuestAccessErrors, ClaimTrackerGuestAccessResponses, ClaimTrackerOwnershipData, ClaimTrackerOwnershipErrors, ClaimTrackerOwnershipResponses, CompleteTrackerFirmwareUpdateData, CompleteTrackerFirmwareUpdateErrors, CompleteTrackerFirmwareUpdateResponses, CreateTrackerInvitationData, CreateTrackerInvitationErrors, CreateTrackerInvitationResponses, DeleteTrackerPhotoData, DeleteTrackerPhotoErrors, DeleteTrackerPhotoResponses, GetAccountPreferencesData, GetAccountPreferencesErrors, GetAccountPreferencesResponses, GetBluetoothReportingPolicyData, GetBluetoothReportingPolicyErrors, GetBluetoothReportingPolicyResponses, GetHealthData, GetHealthResponses, GetTrackerBluetoothCredentialsData, GetTrackerBluetoothCredentialsErrors, GetTrackerBluetoothCredentialsResponses, GetTrackerData, GetTrackerErrors, GetTrackerFirmwarePlanData, GetTrackerFirmwarePlanErrors, GetTrackerFirmwarePlanResponses, GetTrackerPositionsData, GetTrackerPositionsErrors, GetTrackerPositionsResponses, GetTrackerResponses, LinkTrackerSubscriptionData, LinkTrackerSubscriptionErrors, LinkTrackerSubscriptionResponses, ListNotificationsData, ListNotificationsErrors, ListNotificationsResponses, ListSubscriptionsData, ListSubscriptionsErrors, ListSubscriptionsResponses, ListTrackerHistoryData, ListTrackerHistoryErrors, ListTrackerHistoryResponses, ListTrackerPhotosData, ListTrackerPhotosErrors, ListTrackerPhotosResponses, ListTrackersData, ListTrackersErrors, ListTrackersResponses, RecordTrackerFirmwareAttemptData, RecordTrackerFirmwareAttemptErrors, RecordTrackerFirmwareAttemptResponses, RegisterPushRegistrationData, RegisterPushRegistrationErrors, RegisterPushRegistrationResponses, RemovePushRegistrationData, RemovePushRegistrationErrors, RemovePushRegistrationResponses, RemoveTrackerMembershipData, RemoveTrackerMembershipErrors, RemoveTrackerMembershipResponses, ReportTrackerBluetoothBatteryData, ReportTrackerBluetoothBatteryErrors, ReportTrackerBluetoothBatteryResponses, ReportTrackerBluetoothCommandData, ReportTrackerBluetoothCommandErrors, ReportTrackerBluetoothCommandResponses, ReportTrackerFactoryResetData, ReportTrackerFactoryResetErrors, ReportTrackerFactoryResetResponses, RequestAccountDeletionData, RequestAccountDeletionErrors, RequestAccountDeletionResponses, RequestTrackerModeData, RequestTrackerModeErrors, RequestTrackerModeResponses, RevokeTrackerInvitationData, RevokeTrackerInvitationErrors, RevokeTrackerInvitationResponses, SubmitTrackerTheftReportData, SubmitTrackerTheftReportErrors, SubmitTrackerTheftReportResponses, SubscribeAccountPreferencesData, SubscribeAccountPreferencesResponse, SubscribeAccountPreferencesResponses, SubscribeSubscriptionsData, SubscribeSubscriptionsResponse, SubscribeSubscriptionsResponses, SubscribeTrackerPhotosData, SubscribeTrackerPhotosResponse, SubscribeTrackerPhotosResponses, SubscribeTrackerPositionsData, SubscribeTrackerPositionsResponse, SubscribeTrackerPositionsResponses, SubscribeTrackersData, SubscribeTrackersResponse, SubscribeTrackersResponses, UnlinkTrackerSubscriptionData, UnlinkTrackerSubscriptionErrors, UnlinkTrackerSubscriptionResponses, UpdateAccountPreferencesData, UpdateAccountPreferencesErrors, UpdateAccountPreferencesResponses, UpdateTrackerBikeData, UpdateTrackerBikeErrors, UpdateTrackerBikeResponses, UpdateTrackerBluetoothPinData, UpdateTrackerBluetoothPinErrors, UpdateTrackerBluetoothPinResponses, UploadTrackerBluetoothObservationData, UploadTrackerBluetoothObservationErrors, UploadTrackerBluetoothObservationResponses, UploadTrackerPhotoData, UploadTrackerPhotoErrors, UploadTrackerPhotoResponses } from "./types.gen.js";
|
|
3
3
|
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
@@ -32,6 +32,15 @@ export declare class BikeFinderSdk extends HeyApiClient {
|
|
|
32
32
|
key?: string;
|
|
33
33
|
});
|
|
34
34
|
getHealth<ThrowOnError extends boolean = false>(options?: Options<GetHealthData, ThrowOnError>): RequestResult<GetHealthResponses, unknown, ThrowOnError>;
|
|
35
|
+
/**
|
|
36
|
+
* Get Bluetooth observation reporting policy
|
|
37
|
+
*/
|
|
38
|
+
getBluetoothReportingPolicy<ThrowOnError extends boolean = false>(options?: Options<GetBluetoothReportingPolicyData, ThrowOnError>): RequestResult<GetBluetoothReportingPolicyResponses, GetBluetoothReportingPolicyErrors, ThrowOnError>;
|
|
39
|
+
unlinkTrackerSubscription<ThrowOnError extends boolean = false>(options: Options<UnlinkTrackerSubscriptionData, ThrowOnError>): RequestResult<UnlinkTrackerSubscriptionResponses, UnlinkTrackerSubscriptionErrors, ThrowOnError>;
|
|
40
|
+
linkTrackerSubscription<ThrowOnError extends boolean = false>(options: Options<LinkTrackerSubscriptionData, ThrowOnError>): RequestResult<LinkTrackerSubscriptionResponses, LinkTrackerSubscriptionErrors, ThrowOnError>;
|
|
41
|
+
listTrackerPhotos<ThrowOnError extends boolean = false>(options: Options<ListTrackerPhotosData, ThrowOnError>): RequestResult<ListTrackerPhotosResponses, ListTrackerPhotosErrors, ThrowOnError>;
|
|
42
|
+
uploadTrackerPhoto<ThrowOnError extends boolean = false>(options: Options<UploadTrackerPhotoData, ThrowOnError>): RequestResult<UploadTrackerPhotoResponses, UploadTrackerPhotoErrors, ThrowOnError>;
|
|
43
|
+
deleteTrackerPhoto<ThrowOnError extends boolean = false>(options: Options<DeleteTrackerPhotoData, ThrowOnError>): RequestResult<DeleteTrackerPhotoResponses, DeleteTrackerPhotoErrors, ThrowOnError>;
|
|
35
44
|
/**
|
|
36
45
|
* List the caller's active trackers
|
|
37
46
|
*/
|
|
@@ -46,6 +55,123 @@ export declare class BikeFinderSdk extends HeyApiClient {
|
|
|
46
55
|
* Get an actively shared tracker
|
|
47
56
|
*/
|
|
48
57
|
getTracker<ThrowOnError extends boolean = false>(options: Options<GetTrackerData, ThrowOnError>): RequestResult<GetTrackerResponses, GetTrackerErrors, ThrowOnError>;
|
|
58
|
+
getTrackerPositions<ThrowOnError extends boolean = false>(options: Options<GetTrackerPositionsData, ThrowOnError>): RequestResult<GetTrackerPositionsResponses, GetTrackerPositionsErrors, ThrowOnError>;
|
|
59
|
+
subscribeTrackerPositions<ThrowOnError extends boolean = false>(options: Options<SubscribeTrackerPositionsData, ThrowOnError, SubscribeTrackerPositionsResponse>): Promise<ServerSentEventsResult<SubscribeTrackerPositionsResponses>>;
|
|
60
|
+
subscribeTrackerPhotos<ThrowOnError extends boolean = false>(options: Options<SubscribeTrackerPhotosData, ThrowOnError, SubscribeTrackerPhotosResponse>): Promise<ServerSentEventsResult<SubscribeTrackerPhotosResponses>>;
|
|
61
|
+
/**
|
|
62
|
+
* Request Tracker Mode
|
|
63
|
+
*/
|
|
64
|
+
requestTrackerMode<ThrowOnError extends boolean = false>(options: Options<RequestTrackerModeData, ThrowOnError>): RequestResult<RequestTrackerModeResponses, RequestTrackerModeErrors, ThrowOnError>;
|
|
65
|
+
/**
|
|
66
|
+
* Check Tracker Claimability
|
|
67
|
+
*/
|
|
68
|
+
checkTrackerClaimability<ThrowOnError extends boolean = false>(options: Options<CheckTrackerClaimabilityData, ThrowOnError>): RequestResult<CheckTrackerClaimabilityResponses, CheckTrackerClaimabilityErrors, ThrowOnError>;
|
|
69
|
+
/**
|
|
70
|
+
* Claim Tracker Ownership
|
|
71
|
+
*/
|
|
72
|
+
claimTrackerOwnership<ThrowOnError extends boolean = false>(options: Options<ClaimTrackerOwnershipData, ThrowOnError>): RequestResult<ClaimTrackerOwnershipResponses, ClaimTrackerOwnershipErrors, ThrowOnError>;
|
|
73
|
+
/**
|
|
74
|
+
* Claim Tracker Guest Access
|
|
75
|
+
*/
|
|
76
|
+
claimTrackerGuestAccess<ThrowOnError extends boolean = false>(options: Options<ClaimTrackerGuestAccessData, ThrowOnError>): RequestResult<ClaimTrackerGuestAccessResponses, ClaimTrackerGuestAccessErrors, ThrowOnError>;
|
|
77
|
+
/**
|
|
78
|
+
* Create Tracker Invitation
|
|
79
|
+
*/
|
|
80
|
+
createTrackerInvitation<ThrowOnError extends boolean = false>(options: Options<CreateTrackerInvitationData, ThrowOnError>): RequestResult<CreateTrackerInvitationResponses, CreateTrackerInvitationErrors, ThrowOnError>;
|
|
81
|
+
/**
|
|
82
|
+
* Revoke Tracker Invitation
|
|
83
|
+
*/
|
|
84
|
+
revokeTrackerInvitation<ThrowOnError extends boolean = false>(options: Options<RevokeTrackerInvitationData, ThrowOnError>): RequestResult<RevokeTrackerInvitationResponses, RevokeTrackerInvitationErrors, ThrowOnError>;
|
|
85
|
+
/**
|
|
86
|
+
* Remove Tracker Membership
|
|
87
|
+
*/
|
|
88
|
+
removeTrackerMembership<ThrowOnError extends boolean = false>(options: Options<RemoveTrackerMembershipData, ThrowOnError>): RequestResult<RemoveTrackerMembershipResponses, RemoveTrackerMembershipErrors, ThrowOnError>;
|
|
89
|
+
/**
|
|
90
|
+
* Update Tracker Bike
|
|
91
|
+
*/
|
|
92
|
+
updateTrackerBike<ThrowOnError extends boolean = false>(options: Options<UpdateTrackerBikeData, ThrowOnError>): RequestResult<UpdateTrackerBikeResponses, UpdateTrackerBikeErrors, ThrowOnError>;
|
|
93
|
+
/**
|
|
94
|
+
* Submit Tracker Theft Report
|
|
95
|
+
*/
|
|
96
|
+
submitTrackerTheftReport<ThrowOnError extends boolean = false>(options: Options<SubmitTrackerTheftReportData, ThrowOnError>): RequestResult<SubmitTrackerTheftReportResponses, SubmitTrackerTheftReportErrors, ThrowOnError>;
|
|
97
|
+
/**
|
|
98
|
+
* Get Tracker Bluetooth Credentials
|
|
99
|
+
*/
|
|
100
|
+
getTrackerBluetoothCredentials<ThrowOnError extends boolean = false>(options: Options<GetTrackerBluetoothCredentialsData, ThrowOnError>): RequestResult<GetTrackerBluetoothCredentialsResponses, GetTrackerBluetoothCredentialsErrors, ThrowOnError>;
|
|
101
|
+
/**
|
|
102
|
+
* Update Tracker Bluetooth Pin
|
|
103
|
+
*/
|
|
104
|
+
updateTrackerBluetoothPin<ThrowOnError extends boolean = false>(options: Options<UpdateTrackerBluetoothPinData, ThrowOnError>): RequestResult<UpdateTrackerBluetoothPinResponses, UpdateTrackerBluetoothPinErrors, ThrowOnError>;
|
|
105
|
+
/**
|
|
106
|
+
* Report Tracker Bluetooth Battery
|
|
107
|
+
*/
|
|
108
|
+
reportTrackerBluetoothBattery<ThrowOnError extends boolean = false>(options: Options<ReportTrackerBluetoothBatteryData, ThrowOnError>): RequestResult<ReportTrackerBluetoothBatteryResponses, ReportTrackerBluetoothBatteryErrors, ThrowOnError>;
|
|
109
|
+
/**
|
|
110
|
+
* Report Tracker Bluetooth Command
|
|
111
|
+
*/
|
|
112
|
+
reportTrackerBluetoothCommand<ThrowOnError extends boolean = false>(options: Options<ReportTrackerBluetoothCommandData, ThrowOnError>): RequestResult<ReportTrackerBluetoothCommandResponses, ReportTrackerBluetoothCommandErrors, ThrowOnError>;
|
|
113
|
+
/**
|
|
114
|
+
* Upload Tracker Bluetooth Observation
|
|
115
|
+
*/
|
|
116
|
+
uploadTrackerBluetoothObservation<ThrowOnError extends boolean = false>(options: Options<UploadTrackerBluetoothObservationData, ThrowOnError>): RequestResult<UploadTrackerBluetoothObservationResponses, UploadTrackerBluetoothObservationErrors, ThrowOnError>;
|
|
117
|
+
/**
|
|
118
|
+
* Report Tracker Factory Reset
|
|
119
|
+
*/
|
|
120
|
+
reportTrackerFactoryReset<ThrowOnError extends boolean = false>(options: Options<ReportTrackerFactoryResetData, ThrowOnError>): RequestResult<ReportTrackerFactoryResetResponses, ReportTrackerFactoryResetErrors, ThrowOnError>;
|
|
121
|
+
/**
|
|
122
|
+
* Get Tracker Firmware Plan
|
|
123
|
+
*/
|
|
124
|
+
getTrackerFirmwarePlan<ThrowOnError extends boolean = false>(options: Options<GetTrackerFirmwarePlanData, ThrowOnError>): RequestResult<GetTrackerFirmwarePlanResponses, GetTrackerFirmwarePlanErrors, ThrowOnError>;
|
|
125
|
+
/**
|
|
126
|
+
* Complete Tracker Firmware Update
|
|
127
|
+
*/
|
|
128
|
+
completeTrackerFirmwareUpdate<ThrowOnError extends boolean = false>(options: Options<CompleteTrackerFirmwareUpdateData, ThrowOnError>): RequestResult<CompleteTrackerFirmwareUpdateResponses, CompleteTrackerFirmwareUpdateErrors, ThrowOnError>;
|
|
129
|
+
/**
|
|
130
|
+
* Record Tracker Firmware Attempt
|
|
131
|
+
*/
|
|
132
|
+
recordTrackerFirmwareAttempt<ThrowOnError extends boolean = false>(options: Options<RecordTrackerFirmwareAttemptData, ThrowOnError>): RequestResult<RecordTrackerFirmwareAttemptResponses, RecordTrackerFirmwareAttemptErrors, ThrowOnError>;
|
|
133
|
+
/**
|
|
134
|
+
* Read the signed-in account's preferences
|
|
135
|
+
*/
|
|
136
|
+
getAccountPreferences<ThrowOnError extends boolean = false>(options?: Options<GetAccountPreferencesData, ThrowOnError>): RequestResult<GetAccountPreferencesResponses, GetAccountPreferencesErrors, ThrowOnError>;
|
|
137
|
+
/**
|
|
138
|
+
* Update account language and notification preferences
|
|
139
|
+
*/
|
|
140
|
+
updateAccountPreferences<ThrowOnError extends boolean = false>(options: Options<UpdateAccountPreferencesData, ThrowOnError>): RequestResult<UpdateAccountPreferencesResponses, UpdateAccountPreferencesErrors, ThrowOnError>;
|
|
141
|
+
/**
|
|
142
|
+
* Subscribe to the signed-in account's preferences
|
|
143
|
+
*
|
|
144
|
+
* Snapshot events contain account preferences; keepalive events contain null. Reconnect with a refreshed bearer token after closure.
|
|
145
|
+
*/
|
|
146
|
+
subscribeAccountPreferences<ThrowOnError extends boolean = false>(options?: Options<SubscribeAccountPreferencesData, ThrowOnError, SubscribeAccountPreferencesResponse>): Promise<ServerSentEventsResult<SubscribeAccountPreferencesResponses>>;
|
|
147
|
+
/**
|
|
148
|
+
* Remove this phone's push registrations
|
|
149
|
+
*/
|
|
150
|
+
removePushRegistration<ThrowOnError extends boolean = false>(options: Options<RemovePushRegistrationData, ThrowOnError>): RequestResult<RemovePushRegistrationResponses, RemovePushRegistrationErrors, ThrowOnError>;
|
|
151
|
+
/**
|
|
152
|
+
* Register this phone for push notifications
|
|
153
|
+
*/
|
|
154
|
+
registerPushRegistration<ThrowOnError extends boolean = false>(options: Options<RegisterPushRegistrationData, ThrowOnError>): RequestResult<RegisterPushRegistrationResponses, RegisterPushRegistrationErrors, ThrowOnError>;
|
|
155
|
+
/**
|
|
156
|
+
* Submit an account deletion request
|
|
157
|
+
*
|
|
158
|
+
* Records a request for review. Acceptance does not immediately delete the account.
|
|
159
|
+
*/
|
|
160
|
+
requestAccountDeletion<ThrowOnError extends boolean = false>(options?: Options<RequestAccountDeletionData, ThrowOnError>): RequestResult<RequestAccountDeletionResponses, RequestAccountDeletionErrors, ThrowOnError>;
|
|
161
|
+
/**
|
|
162
|
+
* Read one page of tracker position history
|
|
163
|
+
*
|
|
164
|
+
* Returns up to 100 raw records per page, filtering unavailable fixes. startMs is inclusive and endMs exclusive, both Unix milliseconds. Advance using nextCursor even when a page has no usable positions.
|
|
165
|
+
*/
|
|
166
|
+
listTrackerHistory<ThrowOnError extends boolean = false>(options: Options<ListTrackerHistoryData, ThrowOnError>): RequestResult<ListTrackerHistoryResponses, ListTrackerHistoryErrors, ThrowOnError>;
|
|
167
|
+
/**
|
|
168
|
+
* Read account and owned subscription notification history
|
|
169
|
+
*
|
|
170
|
+
* Sources are selected by the server from account ownership. Empty or failed notifications are hidden, but nextCursor still advances through them.
|
|
171
|
+
*/
|
|
172
|
+
listNotifications<ThrowOnError extends boolean = false>(options?: Options<ListNotificationsData, ThrowOnError>): RequestResult<ListNotificationsResponses, ListNotificationsErrors, ThrowOnError>;
|
|
173
|
+
listSubscriptions<ThrowOnError extends boolean = false>(options?: Options<ListSubscriptionsData, ThrowOnError>): RequestResult<ListSubscriptionsResponses, ListSubscriptionsErrors, ThrowOnError>;
|
|
174
|
+
subscribeSubscriptions<ThrowOnError extends boolean = false>(options?: Options<SubscribeSubscriptionsData, ThrowOnError, SubscribeSubscriptionsResponse>): Promise<ServerSentEventsResult<SubscribeSubscriptionsResponses>>;
|
|
49
175
|
}
|
|
50
176
|
export {};
|
|
51
177
|
//# sourceMappingURL=sdk.gen.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sdk.gen.d.ts","sourceRoot":"","sources":["../../src/generated/sdk.gen.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,
|
|
1
|
+
{"version":3,"file":"sdk.gen.d.ts","sourceRoot":"","sources":["../../src/generated/sdk.gen.ts"],"names":[],"mappings":"AAGA,OAAO,EACL,KAAK,MAAM,EACX,KAAK,UAAU,EAEf,KAAK,OAAO,IAAI,QAAQ,EACxB,KAAK,aAAa,EAClB,KAAK,sBAAsB,EAC3B,KAAK,UAAU,EAChB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EACV,4BAA4B,EAC5B,8BAA8B,EAC9B,iCAAiC,EACjC,2BAA2B,EAC3B,6BAA6B,EAC7B,gCAAgC,EAChC,yBAAyB,EACzB,2BAA2B,EAC3B,8BAA8B,EAC9B,iCAAiC,EACjC,mCAAmC,EACnC,sCAAsC,EACtC,2BAA2B,EAC3B,6BAA6B,EAC7B,gCAAgC,EAChC,sBAAsB,EACtB,wBAAwB,EACxB,2BAA2B,EAC3B,yBAAyB,EACzB,2BAA2B,EAC3B,8BAA8B,EAC9B,+BAA+B,EAC/B,iCAAiC,EACjC,oCAAoC,EACpC,aAAa,EACb,kBAAkB,EAClB,kCAAkC,EAClC,oCAAoC,EACpC,uCAAuC,EACvC,cAAc,EACd,gBAAgB,EAChB,0BAA0B,EAC1B,4BAA4B,EAC5B,+BAA+B,EAC/B,uBAAuB,EACvB,yBAAyB,EACzB,4BAA4B,EAC5B,mBAAmB,EACnB,2BAA2B,EAC3B,6BAA6B,EAC7B,gCAAgC,EAChC,qBAAqB,EACrB,uBAAuB,EACvB,0BAA0B,EAC1B,qBAAqB,EACrB,uBAAuB,EACvB,0BAA0B,EAC1B,sBAAsB,EACtB,wBAAwB,EACxB,2BAA2B,EAC3B,qBAAqB,EACrB,uBAAuB,EACvB,0BAA0B,EAC1B,gBAAgB,EAChB,kBAAkB,EAClB,qBAAqB,EACrB,gCAAgC,EAChC,kCAAkC,EAClC,qCAAqC,EACrC,4BAA4B,EAC5B,8BAA8B,EAC9B,iCAAiC,EACjC,0BAA0B,EAC1B,4BAA4B,EAC5B,+BAA+B,EAC/B,2BAA2B,EAC3B,6BAA6B,EAC7B,gCAAgC,EAChC,iCAAiC,EACjC,mCAAmC,EACnC,sCAAsC,EACtC,iCAAiC,EACjC,mCAAmC,EACnC,sCAAsC,EACtC,6BAA6B,EAC7B,+BAA+B,EAC/B,kCAAkC,EAClC,0BAA0B,EAC1B,4BAA4B,EAC5B,+BAA+B,EAC/B,sBAAsB,EACtB,wBAAwB,EACxB,2BAA2B,EAC3B,2BAA2B,EAC3B,6BAA6B,EAC7B,gCAAgC,EAChC,4BAA4B,EAC5B,8BAA8B,EAC9B,iCAAiC,EACjC,+BAA+B,EAE/B,mCAAmC,EACnC,oCAAoC,EACpC,0BAA0B,EAE1B,8BAA8B,EAC9B,+BAA+B,EAC/B,0BAA0B,EAE1B,8BAA8B,EAC9B,+BAA+B,EAC/B,6BAA6B,EAE7B,iCAAiC,EACjC,kCAAkC,EAClC,qBAAqB,EAErB,yBAAyB,EACzB,0BAA0B,EAC1B,6BAA6B,EAC7B,+BAA+B,EAC/B,kCAAkC,EAClC,4BAA4B,EAC5B,8BAA8B,EAC9B,iCAAiC,EACjC,qBAAqB,EACrB,uBAAuB,EACvB,0BAA0B,EAC1B,6BAA6B,EAC7B,+BAA+B,EAC/B,kCAAkC,EAClC,qCAAqC,EACrC,uCAAuC,EACvC,0CAA0C,EAC1C,sBAAsB,EACtB,wBAAwB,EACxB,2BAA2B,EAC5B,MAAM,gBAAgB,CAAC;AA6CxB,MAAM,MAAM,OAAO,CACjB,KAAK,SAAS,UAAU,GAAG,UAAU,EACrC,YAAY,SAAS,OAAO,GAAG,OAAO,EACtC,SAAS,GAAG,OAAO,IACjB,QAAQ,CAAC,KAAK,EAAE,YAAY,EAAE,SAAS,CAAC,GAAG;IAC7C;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB;;;OAGG;IACH,IAAI,CAAC,EAAE,MAAM,UAAU,SAAS,KAAK,GAAG,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAAG,UAAU,CAAC;CAC9E,CAAC;AAEF,cAAM,YAAY;IAChB,SAAS,CAAC,MAAM,EAAE,MAAM,CAAC;gBAEb,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAA;KAAE;CAGvC;AAED,cAAM,cAAc,CAAC,CAAC;IACpB,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAa;IAExC,OAAO,CAAC,QAAQ,CAAC,SAAS,CAA6B;IAEvD,GAAG,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC;IAUpB,GAAG,CAAC,KAAK,EAAE,CAAC,EAAE,GAAG,CAAC,EAAE,MAAM,GAAG,IAAI;CAGlC;AAED,qBAAa,aAAc,SAAQ,YAAY;IAC7C,gBAAuB,UAAU,EAAE,cAAc,CAAC,aAAa,CAAC,CAC1B;gBAE1B,IAAI,CAAC,EAAE;QAAE,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,GAAG,CAAC,EAAE,MAAM,CAAA;KAAE;IAK7C,SAAS,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACnD,OAAO,CAAC,EAAE,OAAO,CAAC,aAAa,EAAE,YAAY,CAAC,GAC7C,aAAa,CAAC,kBAAkB,EAAE,OAAO,EAAE,YAAY,CAAC;IAa3D;;OAEG;IACI,2BAA2B,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACrE,OAAO,CAAC,EAAE,OAAO,CAAC,+BAA+B,EAAE,YAAY,CAAC,GAC/D,aAAa,CACd,oCAAoC,EACpC,iCAAiC,EACjC,YAAY,CACb;IAcM,yBAAyB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACnE,OAAO,EAAE,OAAO,CAAC,6BAA6B,EAAE,YAAY,CAAC,GAC5D,aAAa,CACd,kCAAkC,EAClC,+BAA+B,EAC/B,YAAY,CACb;IAkBM,uBAAuB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACjE,OAAO,EAAE,OAAO,CAAC,2BAA2B,EAAE,YAAY,CAAC,GAC1D,aAAa,CACd,gCAAgC,EAChC,6BAA6B,EAC7B,YAAY,CACb;IAkBM,iBAAiB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC3D,OAAO,EAAE,OAAO,CAAC,qBAAqB,EAAE,YAAY,CAAC,GACpD,aAAa,CACd,0BAA0B,EAC1B,uBAAuB,EACvB,YAAY,CACb;IAcM,kBAAkB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC5D,OAAO,EAAE,OAAO,CAAC,sBAAsB,EAAE,YAAY,CAAC,GACrD,aAAa,CACd,2BAA2B,EAC3B,wBAAwB,EACxB,YAAY,CACb;IAmBM,kBAAkB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC5D,OAAO,EAAE,OAAO,CAAC,sBAAsB,EAAE,YAAY,CAAC,GACrD,aAAa,CACd,2BAA2B,EAC3B,wBAAwB,EACxB,YAAY,CACb;IAcD;;OAEG;IACI,YAAY,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACtD,OAAO,CAAC,EAAE,OAAO,CAAC,gBAAgB,EAAE,YAAY,CAAC,GAChD,aAAa,CAAC,qBAAqB,EAAE,kBAAkB,EAAE,YAAY,CAAC;IAczE;;;;OAIG;IACI,iBAAiB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC3D,OAAO,CAAC,EAAE,OAAO,CACf,qBAAqB,EACrB,YAAY,EACZ,yBAAyB,CAC1B,GACA,OAAO,CAAC,sBAAsB,CAAC,0BAA0B,CAAC,CAAC;IAc9D;;OAEG;IACI,UAAU,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACpD,OAAO,EAAE,OAAO,CAAC,cAAc,EAAE,YAAY,CAAC,GAC7C,aAAa,CAAC,mBAAmB,EAAE,gBAAgB,EAAE,YAAY,CAAC;IAc9D,mBAAmB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC7D,OAAO,EAAE,OAAO,CAAC,uBAAuB,EAAE,YAAY,CAAC,GACtD,aAAa,CACd,4BAA4B,EAC5B,yBAAyB,EACzB,YAAY,CACb;IAcM,yBAAyB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACnE,OAAO,EAAE,OAAO,CACd,6BAA6B,EAC7B,YAAY,EACZ,iCAAiC,CAClC,GACA,OAAO,CAAC,sBAAsB,CAAC,kCAAkC,CAAC,CAAC;IAc/D,sBAAsB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAChE,OAAO,EAAE,OAAO,CACd,0BAA0B,EAC1B,YAAY,EACZ,8BAA8B,CAC/B,GACA,OAAO,CAAC,sBAAsB,CAAC,+BAA+B,CAAC,CAAC;IAcnE;;OAEG;IACI,kBAAkB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC5D,OAAO,EAAE,OAAO,CAAC,sBAAsB,EAAE,YAAY,CAAC,GACrD,aAAa,CACd,2BAA2B,EAC3B,wBAAwB,EACxB,YAAY,CACb;IAkBD;;OAEG;IACI,wBAAwB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAClE,OAAO,EAAE,OAAO,CAAC,4BAA4B,EAAE,YAAY,CAAC,GAC3D,aAAa,CACd,iCAAiC,EACjC,8BAA8B,EAC9B,YAAY,CACb;IAkBD;;OAEG;IACI,qBAAqB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC/D,OAAO,EAAE,OAAO,CAAC,yBAAyB,EAAE,YAAY,CAAC,GACxD,aAAa,CACd,8BAA8B,EAC9B,2BAA2B,EAC3B,YAAY,CACb;IAkBD;;OAEG;IACI,uBAAuB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACjE,OAAO,EAAE,OAAO,CAAC,2BAA2B,EAAE,YAAY,CAAC,GAC1D,aAAa,CACd,gCAAgC,EAChC,6BAA6B,EAC7B,YAAY,CACb;IAkBD;;OAEG;IACI,uBAAuB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACjE,OAAO,EAAE,OAAO,CAAC,2BAA2B,EAAE,YAAY,CAAC,GAC1D,aAAa,CACd,gCAAgC,EAChC,6BAA6B,EAC7B,YAAY,CACb;IAcD;;OAEG;IACI,uBAAuB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACjE,OAAO,EAAE,OAAO,CAAC,2BAA2B,EAAE,YAAY,CAAC,GAC1D,aAAa,CACd,gCAAgC,EAChC,6BAA6B,EAC7B,YAAY,CACb;IAcD;;OAEG;IACI,uBAAuB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACjE,OAAO,EAAE,OAAO,CAAC,2BAA2B,EAAE,YAAY,CAAC,GAC1D,aAAa,CACd,gCAAgC,EAChC,6BAA6B,EAC7B,YAAY,CACb;IAkBD;;OAEG;IACI,iBAAiB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC3D,OAAO,EAAE,OAAO,CAAC,qBAAqB,EAAE,YAAY,CAAC,GACpD,aAAa,CACd,0BAA0B,EAC1B,uBAAuB,EACvB,YAAY,CACb;IAkBD;;OAEG;IACI,wBAAwB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAClE,OAAO,EAAE,OAAO,CAAC,4BAA4B,EAAE,YAAY,CAAC,GAC3D,aAAa,CACd,iCAAiC,EACjC,8BAA8B,EAC9B,YAAY,CACb;IAkBD;;OAEG;IACI,8BAA8B,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACxE,OAAO,EAAE,OAAO,CAAC,kCAAkC,EAAE,YAAY,CAAC,GACjE,aAAa,CACd,uCAAuC,EACvC,oCAAoC,EACpC,YAAY,CACb;IAcD;;OAEG;IACI,yBAAyB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACnE,OAAO,EAAE,OAAO,CAAC,6BAA6B,EAAE,YAAY,CAAC,GAC5D,aAAa,CACd,kCAAkC,EAClC,+BAA+B,EAC/B,YAAY,CACb;IAkBD;;OAEG;IACI,6BAA6B,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACvE,OAAO,EAAE,OAAO,CAAC,iCAAiC,EAAE,YAAY,CAAC,GAChE,aAAa,CACd,sCAAsC,EACtC,mCAAmC,EACnC,YAAY,CACb;IAkBD;;OAEG;IACI,6BAA6B,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACvE,OAAO,EAAE,OAAO,CAAC,iCAAiC,EAAE,YAAY,CAAC,GAChE,aAAa,CACd,sCAAsC,EACtC,mCAAmC,EACnC,YAAY,CACb;IAkBD;;OAEG;IACI,iCAAiC,CACtC,YAAY,SAAS,OAAO,GAAG,KAAK,EAEpC,OAAO,EAAE,OAAO,CAAC,qCAAqC,EAAE,YAAY,CAAC,GACpE,aAAa,CACd,0CAA0C,EAC1C,uCAAuC,EACvC,YAAY,CACb;IAkBD;;OAEG;IACI,yBAAyB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACnE,OAAO,EAAE,OAAO,CAAC,6BAA6B,EAAE,YAAY,CAAC,GAC5D,aAAa,CACd,kCAAkC,EAClC,+BAA+B,EAC/B,YAAY,CACb;IAcD;;OAEG;IACI,sBAAsB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAChE,OAAO,EAAE,OAAO,CAAC,0BAA0B,EAAE,YAAY,CAAC,GACzD,aAAa,CACd,+BAA+B,EAC/B,4BAA4B,EAC5B,YAAY,CACb;IAcD;;OAEG;IACI,6BAA6B,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACvE,OAAO,EAAE,OAAO,CAAC,iCAAiC,EAAE,YAAY,CAAC,GAChE,aAAa,CACd,sCAAsC,EACtC,mCAAmC,EACnC,YAAY,CACb;IAkBD;;OAEG;IACI,4BAA4B,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACtE,OAAO,EAAE,OAAO,CAAC,gCAAgC,EAAE,YAAY,CAAC,GAC/D,aAAa,CACd,qCAAqC,EACrC,kCAAkC,EAClC,YAAY,CACb;IAkBD;;OAEG;IACI,qBAAqB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC/D,OAAO,CAAC,EAAE,OAAO,CAAC,yBAAyB,EAAE,YAAY,CAAC,GACzD,aAAa,CACd,8BAA8B,EAC9B,2BAA2B,EAC3B,YAAY,CACb;IAcD;;OAEG;IACI,wBAAwB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAClE,OAAO,EAAE,OAAO,CAAC,4BAA4B,EAAE,YAAY,CAAC,GAC3D,aAAa,CACd,iCAAiC,EACjC,8BAA8B,EAC9B,YAAY,CACb;IAkBD;;;;OAIG;IACI,2BAA2B,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EACrE,OAAO,CAAC,EAAE,OAAO,CACf,+BAA+B,EAC/B,YAAY,EACZ,mCAAmC,CACpC,GACA,OAAO,CAAC,sBAAsB,CAAC,oCAAoC,CAAC,CAAC;IAcxE;;OAEG;IACI,sBAAsB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAChE,OAAO,EAAE,OAAO,CAAC,0BAA0B,EAAE,YAAY,CAAC,GACzD,aAAa,CACd,+BAA+B,EAC/B,4BAA4B,EAC5B,YAAY,CACb;IAkBD;;OAEG;IACI,wBAAwB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAClE,OAAO,EAAE,OAAO,CAAC,4BAA4B,EAAE,YAAY,CAAC,GAC3D,aAAa,CACd,iCAAiC,EACjC,8BAA8B,EAC9B,YAAY,CACb;IAkBD;;;;OAIG;IACI,sBAAsB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAChE,OAAO,CAAC,EAAE,OAAO,CAAC,0BAA0B,EAAE,YAAY,CAAC,GAC1D,aAAa,CACd,+BAA+B,EAC/B,4BAA4B,EAC5B,YAAY,CACb;IAcD;;;;OAIG;IACI,kBAAkB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC5D,OAAO,EAAE,OAAO,CAAC,sBAAsB,EAAE,YAAY,CAAC,GACrD,aAAa,CACd,2BAA2B,EAC3B,wBAAwB,EACxB,YAAY,CACb;IAcD;;;;OAIG;IACI,iBAAiB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC3D,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,EAAE,YAAY,CAAC,GACrD,aAAa,CACd,0BAA0B,EAC1B,uBAAuB,EACvB,YAAY,CACb;IAcM,iBAAiB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAC3D,OAAO,CAAC,EAAE,OAAO,CAAC,qBAAqB,EAAE,YAAY,CAAC,GACrD,aAAa,CACd,0BAA0B,EAC1B,uBAAuB,EACvB,YAAY,CACb;IAcM,sBAAsB,CAAC,YAAY,SAAS,OAAO,GAAG,KAAK,EAChE,OAAO,CAAC,EAAE,OAAO,CACf,0BAA0B,EAC1B,YAAY,EACZ,8BAA8B,CAC/B,GACA,OAAO,CAAC,sBAAsB,CAAC,+BAA+B,CAAC,CAAC;CAapE"}
|