@model-match/api 3.47.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 +12 -0
- package/dist/{index-BhsKtXOJ.d.mts → index-cCkX3-4W.d.mts} +379 -24
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +1 -1
- package/dist/slim/index.d.mts +32 -6
- package/dist/slim/index.mjs +80 -6
- package/dist/{src-D2hEr2wd.mjs → src-CCp2TVpk.mjs} +86 -4
- package/openapi.json +1077 -263
- 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"
|
|
@@ -25280,6 +25359,59 @@
|
|
|
25280
25359
|
],
|
|
25281
25360
|
"type": "object"
|
|
25282
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
|
+
},
|
|
25283
25415
|
"HeadcountPoint": {
|
|
25284
25416
|
"properties": {
|
|
25285
25417
|
"active": {
|
|
@@ -40590,6 +40722,38 @@
|
|
|
40590
40722
|
],
|
|
40591
40723
|
"type": "object"
|
|
40592
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
|
+
},
|
|
40593
40757
|
"RosterProductionTier": {
|
|
40594
40758
|
"properties": {
|
|
40595
40759
|
"count": {
|
|
@@ -41290,6 +41454,18 @@
|
|
|
41290
41454
|
},
|
|
41291
41455
|
"SavedFilter": {
|
|
41292
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
|
+
},
|
|
41293
41469
|
"createdAt": {
|
|
41294
41470
|
"format": "date-time",
|
|
41295
41471
|
"type": "string"
|
|
@@ -41309,6 +41485,10 @@
|
|
|
41309
41485
|
"id": {
|
|
41310
41486
|
"type": "string"
|
|
41311
41487
|
},
|
|
41488
|
+
"isOwner": {
|
|
41489
|
+
"description": "True for your own filters; false for ones shared with you.",
|
|
41490
|
+
"type": "boolean"
|
|
41491
|
+
},
|
|
41312
41492
|
"kind": {
|
|
41313
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.",
|
|
41314
41494
|
"enum": [
|
|
@@ -41317,6 +41497,12 @@
|
|
|
41317
41497
|
],
|
|
41318
41498
|
"type": "string"
|
|
41319
41499
|
},
|
|
41500
|
+
"lastUsedAt": {
|
|
41501
|
+
"description": "When it was last run; null if never.",
|
|
41502
|
+
"format": "date-time",
|
|
41503
|
+
"nullable": true,
|
|
41504
|
+
"type": "string"
|
|
41505
|
+
},
|
|
41320
41506
|
"name": {
|
|
41321
41507
|
"type": "string"
|
|
41322
41508
|
},
|
|
@@ -41325,6 +41511,24 @@
|
|
|
41325
41511
|
"nullable": true,
|
|
41326
41512
|
"type": "string"
|
|
41327
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
|
+
},
|
|
41328
41532
|
"query": {
|
|
41329
41533
|
"additionalProperties": {
|
|
41330
41534
|
"nullable": true
|
|
@@ -41393,14 +41597,12 @@
|
|
|
41393
41597
|
"format": "date-time",
|
|
41394
41598
|
"type": "string"
|
|
41395
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
|
+
},
|
|
41396
41604
|
"visibility": {
|
|
41397
|
-
"
|
|
41398
|
-
"enum": [
|
|
41399
|
-
"private",
|
|
41400
|
-
"organization",
|
|
41401
|
-
"shared"
|
|
41402
|
-
],
|
|
41403
|
-
"type": "string"
|
|
41605
|
+
"$ref": "#/components/schemas/SavedFilterVisibility"
|
|
41404
41606
|
}
|
|
41405
41607
|
},
|
|
41406
41608
|
"required": [
|
|
@@ -41416,6 +41618,15 @@
|
|
|
41416
41618
|
"fidelity",
|
|
41417
41619
|
"unmapped",
|
|
41418
41620
|
"visibility",
|
|
41621
|
+
"ownerUserId",
|
|
41622
|
+
"ownerName",
|
|
41623
|
+
"isOwner",
|
|
41624
|
+
"permission",
|
|
41625
|
+
"canEdit",
|
|
41626
|
+
"canDelete",
|
|
41627
|
+
"canManageSharing",
|
|
41628
|
+
"useCount",
|
|
41629
|
+
"lastUsedAt",
|
|
41419
41630
|
"operationId",
|
|
41420
41631
|
"stale",
|
|
41421
41632
|
"staleIssues",
|
|
@@ -41427,7 +41638,7 @@
|
|
|
41427
41638
|
"SavedFilterError": {
|
|
41428
41639
|
"properties": {
|
|
41429
41640
|
"code": {
|
|
41430
|
-
"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).",
|
|
41431
41642
|
"type": "string"
|
|
41432
41643
|
},
|
|
41433
41644
|
"error": {
|
|
@@ -41457,91 +41668,223 @@
|
|
|
41457
41668
|
],
|
|
41458
41669
|
"type": "object"
|
|
41459
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
|
+
},
|
|
41460
41681
|
"SavedFilterIcon": {
|
|
41461
|
-
"description": "Optional marker:
|
|
41462
|
-
"
|
|
41463
|
-
|
|
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": {
|
|
41464
41795
|
"properties": {
|
|
41465
|
-
"
|
|
41466
|
-
"
|
|
41467
|
-
|
|
41468
|
-
|
|
41469
|
-
|
|
41470
|
-
"enum": [
|
|
41471
|
-
"color"
|
|
41472
|
-
],
|
|
41473
|
-
"type": "string"
|
|
41796
|
+
"members": {
|
|
41797
|
+
"items": {
|
|
41798
|
+
"$ref": "#/components/schemas/SavedFilterShareableMember"
|
|
41799
|
+
},
|
|
41800
|
+
"type": "array"
|
|
41474
41801
|
}
|
|
41475
41802
|
},
|
|
41476
41803
|
"required": [
|
|
41477
|
-
"
|
|
41478
|
-
"color"
|
|
41804
|
+
"members"
|
|
41479
41805
|
],
|
|
41480
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"
|
|
41481
41819
|
},
|
|
41482
|
-
{
|
|
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": {
|
|
41483
41831
|
"properties": {
|
|
41484
|
-
"
|
|
41485
|
-
"
|
|
41832
|
+
"email": {
|
|
41833
|
+
"nullable": true,
|
|
41486
41834
|
"type": "string"
|
|
41487
41835
|
},
|
|
41488
|
-
"
|
|
41489
|
-
"
|
|
41836
|
+
"image": {
|
|
41837
|
+
"nullable": true,
|
|
41490
41838
|
"type": "string"
|
|
41491
41839
|
},
|
|
41492
|
-
"
|
|
41493
|
-
"
|
|
41494
|
-
"icon"
|
|
41495
|
-
],
|
|
41496
|
-
"type": "string"
|
|
41497
|
-
}
|
|
41498
|
-
},
|
|
41499
|
-
"required": [
|
|
41500
|
-
"type",
|
|
41501
|
-
"icon",
|
|
41502
|
-
"color"
|
|
41503
|
-
],
|
|
41504
|
-
"type": "object"
|
|
41505
|
-
},
|
|
41506
|
-
{
|
|
41507
|
-
"properties": {
|
|
41508
|
-
"emoji": {
|
|
41509
|
-
"maxLength": 16,
|
|
41510
|
-
"minLength": 1,
|
|
41840
|
+
"name": {
|
|
41841
|
+
"nullable": true,
|
|
41511
41842
|
"type": "string"
|
|
41512
41843
|
},
|
|
41513
|
-
"
|
|
41514
|
-
"enum": [
|
|
41515
|
-
"emoji"
|
|
41516
|
-
],
|
|
41844
|
+
"userId": {
|
|
41517
41845
|
"type": "string"
|
|
41518
41846
|
}
|
|
41519
41847
|
},
|
|
41520
41848
|
"required": [
|
|
41521
|
-
"
|
|
41522
|
-
"
|
|
41849
|
+
"userId",
|
|
41850
|
+
"name",
|
|
41851
|
+
"email",
|
|
41852
|
+
"image"
|
|
41523
41853
|
],
|
|
41524
41854
|
"type": "object"
|
|
41525
41855
|
},
|
|
41526
|
-
{
|
|
41527
|
-
"
|
|
41528
|
-
}
|
|
41529
|
-
|
|
41530
|
-
},
|
|
41531
|
-
"SavedFilterList": {
|
|
41532
|
-
"properties": {
|
|
41533
|
-
"data": {
|
|
41856
|
+
"ownerUserId": {
|
|
41857
|
+
"type": "string"
|
|
41858
|
+
},
|
|
41859
|
+
"shares": {
|
|
41534
41860
|
"items": {
|
|
41535
|
-
"$ref": "#/components/schemas/
|
|
41861
|
+
"$ref": "#/components/schemas/SavedFilterShare"
|
|
41536
41862
|
},
|
|
41537
41863
|
"type": "array"
|
|
41864
|
+
},
|
|
41865
|
+
"visibility": {
|
|
41866
|
+
"$ref": "#/components/schemas/SavedFilterVisibility"
|
|
41538
41867
|
}
|
|
41539
41868
|
},
|
|
41540
41869
|
"required": [
|
|
41541
|
-
"
|
|
41870
|
+
"visibility",
|
|
41871
|
+
"ownerUserId",
|
|
41872
|
+
"owner",
|
|
41873
|
+
"canManageSharing",
|
|
41874
|
+
"orgWidePermission",
|
|
41875
|
+
"shares"
|
|
41542
41876
|
],
|
|
41543
41877
|
"type": "object"
|
|
41544
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
|
+
},
|
|
41545
41888
|
"SearchTokenResponse": {
|
|
41546
41889
|
"properties": {
|
|
41547
41890
|
"expiresAt": {
|
|
@@ -42599,6 +42942,16 @@
|
|
|
42599
42942
|
"minLength": 1,
|
|
42600
42943
|
"type": "string"
|
|
42601
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
|
+
},
|
|
42602
42955
|
"query": {
|
|
42603
42956
|
"additionalProperties": {
|
|
42604
42957
|
"nullable": true
|
|
@@ -42628,6 +42981,16 @@
|
|
|
42628
42981
|
},
|
|
42629
42982
|
"maxItems": 100,
|
|
42630
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
|
+
]
|
|
42631
42994
|
}
|
|
42632
42995
|
},
|
|
42633
42996
|
"type": "object"
|
|
@@ -42902,7 +43265,7 @@
|
|
|
42902
43265
|
"info": {
|
|
42903
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.",
|
|
42904
43267
|
"title": "ModelMatch API",
|
|
42905
|
-
"version": "3.
|
|
43268
|
+
"version": "3.109.2"
|
|
42906
43269
|
},
|
|
42907
43270
|
"openapi": "3.1.0",
|
|
42908
43271
|
"paths": {
|
|
@@ -78388,21 +78751,527 @@
|
|
|
78388
78751
|
"content": {
|
|
78389
78752
|
"application/json": {
|
|
78390
78753
|
"schema": {
|
|
78391
|
-
"$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"
|
|
78392
79261
|
}
|
|
78393
79262
|
}
|
|
78394
79263
|
},
|
|
78395
|
-
"description": "
|
|
79264
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
78396
79265
|
},
|
|
78397
79266
|
"404": {
|
|
78398
79267
|
"content": {
|
|
78399
79268
|
"application/json": {
|
|
78400
79269
|
"schema": {
|
|
78401
|
-
"$ref": "#/components/schemas/
|
|
79270
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
78402
79271
|
}
|
|
78403
79272
|
}
|
|
78404
79273
|
},
|
|
78405
|
-
"description": "
|
|
79274
|
+
"description": "No saved filter with that id is visible to the caller (their own, or shared with them)."
|
|
78406
79275
|
},
|
|
78407
79276
|
"413": {
|
|
78408
79277
|
"content": {
|
|
@@ -78425,107 +79294,28 @@
|
|
|
78425
79294
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
78426
79295
|
}
|
|
78427
79296
|
},
|
|
78428
|
-
"summary": "
|
|
78429
|
-
"tags": [
|
|
78430
|
-
"Sales"
|
|
78431
|
-
],
|
|
78432
|
-
"x-mm-records-via": "listSales"
|
|
78433
|
-
}
|
|
78434
|
-
},
|
|
78435
|
-
"/v1/sales/{id}": {
|
|
78436
|
-
"get": {
|
|
78437
|
-
"operationId": "getSale",
|
|
78438
|
-
"parameters": [
|
|
78439
|
-
{
|
|
78440
|
-
"description": "Sale document ID",
|
|
78441
|
-
"in": "path",
|
|
78442
|
-
"name": "id",
|
|
78443
|
-
"required": true,
|
|
78444
|
-
"schema": {
|
|
78445
|
-
"description": "Sale document ID",
|
|
78446
|
-
"type": "string"
|
|
78447
|
-
}
|
|
78448
|
-
}
|
|
78449
|
-
],
|
|
78450
|
-
"responses": {
|
|
78451
|
-
"200": {
|
|
78452
|
-
"content": {
|
|
78453
|
-
"application/json": {
|
|
78454
|
-
"schema": {
|
|
78455
|
-
"$ref": "#/components/schemas/SaleDetailResponse"
|
|
78456
|
-
}
|
|
78457
|
-
}
|
|
78458
|
-
},
|
|
78459
|
-
"description": "Sale detail"
|
|
78460
|
-
},
|
|
78461
|
-
"404": {
|
|
78462
|
-
"content": {
|
|
78463
|
-
"application/json": {
|
|
78464
|
-
"schema": {
|
|
78465
|
-
"$ref": "#/components/schemas/ErrorResponse"
|
|
78466
|
-
}
|
|
78467
|
-
}
|
|
78468
|
-
},
|
|
78469
|
-
"description": "Sale not found"
|
|
78470
|
-
},
|
|
78471
|
-
"413": {
|
|
78472
|
-
"content": {
|
|
78473
|
-
"application/json": {
|
|
78474
|
-
"schema": {
|
|
78475
|
-
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
78476
|
-
}
|
|
78477
|
-
}
|
|
78478
|
-
},
|
|
78479
|
-
"description": "Response payload too large"
|
|
78480
|
-
}
|
|
78481
|
-
},
|
|
78482
|
-
"summary": "Get sale by ID",
|
|
79297
|
+
"summary": "Delete a saved filter",
|
|
78483
79298
|
"tags": [
|
|
78484
|
-
"
|
|
79299
|
+
"Saved Filters"
|
|
78485
79300
|
]
|
|
78486
|
-
}
|
|
78487
|
-
},
|
|
78488
|
-
"/v1/sales/{id}/related": {
|
|
79301
|
+
},
|
|
78489
79302
|
"get": {
|
|
78490
|
-
"description": "
|
|
78491
|
-
"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",
|
|
78492
79305
|
"parameters": [
|
|
78493
79306
|
{
|
|
78494
|
-
"description": "
|
|
79307
|
+
"description": "Saved-filter id (nanoid).",
|
|
78495
79308
|
"in": "path",
|
|
78496
79309
|
"name": "id",
|
|
78497
79310
|
"required": true,
|
|
78498
79311
|
"schema": {
|
|
78499
|
-
"description": "
|
|
78500
|
-
"
|
|
78501
|
-
|
|
78502
|
-
|
|
78503
|
-
|
|
78504
|
-
"description": "Type of record to link to",
|
|
78505
|
-
"in": "query",
|
|
78506
|
-
"name": "to",
|
|
78507
|
-
"required": true,
|
|
78508
|
-
"schema": {
|
|
78509
|
-
"description": "Type of record to link to",
|
|
78510
|
-
"enum": [
|
|
78511
|
-
"agents",
|
|
78512
|
-
"loans",
|
|
78513
|
-
"properties"
|
|
78514
|
-
],
|
|
79312
|
+
"description": "Saved-filter id (nanoid).",
|
|
79313
|
+
"example": "V1StGXR8_Z5jdHi6B-myT",
|
|
79314
|
+
"maxLength": 32,
|
|
79315
|
+
"minLength": 1,
|
|
79316
|
+
"pattern": "^[\\w-]+$",
|
|
78515
79317
|
"type": "string"
|
|
78516
79318
|
}
|
|
78517
|
-
},
|
|
78518
|
-
{
|
|
78519
|
-
"description": "Maximum ids to return (default 25, max 200)",
|
|
78520
|
-
"in": "query",
|
|
78521
|
-
"name": "limit",
|
|
78522
|
-
"required": false,
|
|
78523
|
-
"schema": {
|
|
78524
|
-
"description": "Maximum ids to return (default 25, max 200)",
|
|
78525
|
-
"maximum": 200,
|
|
78526
|
-
"minimum": 1,
|
|
78527
|
-
"type": "integer"
|
|
78528
|
-
}
|
|
78529
79319
|
}
|
|
78530
79320
|
],
|
|
78531
79321
|
"responses": {
|
|
@@ -78533,11 +79323,11 @@
|
|
|
78533
79323
|
"content": {
|
|
78534
79324
|
"application/json": {
|
|
78535
79325
|
"schema": {
|
|
78536
|
-
"$ref": "#/components/schemas/
|
|
79326
|
+
"$ref": "#/components/schemas/GetSavedFilterResult"
|
|
78537
79327
|
}
|
|
78538
79328
|
}
|
|
78539
79329
|
},
|
|
78540
|
-
"description": "
|
|
79330
|
+
"description": "The saved filter."
|
|
78541
79331
|
},
|
|
78542
79332
|
"400": {
|
|
78543
79333
|
"content": {
|
|
@@ -78573,11 +79363,11 @@
|
|
|
78573
79363
|
"content": {
|
|
78574
79364
|
"application/json": {
|
|
78575
79365
|
"schema": {
|
|
78576
|
-
"$ref": "#/components/schemas/
|
|
79366
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
78577
79367
|
}
|
|
78578
79368
|
}
|
|
78579
79369
|
},
|
|
78580
|
-
"description": "
|
|
79370
|
+
"description": "No saved filter with that id is visible to the caller (their own, or shared with them)."
|
|
78581
79371
|
},
|
|
78582
79372
|
"413": {
|
|
78583
79373
|
"content": {
|
|
@@ -78600,74 +79390,59 @@
|
|
|
78600
79390
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
78601
79391
|
}
|
|
78602
79392
|
},
|
|
78603
|
-
"summary": "
|
|
79393
|
+
"summary": "Get a saved filter (with the operation to run it)",
|
|
78604
79394
|
"tags": [
|
|
78605
|
-
"
|
|
79395
|
+
"Saved Filters"
|
|
78606
79396
|
]
|
|
78607
|
-
}
|
|
78608
|
-
|
|
78609
|
-
|
|
78610
|
-
|
|
78611
|
-
"description": "The caller's saved filters (and saved CRM views) in the active organization, oldest first, optionally narrowed by target and kind.",
|
|
78612
|
-
"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",
|
|
78613
79401
|
"parameters": [
|
|
78614
79402
|
{
|
|
78615
|
-
"description": "
|
|
78616
|
-
"in": "
|
|
78617
|
-
"name": "
|
|
78618
|
-
"required":
|
|
78619
|
-
"schema": {
|
|
78620
|
-
"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).",
|
|
78621
|
-
"enum": [
|
|
78622
|
-
"originators",
|
|
78623
|
-
"agents",
|
|
78624
|
-
"companies",
|
|
78625
|
-
"branches",
|
|
78626
|
-
"offices",
|
|
78627
|
-
"loans",
|
|
78628
|
-
"properties",
|
|
78629
|
-
"sales",
|
|
78630
|
-
"crm_people",
|
|
78631
|
-
"crm_companies"
|
|
78632
|
-
],
|
|
78633
|
-
"type": "string"
|
|
78634
|
-
}
|
|
78635
|
-
},
|
|
78636
|
-
{
|
|
78637
|
-
"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.",
|
|
78638
|
-
"in": "query",
|
|
78639
|
-
"name": "kind",
|
|
78640
|
-
"required": false,
|
|
79403
|
+
"description": "Saved-filter id (nanoid).",
|
|
79404
|
+
"in": "path",
|
|
79405
|
+
"name": "id",
|
|
79406
|
+
"required": true,
|
|
78641
79407
|
"schema": {
|
|
78642
|
-
"description": "
|
|
78643
|
-
"
|
|
78644
|
-
|
|
78645
|
-
|
|
78646
|
-
],
|
|
79408
|
+
"description": "Saved-filter id (nanoid).",
|
|
79409
|
+
"example": "V1StGXR8_Z5jdHi6B-myT",
|
|
79410
|
+
"maxLength": 32,
|
|
79411
|
+
"minLength": 1,
|
|
79412
|
+
"pattern": "^[\\w-]+$",
|
|
78647
79413
|
"type": "string"
|
|
78648
79414
|
}
|
|
78649
79415
|
}
|
|
78650
79416
|
],
|
|
79417
|
+
"requestBody": {
|
|
79418
|
+
"content": {
|
|
79419
|
+
"application/json": {
|
|
79420
|
+
"schema": {
|
|
79421
|
+
"$ref": "#/components/schemas/UpdateSavedFilterRequest"
|
|
79422
|
+
}
|
|
79423
|
+
}
|
|
79424
|
+
}
|
|
79425
|
+
},
|
|
78651
79426
|
"responses": {
|
|
78652
79427
|
"200": {
|
|
78653
79428
|
"content": {
|
|
78654
79429
|
"application/json": {
|
|
78655
79430
|
"schema": {
|
|
78656
|
-
"$ref": "#/components/schemas/
|
|
79431
|
+
"$ref": "#/components/schemas/UpdateSavedFilterResult"
|
|
78657
79432
|
}
|
|
78658
79433
|
}
|
|
78659
79434
|
},
|
|
78660
|
-
"description": "
|
|
79435
|
+
"description": "The updated filter."
|
|
78661
79436
|
},
|
|
78662
79437
|
"400": {
|
|
78663
79438
|
"content": {
|
|
78664
79439
|
"application/json": {
|
|
78665
79440
|
"schema": {
|
|
78666
|
-
"$ref": "#/components/schemas/
|
|
79441
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
78667
79442
|
}
|
|
78668
79443
|
}
|
|
78669
79444
|
},
|
|
78670
|
-
"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)."
|
|
78671
79446
|
},
|
|
78672
79447
|
"401": {
|
|
78673
79448
|
"content": {
|
|
@@ -78683,21 +79458,21 @@
|
|
|
78683
79458
|
"content": {
|
|
78684
79459
|
"application/json": {
|
|
78685
79460
|
"schema": {
|
|
78686
|
-
"$ref": "#/components/schemas/
|
|
79461
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
78687
79462
|
}
|
|
78688
79463
|
}
|
|
78689
79464
|
},
|
|
78690
|
-
"description": "
|
|
79465
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
78691
79466
|
},
|
|
78692
79467
|
"404": {
|
|
78693
79468
|
"content": {
|
|
78694
79469
|
"application/json": {
|
|
78695
79470
|
"schema": {
|
|
78696
|
-
"$ref": "#/components/schemas/
|
|
79471
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
78697
79472
|
}
|
|
78698
79473
|
}
|
|
78699
79474
|
},
|
|
78700
|
-
"description": "
|
|
79475
|
+
"description": "No saved filter with that id is visible to the caller (their own, or shared with them)."
|
|
78701
79476
|
},
|
|
78702
79477
|
"413": {
|
|
78703
79478
|
"content": {
|
|
@@ -78720,43 +79495,52 @@
|
|
|
78720
79495
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
78721
79496
|
}
|
|
78722
79497
|
},
|
|
78723
|
-
"summary": "
|
|
79498
|
+
"summary": "Update a saved filter",
|
|
78724
79499
|
"tags": [
|
|
78725
79500
|
"Saved Filters"
|
|
78726
79501
|
]
|
|
78727
|
-
}
|
|
78728
|
-
|
|
78729
|
-
|
|
78730
|
-
|
|
78731
|
-
"
|
|
78732
|
-
|
|
78733
|
-
|
|
78734
|
-
|
|
78735
|
-
|
|
78736
|
-
|
|
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"
|
|
78737
79521
|
}
|
|
78738
79522
|
}
|
|
78739
|
-
|
|
79523
|
+
],
|
|
78740
79524
|
"responses": {
|
|
78741
|
-
"
|
|
79525
|
+
"200": {
|
|
78742
79526
|
"content": {
|
|
78743
79527
|
"application/json": {
|
|
78744
79528
|
"schema": {
|
|
78745
|
-
"$ref": "#/components/schemas/
|
|
79529
|
+
"$ref": "#/components/schemas/SavedFilterShareableMemberList"
|
|
78746
79530
|
}
|
|
78747
79531
|
}
|
|
78748
79532
|
},
|
|
78749
|
-
"description": "The
|
|
79533
|
+
"description": "The workspace roster."
|
|
78750
79534
|
},
|
|
78751
79535
|
"400": {
|
|
78752
79536
|
"content": {
|
|
78753
79537
|
"application/json": {
|
|
78754
79538
|
"schema": {
|
|
78755
|
-
"$ref": "#/components/schemas/
|
|
79539
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
78756
79540
|
}
|
|
78757
79541
|
}
|
|
78758
79542
|
},
|
|
78759
|
-
"description": "Validation error
|
|
79543
|
+
"description": "Validation error"
|
|
78760
79544
|
},
|
|
78761
79545
|
"401": {
|
|
78762
79546
|
"content": {
|
|
@@ -78772,41 +79556,41 @@
|
|
|
78772
79556
|
"content": {
|
|
78773
79557
|
"application/json": {
|
|
78774
79558
|
"schema": {
|
|
78775
|
-
"$ref": "#/components/schemas/
|
|
79559
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
78776
79560
|
}
|
|
78777
79561
|
}
|
|
78778
79562
|
},
|
|
78779
|
-
"description": "
|
|
79563
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
78780
79564
|
},
|
|
78781
79565
|
"404": {
|
|
78782
79566
|
"content": {
|
|
78783
79567
|
"application/json": {
|
|
78784
79568
|
"schema": {
|
|
78785
|
-
"$ref": "#/components/schemas/
|
|
79569
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
78786
79570
|
}
|
|
78787
79571
|
}
|
|
78788
79572
|
},
|
|
78789
|
-
"description": "
|
|
79573
|
+
"description": "No saved filter with that id is visible to the caller (their own, or shared with them)."
|
|
78790
79574
|
},
|
|
78791
|
-
"
|
|
79575
|
+
"413": {
|
|
78792
79576
|
"content": {
|
|
78793
79577
|
"application/json": {
|
|
78794
79578
|
"schema": {
|
|
78795
|
-
"$ref": "#/components/schemas/
|
|
79579
|
+
"$ref": "#/components/schemas/PayloadTooLarge"
|
|
78796
79580
|
}
|
|
78797
79581
|
}
|
|
78798
79582
|
},
|
|
78799
|
-
"description": "
|
|
79583
|
+
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
78800
79584
|
},
|
|
78801
|
-
"
|
|
79585
|
+
"502": {
|
|
78802
79586
|
"content": {
|
|
78803
79587
|
"application/json": {
|
|
78804
79588
|
"schema": {
|
|
78805
|
-
"$ref": "#/components/schemas/
|
|
79589
|
+
"$ref": "#/components/schemas/ErrorResponse"
|
|
78806
79590
|
}
|
|
78807
79591
|
}
|
|
78808
79592
|
},
|
|
78809
|
-
"description": "
|
|
79593
|
+
"description": "Workspace members could not be read (auth service unavailable)."
|
|
78810
79594
|
},
|
|
78811
79595
|
"503": {
|
|
78812
79596
|
"content": {
|
|
@@ -78819,15 +79603,16 @@
|
|
|
78819
79603
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
78820
79604
|
}
|
|
78821
79605
|
},
|
|
78822
|
-
"summary": "
|
|
79606
|
+
"summary": "List the workspace members a saved filter can be shared with",
|
|
78823
79607
|
"tags": [
|
|
78824
79608
|
"Saved Filters"
|
|
78825
79609
|
]
|
|
78826
79610
|
}
|
|
78827
79611
|
},
|
|
78828
|
-
"/v1/saved-filters/{id}": {
|
|
79612
|
+
"/v1/saved-filters/{id}/shares": {
|
|
78829
79613
|
"delete": {
|
|
78830
|
-
"
|
|
79614
|
+
"description": "Owner or workspace admin only. Removes that member's share; a no-op (`revoked: false`) when there was none.",
|
|
79615
|
+
"operationId": "revokeSavedFilterAccess",
|
|
78831
79616
|
"parameters": [
|
|
78832
79617
|
{
|
|
78833
79618
|
"description": "Saved-filter id (nanoid).",
|
|
@@ -78844,16 +79629,25 @@
|
|
|
78844
79629
|
}
|
|
78845
79630
|
}
|
|
78846
79631
|
],
|
|
79632
|
+
"requestBody": {
|
|
79633
|
+
"content": {
|
|
79634
|
+
"application/json": {
|
|
79635
|
+
"schema": {
|
|
79636
|
+
"$ref": "#/components/schemas/RevokeSavedFilterAccessRequest"
|
|
79637
|
+
}
|
|
79638
|
+
}
|
|
79639
|
+
}
|
|
79640
|
+
},
|
|
78847
79641
|
"responses": {
|
|
78848
79642
|
"200": {
|
|
78849
79643
|
"content": {
|
|
78850
79644
|
"application/json": {
|
|
78851
79645
|
"schema": {
|
|
78852
|
-
"$ref": "#/components/schemas/
|
|
79646
|
+
"$ref": "#/components/schemas/RevokeSavedFilterAccessResult"
|
|
78853
79647
|
}
|
|
78854
79648
|
}
|
|
78855
79649
|
},
|
|
78856
|
-
"description": "
|
|
79650
|
+
"description": "Whether a share was removed."
|
|
78857
79651
|
},
|
|
78858
79652
|
"400": {
|
|
78859
79653
|
"content": {
|
|
@@ -78879,11 +79673,11 @@
|
|
|
78879
79673
|
"content": {
|
|
78880
79674
|
"application/json": {
|
|
78881
79675
|
"schema": {
|
|
78882
|
-
"$ref": "#/components/schemas/
|
|
79676
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
78883
79677
|
}
|
|
78884
79678
|
}
|
|
78885
79679
|
},
|
|
78886
|
-
"description": "
|
|
79680
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
78887
79681
|
},
|
|
78888
79682
|
"404": {
|
|
78889
79683
|
"content": {
|
|
@@ -78893,7 +79687,7 @@
|
|
|
78893
79687
|
}
|
|
78894
79688
|
}
|
|
78895
79689
|
},
|
|
78896
|
-
"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)."
|
|
78897
79691
|
},
|
|
78898
79692
|
"413": {
|
|
78899
79693
|
"content": {
|
|
@@ -78916,14 +79710,14 @@
|
|
|
78916
79710
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
78917
79711
|
}
|
|
78918
79712
|
},
|
|
78919
|
-
"summary": "
|
|
79713
|
+
"summary": "Stop sharing a saved filter with a member",
|
|
78920
79714
|
"tags": [
|
|
78921
79715
|
"Saved Filters"
|
|
78922
79716
|
]
|
|
78923
79717
|
},
|
|
78924
79718
|
"get": {
|
|
78925
|
-
"description": "
|
|
78926
|
-
"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",
|
|
78927
79721
|
"parameters": [
|
|
78928
79722
|
{
|
|
78929
79723
|
"description": "Saved-filter id (nanoid).",
|
|
@@ -78945,11 +79739,11 @@
|
|
|
78945
79739
|
"content": {
|
|
78946
79740
|
"application/json": {
|
|
78947
79741
|
"schema": {
|
|
78948
|
-
"$ref": "#/components/schemas/
|
|
79742
|
+
"$ref": "#/components/schemas/GetSavedFilterSharesResult"
|
|
78949
79743
|
}
|
|
78950
79744
|
}
|
|
78951
79745
|
},
|
|
78952
|
-
"description": "The
|
|
79746
|
+
"description": "The filter's sharing state."
|
|
78953
79747
|
},
|
|
78954
79748
|
"400": {
|
|
78955
79749
|
"content": {
|
|
@@ -78975,11 +79769,11 @@
|
|
|
78975
79769
|
"content": {
|
|
78976
79770
|
"application/json": {
|
|
78977
79771
|
"schema": {
|
|
78978
|
-
"$ref": "#/components/schemas/
|
|
79772
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
78979
79773
|
}
|
|
78980
79774
|
}
|
|
78981
79775
|
},
|
|
78982
|
-
"description": "
|
|
79776
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
78983
79777
|
},
|
|
78984
79778
|
"404": {
|
|
78985
79779
|
"content": {
|
|
@@ -78989,7 +79783,7 @@
|
|
|
78989
79783
|
}
|
|
78990
79784
|
}
|
|
78991
79785
|
},
|
|
78992
|
-
"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)."
|
|
78993
79787
|
},
|
|
78994
79788
|
"413": {
|
|
78995
79789
|
"content": {
|
|
@@ -79001,6 +79795,16 @@
|
|
|
79001
79795
|
},
|
|
79002
79796
|
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
79003
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
|
+
},
|
|
79004
79808
|
"503": {
|
|
79005
79809
|
"content": {
|
|
79006
79810
|
"application/json": {
|
|
@@ -79012,14 +79816,14 @@
|
|
|
79012
79816
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
79013
79817
|
}
|
|
79014
79818
|
},
|
|
79015
|
-
"summary": "Get a saved filter
|
|
79819
|
+
"summary": "Get who a saved filter is shared with",
|
|
79016
79820
|
"tags": [
|
|
79017
79821
|
"Saved Filters"
|
|
79018
79822
|
]
|
|
79019
79823
|
},
|
|
79020
|
-
"
|
|
79021
|
-
"description": "
|
|
79022
|
-
"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",
|
|
79023
79827
|
"parameters": [
|
|
79024
79828
|
{
|
|
79025
79829
|
"description": "Saved-filter id (nanoid).",
|
|
@@ -79040,7 +79844,7 @@
|
|
|
79040
79844
|
"content": {
|
|
79041
79845
|
"application/json": {
|
|
79042
79846
|
"schema": {
|
|
79043
|
-
"$ref": "#/components/schemas/
|
|
79847
|
+
"$ref": "#/components/schemas/GrantSavedFilterAccessRequest"
|
|
79044
79848
|
}
|
|
79045
79849
|
}
|
|
79046
79850
|
}
|
|
@@ -79050,11 +79854,11 @@
|
|
|
79050
79854
|
"content": {
|
|
79051
79855
|
"application/json": {
|
|
79052
79856
|
"schema": {
|
|
79053
|
-
"$ref": "#/components/schemas/
|
|
79857
|
+
"$ref": "#/components/schemas/GrantSavedFilterAccessResult"
|
|
79054
79858
|
}
|
|
79055
79859
|
}
|
|
79056
79860
|
},
|
|
79057
|
-
"description": "
|
|
79861
|
+
"description": "Whether a new share was created (false when an existing one was updated)."
|
|
79058
79862
|
},
|
|
79059
79863
|
"400": {
|
|
79060
79864
|
"content": {
|
|
@@ -79064,7 +79868,7 @@
|
|
|
79064
79868
|
}
|
|
79065
79869
|
}
|
|
79066
79870
|
},
|
|
79067
|
-
"description": "Validation error
|
|
79871
|
+
"description": "Validation error, or (`code: NOT_ORG_MEMBER`) the user is not a member of your workspace."
|
|
79068
79872
|
},
|
|
79069
79873
|
"401": {
|
|
79070
79874
|
"content": {
|
|
@@ -79080,11 +79884,11 @@
|
|
|
79080
79884
|
"content": {
|
|
79081
79885
|
"application/json": {
|
|
79082
79886
|
"schema": {
|
|
79083
|
-
"$ref": "#/components/schemas/
|
|
79887
|
+
"$ref": "#/components/schemas/SavedFilterError"
|
|
79084
79888
|
}
|
|
79085
79889
|
}
|
|
79086
79890
|
},
|
|
79087
|
-
"description": "
|
|
79891
|
+
"description": "No active organization, or (`code: FORBIDDEN`) the filter is shared with you at a level that does not allow this."
|
|
79088
79892
|
},
|
|
79089
79893
|
"404": {
|
|
79090
79894
|
"content": {
|
|
@@ -79094,7 +79898,7 @@
|
|
|
79094
79898
|
}
|
|
79095
79899
|
}
|
|
79096
79900
|
},
|
|
79097
|
-
"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)."
|
|
79098
79902
|
},
|
|
79099
79903
|
"413": {
|
|
79100
79904
|
"content": {
|
|
@@ -79106,6 +79910,16 @@
|
|
|
79106
79910
|
},
|
|
79107
79911
|
"description": "Response payload too large — detail endpoint capped to fit Lambda response limits"
|
|
79108
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
|
+
},
|
|
79109
79923
|
"503": {
|
|
79110
79924
|
"content": {
|
|
79111
79925
|
"application/json": {
|
|
@@ -79117,7 +79931,7 @@
|
|
|
79117
79931
|
"description": "Search timed out or the cluster is overloaded — retry after `Retry-After` seconds."
|
|
79118
79932
|
}
|
|
79119
79933
|
},
|
|
79120
|
-
"summary": "
|
|
79934
|
+
"summary": "Share a saved filter with a workspace member",
|
|
79121
79935
|
"tags": [
|
|
79122
79936
|
"Saved Filters"
|
|
79123
79937
|
]
|