@evercam/api 1.0.0-cfcbc946a → 1.0.0-d0847b9fa

package/dist/api/api/evercamApi.d.ts

@@ -0,0 +1,357 @@
+import type { AxiosRequestConfig } from "axios";
+import { Automation, GeoJSONPolygon, ProgressPhotoItemResponsePayload, Project, SwrRequestConfig, UserFeatureFlag } from "@evercam/api/types";
+import type { AconexAuthCallbackParams, AconexEditedImageUploadRequestPayload, AconexUserProject, AconexDocumentSchema, AconexDocumentTypeSchema, ApiCredentials, AutodeskFolder, AutodeskProject, AutodeskTokenResponsePayload, AutodeskSnapshot, AutodeskUserHub, AvailableDaysRequestPayload, AvailableDaysResponsePayload, AvailableHoursRequestPayload, AvailableHoursResponsePayload, BatteryReading, BatteryVoltage, BimCompareExportRequestPayload, BimCreationPayload, BIMLayer, BIMLayerPostPayload, BimLayersQueryParams, BimModelRequestPayload, BimModelResponsePayload, BimPendingImage, BimSnapshotRequestPayload, BimSnapshotResponsePayload, BimUploadCameraParameters, CameraLogsResponsePayload, CamerasResponsePayload, CameraStatusLog, CameraUpdateRequestPayload, Comment, CommentCreationRequestPayload, CommentsRequestPayload, CompanyCameraSummary, CompanyProject, CompanyKit, CompanySummary, CompanyUser, Compare, CompareRequestPayload, ConnectorResponsePayload, Credentials, FetchCameraQueryParams, GoogleAuthRequestPayload, LoginRequestPayload, User, Logo, LogoutParams, Media, MediaCreateRequestPayload, MediaFilterQueryParams, MediaUpdateRequestPayload, MediaUsersResponsePayload, NearestSnapshotResponsePayload, PaginatedItems, PendingBimImagesParams, ProcessPendingImagesBimParams, ProcoreEditedImageUploadRequestPayload, ProcoreObservationFormRequestPayload, ProcoreObservationTypesResponsePayload, ProcoreProjectsAlbumsPayload, ProcoreProjectRequestPayload, ProcoreUserCompaniesResponsePayload, ProcoreCompanyRequestPayload, ProcoreUserProjectsResponsePayload, ProcoreUserProjectPermissionsResponsePayload, ProcoreObservationAssignee, ProcoreObservationDistributionMember, ProcoreObservationTrades, ProcoreObservationLocation, ProcoreObservationSpecificationSection, ProcoreObservationForm, ProcoreObservationDefaultList, ProcoreObservationListItem, ProcoreCustomFieldOptionsRequestPayload, ProgressPhotosCreateUpdateRequestPayload, ProgressPhotosResponsePayload, ProgressPhotosUnSubscribeParams, ProjectBatteryReading, ProjectCreateResponse, ProjectExid, ProjectLogoResponsePayload, ProjectMembersResponsePayload, ProjectMembersRequestPayload, ProjectInviteMembersResponsePayload, RemotePasswordUpdateRequestPayload, SessionsListRequestPayload, ShareCreateResponsePayload, ShareDeletionRequestPayload, SharedUsersResponsePayload, UpdateCameraRestrictionPayload, ReorderCamerasPayload, SignupUserRequestPayload, Snapshot, SnapshotRequestPayload, SnapshotRangeRequestPayload, SnapshotRangeResponsePayload, ThumbnailData, TimelapseCreationRequestPayload, TimelapseCreationResponsePayload, TimelapseSnapshotRequestPayload, TimelapseSnapshotResponsePayload, UpdatePasswordRequestPayload, UserSession, UserUpdateRequestPayload, VoyageControlConnectorPayload, HammertechConnectPayload, HammertechProject, HammertechIssueType, HammertechLocation, HammertechCreateIssuePayload, HammertechIssueResponse, HammertechStoredFilePayload, HammertechStoredFileResponse, RingCompleteLinkingPayload, RingCompleteLinkingResponsePayload, RingDevicesResponsePayload, RingMoveDevicePayload, RingMoveDeviceResponsePayload, RingLiveViewPayload, RingLiveViewResponse, RingStopLiveViewResponse, AuthOptionsResponsePayload, AuthProviderConfigPayload, ConfirmUserRequestPayload, DeleteActiveSessionRequestPayload, ProjectContactsResponsePayload, XWeatherCreatePayload, XWeatherResponse, Widget, WidgetFull, WidgetPayload, WidgetSessionSettingsPayload, WidgetsListRequestPayload, Camera, ProcoreNextObservationAvailableNumber, OAuthClient, OAuthClientWithSecret, OAuthConsentInfo, OAuthConsentPayload, OAuthConsentResponse, CreateOAuthClientPayload, UpdateOAuthClientPayload, PaginationParams, StoryblokResponse, Notification, PlaceholderThumbnailData, ProjectUsersResponsePayload, ProjectMember, SnapshotEmailDeliveryRequestPayload, SnapshotEmailDeliveryResponsePayload, SocketAuthResponsePayload } from "@evercam/api/types";
+export declare const EvercamApi: {
+    apiStatus: {
+        getApiStatus(): Promise<void>;
+    };
+    users: {
+        signup(payload: SignupUserRequestPayload): Promise<User>;
+        zohoAuthUrl(payload: {
+            firstname: string;
+            lastname: string;
+        }): Promise<{
+            url: string;
+        }>;
+        fetchAccessFeatures(email: string): Promise<{
+            features: UserFeatureFlag[];
+        }>;
+        impersonationLogin(token: string): Promise<User>;
+        fetchLoginOptions(email: string): Promise<AuthOptionsResponsePayload>;
+        fetchSignupOptions(email: string): Promise<AuthOptionsResponsePayload>;
+        fetchProviderConfig(provider: string): Promise<AuthProviderConfigPayload>;
+        login(params: LoginRequestPayload): Promise<User>;
+        loginWithApiCredentials(apiId: string, apiKey: string): Promise<User>;
+        loginWithWidgetCredentials(widgetId: string, widgetKey: string): Promise<User>;
+        loginWithProvider(provider: string, payload: GoogleAuthRequestPayload): Promise<User>;
+        show(email: string): Promise<{
+            users: User[];
+        }>;
+        logout(payload: LogoutParams, config?: Partial<AxiosRequestConfig>): Promise<void>;
+        resetPassword(email: string): Promise<{
+            message: string;
+        }>;
+        getCredentials(): Promise<Credentials>;
+        updatePassword(user: string, payload: UpdatePasswordRequestPayload): Promise<{
+            message: string;
+        }>;
+        remotePasswordUpdate(email: string, payload: RemotePasswordUpdateRequestPayload): Promise<{
+            message: string;
+        }>;
+        confirm(email: string, payload: ConfirmUserRequestPayload): Promise<User>;
+        deleteActiveSession(sessionId: string, payload: DeleteActiveSessionRequestPayload): Promise<void>;
+        getActiveSessions(params: AxiosRequestConfig & {
+            params: SessionsListRequestPayload;
+        }): Promise<PaginatedItems<UserSession>>;
+        update(email: string, params?: Partial<UserUpdateRequestPayload>): Promise<{
+            users: User[];
+        }>;
+        deleteAccount(): Promise<void>;
+        fetchPermissions(): Promise<{
+            permissions: string[];
+        }>;
+        getProjectContacts(projectExid: ProjectExid): Promise<ProjectContactsResponsePayload>;
+    };
+    notifications: {
+        get(): Promise<PaginatedItems<Notification>>;
+        markAllAsRead(): Promise<{
+            message: string;
+        }>;
+        markAsRead(id: number): Promise<Notification>;
+    };
+    bim: {
+        getBimSnapshot(cameraId: string, dateTime: string, payload: Partial<BimSnapshotRequestPayload>, extraParams?: AxiosRequestConfig): Promise<BimSnapshotResponsePayload>;
+        getBimModel(cameraId: string, payload: BimModelRequestPayload, extraParams?: AxiosRequestConfig): Promise<BimModelResponsePayload>;
+        pendingBimImages(cameraId: string, params: PendingBimImagesParams): Promise<BimPendingImage[]>;
+        processPendingImages(cameraId: string, params: Partial<ProcessPendingImagesBimParams>): Promise<void>;
+        createBim(cameraId: string, params: BimCreationPayload): Promise<void>;
+        getCameraParameters(cameraId: string, params: ApiCredentials): Promise<BimUploadCameraParameters>;
+        uploadCameraParameters(cameraId: string, params: BimUploadCameraParameters): Promise<BimUploadCameraParameters>;
+        exportCompare(projectExid: string, payload: BimCompareExportRequestPayload): Promise<Compare>;
+    };
+    cameras: {
+        getCameras(params: {
+            params?: Partial<FetchCameraQueryParams>;
+            config?: SwrRequestConfig<CamerasResponsePayload>;
+        }): Promise<CamerasResponsePayload>;
+        getCameraById(cameraId: string, params?: ApiCredentials): Promise<CamerasResponsePayload>;
+        getCameraLastPublicNote(cameraId: string): Promise<CameraLogsResponsePayload>;
+        getNvrStreamingToken({ cameraExid, token, }: {
+            cameraExid: string;
+            token: string;
+        }): Promise<string>;
+        getCameraStatusLogs(exid: string, params: {
+            params: {
+                from: string;
+                to: string;
+            };
+        }): Promise<CameraStatusLog[]>;
+        updateCamera(exid: string, params: Partial<CameraUpdateRequestPayload>): Promise<CamerasResponsePayload>;
+    };
+    projects: {
+        index({ params, config, }?: {
+            params?: ApiCredentials;
+            config?: SwrRequestConfig<Project[]>;
+        }): Promise<Project[]>;
+        create(params: {
+            name: string;
+        }): Promise<{
+            project: ProjectCreateResponse;
+        }>;
+        getLogos(projectId: string): Promise<ProjectLogoResponsePayload>;
+        createLogo(projectId: string, formData: FormData): Promise<Logo>;
+        deleteLogo(projectId: string, id: number): Promise<void>;
+        updateLogo(projectId: string, id: number, name: string): Promise<Logo>;
+        updateThumbnail(projectExid: string, params: {
+            cameraExid?: string;
+            uploadedThumbnail?: string;
+        }): Promise<{
+            message: string;
+        }>;
+        getThumbnailData(projectExid: string): Promise<ThumbnailData>;
+        updateCamerasRestriction(projectExid: ProjectExid, payload: UpdateCameraRestrictionPayload): Promise<void>;
+        reorderCameras(projectExid: ProjectExid, payload: ReorderCamerasPayload): Promise<void>;
+        updatePlaceholderThumbnail(projectExid: string, params: {
+            placeholder?: string;
+        }): Promise<{
+            message: string;
+        }>;
+        getPlaceholderThumbnailData(projectExid: string): Promise<PlaceholderThumbnailData>;
+        transferOwnership(projectExid: string, newOwnerId: number): Promise<{
+            message: string;
+        }>;
+        getUsers(projectExid: string): Promise<ProjectUsersResponsePayload>;
+        getCameras(projectExid: string): Promise<{
+            cameras: Camera[];
+        }>;
+        getCameraRefs(projectExid: string): Promise<{
+            cameras: Camera[];
+        }>;
+        getTeamMembers(): Promise<ProjectMember[]>;
+        getMembers(projectExid: string): Promise<ProjectMembersResponsePayload>;
+        inviteMembers(projectExid: string, payload: ProjectMembersRequestPayload): Promise<ProjectInviteMembersResponsePayload>;
+        removeMembers(projectExid: string, emails: string[]): Promise<void>;
+        updateMembersRole(projectExid: string, payload: ProjectMembersRequestPayload): Promise<void>;
+        requestCameraInfo(projectExid: string): Promise<void>;
+    };
+    timelapse: {
+        getSnapshotRange(cameraId: string, payload: TimelapseSnapshotRequestPayload, extraParams?: AxiosRequestConfig): Promise<TimelapseSnapshotResponsePayload>;
+        createTimelapse(projectExid: string, payload: TimelapseCreationRequestPayload): Promise<TimelapseCreationResponsePayload>;
+        cUpdate(projectExid: string, id: string | number, payload: MediaUpdateRequestPayload): Promise<TimelapseCreationResponsePayload>;
+        cDelete(projectExid: string, id: number): Promise<void>;
+    };
+    compares: {
+        cCreate(projectExid: string, payload: CompareRequestPayload): Promise<Compare>;
+        cShow(projectExid: string, id: string): Promise<Compare>;
+        cUpdate(projectExid: string, id: string, payload: MediaUpdateRequestPayload): Promise<Compare>;
+        cDelete(projectExid: string, id: string): Promise<void>;
+    };
+    projectConnectos: {
+        index(projectExid: string): Promise<Array<XWeatherResponse>>;
+    };
+    providers: {
+        getProviders(): Promise<ConnectorResponsePayload>;
+    };
+    aconex: {
+        authenticate(payload: AconexAuthCallbackParams): Promise<void>;
+        getUserProjects(): Promise<AconexUserProject[]>;
+        revoke(): Promise<void>;
+        uploadEditedSnapshot(projectId: number, payload: AconexEditedImageUploadRequestPayload): Promise<void>;
+        getDocumentSchema(projectId: number): Promise<AconexDocumentSchema[]>;
+        getDocumentTypeSchema(projectId: number, documentTypeId: string): Promise<AconexDocumentTypeSchema[]>;
+    };
+    procore: {
+        getUserCompanies(): Promise<ProcoreUserCompaniesResponsePayload>;
+        getUserProjects(payload: ProcoreCompanyRequestPayload): Promise<ProcoreUserProjectsResponsePayload>;
+        getUserProjectPermissions(payload: ProcoreProjectRequestPayload): Promise<ProcoreUserProjectPermissionsResponsePayload>;
+        getProjectAlbums(payload: ProcoreProjectRequestPayload): Promise<ProcoreProjectsAlbumsPayload>;
+        uploadEditedSnapshot(payload: ProcoreEditedImageUploadRequestPayload): Promise<void>;
+        sendRevoke(): Promise<void>;
+        getObservationTypes(payload: ProcoreProjectRequestPayload): Promise<ProcoreObservationTypesResponsePayload>;
+        getObservationForm(payload: ProcoreObservationFormRequestPayload): Promise<ProcoreObservationForm>;
+        getNextAvailableObservationNumber(payload: ProcoreProjectRequestPayload): Promise<ProcoreNextObservationAvailableNumber>;
+        getAssignees(payload: ProcoreProjectRequestPayload): Promise<Array<ProcoreObservationAssignee>>;
+        getDistributionMembers(payload: ProcoreProjectRequestPayload): Promise<Array<ProcoreObservationDistributionMember>>;
+        createObservation(formData: FormData): Promise<void>;
+        getContributingBehaviors(payload: ProcoreCompanyRequestPayload): Promise<ProcoreObservationDefaultList>;
+        getContributingConditions(payload: ProcoreCompanyRequestPayload): Promise<ProcoreObservationDefaultList>;
+        getTrades(payload: ProcoreCompanyRequestPayload): Promise<Array<ProcoreObservationTrades>>;
+        getHazards(payload: ProcoreCompanyRequestPayload): Promise<ProcoreObservationDefaultList>;
+        getLocations(payload: ProcoreProjectRequestPayload): Promise<Array<ProcoreObservationLocation>>;
+        getSpecificationSections(payload: ProcoreProjectRequestPayload): Promise<Array<ProcoreObservationSpecificationSection>>;
+        getCustomFieldOptions(payload: ProcoreCustomFieldOptionsRequestPayload): Promise<Array<ProcoreObservationListItem>>;
+    };
+    autodesk: {
+        sendRevoke(): Promise<void>;
+        getUserHubs(): Promise<AutodeskUserHub[]>;
+        getProjects(hubId: string): Promise<AutodeskProject[]>;
+        getFolders(hubId: string, projectId: string): Promise<Array<AutodeskFolder>>;
+        getSubFolders(projectId: string, parentFolderId: string, getDerivatives: boolean): Promise<Array<AutodeskFolder>>;
+        getFolder(projectId: string, folderId: string): Promise<AutodeskFolder>;
+        uploadEditedSnapshot(payload: AutodeskSnapshot): Promise<null>;
+        fetchViewerToken(exid: string): Promise<AutodeskTokenResponsePayload>;
+    };
+    voyageControl: {
+        connect(payload: VoyageControlConnectorPayload): Promise<void>;
+        sendRevoke(): Promise<void>;
+    };
+    hammertech: {
+        connect(payload: HammertechConnectPayload): Promise<void>;
+        revoke(): Promise<void>;
+        getProjects(): Promise<HammertechProject[]>;
+        getIssueTypes(projectId: string): Promise<HammertechIssueType[]>;
+        getLocations(projectId: string): Promise<HammertechLocation[]>;
+        createIssue(payload: HammertechCreateIssuePayload): Promise<HammertechIssueResponse>;
+        createStoredFile(payload: HammertechStoredFilePayload): Promise<HammertechStoredFileResponse>;
+    };
+    ring: {
+        completeLinking(payload: RingCompleteLinkingPayload): Promise<RingCompleteLinkingResponsePayload>;
+        getDevices(): Promise<RingDevicesResponsePayload>;
+        moveDevice(cameraExid: string, payload: RingMoveDevicePayload): Promise<RingMoveDeviceResponsePayload>;
+        deleteDevice(cameraExid: string): Promise<{
+            status: string;
+            cameraExid: string;
+        }>;
+        disconnect(): Promise<void>;
+        startLiveView(cameraExid: string, payload: RingLiveViewPayload): Promise<RingLiveViewResponse>;
+        stopLiveView(cameraExid: string, sessionId: string): Promise<RingStopLiveViewResponse>;
+    };
+    xweather: {
+        connect(projectExid: string, payload: XWeatherCreatePayload): Promise<XWeatherResponse>;
+        revoke(projectExid: string): Promise<void>;
+    };
+    recordings: {
+        oldest(cameraId: string, payload?: SnapshotRequestPayload): Promise<Snapshot>;
+        latest(cameraId: string, payload?: SnapshotRequestPayload): Promise<Snapshot>;
+        nearest(cameraId: string, timestamp: string, payload?: SnapshotRequestPayload, extraParams?: AxiosRequestConfig): Promise<NearestSnapshotResponsePayload>;
+        availableDays({ cameraId, year, month, payload, cancelToken, }: AvailableDaysRequestPayload): Promise<AvailableDaysResponsePayload>;
+        availableHours({ cameraId, year, month, day, payload, cancelToken, }: AvailableHoursRequestPayload): Promise<AvailableHoursResponsePayload>;
+        getSnapshot(cameraId: string, dateTime: string): Promise<SnapshotRangeResponsePayload>;
+        getSnapshotRange(cameraId: string, payload: SnapshotRangeRequestPayload, extraParams?: AxiosRequestConfig): Promise<SnapshotRangeResponsePayload>;
+    };
+    progressPhotos: {
+        index(projectId: string): Promise<ProgressPhotosResponsePayload>;
+        show(id: string): Promise<ProgressPhotoItemResponsePayload>;
+        create(payload: ProgressPhotosCreateUpdateRequestPayload): Promise<ProgressPhotosResponsePayload>;
+        update(id: string | number, payload: ProgressPhotosCreateUpdateRequestPayload): Promise<Automation>;
+        unsubscribe(progressPhotoId: string, params: ProgressPhotosUnSubscribeParams): Promise<ProgressPhotosResponsePayload>;
+        delete(id: string, params?: ApiCredentials): Promise<void>;
+    };
+    mediaHub: {
+        getAllMedia(projectExid: string, params: MediaFilterQueryParams): Promise<PaginatedItems<Media>>;
+        getAllMediaUsers(projectExid: string): Promise<MediaUsersResponsePayload>;
+        cShow(projectExid: string, id: string): Promise<Media>;
+        cCreate(projectExid: string, payload: FormData | MediaCreateRequestPayload, onUploadProgress?: (progressEvent: any) => void): Promise<Media>;
+        cUpdate(projectExid: string, id: string, payload: MediaUpdateRequestPayload): Promise<Media>;
+        cDelete(projectExid: string, id: string): Promise<void>;
+    };
+    shares: {
+        deleteShareRequest(payload: {
+            params: ShareDeletionRequestPayload;
+        }): Promise<void>;
+        getSharedUsers(cameraId: string): Promise<SharedUsersResponsePayload>;
+        getShareRequestByKey(key: string): Promise<Pick<ShareCreateResponsePayload, "shareRequests">>;
+    };
+    company: {
+        show(companyId?: string, params?: {
+            with_zoho?: boolean;
+        }): Promise<CompanySummary>;
+        getCompanyUsers(params: {
+            params: {
+                page: number;
+                limit: number;
+            };
+        }): Promise<PaginatedItems<CompanyUser>>;
+        getCompanyProjects(params: {
+            params: {
+                page: number;
+                limit: number;
+            };
+        }): Promise<PaginatedItems<CompanyProject>>;
+        getCompanyCameras(params: PaginationParams | {
+            params: PaginationParams;
+        }): Promise<PaginatedItems<CompanyCameraSummary>>;
+        getCompanyKits(params: {
+            params: {
+                page: number;
+                limit: number;
+            };
+        }): Promise<PaginatedItems<CompanyKit>>;
+    };
+    batteries: {
+        ProjectBatteryReadings(projectExid: string): Promise<ProjectBatteryReading[]>;
+        batteryReadings(cameraExid: string, params: {
+            fromDate: string;
+            toDate: string;
+        }): Promise<PaginatedItems<BatteryReading>>;
+        readingsVoltageSummary(cameraExid: string, params: {
+            fromDate: string;
+            toDate: string;
+        }): Promise<BatteryVoltage[]>;
+    };
+    layers: {
+        getLayer(cameraId: string, params: BimLayersQueryParams, extraParams?: AxiosRequestConfig): Promise<BIMLayer>;
+        getLayersById(cameraId: string, id: number, params: ApiCredentials): Promise<BIMLayer>;
+        getLayers(cameraId: string, params: BimLayersQueryParams): Promise<BIMLayer[]>;
+        createLayer(cameraId: string, params: BIMLayerPostPayload): Promise<BIMLayer>;
+        deleteLayer(cameraId: string, id: number, params?: ApiCredentials): Promise<void>;
+        updateLayer(cameraId: string, id: number, params: Partial<BIMLayerPostPayload>): Promise<BIMLayer>;
+    };
+    comments: {
+        fetchComments(projectExid: string, params: CommentsRequestPayload): Promise<PaginatedItems<Comment>>;
+        addComment(projectId: string, params: CommentCreationRequestPayload): Promise<Comment>;
+        archiveOrUnarchiveComment(projectId: string, id: number, archive: boolean): Promise<Comment>;
+        deleteComment(projectId: string, id: number): Promise<void>;
+    };
+    storyblock: {
+        getStory(params: {
+            route: string;
+            params: string;
+        }): Promise<StoryblokResponse>;
+    };
+    snapshots: {
+        deliverViaEmail(projectExid: string, payload: SnapshotEmailDeliveryRequestPayload): Promise<SnapshotEmailDeliveryResponsePayload>;
+    };
+    sockets: {
+        getWsToken(): Promise<SocketAuthResponsePayload>;
+    };
+    mailing: {
+        unsubscribe(params: {
+            key: string;
+        }): Promise<void>;
+    };
+    widgets: {
+        index(params: Partial<WidgetsListRequestPayload>): Promise<PaginatedItems<Widget>>;
+        show(id: number): Promise<WidgetFull>;
+        getByKeys(): Promise<WidgetFull>;
+        setSessionSettings(params: WidgetSessionSettingsPayload): Promise<WidgetFull>;
+        setStatus(id: number, params: {
+            active: boolean;
+        }): Promise<WidgetFull>;
+        create(payload: WidgetPayload): Promise<WidgetFull>;
+        update(id: number, payload: WidgetPayload): Promise<WidgetFull>;
+        delete(id: number): Promise<void>;
+    };
+    developerApps: {
+        index(): Promise<{
+            items: OAuthClient[];
+        }>;
+        show(clientId: string): Promise<OAuthClient>;
+        create(payload: CreateOAuthClientPayload): Promise<OAuthClientWithSecret>;
+        update(clientId: string, payload: UpdateOAuthClientPayload): Promise<OAuthClient>;
+        delete(clientId: string): Promise<void>;
+        regenerateSecret(clientId: string): Promise<OAuthClientWithSecret>;
+    };
+    oauth: {
+        getClientInfo(clientId: string, scope: string): Promise<OAuthConsentInfo>;
+        submitConsent(payload: OAuthConsentPayload): Promise<OAuthConsentResponse>;
+    };
+    zoho: {
+        getDealLocation(dealId: string): Promise<{
+            geographicBounds: GeoJSONPolygon | null;
+        }>;
+        updateDealLocation(dealId: string, payload: {
+            geographicBounds: GeoJSONPolygon;
+        }): Promise<void>;
+    };
+};

package/dist/api/api/evercamLabsApi.d.ts

@@ -0,0 +1,45 @@
+import { CameraExid, CopilotConversation, CopilotMessage, CopilotMessageStep, FeedbackPayload, GrafanaKitMetrics, LabsPaginationParams, LuminanceReading, PaginatedItems, ActiveUsersResponsePayload, ActiveUsersRequestPayload, PosthogUsersRequestParams, PosthogUsersResponse, HeatmapIntersectionsRequestParams, SmartSearchHeatmapPoint, SiteAnalyticsProcessingStatusPayload, SiteAnalyticsProcessingStatus, SwrRequestConfig, GrafanaMetricId, KitMetricPeriod } from "@evercam/api/types";
+export declare function getLabsBaseUrl(): string | null | undefined;
+export declare const EvercamLabsApi: {
+    posthog: {
+        getEvents(params: any): Promise<PaginatedItems<any>>;
+        getUsers(params: PosthogUsersRequestParams): Promise<PosthogUsersResponse>;
+        getActiveUsers(params: ActiveUsersRequestPayload): Promise<{
+            data: ActiveUsersResponsePayload;
+        }>;
+    };
+    copilot: {
+        getAllConversations(params: LabsPaginationParams & {
+            cameraExid?: string;
+            projectExid?: string;
+            user?: string;
+        }): Promise<PaginatedItems<CopilotConversation>>;
+        getOneConversation(conversationId: number): Promise<PaginatedItems<CopilotConversation>>;
+        getConversationMessages(conversationId: number, params: LabsPaginationParams): Promise<PaginatedItems<CopilotMessage>>;
+        getMessageSteps(message: CopilotMessage): Promise<CopilotMessageStep[]>;
+        submitMessageFeedback({ conversationId, messageId, ...params }: FeedbackPayload): Promise<import("axios").AxiosResponse<any, any>>;
+    };
+    siteAnalytics: {
+        getProcessingStatus(params?: SiteAnalyticsProcessingStatusPayload, config?: SwrRequestConfig<SiteAnalyticsProcessingStatus[]>): Promise<SiteAnalyticsProcessingStatus[]>;
+        getIntersectionsHeatmapData(params: HeatmapIntersectionsRequestParams): Promise<SmartSearchHeatmapPoint[]>;
+    };
+    googleCloudStorage: {
+        listFiles(prefix?: string): Promise<{
+            files: string[];
+            folders: string[];
+        }>;
+        getSignedUrl(fileName: string): Promise<{
+            url: string;
+        }>;
+    };
+    luminance: {
+        getReadings(params: {
+            cameraExid: CameraExid;
+            fromDate: string;
+            toDate: string;
+        }): Promise<LuminanceReading[]>;
+    };
+    kits: {
+        getMetrics(kitId: string, metrics: GrafanaMetricId[], period?: KitMetricPeriod): Promise<GrafanaKitMetrics>;
+    };
+};

package/dist/api/{exNvrApi.d.ts → api/exNvrApi.d.ts}

@@ -1,4 +1,4 @@
-import { ExNvrDeviceConfig, ExNvrLoginResponse, ExNvrRecordingInterval, ExNvrSystemStatus } from "@evercam/api/types/";
+import { ExNvrDeviceConfig, ExNvrLoginResponse, ExNvrRecordingInterval, ExNvrSystemStatus } from "@evercam/api/types";
 export declare const ExNvrApi: {
     users: {
         login({ apiUrl, username, password, }: {

package/dist/api/api/index.d.ts

@@ -0,0 +1,13 @@
+export * from "./client";
+export * from "./adminApi";
+export * from "./videoWallApi";
+export * from "./3dFirebaseApi";
+export * from "./aiApi";
+export * from "./webRtcApi";
+export * from "./weatherApi";
+export * from "./evercamLabsApi";
+export * from "./evercamApi";
+export * from "./ptzApi";
+export * from "./ingestApi";
+export * from "./exNvrApi";
+export * from "./authzApi";

package/dist/api/api/ingestApi.d.ts

@@ -0,0 +1,162 @@
+import type { AxiosRequestConfig } from "axios";
+import type { SwrRequestConfig } from "@evercam/api/types";
+import type { _360AssetsQueryParams, _360AssetsRequestPayload, _360QueueQueryParams, _360AssetsUploadPayload, _360AssetsResponse, _360AssetsCountsResponse, _360QueueResponse, _360FloorsResponse, DroneQueueResponse, DroneUploadsResponse, IngestUploadInitResponse, BimUploadsResponse, MobileAssetsQueryParams, MobileCaptureAssetsResponse, BimUploadPayload, BimUploadsQueryParams, CalculateMeasuringOperationRequestPayload, DrawingsRequestPayload, DronesQueryParams, DroneUploadUpdateRequestPayload, IngestProcessingProgress, FlightImagesQueryParams, Generate360MapRequestPayload, GenerateFloorPayload, InspectionToolRequestPayload, JsonObject, _360WalkV2, _360FloorV2 } from "@evercam/api/types";
+import { IngestVersions, IngestTypes } from "@evercam/api/types";
+export declare const getIngestApiUrls: (type: string) => string[];
+export declare const IngestApi: {
+    drone: {
+        createUpload(projectId: string, params: {
+            uploadedBy: string;
+        }): Promise<IngestUploadInitResponse>;
+        reprocessDrone(id: number, params?: JsonObject): Promise<void>;
+        getDrones(params: {
+            params: Partial<DronesQueryParams>;
+        }): Promise<DroneUploadsResponse>;
+        getProcessingProgress(id: number): Promise<IngestProcessingProgress>;
+        getArchive(id: number, params: {
+            dataType: string;
+        }): Promise<Blob>;
+        deleteUpload(id: number): Promise<void>;
+        prepareForUpload(projectId: string, params: {
+            uploadedBy: string;
+            token: string;
+        }): Promise<void>;
+        upload(projectId: string, params: {
+            uploadedBy: string;
+            token: string;
+        }, payload: DroneUploadUpdateRequestPayload): Promise<void>;
+        verifyToken(projectId: string, params: {
+            token: string;
+        }): Promise<JsonObject>;
+        calculateMeasuringOperation(projectId: string, params: CalculateMeasuringOperationRequestPayload, ingestUrl?: string): Promise<JsonObject>;
+        inspectionTool(projectId: string, params: InspectionToolRequestPayload): Promise<JsonObject>;
+        isInspectionEnabled(projectId: string, params?: JsonObject): Promise<JsonObject>;
+        getDroneQueueSize(droneUrl: string): Promise<DroneQueueResponse>;
+        getFlightImages(projectId: string, params: FlightImagesQueryParams): Promise<JsonObject>;
+        checkFlightAvailableFeatures(projectId: string, params: JsonObject): Promise<JsonObject>;
+    };
+    assets360: {
+        get360Assets(params: {
+            params: Partial<_360AssetsQueryParams>;
+        }): Promise<_360AssetsResponse>;
+        get360AssetsCounts(projectId: string, params: {
+            uploadedBy: string;
+        }): Promise<_360AssetsCountsResponse>;
+        get360AssetLink(projectId: string, date: string, floor: string | number, assetType: string, drawingId: string | number, marker: string | null): Promise<string | string[]>;
+        update360(id: number, payload: _360AssetsRequestPayload): Promise<_360WalkV2>;
+        update360ByProjectDateName(projectId: string, date: string, floor: string, payload: Partial<_360AssetsRequestPayload> & {
+            drawingId?: number;
+        }): Promise<_360WalkV2>;
+        deleteUpload(id: number): Promise<void>;
+        getArchive(id: number, params: {
+            dateType: string;
+        }): Promise<Blob>;
+        get360Progress(id: number): Promise<IngestProcessingProgress>;
+        createUpload(projectId: string, params: _360AssetsRequestPayload): Promise<IngestUploadInitResponse>;
+        upload(id: number, params: JsonObject, payload: _360AssetsUploadPayload): Promise<_360WalkV2>;
+        reprocess360(id: number): Promise<void>;
+        drawingExists(payload: {
+            params: {
+                name: string;
+                project_id: string;
+            };
+        }): Promise<JsonObject>;
+        getDrawings(payload: {
+            params: DrawingsRequestPayload;
+            config?: SwrRequestConfig<_360FloorsResponse>;
+        }): Promise<_360FloorsResponse>;
+        getDrawingById(id: number, projectExid: string): Promise<_360FloorV2>;
+        updateDrawing(id: number, projectExid: string, payload: GenerateFloorPayload): Promise<_360FloorV2>;
+        deleteDrawing(id: number): Promise<void>;
+        restoreDrawing(id: number): Promise<void>;
+        transferWalks(sourceId: number, targetId: number, projectExid: string): Promise<void>;
+        createDrawing(projectExid: string, payload: GenerateFloorPayload, createdBy: string): Promise<_360FloorV2>;
+        fetchDrawingOverlay(id: number, params: {
+            view: boolean;
+            thumbnail?: boolean;
+        }, onDownloadProgress?: (progress: ProgressEvent) => void, extraConfig?: AxiosRequestConfig): Promise<string>;
+        getFloorArchive(id: number): Promise<string>;
+        generate360map(projectId: string, params: Generate360MapRequestPayload): Promise<JsonObject>;
+        get360QueueSize(ingestUrl: string, params?: _360QueueQueryParams): Promise<_360QueueResponse>;
+    };
+    bim: {
+        createUpload(projectId: string, params: {
+            uploadedBy: string;
+        }): Promise<IngestUploadInitResponse>;
+        getBIMs(params: {
+            params: Partial<BimUploadsQueryParams>;
+        }): Promise<BimUploadsResponse>;
+        getArchive(id: number): Promise<Blob>;
+        deleteUpload(id: number): Promise<void>;
+        upload(projectId: string, params: {
+            id: string;
+            name: string;
+        }, payload: BimUploadPayload): Promise<void>;
+    };
+    webhook: {
+        notifyBimUpdated(projectId: string, bimIdentifier: string): Promise<void>;
+    };
+    mobileCapture: {
+        getProjectMobileAssets(params: MobileAssetsQueryParams, extraConfig?: AxiosRequestConfig): Promise<MobileCaptureAssetsResponse>;
+        getMobileAssetPhoto(assetId: string | number, params: {
+            projectId?: string;
+            project_id?: string;
+            isThumbnail?: boolean;
+            is_thumbnail?: boolean;
+        }): Promise<string>;
+        deleteAsset(assetId: string | number): Promise<void>;
+    };
+    utils: {
+        loadAllAssetsInQueue(): Promise<({
+            ingestVersion: string;
+            id: number;
+            projectId: string;
+            consumed: boolean;
+            token: string;
+            flightDate: string;
+            flightGeolocation: string;
+            modelZip: string;
+            orthomosaicZip: string;
+            reportPdf: string;
+            processingLog: string;
+            uploadedBy: string;
+            processingStatus: import("@evercam/api/types").IngestProcessingStatus | string;
+            modelCesiumAssetId: string;
+            updatedAt: string;
+            hasTusLinks: boolean;
+            hasSteps: boolean;
+            aerialShots: import("@evercam/api/types").AerialShotItem[];
+        } | {
+            ingestVersion: string;
+            archive: string;
+            date: string;
+            deviceSerial: string | null;
+            endPosition: string | null;
+            floor: string;
+            floorId: number;
+            id: number;
+            images: string[];
+            insertedAt: string;
+            mobileAudios: string[];
+            mobileAudiosArchive: string;
+            mobilePhotos: string[];
+            mobilePhotosArchive: string;
+            model: string;
+            name: string;
+            processingStatus: string;
+            projectId: string;
+            report: string;
+            processingLog: string;
+            hasSteps?: boolean;
+            route: unknown | null;
+            startPosition: string | null;
+            tusLinks: unknown | null;
+            updatedAt: string;
+            uploadedBy: string;
+            videoArchive: string;
+            videos: string[];
+        })[]>;
+        getIngestVersion(ingestUrl: string): IngestVersions;
+        chooseIngestApiUrl(type: IngestTypes): Promise<string>;
+    };
+};

package/dist/api/{ptzApi.d.ts → api/ptzApi.d.ts}

@@ -1,9 +1,14 @@
-import { MoveParams, ZoomParams } from "@/types";
+import { MoveParams, ZoomParams } from "@evercam/api/types";
 export declare const PtzApi: {
     presets: {
-        index({ cameraExid }: {
+        index({ cameraExid, }: {
             cameraExid: string;
-        }): Promise<import("axios").AxiosResponse<any, any>>;
+        }): Promise<{
+            presets: Array<{
+                name: string;
+                token: string;
+            }>;
+        }>;
         go({ cameraExid, presetId, }: {
             cameraExid: string;
             presetId: string | number;
@@ -21,6 +26,10 @@ export declare const PtzApi: {
             presetId: string | number;
             presetName: string;
         }): Promise<import("axios").AxiosResponse<any, any>>;
+        updateHome({ cameraExid, presetName, }: {
+            cameraExid: string;
+            presetName: string;
+        }): Promise<import("axios").AxiosResponse<any, any>>;
         delete({ cameraExid, presetId, }: {
             cameraExid: string;
             presetId: string | number;

package/dist/api/api/videoWallApi.d.ts

@@ -0,0 +1,9 @@
+import { type PaginatedItems } from "@evercam/shared/types";
+import { VideoWall, VideoWallListParams, VideoWallCreateUpdatePayload } from "@evercam/api/types/videoWall";
+export declare const VideoWallApi: {
+    list(params?: VideoWallListParams): Promise<import("axios").AxiosResponse<PaginatedItems<VideoWall>, any>>;
+    create(body: VideoWallCreateUpdatePayload): Promise<import("axios").AxiosResponse<VideoWall, any>>;
+    get(exid: string | number): Promise<import("axios").AxiosResponse<VideoWall, any>>;
+    update(exid: string | number, body: Partial<VideoWallCreateUpdatePayload>): Promise<import("axios").AxiosResponse<VideoWall, any>>;
+    delete(exid: string | number): Promise<import("axios").AxiosResponse<any, any>>;
+};

package/dist/api/api/weatherApi.d.ts

@@ -0,0 +1,9 @@
+import { CurrentWeatherRequestPayload, HistoryWeatherRequestPayload, WeatherDataResponse, WeatherReportRequestPayload, WeatherResponsePayload } from "@evercam/api/types";
+import { AxiosRequestConfig } from "axios";
+export declare const WeatherApi: {
+    current(projectExid: string, payload: CurrentWeatherRequestPayload): Promise<WeatherResponsePayload> | undefined;
+    historical(projectExid: string, payload: HistoryWeatherRequestPayload): Promise<WeatherResponsePayload> | undefined;
+    report(projectExid: string, payload: WeatherReportRequestPayload, config?: AxiosRequestConfig): Promise<{
+        data: WeatherDataResponse[];
+    }> | undefined;
+};

package/dist/api/index.d.ts

@@ -1,13 +1,3 @@
-export * from "./client";
-export * from "./adminApi";
-export * from "./videoWallApi";
-export * from "./3dFirebaseApi";
-export * from "./aiApi";
-export * from "./webRtcApi";
-export * from "./weatherApi";
-export * from "./evercamLabsApi";
-export * from "./evercamApi";
-export * from "./ptzApi";
-export * from "./ingestApi";
-export * from "./exNvrApi";
-export * from "./authzApi";
+export * from "./api";
+export * from "./types";
+export * from "./utils";