@bikefinder/api-client 0.7.2 → 0.11.1

package/src/generated/index.ts

@@ -5,6 +5,10 @@ export type {
   AccountDeletionRequest,
   AccountNotification,
   AccountPreferences,
+  BatteryEvidenceState,
+  BatteryField,
+  BatteryOrigin,
+  BatteryTimeBasis,
   BluetoothBatteryRequest,
   BluetoothCommandReport,
   BluetoothCommandType,
@@ -18,18 +22,12 @@ export type {
   CheckTrackerClaimabilityErrors,
   CheckTrackerClaimabilityResponse,
   CheckTrackerClaimabilityResponses,
-  ClaimTrackerGuestAccessData,
-  ClaimTrackerGuestAccessError,
-  ClaimTrackerGuestAccessErrors,
-  ClaimTrackerGuestAccessRequest,
-  ClaimTrackerGuestAccessResponse,
-  ClaimTrackerGuestAccessResponses,
-  ClaimTrackerOwnershipData,
-  ClaimTrackerOwnershipError,
-  ClaimTrackerOwnershipErrors,
-  ClaimTrackerOwnershipRequest,
-  ClaimTrackerOwnershipResponse,
-  ClaimTrackerOwnershipResponses,
+  ClaimTrackerData,
+  ClaimTrackerError,
+  ClaimTrackerErrors,
+  ClaimTrackerRequest,
+  ClaimTrackerResponse,
+  ClaimTrackerResponses,
   ClientOptions,
   CommandSuccess,
   CompleteFirmwareRequest,
@@ -49,6 +47,7 @@ export type {
   DeleteTrackerPhotoResponse,
   DeleteTrackerPhotoResponses,
   DevicePreferences,
+  FirmwareBlockReason,
   GetAccountPreferencesData,
   GetAccountPreferencesError,
   GetAccountPreferencesErrors,
@@ -62,6 +61,16 @@ export type {
   GetHealthData,
   GetHealthResponse,
   GetHealthResponses,
+  GetTrackerBatteryData,
+  GetTrackerBatteryError,
+  GetTrackerBatteryErrors,
+  GetTrackerBatteryResponse,
+  GetTrackerBatteryResponses,
+  GetTrackerBikeData,
+  GetTrackerBikeError,
+  GetTrackerBikeErrors,
+  GetTrackerBikeResponse,
+  GetTrackerBikeResponses,
   GetTrackerBluetoothCredentialsData,
   GetTrackerBluetoothCredentialsError,
   GetTrackerBluetoothCredentialsErrors,
@@ -128,6 +137,12 @@ export type {
   RecordTrackerFirmwareAttemptErrors,
   RecordTrackerFirmwareAttemptResponse,
   RecordTrackerFirmwareAttemptResponses,
+  RedeemTrackerInvitationData,
+  RedeemTrackerInvitationError,
+  RedeemTrackerInvitationErrors,
+  RedeemTrackerInvitationRequest,
+  RedeemTrackerInvitationResponse,
+  RedeemTrackerInvitationResponses,
   RegisterPushRegistrationData,
   RegisterPushRegistrationError,
   RegisterPushRegistrationErrors,
@@ -193,6 +208,16 @@ export type {
   SubscribeSubscriptionsErrors,
   SubscribeSubscriptionsResponse,
   SubscribeSubscriptionsResponses,
+  SubscribeTrackerBatteryData,
+  SubscribeTrackerBatteryError,
+  SubscribeTrackerBatteryErrors,
+  SubscribeTrackerBatteryResponse,
+  SubscribeTrackerBatteryResponses,
+  SubscribeTrackerBikeData,
+  SubscribeTrackerBikeError,
+  SubscribeTrackerBikeErrors,
+  SubscribeTrackerBikeResponse,
+  SubscribeTrackerBikeResponses,
   SubscribeTrackerPhotosData,
   SubscribeTrackerPhotosError,
   SubscribeTrackerPhotosErrors,
@@ -212,12 +237,19 @@ export type {
   SubscriptionList,
   SubscriptionPlan,
   TrackerBattery,
+  TrackerBatterySummary,
   TrackerBikeDetails,
   TrackerBluetoothCredentials,
   TrackerClaimabilityRequest,
+  TrackerFirmwareEligibility,
+  TrackerFirmwareEligibilityAvailableFirmwareUpdate,
+  TrackerFirmwareEligibilityBlockedTrackerFirmware,
+  TrackerFirmwareEligibilityCurrentTrackerFirmware,
+  TrackerFirmwareEligibilityUnsupportedTrackerFirmware,
   TrackerFirmwarePlan,
   TrackerFirmwareVersions,
   TrackerInvitation,
+  TrackerMembership,
   TrackerModeRequest,
   TrackerModeResult,
   TrackerPage,

package/src/generated/sdk.gen.ts

@@ -14,12 +14,9 @@ import type {
   CheckTrackerClaimabilityData,
   CheckTrackerClaimabilityErrors,
   CheckTrackerClaimabilityResponses,
-  ClaimTrackerGuestAccessData,
-  ClaimTrackerGuestAccessErrors,
-  ClaimTrackerGuestAccessResponses,
-  ClaimTrackerOwnershipData,
-  ClaimTrackerOwnershipErrors,
-  ClaimTrackerOwnershipResponses,
+  ClaimTrackerData,
+  ClaimTrackerErrors,
+  ClaimTrackerResponses,
   CompleteTrackerFirmwareUpdateData,
   CompleteTrackerFirmwareUpdateErrors,
   CompleteTrackerFirmwareUpdateResponses,
@@ -37,6 +34,12 @@ import type {
   GetBluetoothReportingPolicyResponses,
   GetHealthData,
   GetHealthResponses,
+  GetTrackerBatteryData,
+  GetTrackerBatteryErrors,
+  GetTrackerBatteryResponses,
+  GetTrackerBikeData,
+  GetTrackerBikeErrors,
+  GetTrackerBikeResponses,
   GetTrackerBluetoothCredentialsData,
   GetTrackerBluetoothCredentialsErrors,
   GetTrackerBluetoothCredentialsResponses,
@@ -70,6 +73,9 @@ import type {
   RecordTrackerFirmwareAttemptData,
   RecordTrackerFirmwareAttemptErrors,
   RecordTrackerFirmwareAttemptResponses,
+  RedeemTrackerInvitationData,
+  RedeemTrackerInvitationErrors,
+  RedeemTrackerInvitationResponses,
   RegisterPushRegistrationData,
   RegisterPushRegistrationErrors,
   RegisterPushRegistrationResponses,
@@ -108,6 +114,14 @@ import type {
   SubscribeSubscriptionsErrors,
   SubscribeSubscriptionsResponse,
   SubscribeSubscriptionsResponses,
+  SubscribeTrackerBatteryData,
+  SubscribeTrackerBatteryErrors,
+  SubscribeTrackerBatteryResponse,
+  SubscribeTrackerBatteryResponses,
+  SubscribeTrackerBikeData,
+  SubscribeTrackerBikeErrors,
+  SubscribeTrackerBikeResponse,
+  SubscribeTrackerBikeResponses,
   SubscribeTrackerPhotosData,
   SubscribeTrackerPhotosErrors,
   SubscribeTrackerPhotosResponse,
@@ -141,14 +155,15 @@ import type {
 } from "./types.gen.js";
 import {
   zCheckTrackerClaimabilityResponse,
-  zClaimTrackerGuestAccessResponse,
-  zClaimTrackerOwnershipResponse,
+  zClaimTrackerResponse,
   zCompleteTrackerFirmwareUpdateResponse,
   zCreateTrackerInvitationResponse,
   zDeleteTrackerPhotoResponse,
   zGetAccountPreferencesResponse,
   zGetBluetoothReportingPolicyResponse,
   zGetHealthResponse,
+  zGetTrackerBatteryResponse,
+  zGetTrackerBikeResponse,
   zGetTrackerBluetoothCredentialsResponse,
   zGetTrackerFirmwarePlanResponse,
   zGetTrackerPositionsResponse,
@@ -160,6 +175,7 @@ import {
   zListTrackerPhotosResponse,
   zListTrackersResponse,
   zRecordTrackerFirmwareAttemptResponse,
+  zRedeemTrackerInvitationResponse,
   zRegisterPushRegistrationResponse,
   zRemovePushRegistrationResponse,
   zRemoveTrackerMembershipResponse,
@@ -172,6 +188,8 @@ import {
   zSubmitTrackerTheftReportResponse,
   zSubscribeAccountPreferencesResponse,
   zSubscribeSubscriptionsResponse,
+  zSubscribeTrackerBatteryResponse,
+  zSubscribeTrackerBikeResponse,
   zSubscribeTrackerPhotosResponse,
   zSubscribeTrackerPositionsResponse,
   zSubscribeTrackersResponse,
@@ -346,6 +364,56 @@ export class BikeFinderSdk extends HeyApiClient {
     });
   }
 
+  /**
+   * Submit a tracker theft report
+   */
+  public submitTrackerTheftReport<ThrowOnError extends boolean = false>(
+    options: Options<SubmitTrackerTheftReportData, ThrowOnError>,
+  ): RequestResult<
+    SubmitTrackerTheftReportResponses,
+    SubmitTrackerTheftReportErrors,
+    ThrowOnError
+  > {
+    return (options.client ?? this.client).post<
+      SubmitTrackerTheftReportResponses,
+      SubmitTrackerTheftReportErrors,
+      ThrowOnError
+    >({
+      responseTransformer: async (data) =>
+        await zSubmitTrackerTheftReportResponse.parseAsync(data),
+      security: [{ scheme: "bearer", type: "http" }],
+      url: "/v1/trackers/{trackerId}/theft-reports",
+      ...options,
+      headers: {
+        "Content-Type": "application/json",
+        ...options.headers,
+      },
+    });
+  }
+
+  /**
+   * Read the tracker's bike resource
+   */
+  public getTrackerBike<ThrowOnError extends boolean = false>(
+    options: Options<GetTrackerBikeData, ThrowOnError>,
+  ): RequestResult<
+    GetTrackerBikeResponses,
+    GetTrackerBikeErrors,
+    ThrowOnError
+  > {
+    return (options.client ?? this.client).get<
+      GetTrackerBikeResponses,
+      GetTrackerBikeErrors,
+      ThrowOnError
+    >({
+      responseTransformer: async (data) =>
+        await zGetTrackerBikeResponse.parseAsync(data),
+      security: [{ scheme: "bearer", type: "http" }],
+      url: "/v1/trackers/{trackerId}/bike",
+      ...options,
+    });
+  }
+
   /**
    * Update tracker bike details
    */
@@ -374,29 +442,71 @@ export class BikeFinderSdk extends HeyApiClient {
   }
 
   /**
-   * Submit a tracker theft report
+   * Subscribe to the tracker's bike resource
    */
-  public submitTrackerTheftReport<ThrowOnError extends boolean = false>(
-    options: Options<SubmitTrackerTheftReportData, ThrowOnError>,
+  public subscribeTrackerBike<ThrowOnError extends boolean = false>(
+    options: Options<
+      SubscribeTrackerBikeData,
+      ThrowOnError,
+      SubscribeTrackerBikeResponse
+    >,
+  ): Promise<ServerSentEventsResult<SubscribeTrackerBikeResponses>> {
+    return (options.client ?? this.client).sse.get<
+      SubscribeTrackerBikeResponses,
+      SubscribeTrackerBikeErrors,
+      ThrowOnError
+    >({
+      responseTransformer: async (data) =>
+        await zSubscribeTrackerBikeResponse.parseAsync(data),
+      security: [{ scheme: "bearer", type: "http" }],
+      url: "/v1/trackers/{trackerId}/bike/stream",
+      ...options,
+    });
+  }
+
+  /**
+   * Read the tracker's battery resource
+   */
+  public getTrackerBattery<ThrowOnError extends boolean = false>(
+    options: Options<GetTrackerBatteryData, ThrowOnError>,
   ): RequestResult<
-    SubmitTrackerTheftReportResponses,
-    SubmitTrackerTheftReportErrors,
+    GetTrackerBatteryResponses,
+    GetTrackerBatteryErrors,
     ThrowOnError
   > {
-    return (options.client ?? this.client).post<
-      SubmitTrackerTheftReportResponses,
-      SubmitTrackerTheftReportErrors,
+    return (options.client ?? this.client).get<
+      GetTrackerBatteryResponses,
+      GetTrackerBatteryErrors,
       ThrowOnError
     >({
       responseTransformer: async (data) =>
-        await zSubmitTrackerTheftReportResponse.parseAsync(data),
+        await zGetTrackerBatteryResponse.parseAsync(data),
       security: [{ scheme: "bearer", type: "http" }],
-      url: "/v1/trackers/{trackerId}/theft-reports",
+      url: "/v1/trackers/{trackerId}/battery",
+      ...options,
+    });
+  }
+
+  /**
+   * Subscribe to the tracker's battery resource
+   */
+  public subscribeTrackerBattery<ThrowOnError extends boolean = false>(
+    options: Options<
+      SubscribeTrackerBatteryData,
+      ThrowOnError,
+      SubscribeTrackerBatteryResponse
+    >,
+  ): Promise<ServerSentEventsResult<SubscribeTrackerBatteryResponses>> {
+    return (options.client ?? this.client).sse.get<
+      SubscribeTrackerBatteryResponses,
+      SubscribeTrackerBatteryErrors,
+      ThrowOnError
+    >({
+      responseTransformer: async (data) =>
+        await zSubscribeTrackerBatteryResponse.parseAsync(data),
+      security: [{ scheme: "bearer", type: "http" }],
+      url: "/v1/trackers/{trackerId}/battery/stream",
       ...options,
-      headers: {
-        "Content-Type": "application/json",
-        ...options.headers,
-      },
     });
   }
 
@@ -428,24 +538,20 @@ export class BikeFinderSdk extends HeyApiClient {
   }
 
   /**
-   * Claim ownership of a tracker
+   * Join an empty tracker
    */
-  public claimTrackerOwnership<ThrowOnError extends boolean = false>(
-    options: Options<ClaimTrackerOwnershipData, ThrowOnError>,
-  ): RequestResult<
-    ClaimTrackerOwnershipResponses,
-    ClaimTrackerOwnershipErrors,
-    ThrowOnError
-  > {
+  public claimTracker<ThrowOnError extends boolean = false>(
+    options: Options<ClaimTrackerData, ThrowOnError>,
+  ): RequestResult<ClaimTrackerResponses, ClaimTrackerErrors, ThrowOnError> {
     return (options.client ?? this.client).post<
-      ClaimTrackerOwnershipResponses,
-      ClaimTrackerOwnershipErrors,
+      ClaimTrackerResponses,
+      ClaimTrackerErrors,
       ThrowOnError
     >({
       responseTransformer: async (data) =>
-        await zClaimTrackerOwnershipResponse.parseAsync(data),
+        await zClaimTrackerResponse.parseAsync(data),
       security: [{ scheme: "bearer", type: "http" }],
-      url: "/v1/trackers/{trackerId}/ownership-claims",
+      url: "/v1/trackers/{trackerId}/claims",
       ...options,
       headers: {
         "Content-Type": "application/json",
@@ -455,24 +561,24 @@ export class BikeFinderSdk extends HeyApiClient {
   }
 
   /**
-   * Join a tracker using a sharing code
+   * Join a tracker by redeeming an invitation
    */
-  public claimTrackerGuestAccess<ThrowOnError extends boolean = false>(
-    options: Options<ClaimTrackerGuestAccessData, ThrowOnError>,
+  public redeemTrackerInvitation<ThrowOnError extends boolean = false>(
+    options: Options<RedeemTrackerInvitationData, ThrowOnError>,
   ): RequestResult<
-    ClaimTrackerGuestAccessResponses,
-    ClaimTrackerGuestAccessErrors,
+    RedeemTrackerInvitationResponses,
+    RedeemTrackerInvitationErrors,
     ThrowOnError
   > {
     return (options.client ?? this.client).post<
-      ClaimTrackerGuestAccessResponses,
-      ClaimTrackerGuestAccessErrors,
+      RedeemTrackerInvitationResponses,
+      RedeemTrackerInvitationErrors,
       ThrowOnError
     >({
       responseTransformer: async (data) =>
-        await zClaimTrackerGuestAccessResponse.parseAsync(data),
+        await zRedeemTrackerInvitationResponse.parseAsync(data),
       security: [{ scheme: "bearer", type: "http" }],
-      url: "/v1/trackers/{trackerId}/guest-access-claims",
+      url: "/v1/trackers/{trackerId}/invitation-redemptions",
       ...options,
       headers: {
         "Content-Type": "application/json",
@@ -715,7 +821,7 @@ export class BikeFinderSdk extends HeyApiClient {
   }
 
   /**
-   * Get the firmware update plan for a platform and build
+   * Check firmware eligibility and get an available update plan
    */
   public getTrackerFirmwarePlan<ThrowOnError extends boolean = false>(
     options: Options<GetTrackerFirmwarePlanData, ThrowOnError>,