@softruck/api-contracts 0.1.1-beta.3

package/dist/enterprises/types.d.ts

@@ -0,0 +1,160 @@
+import type { Deactivatable } from '../core/types';
+export interface EnterpriseAttributes extends Deactivatable {
+    name: string | null;
+    fantasy_name: string | null;
+    cnpj: string | null;
+    email: string | null;
+    phone1: string | null;
+    phone2: string | null;
+    assistance_emergency_tel: string | null;
+    theft_emergency_tel: string | null;
+    country: string | null;
+    timezone: string | null;
+    last_integration_source: string | null;
+    last_integration_time: string | null;
+}
+export interface Enterprise {
+    id: string;
+    attributes: EnterpriseAttributes;
+    relationships: {
+        country: {
+            attributes: {
+                name: string | null;
+                timezone: string | null;
+            };
+        } | null;
+    };
+}
+export interface EnterpriseAddress {
+    id: string;
+    attributes: {
+        formatted_address: string | null;
+    };
+}
+export type EnterpriseAddressType = 'BILLING' | 'DELIVERY' | 'OTHER';
+export interface CreateEnterpriseAddressPayload {
+    data: {
+        attributes: {
+            type: EnterpriseAddressType;
+            coords?: [number, number];
+            formatted_address: string;
+            street: string;
+            street_number?: string;
+            complement?: string;
+            city: string;
+            region: string;
+            country: string;
+            country_code?: string;
+            zip_code?: string;
+            description?: string;
+        };
+    };
+}
+export interface EnterpriseCustomization {
+    id: string;
+    attributes: {
+        domain: string | null;
+        color1: string | null;
+        color2: string | null;
+        apps: {
+            android: string | null;
+        } | null;
+    };
+}
+export interface EnterprisePublicResponse {
+    data: {
+        attributes: {
+            name: string;
+        };
+        relationships: {
+            customization: {
+                attributes: {
+                    color1: string;
+                    color2: string;
+                    layout: 'LEFT' | 'RIGHT' | 'CENTER';
+                };
+            };
+            document: {
+                attributes: {
+                    folder: string;
+                };
+            } | null;
+        };
+    } | null;
+}
+export interface BootstrapEnterpriseAttributes {
+    name: string | null;
+    phone1: string | null;
+    phone2: string | null;
+    email: string | null;
+    cnpj: string | null;
+    timezone: string;
+    main_client: boolean | null;
+    support: boolean | null;
+}
+export interface BootstrapEnterpriseData {
+    id: string;
+    attributes: BootstrapEnterpriseAttributes;
+    relationships: {
+        addresses: Array<Record<string, unknown>>;
+        country: Record<string, unknown> | null;
+        document: Record<string, unknown> | null;
+        regional_setting: Record<string, unknown> | null;
+    };
+}
+export interface Country {
+    id: string;
+    attributes: {
+        name: string | null;
+        timezones: string[];
+    };
+}
+export interface EnterpriseOverviewSummary {
+    vehicles: {
+        total: number;
+        actives: number;
+    };
+    devices: {
+        total: number;
+        actives: number;
+    };
+    users: {
+        total: number;
+        actives: number;
+    };
+    chips: {
+        total: number;
+    };
+    enterprises: {
+        total: number;
+    };
+    protocols: {
+        total: number;
+    };
+    service_orders: {
+        total: number;
+    };
+}
+export interface CreateEnterprisePayload {
+    attributes: {
+        name: string;
+        cnpj: string;
+        timezone: string;
+        fantasy_name?: string;
+        phone1?: string;
+        phone2?: string;
+        email?: string;
+        description?: string;
+        contact_name?: string;
+        state_registration_no?: string;
+        webpage?: string;
+        assistance_emergency_tel?: string;
+        theft_emergency_tel?: string;
+    };
+    relationships: {
+        country: {
+            type: 'country';
+            id: string;
+        };
+    };
+}

package/dist/enterprises/types.js

@@ -0,0 +1 @@
+export {};

package/dist/events/api.d.ts

@@ -0,0 +1,18 @@
+import type { ApiClientLike } from '../core/client';
+import type { QueryParams } from '../core/query-builder';
+import type { BoardEventsResponse, CreateEventPayload, Event, EventAttributes, EventDetail } from './types';
+export declare function createEventsApi(client: ApiClientLike): {
+    listBoard: (params?: Partial<QueryParams>, signal?: AbortSignal) => Promise<BoardEventsResponse>;
+    listByStatus: (params?: Partial<QueryParams>, signal?: AbortSignal) => Promise<{
+        data: Event[];
+    }>;
+    get: (id: string, signal?: AbortSignal) => Promise<{
+        data: EventDetail;
+    }>;
+    create: (payload: CreateEventPayload) => Promise<{
+        data: Event;
+    }>;
+    update: (id: string, payload: Partial<Pick<EventAttributes, "status" | "title">>) => Promise<undefined>;
+    remove: (id: string) => Promise<undefined>;
+    removeAlert: (eventId: string, alertId: string) => Promise<undefined>;
+};

package/dist/events/api.js

@@ -0,0 +1,13 @@
+import { withQuery } from '../core/query-builder.js';
+export function createEventsApi(client) {
+    const endpoint = '/v4/events';
+    return {
+        listBoard: (params = {}, signal) => client.get(withQuery(endpoint, params), { signal }).then((r) => r.data.data),
+        listByStatus: (params = {}, signal) => client.get(withQuery(endpoint, params), { signal }).then((r) => r.data),
+        get: (id, signal) => client.get(`${endpoint}/${id}`, { signal }).then((r) => r.data),
+        create: (payload) => client.post(endpoint, { data: payload }).then((r) => r.data),
+        update: (id, payload) => client.patch(`${endpoint}/${id}`, { data: payload }).then(() => undefined),
+        remove: (id) => client.delete(`${endpoint}/${id}`).then(() => undefined),
+        removeAlert: (eventId, alertId) => client.delete(`${endpoint}/${eventId}/alerts`, { data: { data: { alertIds: [alertId] } } }).then(() => undefined),
+    };
+}

package/dist/events/index.d.ts

@@ -0,0 +1,3 @@
+export * from './api';
+export * from './schemas';
+export * from './types';

package/dist/events/index.js

@@ -0,0 +1,3 @@
+export * from './api.js';
+export * from './schemas.js';
+export * from './types.js';

package/dist/events/schemas.d.ts

@@ -0,0 +1,262 @@
+import { z } from 'zod';
+export declare const EventStatusSchema: z.ZodEnum<{
+    done: "done";
+    todo: "todo";
+    doing: "doing";
+}>;
+export declare const EventAttributesSchema: z.ZodObject<{
+    title: z.ZodString;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    tags: z.ZodArray<z.ZodString>;
+    vals: z.ZodArray<z.ZodString>;
+    alertsCount: z.ZodNumber;
+    commentsCount: z.ZodNumber;
+    status: z.ZodEnum<{
+        done: "done";
+        todo: "todo";
+        doing: "doing";
+    }>;
+    createdAt: z.ZodString;
+    updatedAt: z.ZodString;
+}, z.core.$strip>;
+export declare const EventVehicleSchema: z.ZodObject<{
+    id: z.ZodNumber;
+    uuid: z.ZodString;
+    type: z.ZodString;
+    attributes: z.ZodObject<{
+        plate: z.ZodNullable<z.ZodString>;
+        vin: z.ZodNullable<z.ZodString>;
+        color: z.ZodNullable<z.ZodString>;
+        type: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    relationships: z.ZodObject<{
+        responsibles: z.ZodArray<z.ZodObject<{
+            id: z.ZodNumber;
+            attributes: z.ZodObject<{
+                name: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const EventSchema: z.ZodObject<{
+    id: z.ZodString;
+    attributes: z.ZodObject<{
+        title: z.ZodString;
+        description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+        tags: z.ZodArray<z.ZodString>;
+        vals: z.ZodArray<z.ZodString>;
+        alertsCount: z.ZodNumber;
+        commentsCount: z.ZodNumber;
+        status: z.ZodEnum<{
+            done: "done";
+            todo: "todo";
+            doing: "doing";
+        }>;
+        createdAt: z.ZodString;
+        updatedAt: z.ZodString;
+    }, z.core.$strip>;
+    relationships: z.ZodObject<{
+        vehicle: z.ZodNullable<z.ZodObject<{
+            id: z.ZodNumber;
+            uuid: z.ZodString;
+            type: z.ZodString;
+            attributes: z.ZodObject<{
+                plate: z.ZodNullable<z.ZodString>;
+                vin: z.ZodNullable<z.ZodString>;
+                color: z.ZodNullable<z.ZodString>;
+                type: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+            relationships: z.ZodObject<{
+                responsibles: z.ZodArray<z.ZodObject<{
+                    id: z.ZodNumber;
+                    attributes: z.ZodObject<{
+                        name: z.ZodNullable<z.ZodString>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const BoardColumnSchema: z.ZodObject<{
+    count: z.ZodNumber;
+    events: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        attributes: z.ZodObject<{
+            title: z.ZodString;
+            description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            tags: z.ZodArray<z.ZodString>;
+            vals: z.ZodArray<z.ZodString>;
+            alertsCount: z.ZodNumber;
+            commentsCount: z.ZodNumber;
+            status: z.ZodEnum<{
+                done: "done";
+                todo: "todo";
+                doing: "doing";
+            }>;
+            createdAt: z.ZodString;
+            updatedAt: z.ZodString;
+        }, z.core.$strip>;
+        relationships: z.ZodObject<{
+            vehicle: z.ZodNullable<z.ZodObject<{
+                id: z.ZodNumber;
+                uuid: z.ZodString;
+                type: z.ZodString;
+                attributes: z.ZodObject<{
+                    plate: z.ZodNullable<z.ZodString>;
+                    vin: z.ZodNullable<z.ZodString>;
+                    color: z.ZodNullable<z.ZodString>;
+                    type: z.ZodNullable<z.ZodString>;
+                }, z.core.$strip>;
+                relationships: z.ZodObject<{
+                    responsibles: z.ZodArray<z.ZodObject<{
+                        id: z.ZodNumber;
+                        attributes: z.ZodObject<{
+                            name: z.ZodNullable<z.ZodString>;
+                        }, z.core.$strip>;
+                    }, z.core.$strip>>;
+                }, z.core.$strip>;
+            }, z.core.$strip>>;
+        }, z.core.$strip>;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export declare const BoardEventsResponseSchema: z.ZodObject<{
+    todo: z.ZodObject<{
+        count: z.ZodNumber;
+        events: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            attributes: z.ZodObject<{
+                title: z.ZodString;
+                description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                tags: z.ZodArray<z.ZodString>;
+                vals: z.ZodArray<z.ZodString>;
+                alertsCount: z.ZodNumber;
+                commentsCount: z.ZodNumber;
+                status: z.ZodEnum<{
+                    done: "done";
+                    todo: "todo";
+                    doing: "doing";
+                }>;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            }, z.core.$strip>;
+            relationships: z.ZodObject<{
+                vehicle: z.ZodNullable<z.ZodObject<{
+                    id: z.ZodNumber;
+                    uuid: z.ZodString;
+                    type: z.ZodString;
+                    attributes: z.ZodObject<{
+                        plate: z.ZodNullable<z.ZodString>;
+                        vin: z.ZodNullable<z.ZodString>;
+                        color: z.ZodNullable<z.ZodString>;
+                        type: z.ZodNullable<z.ZodString>;
+                    }, z.core.$strip>;
+                    relationships: z.ZodObject<{
+                        responsibles: z.ZodArray<z.ZodObject<{
+                            id: z.ZodNumber;
+                            attributes: z.ZodObject<{
+                                name: z.ZodNullable<z.ZodString>;
+                            }, z.core.$strip>;
+                        }, z.core.$strip>>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    doing: z.ZodObject<{
+        count: z.ZodNumber;
+        events: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            attributes: z.ZodObject<{
+                title: z.ZodString;
+                description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                tags: z.ZodArray<z.ZodString>;
+                vals: z.ZodArray<z.ZodString>;
+                alertsCount: z.ZodNumber;
+                commentsCount: z.ZodNumber;
+                status: z.ZodEnum<{
+                    done: "done";
+                    todo: "todo";
+                    doing: "doing";
+                }>;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            }, z.core.$strip>;
+            relationships: z.ZodObject<{
+                vehicle: z.ZodNullable<z.ZodObject<{
+                    id: z.ZodNumber;
+                    uuid: z.ZodString;
+                    type: z.ZodString;
+                    attributes: z.ZodObject<{
+                        plate: z.ZodNullable<z.ZodString>;
+                        vin: z.ZodNullable<z.ZodString>;
+                        color: z.ZodNullable<z.ZodString>;
+                        type: z.ZodNullable<z.ZodString>;
+                    }, z.core.$strip>;
+                    relationships: z.ZodObject<{
+                        responsibles: z.ZodArray<z.ZodObject<{
+                            id: z.ZodNumber;
+                            attributes: z.ZodObject<{
+                                name: z.ZodNullable<z.ZodString>;
+                            }, z.core.$strip>;
+                        }, z.core.$strip>>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+    done: z.ZodObject<{
+        count: z.ZodNumber;
+        events: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            attributes: z.ZodObject<{
+                title: z.ZodString;
+                description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                tags: z.ZodArray<z.ZodString>;
+                vals: z.ZodArray<z.ZodString>;
+                alertsCount: z.ZodNumber;
+                commentsCount: z.ZodNumber;
+                status: z.ZodEnum<{
+                    done: "done";
+                    todo: "todo";
+                    doing: "doing";
+                }>;
+                createdAt: z.ZodString;
+                updatedAt: z.ZodString;
+            }, z.core.$strip>;
+            relationships: z.ZodObject<{
+                vehicle: z.ZodNullable<z.ZodObject<{
+                    id: z.ZodNumber;
+                    uuid: z.ZodString;
+                    type: z.ZodString;
+                    attributes: z.ZodObject<{
+                        plate: z.ZodNullable<z.ZodString>;
+                        vin: z.ZodNullable<z.ZodString>;
+                        color: z.ZodNullable<z.ZodString>;
+                        type: z.ZodNullable<z.ZodString>;
+                    }, z.core.$strip>;
+                    relationships: z.ZodObject<{
+                        responsibles: z.ZodArray<z.ZodObject<{
+                            id: z.ZodNumber;
+                            attributes: z.ZodObject<{
+                                name: z.ZodNullable<z.ZodString>;
+                            }, z.core.$strip>;
+                        }, z.core.$strip>>;
+                    }, z.core.$strip>;
+                }, z.core.$strip>>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const CreateEventPayloadSchema: z.ZodObject<{
+    title: z.ZodString;
+    description: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    alerts: z.ZodArray<z.ZodObject<{
+        tag: z.ZodString;
+        val: z.ZodString;
+        act: z.ZodNumber;
+        flood: z.ZodBoolean;
+        lat: z.ZodNullable<z.ZodNumber>;
+        lng: z.ZodNullable<z.ZodNumber>;
+        did: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;

package/dist/events/schemas.js

@@ -0,0 +1,54 @@
+import { z } from 'zod';
+export const EventStatusSchema = z.enum(['todo', 'doing', 'done']);
+export const EventAttributesSchema = z.object({
+    title: z.string(),
+    description: z.string().nullable().optional(),
+    tags: z.array(z.string()),
+    vals: z.array(z.string()),
+    alertsCount: z.number(),
+    commentsCount: z.number(),
+    status: EventStatusSchema,
+    createdAt: z.string(),
+    updatedAt: z.string(),
+});
+export const EventVehicleSchema = z.object({
+    id: z.number(),
+    uuid: z.string(),
+    type: z.string(),
+    attributes: z.object({
+        plate: z.string().nullable(),
+        vin: z.string().nullable(),
+        color: z.string().nullable(),
+        type: z.string().nullable(),
+    }),
+    relationships: z.object({
+        responsibles: z.array(z.object({ id: z.number(), attributes: z.object({ name: z.string().nullable() }) })),
+    }),
+});
+export const EventSchema = z.object({
+    id: z.string(),
+    attributes: EventAttributesSchema,
+    relationships: z.object({ vehicle: EventVehicleSchema.nullable() }),
+});
+export const BoardColumnSchema = z.object({
+    count: z.number(),
+    events: z.array(EventSchema),
+});
+export const BoardEventsResponseSchema = z.object({
+    todo: BoardColumnSchema,
+    doing: BoardColumnSchema,
+    done: BoardColumnSchema,
+});
+export const CreateEventPayloadSchema = z.object({
+    title: z.string().min(1),
+    description: z.string().nullable().optional(),
+    alerts: z.array(z.object({
+        tag: z.string(),
+        val: z.string(),
+        act: z.number(),
+        flood: z.boolean(),
+        lat: z.number().nullable(),
+        lng: z.number().nullable(),
+        did: z.string(),
+    })),
+});

package/dist/events/types.d.ts

@@ -0,0 +1,130 @@
+import type { AlertAttributes } from '../alerts/types';
+export type EventStatus = 'todo' | 'doing' | 'done';
+export interface EventAttributes {
+    title: string;
+    description?: string | null;
+    tags: string[];
+    vals: string[];
+    alertsCount: number;
+    commentsCount: number;
+    status: EventStatus;
+    createdAt: string;
+    updatedAt: string;
+}
+export interface EventVehicle {
+    id: number;
+    uuid: string;
+    type: string;
+    attributes: {
+        plate: string | null;
+        vin: string | null;
+        color: string | null;
+        type: string | null;
+    };
+    relationships: {
+        responsibles: Array<{
+            id: number;
+            attributes: {
+                name: string | null;
+            };
+        }>;
+    };
+}
+export interface Event {
+    id: string;
+    attributes: EventAttributes;
+    relationships: {
+        vehicle: EventVehicle | null;
+    };
+}
+export interface EventDetail {
+    id: string;
+    attributes: EventAttributes;
+    relationships: {
+        vehicle: EventVehicle | null;
+        enterprise: {
+            id: number;
+            attributes: {
+                name: string;
+                cnpj: string | null;
+                email: string | null;
+            };
+        } | null;
+        user: {
+            id: number;
+            attributes: {
+                name: string | null;
+                username?: string;
+                email?: string | null;
+            };
+        } | null;
+        devices: Array<{
+            id: number;
+            attributes: {
+                name: string;
+                imei: string;
+            };
+            relationships: {
+                device_type: {
+                    attributes: {
+                        alias: string;
+                        brand_alias: string;
+                    };
+                };
+            };
+        }>;
+        alerts: Array<{
+            id: string;
+            attributes: {
+                tag: string;
+                val: string;
+                msg: string | null;
+                lat: number | null;
+                lng: number | null;
+                pla: string | null;
+                actiso: string;
+            };
+        }>;
+        comments: Array<{
+            id: string;
+            attributes: {
+                body: string;
+                createdAt: string;
+            };
+            relationships: {
+                user: {
+                    attributes: {
+                        name: string | null;
+                    };
+                } | null;
+            };
+        }>;
+        statusHistory: Array<{
+            attributes: {
+                status: EventStatus;
+                updatedAt: string;
+            };
+            relationships: {
+                user: {
+                    attributes: {
+                        name: string | null;
+                    };
+                } | null;
+            };
+        }>;
+    };
+}
+export interface BoardColumn {
+    count: number;
+    events: Event[];
+}
+export interface BoardEventsResponse {
+    todo: BoardColumn;
+    doing: BoardColumn;
+    done: BoardColumn;
+}
+export interface CreateEventPayload {
+    title: string;
+    description?: string | null;
+    alerts: AlertAttributes[];
+}

package/dist/events/types.js

@@ -0,0 +1 @@
+export {};

package/dist/exports/api.d.ts

@@ -0,0 +1,18 @@
+import type { ApiClientLike } from '../core/client';
+import type { QueryParams } from '../core/query-builder';
+import type { CreateExportPayload, ExportFile, ExportFilePanelRow } from './types';
+export declare function createExportsApi(client: ApiClientLike): {
+    requestExport: (payload: CreateExportPayload) => Promise<undefined>;
+    panel: (params?: Partial<QueryParams>, signal?: AbortSignal) => Promise<{
+        data: ExportFilePanelRow[];
+    }>;
+    endpoint: string;
+    list: <R = ExportFile>(params?: Partial<QueryParams>, signal?: AbortSignal) => Promise<import("..").ListResponse<R>>;
+    get: <R = ExportFile>(id: string, params?: Partial<QueryParams>, signal?: AbortSignal) => Promise<{
+        data: R;
+    }>;
+    create: (payload: unknown) => Promise<undefined>;
+    update: (id: string, payload: unknown) => Promise<undefined>;
+    remove: (id: string) => Promise<undefined>;
+    removeMany: (payload: unknown, signal?: AbortSignal) => Promise<undefined>;
+};

package/dist/exports/api.js

@@ -0,0 +1,9 @@
+import { createResourceApi } from '../core/client.js';
+import { withQuery } from '../core/query-builder.js';
+export function createExportsApi(client) {
+    return {
+        ...createResourceApi(client, '/v5/exports'),
+        requestExport: (payload) => client.post('/v5/exports', { data: payload }).then(() => undefined),
+        panel: (params = {}, signal) => client.get(withQuery('/v5/exports', params), { signal }).then(r => r.data),
+    };
+}

package/dist/exports/index.d.ts

@@ -0,0 +1,3 @@
+export * from './api';
+export * from './schemas';
+export * from './types';

package/dist/exports/index.js

@@ -0,0 +1,3 @@
+export * from './api.js';
+export * from './schemas.js';
+export * from './types.js';