@bikefinder/api-client 0.7.2 → 0.11.1

package/src/generated/types.gen.ts

@@ -25,6 +25,15 @@ export type AccountPreferences = {
   devicePreferences: DevicePreferences;
 };
 
+export type BatteryEvidenceState = "notRecorded" | "recorded" | "invalid";
+
+export type BatteryField =
+  "reading" | "levelPercent" | "charging" | "time" | "origin";
+
+export type BatteryOrigin = "bluetooth" | "tracker";
+
+export type BatteryTimeBasis = "unknown" | "observed" | "received";
+
 export type BluetoothBatteryRequest = {
   observedAt: string;
   level: null | number;
@@ -73,12 +82,7 @@ export type BluetoothReportingPolicy = {
   accuracy: number;
 };
 
-export type ClaimTrackerGuestAccessRequest = {
-  accessCode: string;
-  displayName: null | string;
-};
-
-export type ClaimTrackerOwnershipRequest = {
+export type ClaimTrackerRequest = {
   displayName: null | string;
 };
 
@@ -97,6 +101,16 @@ export type DevicePreferences = {
   mapStyle: string;
 };
 
+export type FirmwareBlockReason =
+  | "subscriptionRequired"
+  | "accountRestricted"
+  | "temporarilyPaused"
+  | "repeatedFailures"
+  | "locationRequired"
+  | "outsideSupportedArea"
+  | "installedVersionUnknown"
+  | "appUpdateRequired";
+
 export type HealthStatus = {
   status: string;
 };
@@ -156,6 +170,11 @@ export type RecordFirmwareAttemptResult = {
   recorded: boolean;
 };
 
+export type RedeemTrackerInvitationRequest = {
+  accessCode: string;
+  displayName: null | string;
+};
+
 export type RegisterPushRegistrationRequest = {
   token: string;
   platform: MobilePlatform;
@@ -203,9 +222,20 @@ export type SubscriptionPlan = {
 };
 
 export type TrackerBattery = {
-  level: null | number;
-  isCharging: boolean;
+  trackerId: string;
+  reading: TrackerBatterySummary;
+  state: BatteryEvidenceState;
   observedAt: null | string;
+  receivedAt: null | string;
+  origin: null | BatteryOrigin;
+  invalidFields: Array<BatteryField>;
+};
+
+export type TrackerBatterySummary = {
+  levelPercent: null | number;
+  charging: null | boolean;
+  asOf: null | string;
+  timeBasis: BatteryTimeBasis;
 };
 
 export type TrackerBikeDetails = {
@@ -231,6 +261,43 @@ export type TrackerClaimabilityRequest = {
   trackerIds: Array<string>;
 };
 
+export type TrackerFirmwareEligibility =
+  | ({
+      status: "available";
+    } & TrackerFirmwareEligibilityAvailableFirmwareUpdate)
+  | ({
+      status: "current";
+    } & TrackerFirmwareEligibilityCurrentTrackerFirmware)
+  | ({
+      status: "unsupported";
+    } & TrackerFirmwareEligibilityUnsupportedTrackerFirmware)
+  | ({
+      status: "blocked";
+    } & TrackerFirmwareEligibilityBlockedTrackerFirmware);
+
+export type TrackerFirmwareEligibilityAvailableFirmwareUpdate = {
+  status?: "available";
+  plan: TrackerFirmwarePlan;
+  trackerId: string;
+};
+
+export type TrackerFirmwareEligibilityBlockedTrackerFirmware = {
+  status?: "blocked";
+  reason: FirmwareBlockReason;
+  retryAfter: null | string;
+  trackerId: string;
+};
+
+export type TrackerFirmwareEligibilityCurrentTrackerFirmware = {
+  status?: "current";
+  trackerId: string;
+};
+
+export type TrackerFirmwareEligibilityUnsupportedTrackerFirmware = {
+  status?: "unsupported";
+  trackerId: string;
+};
+
 export type TrackerFirmwarePlan = {
   trackerId: string;
   from: string;
@@ -254,6 +321,11 @@ export type TrackerInvitation = {
   accessCode: string;
 };
 
+export type TrackerMembership = {
+  trackerId: string;
+  accountId: string;
+};
+
 export type TrackerModeRequest = {
   mode: TrackingMode;
 };
@@ -306,11 +378,9 @@ export type TrackerSummary = {
   nickname: null | string;
   requestedMode: null | TrackingMode;
   subscriptionActive: null | boolean;
-  bikeDetails: null | TrackerBikeDetails;
-  battery: null | TrackerBattery;
+  battery: null | TrackerBatterySummary;
   subscription: null | TrackerSubscription;
   membershipCount: number;
-  sharingCodes: null | Array<string>;
   generation: null | number;
   imei: null | string;
   iccid: null | string;
@@ -585,6 +655,140 @@ export type RequestTrackerModeResponses = {
 export type RequestTrackerModeResponse =
   RequestTrackerModeResponses[keyof RequestTrackerModeResponses];
 
+export type SubmitTrackerTheftReportData = {
+  body: SubmitTrackerTheftReportRequest;
+  path: {
+    trackerId: string;
+  };
+  query?: never;
+  url: "/v1/trackers/{trackerId}/theft-reports";
+};
+
+export type SubmitTrackerTheftReportErrors = {
+  /**
+   * Bad Request
+   */
+  400: ProblemDetails;
+  /**
+   * Unauthorized
+   */
+  401: ProblemDetails;
+  /**
+   * Forbidden
+   */
+  403: ProblemDetails;
+  /**
+   * Not Found
+   */
+  404: ProblemDetails;
+  /**
+   * Conflict
+   */
+  409: ProblemDetails;
+  /**
+   * Payload Too Large
+   */
+  413: ProblemDetails;
+  /**
+   * Unsupported Media Type
+   */
+  415: ProblemDetails;
+  /**
+   * Too Many Requests
+   */
+  429: ProblemDetails;
+  /**
+   * Internal Server Error
+   */
+  500: ProblemDetails;
+  /**
+   * Bad Gateway
+   */
+  502: ProblemDetails;
+  /**
+   * Service Unavailable
+   */
+  503: ProblemDetails;
+};
+
+export type SubmitTrackerTheftReportError =
+  SubmitTrackerTheftReportErrors[keyof SubmitTrackerTheftReportErrors];
+
+export type SubmitTrackerTheftReportResponses = {
+  /**
+   * OK
+   */
+  200: TrackerTheftReportResult;
+};
+
+export type SubmitTrackerTheftReportResponse =
+  SubmitTrackerTheftReportResponses[keyof SubmitTrackerTheftReportResponses];
+
+export type GetTrackerBikeData = {
+  body?: never;
+  path: {
+    trackerId: string;
+  };
+  query?: never;
+  url: "/v1/trackers/{trackerId}/bike";
+};
+
+export type GetTrackerBikeErrors = {
+  /**
+   * Bad Request
+   */
+  400: ProblemDetails;
+  /**
+   * Unauthorized
+   */
+  401: ProblemDetails;
+  /**
+   * Forbidden
+   */
+  403: ProblemDetails;
+  /**
+   * Not Found
+   */
+  404: ProblemDetails;
+  /**
+   * Conflict
+   */
+  409: ProblemDetails;
+  /**
+   * Payload Too Large
+   */
+  413: ProblemDetails;
+  /**
+   * Too Many Requests
+   */
+  429: ProblemDetails;
+  /**
+   * Internal Server Error
+   */
+  500: ProblemDetails;
+  /**
+   * Bad Gateway
+   */
+  502: ProblemDetails;
+  /**
+   * Service Unavailable
+   */
+  503: ProblemDetails;
+};
+
+export type GetTrackerBikeError =
+  GetTrackerBikeErrors[keyof GetTrackerBikeErrors];
+
+export type GetTrackerBikeResponses = {
+  /**
+   * OK
+   */
+  200: TrackerBikeDetails;
+};
+
+export type GetTrackerBikeResponse =
+  GetTrackerBikeResponses[keyof GetTrackerBikeResponses];
+
 export type UpdateTrackerBikeData = {
   body: UpdateTrackerBikeRequest;
   path: {
@@ -654,16 +858,16 @@ export type UpdateTrackerBikeResponses = {
 export type UpdateTrackerBikeResponse =
   UpdateTrackerBikeResponses[keyof UpdateTrackerBikeResponses];
 
-export type SubmitTrackerTheftReportData = {
-  body: SubmitTrackerTheftReportRequest;
+export type SubscribeTrackerBikeData = {
+  body?: never;
   path: {
     trackerId: string;
   };
   query?: never;
-  url: "/v1/trackers/{trackerId}/theft-reports";
+  url: "/v1/trackers/{trackerId}/bike/stream";
 };
 
-export type SubmitTrackerTheftReportErrors = {
+export type SubscribeTrackerBikeErrors = {
   /**
    * Bad Request
    */
@@ -689,9 +893,70 @@ export type SubmitTrackerTheftReportErrors = {
    */
   413: ProblemDetails;
   /**
-   * Unsupported Media Type
+   * Too Many Requests
    */
-  415: ProblemDetails;
+  429: ProblemDetails;
+  /**
+   * Internal Server Error
+   */
+  500: ProblemDetails;
+  /**
+   * Bad Gateway
+   */
+  502: ProblemDetails;
+  /**
+   * Service Unavailable
+   */
+  503: ProblemDetails;
+};
+
+export type SubscribeTrackerBikeError =
+  SubscribeTrackerBikeErrors[keyof SubscribeTrackerBikeErrors];
+
+export type SubscribeTrackerBikeResponses = {
+  /**
+   * OK
+   */
+  200: TrackerBikeDetails | null;
+};
+
+export type SubscribeTrackerBikeResponse =
+  SubscribeTrackerBikeResponses[keyof SubscribeTrackerBikeResponses];
+
+export type GetTrackerBatteryData = {
+  body?: never;
+  path: {
+    trackerId: string;
+  };
+  query?: never;
+  url: "/v1/trackers/{trackerId}/battery";
+};
+
+export type GetTrackerBatteryErrors = {
+  /**
+   * Bad Request
+   */
+  400: ProblemDetails;
+  /**
+   * Unauthorized
+   */
+  401: ProblemDetails;
+  /**
+   * Forbidden
+   */
+  403: ProblemDetails;
+  /**
+   * Not Found
+   */
+  404: ProblemDetails;
+  /**
+   * Conflict
+   */
+  409: ProblemDetails;
+  /**
+   * Payload Too Large
+   */
+  413: ProblemDetails;
   /**
    * Too Many Requests
    */
@@ -710,18 +975,83 @@ export type SubmitTrackerTheftReportErrors = {
   503: ProblemDetails;
 };
 
-export type SubmitTrackerTheftReportError =
-  SubmitTrackerTheftReportErrors[keyof SubmitTrackerTheftReportErrors];
+export type GetTrackerBatteryError =
+  GetTrackerBatteryErrors[keyof GetTrackerBatteryErrors];
 
-export type SubmitTrackerTheftReportResponses = {
+export type GetTrackerBatteryResponses = {
   /**
    * OK
    */
-  200: TrackerTheftReportResult;
+  200: TrackerBattery;
 };
 
-export type SubmitTrackerTheftReportResponse =
-  SubmitTrackerTheftReportResponses[keyof SubmitTrackerTheftReportResponses];
+export type GetTrackerBatteryResponse =
+  GetTrackerBatteryResponses[keyof GetTrackerBatteryResponses];
+
+export type SubscribeTrackerBatteryData = {
+  body?: never;
+  path: {
+    trackerId: string;
+  };
+  query?: never;
+  url: "/v1/trackers/{trackerId}/battery/stream";
+};
+
+export type SubscribeTrackerBatteryErrors = {
+  /**
+   * Bad Request
+   */
+  400: ProblemDetails;
+  /**
+   * Unauthorized
+   */
+  401: ProblemDetails;
+  /**
+   * Forbidden
+   */
+  403: ProblemDetails;
+  /**
+   * Not Found
+   */
+  404: ProblemDetails;
+  /**
+   * Conflict
+   */
+  409: ProblemDetails;
+  /**
+   * Payload Too Large
+   */
+  413: ProblemDetails;
+  /**
+   * Too Many Requests
+   */
+  429: ProblemDetails;
+  /**
+   * Internal Server Error
+   */
+  500: ProblemDetails;
+  /**
+   * Bad Gateway
+   */
+  502: ProblemDetails;
+  /**
+   * Service Unavailable
+   */
+  503: ProblemDetails;
+};
+
+export type SubscribeTrackerBatteryError =
+  SubscribeTrackerBatteryErrors[keyof SubscribeTrackerBatteryErrors];
+
+export type SubscribeTrackerBatteryResponses = {
+  /**
+   * OK
+   */
+  200: TrackerBattery | null;
+};
+
+export type SubscribeTrackerBatteryResponse =
+  SubscribeTrackerBatteryResponses[keyof SubscribeTrackerBatteryResponses];
 
 export type CheckTrackerClaimabilityData = {
   body: TrackerClaimabilityRequest;
@@ -792,16 +1122,16 @@ export type CheckTrackerClaimabilityResponses = {
 export type CheckTrackerClaimabilityResponse =
   CheckTrackerClaimabilityResponses[keyof CheckTrackerClaimabilityResponses];
 
-export type ClaimTrackerOwnershipData = {
-  body: ClaimTrackerOwnershipRequest;
+export type ClaimTrackerData = {
+  body: ClaimTrackerRequest;
   path: {
     trackerId: string;
   };
   query?: never;
-  url: "/v1/trackers/{trackerId}/ownership-claims";
+  url: "/v1/trackers/{trackerId}/claims";
 };
 
-export type ClaimTrackerOwnershipErrors = {
+export type ClaimTrackerErrors = {
   /**
    * Bad Request
    */
@@ -848,29 +1178,28 @@ export type ClaimTrackerOwnershipErrors = {
   503: ProblemDetails;
 };
 
-export type ClaimTrackerOwnershipError =
-  ClaimTrackerOwnershipErrors[keyof ClaimTrackerOwnershipErrors];
+export type ClaimTrackerError = ClaimTrackerErrors[keyof ClaimTrackerErrors];
 
-export type ClaimTrackerOwnershipResponses = {
+export type ClaimTrackerResponses = {
   /**
    * OK
    */
-  200: CommandSuccess;
+  200: TrackerMembership;
 };
 
-export type ClaimTrackerOwnershipResponse =
-  ClaimTrackerOwnershipResponses[keyof ClaimTrackerOwnershipResponses];
+export type ClaimTrackerResponse =
+  ClaimTrackerResponses[keyof ClaimTrackerResponses];
 
-export type ClaimTrackerGuestAccessData = {
-  body: ClaimTrackerGuestAccessRequest;
+export type RedeemTrackerInvitationData = {
+  body: RedeemTrackerInvitationRequest;
   path: {
     trackerId: string;
   };
   query?: never;
-  url: "/v1/trackers/{trackerId}/guest-access-claims";
+  url: "/v1/trackers/{trackerId}/invitation-redemptions";
 };
 
-export type ClaimTrackerGuestAccessErrors = {
+export type RedeemTrackerInvitationErrors = {
   /**
    * Bad Request
    */
@@ -917,18 +1246,18 @@ export type ClaimTrackerGuestAccessErrors = {
   503: ProblemDetails;
 };
 
-export type ClaimTrackerGuestAccessError =
-  ClaimTrackerGuestAccessErrors[keyof ClaimTrackerGuestAccessErrors];
+export type RedeemTrackerInvitationError =
+  RedeemTrackerInvitationErrors[keyof RedeemTrackerInvitationErrors];
 
-export type ClaimTrackerGuestAccessResponses = {
+export type RedeemTrackerInvitationResponses = {
   /**
    * OK
    */
-  200: CommandSuccess;
+  200: TrackerMembership;
 };
 
-export type ClaimTrackerGuestAccessResponse =
-  ClaimTrackerGuestAccessResponses[keyof ClaimTrackerGuestAccessResponses];
+export type RedeemTrackerInvitationResponse =
+  RedeemTrackerInvitationResponses[keyof RedeemTrackerInvitationResponses];
 
 export type CreateTrackerInvitationData = {
   body?: never;
@@ -1601,7 +1930,7 @@ export type GetTrackerFirmwarePlanResponses = {
   /**
    * OK
    */
-  200: TrackerFirmwarePlan;
+  200: TrackerFirmwareEligibility;
 };
 
 export type GetTrackerFirmwarePlanResponse =