@reor/tripper-api-client 0.0.2 → 0.0.3

package/dist/generated/index.d.ts

@@ -1,2 +1,2 @@
-export { createLocation, createLocationType, deleteLocationType, get, getLocationsWithinBoundingBox, getLocationTypeById, getLocationTypes, type Options, updateLocationTypeIcon, updateLocationTypeName } from './sdk.gen';
-export type { ClientOptions, CreateLocationData, CreateLocationError, CreateLocationErrors, CreateLocationRequest, CreateLocationResponse, CreateLocationResponses, CreateLocationTypeData, CreateLocationTypeError, CreateLocationTypeErrors, CreateLocationTypeRequest, CreateLocationTypeResponse, CreateLocationTypeResponses, DeleteLocationTypeData, DeleteLocationTypeError, DeleteLocationTypeErrors, DeleteLocationTypeResponse, DeleteLocationTypeResponses, GetData, GetLocationsWithinBoundingBoxData, GetLocationsWithinBoundingBoxError, GetLocationsWithinBoundingBoxErrors, GetLocationsWithinBoundingBoxResponse, GetLocationsWithinBoundingBoxResponses, GetLocationTypeByIdData, GetLocationTypeByIdErrors, GetLocationTypeByIdResponse, GetLocationTypeByIdResponses, GetLocationTypesData, GetLocationTypesErrors, GetLocationTypesResponse, GetLocationTypesResponses, GetResponse, GetResponses, JsonElement, LocationResponse, LocationTypeResponse, LocationTypeSummaryResponse, ProblemDetails, UpdateLocationTypeIconData, UpdateLocationTypeIconError, UpdateLocationTypeIconErrors, UpdateLocationTypeIconRequest, UpdateLocationTypeIconResponse, UpdateLocationTypeIconResponses, UpdateLocationTypeNameData, UpdateLocationTypeNameError, UpdateLocationTypeNameErrors, UpdateLocationTypeNameRequest, UpdateLocationTypeNameResponse, UpdateLocationTypeNameResponses } from './types.gen';
+export { createLocation, createLocationType, deleteLocationType, get, getLocationsWithinBoundingBox, getLocationTypeById, getLocationTypes, getRouteById, getRoutesWithinBoundingBox, getRouteTrack, type Options, updateLocationTypeIcon, updateLocationTypeName, uploadRoute } from './sdk.gen';
+export type { ClientOptions, CreateLocationData, CreateLocationError, CreateLocationErrors, CreateLocationRequest, CreateLocationResponse, CreateLocationResponses, CreateLocationTypeData, CreateLocationTypeError, CreateLocationTypeErrors, CreateLocationTypeRequest, CreateLocationTypeResponse, CreateLocationTypeResponses, DeleteLocationTypeData, DeleteLocationTypeError, DeleteLocationTypeErrors, DeleteLocationTypeResponse, DeleteLocationTypeResponses, GetData, GetLocationsWithinBoundingBoxData, GetLocationsWithinBoundingBoxError, GetLocationsWithinBoundingBoxErrors, GetLocationsWithinBoundingBoxResponse, GetLocationsWithinBoundingBoxResponses, GetLocationTypeByIdData, GetLocationTypeByIdErrors, GetLocationTypeByIdResponse, GetLocationTypeByIdResponses, GetLocationTypesData, GetLocationTypesErrors, GetLocationTypesResponse, GetLocationTypesResponses, GetResponse, GetResponses, GetRouteByIdData, GetRouteByIdErrors, GetRouteByIdResponse, GetRouteByIdResponses, GetRoutesWithinBoundingBoxData, GetRoutesWithinBoundingBoxError, GetRoutesWithinBoundingBoxErrors, GetRoutesWithinBoundingBoxResponse, GetRoutesWithinBoundingBoxResponses, GetRouteTrackData, GetRouteTrackErrors, GetRouteTrackResponse, GetRouteTrackResponses, IFormFile, JsonElement, LocationResponse, LocationTypeResponse, LocationTypeSummaryResponse, ProblemDetails, RouteDetailsResponse, RouteSummaryResponse, RouteTrackResponse, RouteUploadRequest, UpdateLocationTypeIconData, UpdateLocationTypeIconError, UpdateLocationTypeIconErrors, UpdateLocationTypeIconRequest, UpdateLocationTypeIconResponse, UpdateLocationTypeIconResponses, UpdateLocationTypeNameData, UpdateLocationTypeNameError, UpdateLocationTypeNameErrors, UpdateLocationTypeNameRequest, UpdateLocationTypeNameResponse, UpdateLocationTypeNameResponses, UploadRouteData, UploadRouteError, UploadRouteErrors, UploadRouteResponse, UploadRouteResponses } from './types.gen';

package/dist/generated/index.js

@@ -1,7 +1,7 @@
 "use strict";
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateLocationTypeName = exports.updateLocationTypeIcon = exports.getLocationTypes = exports.getLocationTypeById = exports.getLocationsWithinBoundingBox = exports.get = exports.deleteLocationType = exports.createLocationType = exports.createLocation = void 0;
+exports.uploadRoute = exports.updateLocationTypeName = exports.updateLocationTypeIcon = exports.getRouteTrack = exports.getRoutesWithinBoundingBox = exports.getRouteById = exports.getLocationTypes = exports.getLocationTypeById = exports.getLocationsWithinBoundingBox = exports.get = exports.deleteLocationType = exports.createLocationType = exports.createLocation = void 0;
 var sdk_gen_1 = require("./sdk.gen");
 Object.defineProperty(exports, "createLocation", { enumerable: true, get: function () { return sdk_gen_1.createLocation; } });
 Object.defineProperty(exports, "createLocationType", { enumerable: true, get: function () { return sdk_gen_1.createLocationType; } });
@@ -10,5 +10,9 @@ Object.defineProperty(exports, "get", { enumerable: true, get: function () { ret
 Object.defineProperty(exports, "getLocationsWithinBoundingBox", { enumerable: true, get: function () { return sdk_gen_1.getLocationsWithinBoundingBox; } });
 Object.defineProperty(exports, "getLocationTypeById", { enumerable: true, get: function () { return sdk_gen_1.getLocationTypeById; } });
 Object.defineProperty(exports, "getLocationTypes", { enumerable: true, get: function () { return sdk_gen_1.getLocationTypes; } });
+Object.defineProperty(exports, "getRouteById", { enumerable: true, get: function () { return sdk_gen_1.getRouteById; } });
+Object.defineProperty(exports, "getRoutesWithinBoundingBox", { enumerable: true, get: function () { return sdk_gen_1.getRoutesWithinBoundingBox; } });
+Object.defineProperty(exports, "getRouteTrack", { enumerable: true, get: function () { return sdk_gen_1.getRouteTrack; } });
 Object.defineProperty(exports, "updateLocationTypeIcon", { enumerable: true, get: function () { return sdk_gen_1.updateLocationTypeIcon; } });
 Object.defineProperty(exports, "updateLocationTypeName", { enumerable: true, get: function () { return sdk_gen_1.updateLocationTypeName; } });
+Object.defineProperty(exports, "uploadRoute", { enumerable: true, get: function () { return sdk_gen_1.uploadRoute; } });

package/dist/generated/sdk.gen.d.ts

@@ -1,5 +1,5 @@
-import type { Client, Options as Options2, TDataShape } from './client';
-import type { CreateLocationData, CreateLocationErrors, CreateLocationResponses, CreateLocationTypeData, CreateLocationTypeErrors, CreateLocationTypeResponses, DeleteLocationTypeData, DeleteLocationTypeErrors, DeleteLocationTypeResponses, GetData, GetLocationsWithinBoundingBoxData, GetLocationsWithinBoundingBoxErrors, GetLocationsWithinBoundingBoxResponses, GetLocationTypeByIdData, GetLocationTypeByIdErrors, GetLocationTypeByIdResponses, GetLocationTypesData, GetLocationTypesErrors, GetLocationTypesResponses, GetResponses, UpdateLocationTypeIconData, UpdateLocationTypeIconErrors, UpdateLocationTypeIconResponses, UpdateLocationTypeNameData, UpdateLocationTypeNameErrors, UpdateLocationTypeNameResponses } from './types.gen';
+import { type Client, type Options as Options2, type TDataShape } from './client';
+import type { CreateLocationData, CreateLocationErrors, CreateLocationResponses, CreateLocationTypeData, CreateLocationTypeErrors, CreateLocationTypeResponses, DeleteLocationTypeData, DeleteLocationTypeErrors, DeleteLocationTypeResponses, GetData, GetLocationsWithinBoundingBoxData, GetLocationsWithinBoundingBoxErrors, GetLocationsWithinBoundingBoxResponses, GetLocationTypeByIdData, GetLocationTypeByIdErrors, GetLocationTypeByIdResponses, GetLocationTypesData, GetLocationTypesErrors, GetLocationTypesResponses, GetResponses, GetRouteByIdData, GetRouteByIdErrors, GetRouteByIdResponses, GetRoutesWithinBoundingBoxData, GetRoutesWithinBoundingBoxErrors, GetRoutesWithinBoundingBoxResponses, GetRouteTrackData, GetRouteTrackErrors, GetRouteTrackResponses, UpdateLocationTypeIconData, UpdateLocationTypeIconErrors, UpdateLocationTypeIconResponses, UpdateLocationTypeNameData, UpdateLocationTypeNameErrors, UpdateLocationTypeNameResponses, UploadRouteData, UploadRouteErrors, UploadRouteResponses } from './types.gen';
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean, TResponse = unknown> = Options2<TData, ThrowOnError, TResponse> & {
     /**
      * You can provide a client instance returned by `createClient()` instead of
@@ -62,3 +62,27 @@ export declare const updateLocationTypeName: <ThrowOnError extends boolean = fal
  * Changes the icon identifier (e.g. "house" or "boat") of the specified location type.
  */
 export declare const updateLocationTypeIcon: <ThrowOnError extends boolean = false>(options: Options<UpdateLocationTypeIconData, ThrowOnError>) => import("./client").RequestResult<UpdateLocationTypeIconResponses, UpdateLocationTypeIconErrors, ThrowOnError, "fields">;
+/**
+ * Get routes within a bounding box
+ *
+ * Returns routes owned by the authenticated user that intersect the supplied WGS84 bounding box.
+ */
+export declare const getRoutesWithinBoundingBox: <ThrowOnError extends boolean = false>(options: Options<GetRoutesWithinBoundingBoxData, ThrowOnError>) => import("./client").RequestResult<GetRoutesWithinBoundingBoxResponses, GetRoutesWithinBoundingBoxErrors, ThrowOnError, "fields">;
+/**
+ * Upload a route file
+ *
+ * Parses and stores a route file (GPX only for now) owned by the authenticated user.
+ */
+export declare const uploadRoute: <ThrowOnError extends boolean = false>(options: Options<UploadRouteData, ThrowOnError>) => import("./client").RequestResult<UploadRouteResponses, UploadRouteErrors, ThrowOnError, "fields">;
+/**
+ * Get route details
+ *
+ * Returns the details and calculated metrics of a route owned by the authenticated user, excluding track points.
+ */
+export declare const getRouteById: <ThrowOnError extends boolean = false>(options: Options<GetRouteByIdData, ThrowOnError>) => import("./client").RequestResult<GetRouteByIdResponses, GetRouteByIdErrors, ThrowOnError, "fields">;
+/**
+ * Get a route's track
+ *
+ * Returns the id, name, GeoJSON track, and point count of a route owned by the authenticated user.
+ */
+export declare const getRouteTrack: <ThrowOnError extends boolean = false>(options: Options<GetRouteTrackData, ThrowOnError>) => import("./client").RequestResult<GetRouteTrackResponses, GetRouteTrackErrors, ThrowOnError, "fields">;

package/dist/generated/sdk.gen.js

@@ -1,7 +1,8 @@
 "use strict";
 // This file is auto-generated by @hey-api/openapi-ts
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateLocationTypeIcon = exports.updateLocationTypeName = exports.getLocationTypeById = exports.deleteLocationType = exports.createLocationType = exports.getLocationTypes = exports.createLocation = exports.getLocationsWithinBoundingBox = exports.get = void 0;
+exports.getRouteTrack = exports.getRouteById = exports.uploadRoute = exports.getRoutesWithinBoundingBox = exports.updateLocationTypeIcon = exports.updateLocationTypeName = exports.getLocationTypeById = exports.deleteLocationType = exports.createLocationType = exports.getLocationTypes = exports.createLocation = exports.getLocationsWithinBoundingBox = exports.get = void 0;
+const client_1 = require("./client");
 const client_gen_1 = require("./client.gen");
 const get = (options) => (options?.client ?? client_gen_1.client).get({
     security: [{ scheme: 'bearer', type: 'http' }],
@@ -113,3 +114,52 @@ const updateLocationTypeIcon = (options) => (options.client ?? client_gen_1.clie
     }
 });
 exports.updateLocationTypeIcon = updateLocationTypeIcon;
+/**
+ * Get routes within a bounding box
+ *
+ * Returns routes owned by the authenticated user that intersect the supplied WGS84 bounding box.
+ */
+const getRoutesWithinBoundingBox = (options) => (options.client ?? client_gen_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/route',
+    ...options
+});
+exports.getRoutesWithinBoundingBox = getRoutesWithinBoundingBox;
+/**
+ * Upload a route file
+ *
+ * Parses and stores a route file (GPX only for now) owned by the authenticated user.
+ */
+const uploadRoute = (options) => (options.client ?? client_gen_1.client).post({
+    ...client_1.formDataBodySerializer,
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/upload/route',
+    ...options,
+    headers: {
+        'Content-Type': null,
+        ...options.headers
+    }
+});
+exports.uploadRoute = uploadRoute;
+/**
+ * Get route details
+ *
+ * Returns the details and calculated metrics of a route owned by the authenticated user, excluding track points.
+ */
+const getRouteById = (options) => (options.client ?? client_gen_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/route/{id}',
+    ...options
+});
+exports.getRouteById = getRouteById;
+/**
+ * Get a route's track
+ *
+ * Returns the id, name, GeoJSON track, and point count of a route owned by the authenticated user.
+ */
+const getRouteTrack = (options) => (options.client ?? client_gen_1.client).get({
+    security: [{ scheme: 'bearer', type: 'http' }],
+    url: '/route/{id}/track',
+    ...options
+});
+exports.getRouteTrack = getRouteTrack;

package/dist/generated/types.gen.d.ts

@@ -10,6 +10,7 @@ export type CreateLocationTypeRequest = {
     name: string;
     icon: string;
 };
+export type IFormFile = Blob | File;
 export type JsonElement = unknown;
 export type LocationResponse = {
     id: string;
@@ -38,6 +39,34 @@ export type ProblemDetails = {
     detail?: null | string;
     instance?: null | string;
 };
+export type RouteDetailsResponse = {
+    id: string;
+    name: string;
+    originalFileName: string;
+    originalFileSourceFormat: string;
+    totalDistanceMeters: number | string;
+    totalDisplacementMeters: number | string;
+    totalDurationSeconds: number | string;
+    createdAt: string;
+    updatedAt: string;
+};
+export type RouteSummaryResponse = {
+    id: string;
+    name: string;
+    createdAt: string;
+    updatedAt: string;
+};
+export type RouteTrackResponse = {
+    id: string;
+    name: string;
+    geometry: JsonElement;
+    pointCount: number | string;
+};
+export type RouteUploadRequest = {
+    file?: IFormFile;
+    name?: string;
+    extension?: null | string;
+};
 export type UpdateLocationTypeIconRequest = {
     icon: string;
 };
@@ -284,3 +313,110 @@ export type UpdateLocationTypeIconResponses = {
     200: LocationTypeResponse;
 };
 export type UpdateLocationTypeIconResponse = UpdateLocationTypeIconResponses[keyof UpdateLocationTypeIconResponses];
+export type GetRoutesWithinBoundingBoxData = {
+    body?: never;
+    path?: never;
+    query: {
+        minLongitude: number | string;
+        minLatitude: number | string;
+        maxLongitude: number | string;
+        maxLatitude: number | string;
+    };
+    url: '/route';
+};
+export type GetRoutesWithinBoundingBoxErrors = {
+    /**
+     * Bad Request
+     */
+    400: ProblemDetails;
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+};
+export type GetRoutesWithinBoundingBoxError = GetRoutesWithinBoundingBoxErrors[keyof GetRoutesWithinBoundingBoxErrors];
+export type GetRoutesWithinBoundingBoxResponses = {
+    /**
+     * OK
+     */
+    200: Array<RouteSummaryResponse>;
+};
+export type GetRoutesWithinBoundingBoxResponse = GetRoutesWithinBoundingBoxResponses[keyof GetRoutesWithinBoundingBoxResponses];
+export type UploadRouteData = {
+    body: RouteUploadRequest;
+    path?: never;
+    query?: never;
+    url: '/upload/route';
+};
+export type UploadRouteErrors = {
+    /**
+     * Bad Request
+     */
+    400: ProblemDetails;
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Service Unavailable
+     */
+    503: ProblemDetails;
+};
+export type UploadRouteError = UploadRouteErrors[keyof UploadRouteErrors];
+export type UploadRouteResponses = {
+    /**
+     * Created
+     */
+    201: RouteSummaryResponse;
+};
+export type UploadRouteResponse = UploadRouteResponses[keyof UploadRouteResponses];
+export type GetRouteByIdData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/route/{id}';
+};
+export type GetRouteByIdErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Not Found
+     */
+    404: unknown;
+};
+export type GetRouteByIdResponses = {
+    /**
+     * OK
+     */
+    200: RouteDetailsResponse;
+};
+export type GetRouteByIdResponse = GetRouteByIdResponses[keyof GetRouteByIdResponses];
+export type GetRouteTrackData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/route/{id}/track';
+};
+export type GetRouteTrackErrors = {
+    /**
+     * Unauthorized
+     */
+    401: unknown;
+    /**
+     * Not Found
+     */
+    404: unknown;
+};
+export type GetRouteTrackResponses = {
+    /**
+     * OK
+     */
+    200: RouteTrackResponse;
+};
+export type GetRouteTrackResponse = GetRouteTrackResponses[keyof GetRouteTrackResponses];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@reor/tripper-api-client",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "Generated TypeScript client for the Tripper API",
   "repository": {
     "type": "git",