@model-match/api 3.46.0 → 3.48.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/RELEASE_NOTES.md +19 -0
- package/dist/{index-D5lJRhPf.d.mts → index-cCkX3-4W.d.mts} +878 -71
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +1 -1
- package/dist/slim/index.d.mts +52 -6
- package/dist/slim/index.mjs +154 -6
- package/dist/{src-B0B4SZ9p.mjs → src-CCp2TVpk.mjs} +170 -4
- package/openapi.json +2347 -372
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -8834,6 +8834,63 @@
|
|
|
8834
8834
|
},
|
|
8835
8835
|
"type": "object"
|
|
8836
8836
|
},
|
|
8837
|
+
"BranchLicense": {
|
|
8838
|
+
"properties": {
|
|
8839
|
+
"authorizedSince": {
|
|
8840
|
+
"description": "Start of the license's current authorized period (YYYY-MM-DD). Null when the license is not currently authorized.",
|
|
8841
|
+
"nullable": true,
|
|
8842
|
+
"type": "string"
|
|
8843
|
+
},
|
|
8844
|
+
"isAuthorized": {
|
|
8845
|
+
"nullable": true,
|
|
8846
|
+
"type": "boolean"
|
|
8847
|
+
},
|
|
8848
|
+
"issueDate": {
|
|
8849
|
+
"description": "Date the license was originally issued (YYYY-MM-DD).",
|
|
8850
|
+
"nullable": true,
|
|
8851
|
+
"type": "string"
|
|
8852
|
+
},
|
|
8853
|
+
"licenseId": {
|
|
8854
|
+
"nullable": true,
|
|
8855
|
+
"type": "string"
|
|
8856
|
+
},
|
|
8857
|
+
"licenseNumber": {
|
|
8858
|
+
"nullable": true,
|
|
8859
|
+
"type": "string"
|
|
8860
|
+
},
|
|
8861
|
+
"licenseType": {
|
|
8862
|
+
"nullable": true,
|
|
8863
|
+
"type": "string"
|
|
8864
|
+
},
|
|
8865
|
+
"regulator": {
|
|
8866
|
+
"description": "Issuing state regulator.",
|
|
8867
|
+
"nullable": true,
|
|
8868
|
+
"type": "string"
|
|
8869
|
+
},
|
|
8870
|
+
"status": {
|
|
8871
|
+
"description": "Current license status, e.g. \"Approved\", \"Voluntary Surrender\", \"Expired\".",
|
|
8872
|
+
"nullable": true,
|
|
8873
|
+
"type": "string"
|
|
8874
|
+
},
|
|
8875
|
+
"statusDate": {
|
|
8876
|
+
"description": "Date the license entered its current `status` (YYYY-MM-DD).",
|
|
8877
|
+
"nullable": true,
|
|
8878
|
+
"type": "string"
|
|
8879
|
+
}
|
|
8880
|
+
},
|
|
8881
|
+
"required": [
|
|
8882
|
+
"licenseId",
|
|
8883
|
+
"regulator",
|
|
8884
|
+
"licenseNumber",
|
|
8885
|
+
"licenseType",
|
|
8886
|
+
"issueDate",
|
|
8887
|
+
"status",
|
|
8888
|
+
"statusDate",
|
|
8889
|
+
"isAuthorized",
|
|
8890
|
+
"authorizedSince"
|
|
8891
|
+
],
|
|
8892
|
+
"type": "object"
|
|
8893
|
+
},
|
|
8837
8894
|
"BranchListRequest": {
|
|
8838
8895
|
"additionalProperties": false,
|
|
8839
8896
|
"properties": {
|
|
@@ -8858,6 +8915,20 @@
|
|
|
8858
8915
|
"lenderMatchMode": {
|
|
8859
8916
|
"$ref": "#/components/schemas/LenderMatchMode"
|
|
8860
8917
|
},
|
|
8918
|
+
"licensedSince": {
|
|
8919
|
+
"description": "Bound the date the branch was FIRST licensed — the earliest `issueDate` across its `licenses[]` (YYYY-MM-DD, inclusive). `{gte: \"2026-07-01\"}` = branches whose every license was issued on or after July 1, 2026, i.e. new branches; an established branch that added a state recently does NOT match. Branches with no license dates on file never match. Always ANDed with the other filters. A range matching more than 5,000 branches is rejected with a 400.",
|
|
8920
|
+
"properties": {
|
|
8921
|
+
"gte": {
|
|
8922
|
+
"format": "date",
|
|
8923
|
+
"type": "string"
|
|
8924
|
+
},
|
|
8925
|
+
"lte": {
|
|
8926
|
+
"format": "date",
|
|
8927
|
+
"type": "string"
|
|
8928
|
+
}
|
|
8929
|
+
},
|
|
8930
|
+
"type": "object"
|
|
8931
|
+
},
|
|
8861
8932
|
"managerName": {
|
|
8862
8933
|
"description": "Branch manager name. Matches ALL the words supplied, fuzzily, against the names of the branch's licensed managers. Always ANDed with the other filters. A name matching more than 5,000 branches is rejected with a 400.",
|
|
8863
8934
|
"minLength": 1,
|
|
@@ -9445,6 +9516,14 @@
|
|
|
9445
9516
|
"nullable": true,
|
|
9446
9517
|
"type": "array"
|
|
9447
9518
|
},
|
|
9519
|
+
"licenses": {
|
|
9520
|
+
"description": "Every NMLS license / registration on file for the branch, authorized or not. A current snapshot (refreshed weekly), not period-scoped. Null when the branch's licenses are not on file.",
|
|
9521
|
+
"items": {
|
|
9522
|
+
"$ref": "#/components/schemas/BranchLicense"
|
|
9523
|
+
},
|
|
9524
|
+
"nullable": true,
|
|
9525
|
+
"type": "array"
|
|
9526
|
+
},
|
|
9448
9527
|
"loCount": {
|
|
9449
9528
|
"nullable": true,
|
|
9450
9529
|
"type": "number"
|
|
@@ -18908,6 +18987,97 @@
|
|
|
18908
18987
|
],
|
|
18909
18988
|
"type": "object"
|
|
18910
18989
|
},
|
|
18990
|
+
"CrmImportCheck": {
|
|
18991
|
+
"properties": {
|
|
18992
|
+
"data": {
|
|
18993
|
+
"properties": {
|
|
18994
|
+
"failed": {
|
|
18995
|
+
"type": "number"
|
|
18996
|
+
},
|
|
18997
|
+
"fileRows": {
|
|
18998
|
+
"nullable": true,
|
|
18999
|
+
"type": "number"
|
|
19000
|
+
},
|
|
19001
|
+
"imported": {
|
|
19002
|
+
"type": "number"
|
|
19003
|
+
},
|
|
19004
|
+
"inCrm": {
|
|
19005
|
+
"type": "number"
|
|
19006
|
+
},
|
|
19007
|
+
"lists": {
|
|
19008
|
+
"items": {
|
|
19009
|
+
"properties": {
|
|
19010
|
+
"deleted": {
|
|
19011
|
+
"type": "boolean"
|
|
19012
|
+
},
|
|
19013
|
+
"imported": {
|
|
19014
|
+
"type": "number"
|
|
19015
|
+
},
|
|
19016
|
+
"inList": {
|
|
19017
|
+
"type": "number"
|
|
19018
|
+
},
|
|
19019
|
+
"listId": {
|
|
19020
|
+
"type": "string"
|
|
19021
|
+
},
|
|
19022
|
+
"name": {
|
|
19023
|
+
"type": "string"
|
|
19024
|
+
},
|
|
19025
|
+
"rows": {
|
|
19026
|
+
"type": "number"
|
|
19027
|
+
}
|
|
19028
|
+
},
|
|
19029
|
+
"required": [
|
|
19030
|
+
"listId",
|
|
19031
|
+
"name",
|
|
19032
|
+
"deleted",
|
|
19033
|
+
"rows",
|
|
19034
|
+
"imported",
|
|
19035
|
+
"inList"
|
|
19036
|
+
],
|
|
19037
|
+
"type": "object"
|
|
19038
|
+
},
|
|
19039
|
+
"type": "array"
|
|
19040
|
+
},
|
|
19041
|
+
"notes": {
|
|
19042
|
+
"properties": {
|
|
19043
|
+
"inFile": {
|
|
19044
|
+
"type": "number"
|
|
19045
|
+
},
|
|
19046
|
+
"onFailedRows": {
|
|
19047
|
+
"type": "number"
|
|
19048
|
+
},
|
|
19049
|
+
"present": {
|
|
19050
|
+
"type": "number"
|
|
19051
|
+
}
|
|
19052
|
+
},
|
|
19053
|
+
"required": [
|
|
19054
|
+
"inFile",
|
|
19055
|
+
"onFailedRows",
|
|
19056
|
+
"present"
|
|
19057
|
+
],
|
|
19058
|
+
"type": "object"
|
|
19059
|
+
},
|
|
19060
|
+
"rows": {
|
|
19061
|
+
"type": "number"
|
|
19062
|
+
}
|
|
19063
|
+
},
|
|
19064
|
+
"required": [
|
|
19065
|
+
"fileRows",
|
|
19066
|
+
"rows",
|
|
19067
|
+
"imported",
|
|
19068
|
+
"failed",
|
|
19069
|
+
"inCrm",
|
|
19070
|
+
"lists",
|
|
19071
|
+
"notes"
|
|
19072
|
+
],
|
|
19073
|
+
"type": "object"
|
|
19074
|
+
}
|
|
19075
|
+
},
|
|
19076
|
+
"required": [
|
|
19077
|
+
"data"
|
|
19078
|
+
],
|
|
19079
|
+
"type": "object"
|
|
19080
|
+
},
|
|
18911
19081
|
"CrmImportErrorCode": {
|
|
18912
19082
|
"description": "Failure reason on a failed row; drives friendly client copy. Absent on success.",
|
|
18913
19083
|
"enum": [
|
|
@@ -18916,6 +19086,7 @@
|
|
|
18916
19086
|
"WRONG_OBJECT_TYPE",
|
|
18917
19087
|
"NO_ACCESS",
|
|
18918
19088
|
"UNKNOWN_FIELD",
|
|
19089
|
+
"EXTERNAL_ID_CONFLICT",
|
|
18919
19090
|
"INVALID",
|
|
18920
19091
|
"INTERNAL"
|
|
18921
19092
|
],
|
|
@@ -19043,6 +19214,11 @@
|
|
|
19043
19214
|
"description": "Set to update an existing record; omit to create one.",
|
|
19044
19215
|
"type": "string"
|
|
19045
19216
|
},
|
|
19217
|
+
"externalId": {
|
|
19218
|
+
"description": "The record's id in the source system (unique per org + batch externalSource). A known id updates that record; an unknown one is stamped on the created record, so re-running an import never duplicates. A record holds at most one id — a different one fails the row with EXTERNAL_ID_CONFLICT.",
|
|
19219
|
+
"maxLength": 256,
|
|
19220
|
+
"type": "string"
|
|
19221
|
+
},
|
|
19046
19222
|
"facebook": {
|
|
19047
19223
|
"type": "string"
|
|
19048
19224
|
},
|
|
@@ -19062,6 +19238,21 @@
|
|
|
19062
19238
|
"linkedin": {
|
|
19063
19239
|
"type": "string"
|
|
19064
19240
|
},
|
|
19241
|
+
"listStatus": {
|
|
19242
|
+
"description": "Status (id or label) within the row's first list; becomes the record's status. Fails the row when it isn't one of that list's.",
|
|
19243
|
+
"maxLength": 120,
|
|
19244
|
+
"type": "string"
|
|
19245
|
+
},
|
|
19246
|
+
"lists": {
|
|
19247
|
+
"description": "Lists this row's record joins, by name (case/space-insensitive), among the list owner's lists — the batch ownerUserId, else the caller. A name with no match fails the row unless the batch sets createMissingLists.",
|
|
19248
|
+
"items": {
|
|
19249
|
+
"maxLength": 200,
|
|
19250
|
+
"minLength": 1,
|
|
19251
|
+
"type": "string"
|
|
19252
|
+
},
|
|
19253
|
+
"maxItems": 20,
|
|
19254
|
+
"type": "array"
|
|
19255
|
+
},
|
|
19065
19256
|
"location": {
|
|
19066
19257
|
"type": "string"
|
|
19067
19258
|
},
|
|
@@ -19094,6 +19285,17 @@
|
|
|
19094
19285
|
"realtor": {
|
|
19095
19286
|
"type": "string"
|
|
19096
19287
|
},
|
|
19288
|
+
"rejectReason": {
|
|
19289
|
+
"description": "The client already failed this row (e.g. an undialable phone): it is logged as failed with this reason and never written.",
|
|
19290
|
+
"maxLength": 500,
|
|
19291
|
+
"minLength": 1,
|
|
19292
|
+
"type": "string"
|
|
19293
|
+
},
|
|
19294
|
+
"sourceLine": {
|
|
19295
|
+
"description": "The row's line in the source file; kept in import history so the download points back at the file.",
|
|
19296
|
+
"minimum": 1,
|
|
19297
|
+
"type": "integer"
|
|
19298
|
+
},
|
|
19097
19299
|
"state": {
|
|
19098
19300
|
"type": "string"
|
|
19099
19301
|
},
|
|
@@ -19103,6 +19305,34 @@
|
|
|
19103
19305
|
"subtitle": {
|
|
19104
19306
|
"type": "string"
|
|
19105
19307
|
},
|
|
19308
|
+
"timelineNotes": {
|
|
19309
|
+
"description": "Dated note history (e.g. a legacy notes export), appended as plain notes authored by the record's owner. Keyed: a note the record already has (deleted ones included) is skipped, so re-runs never double it. Distinct from `note`, which is append-only.",
|
|
19310
|
+
"items": {
|
|
19311
|
+
"properties": {
|
|
19312
|
+
"body": {
|
|
19313
|
+
"maxLength": 10000,
|
|
19314
|
+
"minLength": 1,
|
|
19315
|
+
"type": "string"
|
|
19316
|
+
},
|
|
19317
|
+
"key": {
|
|
19318
|
+
"description": "Stable id from the source system; absent ⇒ a hash of date + text.",
|
|
19319
|
+
"maxLength": 256,
|
|
19320
|
+
"type": "string"
|
|
19321
|
+
},
|
|
19322
|
+
"occurredAt": {
|
|
19323
|
+
"description": "ISO date-time the note was written (the timeline backdates to it); an unreadable date fails the row.",
|
|
19324
|
+
"maxLength": 64,
|
|
19325
|
+
"type": "string"
|
|
19326
|
+
}
|
|
19327
|
+
},
|
|
19328
|
+
"required": [
|
|
19329
|
+
"body"
|
|
19330
|
+
],
|
|
19331
|
+
"type": "object"
|
|
19332
|
+
},
|
|
19333
|
+
"maxItems": 200,
|
|
19334
|
+
"type": "array"
|
|
19335
|
+
},
|
|
19106
19336
|
"title": {
|
|
19107
19337
|
"description": "Role title override for people rows (the record's Title field, column and filter) — distinct from `subtitle`, the display line under the name. Trimmed; blank reads as absent. Overwrites on update rows. Ignored on companies imports.",
|
|
19108
19338
|
"type": "string"
|
|
@@ -19154,17 +19384,410 @@
|
|
|
19154
19384
|
],
|
|
19155
19385
|
"type": "object"
|
|
19156
19386
|
},
|
|
19387
|
+
"CrmImportRows": {
|
|
19388
|
+
"properties": {
|
|
19389
|
+
"data": {
|
|
19390
|
+
"properties": {
|
|
19391
|
+
"next": {
|
|
19392
|
+
"nullable": true,
|
|
19393
|
+
"type": "number"
|
|
19394
|
+
},
|
|
19395
|
+
"rows": {
|
|
19396
|
+
"items": {
|
|
19397
|
+
"properties": {
|
|
19398
|
+
"code": {
|
|
19399
|
+
"nullable": true,
|
|
19400
|
+
"type": "string"
|
|
19401
|
+
},
|
|
19402
|
+
"email": {
|
|
19403
|
+
"nullable": true,
|
|
19404
|
+
"type": "string"
|
|
19405
|
+
},
|
|
19406
|
+
"entityId": {
|
|
19407
|
+
"nullable": true,
|
|
19408
|
+
"type": "string"
|
|
19409
|
+
},
|
|
19410
|
+
"error": {
|
|
19411
|
+
"nullable": true,
|
|
19412
|
+
"type": "string"
|
|
19413
|
+
},
|
|
19414
|
+
"externalId": {
|
|
19415
|
+
"nullable": true,
|
|
19416
|
+
"type": "string"
|
|
19417
|
+
},
|
|
19418
|
+
"inCrm": {
|
|
19419
|
+
"type": "boolean"
|
|
19420
|
+
},
|
|
19421
|
+
"inListIds": {
|
|
19422
|
+
"items": {
|
|
19423
|
+
"type": "string"
|
|
19424
|
+
},
|
|
19425
|
+
"type": "array"
|
|
19426
|
+
},
|
|
19427
|
+
"listIds": {
|
|
19428
|
+
"items": {
|
|
19429
|
+
"type": "string"
|
|
19430
|
+
},
|
|
19431
|
+
"type": "array"
|
|
19432
|
+
},
|
|
19433
|
+
"name": {
|
|
19434
|
+
"nullable": true,
|
|
19435
|
+
"type": "string"
|
|
19436
|
+
},
|
|
19437
|
+
"notesInFile": {
|
|
19438
|
+
"type": "number"
|
|
19439
|
+
},
|
|
19440
|
+
"notesPresent": {
|
|
19441
|
+
"type": "number"
|
|
19442
|
+
},
|
|
19443
|
+
"outcome": {
|
|
19444
|
+
"enum": [
|
|
19445
|
+
"created",
|
|
19446
|
+
"updated",
|
|
19447
|
+
"failed"
|
|
19448
|
+
],
|
|
19449
|
+
"type": "string"
|
|
19450
|
+
},
|
|
19451
|
+
"phone": {
|
|
19452
|
+
"nullable": true,
|
|
19453
|
+
"type": "string"
|
|
19454
|
+
},
|
|
19455
|
+
"seq": {
|
|
19456
|
+
"type": "number"
|
|
19457
|
+
},
|
|
19458
|
+
"sourceLine": {
|
|
19459
|
+
"nullable": true,
|
|
19460
|
+
"type": "number"
|
|
19461
|
+
}
|
|
19462
|
+
},
|
|
19463
|
+
"required": [
|
|
19464
|
+
"seq",
|
|
19465
|
+
"outcome",
|
|
19466
|
+
"entityId",
|
|
19467
|
+
"name",
|
|
19468
|
+
"externalId",
|
|
19469
|
+
"email",
|
|
19470
|
+
"phone",
|
|
19471
|
+
"code",
|
|
19472
|
+
"error",
|
|
19473
|
+
"sourceLine",
|
|
19474
|
+
"listIds",
|
|
19475
|
+
"inListIds",
|
|
19476
|
+
"inCrm",
|
|
19477
|
+
"notesInFile",
|
|
19478
|
+
"notesPresent"
|
|
19479
|
+
],
|
|
19480
|
+
"type": "object"
|
|
19481
|
+
},
|
|
19482
|
+
"type": "array"
|
|
19483
|
+
}
|
|
19484
|
+
},
|
|
19485
|
+
"required": [
|
|
19486
|
+
"rows",
|
|
19487
|
+
"next"
|
|
19488
|
+
],
|
|
19489
|
+
"type": "object"
|
|
19490
|
+
}
|
|
19491
|
+
},
|
|
19492
|
+
"required": [
|
|
19493
|
+
"data"
|
|
19494
|
+
],
|
|
19495
|
+
"type": "object"
|
|
19496
|
+
},
|
|
19497
|
+
"CrmImportRun": {
|
|
19498
|
+
"properties": {
|
|
19499
|
+
"data": {
|
|
19500
|
+
"properties": {
|
|
19501
|
+
"canUndo": {
|
|
19502
|
+
"type": "boolean"
|
|
19503
|
+
},
|
|
19504
|
+
"completedAt": {
|
|
19505
|
+
"nullable": true,
|
|
19506
|
+
"type": "string"
|
|
19507
|
+
},
|
|
19508
|
+
"created": {
|
|
19509
|
+
"type": "number"
|
|
19510
|
+
},
|
|
19511
|
+
"createdAt": {
|
|
19512
|
+
"type": "string"
|
|
19513
|
+
},
|
|
19514
|
+
"createdByUserId": {
|
|
19515
|
+
"type": "string"
|
|
19516
|
+
},
|
|
19517
|
+
"externalSource": {
|
|
19518
|
+
"nullable": true,
|
|
19519
|
+
"type": "string"
|
|
19520
|
+
},
|
|
19521
|
+
"failed": {
|
|
19522
|
+
"type": "number"
|
|
19523
|
+
},
|
|
19524
|
+
"fileName": {
|
|
19525
|
+
"nullable": true,
|
|
19526
|
+
"type": "string"
|
|
19527
|
+
},
|
|
19528
|
+
"fileRows": {
|
|
19529
|
+
"nullable": true,
|
|
19530
|
+
"type": "number"
|
|
19531
|
+
},
|
|
19532
|
+
"id": {
|
|
19533
|
+
"type": "string"
|
|
19534
|
+
},
|
|
19535
|
+
"lastUndoAt": {
|
|
19536
|
+
"nullable": true,
|
|
19537
|
+
"type": "string"
|
|
19538
|
+
},
|
|
19539
|
+
"lists": {
|
|
19540
|
+
"items": {
|
|
19541
|
+
"properties": {
|
|
19542
|
+
"created": {
|
|
19543
|
+
"type": "boolean"
|
|
19544
|
+
},
|
|
19545
|
+
"deleted": {
|
|
19546
|
+
"type": "boolean"
|
|
19547
|
+
},
|
|
19548
|
+
"listId": {
|
|
19549
|
+
"type": "string"
|
|
19550
|
+
},
|
|
19551
|
+
"name": {
|
|
19552
|
+
"type": "string"
|
|
19553
|
+
}
|
|
19554
|
+
},
|
|
19555
|
+
"required": [
|
|
19556
|
+
"listId",
|
|
19557
|
+
"name",
|
|
19558
|
+
"created",
|
|
19559
|
+
"deleted"
|
|
19560
|
+
],
|
|
19561
|
+
"type": "object"
|
|
19562
|
+
},
|
|
19563
|
+
"type": "array"
|
|
19564
|
+
},
|
|
19565
|
+
"objectType": {
|
|
19566
|
+
"type": "string"
|
|
19567
|
+
},
|
|
19568
|
+
"ownerUserId": {
|
|
19569
|
+
"nullable": true,
|
|
19570
|
+
"type": "string"
|
|
19571
|
+
},
|
|
19572
|
+
"scoped": {
|
|
19573
|
+
"type": "boolean"
|
|
19574
|
+
},
|
|
19575
|
+
"total": {
|
|
19576
|
+
"type": "number"
|
|
19577
|
+
},
|
|
19578
|
+
"undoRemoved": {
|
|
19579
|
+
"nullable": true,
|
|
19580
|
+
"type": "number"
|
|
19581
|
+
},
|
|
19582
|
+
"undoneAt": {
|
|
19583
|
+
"nullable": true,
|
|
19584
|
+
"type": "string"
|
|
19585
|
+
},
|
|
19586
|
+
"undoneByUserId": {
|
|
19587
|
+
"nullable": true,
|
|
19588
|
+
"type": "string"
|
|
19589
|
+
},
|
|
19590
|
+
"updated": {
|
|
19591
|
+
"type": "number"
|
|
19592
|
+
}
|
|
19593
|
+
},
|
|
19594
|
+
"required": [
|
|
19595
|
+
"id",
|
|
19596
|
+
"createdByUserId",
|
|
19597
|
+
"ownerUserId",
|
|
19598
|
+
"objectType",
|
|
19599
|
+
"externalSource",
|
|
19600
|
+
"fileName",
|
|
19601
|
+
"fileRows",
|
|
19602
|
+
"total",
|
|
19603
|
+
"created",
|
|
19604
|
+
"updated",
|
|
19605
|
+
"failed",
|
|
19606
|
+
"lists",
|
|
19607
|
+
"createdAt",
|
|
19608
|
+
"completedAt",
|
|
19609
|
+
"undoneAt",
|
|
19610
|
+
"undoneByUserId",
|
|
19611
|
+
"undoRemoved",
|
|
19612
|
+
"lastUndoAt",
|
|
19613
|
+
"scoped",
|
|
19614
|
+
"canUndo"
|
|
19615
|
+
],
|
|
19616
|
+
"type": "object"
|
|
19617
|
+
}
|
|
19618
|
+
},
|
|
19619
|
+
"required": [
|
|
19620
|
+
"data"
|
|
19621
|
+
],
|
|
19622
|
+
"type": "object"
|
|
19623
|
+
},
|
|
19624
|
+
"CrmImportRuns": {
|
|
19625
|
+
"properties": {
|
|
19626
|
+
"data": {
|
|
19627
|
+
"items": {
|
|
19628
|
+
"properties": {
|
|
19629
|
+
"canUndo": {
|
|
19630
|
+
"type": "boolean"
|
|
19631
|
+
},
|
|
19632
|
+
"completedAt": {
|
|
19633
|
+
"nullable": true,
|
|
19634
|
+
"type": "string"
|
|
19635
|
+
},
|
|
19636
|
+
"created": {
|
|
19637
|
+
"type": "number"
|
|
19638
|
+
},
|
|
19639
|
+
"createdAt": {
|
|
19640
|
+
"type": "string"
|
|
19641
|
+
},
|
|
19642
|
+
"createdByUserId": {
|
|
19643
|
+
"type": "string"
|
|
19644
|
+
},
|
|
19645
|
+
"externalSource": {
|
|
19646
|
+
"nullable": true,
|
|
19647
|
+
"type": "string"
|
|
19648
|
+
},
|
|
19649
|
+
"failed": {
|
|
19650
|
+
"type": "number"
|
|
19651
|
+
},
|
|
19652
|
+
"fileName": {
|
|
19653
|
+
"nullable": true,
|
|
19654
|
+
"type": "string"
|
|
19655
|
+
},
|
|
19656
|
+
"fileRows": {
|
|
19657
|
+
"nullable": true,
|
|
19658
|
+
"type": "number"
|
|
19659
|
+
},
|
|
19660
|
+
"id": {
|
|
19661
|
+
"type": "string"
|
|
19662
|
+
},
|
|
19663
|
+
"lastUndoAt": {
|
|
19664
|
+
"nullable": true,
|
|
19665
|
+
"type": "string"
|
|
19666
|
+
},
|
|
19667
|
+
"lists": {
|
|
19668
|
+
"items": {
|
|
19669
|
+
"properties": {
|
|
19670
|
+
"created": {
|
|
19671
|
+
"type": "boolean"
|
|
19672
|
+
},
|
|
19673
|
+
"deleted": {
|
|
19674
|
+
"type": "boolean"
|
|
19675
|
+
},
|
|
19676
|
+
"listId": {
|
|
19677
|
+
"type": "string"
|
|
19678
|
+
},
|
|
19679
|
+
"name": {
|
|
19680
|
+
"type": "string"
|
|
19681
|
+
}
|
|
19682
|
+
},
|
|
19683
|
+
"required": [
|
|
19684
|
+
"listId",
|
|
19685
|
+
"name",
|
|
19686
|
+
"created",
|
|
19687
|
+
"deleted"
|
|
19688
|
+
],
|
|
19689
|
+
"type": "object"
|
|
19690
|
+
},
|
|
19691
|
+
"type": "array"
|
|
19692
|
+
},
|
|
19693
|
+
"objectType": {
|
|
19694
|
+
"type": "string"
|
|
19695
|
+
},
|
|
19696
|
+
"ownerUserId": {
|
|
19697
|
+
"nullable": true,
|
|
19698
|
+
"type": "string"
|
|
19699
|
+
},
|
|
19700
|
+
"scoped": {
|
|
19701
|
+
"type": "boolean"
|
|
19702
|
+
},
|
|
19703
|
+
"total": {
|
|
19704
|
+
"type": "number"
|
|
19705
|
+
},
|
|
19706
|
+
"undoRemoved": {
|
|
19707
|
+
"nullable": true,
|
|
19708
|
+
"type": "number"
|
|
19709
|
+
},
|
|
19710
|
+
"undoneAt": {
|
|
19711
|
+
"nullable": true,
|
|
19712
|
+
"type": "string"
|
|
19713
|
+
},
|
|
19714
|
+
"undoneByUserId": {
|
|
19715
|
+
"nullable": true,
|
|
19716
|
+
"type": "string"
|
|
19717
|
+
},
|
|
19718
|
+
"updated": {
|
|
19719
|
+
"type": "number"
|
|
19720
|
+
}
|
|
19721
|
+
},
|
|
19722
|
+
"required": [
|
|
19723
|
+
"id",
|
|
19724
|
+
"createdByUserId",
|
|
19725
|
+
"ownerUserId",
|
|
19726
|
+
"objectType",
|
|
19727
|
+
"externalSource",
|
|
19728
|
+
"fileName",
|
|
19729
|
+
"fileRows",
|
|
19730
|
+
"total",
|
|
19731
|
+
"created",
|
|
19732
|
+
"updated",
|
|
19733
|
+
"failed",
|
|
19734
|
+
"lists",
|
|
19735
|
+
"createdAt",
|
|
19736
|
+
"completedAt",
|
|
19737
|
+
"undoneAt",
|
|
19738
|
+
"undoneByUserId",
|
|
19739
|
+
"undoRemoved",
|
|
19740
|
+
"lastUndoAt",
|
|
19741
|
+
"scoped",
|
|
19742
|
+
"canUndo"
|
|
19743
|
+
],
|
|
19744
|
+
"type": "object"
|
|
19745
|
+
},
|
|
19746
|
+
"type": "array"
|
|
19747
|
+
}
|
|
19748
|
+
},
|
|
19749
|
+
"required": [
|
|
19750
|
+
"data"
|
|
19751
|
+
],
|
|
19752
|
+
"type": "object"
|
|
19753
|
+
},
|
|
19157
19754
|
"CrmImportSummary": {
|
|
19158
19755
|
"properties": {
|
|
19159
19756
|
"created": {
|
|
19160
19757
|
"type": "number"
|
|
19161
19758
|
},
|
|
19759
|
+
"dryRun": {
|
|
19760
|
+
"type": "boolean"
|
|
19761
|
+
},
|
|
19162
19762
|
"enrichJobId": {
|
|
19163
19763
|
"type": "string"
|
|
19164
19764
|
},
|
|
19165
19765
|
"failed": {
|
|
19166
19766
|
"type": "number"
|
|
19167
19767
|
},
|
|
19768
|
+
"lists": {
|
|
19769
|
+
"description": "Lists the rows named (row `lists`), and which this batch created.",
|
|
19770
|
+
"items": {
|
|
19771
|
+
"properties": {
|
|
19772
|
+
"created": {
|
|
19773
|
+
"type": "boolean"
|
|
19774
|
+
},
|
|
19775
|
+
"listId": {
|
|
19776
|
+
"type": "string"
|
|
19777
|
+
},
|
|
19778
|
+
"name": {
|
|
19779
|
+
"type": "string"
|
|
19780
|
+
}
|
|
19781
|
+
},
|
|
19782
|
+
"required": [
|
|
19783
|
+
"name",
|
|
19784
|
+
"listId",
|
|
19785
|
+
"created"
|
|
19786
|
+
],
|
|
19787
|
+
"type": "object"
|
|
19788
|
+
},
|
|
19789
|
+
"type": "array"
|
|
19790
|
+
},
|
|
19168
19791
|
"results": {
|
|
19169
19792
|
"items": {
|
|
19170
19793
|
"$ref": "#/components/schemas/CrmImportRowResult"
|
|
@@ -19187,6 +19810,40 @@
|
|
|
19187
19810
|
],
|
|
19188
19811
|
"type": "object"
|
|
19189
19812
|
},
|
|
19813
|
+
"CrmImportUndo": {
|
|
19814
|
+
"properties": {
|
|
19815
|
+
"data": {
|
|
19816
|
+
"properties": {
|
|
19817
|
+
"keptChanged": {
|
|
19818
|
+
"type": "number"
|
|
19819
|
+
},
|
|
19820
|
+
"keptNoAccess": {
|
|
19821
|
+
"type": "number"
|
|
19822
|
+
},
|
|
19823
|
+
"listsRemoved": {
|
|
19824
|
+
"items": {
|
|
19825
|
+
"type": "string"
|
|
19826
|
+
},
|
|
19827
|
+
"type": "array"
|
|
19828
|
+
},
|
|
19829
|
+
"removed": {
|
|
19830
|
+
"type": "number"
|
|
19831
|
+
}
|
|
19832
|
+
},
|
|
19833
|
+
"required": [
|
|
19834
|
+
"removed",
|
|
19835
|
+
"keptChanged",
|
|
19836
|
+
"keptNoAccess",
|
|
19837
|
+
"listsRemoved"
|
|
19838
|
+
],
|
|
19839
|
+
"type": "object"
|
|
19840
|
+
}
|
|
19841
|
+
},
|
|
19842
|
+
"required": [
|
|
19843
|
+
"data"
|
|
19844
|
+
],
|
|
19845
|
+
"type": "object"
|
|
19846
|
+
},
|
|
19190
19847
|
"CrmLenderChannels": {
|
|
19191
19848
|
"properties": {
|
|
19192
19849
|
"data": {
|
|
@@ -24702,6 +25359,59 @@
|
|
|
24702
25359
|
],
|
|
24703
25360
|
"type": "object"
|
|
24704
25361
|
},
|
|
25362
|
+
"GetSavedFilterSharesResult": {
|
|
25363
|
+
"properties": {
|
|
25364
|
+
"data": {
|
|
25365
|
+
"$ref": "#/components/schemas/SavedFilterSharing"
|
|
25366
|
+
}
|
|
25367
|
+
},
|
|
25368
|
+
"required": [
|
|
25369
|
+
"data"
|
|
25370
|
+
],
|
|
25371
|
+
"type": "object"
|
|
25372
|
+
},
|
|
25373
|
+
"GrantSavedFilterAccessRequest": {
|
|
25374
|
+
"additionalProperties": false,
|
|
25375
|
+
"properties": {
|
|
25376
|
+
"permission": {
|
|
25377
|
+
"allOf": [
|
|
25378
|
+
{
|
|
25379
|
+
"$ref": "#/components/schemas/SavedFilterGrantPermission"
|
|
25380
|
+
},
|
|
25381
|
+
{
|
|
25382
|
+
"description": "Defaults to `viewer`."
|
|
25383
|
+
}
|
|
25384
|
+
]
|
|
25385
|
+
},
|
|
25386
|
+
"userId": {
|
|
25387
|
+
"minLength": 1,
|
|
25388
|
+
"type": "string"
|
|
25389
|
+
}
|
|
25390
|
+
},
|
|
25391
|
+
"required": [
|
|
25392
|
+
"userId"
|
|
25393
|
+
],
|
|
25394
|
+
"type": "object"
|
|
25395
|
+
},
|
|
25396
|
+
"GrantSavedFilterAccessResult": {
|
|
25397
|
+
"properties": {
|
|
25398
|
+
"data": {
|
|
25399
|
+
"properties": {
|
|
25400
|
+
"granted": {
|
|
25401
|
+
"type": "boolean"
|
|
25402
|
+
}
|
|
25403
|
+
},
|
|
25404
|
+
"required": [
|
|
25405
|
+
"granted"
|
|
25406
|
+
],
|
|
25407
|
+
"type": "object"
|
|
25408
|
+
}
|
|
25409
|
+
},
|
|
25410
|
+
"required": [
|
|
25411
|
+
"data"
|
|
25412
|
+
],
|
|
25413
|
+
"type": "object"
|
|
25414
|
+
},
|
|
24705
25415
|
"HeadcountPoint": {
|
|
24706
25416
|
"properties": {
|
|
24707
25417
|
"active": {
|
|
@@ -40012,6 +40722,38 @@
|
|
|
40012
40722
|
],
|
|
40013
40723
|
"type": "object"
|
|
40014
40724
|
},
|
|
40725
|
+
"RevokeSavedFilterAccessRequest": {
|
|
40726
|
+
"additionalProperties": false,
|
|
40727
|
+
"properties": {
|
|
40728
|
+
"userId": {
|
|
40729
|
+
"minLength": 1,
|
|
40730
|
+
"type": "string"
|
|
40731
|
+
}
|
|
40732
|
+
},
|
|
40733
|
+
"required": [
|
|
40734
|
+
"userId"
|
|
40735
|
+
],
|
|
40736
|
+
"type": "object"
|
|
40737
|
+
},
|
|
40738
|
+
"RevokeSavedFilterAccessResult": {
|
|
40739
|
+
"properties": {
|
|
40740
|
+
"data": {
|
|
40741
|
+
"properties": {
|
|
40742
|
+
"revoked": {
|
|
40743
|
+
"type": "boolean"
|
|
40744
|
+
}
|
|
40745
|
+
},
|
|
40746
|
+
"required": [
|
|
40747
|
+
"revoked"
|
|
40748
|
+
],
|
|
40749
|
+
"type": "object"
|
|
40750
|
+
}
|
|
40751
|
+
},
|
|
40752
|
+
"required": [
|
|
40753
|
+
"data"
|
|
40754
|
+
],
|
|
40755
|
+
"type": "object"
|
|
40756
|
+
},
|
|
40015
40757
|
"RosterProductionTier": {
|
|
40016
40758
|
"properties": {
|
|
40017
40759
|
"count": {
|
|
@@ -40712,6 +41454,18 @@
|
|
|
40712
41454
|
},
|
|
40713
41455
|
"SavedFilter": {
|
|
40714
41456
|
"properties": {
|
|
41457
|
+
"canDelete": {
|
|
41458
|
+
"description": "You may delete it (owner or workspace admin).",
|
|
41459
|
+
"type": "boolean"
|
|
41460
|
+
},
|
|
41461
|
+
"canEdit": {
|
|
41462
|
+
"description": "You may update its name, icon, query and UI state (owner, editor, or workspace admin).",
|
|
41463
|
+
"type": "boolean"
|
|
41464
|
+
},
|
|
41465
|
+
"canManageSharing": {
|
|
41466
|
+
"description": "You may change its visibility and who it is shared with (owner or workspace admin).",
|
|
41467
|
+
"type": "boolean"
|
|
41468
|
+
},
|
|
40715
41469
|
"createdAt": {
|
|
40716
41470
|
"format": "date-time",
|
|
40717
41471
|
"type": "string"
|
|
@@ -40731,6 +41485,10 @@
|
|
|
40731
41485
|
"id": {
|
|
40732
41486
|
"type": "string"
|
|
40733
41487
|
},
|
|
41488
|
+
"isOwner": {
|
|
41489
|
+
"description": "True for your own filters; false for ones shared with you.",
|
|
41490
|
+
"type": "boolean"
|
|
41491
|
+
},
|
|
40734
41492
|
"kind": {
|
|
40735
41493
|
"description": "`filter` (default) — a saved search; `view` — a saved CRM table layout (columns / order) kept in `uiState`. Views never carry a `query` and have their own 25-per-target quota. Fixed at create.",
|
|
40736
41494
|
"enum": [
|
|
@@ -40739,6 +41497,12 @@
|
|
|
40739
41497
|
],
|
|
40740
41498
|
"type": "string"
|
|
40741
41499
|
},
|
|
41500
|
+
"lastUsedAt": {
|
|
41501
|
+
"description": "When it was last run; null if never.",
|
|
41502
|
+
"format": "date-time",
|
|
41503
|
+
"nullable": true,
|
|
41504
|
+
"type": "string"
|
|
41505
|
+
},
|
|
40742
41506
|
"name": {
|
|
40743
41507
|
"type": "string"
|
|
40744
41508
|
},
|
|
@@ -40747,6 +41511,24 @@
|
|
|
40747
41511
|
"nullable": true,
|
|
40748
41512
|
"type": "string"
|
|
40749
41513
|
},
|
|
41514
|
+
"ownerName": {
|
|
41515
|
+
"description": "The owner's display name on a filter shared with you; null on your own filters (and when it cannot be resolved).",
|
|
41516
|
+
"nullable": true,
|
|
41517
|
+
"type": "string"
|
|
41518
|
+
},
|
|
41519
|
+
"ownerUserId": {
|
|
41520
|
+
"description": "The user who owns it.",
|
|
41521
|
+
"type": "string"
|
|
41522
|
+
},
|
|
41523
|
+
"permission": {
|
|
41524
|
+
"description": "Your role: `owner`, or the access it was shared with you at (`editor` / `viewer`; a filter visible to the whole workspace without an editor grant is `viewer`).",
|
|
41525
|
+
"enum": [
|
|
41526
|
+
"owner",
|
|
41527
|
+
"editor",
|
|
41528
|
+
"viewer"
|
|
41529
|
+
],
|
|
41530
|
+
"type": "string"
|
|
41531
|
+
},
|
|
40750
41532
|
"query": {
|
|
40751
41533
|
"additionalProperties": {
|
|
40752
41534
|
"nullable": true
|
|
@@ -40815,14 +41597,12 @@
|
|
|
40815
41597
|
"format": "date-time",
|
|
40816
41598
|
"type": "string"
|
|
40817
41599
|
},
|
|
41600
|
+
"useCount": {
|
|
41601
|
+
"description": "How many times the filter has been run: fetched with `getSavedFilter`, or named in `X-MM-Saved-Filter-Id` on a successful list request (count requests do not count).",
|
|
41602
|
+
"type": "integer"
|
|
41603
|
+
},
|
|
40818
41604
|
"visibility": {
|
|
40819
|
-
"
|
|
40820
|
-
"enum": [
|
|
40821
|
-
"private",
|
|
40822
|
-
"organization",
|
|
40823
|
-
"shared"
|
|
40824
|
-
],
|
|
40825
|
-
"type": "string"
|
|
41605
|
+
"$ref": "#/components/schemas/SavedFilterVisibility"
|
|
40826
41606
|
}
|
|
40827
41607
|
},
|
|
40828
41608
|
"required": [
|
|
@@ -40838,6 +41618,15 @@
|
|
|
40838
41618
|
"fidelity",
|
|
40839
41619
|
"unmapped",
|
|
40840
41620
|
"visibility",
|
|
41621
|
+
"ownerUserId",
|
|
41622
|
+
"ownerName",
|
|
41623
|
+
"isOwner",
|
|
41624
|
+
"permission",
|
|
41625
|
+
"canEdit",
|
|
41626
|
+
"canDelete",
|
|
41627
|
+
"canManageSharing",
|
|
41628
|
+
"useCount",
|
|
41629
|
+
"lastUsedAt",
|
|
40841
41630
|
"operationId",
|
|
40842
41631
|
"stale",
|
|
40843
41632
|
"staleIssues",
|
|
@@ -40849,7 +41638,7 @@
|
|
|
40849
41638
|
"SavedFilterError": {
|
|
40850
41639
|
"properties": {
|
|
40851
41640
|
"code": {
|
|
40852
|
-
"description": "`QUOTA_EXCEEDED` (409, 25 per target + kind).",
|
|
41641
|
+
"description": "`QUOTA_EXCEEDED` (409, 25 per target + kind), `FORBIDDEN` (403, your access to a shared filter does not allow this), `NOT_ORG_MEMBER` (400, the user to share with is not in your workspace).",
|
|
40853
41642
|
"type": "string"
|
|
40854
41643
|
},
|
|
40855
41644
|
"error": {
|
|
@@ -40879,91 +41668,223 @@
|
|
|
40879
41668
|
],
|
|
40880
41669
|
"type": "object"
|
|
40881
41670
|
},
|
|
41671
|
+
"SavedFilterGrantPermission": {
|
|
41672
|
+
"description": "The whole workspace's role on an `organization` filter; null for private / shared filters.",
|
|
41673
|
+
"enum": [
|
|
41674
|
+
"editor",
|
|
41675
|
+
"viewer",
|
|
41676
|
+
null
|
|
41677
|
+
],
|
|
41678
|
+
"nullable": true,
|
|
41679
|
+
"type": "string"
|
|
41680
|
+
},
|
|
40882
41681
|
"SavedFilterIcon": {
|
|
40883
|
-
"description": "Optional marker:
|
|
40884
|
-
"
|
|
40885
|
-
|
|
41682
|
+
"description": "Optional marker: one emoji. (Color dots and named icons were retired; existing ones were converted to the nearest emoji.)",
|
|
41683
|
+
"nullable": true,
|
|
41684
|
+
"properties": {
|
|
41685
|
+
"emoji": {
|
|
41686
|
+
"maxLength": 16,
|
|
41687
|
+
"minLength": 1,
|
|
41688
|
+
"type": "string"
|
|
41689
|
+
},
|
|
41690
|
+
"type": {
|
|
41691
|
+
"enum": [
|
|
41692
|
+
"emoji"
|
|
41693
|
+
],
|
|
41694
|
+
"type": "string"
|
|
41695
|
+
}
|
|
41696
|
+
},
|
|
41697
|
+
"required": [
|
|
41698
|
+
"type",
|
|
41699
|
+
"emoji"
|
|
41700
|
+
],
|
|
41701
|
+
"type": "object"
|
|
41702
|
+
},
|
|
41703
|
+
"SavedFilterList": {
|
|
41704
|
+
"properties": {
|
|
41705
|
+
"data": {
|
|
41706
|
+
"items": {
|
|
41707
|
+
"$ref": "#/components/schemas/SavedFilter"
|
|
41708
|
+
},
|
|
41709
|
+
"type": "array"
|
|
41710
|
+
}
|
|
41711
|
+
},
|
|
41712
|
+
"required": [
|
|
41713
|
+
"data"
|
|
41714
|
+
],
|
|
41715
|
+
"type": "object"
|
|
41716
|
+
},
|
|
41717
|
+
"SavedFilterShare": {
|
|
41718
|
+
"properties": {
|
|
41719
|
+
"createdAt": {
|
|
41720
|
+
"description": "Epoch milliseconds.",
|
|
41721
|
+
"type": "number"
|
|
41722
|
+
},
|
|
41723
|
+
"email": {
|
|
41724
|
+
"nullable": true,
|
|
41725
|
+
"type": "string"
|
|
41726
|
+
},
|
|
41727
|
+
"id": {
|
|
41728
|
+
"type": "string"
|
|
41729
|
+
},
|
|
41730
|
+
"image": {
|
|
41731
|
+
"nullable": true,
|
|
41732
|
+
"type": "string"
|
|
41733
|
+
},
|
|
41734
|
+
"invitedByName": {
|
|
41735
|
+
"nullable": true,
|
|
41736
|
+
"type": "string"
|
|
41737
|
+
},
|
|
41738
|
+
"name": {
|
|
41739
|
+
"nullable": true,
|
|
41740
|
+
"type": "string"
|
|
41741
|
+
},
|
|
41742
|
+
"permission": {
|
|
41743
|
+
"enum": [
|
|
41744
|
+
"owner",
|
|
41745
|
+
"editor",
|
|
41746
|
+
"viewer"
|
|
41747
|
+
],
|
|
41748
|
+
"type": "string"
|
|
41749
|
+
},
|
|
41750
|
+
"userId": {
|
|
41751
|
+
"type": "string"
|
|
41752
|
+
}
|
|
41753
|
+
},
|
|
41754
|
+
"required": [
|
|
41755
|
+
"id",
|
|
41756
|
+
"userId",
|
|
41757
|
+
"name",
|
|
41758
|
+
"email",
|
|
41759
|
+
"image",
|
|
41760
|
+
"permission",
|
|
41761
|
+
"invitedByName",
|
|
41762
|
+
"createdAt"
|
|
41763
|
+
],
|
|
41764
|
+
"type": "object"
|
|
41765
|
+
},
|
|
41766
|
+
"SavedFilterShareableMember": {
|
|
41767
|
+
"properties": {
|
|
41768
|
+
"email": {
|
|
41769
|
+
"nullable": true,
|
|
41770
|
+
"type": "string"
|
|
41771
|
+
},
|
|
41772
|
+
"image": {
|
|
41773
|
+
"nullable": true,
|
|
41774
|
+
"type": "string"
|
|
41775
|
+
},
|
|
41776
|
+
"name": {
|
|
41777
|
+
"nullable": true,
|
|
41778
|
+
"type": "string"
|
|
41779
|
+
},
|
|
41780
|
+
"userId": {
|
|
41781
|
+
"type": "string"
|
|
41782
|
+
}
|
|
41783
|
+
},
|
|
41784
|
+
"required": [
|
|
41785
|
+
"userId",
|
|
41786
|
+
"name",
|
|
41787
|
+
"email",
|
|
41788
|
+
"image"
|
|
41789
|
+
],
|
|
41790
|
+
"type": "object"
|
|
41791
|
+
},
|
|
41792
|
+
"SavedFilterShareableMemberList": {
|
|
41793
|
+
"properties": {
|
|
41794
|
+
"data": {
|
|
40886
41795
|
"properties": {
|
|
40887
|
-
"
|
|
40888
|
-
"
|
|
40889
|
-
|
|
40890
|
-
|
|
40891
|
-
|
|
40892
|
-
"enum": [
|
|
40893
|
-
"color"
|
|
40894
|
-
],
|
|
40895
|
-
"type": "string"
|
|
41796
|
+
"members": {
|
|
41797
|
+
"items": {
|
|
41798
|
+
"$ref": "#/components/schemas/SavedFilterShareableMember"
|
|
41799
|
+
},
|
|
41800
|
+
"type": "array"
|
|
40896
41801
|
}
|
|
40897
41802
|
},
|
|
40898
41803
|
"required": [
|
|
40899
|
-
"
|
|
40900
|
-
"color"
|
|
41804
|
+
"members"
|
|
40901
41805
|
],
|
|
40902
41806
|
"type": "object"
|
|
41807
|
+
}
|
|
41808
|
+
},
|
|
41809
|
+
"required": [
|
|
41810
|
+
"data"
|
|
41811
|
+
],
|
|
41812
|
+
"type": "object"
|
|
41813
|
+
},
|
|
41814
|
+
"SavedFilterSharing": {
|
|
41815
|
+
"properties": {
|
|
41816
|
+
"canManageSharing": {
|
|
41817
|
+
"description": "The caller may grant / revoke and change visibility (owner or workspace admin).",
|
|
41818
|
+
"type": "boolean"
|
|
40903
41819
|
},
|
|
40904
|
-
{
|
|
41820
|
+
"orgWidePermission": {
|
|
41821
|
+
"allOf": [
|
|
41822
|
+
{
|
|
41823
|
+
"$ref": "#/components/schemas/SavedFilterGrantPermission"
|
|
41824
|
+
},
|
|
41825
|
+
{
|
|
41826
|
+
"description": "On an `organization` filter, whether every member can edit or only view. Always `viewer` otherwise."
|
|
41827
|
+
}
|
|
41828
|
+
]
|
|
41829
|
+
},
|
|
41830
|
+
"owner": {
|
|
40905
41831
|
"properties": {
|
|
40906
|
-
"
|
|
40907
|
-
"
|
|
41832
|
+
"email": {
|
|
41833
|
+
"nullable": true,
|
|
40908
41834
|
"type": "string"
|
|
40909
41835
|
},
|
|
40910
|
-
"
|
|
40911
|
-
"
|
|
41836
|
+
"image": {
|
|
41837
|
+
"nullable": true,
|
|
40912
41838
|
"type": "string"
|
|
40913
41839
|
},
|
|
40914
|
-
"
|
|
40915
|
-
"
|
|
40916
|
-
"icon"
|
|
40917
|
-
],
|
|
40918
|
-
"type": "string"
|
|
40919
|
-
}
|
|
40920
|
-
},
|
|
40921
|
-
"required": [
|
|
40922
|
-
"type",
|
|
40923
|
-
"icon",
|
|
40924
|
-
"color"
|
|
40925
|
-
],
|
|
40926
|
-
"type": "object"
|
|
40927
|
-
},
|
|
40928
|
-
{
|
|
40929
|
-
"properties": {
|
|
40930
|
-
"emoji": {
|
|
40931
|
-
"maxLength": 16,
|
|
40932
|
-
"minLength": 1,
|
|
41840
|
+
"name": {
|
|
41841
|
+
"nullable": true,
|
|
40933
41842
|
"type": "string"
|
|
40934
41843
|
},
|
|
40935
|
-
"
|
|
40936
|
-
"enum": [
|
|
40937
|
-
"emoji"
|
|
40938
|
-
],
|
|
41844
|
+
"userId": {
|
|
40939
41845
|
"type": "string"
|
|
40940
41846
|
}
|
|
40941
41847
|
},
|
|
40942
41848
|
"required": [
|
|
40943
|
-
"
|
|
40944
|
-
"
|
|
41849
|
+
"userId",
|
|
41850
|
+
"name",
|
|
41851
|
+
"email",
|
|
41852
|
+
"image"
|
|
40945
41853
|
],
|
|
40946
41854
|
"type": "object"
|
|
40947
41855
|
},
|
|
40948
|
-
{
|
|
40949
|
-
"
|
|
40950
|
-
}
|
|
40951
|
-
|
|
40952
|
-
},
|
|
40953
|
-
"SavedFilterList": {
|
|
40954
|
-
"properties": {
|
|
40955
|
-
"data": {
|
|
41856
|
+
"ownerUserId": {
|
|
41857
|
+
"type": "string"
|
|
41858
|
+
},
|
|
41859
|
+
"shares": {
|
|
40956
41860
|
"items": {
|
|
40957
|
-
"$ref": "#/components/schemas/
|
|
41861
|
+
"$ref": "#/components/schemas/SavedFilterShare"
|
|
40958
41862
|
},
|
|
40959
41863
|
"type": "array"
|
|
41864
|
+
},
|
|
41865
|
+
"visibility": {
|
|
41866
|
+
"$ref": "#/components/schemas/SavedFilterVisibility"
|
|
40960
41867
|
}
|
|
40961
41868
|
},
|
|
40962
41869
|
"required": [
|
|
40963
|
-
"
|
|
41870
|
+
"visibility",
|
|
41871
|
+
"ownerUserId",
|
|
41872
|
+
"owner",
|
|
41873
|
+
"canManageSharing",
|
|
41874
|
+
"orgWidePermission",
|
|
41875
|
+
"shares"
|
|
40964
41876
|
],
|
|
40965
41877
|
"type": "object"
|
|
40966
41878
|
},
|
|
41879
|
+
"SavedFilterVisibility": {
|
|
41880
|
+
"description": "Who can see the filter: `private` — only its owner; `organization` — every member of the workspace (view; edit too when `orgWidePermission` is `editor`); `shared` — only the members it was shared with (see `/saved-filters/{id}/shares`).",
|
|
41881
|
+
"enum": [
|
|
41882
|
+
"private",
|
|
41883
|
+
"organization",
|
|
41884
|
+
"shared"
|
|
41885
|
+
],
|
|
41886
|
+
"type": "string"
|
|
41887
|
+
},
|
|
40967
41888
|
"SearchTokenResponse": {
|
|
40968
41889
|
"properties": {
|
|
40969
41890
|
"expiresAt": {
|
|
@@ -42021,6 +42942,16 @@
|
|
|
42021
42942
|
"minLength": 1,
|
|
42022
42943
|
"type": "string"
|
|
42023
42944
|
},
|
|
42945
|
+
"orgWidePermission": {
|
|
42946
|
+
"allOf": [
|
|
42947
|
+
{
|
|
42948
|
+
"$ref": "#/components/schemas/SavedFilterGrantPermission"
|
|
42949
|
+
},
|
|
42950
|
+
{
|
|
42951
|
+
"description": "Owner or workspace admin only. The whole workspace's role; setting it also sets `visibility: organization`."
|
|
42952
|
+
}
|
|
42953
|
+
]
|
|
42954
|
+
},
|
|
42024
42955
|
"query": {
|
|
42025
42956
|
"additionalProperties": {
|
|
42026
42957
|
"nullable": true
|
|
@@ -42050,6 +42981,16 @@
|
|
|
42050
42981
|
},
|
|
42051
42982
|
"maxItems": 100,
|
|
42052
42983
|
"type": "array"
|
|
42984
|
+
},
|
|
42985
|
+
"visibility": {
|
|
42986
|
+
"allOf": [
|
|
42987
|
+
{
|
|
42988
|
+
"$ref": "#/components/schemas/SavedFilterVisibility"
|
|
42989
|
+
},
|
|
42990
|
+
{
|
|
42991
|
+
"description": "Owner or workspace admin only. `private` removes every share; `shared` removes the workspace-wide grant; sharing with a member (`POST /saved-filters/{id}/shares`) turns a private filter into `shared` on its own."
|
|
42992
|
+
}
|
|
42993
|
+
]
|
|
42053
42994
|
}
|
|
42054
42995
|
},
|
|
42055
42996
|
"type": "object"
|
|
@@ -42324,7 +43265,7 @@
|
|
|
42324
43265
|
"info": {
|
|
42325
43266
|
"description": "ModelMatch API — mortgage and real-estate market data.\n\n## Bulk delivery limits\n\nThe `POST /{entity}/bulk-delivery` endpoints export a full result set to\nS3 as NDJSON, JSON, CSV, or Parquet.\n\n- **Up to 5,000 rows per delivery: no entitlement required.** Available to\n every authenticated caller.\n- **Above 5,000 rows: requires the entity's `bulk-delivery.{entity}`\n entitlement** (e.g. `bulk-delivery.loans`). The grant's scope sets your\n row ceiling and may also restrict which rows and fields you receive.\n\nA delivery that would exceed the limit available to you is rejected with\n`403 entitlement_missing`, reporting the matched row count and the ceiling\nthat applied. To stay under the limit, pass `limit` — the job then delivers\n(and bills for) only the first `limit` rows of a broader query.\n\n**Need a higher limit?** Email support@modelmatch.com to request the\nentitlement. Limits are raised per organization and per entity.\n\nBulk delivery is billed at 1 credit per delivered row whether or not\nan entitlement is held.\n\nInstead of a download, a delivery can be sent to a push target configured\non your workspace: pass `destination: { type: \"push-target\", targetId }`.\nThe same limits and billing apply.",
|
|
42326
43267
|
"title": "ModelMatch API",
|
|
42327
|
-
"version": "3.
|
|
43268
|
+
"version": "3.109.2"
|
|
42328
43269
|
},
|
|
42329
43270
|
"openapi": "3.1.0",
|
|
42330
43271
|
"paths": {
|
|
@@ -56682,6 +57623,14 @@
|
|
|
56682
57623
|
"application/json": {
|
|
56683
57624
|
"schema": {
|
|
56684
57625
|
"properties": {
|
|
57626
|
+
"createMissingLists": {
|
|
57627
|
+
"description": "Create lists rows name that the list owner doesn't have yet, owned by ownerUserId (else the caller).",
|
|
57628
|
+
"type": "boolean"
|
|
57629
|
+
},
|
|
57630
|
+
"dryRun": {
|
|
57631
|
+
"description": "Plan only: return what the import WOULD do (per-row created / updated / failed, lists it would find or create) without writing anything. Always synchronous.",
|
|
57632
|
+
"type": "boolean"
|
|
57633
|
+
},
|
|
56685
57634
|
"entityType": {
|
|
56686
57635
|
"allOf": [
|
|
56687
57636
|
{
|
|
@@ -56692,10 +57641,50 @@
|
|
|
56692
57641
|
}
|
|
56693
57642
|
]
|
|
56694
57643
|
},
|
|
57644
|
+
"externalSource": {
|
|
57645
|
+
"description": "Source system the rows' externalIds belong to (e.g. \"legacy-mm\"). Defaults to \"import\".",
|
|
57646
|
+
"pattern": "^[a-z0-9][a-z0-9-]{0,63}$",
|
|
57647
|
+
"type": "string"
|
|
57648
|
+
},
|
|
57649
|
+
"fileName": {
|
|
57650
|
+
"description": "Source file name, shown in import history.",
|
|
57651
|
+
"maxLength": 255,
|
|
57652
|
+
"type": "string"
|
|
57653
|
+
},
|
|
57654
|
+
"fileRows": {
|
|
57655
|
+
"description": "Data rows in the source file (the client's count, including rows it rejected before sending) — the check report's file rows.",
|
|
57656
|
+
"minimum": 0,
|
|
57657
|
+
"type": "integer"
|
|
57658
|
+
},
|
|
57659
|
+
"importBatchKey": {
|
|
57660
|
+
"description": "This batch's key within its run (e.g. \"2/5\"). A batch resent under a key the run already recorded is refused (409).",
|
|
57661
|
+
"maxLength": 40,
|
|
57662
|
+
"minLength": 1,
|
|
57663
|
+
"type": "string"
|
|
57664
|
+
},
|
|
57665
|
+
"importRunId": {
|
|
57666
|
+
"description": "Import history run id, minted by the client per run and sent with every batch of it — the batches become one history entry.",
|
|
57667
|
+
"maxLength": 100,
|
|
57668
|
+
"minLength": 1,
|
|
57669
|
+
"type": "string"
|
|
57670
|
+
},
|
|
56695
57671
|
"listId": {
|
|
56696
57672
|
"nullable": true,
|
|
56697
57673
|
"type": "string"
|
|
56698
57674
|
},
|
|
57675
|
+
"listStatuses": {
|
|
57676
|
+
"additionalProperties": {
|
|
57677
|
+
"items": {
|
|
57678
|
+
"maxLength": 120,
|
|
57679
|
+
"minLength": 1,
|
|
57680
|
+
"type": "string"
|
|
57681
|
+
},
|
|
57682
|
+
"maxItems": 50,
|
|
57683
|
+
"type": "array"
|
|
57684
|
+
},
|
|
57685
|
+
"description": "Status labels, in order, per list name — the status vocabulary of lists this batch creates (else the default statuses).",
|
|
57686
|
+
"type": "object"
|
|
57687
|
+
},
|
|
56699
57688
|
"objectType": {
|
|
56700
57689
|
"$ref": "#/components/schemas/CrmObjectType"
|
|
56701
57690
|
},
|
|
@@ -56780,6 +57769,16 @@
|
|
|
56780
57769
|
},
|
|
56781
57770
|
"description": "Not found"
|
|
56782
57771
|
},
|
|
57772
|
+
"409": {
|
|
57773
|
+
"content": {
|
|
57774
|
+
"application/json": {
|
|
57775
|
+
"schema": {
|
|
57776
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
57777
|
+
}
|
|
57778
|
+
}
|
|
57779
|
+
},
|
|
57780
|
+
"description": "This batch's `importBatchKey` was already recorded on the run — a resend, refused."
|
|
57781
|
+
},
|
|
56783
57782
|
"413": {
|
|
56784
57783
|
"content": {
|
|
56785
57784
|
"application/json": {
|
|
@@ -56910,40 +57909,53 @@
|
|
|
56910
57909
|
]
|
|
56911
57910
|
}
|
|
56912
57911
|
},
|
|
56913
|
-
"/v1/crm/
|
|
56914
|
-
"
|
|
56915
|
-
"operationId": "
|
|
56916
|
-
"
|
|
56917
|
-
|
|
56918
|
-
"
|
|
56919
|
-
|
|
56920
|
-
|
|
56921
|
-
|
|
56922
|
-
|
|
56923
|
-
|
|
56924
|
-
|
|
56925
|
-
|
|
56926
|
-
|
|
56927
|
-
|
|
56928
|
-
|
|
56929
|
-
|
|
56930
|
-
|
|
56931
|
-
|
|
56932
|
-
|
|
56933
|
-
|
|
57912
|
+
"/v1/crm/imports": {
|
|
57913
|
+
"get": {
|
|
57914
|
+
"operationId": "listCrmImports",
|
|
57915
|
+
"parameters": [
|
|
57916
|
+
{
|
|
57917
|
+
"in": "query",
|
|
57918
|
+
"name": "limit",
|
|
57919
|
+
"required": false,
|
|
57920
|
+
"schema": {
|
|
57921
|
+
"maximum": 500,
|
|
57922
|
+
"minimum": 1,
|
|
57923
|
+
"type": "integer"
|
|
57924
|
+
}
|
|
57925
|
+
},
|
|
57926
|
+
{
|
|
57927
|
+
"description": "Only runs that touched this list (list settings).",
|
|
57928
|
+
"in": "query",
|
|
57929
|
+
"name": "listId",
|
|
57930
|
+
"required": false,
|
|
57931
|
+
"schema": {
|
|
57932
|
+
"description": "Only runs that touched this list (list settings).",
|
|
57933
|
+
"minLength": 1,
|
|
57934
|
+
"type": "string"
|
|
57935
|
+
}
|
|
57936
|
+
},
|
|
57937
|
+
{
|
|
57938
|
+
"description": "Page back: runs created before this (the last run's `createdAt`).",
|
|
57939
|
+
"in": "query",
|
|
57940
|
+
"name": "before",
|
|
57941
|
+
"required": false,
|
|
57942
|
+
"schema": {
|
|
57943
|
+
"description": "Page back: runs created before this (the last run's `createdAt`).",
|
|
57944
|
+
"format": "date-time",
|
|
57945
|
+
"type": "string"
|
|
56934
57946
|
}
|
|
56935
57947
|
}
|
|
56936
|
-
|
|
57948
|
+
],
|
|
56937
57949
|
"responses": {
|
|
56938
57950
|
"200": {
|
|
56939
57951
|
"content": {
|
|
56940
57952
|
"application/json": {
|
|
56941
57953
|
"schema": {
|
|
56942
|
-
"$ref": "#/components/schemas/
|
|
57954
|
+
"$ref": "#/components/schemas/CrmImportRuns"
|
|
56943
57955
|
}
|
|
56944
57956
|
}
|
|
56945
57957
|
},
|
|
56946
|
-
"description": "
|
|
57958
|
+
"description": "Import runs."
|
|
56947
57959
|
},
|
|
56948
57960
|
"400": {
|
|
56949
57961
|
"content": {
|
|
@@ -57006,42 +58018,23 @@
|
|
|
57006
58018
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
57007
58019
|
}
|
|
57008
58020
|
},
|
|
57009
|
-
"summary": "
|
|
58021
|
+
"summary": "List import runs (own + into your lists; all for admins), newest first",
|
|
57010
58022
|
"tags": [
|
|
57011
58023
|
"CRM"
|
|
57012
58024
|
]
|
|
57013
58025
|
}
|
|
57014
58026
|
},
|
|
57015
|
-
"/v1/crm/
|
|
58027
|
+
"/v1/crm/imports/{id}": {
|
|
57016
58028
|
"get": {
|
|
57017
|
-
"operationId": "
|
|
58029
|
+
"operationId": "getCrmImport",
|
|
57018
58030
|
"parameters": [
|
|
57019
58031
|
{
|
|
57020
|
-
"
|
|
57021
|
-
"
|
|
57022
|
-
"
|
|
57023
|
-
"
|
|
57024
|
-
"$ref": "#/components/schemas/CrmObjectType"
|
|
57025
|
-
}
|
|
57026
|
-
},
|
|
57027
|
-
{
|
|
57028
|
-
"in": "query",
|
|
57029
|
-
"name": "entityId",
|
|
57030
|
-
"required": false,
|
|
58032
|
+
"description": "Import run id.",
|
|
58033
|
+
"in": "path",
|
|
58034
|
+
"name": "id",
|
|
58035
|
+
"required": true,
|
|
57031
58036
|
"schema": {
|
|
57032
|
-
"
|
|
57033
|
-
"type": "string"
|
|
57034
|
-
}
|
|
57035
|
-
},
|
|
57036
|
-
{
|
|
57037
|
-
"in": "query",
|
|
57038
|
-
"name": "scope",
|
|
57039
|
-
"required": false,
|
|
57040
|
-
"schema": {
|
|
57041
|
-
"enum": [
|
|
57042
|
-
"visible",
|
|
57043
|
-
"all"
|
|
57044
|
-
],
|
|
58037
|
+
"description": "Import run id.",
|
|
57045
58038
|
"type": "string"
|
|
57046
58039
|
}
|
|
57047
58040
|
}
|
|
@@ -57051,11 +58044,11 @@
|
|
|
57051
58044
|
"content": {
|
|
57052
58045
|
"application/json": {
|
|
57053
58046
|
"schema": {
|
|
57054
|
-
"$ref": "#/components/schemas/
|
|
58047
|
+
"$ref": "#/components/schemas/CrmImportRun"
|
|
57055
58048
|
}
|
|
57056
58049
|
}
|
|
57057
58050
|
},
|
|
57058
|
-
"description": "
|
|
58051
|
+
"description": "The import run."
|
|
57059
58052
|
},
|
|
57060
58053
|
"400": {
|
|
57061
58054
|
"content": {
|
|
@@ -57118,44 +58111,37 @@
|
|
|
57118
58111
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
57119
58112
|
}
|
|
57120
58113
|
},
|
|
57121
|
-
"summary": "
|
|
58114
|
+
"summary": "Get one import run",
|
|
57122
58115
|
"tags": [
|
|
57123
58116
|
"CRM"
|
|
57124
58117
|
]
|
|
57125
|
-
}
|
|
57126
|
-
|
|
57127
|
-
|
|
57128
|
-
|
|
57129
|
-
|
|
57130
|
-
|
|
57131
|
-
|
|
57132
|
-
|
|
57133
|
-
|
|
57134
|
-
|
|
57135
|
-
|
|
57136
|
-
|
|
57137
|
-
|
|
57138
|
-
|
|
57139
|
-
},
|
|
57140
|
-
"required": [
|
|
57141
|
-
"name",
|
|
57142
|
-
"objectType"
|
|
57143
|
-
],
|
|
57144
|
-
"type": "object"
|
|
57145
|
-
}
|
|
58118
|
+
}
|
|
58119
|
+
},
|
|
58120
|
+
"/v1/crm/imports/{id}/check": {
|
|
58121
|
+
"get": {
|
|
58122
|
+
"operationId": "checkCrmImport",
|
|
58123
|
+
"parameters": [
|
|
58124
|
+
{
|
|
58125
|
+
"description": "Import run id.",
|
|
58126
|
+
"in": "path",
|
|
58127
|
+
"name": "id",
|
|
58128
|
+
"required": true,
|
|
58129
|
+
"schema": {
|
|
58130
|
+
"description": "Import run id.",
|
|
58131
|
+
"type": "string"
|
|
57146
58132
|
}
|
|
57147
58133
|
}
|
|
57148
|
-
|
|
58134
|
+
],
|
|
57149
58135
|
"responses": {
|
|
57150
58136
|
"200": {
|
|
57151
58137
|
"content": {
|
|
57152
58138
|
"application/json": {
|
|
57153
58139
|
"schema": {
|
|
57154
|
-
"$ref": "#/components/schemas/
|
|
58140
|
+
"$ref": "#/components/schemas/CrmImportCheck"
|
|
57155
58141
|
}
|
|
57156
58142
|
}
|
|
57157
58143
|
},
|
|
57158
|
-
"description": "The
|
|
58144
|
+
"description": "The run checked against the CRM now."
|
|
57159
58145
|
},
|
|
57160
58146
|
"400": {
|
|
57161
58147
|
"content": {
|
|
@@ -57218,31 +58204,46 @@
|
|
|
57218
58204
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
57219
58205
|
}
|
|
57220
58206
|
},
|
|
57221
|
-
"summary": "
|
|
58207
|
+
"summary": "Check report for an import run (rows, records, lists, notes)",
|
|
57222
58208
|
"tags": [
|
|
57223
58209
|
"CRM"
|
|
57224
58210
|
]
|
|
57225
58211
|
}
|
|
57226
58212
|
},
|
|
57227
|
-
"/v1/crm/
|
|
58213
|
+
"/v1/crm/imports/{id}/rows": {
|
|
57228
58214
|
"get": {
|
|
57229
|
-
"operationId": "
|
|
58215
|
+
"operationId": "listCrmImportRows",
|
|
57230
58216
|
"parameters": [
|
|
57231
58217
|
{
|
|
58218
|
+
"description": "Import run id.",
|
|
58219
|
+
"in": "path",
|
|
58220
|
+
"name": "id",
|
|
58221
|
+
"required": true,
|
|
58222
|
+
"schema": {
|
|
58223
|
+
"description": "Import run id.",
|
|
58224
|
+
"type": "string"
|
|
58225
|
+
}
|
|
58226
|
+
},
|
|
58227
|
+
{
|
|
58228
|
+
"description": "Cursor: return rows after this `seq` (from `next`).",
|
|
57232
58229
|
"in": "query",
|
|
57233
|
-
"name": "
|
|
58230
|
+
"name": "after",
|
|
57234
58231
|
"required": false,
|
|
57235
58232
|
"schema": {
|
|
57236
|
-
"
|
|
58233
|
+
"description": "Cursor: return rows after this `seq` (from `next`).",
|
|
58234
|
+
"minimum": -1,
|
|
58235
|
+
"nullable": true,
|
|
58236
|
+
"type": "integer"
|
|
57237
58237
|
}
|
|
57238
58238
|
},
|
|
57239
58239
|
{
|
|
57240
58240
|
"in": "query",
|
|
57241
|
-
"name": "
|
|
57242
|
-
"required":
|
|
58241
|
+
"name": "limit",
|
|
58242
|
+
"required": false,
|
|
57243
58243
|
"schema": {
|
|
57244
|
-
"
|
|
57245
|
-
"
|
|
58244
|
+
"maximum": 5000,
|
|
58245
|
+
"minimum": 1,
|
|
58246
|
+
"type": "integer"
|
|
57246
58247
|
}
|
|
57247
58248
|
}
|
|
57248
58249
|
],
|
|
@@ -57251,11 +58252,11 @@
|
|
|
57251
58252
|
"content": {
|
|
57252
58253
|
"application/json": {
|
|
57253
58254
|
"schema": {
|
|
57254
|
-
"$ref": "#/components/schemas/
|
|
58255
|
+
"$ref": "#/components/schemas/CrmImportRows"
|
|
57255
58256
|
}
|
|
57256
58257
|
}
|
|
57257
58258
|
},
|
|
57258
|
-
"description": "
|
|
58259
|
+
"description": "A page of the run's rows."
|
|
57259
58260
|
},
|
|
57260
58261
|
"400": {
|
|
57261
58262
|
"content": {
|
|
@@ -57318,35 +58319,53 @@
|
|
|
57318
58319
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
57319
58320
|
}
|
|
57320
58321
|
},
|
|
57321
|
-
"summary": "
|
|
58322
|
+
"summary": "Every row of an import run with its outcome, in file order",
|
|
57322
58323
|
"tags": [
|
|
57323
58324
|
"CRM"
|
|
57324
58325
|
]
|
|
57325
58326
|
}
|
|
57326
58327
|
},
|
|
57327
|
-
"/v1/crm/
|
|
57328
|
-
"
|
|
57329
|
-
"operationId": "
|
|
58328
|
+
"/v1/crm/imports/{id}/undo": {
|
|
58329
|
+
"post": {
|
|
58330
|
+
"operationId": "undoCrmImport",
|
|
57330
58331
|
"parameters": [
|
|
57331
58332
|
{
|
|
58333
|
+
"description": "Import run id.",
|
|
57332
58334
|
"in": "path",
|
|
57333
58335
|
"name": "id",
|
|
57334
58336
|
"required": true,
|
|
57335
58337
|
"schema": {
|
|
58338
|
+
"description": "Import run id.",
|
|
57336
58339
|
"type": "string"
|
|
57337
58340
|
}
|
|
57338
58341
|
}
|
|
57339
58342
|
],
|
|
58343
|
+
"requestBody": {
|
|
58344
|
+
"content": {
|
|
58345
|
+
"application/json": {
|
|
58346
|
+
"schema": {
|
|
58347
|
+
"properties": {
|
|
58348
|
+
"dryRun": {
|
|
58349
|
+
"description": "Count what would be removed; change nothing.",
|
|
58350
|
+
"type": "boolean"
|
|
58351
|
+
}
|
|
58352
|
+
},
|
|
58353
|
+
"type": "object"
|
|
58354
|
+
}
|
|
58355
|
+
}
|
|
58356
|
+
},
|
|
58357
|
+
"required": false
|
|
58358
|
+
},
|
|
57340
58359
|
"responses": {
|
|
57341
58360
|
"200": {
|
|
57342
58361
|
"content": {
|
|
57343
58362
|
"application/json": {
|
|
57344
58363
|
"schema": {
|
|
57345
|
-
"$ref": "#/components/schemas/
|
|
58364
|
+
"$ref": "#/components/schemas/CrmImportUndo"
|
|
57346
58365
|
}
|
|
57347
58366
|
}
|
|
57348
58367
|
},
|
|
57349
|
-
"description": "
|
|
58368
|
+
"description": "What was (or, on a dry run, would be) removed and kept."
|
|
57350
58369
|
},
|
|
57351
58370
|
"400": {
|
|
57352
58371
|
"content": {
|
|
@@ -57409,33 +58428,538 @@
|
|
|
57409
58428
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
57410
58429
|
}
|
|
57411
58430
|
},
|
|
57412
|
-
"summary": "
|
|
58431
|
+
"summary": "Undo an import run (removes untouched records it created)",
|
|
57413
58432
|
"tags": [
|
|
57414
58433
|
"CRM"
|
|
57415
58434
|
]
|
|
57416
|
-
}
|
|
57417
|
-
|
|
57418
|
-
|
|
57419
|
-
|
|
57420
|
-
|
|
57421
|
-
|
|
57422
|
-
|
|
57423
|
-
"
|
|
57424
|
-
|
|
57425
|
-
|
|
58435
|
+
}
|
|
58436
|
+
},
|
|
58437
|
+
"/v1/crm/lender-channels": {
|
|
58438
|
+
"post": {
|
|
58439
|
+
"operationId": "crmLenderChannels",
|
|
58440
|
+
"requestBody": {
|
|
58441
|
+
"content": {
|
|
58442
|
+
"application/json": {
|
|
58443
|
+
"schema": {
|
|
58444
|
+
"properties": {
|
|
58445
|
+
"loNmlsIds": {
|
|
58446
|
+
"description": "Bare LO NMLS ids (deduped, capped at 500).",
|
|
58447
|
+
"items": {
|
|
58448
|
+
"type": "string"
|
|
58449
|
+
},
|
|
58450
|
+
"type": "array"
|
|
58451
|
+
}
|
|
58452
|
+
},
|
|
58453
|
+
"required": [
|
|
58454
|
+
"loNmlsIds"
|
|
58455
|
+
],
|
|
58456
|
+
"type": "object"
|
|
58457
|
+
}
|
|
57426
58458
|
}
|
|
57427
58459
|
}
|
|
57428
|
-
|
|
58460
|
+
},
|
|
57429
58461
|
"responses": {
|
|
57430
58462
|
"200": {
|
|
57431
58463
|
"content": {
|
|
57432
58464
|
"application/json": {
|
|
57433
58465
|
"schema": {
|
|
57434
|
-
"$ref": "#/components/schemas/
|
|
58466
|
+
"$ref": "#/components/schemas/CrmLenderChannels"
|
|
57435
58467
|
}
|
|
57436
58468
|
}
|
|
57437
58469
|
},
|
|
57438
|
-
"description": "
|
|
58470
|
+
"description": "Per-LO current sponsor company + classified lender channel."
|
|
58471
|
+
},
|
|
58472
|
+
"400": {
|
|
58473
|
+
"content": {
|
|
58474
|
+
"application/json": {
|
|
58475
|
+
"schema": {
|
|
58476
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58477
|
+
}
|
|
58478
|
+
}
|
|
58479
|
+
},
|
|
58480
|
+
"description": "Validation error"
|
|
58481
|
+
},
|
|
58482
|
+
"401": {
|
|
58483
|
+
"content": {
|
|
58484
|
+
"application/json": {
|
|
58485
|
+
"schema": {
|
|
58486
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58487
|
+
}
|
|
58488
|
+
}
|
|
58489
|
+
},
|
|
58490
|
+
"description": "Unauthorized"
|
|
58491
|
+
},
|
|
58492
|
+
"403": {
|
|
58493
|
+
"content": {
|
|
58494
|
+
"application/json": {
|
|
58495
|
+
"schema": {
|
|
58496
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58497
|
+
}
|
|
58498
|
+
}
|
|
58499
|
+
},
|
|
58500
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
58501
|
+
},
|
|
58502
|
+
"404": {
|
|
58503
|
+
"content": {
|
|
58504
|
+
"application/json": {
|
|
58505
|
+
"schema": {
|
|
58506
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58507
|
+
}
|
|
58508
|
+
}
|
|
58509
|
+
},
|
|
58510
|
+
"description": "Not found"
|
|
58511
|
+
},
|
|
58512
|
+
"413": {
|
|
58513
|
+
"content": {
|
|
58514
|
+
"application/json": {
|
|
58515
|
+
"schema": {
|
|
58516
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
58517
|
+
}
|
|
58518
|
+
}
|
|
58519
|
+
},
|
|
58520
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
58521
|
+
},
|
|
58522
|
+
"503": {
|
|
58523
|
+
"content": {
|
|
58524
|
+
"application/json": {
|
|
58525
|
+
"schema": {
|
|
58526
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
58527
|
+
}
|
|
58528
|
+
}
|
|
58529
|
+
},
|
|
58530
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
58531
|
+
}
|
|
58532
|
+
},
|
|
58533
|
+
"summary": "Bank / Credit Union / Broker / Retail channel per LO (by NMLS)",
|
|
58534
|
+
"tags": [
|
|
58535
|
+
"CRM"
|
|
58536
|
+
]
|
|
58537
|
+
}
|
|
58538
|
+
},
|
|
58539
|
+
"/v1/crm/lists": {
|
|
58540
|
+
"get": {
|
|
58541
|
+
"operationId": "listCrmLists",
|
|
58542
|
+
"parameters": [
|
|
58543
|
+
{
|
|
58544
|
+
"in": "query",
|
|
58545
|
+
"name": "objectType",
|
|
58546
|
+
"required": false,
|
|
58547
|
+
"schema": {
|
|
58548
|
+
"$ref": "#/components/schemas/CrmObjectType"
|
|
58549
|
+
}
|
|
58550
|
+
},
|
|
58551
|
+
{
|
|
58552
|
+
"in": "query",
|
|
58553
|
+
"name": "entityId",
|
|
58554
|
+
"required": false,
|
|
58555
|
+
"schema": {
|
|
58556
|
+
"minLength": 1,
|
|
58557
|
+
"type": "string"
|
|
58558
|
+
}
|
|
58559
|
+
},
|
|
58560
|
+
{
|
|
58561
|
+
"in": "query",
|
|
58562
|
+
"name": "scope",
|
|
58563
|
+
"required": false,
|
|
58564
|
+
"schema": {
|
|
58565
|
+
"enum": [
|
|
58566
|
+
"visible",
|
|
58567
|
+
"all"
|
|
58568
|
+
],
|
|
58569
|
+
"type": "string"
|
|
58570
|
+
}
|
|
58571
|
+
}
|
|
58572
|
+
],
|
|
58573
|
+
"responses": {
|
|
58574
|
+
"200": {
|
|
58575
|
+
"content": {
|
|
58576
|
+
"application/json": {
|
|
58577
|
+
"schema": {
|
|
58578
|
+
"$ref": "#/components/schemas/CrmListArray"
|
|
58579
|
+
}
|
|
58580
|
+
}
|
|
58581
|
+
},
|
|
58582
|
+
"description": "Visible lists (own + org-wide + shared-with-me); scope=all returns every workspace list for admins."
|
|
58583
|
+
},
|
|
58584
|
+
"400": {
|
|
58585
|
+
"content": {
|
|
58586
|
+
"application/json": {
|
|
58587
|
+
"schema": {
|
|
58588
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58589
|
+
}
|
|
58590
|
+
}
|
|
58591
|
+
},
|
|
58592
|
+
"description": "Validation error"
|
|
58593
|
+
},
|
|
58594
|
+
"401": {
|
|
58595
|
+
"content": {
|
|
58596
|
+
"application/json": {
|
|
58597
|
+
"schema": {
|
|
58598
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58599
|
+
}
|
|
58600
|
+
}
|
|
58601
|
+
},
|
|
58602
|
+
"description": "Unauthorized"
|
|
58603
|
+
},
|
|
58604
|
+
"403": {
|
|
58605
|
+
"content": {
|
|
58606
|
+
"application/json": {
|
|
58607
|
+
"schema": {
|
|
58608
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58609
|
+
}
|
|
58610
|
+
}
|
|
58611
|
+
},
|
|
58612
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
58613
|
+
},
|
|
58614
|
+
"404": {
|
|
58615
|
+
"content": {
|
|
58616
|
+
"application/json": {
|
|
58617
|
+
"schema": {
|
|
58618
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58619
|
+
}
|
|
58620
|
+
}
|
|
58621
|
+
},
|
|
58622
|
+
"description": "Not found"
|
|
58623
|
+
},
|
|
58624
|
+
"413": {
|
|
58625
|
+
"content": {
|
|
58626
|
+
"application/json": {
|
|
58627
|
+
"schema": {
|
|
58628
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
58629
|
+
}
|
|
58630
|
+
}
|
|
58631
|
+
},
|
|
58632
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
58633
|
+
},
|
|
58634
|
+
"503": {
|
|
58635
|
+
"content": {
|
|
58636
|
+
"application/json": {
|
|
58637
|
+
"schema": {
|
|
58638
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
58639
|
+
}
|
|
58640
|
+
}
|
|
58641
|
+
},
|
|
58642
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
58643
|
+
}
|
|
58644
|
+
},
|
|
58645
|
+
"summary": "List the caller's lists (picker mode with ?entityId adds hasMember)",
|
|
58646
|
+
"tags": [
|
|
58647
|
+
"CRM"
|
|
58648
|
+
]
|
|
58649
|
+
},
|
|
58650
|
+
"post": {
|
|
58651
|
+
"operationId": "createCrmList",
|
|
58652
|
+
"requestBody": {
|
|
58653
|
+
"content": {
|
|
58654
|
+
"application/json": {
|
|
58655
|
+
"schema": {
|
|
58656
|
+
"properties": {
|
|
58657
|
+
"name": {
|
|
58658
|
+
"type": "string"
|
|
58659
|
+
},
|
|
58660
|
+
"objectType": {
|
|
58661
|
+
"$ref": "#/components/schemas/CrmObjectType"
|
|
58662
|
+
}
|
|
58663
|
+
},
|
|
58664
|
+
"required": [
|
|
58665
|
+
"name",
|
|
58666
|
+
"objectType"
|
|
58667
|
+
],
|
|
58668
|
+
"type": "object"
|
|
58669
|
+
}
|
|
58670
|
+
}
|
|
58671
|
+
}
|
|
58672
|
+
},
|
|
58673
|
+
"responses": {
|
|
58674
|
+
"200": {
|
|
58675
|
+
"content": {
|
|
58676
|
+
"application/json": {
|
|
58677
|
+
"schema": {
|
|
58678
|
+
"$ref": "#/components/schemas/CrmListCreateResult"
|
|
58679
|
+
}
|
|
58680
|
+
}
|
|
58681
|
+
},
|
|
58682
|
+
"description": "The created list."
|
|
58683
|
+
},
|
|
58684
|
+
"400": {
|
|
58685
|
+
"content": {
|
|
58686
|
+
"application/json": {
|
|
58687
|
+
"schema": {
|
|
58688
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58689
|
+
}
|
|
58690
|
+
}
|
|
58691
|
+
},
|
|
58692
|
+
"description": "Validation error"
|
|
58693
|
+
},
|
|
58694
|
+
"401": {
|
|
58695
|
+
"content": {
|
|
58696
|
+
"application/json": {
|
|
58697
|
+
"schema": {
|
|
58698
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58699
|
+
}
|
|
58700
|
+
}
|
|
58701
|
+
},
|
|
58702
|
+
"description": "Unauthorized"
|
|
58703
|
+
},
|
|
58704
|
+
"403": {
|
|
58705
|
+
"content": {
|
|
58706
|
+
"application/json": {
|
|
58707
|
+
"schema": {
|
|
58708
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58709
|
+
}
|
|
58710
|
+
}
|
|
58711
|
+
},
|
|
58712
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
58713
|
+
},
|
|
58714
|
+
"404": {
|
|
58715
|
+
"content": {
|
|
58716
|
+
"application/json": {
|
|
58717
|
+
"schema": {
|
|
58718
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58719
|
+
}
|
|
58720
|
+
}
|
|
58721
|
+
},
|
|
58722
|
+
"description": "Not found"
|
|
58723
|
+
},
|
|
58724
|
+
"413": {
|
|
58725
|
+
"content": {
|
|
58726
|
+
"application/json": {
|
|
58727
|
+
"schema": {
|
|
58728
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
58729
|
+
}
|
|
58730
|
+
}
|
|
58731
|
+
},
|
|
58732
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
58733
|
+
},
|
|
58734
|
+
"503": {
|
|
58735
|
+
"content": {
|
|
58736
|
+
"application/json": {
|
|
58737
|
+
"schema": {
|
|
58738
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
58739
|
+
}
|
|
58740
|
+
}
|
|
58741
|
+
},
|
|
58742
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
58743
|
+
}
|
|
58744
|
+
},
|
|
58745
|
+
"summary": "Create a list",
|
|
58746
|
+
"tags": [
|
|
58747
|
+
"CRM"
|
|
58748
|
+
]
|
|
58749
|
+
}
|
|
58750
|
+
},
|
|
58751
|
+
"/v1/crm/lists/memberships": {
|
|
58752
|
+
"get": {
|
|
58753
|
+
"operationId": "listCrmListMemberships",
|
|
58754
|
+
"parameters": [
|
|
58755
|
+
{
|
|
58756
|
+
"in": "query",
|
|
58757
|
+
"name": "objectType",
|
|
58758
|
+
"required": false,
|
|
58759
|
+
"schema": {
|
|
58760
|
+
"$ref": "#/components/schemas/CrmObjectType"
|
|
58761
|
+
}
|
|
58762
|
+
},
|
|
58763
|
+
{
|
|
58764
|
+
"in": "query",
|
|
58765
|
+
"name": "entityIds",
|
|
58766
|
+
"required": true,
|
|
58767
|
+
"schema": {
|
|
58768
|
+
"minLength": 1,
|
|
58769
|
+
"type": "string"
|
|
58770
|
+
}
|
|
58771
|
+
}
|
|
58772
|
+
],
|
|
58773
|
+
"responses": {
|
|
58774
|
+
"200": {
|
|
58775
|
+
"content": {
|
|
58776
|
+
"application/json": {
|
|
58777
|
+
"schema": {
|
|
58778
|
+
"$ref": "#/components/schemas/CrmListMembershipsResult"
|
|
58779
|
+
}
|
|
58780
|
+
}
|
|
58781
|
+
},
|
|
58782
|
+
"description": "Each requested entityId mapped to the visible lists it's on ([] = none)."
|
|
58783
|
+
},
|
|
58784
|
+
"400": {
|
|
58785
|
+
"content": {
|
|
58786
|
+
"application/json": {
|
|
58787
|
+
"schema": {
|
|
58788
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58789
|
+
}
|
|
58790
|
+
}
|
|
58791
|
+
},
|
|
58792
|
+
"description": "Validation error"
|
|
58793
|
+
},
|
|
58794
|
+
"401": {
|
|
58795
|
+
"content": {
|
|
58796
|
+
"application/json": {
|
|
58797
|
+
"schema": {
|
|
58798
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58799
|
+
}
|
|
58800
|
+
}
|
|
58801
|
+
},
|
|
58802
|
+
"description": "Unauthorized"
|
|
58803
|
+
},
|
|
58804
|
+
"403": {
|
|
58805
|
+
"content": {
|
|
58806
|
+
"application/json": {
|
|
58807
|
+
"schema": {
|
|
58808
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58809
|
+
}
|
|
58810
|
+
}
|
|
58811
|
+
},
|
|
58812
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
58813
|
+
},
|
|
58814
|
+
"404": {
|
|
58815
|
+
"content": {
|
|
58816
|
+
"application/json": {
|
|
58817
|
+
"schema": {
|
|
58818
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58819
|
+
}
|
|
58820
|
+
}
|
|
58821
|
+
},
|
|
58822
|
+
"description": "Not found"
|
|
58823
|
+
},
|
|
58824
|
+
"413": {
|
|
58825
|
+
"content": {
|
|
58826
|
+
"application/json": {
|
|
58827
|
+
"schema": {
|
|
58828
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
58829
|
+
}
|
|
58830
|
+
}
|
|
58831
|
+
},
|
|
58832
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
58833
|
+
},
|
|
58834
|
+
"503": {
|
|
58835
|
+
"content": {
|
|
58836
|
+
"application/json": {
|
|
58837
|
+
"schema": {
|
|
58838
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
58839
|
+
}
|
|
58840
|
+
}
|
|
58841
|
+
},
|
|
58842
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
58843
|
+
}
|
|
58844
|
+
},
|
|
58845
|
+
"summary": "Batched list-membership lookup for many entities",
|
|
58846
|
+
"tags": [
|
|
58847
|
+
"CRM"
|
|
58848
|
+
]
|
|
58849
|
+
}
|
|
58850
|
+
},
|
|
58851
|
+
"/v1/crm/lists/{id}": {
|
|
58852
|
+
"delete": {
|
|
58853
|
+
"operationId": "deleteCrmList",
|
|
58854
|
+
"parameters": [
|
|
58855
|
+
{
|
|
58856
|
+
"in": "path",
|
|
58857
|
+
"name": "id",
|
|
58858
|
+
"required": true,
|
|
58859
|
+
"schema": {
|
|
58860
|
+
"type": "string"
|
|
58861
|
+
}
|
|
58862
|
+
}
|
|
58863
|
+
],
|
|
58864
|
+
"responses": {
|
|
58865
|
+
"200": {
|
|
58866
|
+
"content": {
|
|
58867
|
+
"application/json": {
|
|
58868
|
+
"schema": {
|
|
58869
|
+
"$ref": "#/components/schemas/CrmListDeleteResult"
|
|
58870
|
+
}
|
|
58871
|
+
}
|
|
58872
|
+
},
|
|
58873
|
+
"description": "Deleted (soft)."
|
|
58874
|
+
},
|
|
58875
|
+
"400": {
|
|
58876
|
+
"content": {
|
|
58877
|
+
"application/json": {
|
|
58878
|
+
"schema": {
|
|
58879
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58880
|
+
}
|
|
58881
|
+
}
|
|
58882
|
+
},
|
|
58883
|
+
"description": "Validation error"
|
|
58884
|
+
},
|
|
58885
|
+
"401": {
|
|
58886
|
+
"content": {
|
|
58887
|
+
"application/json": {
|
|
58888
|
+
"schema": {
|
|
58889
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58890
|
+
}
|
|
58891
|
+
}
|
|
58892
|
+
},
|
|
58893
|
+
"description": "Unauthorized"
|
|
58894
|
+
},
|
|
58895
|
+
"403": {
|
|
58896
|
+
"content": {
|
|
58897
|
+
"application/json": {
|
|
58898
|
+
"schema": {
|
|
58899
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58900
|
+
}
|
|
58901
|
+
}
|
|
58902
|
+
},
|
|
58903
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
58904
|
+
},
|
|
58905
|
+
"404": {
|
|
58906
|
+
"content": {
|
|
58907
|
+
"application/json": {
|
|
58908
|
+
"schema": {
|
|
58909
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
58910
|
+
}
|
|
58911
|
+
}
|
|
58912
|
+
},
|
|
58913
|
+
"description": "Not found"
|
|
58914
|
+
},
|
|
58915
|
+
"413": {
|
|
58916
|
+
"content": {
|
|
58917
|
+
"application/json": {
|
|
58918
|
+
"schema": {
|
|
58919
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
58920
|
+
}
|
|
58921
|
+
}
|
|
58922
|
+
},
|
|
58923
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
58924
|
+
},
|
|
58925
|
+
"503": {
|
|
58926
|
+
"content": {
|
|
58927
|
+
"application/json": {
|
|
58928
|
+
"schema": {
|
|
58929
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
58930
|
+
}
|
|
58931
|
+
}
|
|
58932
|
+
},
|
|
58933
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
58934
|
+
}
|
|
58935
|
+
},
|
|
58936
|
+
"summary": "Delete a list",
|
|
58937
|
+
"tags": [
|
|
58938
|
+
"CRM"
|
|
58939
|
+
]
|
|
58940
|
+
},
|
|
58941
|
+
"get": {
|
|
58942
|
+
"operationId": "getCrmList",
|
|
58943
|
+
"parameters": [
|
|
58944
|
+
{
|
|
58945
|
+
"in": "path",
|
|
58946
|
+
"name": "id",
|
|
58947
|
+
"required": true,
|
|
58948
|
+
"schema": {
|
|
58949
|
+
"type": "string"
|
|
58950
|
+
}
|
|
58951
|
+
}
|
|
58952
|
+
],
|
|
58953
|
+
"responses": {
|
|
58954
|
+
"200": {
|
|
58955
|
+
"content": {
|
|
58956
|
+
"application/json": {
|
|
58957
|
+
"schema": {
|
|
58958
|
+
"$ref": "#/components/schemas/CrmListWithMembers"
|
|
58959
|
+
}
|
|
58960
|
+
}
|
|
58961
|
+
},
|
|
58962
|
+
"description": "The list + members, or null when not found / not visible."
|
|
57439
58963
|
},
|
|
57440
58964
|
"400": {
|
|
57441
58965
|
"content": {
|
|
@@ -77227,21 +78751,527 @@
|
|
|
77227
78751
|
"content": {
|
|
77228
78752
|
"application/json": {
|
|
77229
78753
|
"schema": {
|
|
77230
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
78754
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
78755
|
+
}
|
|
78756
|
+
}
|
|
78757
|
+
},
|
|
78758
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
78759
|
+
},
|
|
78760
|
+
"404": {
|
|
78761
|
+
"content": {
|
|
78762
|
+
"application/json": {
|
|
78763
|
+
"schema": {
|
|
78764
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
78765
|
+
}
|
|
78766
|
+
}
|
|
78767
|
+
},
|
|
78768
|
+
"description": "Not found"
|
|
78769
|
+
},
|
|
78770
|
+
"413": {
|
|
78771
|
+
"content": {
|
|
78772
|
+
"application/json": {
|
|
78773
|
+
"schema": {
|
|
78774
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
78775
|
+
}
|
|
78776
|
+
}
|
|
78777
|
+
},
|
|
78778
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
78779
|
+
},
|
|
78780
|
+
"503": {
|
|
78781
|
+
"content": {
|
|
78782
|
+
"application/json": {
|
|
78783
|
+
"schema": {
|
|
78784
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
78785
|
+
}
|
|
78786
|
+
}
|
|
78787
|
+
},
|
|
78788
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
78789
|
+
}
|
|
78790
|
+
},
|
|
78791
|
+
"summary": "Count sales matching filters",
|
|
78792
|
+
"tags": [
|
|
78793
|
+
"Sales"
|
|
78794
|
+
],
|
|
78795
|
+
"x-mm-records-via": "listSales"
|
|
78796
|
+
}
|
|
78797
|
+
},
|
|
78798
|
+
"/v1/sales/{id}": {
|
|
78799
|
+
"get": {
|
|
78800
|
+
"operationId": "getSale",
|
|
78801
|
+
"parameters": [
|
|
78802
|
+
{
|
|
78803
|
+
"description": "Sale document ID",
|
|
78804
|
+
"in": "path",
|
|
78805
|
+
"name": "id",
|
|
78806
|
+
"required": true,
|
|
78807
|
+
"schema": {
|
|
78808
|
+
"description": "Sale document ID",
|
|
78809
|
+
"type": "string"
|
|
78810
|
+
}
|
|
78811
|
+
}
|
|
78812
|
+
],
|
|
78813
|
+
"responses": {
|
|
78814
|
+
"200": {
|
|
78815
|
+
"content": {
|
|
78816
|
+
"application/json": {
|
|
78817
|
+
"schema": {
|
|
78818
|
+
"$ref": "#/components/schemas/SaleDetailResponse"
|
|
78819
|
+
}
|
|
78820
|
+
}
|
|
78821
|
+
},
|
|
78822
|
+
"description": "Sale detail"
|
|
78823
|
+
},
|
|
78824
|
+
"404": {
|
|
78825
|
+
"content": {
|
|
78826
|
+
"application/json": {
|
|
78827
|
+
"schema": {
|
|
78828
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
78829
|
+
}
|
|
78830
|
+
}
|
|
78831
|
+
},
|
|
78832
|
+
"description": "Sale not found"
|
|
78833
|
+
},
|
|
78834
|
+
"413": {
|
|
78835
|
+
"content": {
|
|
78836
|
+
"application/json": {
|
|
78837
|
+
"schema": {
|
|
78838
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
78839
|
+
}
|
|
78840
|
+
}
|
|
78841
|
+
},
|
|
78842
|
+
"description": "Response payload too large"
|
|
78843
|
+
}
|
|
78844
|
+
},
|
|
78845
|
+
"summary": "Get sale by ID",
|
|
78846
|
+
"tags": [
|
|
78847
|
+
"Sales"
|
|
78848
|
+
]
|
|
78849
|
+
}
|
|
78850
|
+
},
|
|
78851
|
+
"/v1/sales/{id}/related": {
|
|
78852
|
+
"get": {
|
|
78853
|
+
"description": "Return the ids of records of another type that are linked to this record. Links resolve by identifier, strongest identifier first, and equally-trusted identifiers are combined — a company's linked loans cover every role it holds on a loan, not just the first one found. The response reports which strength was used: `primary` is the canonical identifier for that pair, `secondary` is a real but weaker alternate used only when the record carries nothing better. This is a lightweight index: it returns ids and a count, not full records. For filtering, sorting, pagination and full detail, use the named endpoint for the pair (for example the originator loans endpoint) and fetch records by id.",
|
|
78854
|
+
"operationId": "saleRelated",
|
|
78855
|
+
"parameters": [
|
|
78856
|
+
{
|
|
78857
|
+
"description": "Sale id",
|
|
78858
|
+
"in": "path",
|
|
78859
|
+
"name": "id",
|
|
78860
|
+
"required": true,
|
|
78861
|
+
"schema": {
|
|
78862
|
+
"description": "Sale id",
|
|
78863
|
+
"type": "string"
|
|
78864
|
+
}
|
|
78865
|
+
},
|
|
78866
|
+
{
|
|
78867
|
+
"description": "Type of record to link to",
|
|
78868
|
+
"in": "query",
|
|
78869
|
+
"name": "to",
|
|
78870
|
+
"required": true,
|
|
78871
|
+
"schema": {
|
|
78872
|
+
"description": "Type of record to link to",
|
|
78873
|
+
"enum": [
|
|
78874
|
+
"agents",
|
|
78875
|
+
"loans",
|
|
78876
|
+
"properties"
|
|
78877
|
+
],
|
|
78878
|
+
"type": "string"
|
|
78879
|
+
}
|
|
78880
|
+
},
|
|
78881
|
+
{
|
|
78882
|
+
"description": "Maximum ids to return (default 25, max 200)",
|
|
78883
|
+
"in": "query",
|
|
78884
|
+
"name": "limit",
|
|
78885
|
+
"required": false,
|
|
78886
|
+
"schema": {
|
|
78887
|
+
"description": "Maximum ids to return (default 25, max 200)",
|
|
78888
|
+
"maximum": 200,
|
|
78889
|
+
"minimum": 1,
|
|
78890
|
+
"type": "integer"
|
|
78891
|
+
}
|
|
78892
|
+
}
|
|
78893
|
+
],
|
|
78894
|
+
"responses": {
|
|
78895
|
+
"200": {
|
|
78896
|
+
"content": {
|
|
78897
|
+
"application/json": {
|
|
78898
|
+
"schema": {
|
|
78899
|
+
"$ref": "#/components/schemas/RelatedResponse"
|
|
78900
|
+
}
|
|
78901
|
+
}
|
|
78902
|
+
},
|
|
78903
|
+
"description": "Linked record ids"
|
|
78904
|
+
},
|
|
78905
|
+
"400": {
|
|
78906
|
+
"content": {
|
|
78907
|
+
"application/json": {
|
|
78908
|
+
"schema": {
|
|
78909
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
78910
|
+
}
|
|
78911
|
+
}
|
|
78912
|
+
},
|
|
78913
|
+
"description": "Validation error"
|
|
78914
|
+
},
|
|
78915
|
+
"401": {
|
|
78916
|
+
"content": {
|
|
78917
|
+
"application/json": {
|
|
78918
|
+
"schema": {
|
|
78919
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
78920
|
+
}
|
|
78921
|
+
}
|
|
78922
|
+
},
|
|
78923
|
+
"description": "Unauthorized"
|
|
78924
|
+
},
|
|
78925
|
+
"403": {
|
|
78926
|
+
"content": {
|
|
78927
|
+
"application/json": {
|
|
78928
|
+
"schema": {
|
|
78929
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
78930
|
+
}
|
|
78931
|
+
}
|
|
78932
|
+
},
|
|
78933
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
78934
|
+
},
|
|
78935
|
+
"404": {
|
|
78936
|
+
"content": {
|
|
78937
|
+
"application/json": {
|
|
78938
|
+
"schema": {
|
|
78939
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
78940
|
+
}
|
|
78941
|
+
}
|
|
78942
|
+
},
|
|
78943
|
+
"description": "Record not found"
|
|
78944
|
+
},
|
|
78945
|
+
"413": {
|
|
78946
|
+
"content": {
|
|
78947
|
+
"application/json": {
|
|
78948
|
+
"schema": {
|
|
78949
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
78950
|
+
}
|
|
78951
|
+
}
|
|
78952
|
+
},
|
|
78953
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
78954
|
+
},
|
|
78955
|
+
"503": {
|
|
78956
|
+
"content": {
|
|
78957
|
+
"application/json": {
|
|
78958
|
+
"schema": {
|
|
78959
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
78960
|
+
}
|
|
78961
|
+
}
|
|
78962
|
+
},
|
|
78963
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
78964
|
+
}
|
|
78965
|
+
},
|
|
78966
|
+
"summary": "Records linked to this one",
|
|
78967
|
+
"tags": [
|
|
78968
|
+
"Related"
|
|
78969
|
+
]
|
|
78970
|
+
}
|
|
78971
|
+
},
|
|
78972
|
+
"/v1/saved-filters": {
|
|
78973
|
+
"get": {
|
|
78974
|
+
"description": "The caller's saved filters (and saved CRM views) in the active organization plus the ones shared with them, oldest first, optionally narrowed by target, kind and ownership. `isOwner` / `permission` / `canEdit` on each row say whose it is and what the caller may do.",
|
|
78975
|
+
"operationId": "listSavedFilters",
|
|
78976
|
+
"parameters": [
|
|
78977
|
+
{
|
|
78978
|
+
"description": "Which list the filter runs against. Market targets run against that entity's list operation (see `operationId`, e.g. listOriginators); `crm_people` / `crm_companies` are UI-only (filtered client-side).",
|
|
78979
|
+
"in": "query",
|
|
78980
|
+
"name": "target",
|
|
78981
|
+
"required": false,
|
|
78982
|
+
"schema": {
|
|
78983
|
+
"description": "Which list the filter runs against. Market targets run against that entity's list operation (see `operationId`, e.g. listOriginators); `crm_people` / `crm_companies` are UI-only (filtered client-side).",
|
|
78984
|
+
"enum": [
|
|
78985
|
+
"originators",
|
|
78986
|
+
"agents",
|
|
78987
|
+
"companies",
|
|
78988
|
+
"branches",
|
|
78989
|
+
"offices",
|
|
78990
|
+
"loans",
|
|
78991
|
+
"properties",
|
|
78992
|
+
"sales",
|
|
78993
|
+
"crm_people",
|
|
78994
|
+
"crm_companies"
|
|
78995
|
+
],
|
|
78996
|
+
"type": "string"
|
|
78997
|
+
}
|
|
78998
|
+
},
|
|
78999
|
+
{
|
|
79000
|
+
"description": "`filter` (default) — a saved search; `view` — a saved CRM table layout (columns / order) kept in `uiState`. Views never carry a `query` and have their own 25-per-target quota. Fixed at create.",
|
|
79001
|
+
"in": "query",
|
|
79002
|
+
"name": "kind",
|
|
79003
|
+
"required": false,
|
|
79004
|
+
"schema": {
|
|
79005
|
+
"description": "`filter` (default) — a saved search; `view` — a saved CRM table layout (columns / order) kept in `uiState`. Views never carry a `query` and have their own 25-per-target quota. Fixed at create.",
|
|
79006
|
+
"enum": [
|
|
79007
|
+
"filter",
|
|
79008
|
+
"view"
|
|
79009
|
+
],
|
|
79010
|
+
"type": "string"
|
|
79011
|
+
}
|
|
79012
|
+
},
|
|
79013
|
+
{
|
|
79014
|
+
"description": "`mine` — only filters you own; `shared` — only filters shared with you. Omit for both.",
|
|
79015
|
+
"in": "query",
|
|
79016
|
+
"name": "ownership",
|
|
79017
|
+
"required": false,
|
|
79018
|
+
"schema": {
|
|
79019
|
+
"description": "`mine` — only filters you own; `shared` — only filters shared with you. Omit for both.",
|
|
79020
|
+
"enum": [
|
|
79021
|
+
"mine",
|
|
79022
|
+
"shared"
|
|
79023
|
+
],
|
|
79024
|
+
"type": "string"
|
|
79025
|
+
}
|
|
79026
|
+
}
|
|
79027
|
+
],
|
|
79028
|
+
"responses": {
|
|
79029
|
+
"200": {
|
|
79030
|
+
"content": {
|
|
79031
|
+
"application/json": {
|
|
79032
|
+
"schema": {
|
|
79033
|
+
"$ref": "#/components/schemas/SavedFilterList"
|
|
79034
|
+
}
|
|
79035
|
+
}
|
|
79036
|
+
},
|
|
79037
|
+
"description": "Saved filters."
|
|
79038
|
+
},
|
|
79039
|
+
"400": {
|
|
79040
|
+
"content": {
|
|
79041
|
+
"application/json": {
|
|
79042
|
+
"schema": {
|
|
79043
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
79044
|
+
}
|
|
79045
|
+
}
|
|
79046
|
+
},
|
|
79047
|
+
"description": "Validation error"
|
|
79048
|
+
},
|
|
79049
|
+
"401": {
|
|
79050
|
+
"content": {
|
|
79051
|
+
"application/json": {
|
|
79052
|
+
"schema": {
|
|
79053
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
79054
|
+
}
|
|
79055
|
+
}
|
|
79056
|
+
},
|
|
79057
|
+
"description": "Unauthorized"
|
|
79058
|
+
},
|
|
79059
|
+
"403": {
|
|
79060
|
+
"content": {
|
|
79061
|
+
"application/json": {
|
|
79062
|
+
"schema": {
|
|
79063
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
79064
|
+
}
|
|
79065
|
+
}
|
|
79066
|
+
},
|
|
79067
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
79068
|
+
},
|
|
79069
|
+
"404": {
|
|
79070
|
+
"content": {
|
|
79071
|
+
"application/json": {
|
|
79072
|
+
"schema": {
|
|
79073
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
79074
|
+
}
|
|
79075
|
+
}
|
|
79076
|
+
},
|
|
79077
|
+
"description": "Not found"
|
|
79078
|
+
},
|
|
79079
|
+
"413": {
|
|
79080
|
+
"content": {
|
|
79081
|
+
"application/json": {
|
|
79082
|
+
"schema": {
|
|
79083
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
79084
|
+
}
|
|
79085
|
+
}
|
|
79086
|
+
},
|
|
79087
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
79088
|
+
},
|
|
79089
|
+
"503": {
|
|
79090
|
+
"content": {
|
|
79091
|
+
"application/json": {
|
|
79092
|
+
"schema": {
|
|
79093
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
79094
|
+
}
|
|
79095
|
+
}
|
|
79096
|
+
},
|
|
79097
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
79098
|
+
}
|
|
79099
|
+
},
|
|
79100
|
+
"summary": "List your saved filters",
|
|
79101
|
+
"tags": [
|
|
79102
|
+
"Saved Filters"
|
|
79103
|
+
]
|
|
79104
|
+
},
|
|
79105
|
+
"post": {
|
|
79106
|
+
"description": "Save a named filter for a list target. For a market target, `query` is the target operation's request body without `pagination` (e.g. the body you would send to listOriginators) and is validated against it. New filters are private. Limit: 25 you own per target (filters shared with you do not count).",
|
|
79107
|
+
"operationId": "createSavedFilter",
|
|
79108
|
+
"requestBody": {
|
|
79109
|
+
"content": {
|
|
79110
|
+
"application/json": {
|
|
79111
|
+
"schema": {
|
|
79112
|
+
"$ref": "#/components/schemas/CreateSavedFilterRequest"
|
|
79113
|
+
}
|
|
79114
|
+
}
|
|
79115
|
+
}
|
|
79116
|
+
},
|
|
79117
|
+
"responses": {
|
|
79118
|
+
"201": {
|
|
79119
|
+
"content": {
|
|
79120
|
+
"application/json": {
|
|
79121
|
+
"schema": {
|
|
79122
|
+
"$ref": "#/components/schemas/CreateSavedFilterResult"
|
|
79123
|
+
}
|
|
79124
|
+
}
|
|
79125
|
+
},
|
|
79126
|
+
"description": "The saved filter."
|
|
79127
|
+
},
|
|
79128
|
+
"400": {
|
|
79129
|
+
"content": {
|
|
79130
|
+
"application/json": {
|
|
79131
|
+
"schema": {
|
|
79132
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
79133
|
+
}
|
|
79134
|
+
}
|
|
79135
|
+
},
|
|
79136
|
+
"description": "Validation error — including a `query` that is not a valid request for the target's operation (`issues` lists each problem)."
|
|
79137
|
+
},
|
|
79138
|
+
"401": {
|
|
79139
|
+
"content": {
|
|
79140
|
+
"application/json": {
|
|
79141
|
+
"schema": {
|
|
79142
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
79143
|
+
}
|
|
79144
|
+
}
|
|
79145
|
+
},
|
|
79146
|
+
"description": "Unauthorized"
|
|
79147
|
+
},
|
|
79148
|
+
"403": {
|
|
79149
|
+
"content": {
|
|
79150
|
+
"application/json": {
|
|
79151
|
+
"schema": {
|
|
79152
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
79153
|
+
}
|
|
79154
|
+
}
|
|
79155
|
+
},
|
|
79156
|
+
"description": "Forbidden (authenticated, but missing required context — e.g. no active organization)"
|
|
79157
|
+
},
|
|
79158
|
+
"404": {
|
|
79159
|
+
"content": {
|
|
79160
|
+
"application/json": {
|
|
79161
|
+
"schema": {
|
|
79162
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
79163
|
+
}
|
|
79164
|
+
}
|
|
79165
|
+
},
|
|
79166
|
+
"description": "Not found"
|
|
79167
|
+
},
|
|
79168
|
+
"409": {
|
|
79169
|
+
"content": {
|
|
79170
|
+
"application/json": {
|
|
79171
|
+
"schema": {
|
|
79172
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
79173
|
+
}
|
|
79174
|
+
}
|
|
79175
|
+
},
|
|
79176
|
+
"description": "`QUOTA_EXCEEDED` — 25 saved filters for this target already; update or delete one."
|
|
79177
|
+
},
|
|
79178
|
+
"413": {
|
|
79179
|
+
"content": {
|
|
79180
|
+
"application/json": {
|
|
79181
|
+
"schema": {
|
|
79182
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
79183
|
+
}
|
|
79184
|
+
}
|
|
79185
|
+
},
|
|
79186
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
79187
|
+
},
|
|
79188
|
+
"503": {
|
|
79189
|
+
"content": {
|
|
79190
|
+
"application/json": {
|
|
79191
|
+
"schema": {
|
|
79192
|
+
"$ref": "#/components/schemas/SearchUnavailable"
|
|
79193
|
+
}
|
|
79194
|
+
}
|
|
79195
|
+
},
|
|
79196
|
+
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
79197
|
+
}
|
|
79198
|
+
},
|
|
79199
|
+
"summary": "Save a filter",
|
|
79200
|
+
"tags": [
|
|
79201
|
+
"Saved Filters"
|
|
79202
|
+
]
|
|
79203
|
+
}
|
|
79204
|
+
},
|
|
79205
|
+
"/v1/saved-filters/{id}": {
|
|
79206
|
+
"delete": {
|
|
79207
|
+
"description": "Owner or workspace admin only; its shares go with it. A filter shared with you cannot be deleted by you.",
|
|
79208
|
+
"operationId": "deleteSavedFilter",
|
|
79209
|
+
"parameters": [
|
|
79210
|
+
{
|
|
79211
|
+
"description": "Saved-filter id (nanoid).",
|
|
79212
|
+
"in": "path",
|
|
79213
|
+
"name": "id",
|
|
79214
|
+
"required": true,
|
|
79215
|
+
"schema": {
|
|
79216
|
+
"description": "Saved-filter id (nanoid).",
|
|
79217
|
+
"example": "V1StGXR8_Z5jdHi6B-myT",
|
|
79218
|
+
"maxLength": 32,
|
|
79219
|
+
"minLength": 1,
|
|
79220
|
+
"pattern": "^[\\w-]+$",
|
|
79221
|
+
"type": "string"
|
|
79222
|
+
}
|
|
79223
|
+
}
|
|
79224
|
+
],
|
|
79225
|
+
"responses": {
|
|
79226
|
+
"200": {
|
|
79227
|
+
"content": {
|
|
79228
|
+
"application/json": {
|
|
79229
|
+
"schema": {
|
|
79230
|
+
"$ref": "#/components/schemas/DeleteSavedFilterResult"
|
|
79231
|
+
}
|
|
79232
|
+
}
|
|
79233
|
+
},
|
|
79234
|
+
"description": "Deleted."
|
|
79235
|
+
},
|
|
79236
|
+
"400": {
|
|
79237
|
+
"content": {
|
|
79238
|
+
"application/json": {
|
|
79239
|
+
"schema": {
|
|
79240
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
79241
|
+
}
|
|
79242
|
+
}
|
|
79243
|
+
},
|
|
79244
|
+
"description": "Validation error"
|
|
79245
|
+
},
|
|
79246
|
+
"401": {
|
|
79247
|
+
"content": {
|
|
79248
|
+
"application/json": {
|
|
79249
|
+
"schema": {
|
|
79250
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
79251
|
+
}
|
|
79252
|
+
}
|
|
79253
|
+
},
|
|
79254
|
+
"description": "Unauthorized"
|
|
79255
|
+
},
|
|
79256
|
+
"403": {
|
|
79257
|
+
"content": {
|
|
79258
|
+
"application/json": {
|
|
79259
|
+
"schema": {
|
|
79260
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
77231
79261
|
}
|
|
77232
79262
|
}
|
|
77233
79263
|
},
|
|
77234
|
-
"description": "
|
|
79264
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
77235
79265
|
},
|
|
77236
79266
|
"404": {
|
|
77237
79267
|
"content": {
|
|
77238
79268
|
"application/json": {
|
|
77239
79269
|
"schema": {
|
|
77240
|
-
"$ref": "#/components/schemas/
|
|
79270
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
77241
79271
|
}
|
|
77242
79272
|
}
|
|
77243
79273
|
},
|
|
77244
|
-
"description": "
|
|
79274
|
+
"description": "No saved filter with that id is visible to the caller (their own, or shared with them)."
|
|
77245
79275
|
},
|
|
77246
79276
|
"413": {
|
|
77247
79277
|
"content": {
|
|
@@ -77264,107 +79294,28 @@
|
|
|
77264
79294
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
77265
79295
|
}
|
|
77266
79296
|
},
|
|
77267
|
-
"summary": "
|
|
77268
|
-
"tags": [
|
|
77269
|
-
"Sales"
|
|
77270
|
-
],
|
|
77271
|
-
"x-mm-records-via": "listSales"
|
|
77272
|
-
}
|
|
77273
|
-
},
|
|
77274
|
-
"/v1/sales/{id}": {
|
|
77275
|
-
"get": {
|
|
77276
|
-
"operationId": "getSale",
|
|
77277
|
-
"parameters": [
|
|
77278
|
-
{
|
|
77279
|
-
"description": "Sale document ID",
|
|
77280
|
-
"in": "path",
|
|
77281
|
-
"name": "id",
|
|
77282
|
-
"required": true,
|
|
77283
|
-
"schema": {
|
|
77284
|
-
"description": "Sale document ID",
|
|
77285
|
-
"type": "string"
|
|
77286
|
-
}
|
|
77287
|
-
}
|
|
77288
|
-
],
|
|
77289
|
-
"responses": {
|
|
77290
|
-
"200": {
|
|
77291
|
-
"content": {
|
|
77292
|
-
"application/json": {
|
|
77293
|
-
"schema": {
|
|
77294
|
-
"$ref": "#/components/schemas/SaleDetailResponse"
|
|
77295
|
-
}
|
|
77296
|
-
}
|
|
77297
|
-
},
|
|
77298
|
-
"description": "Sale detail"
|
|
77299
|
-
},
|
|
77300
|
-
"404": {
|
|
77301
|
-
"content": {
|
|
77302
|
-
"application/json": {
|
|
77303
|
-
"schema": {
|
|
77304
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
77305
|
-
}
|
|
77306
|
-
}
|
|
77307
|
-
},
|
|
77308
|
-
"description": "Sale not found"
|
|
77309
|
-
},
|
|
77310
|
-
"413": {
|
|
77311
|
-
"content": {
|
|
77312
|
-
"application/json": {
|
|
77313
|
-
"schema": {
|
|
77314
|
-
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
77315
|
-
}
|
|
77316
|
-
}
|
|
77317
|
-
},
|
|
77318
|
-
"description": "Response payload too large"
|
|
77319
|
-
}
|
|
77320
|
-
},
|
|
77321
|
-
"summary": "Get sale by ID",
|
|
79297
|
+
"summary": "Delete a saved filter",
|
|
77322
79298
|
"tags": [
|
|
77323
|
-
"
|
|
79299
|
+
"Saved Filters"
|
|
77324
79300
|
]
|
|
77325
|
-
}
|
|
77326
|
-
},
|
|
77327
|
-
"/v1/sales/{id}/related": {
|
|
79301
|
+
},
|
|
77328
79302
|
"get": {
|
|
77329
|
-
"description": "
|
|
77330
|
-
"operationId": "
|
|
79303
|
+
"description": "Returns the saved `query` and the `operationId` to run it with — your own filter or one shared with you. Check `fidelity` (`partial` → `unmapped` lists what the query omits; `ui_only` → nothing to run) and `stale` (the query no longer validates) before running.",
|
|
79304
|
+
"operationId": "getSavedFilter",
|
|
77331
79305
|
"parameters": [
|
|
77332
79306
|
{
|
|
77333
|
-
"description": "
|
|
79307
|
+
"description": "Saved-filter id (nanoid).",
|
|
77334
79308
|
"in": "path",
|
|
77335
79309
|
"name": "id",
|
|
77336
79310
|
"required": true,
|
|
77337
79311
|
"schema": {
|
|
77338
|
-
"description": "
|
|
77339
|
-
"
|
|
77340
|
-
|
|
77341
|
-
|
|
77342
|
-
|
|
77343
|
-
"description": "Type of record to link to",
|
|
77344
|
-
"in": "query",
|
|
77345
|
-
"name": "to",
|
|
77346
|
-
"required": true,
|
|
77347
|
-
"schema": {
|
|
77348
|
-
"description": "Type of record to link to",
|
|
77349
|
-
"enum": [
|
|
77350
|
-
"agents",
|
|
77351
|
-
"loans",
|
|
77352
|
-
"properties"
|
|
77353
|
-
],
|
|
79312
|
+
"description": "Saved-filter id (nanoid).",
|
|
79313
|
+
"example": "V1StGXR8_Z5jdHi6B-myT",
|
|
79314
|
+
"maxLength": 32,
|
|
79315
|
+
"minLength": 1,
|
|
79316
|
+
"pattern": "^[\\w-]+$",
|
|
77354
79317
|
"type": "string"
|
|
77355
79318
|
}
|
|
77356
|
-
},
|
|
77357
|
-
{
|
|
77358
|
-
"description": "Maximum ids to return (default 25, max 200)",
|
|
77359
|
-
"in": "query",
|
|
77360
|
-
"name": "limit",
|
|
77361
|
-
"required": false,
|
|
77362
|
-
"schema": {
|
|
77363
|
-
"description": "Maximum ids to return (default 25, max 200)",
|
|
77364
|
-
"maximum": 200,
|
|
77365
|
-
"minimum": 1,
|
|
77366
|
-
"type": "integer"
|
|
77367
|
-
}
|
|
77368
79319
|
}
|
|
77369
79320
|
],
|
|
77370
79321
|
"responses": {
|
|
@@ -77372,11 +79323,11 @@
|
|
|
77372
79323
|
"content": {
|
|
77373
79324
|
"application/json": {
|
|
77374
79325
|
"schema": {
|
|
77375
|
-
"$ref": "#/components/schemas/
|
|
79326
|
+
"$ref": "#/components/schemas/GetSavedFilterResult"
|
|
77376
79327
|
}
|
|
77377
79328
|
}
|
|
77378
79329
|
},
|
|
77379
|
-
"description": "
|
|
79330
|
+
"description": "The saved filter."
|
|
77380
79331
|
},
|
|
77381
79332
|
"400": {
|
|
77382
79333
|
"content": {
|
|
@@ -77412,11 +79363,11 @@
|
|
|
77412
79363
|
"content": {
|
|
77413
79364
|
"application/json": {
|
|
77414
79365
|
"schema": {
|
|
77415
|
-
"$ref": "#/components/schemas/
|
|
79366
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
77416
79367
|
}
|
|
77417
79368
|
}
|
|
77418
79369
|
},
|
|
77419
|
-
"description": "
|
|
79370
|
+
"description": "No saved filter with that id is visible to the caller (their own, or shared with them)."
|
|
77420
79371
|
},
|
|
77421
79372
|
"413": {
|
|
77422
79373
|
"content": {
|
|
@@ -77439,74 +79390,59 @@
|
|
|
77439
79390
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
77440
79391
|
}
|
|
77441
79392
|
},
|
|
77442
|
-
"summary": "
|
|
79393
|
+
"summary": "Get a saved filter (with the operation to run it)",
|
|
77443
79394
|
"tags": [
|
|
77444
|
-
"
|
|
79395
|
+
"Saved Filters"
|
|
77445
79396
|
]
|
|
77446
|
-
}
|
|
77447
|
-
|
|
77448
|
-
|
|
77449
|
-
|
|
77450
|
-
"description": "The caller's saved filters (and saved CRM views) in the active organization, oldest first, optionally narrowed by target and kind.",
|
|
77451
|
-
"operationId": "listSavedFilters",
|
|
79397
|
+
},
|
|
79398
|
+
"patch": {
|
|
79399
|
+
"description": "Rename, re-icon, or replace the query / UI state (owner, `editor`, or workspace admin). The target is fixed. A new `query` is validated like on create. `visibility` / `orgWidePermission` change who can see it (owner or workspace admin only).",
|
|
79400
|
+
"operationId": "updateSavedFilter",
|
|
77452
79401
|
"parameters": [
|
|
77453
79402
|
{
|
|
77454
|
-
"description": "
|
|
77455
|
-
"in": "
|
|
77456
|
-
"name": "
|
|
77457
|
-
"required":
|
|
77458
|
-
"schema": {
|
|
77459
|
-
"description": "Which list the filter runs against. Market targets run against that entity's list operation (see `operationId`, e.g. listOriginators); `crm_people` / `crm_companies` are UI-only (filtered client-side).",
|
|
77460
|
-
"enum": [
|
|
77461
|
-
"originators",
|
|
77462
|
-
"agents",
|
|
77463
|
-
"companies",
|
|
77464
|
-
"branches",
|
|
77465
|
-
"offices",
|
|
77466
|
-
"loans",
|
|
77467
|
-
"properties",
|
|
77468
|
-
"sales",
|
|
77469
|
-
"crm_people",
|
|
77470
|
-
"crm_companies"
|
|
77471
|
-
],
|
|
77472
|
-
"type": "string"
|
|
77473
|
-
}
|
|
77474
|
-
},
|
|
77475
|
-
{
|
|
77476
|
-
"description": "`filter` (default) — a saved search; `view` — a saved CRM table layout (columns / order) kept in `uiState`. Views never carry a `query` and have their own 25-per-target quota. Fixed at create.",
|
|
77477
|
-
"in": "query",
|
|
77478
|
-
"name": "kind",
|
|
77479
|
-
"required": false,
|
|
79403
|
+
"description": "Saved-filter id (nanoid).",
|
|
79404
|
+
"in": "path",
|
|
79405
|
+
"name": "id",
|
|
79406
|
+
"required": true,
|
|
77480
79407
|
"schema": {
|
|
77481
|
-
"description": "
|
|
77482
|
-
"
|
|
77483
|
-
|
|
77484
|
-
|
|
77485
|
-
],
|
|
79408
|
+
"description": "Saved-filter id (nanoid).",
|
|
79409
|
+
"example": "V1StGXR8_Z5jdHi6B-myT",
|
|
79410
|
+
"maxLength": 32,
|
|
79411
|
+
"minLength": 1,
|
|
79412
|
+
"pattern": "^[\\w-]+$",
|
|
77486
79413
|
"type": "string"
|
|
77487
79414
|
}
|
|
77488
79415
|
}
|
|
77489
79416
|
],
|
|
79417
|
+
"requestBody": {
|
|
79418
|
+
"content": {
|
|
79419
|
+
"application/json": {
|
|
79420
|
+
"schema": {
|
|
79421
|
+
"$ref": "#/components/schemas/UpdateSavedFilterRequest"
|
|
79422
|
+
}
|
|
79423
|
+
}
|
|
79424
|
+
}
|
|
79425
|
+
},
|
|
77490
79426
|
"responses": {
|
|
77491
79427
|
"200": {
|
|
77492
79428
|
"content": {
|
|
77493
79429
|
"application/json": {
|
|
77494
79430
|
"schema": {
|
|
77495
|
-
"$ref": "#/components/schemas/
|
|
79431
|
+
"$ref": "#/components/schemas/UpdateSavedFilterResult"
|
|
77496
79432
|
}
|
|
77497
79433
|
}
|
|
77498
79434
|
},
|
|
77499
|
-
"description": "
|
|
79435
|
+
"description": "The updated filter."
|
|
77500
79436
|
},
|
|
77501
79437
|
"400": {
|
|
77502
79438
|
"content": {
|
|
77503
79439
|
"application/json": {
|
|
77504
79440
|
"schema": {
|
|
77505
|
-
"$ref": "#/components/schemas/
|
|
79441
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
77506
79442
|
}
|
|
77507
79443
|
}
|
|
77508
79444
|
},
|
|
77509
|
-
"description": "Validation error"
|
|
79445
|
+
"description": "Validation error — including a `query` that is not a valid request for the target's operation (`issues` lists each problem)."
|
|
77510
79446
|
},
|
|
77511
79447
|
"401": {
|
|
77512
79448
|
"content": {
|
|
@@ -77522,21 +79458,21 @@
|
|
|
77522
79458
|
"content": {
|
|
77523
79459
|
"application/json": {
|
|
77524
79460
|
"schema": {
|
|
77525
|
-
"$ref": "#/components/schemas/
|
|
79461
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
77526
79462
|
}
|
|
77527
79463
|
}
|
|
77528
79464
|
},
|
|
77529
|
-
"description": "
|
|
79465
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
77530
79466
|
},
|
|
77531
79467
|
"404": {
|
|
77532
79468
|
"content": {
|
|
77533
79469
|
"application/json": {
|
|
77534
79470
|
"schema": {
|
|
77535
|
-
"$ref": "#/components/schemas/
|
|
79471
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
77536
79472
|
}
|
|
77537
79473
|
}
|
|
77538
79474
|
},
|
|
77539
|
-
"description": "
|
|
79475
|
+
"description": "No saved filter with that id is visible to the caller (their own, or shared with them)."
|
|
77540
79476
|
},
|
|
77541
79477
|
"413": {
|
|
77542
79478
|
"content": {
|
|
@@ -77559,43 +79495,52 @@
|
|
|
77559
79495
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
77560
79496
|
}
|
|
77561
79497
|
},
|
|
77562
|
-
"summary": "
|
|
79498
|
+
"summary": "Update a saved filter",
|
|
77563
79499
|
"tags": [
|
|
77564
79500
|
"Saved Filters"
|
|
77565
79501
|
]
|
|
77566
|
-
}
|
|
77567
|
-
|
|
77568
|
-
|
|
77569
|
-
|
|
77570
|
-
"
|
|
77571
|
-
|
|
77572
|
-
|
|
77573
|
-
|
|
77574
|
-
|
|
77575
|
-
|
|
79502
|
+
}
|
|
79503
|
+
},
|
|
79504
|
+
"/v1/saved-filters/{id}/shareable-members": {
|
|
79505
|
+
"get": {
|
|
79506
|
+
"description": "Owner or workspace admin only. Every member of the workspace, the owner and existing shares included — subtract them for the picker.",
|
|
79507
|
+
"operationId": "listSavedFilterShareableMembers",
|
|
79508
|
+
"parameters": [
|
|
79509
|
+
{
|
|
79510
|
+
"description": "Saved-filter id (nanoid).",
|
|
79511
|
+
"in": "path",
|
|
79512
|
+
"name": "id",
|
|
79513
|
+
"required": true,
|
|
79514
|
+
"schema": {
|
|
79515
|
+
"description": "Saved-filter id (nanoid).",
|
|
79516
|
+
"example": "V1StGXR8_Z5jdHi6B-myT",
|
|
79517
|
+
"maxLength": 32,
|
|
79518
|
+
"minLength": 1,
|
|
79519
|
+
"pattern": "^[\\w-]+$",
|
|
79520
|
+
"type": "string"
|
|
77576
79521
|
}
|
|
77577
79522
|
}
|
|
77578
|
-
|
|
79523
|
+
],
|
|
77579
79524
|
"responses": {
|
|
77580
|
-
"
|
|
79525
|
+
"200": {
|
|
77581
79526
|
"content": {
|
|
77582
79527
|
"application/json": {
|
|
77583
79528
|
"schema": {
|
|
77584
|
-
"$ref": "#/components/schemas/
|
|
79529
|
+
"$ref": "#/components/schemas/SavedFilterShareableMemberList"
|
|
77585
79530
|
}
|
|
77586
79531
|
}
|
|
77587
79532
|
},
|
|
77588
|
-
"description": "The
|
|
79533
|
+
"description": "The workspace roster."
|
|
77589
79534
|
},
|
|
77590
79535
|
"400": {
|
|
77591
79536
|
"content": {
|
|
77592
79537
|
"application/json": {
|
|
77593
79538
|
"schema": {
|
|
77594
|
-
"$ref": "#/components/schemas/
|
|
79539
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
77595
79540
|
}
|
|
77596
79541
|
}
|
|
77597
79542
|
},
|
|
77598
|
-
"description": "Validation error
|
|
79543
|
+
"description": "Validation error"
|
|
77599
79544
|
},
|
|
77600
79545
|
"401": {
|
|
77601
79546
|
"content": {
|
|
@@ -77611,41 +79556,41 @@
|
|
|
77611
79556
|
"content": {
|
|
77612
79557
|
"application/json": {
|
|
77613
79558
|
"schema": {
|
|
77614
|
-
"$ref": "#/components/schemas/
|
|
79559
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
77615
79560
|
}
|
|
77616
79561
|
}
|
|
77617
79562
|
},
|
|
77618
|
-
"description": "
|
|
79563
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
77619
79564
|
},
|
|
77620
79565
|
"404": {
|
|
77621
79566
|
"content": {
|
|
77622
79567
|
"application/json": {
|
|
77623
79568
|
"schema": {
|
|
77624
|
-
"$ref": "#/components/schemas/
|
|
79569
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
77625
79570
|
}
|
|
77626
79571
|
}
|
|
77627
79572
|
},
|
|
77628
|
-
"description": "
|
|
79573
|
+
"description": "No saved filter with that id is visible to the caller (their own, or shared with them)."
|
|
77629
79574
|
},
|
|
77630
|
-
"
|
|
79575
|
+
"413": {
|
|
77631
79576
|
"content": {
|
|
77632
79577
|
"application/json": {
|
|
77633
79578
|
"schema": {
|
|
77634
|
-
"$ref": "#/components/schemas/
|
|
79579
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
77635
79580
|
}
|
|
77636
79581
|
}
|
|
77637
79582
|
},
|
|
77638
|
-
"description": "
|
|
79583
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
77639
79584
|
},
|
|
77640
|
-
"
|
|
79585
|
+
"502": {
|
|
77641
79586
|
"content": {
|
|
77642
79587
|
"application/json": {
|
|
77643
79588
|
"schema": {
|
|
77644
|
-
"$ref": "#/components/schemas/
|
|
79589
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
77645
79590
|
}
|
|
77646
79591
|
}
|
|
77647
79592
|
},
|
|
77648
|
-
"description": "
|
|
79593
|
+
"description": "Workspace members could not be read (auth service unavailable)."
|
|
77649
79594
|
},
|
|
77650
79595
|
"503": {
|
|
77651
79596
|
"content": {
|
|
@@ -77658,15 +79603,16 @@
|
|
|
77658
79603
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
77659
79604
|
}
|
|
77660
79605
|
},
|
|
77661
|
-
"summary": "
|
|
79606
|
+
"summary": "List the workspace members a saved filter can be shared with",
|
|
77662
79607
|
"tags": [
|
|
77663
79608
|
"Saved Filters"
|
|
77664
79609
|
]
|
|
77665
79610
|
}
|
|
77666
79611
|
},
|
|
77667
|
-
"/v1/saved-filters/{id}": {
|
|
79612
|
+
"/v1/saved-filters/{id}/shares": {
|
|
77668
79613
|
"delete": {
|
|
77669
|
-
"
|
|
79614
|
+
"description": "Owner or workspace admin only. Removes that member's share; a no-op (`revoked: false`) when there was none.",
|
|
79615
|
+
"operationId": "revokeSavedFilterAccess",
|
|
77670
79616
|
"parameters": [
|
|
77671
79617
|
{
|
|
77672
79618
|
"description": "Saved-filter id (nanoid).",
|
|
@@ -77683,16 +79629,25 @@
|
|
|
77683
79629
|
}
|
|
77684
79630
|
}
|
|
77685
79631
|
],
|
|
79632
|
+
"requestBody": {
|
|
79633
|
+
"content": {
|
|
79634
|
+
"application/json": {
|
|
79635
|
+
"schema": {
|
|
79636
|
+
"$ref": "#/components/schemas/RevokeSavedFilterAccessRequest"
|
|
79637
|
+
}
|
|
79638
|
+
}
|
|
79639
|
+
}
|
|
79640
|
+
},
|
|
77686
79641
|
"responses": {
|
|
77687
79642
|
"200": {
|
|
77688
79643
|
"content": {
|
|
77689
79644
|
"application/json": {
|
|
77690
79645
|
"schema": {
|
|
77691
|
-
"$ref": "#/components/schemas/
|
|
79646
|
+
"$ref": "#/components/schemas/RevokeSavedFilterAccessResult"
|
|
77692
79647
|
}
|
|
77693
79648
|
}
|
|
77694
79649
|
},
|
|
77695
|
-
"description": "
|
|
79650
|
+
"description": "Whether a share was removed."
|
|
77696
79651
|
},
|
|
77697
79652
|
"400": {
|
|
77698
79653
|
"content": {
|
|
@@ -77718,11 +79673,11 @@
|
|
|
77718
79673
|
"content": {
|
|
77719
79674
|
"application/json": {
|
|
77720
79675
|
"schema": {
|
|
77721
|
-
"$ref": "#/components/schemas/
|
|
79676
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
77722
79677
|
}
|
|
77723
79678
|
}
|
|
77724
79679
|
},
|
|
77725
|
-
"description": "
|
|
79680
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
77726
79681
|
},
|
|
77727
79682
|
"404": {
|
|
77728
79683
|
"content": {
|
|
@@ -77732,7 +79687,7 @@
|
|
|
77732
79687
|
}
|
|
77733
79688
|
}
|
|
77734
79689
|
},
|
|
77735
|
-
"description": "No saved filter with that id
|
|
79690
|
+
"description": "No saved filter with that id is visible to the caller (their own, or shared with them)."
|
|
77736
79691
|
},
|
|
77737
79692
|
"413": {
|
|
77738
79693
|
"content": {
|
|
@@ -77755,14 +79710,14 @@
|
|
|
77755
79710
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
77756
79711
|
}
|
|
77757
79712
|
},
|
|
77758
|
-
"summary": "
|
|
79713
|
+
"summary": "Stop sharing a saved filter with a member",
|
|
77759
79714
|
"tags": [
|
|
77760
79715
|
"Saved Filters"
|
|
77761
79716
|
]
|
|
77762
79717
|
},
|
|
77763
79718
|
"get": {
|
|
77764
|
-
"description": "
|
|
77765
|
-
"operationId": "
|
|
79719
|
+
"description": "Visibility, owner, the workspace-wide role and every per-user share. Readable by the owner, an `editor`, or a workspace admin.",
|
|
79720
|
+
"operationId": "getSavedFilterShares",
|
|
77766
79721
|
"parameters": [
|
|
77767
79722
|
{
|
|
77768
79723
|
"description": "Saved-filter id (nanoid).",
|
|
@@ -77784,11 +79739,11 @@
|
|
|
77784
79739
|
"content": {
|
|
77785
79740
|
"application/json": {
|
|
77786
79741
|
"schema": {
|
|
77787
|
-
"$ref": "#/components/schemas/
|
|
79742
|
+
"$ref": "#/components/schemas/GetSavedFilterSharesResult"
|
|
77788
79743
|
}
|
|
77789
79744
|
}
|
|
77790
79745
|
},
|
|
77791
|
-
"description": "The
|
|
79746
|
+
"description": "The filter's sharing state."
|
|
77792
79747
|
},
|
|
77793
79748
|
"400": {
|
|
77794
79749
|
"content": {
|
|
@@ -77814,11 +79769,11 @@
|
|
|
77814
79769
|
"content": {
|
|
77815
79770
|
"application/json": {
|
|
77816
79771
|
"schema": {
|
|
77817
|
-
"$ref": "#/components/schemas/
|
|
79772
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
77818
79773
|
}
|
|
77819
79774
|
}
|
|
77820
79775
|
},
|
|
77821
|
-
"description": "
|
|
79776
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
77822
79777
|
},
|
|
77823
79778
|
"404": {
|
|
77824
79779
|
"content": {
|
|
@@ -77828,7 +79783,7 @@
|
|
|
77828
79783
|
}
|
|
77829
79784
|
}
|
|
77830
79785
|
},
|
|
77831
|
-
"description": "No saved filter with that id
|
|
79786
|
+
"description": "No saved filter with that id is visible to the caller (their own, or shared with them)."
|
|
77832
79787
|
},
|
|
77833
79788
|
"413": {
|
|
77834
79789
|
"content": {
|
|
@@ -77840,6 +79795,16 @@
|
|
|
77840
79795
|
},
|
|
77841
79796
|
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
77842
79797
|
},
|
|
79798
|
+
"502": {
|
|
79799
|
+
"content": {
|
|
79800
|
+
"application/json": {
|
|
79801
|
+
"schema": {
|
|
79802
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
79803
|
+
}
|
|
79804
|
+
}
|
|
79805
|
+
},
|
|
79806
|
+
"description": "Workspace members could not be read (auth service unavailable)."
|
|
79807
|
+
},
|
|
77843
79808
|
"503": {
|
|
77844
79809
|
"content": {
|
|
77845
79810
|
"application/json": {
|
|
@@ -77851,14 +79816,14 @@
|
|
|
77851
79816
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
77852
79817
|
}
|
|
77853
79818
|
},
|
|
77854
|
-
"summary": "Get a saved filter
|
|
79819
|
+
"summary": "Get who a saved filter is shared with",
|
|
77855
79820
|
"tags": [
|
|
77856
79821
|
"Saved Filters"
|
|
77857
79822
|
]
|
|
77858
79823
|
},
|
|
77859
|
-
"
|
|
77860
|
-
"description": "
|
|
77861
|
-
"operationId": "
|
|
79824
|
+
"post": {
|
|
79825
|
+
"description": "Owner or workspace admin only. Re-sharing updates the member's role. Sharing a private filter makes it `shared`. Sharing with the owner is a no-op (`granted: false`).",
|
|
79826
|
+
"operationId": "grantSavedFilterAccess",
|
|
77862
79827
|
"parameters": [
|
|
77863
79828
|
{
|
|
77864
79829
|
"description": "Saved-filter id (nanoid).",
|
|
@@ -77879,7 +79844,7 @@
|
|
|
77879
79844
|
"content": {
|
|
77880
79845
|
"application/json": {
|
|
77881
79846
|
"schema": {
|
|
77882
|
-
"$ref": "#/components/schemas/
|
|
79847
|
+
"$ref": "#/components/schemas/GrantSavedFilterAccessRequest"
|
|
77883
79848
|
}
|
|
77884
79849
|
}
|
|
77885
79850
|
}
|
|
@@ -77889,11 +79854,11 @@
|
|
|
77889
79854
|
"content": {
|
|
77890
79855
|
"application/json": {
|
|
77891
79856
|
"schema": {
|
|
77892
|
-
"$ref": "#/components/schemas/
|
|
79857
|
+
"$ref": "#/components/schemas/GrantSavedFilterAccessResult"
|
|
77893
79858
|
}
|
|
77894
79859
|
}
|
|
77895
79860
|
},
|
|
77896
|
-
"description": "
|
|
79861
|
+
"description": "Whether a new share was created (false when an existing one was updated)."
|
|
77897
79862
|
},
|
|
77898
79863
|
"400": {
|
|
77899
79864
|
"content": {
|
|
@@ -77903,7 +79868,7 @@
|
|
|
77903
79868
|
}
|
|
77904
79869
|
}
|
|
77905
79870
|
},
|
|
77906
|
-
"description": "Validation error
|
|
79871
|
+
"description": "Validation error, or (`code: NOT_ORG_MEMBER`) the user is not a member of your workspace."
|
|
77907
79872
|
},
|
|
77908
79873
|
"401": {
|
|
77909
79874
|
"content": {
|
|
@@ -77919,11 +79884,11 @@
|
|
|
77919
79884
|
"content": {
|
|
77920
79885
|
"application/json": {
|
|
77921
79886
|
"schema": {
|
|
77922
|
-
"$ref": "#/components/schemas/
|
|
79887
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
77923
79888
|
}
|
|
77924
79889
|
}
|
|
77925
79890
|
},
|
|
77926
|
-
"description": "
|
|
79891
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
77927
79892
|
},
|
|
77928
79893
|
"404": {
|
|
77929
79894
|
"content": {
|
|
@@ -77933,7 +79898,7 @@
|
|
|
77933
79898
|
}
|
|
77934
79899
|
}
|
|
77935
79900
|
},
|
|
77936
|
-
"description": "No saved filter with that id
|
|
79901
|
+
"description": "No saved filter with that id is visible to the caller (their own, or shared with them)."
|
|
77937
79902
|
},
|
|
77938
79903
|
"413": {
|
|
77939
79904
|
"content": {
|
|
@@ -77945,6 +79910,16 @@
|
|
|
77945
79910
|
},
|
|
77946
79911
|
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
77947
79912
|
},
|
|
79913
|
+
"502": {
|
|
79914
|
+
"content": {
|
|
79915
|
+
"application/json": {
|
|
79916
|
+
"schema": {
|
|
79917
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
79918
|
+
}
|
|
79919
|
+
}
|
|
79920
|
+
},
|
|
79921
|
+
"description": "Workspace members could not be read (auth service unavailable)."
|
|
79922
|
+
},
|
|
77948
79923
|
"503": {
|
|
77949
79924
|
"content": {
|
|
77950
79925
|
"application/json": {
|
|
@@ -77956,7 +79931,7 @@
|
|
|
77956
79931
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
77957
79932
|
}
|
|
77958
79933
|
},
|
|
77959
|
-
"summary": "
|
|
79934
|
+
"summary": "Share a saved filter with a workspace member",
|
|
77960
79935
|
"tags": [
|
|
77961
79936
|
"Saved Filters"
|
|
77962
79937
|
]
|