@model-match/api 3.8.0 → 3.10.0

package/openapi.json

@@ -2,7 +2,7 @@
   "openapi": "3.1.0",
   "info": {
     "title": "ModelMatch API",
-    "version": "3.17.0",
+    "version": "3.19.0",
     "description": "ModelMatch API — mortgage and real-estate market data"
   },
   "tags": [
@@ -6271,6 +6271,57 @@
           "data"
         ]
       },
+      "CrmListMembershipsResult": {
+        "type": "object",
+        "properties": {
+          "data": {
+            "$ref": "#/components/schemas/CrmListMemberships"
+          }
+        },
+        "required": [
+          "data"
+        ]
+      },
+      "CrmListMemberships": {
+        "type": "object",
+        "properties": {
+          "memberships": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/CrmListMembershipEntry"
+              }
+            }
+          }
+        },
+        "required": [
+          "memberships"
+        ]
+      },
+      "CrmListMembershipEntry": {
+        "type": "object",
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "name": {
+            "type": "string"
+          },
+          "objectType": {
+            "$ref": "#/components/schemas/CrmObjectType"
+          },
+          "canManage": {
+            "type": "boolean"
+          }
+        },
+        "required": [
+          "id",
+          "name",
+          "objectType",
+          "canManage"
+        ]
+      },
       "CrmListWithMembers": {
         "type": "object",
         "properties": {
@@ -6485,6 +6536,12 @@
                   "type": "string"
                 }
               },
+              "createdEntityIds": {
+                "type": "array",
+                "items": {
+                  "type": "string"
+                }
+              },
               "enrichJobId": {
                 "type": "string"
               }
@@ -6492,7 +6549,8 @@
             "required": [
               "added",
               "total",
-              "addedEntityIds"
+              "addedEntityIds",
+              "createdEntityIds"
             ]
           }
         },
@@ -8757,9 +8815,29 @@
           "email": {
             "type": "string"
           },
+          "emails": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            },
+            "maxItems": 5,
+            "description": "Additional emails in submitted order (first non-duplicate becomes primary via oldest-wins)."
+          },
           "phone": {
             "$ref": "#/components/schemas/CrmImportPhone"
           },
+          "phones": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/CrmImportPhone"
+            },
+            "maxItems": 5,
+            "description": "Additional phones in submitted order."
+          },
+          "company": {
+            "type": "string",
+            "description": "Employer override for people rows; ignored on companies imports."
+          },
           "website": {
             "type": "string"
           },
@@ -21374,6 +21452,96 @@
         }
       }
     },
+    "/v1/crm/lists/memberships": {
+      "get": {
+        "operationId": "listCrmListMemberships",
+        "tags": [
+          "CRM"
+        ],
+        "summary": "Batched list-membership lookup for many entities",
+        "parameters": [
+          {
+            "schema": {
+              "$ref": "#/components/schemas/CrmObjectType"
+            },
+            "required": false,
+            "name": "objectType",
+            "in": "query"
+          },
+          {
+            "schema": {
+              "type": "string",
+              "minLength": 1
+            },
+            "required": true,
+            "name": "entityIds",
+            "in": "query"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Each requested entityId mapped to the visible lists it's on ([] = none).",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/CrmListMembershipsResult"
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Validation error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "401": {
+            "description": "Unauthorized",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "403": {
+            "description": "Forbidden (authenticated, but missing required context — e.g. no active organization)",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "404": {
+            "description": "Not found",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ErrorResponse"
+                }
+              }
+            }
+          },
+          "413": {
+            "description": "Response payload too large — detail endpoint capped to fit Lambda response limits",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/PayloadTooLarge"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/v1/crm/lists/{id}": {
       "get": {
         "operationId": "getCrmList",
@@ -21985,12 +22153,17 @@
                         },
                         "companyType": {
                           "type": "string"
+                        },
+                        "contacts": {
+                          "type": "array",
+                          "items": {
+                            "$ref": "#/components/schemas/CrmContactSeed"
+                          }
                         }
                       },
                       "required": [
                         "entityType",
                         "entityId",
-                        "link",
                         "display"
                       ]
                     },
@@ -28926,7 +29099,7 @@
           "Search"
         ],
         "summary": "Instant multi-entity typeahead search",
-        "description": "Fast typeahead/autocomplete search across agents, originators, companies, and offices. Returns top matches per entity type. Use this for quick name lookups, not for filtered searches (use the entity-specific list endpoints for those).",
+        "description": "Fast typeahead/autocomplete search across agents, originators, companies, and offices. Returns top matches per entity type. A bare NMLS ID resolves directly to its originator, company, or branch. Use this for quick name lookups, not for filtered searches (use the entity-specific list endpoints for those). If you already have an entity ID, prefer getOriginator / getCompany / getBranch.",
         "requestBody": {
           "content": {
             "application/json": {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@model-match/api",
-	"version": "3.8.0",
+	"version": "3.10.0",
 	"description": "TypeScript client for the ModelMatch API",
 	"license": "MIT",
 	"files": [
@@ -41,7 +41,7 @@
 	},
 	"devDependencies": {
 		"@hey-api/openapi-ts": "^0.67.6",
-		"@model-match-inc/api": "3.15.2",
+		"@model-match-inc/api": "3.18.0",
 		"tsdown": "^0.21.10",
 		"typescript": "6.0.2",
 		"vitest": "4.1.2"