@softruck/api-contracts 0.1.1-beta.3

package/dist/service-orders/types.d.ts

@@ -0,0 +1,84 @@
+import type { AssigneeRelAttr, CompletionRelAttr, CustomField, Document, EnterpriseRelAttr, SectionRelAttr, TaskBaseAttributes, TaskEntry, TypeRelAttr, VehicleRelAttr } from '../core/types';
+export interface ServiceOrderAttributes extends TaskBaseAttributes {
+    due_date: string | null;
+}
+export interface ServiceOrder {
+    id: string;
+    attributes: ServiceOrderAttributes;
+    relationships: {
+        enterprise: {
+            attributes: EnterpriseRelAttr;
+        } | null;
+        type: {
+            attributes: TypeRelAttr;
+        } | null;
+        section: {
+            attributes: SectionRelAttr;
+        } | null;
+        asset: {
+            attributes: Pick<VehicleRelAttr, 'plate' | 'vin' | 'label'>;
+        } | null;
+        assignee: {
+            attributes: AssigneeRelAttr;
+        } | null;
+        addresses: Array<{
+            id: string;
+            attributes: {
+                formatted_address: string | null;
+            };
+        }>;
+        completion: {
+            attributes: CompletionRelAttr;
+        } | null;
+        tags: Array<{
+            id: string;
+            attributes: {
+                name: string;
+            };
+        }>;
+    };
+}
+export interface ServiceOrderPanelRow {
+    attributes: {
+        count: string;
+        completed: boolean | null;
+        created_at: {
+            day: string;
+        } | null;
+        type: {
+            name: string | null;
+        } | null;
+        asset_type: {
+            name: string | null;
+        } | null;
+    };
+}
+export interface ServiceOrderEntriesRow {
+    attributes: {
+        count: string;
+        sum: {
+            entries: {
+                total_price: string | null;
+            };
+        } | null;
+    };
+}
+export interface AcknowledgementAttributes {
+    acknowledged: boolean | null;
+    acknowledged_at: string | null;
+    rate: number | null;
+    created_at: string | null;
+}
+export interface Acknowledgement {
+    id: string;
+    attributes: AcknowledgementAttributes;
+    relationships: {
+        task: {
+            id: string;
+            attributes: {
+                token: string;
+            };
+        };
+    };
+}
+export type { CustomField, Document, TaskEntry };

package/dist/service-orders/types.js

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

package/dist/sharings/api.d.ts

@@ -0,0 +1,17 @@
+import type { ApiClientLike } from '../core/client';
+import type { QueryParams } from '../core/query-builder';
+import type { Sharing, SharingPanelRow } from './types';
+export declare function createSharingsApi(client: ApiClientLike): {
+    panel: (params?: Partial<QueryParams>, signal?: AbortSignal) => Promise<{
+        data: SharingPanelRow[];
+    }>;
+    endpoint: string;
+    list: <R = Sharing>(params?: Partial<QueryParams>, signal?: AbortSignal) => Promise<import("..").ListResponse<R>>;
+    get: <R = Sharing>(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/sharings/api.js

@@ -0,0 +1,8 @@
+import { createResourceApi } from '../core/client.js';
+import { withQuery } from '../core/query-builder.js';
+export function createSharingsApi(client) {
+    return {
+        ...createResourceApi(client, '/v5/sharings'),
+        panel: (params = {}, signal) => client.get(withQuery('/v5/sharings', params), { signal }).then(r => r.data),
+    };
+}

package/dist/sharings/index.d.ts

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

package/dist/sharings/index.js

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

package/dist/sharings/schemas.d.ts

@@ -0,0 +1,47 @@
+import { z } from 'zod';
+export declare const SharingSchema: z.ZodObject<{
+    id: z.ZodString;
+    attributes: z.ZodObject<{
+        hash: z.ZodNullable<z.ZodString>;
+        type: z.ZodNullable<z.ZodString>;
+        valid_until: z.ZodNullable<z.ZodString>;
+        active: z.ZodNullable<z.ZodBoolean>;
+        created_at: z.ZodNullable<z.ZodString>;
+        updated_at: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    relationships: z.ZodObject<{
+        enterprise: z.ZodNullable<z.ZodObject<{
+            attributes: z.ZodObject<{
+                name: z.ZodNullable<z.ZodString>;
+                cnpj: z.ZodNullable<z.ZodString>;
+                email: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+        creator: z.ZodNullable<z.ZodObject<{
+            attributes: z.ZodObject<{
+                name: z.ZodNullable<z.ZodString>;
+                email: z.ZodNullable<z.ZodString>;
+                phone1: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+        asset: z.ZodNullable<z.ZodObject<{
+            attributes: z.ZodObject<{
+                plate: z.ZodNullable<z.ZodString>;
+                vin: z.ZodNullable<z.ZodString>;
+                label: z.ZodNullable<z.ZodString>;
+                type_name: z.ZodNullable<z.ZodString>;
+                code: z.ZodNullable<z.ZodString>;
+                model_name: z.ZodNullable<z.ZodString>;
+                trim_name: z.ZodNullable<z.ZodString>;
+                year: z.ZodNullable<z.ZodNumber>;
+                color: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+        device: z.ZodNullable<z.ZodObject<{
+            attributes: z.ZodObject<{
+                name: z.ZodNullable<z.ZodString>;
+                imei: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;

package/dist/sharings/schemas.js

@@ -0,0 +1,36 @@
+import { z } from 'zod';
+export const SharingSchema = z.object({
+    id: z.string(),
+    attributes: z.object({
+        hash: z.string().nullable(),
+        type: z.string().nullable(),
+        valid_until: z.string().nullable(),
+        active: z.boolean().nullable(),
+        created_at: z.string().nullable(),
+        updated_at: z.string().nullable(),
+    }),
+    relationships: z.object({
+        enterprise: z.object({
+            attributes: z.object({ name: z.string().nullable(), cnpj: z.string().nullable(), email: z.string().nullable() }),
+        }).nullable(),
+        creator: z.object({
+            attributes: z.object({ name: z.string().nullable(), email: z.string().nullable(), phone1: z.string().nullable() }),
+        }).nullable(),
+        asset: z.object({
+            attributes: z.object({
+                plate: z.string().nullable(),
+                vin: z.string().nullable(),
+                label: z.string().nullable(),
+                type_name: z.string().nullable(),
+                code: z.string().nullable(),
+                model_name: z.string().nullable(),
+                trim_name: z.string().nullable(),
+                year: z.number().nullable(),
+                color: z.string().nullable(),
+            }),
+        }).nullable(),
+        device: z.object({
+            attributes: z.object({ name: z.string().nullable(), imei: z.string().nullable() }),
+        }).nullable(),
+    }),
+});

package/dist/sharings/types.d.ts

@@ -0,0 +1,54 @@
+import type { EnterpriseRelAttr, Timestamped, UserRelAttr, VehicleRelAttr } from '../core/types';
+export interface SharingAttributes extends Timestamped {
+    hash: string | null;
+    type: string | null;
+    valid_until: string | null;
+    tokens_generated: number | null;
+    active: boolean | null;
+}
+export interface Sharing {
+    id: string;
+    attributes: SharingAttributes;
+    relationships: {
+        enterprise: {
+            attributes: EnterpriseRelAttr;
+        } | null;
+        creator: {
+            attributes: Pick<UserRelAttr, 'name' | 'email' | 'phone1'>;
+        } | null;
+        asset: {
+            attributes: VehicleRelAttr & {
+                code: string | null;
+                model_name: string | null;
+                trim_name: string | null;
+                year: number | null;
+                color: string | null;
+            };
+        } | null;
+        device: {
+            attributes: {
+                name: string | null;
+                imei: string | null;
+            };
+        } | null;
+    };
+}
+export interface SharingPanelRow {
+    attributes: {
+        count: string;
+        created_at: {
+            day: string;
+        } | null;
+        creator: {
+            name: string | null;
+        } | null;
+        device: {
+            name: string | null;
+        } | null;
+        sum: {
+            sharings: {
+                tokens_generated: string | null;
+            };
+        } | null;
+    };
+}

package/dist/sharings/types.js

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

package/dist/surveys/api.d.ts

@@ -0,0 +1,2 @@
+import type { ApiClientLike } from '../core/client';
+export declare function createSurveysApi(_client: ApiClientLike): {};

package/dist/surveys/api.js

@@ -0,0 +1,3 @@
+export function createSurveysApi(_client) {
+    return {};
+}

package/dist/surveys/index.d.ts

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

package/dist/surveys/index.js

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

package/dist/surveys/schemas.d.ts

@@ -0,0 +1,33 @@
+import { z } from 'zod';
+export declare const SurveySchema: z.ZodObject<{
+    id: z.ZodString;
+    attributes: z.ZodObject<{
+        token: z.ZodNullable<z.ZodString>;
+        status: z.ZodNullable<z.ZodString>;
+        priority: z.ZodNullable<z.ZodString>;
+        description: z.ZodNullable<z.ZodString>;
+        notes: z.ZodNullable<z.ZodString>;
+        due_date: z.ZodNullable<z.ZodString>;
+        created_at: z.ZodNullable<z.ZodString>;
+        updated_at: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    relationships: z.ZodObject<{
+        enterprise: z.ZodNullable<z.ZodObject<{
+            attributes: z.ZodObject<{
+                name: z.ZodNullable<z.ZodString>;
+                cnpj: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+        type: z.ZodNullable<z.ZodObject<{
+            attributes: z.ZodObject<{
+                name: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+        asset: z.ZodNullable<z.ZodObject<{
+            attributes: z.ZodObject<{
+                plate: z.ZodNullable<z.ZodString>;
+                label: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;

package/dist/surveys/schemas.js

@@ -0,0 +1,23 @@
+import { z } from 'zod';
+export const SurveySchema = z.object({
+    id: z.string(),
+    attributes: z.object({
+        token: z.string().nullable(),
+        status: z.string().nullable(),
+        priority: z.string().nullable(),
+        description: z.string().nullable(),
+        notes: z.string().nullable(),
+        due_date: z.string().nullable(),
+        created_at: z.string().nullable(),
+        updated_at: z.string().nullable(),
+    }),
+    relationships: z.object({
+        enterprise: z.object({
+            attributes: z.object({ name: z.string().nullable(), cnpj: z.string().nullable() }),
+        }).nullable(),
+        type: z.object({ attributes: z.object({ name: z.string().nullable() }) }).nullable(),
+        asset: z.object({
+            attributes: z.object({ plate: z.string().nullable(), label: z.string().nullable() }),
+        }).nullable(),
+    }),
+});

package/dist/surveys/types.d.ts

@@ -0,0 +1,27 @@
+import type { TaskBaseAttributes } from '../core/types';
+export interface SurveyAttributes extends TaskBaseAttributes {
+    due_date: string | null;
+}
+export interface Survey {
+    id: string;
+    attributes: SurveyAttributes;
+    relationships: {
+        enterprise: {
+            attributes: {
+                name: string | null;
+                cnpj: string | null;
+            };
+        } | null;
+        type: {
+            attributes: {
+                name: string | null;
+            };
+        } | null;
+        asset: {
+            attributes: {
+                plate: string | null;
+                label: string | null;
+            };
+        } | null;
+    };
+}

package/dist/surveys/types.js

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

package/dist/tags/api.d.ts

@@ -0,0 +1,24 @@
+import type { ApiClientLike } from '../core/client';
+import type { QueryParams } from '../core/query-builder';
+import type { Tag, TagResource } from './types';
+interface SearchTagsOptions {
+    enterpriseId?: string;
+    signal?: AbortSignal;
+}
+export declare function createTagsApi(client: ApiClientLike): {
+    search: (query: string, options?: SearchTagsOptions) => Promise<{
+        data: Tag[];
+    }>;
+    assign: (tagId: string, target: string, entityId: string, signal?: AbortSignal) => Promise<undefined>;
+    unassign: (tagId: string, target: string, entityId: string, signal?: AbortSignal) => Promise<undefined>;
+    endpoint: string;
+    list: <R = TagResource>(params?: Partial<QueryParams>, signal?: AbortSignal) => Promise<import("..").ListResponse<R>>;
+    get: <R = TagResource>(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>;
+};
+export {};

package/dist/tags/api.js

@@ -0,0 +1,28 @@
+import { createResourceApi } from '../core/client.js';
+import { withQuery } from '../core/query-builder.js';
+export function createTagsApi(client) {
+    return {
+        ...createResourceApi(client, '/v5/tags'),
+        search: (query, options = {}) => {
+            const params = {
+                attributes: ['name', 'color'],
+                limit: 20,
+                search: query === '' ? undefined : query,
+                ...(options.enterpriseId ? { filters: { 'enterprise.id': { operator: 'eq', value: options.enterpriseId } } } : {}),
+            };
+            return client.get(withQuery('/v5/tags', params), { signal: options.signal }).then(r => r.data);
+        },
+        assign: (tagId, target, entityId, signal) => client.post(`/v5/tags/${tagId}/assignments`, {
+            data: {
+                attributes: { target },
+                relationships: { assignment: [{ type: target, id: entityId }] },
+            },
+        }, { signal }).then(() => undefined),
+        unassign: (tagId, target, entityId, signal) => client.delete(`/v5/tags/assignments`, {
+            data: {
+                data: [{ relationships: { tag: { type: 'tags', id: tagId }, assignment: { type: target, id: entityId } } }],
+            },
+            signal,
+        }).then(() => undefined),
+    };
+}

package/dist/tags/index.d.ts

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

package/dist/tags/index.js

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

package/dist/tags/schemas.d.ts

@@ -0,0 +1,26 @@
+import { z } from 'zod';
+export declare const TagSchema: z.ZodObject<{
+    id: z.ZodString;
+    attributes: z.ZodObject<{
+        name: z.ZodString;
+        color: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export declare const TagResourceSchema: z.ZodObject<{
+    id: z.ZodString;
+    attributes: z.ZodObject<{
+        name: z.ZodString;
+        color: z.ZodNullable<z.ZodString>;
+        created_at: z.ZodNullable<z.ZodString>;
+        updated_at: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+    relationships: z.ZodObject<{
+        enterprise: z.ZodNullable<z.ZodObject<{
+            attributes: z.ZodObject<{
+                name: z.ZodNullable<z.ZodString>;
+                cnpj: z.ZodNullable<z.ZodString>;
+                email: z.ZodNullable<z.ZodString>;
+            }, z.core.$strip>;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;

package/dist/tags/schemas.js

@@ -0,0 +1,19 @@
+import { z } from 'zod';
+export const TagSchema = z.object({
+    id: z.string(),
+    attributes: z.object({ name: z.string(), color: z.string().nullable() }),
+});
+export const TagResourceSchema = z.object({
+    id: z.string(),
+    attributes: z.object({
+        name: z.string(),
+        color: z.string().nullable(),
+        created_at: z.string().nullable(),
+        updated_at: z.string().nullable(),
+    }),
+    relationships: z.object({
+        enterprise: z.object({
+            attributes: z.object({ name: z.string().nullable(), cnpj: z.string().nullable(), email: z.string().nullable() }),
+        }).nullable(),
+    }),
+});

package/dist/tags/types.d.ts

@@ -0,0 +1,16 @@
+import type { EnterpriseRelAttr, Tag } from '../core/types';
+export interface TagResource {
+    id: string;
+    attributes: {
+        name: string;
+        color: string | null;
+        created_at: string | null;
+        updated_at: string | null;
+    };
+    relationships: {
+        enterprise: {
+            attributes: EnterpriseRelAttr;
+        } | null;
+    };
+}
+export type { Tag };

package/dist/tags/types.js

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

package/dist/tracking/api.d.ts

@@ -0,0 +1,2 @@
+import type { ApiClientLike } from '../core/client';
+export declare function createTrackingApi(_client: ApiClientLike): {};

package/dist/tracking/api.js

@@ -0,0 +1,3 @@
+export function createTrackingApi(_client) {
+    return {};
+}

package/dist/tracking/index.d.ts

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

package/dist/tracking/index.js

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

package/dist/tracking/schemas.d.ts

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+export declare const TrackingDeviceSchema: z.ZodObject<{
+    id: z.ZodString;
+    attributes: z.ZodObject<{
+        imei: z.ZodNullable<z.ZodString>;
+        lat: z.ZodNullable<z.ZodNumber>;
+        lng: z.ZodNullable<z.ZodNumber>;
+        ign: z.ZodNullable<z.ZodBoolean>;
+        spd: z.ZodNullable<z.ZodNumber>;
+        updated_at: z.ZodNullable<z.ZodString>;
+    }, z.core.$strip>;
+}, z.core.$strip>;

package/dist/tracking/schemas.js

@@ -0,0 +1,12 @@
+import { z } from 'zod';
+export const TrackingDeviceSchema = z.object({
+    id: z.string(),
+    attributes: z.object({
+        imei: z.string().nullable(),
+        lat: z.number().nullable(),
+        lng: z.number().nullable(),
+        ign: z.boolean().nullable(),
+        spd: z.number().nullable(),
+        updated_at: z.string().nullable(),
+    }),
+});

package/dist/tracking/types.d.ts

@@ -0,0 +1,11 @@
+export interface TrackingDevice {
+    id: string;
+    attributes: {
+        imei: string | null;
+        lat: number | null;
+        lng: number | null;
+        ign: boolean | null;
+        spd: number | null;
+        updated_at: string | null;
+    };
+}

package/dist/tracking/types.js

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

package/dist/trajectories/api.d.ts

@@ -0,0 +1,27 @@
+import type { ApiClientLike } from '../core/client';
+import type { QueryParams } from '../core/query-builder';
+import type { ActivityReportAttributes, Trajectory } from './types';
+export declare function createTrajectoriesApi(client: ApiClientLike): {
+    activityReport: (params: Partial<QueryParams>, signal?: AbortSignal) => Promise<{
+        data: {
+            attributes: ActivityReportAttributes;
+        };
+    }>;
+    movementReport: (params: Partial<QueryParams>, signal?: AbortSignal) => Promise<{
+        data: {
+            attributes: {
+                report: number[][];
+            };
+        };
+    }>;
+    endpoint: string;
+    list: <R = Trajectory>(params?: Partial<QueryParams>, signal?: AbortSignal) => Promise<import("..").ListResponse<R>>;
+    get: <R = Trajectory>(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>;
+};
+export type { QueryParams };

package/dist/trajectories/api.js

@@ -0,0 +1,13 @@
+import { createResourceApi } from '../core/client.js';
+import { withQuery } from '../core/query-builder.js';
+export function createTrajectoriesApi(client) {
+    return {
+        ...createResourceApi(client, '/v5/trajectories'),
+        activityReport: (params, signal) => client
+            .get(withQuery('/v5/trajectories/reports/activity/enterprise', params), { signal })
+            .then((r) => r.data),
+        movementReport: (params, signal) => client
+            .get(withQuery('/v5/trajectories/reports/movement/enterprise', params), { signal })
+            .then((r) => r.data),
+    };
+}

package/dist/trajectories/index.d.ts

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

package/dist/trajectories/index.js

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