@withloops.ai/contracts 0.3.0 → 0.4.0

package/dist/api.d.ts

@@ -112,6 +112,14 @@ export declare const ListQuery: z.ZodObject<{
     updatedSince: z.ZodOptional<z.ZodISODateTime>;
 }, z.core.$strip>;
 export type ListQuery = z.infer<typeof ListQuery>;
+/** Where the record also lives (`ExternalRef` in sync.ts), shown so a developer can find their own id. Added in 0.4.0. */
+export declare const RecordRef: z.ZodObject<{
+    appId: z.ZodString;
+    object: z.ZodString;
+    externalId: z.ZodString;
+    lockedFields: z.ZodArray<z.ZodString>;
+}, z.core.$strip>;
+export type RecordRef = z.infer<typeof RecordRef>;
 /** A Loops contact as the public API shows it. camelCase, ids as strings, dates ISO. */
 export declare const Contact: z.ZodObject<{
     id: z.ZodString;
@@ -122,6 +130,12 @@ export declare const Contact: z.ZodObject<{
     jobTitle: z.ZodNullable<z.ZodString>;
     companyId: z.ZodNullable<z.ZodString>;
     ownerId: z.ZodNullable<z.ZodString>;
+    refs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        appId: z.ZodString;
+        object: z.ZodString;
+        externalId: z.ZodString;
+        lockedFields: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>>;
     createdAt: z.ZodISODateTime;
     updatedAt: z.ZodISODateTime;
 }, z.core.$strip>;
@@ -146,3 +160,142 @@ export declare const ContactUpdate: z.ZodObject<{
     ownerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
 }, z.core.$strip>;
 export type ContactUpdate = z.infer<typeof ContactUpdate>;
+export declare const Company: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodNullable<z.ZodString>;
+    website: z.ZodNullable<z.ZodString>;
+    domain: z.ZodNullable<z.ZodString>;
+    phone: z.ZodNullable<z.ZodString>;
+    industry: z.ZodNullable<z.ZodString>;
+    ownerId: z.ZodNullable<z.ZodString>;
+    refs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        appId: z.ZodString;
+        object: z.ZodString;
+        externalId: z.ZodString;
+        lockedFields: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type Company = z.infer<typeof Company>;
+export declare const CompanyCreate: z.ZodObject<{
+    name: z.ZodString;
+    website: z.ZodOptional<z.ZodString>;
+    phone: z.ZodOptional<z.ZodString>;
+    industry: z.ZodOptional<z.ZodString>;
+    ownerId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type CompanyCreate = z.infer<typeof CompanyCreate>;
+export declare const CompanyUpdate: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    website: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    phone: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    industry: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    ownerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type CompanyUpdate = z.infer<typeof CompanyUpdate>;
+export declare const Deal: z.ZodObject<{
+    id: z.ZodString;
+    name: z.ZodNullable<z.ZodString>;
+    value: z.ZodNullable<z.ZodNumber>;
+    currency: z.ZodNullable<z.ZodString>;
+    stage: z.ZodNullable<z.ZodString>;
+    closeDate: z.ZodNullable<z.ZodString>;
+    companyId: z.ZodNullable<z.ZodString>;
+    ownerId: z.ZodNullable<z.ZodString>;
+    refs: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        appId: z.ZodString;
+        object: z.ZodString;
+        externalId: z.ZodString;
+        lockedFields: z.ZodArray<z.ZodString>;
+    }, z.core.$strip>>>;
+    createdAt: z.ZodISODateTime;
+    updatedAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type Deal = z.infer<typeof Deal>;
+export declare const DealCreate: z.ZodObject<{
+    name: z.ZodString;
+    value: z.ZodOptional<z.ZodNumber>;
+    currency: z.ZodOptional<z.ZodString>;
+    stage: z.ZodOptional<z.ZodString>;
+    closeDate: z.ZodOptional<z.ZodString>;
+    companyId: z.ZodOptional<z.ZodString>;
+    ownerId: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type DealCreate = z.infer<typeof DealCreate>;
+export declare const DealUpdate: z.ZodObject<{
+    name: z.ZodOptional<z.ZodString>;
+    value: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
+    currency: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    stage: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    closeDate: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    companyId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+    ownerId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+}, z.core.$strip>;
+export type DealUpdate = z.infer<typeof DealUpdate>;
+/** Loops record kinds as the API names them in links. */
+export declare const LinkKind: z.ZodEnum<{
+    contact: "contact";
+    company: "company";
+    lead: "lead";
+    deal: "deal";
+}>;
+export type LinkKind = z.infer<typeof LinkKind>;
+/** A link between two records (`recordLinks` in Vista): a deal holds many people, each with a role. */
+export declare const RecordLink: z.ZodObject<{
+    id: z.ZodString;
+    from: z.ZodObject<{
+        kind: z.ZodEnum<{
+            contact: "contact";
+            company: "company";
+            lead: "lead";
+            deal: "deal";
+        }>;
+        id: z.ZodString;
+    }, z.core.$strip>;
+    to: z.ZodObject<{
+        kind: z.ZodEnum<{
+            contact: "contact";
+            company: "company";
+            lead: "lead";
+            deal: "deal";
+        }>;
+        id: z.ZodString;
+    }, z.core.$strip>;
+    role: z.ZodNullable<z.ZodString>;
+    createdAt: z.ZodISODateTime;
+}, z.core.$strip>;
+export type RecordLink = z.infer<typeof RecordLink>;
+export declare const RecordLinkCreate: z.ZodObject<{
+    from: z.ZodObject<{
+        kind: z.ZodEnum<{
+            contact: "contact";
+            company: "company";
+            lead: "lead";
+            deal: "deal";
+        }>;
+        id: z.ZodString;
+    }, z.core.$strip>;
+    to: z.ZodObject<{
+        kind: z.ZodEnum<{
+            contact: "contact";
+            company: "company";
+            lead: "lead";
+            deal: "deal";
+        }>;
+        id: z.ZodString;
+    }, z.core.$strip>;
+    role: z.ZodOptional<z.ZodString>;
+}, z.core.$strip>;
+export type RecordLinkCreate = z.infer<typeof RecordLinkCreate>;
+/** `GET /v1/links?kind=deal&id=…`: the links of one record, either end. */
+export declare const RecordLinkQuery: z.ZodObject<{
+    kind: z.ZodEnum<{
+        contact: "contact";
+        company: "company";
+        lead: "lead";
+        deal: "deal";
+    }>;
+    id: z.ZodString;
+}, z.core.$strip>;
+export type RecordLinkQuery = z.infer<typeof RecordLinkQuery>;

package/dist/api.js

@@ -60,6 +60,14 @@ export const ListQuery = z.object({
     updatedSince: Timestamp.optional(),
 });
 // ── Resources (L0: contacts) ────────────────────────────────────────────────────
+/** Where the record also lives (`ExternalRef` in sync.ts), shown so a developer can find their own id. Added in 0.4.0. */
+export const RecordRef = z.object({
+    appId: z.string(),
+    object: z.string(),
+    externalId: z.string(),
+    /** Fields that CRM owns on this record; a PATCH to one answers `conflict`. */
+    lockedFields: z.array(z.string()),
+});
 /** A Loops contact as the public API shows it. camelCase, ids as strings, dates ISO. */
 export const Contact = z.object({
     id: z.string(),
@@ -70,6 +78,8 @@ export const Contact = z.object({
     jobTitle: z.string().nullable(),
     companyId: z.string().nullable(),
     ownerId: z.string().nullable(),
+    /** Added in 0.4.0. Where this contact also lives (a connected CRM). */
+    refs: z.array(RecordRef).optional(),
     createdAt: Timestamp,
     updatedAt: Timestamp,
 });
@@ -93,3 +103,79 @@ export const ContactUpdate = z.object({
     companyId: z.string().nullable().optional(),
     ownerId: z.string().nullable().optional(),
 });
+// ── Resources added in 0.4.0 (L2): companies, deals, record links ───────────────
+export const Company = z.object({
+    id: z.string(),
+    name: z.string().nullable(),
+    website: z.string().nullable(),
+    domain: z.string().nullable(),
+    phone: z.string().nullable(),
+    industry: z.string().nullable(),
+    ownerId: z.string().nullable(),
+    refs: z.array(RecordRef).optional(),
+    createdAt: Timestamp,
+    updatedAt: Timestamp,
+});
+export const CompanyCreate = z.object({
+    name: z.string().min(1).max(200),
+    website: z.string().max(500).optional(),
+    phone: z.string().max(40).optional(),
+    industry: z.string().max(120).optional(),
+    ownerId: z.string().optional(),
+});
+export const CompanyUpdate = z.object({
+    name: z.string().min(1).max(200).optional(),
+    website: z.string().max(500).nullable().optional(),
+    phone: z.string().max(40).nullable().optional(),
+    industry: z.string().max(120).nullable().optional(),
+    ownerId: z.string().nullable().optional(),
+});
+export const Deal = z.object({
+    id: z.string(),
+    name: z.string().nullable(),
+    /** Amount in the currency's units (12500.5). */
+    value: z.number().nullable(),
+    currency: z.string().nullable(),
+    stage: z.string().nullable(),
+    closeDate: z.string().nullable(),
+    companyId: z.string().nullable(),
+    ownerId: z.string().nullable(),
+    refs: z.array(RecordRef).optional(),
+    createdAt: Timestamp,
+    updatedAt: Timestamp,
+});
+export const DealCreate = z.object({
+    name: z.string().min(1).max(200),
+    value: z.number().min(0).optional(),
+    currency: z.string().length(3).optional(),
+    stage: z.string().max(120).optional(),
+    closeDate: z.string().optional(),
+    companyId: z.string().optional(),
+    ownerId: z.string().optional(),
+});
+export const DealUpdate = z.object({
+    name: z.string().min(1).max(200).optional(),
+    value: z.number().min(0).nullable().optional(),
+    currency: z.string().length(3).nullable().optional(),
+    stage: z.string().max(120).nullable().optional(),
+    closeDate: z.string().nullable().optional(),
+    companyId: z.string().nullable().optional(),
+    ownerId: z.string().nullable().optional(),
+});
+/** Loops record kinds as the API names them in links. */
+export const LinkKind = z.enum(['contact', 'company', 'lead', 'deal']);
+/** A link between two records (`recordLinks` in Vista): a deal holds many people, each with a role. */
+export const RecordLink = z.object({
+    id: z.string(),
+    from: z.object({ kind: LinkKind, id: z.string() }),
+    to: z.object({ kind: LinkKind, id: z.string() }),
+    role: z.string().nullable(),
+    createdAt: Timestamp,
+});
+export const RecordLinkCreate = z.object({
+    from: z.object({ kind: LinkKind, id: z.string().min(1) }),
+    to: z.object({ kind: LinkKind, id: z.string().min(1) }),
+    role: z.string().max(80).optional(),
+});
+/** `GET /v1/links?kind=deal&id=…`: the links of one record, either end. */
+export const RecordLinkQuery = z.object({ kind: LinkKind, id: z.string().min(1) });

package/dist/fields.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Added in 0.4.0 (L2). The Loops fields a connector maps into, per record kind. `custom.<key>` reaches a custom field.
+ * Link ids (companyId on a contact, people on a deal) are NOT fields: they come from `sync.links` and become `recordLinks`.
+ * Only ever ADD names here.
+ */
+export declare const LOOPS_FIELD_NAMES: Record<'CONTACT' | 'COMPANY' | 'LEAD' | 'DEAL', readonly string[]>;

package/dist/fields.js

@@ -0,0 +1,11 @@
+/**
+ * Added in 0.4.0 (L2). The Loops fields a connector maps into, per record kind. `custom.<key>` reaches a custom field.
+ * Link ids (companyId on a contact, people on a deal) are NOT fields: they come from `sync.links` and become `recordLinks`.
+ * Only ever ADD names here.
+ */
+export const LOOPS_FIELD_NAMES = {
+    CONTACT: ['firstName', 'lastName', 'email', 'phone', 'mobile', 'jobTitle', 'linkedinUrl', 'city', 'country', 'ownerEmail'],
+    COMPANY: ['name', 'website', 'domain', 'phone', 'industry', 'city', 'country', 'linkedinUrl', 'ownerEmail'],
+    LEAD: ['firstName', 'lastName', 'email', 'phone', 'jobTitle', 'companyName', 'website', 'status', 'source', 'ownerEmail'],
+    DEAL: ['name', 'value', 'currency', 'stage', 'closeDate', 'probability', 'ownerEmail'],
+};

package/dist/index.d.ts

@@ -5,3 +5,5 @@ export * from './manifest.ts';
 export * from './api.ts';
 export * from './registry.ts';
 export * from './trust.ts';
+export * from './fields.ts';
+export * from './sync.ts';

package/dist/index.js

@@ -5,3 +5,5 @@ export * from "./manifest.js";
 export * from "./api.js";
 export * from "./registry.js";
 export * from "./trust.js";
+export * from "./fields.js";
+export * from "./sync.js";