@model-match/api 3.20.0 → 3.21.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/dist/{index-B37G0lV3.d.mts → index-Dqyv0ofc.d.mts} +359 -24
- package/dist/index.d.mts +2 -2
- package/dist/index.mjs +1 -1
- package/dist/slim/index.d.mts +4 -4
- package/dist/slim/index.mjs +3 -3
- package/dist/{src-CkGOuklD.mjs → src-C-v3quuA.mjs} +2 -2
- package/openapi.json +1545 -49
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -392,6 +392,472 @@
|
|
|
392
392
|
],
|
|
393
393
|
"type": "object"
|
|
394
394
|
},
|
|
395
|
+
"AdminAlertRecipe": {
|
|
396
|
+
"properties": {
|
|
397
|
+
"category": {
|
|
398
|
+
"maxLength": 32,
|
|
399
|
+
"minLength": 1,
|
|
400
|
+
"type": "string"
|
|
401
|
+
},
|
|
402
|
+
"copy": {
|
|
403
|
+
"properties": {
|
|
404
|
+
"headline": {
|
|
405
|
+
"maxLength": 200,
|
|
406
|
+
"minLength": 1,
|
|
407
|
+
"type": "string"
|
|
408
|
+
},
|
|
409
|
+
"intro": {
|
|
410
|
+
"maxLength": 1000,
|
|
411
|
+
"type": "string"
|
|
412
|
+
},
|
|
413
|
+
"plural": {
|
|
414
|
+
"maxLength": 40,
|
|
415
|
+
"minLength": 1,
|
|
416
|
+
"type": "string"
|
|
417
|
+
},
|
|
418
|
+
"subject": {
|
|
419
|
+
"maxLength": 200,
|
|
420
|
+
"minLength": 1,
|
|
421
|
+
"type": "string"
|
|
422
|
+
}
|
|
423
|
+
},
|
|
424
|
+
"required": [
|
|
425
|
+
"subject",
|
|
426
|
+
"headline",
|
|
427
|
+
"intro",
|
|
428
|
+
"plural"
|
|
429
|
+
],
|
|
430
|
+
"type": "object"
|
|
431
|
+
},
|
|
432
|
+
"createdAt": {
|
|
433
|
+
"type": "string"
|
|
434
|
+
},
|
|
435
|
+
"createdBy": {
|
|
436
|
+
"type": "string"
|
|
437
|
+
},
|
|
438
|
+
"description": {
|
|
439
|
+
"maxLength": 500,
|
|
440
|
+
"type": "string"
|
|
441
|
+
},
|
|
442
|
+
"family": {
|
|
443
|
+
"enum": [
|
|
444
|
+
"past-clients",
|
|
445
|
+
"agent-partners",
|
|
446
|
+
"farm-area",
|
|
447
|
+
"watch-record"
|
|
448
|
+
],
|
|
449
|
+
"type": "string"
|
|
450
|
+
},
|
|
451
|
+
"featured": {
|
|
452
|
+
"type": "boolean"
|
|
453
|
+
},
|
|
454
|
+
"grants": {
|
|
455
|
+
"properties": {
|
|
456
|
+
"agent": {
|
|
457
|
+
"items": {
|
|
458
|
+
"enum": [
|
|
459
|
+
"area_new_listing",
|
|
460
|
+
"watched_agent_pending",
|
|
461
|
+
"borrower_listed",
|
|
462
|
+
"epo_risk",
|
|
463
|
+
"agent_sale_closed",
|
|
464
|
+
"rate_term_refi_area",
|
|
465
|
+
"watched_sale",
|
|
466
|
+
"watched_property",
|
|
467
|
+
"watched_loan"
|
|
468
|
+
],
|
|
469
|
+
"type": "string"
|
|
470
|
+
},
|
|
471
|
+
"type": "array"
|
|
472
|
+
},
|
|
473
|
+
"area": {
|
|
474
|
+
"items": {
|
|
475
|
+
"enum": [
|
|
476
|
+
"area_new_listing",
|
|
477
|
+
"watched_agent_pending",
|
|
478
|
+
"borrower_listed",
|
|
479
|
+
"epo_risk",
|
|
480
|
+
"agent_sale_closed",
|
|
481
|
+
"rate_term_refi_area",
|
|
482
|
+
"watched_sale",
|
|
483
|
+
"watched_property",
|
|
484
|
+
"watched_loan"
|
|
485
|
+
],
|
|
486
|
+
"type": "string"
|
|
487
|
+
},
|
|
488
|
+
"type": "array"
|
|
489
|
+
},
|
|
490
|
+
"document": {
|
|
491
|
+
"properties": {
|
|
492
|
+
"loan": {
|
|
493
|
+
"items": {
|
|
494
|
+
"properties": {
|
|
495
|
+
"match": {
|
|
496
|
+
"enum": [
|
|
497
|
+
"all",
|
|
498
|
+
"any"
|
|
499
|
+
],
|
|
500
|
+
"type": "string"
|
|
501
|
+
},
|
|
502
|
+
"predicates": {
|
|
503
|
+
"items": {
|
|
504
|
+
"properties": {
|
|
505
|
+
"field": {
|
|
506
|
+
"type": "string"
|
|
507
|
+
},
|
|
508
|
+
"op": {
|
|
509
|
+
"enum": [
|
|
510
|
+
"gt",
|
|
511
|
+
"gte",
|
|
512
|
+
"lt",
|
|
513
|
+
"lte",
|
|
514
|
+
"eq",
|
|
515
|
+
"between",
|
|
516
|
+
"pct_change_gte",
|
|
517
|
+
"abs_change_gte",
|
|
518
|
+
"changed",
|
|
519
|
+
"changed_to"
|
|
520
|
+
],
|
|
521
|
+
"type": "string"
|
|
522
|
+
},
|
|
523
|
+
"stringValue": {
|
|
524
|
+
"type": "string"
|
|
525
|
+
},
|
|
526
|
+
"value": {
|
|
527
|
+
"type": "number"
|
|
528
|
+
},
|
|
529
|
+
"value2": {
|
|
530
|
+
"type": "number"
|
|
531
|
+
}
|
|
532
|
+
},
|
|
533
|
+
"required": [
|
|
534
|
+
"field",
|
|
535
|
+
"op"
|
|
536
|
+
],
|
|
537
|
+
"type": "object"
|
|
538
|
+
},
|
|
539
|
+
"minItems": 1,
|
|
540
|
+
"type": "array"
|
|
541
|
+
}
|
|
542
|
+
},
|
|
543
|
+
"required": [
|
|
544
|
+
"predicates"
|
|
545
|
+
],
|
|
546
|
+
"type": "object"
|
|
547
|
+
},
|
|
548
|
+
"type": "array"
|
|
549
|
+
},
|
|
550
|
+
"property": {
|
|
551
|
+
"items": {
|
|
552
|
+
"properties": {
|
|
553
|
+
"match": {
|
|
554
|
+
"enum": [
|
|
555
|
+
"all",
|
|
556
|
+
"any"
|
|
557
|
+
],
|
|
558
|
+
"type": "string"
|
|
559
|
+
},
|
|
560
|
+
"predicates": {
|
|
561
|
+
"items": {
|
|
562
|
+
"properties": {
|
|
563
|
+
"field": {
|
|
564
|
+
"type": "string"
|
|
565
|
+
},
|
|
566
|
+
"op": {
|
|
567
|
+
"enum": [
|
|
568
|
+
"gt",
|
|
569
|
+
"gte",
|
|
570
|
+
"lt",
|
|
571
|
+
"lte",
|
|
572
|
+
"eq",
|
|
573
|
+
"between",
|
|
574
|
+
"pct_change_gte",
|
|
575
|
+
"abs_change_gte",
|
|
576
|
+
"changed",
|
|
577
|
+
"changed_to"
|
|
578
|
+
],
|
|
579
|
+
"type": "string"
|
|
580
|
+
},
|
|
581
|
+
"stringValue": {
|
|
582
|
+
"type": "string"
|
|
583
|
+
},
|
|
584
|
+
"value": {
|
|
585
|
+
"type": "number"
|
|
586
|
+
},
|
|
587
|
+
"value2": {
|
|
588
|
+
"type": "number"
|
|
589
|
+
}
|
|
590
|
+
},
|
|
591
|
+
"required": [
|
|
592
|
+
"field",
|
|
593
|
+
"op"
|
|
594
|
+
],
|
|
595
|
+
"type": "object"
|
|
596
|
+
},
|
|
597
|
+
"minItems": 1,
|
|
598
|
+
"type": "array"
|
|
599
|
+
}
|
|
600
|
+
},
|
|
601
|
+
"required": [
|
|
602
|
+
"predicates"
|
|
603
|
+
],
|
|
604
|
+
"type": "object"
|
|
605
|
+
},
|
|
606
|
+
"type": "array"
|
|
607
|
+
},
|
|
608
|
+
"sale": {
|
|
609
|
+
"items": {
|
|
610
|
+
"properties": {
|
|
611
|
+
"match": {
|
|
612
|
+
"enum": [
|
|
613
|
+
"all",
|
|
614
|
+
"any"
|
|
615
|
+
],
|
|
616
|
+
"type": "string"
|
|
617
|
+
},
|
|
618
|
+
"predicates": {
|
|
619
|
+
"items": {
|
|
620
|
+
"properties": {
|
|
621
|
+
"field": {
|
|
622
|
+
"type": "string"
|
|
623
|
+
},
|
|
624
|
+
"op": {
|
|
625
|
+
"enum": [
|
|
626
|
+
"gt",
|
|
627
|
+
"gte",
|
|
628
|
+
"lt",
|
|
629
|
+
"lte",
|
|
630
|
+
"eq",
|
|
631
|
+
"between",
|
|
632
|
+
"pct_change_gte",
|
|
633
|
+
"abs_change_gte",
|
|
634
|
+
"changed",
|
|
635
|
+
"changed_to"
|
|
636
|
+
],
|
|
637
|
+
"type": "string"
|
|
638
|
+
},
|
|
639
|
+
"stringValue": {
|
|
640
|
+
"type": "string"
|
|
641
|
+
},
|
|
642
|
+
"value": {
|
|
643
|
+
"type": "number"
|
|
644
|
+
},
|
|
645
|
+
"value2": {
|
|
646
|
+
"type": "number"
|
|
647
|
+
}
|
|
648
|
+
},
|
|
649
|
+
"required": [
|
|
650
|
+
"field",
|
|
651
|
+
"op"
|
|
652
|
+
],
|
|
653
|
+
"type": "object"
|
|
654
|
+
},
|
|
655
|
+
"minItems": 1,
|
|
656
|
+
"type": "array"
|
|
657
|
+
}
|
|
658
|
+
},
|
|
659
|
+
"required": [
|
|
660
|
+
"predicates"
|
|
661
|
+
],
|
|
662
|
+
"type": "object"
|
|
663
|
+
},
|
|
664
|
+
"type": "array"
|
|
665
|
+
}
|
|
666
|
+
},
|
|
667
|
+
"type": "object"
|
|
668
|
+
},
|
|
669
|
+
"nmls": {
|
|
670
|
+
"items": {
|
|
671
|
+
"enum": [
|
|
672
|
+
"area_new_listing",
|
|
673
|
+
"watched_agent_pending",
|
|
674
|
+
"borrower_listed",
|
|
675
|
+
"epo_risk",
|
|
676
|
+
"agent_sale_closed",
|
|
677
|
+
"rate_term_refi_area",
|
|
678
|
+
"watched_sale",
|
|
679
|
+
"watched_property",
|
|
680
|
+
"watched_loan"
|
|
681
|
+
],
|
|
682
|
+
"type": "string"
|
|
683
|
+
},
|
|
684
|
+
"type": "array"
|
|
685
|
+
}
|
|
686
|
+
},
|
|
687
|
+
"type": "object"
|
|
688
|
+
},
|
|
689
|
+
"howItWorks": {
|
|
690
|
+
"maxLength": 2000,
|
|
691
|
+
"type": "string"
|
|
692
|
+
},
|
|
693
|
+
"icon": {
|
|
694
|
+
"type": "string"
|
|
695
|
+
},
|
|
696
|
+
"id": {
|
|
697
|
+
"type": "string"
|
|
698
|
+
},
|
|
699
|
+
"inputs": {
|
|
700
|
+
"items": {
|
|
701
|
+
"properties": {
|
|
702
|
+
"documentType": {
|
|
703
|
+
"enum": [
|
|
704
|
+
"sale",
|
|
705
|
+
"property",
|
|
706
|
+
"loan"
|
|
707
|
+
],
|
|
708
|
+
"type": "string"
|
|
709
|
+
},
|
|
710
|
+
"help": {
|
|
711
|
+
"maxLength": 400,
|
|
712
|
+
"type": "string"
|
|
713
|
+
},
|
|
714
|
+
"label": {
|
|
715
|
+
"maxLength": 80,
|
|
716
|
+
"type": "string"
|
|
717
|
+
},
|
|
718
|
+
"max": {
|
|
719
|
+
"minimum": 1,
|
|
720
|
+
"type": "integer"
|
|
721
|
+
},
|
|
722
|
+
"min": {
|
|
723
|
+
"minimum": 0,
|
|
724
|
+
"type": "integer"
|
|
725
|
+
},
|
|
726
|
+
"required": {
|
|
727
|
+
"type": "boolean"
|
|
728
|
+
},
|
|
729
|
+
"type": {
|
|
730
|
+
"enum": [
|
|
731
|
+
"nmls",
|
|
732
|
+
"agent",
|
|
733
|
+
"area",
|
|
734
|
+
"document"
|
|
735
|
+
],
|
|
736
|
+
"type": "string"
|
|
737
|
+
}
|
|
738
|
+
},
|
|
739
|
+
"required": [
|
|
740
|
+
"type",
|
|
741
|
+
"required"
|
|
742
|
+
],
|
|
743
|
+
"type": "object"
|
|
744
|
+
},
|
|
745
|
+
"maxItems": 4,
|
|
746
|
+
"type": "array"
|
|
747
|
+
},
|
|
748
|
+
"maxItemsPerRun": {
|
|
749
|
+
"maximum": 100,
|
|
750
|
+
"minimum": 1,
|
|
751
|
+
"type": "integer"
|
|
752
|
+
},
|
|
753
|
+
"sortOrder": {
|
|
754
|
+
"maximum": 999999,
|
|
755
|
+
"minimum": 0,
|
|
756
|
+
"type": "integer"
|
|
757
|
+
},
|
|
758
|
+
"status": {
|
|
759
|
+
"enum": [
|
|
760
|
+
"draft",
|
|
761
|
+
"published",
|
|
762
|
+
"archived"
|
|
763
|
+
],
|
|
764
|
+
"type": "string"
|
|
765
|
+
},
|
|
766
|
+
"subscribers": {
|
|
767
|
+
"description": "List only: users with a subscription carrying this recipe (kinds on).",
|
|
768
|
+
"type": "integer"
|
|
769
|
+
},
|
|
770
|
+
"title": {
|
|
771
|
+
"maxLength": 80,
|
|
772
|
+
"minLength": 1,
|
|
773
|
+
"type": "string"
|
|
774
|
+
},
|
|
775
|
+
"updatedAt": {
|
|
776
|
+
"type": "string"
|
|
777
|
+
},
|
|
778
|
+
"updatedBy": {
|
|
779
|
+
"type": "string"
|
|
780
|
+
},
|
|
781
|
+
"version": {
|
|
782
|
+
"minimum": 1,
|
|
783
|
+
"type": "integer"
|
|
784
|
+
}
|
|
785
|
+
},
|
|
786
|
+
"required": [
|
|
787
|
+
"id",
|
|
788
|
+
"title",
|
|
789
|
+
"description",
|
|
790
|
+
"icon",
|
|
791
|
+
"category",
|
|
792
|
+
"family",
|
|
793
|
+
"grants",
|
|
794
|
+
"inputs",
|
|
795
|
+
"copy",
|
|
796
|
+
"featured",
|
|
797
|
+
"sortOrder",
|
|
798
|
+
"status",
|
|
799
|
+
"version",
|
|
800
|
+
"createdBy",
|
|
801
|
+
"createdAt",
|
|
802
|
+
"updatedBy",
|
|
803
|
+
"updatedAt"
|
|
804
|
+
],
|
|
805
|
+
"type": "object"
|
|
806
|
+
},
|
|
807
|
+
"AdminAlertRecipeResponse": {
|
|
808
|
+
"properties": {
|
|
809
|
+
"data": {
|
|
810
|
+
"$ref": "#/components/schemas/AdminAlertRecipe"
|
|
811
|
+
}
|
|
812
|
+
},
|
|
813
|
+
"required": [
|
|
814
|
+
"data"
|
|
815
|
+
],
|
|
816
|
+
"type": "object"
|
|
817
|
+
},
|
|
818
|
+
"AdminAlertRecipeStatsResponse": {
|
|
819
|
+
"properties": {
|
|
820
|
+
"data": {
|
|
821
|
+
"properties": {
|
|
822
|
+
"alertsLast30d": {
|
|
823
|
+
"description": "Alerts fired in the last 30 days whose grant came from this recipe (LOG `via.recipeIds`), across its subscribers.",
|
|
824
|
+
"type": "integer"
|
|
825
|
+
},
|
|
826
|
+
"lastFiredAt": {
|
|
827
|
+
"description": "Newest such alert (ISO) in the last 30 days.",
|
|
828
|
+
"type": "string"
|
|
829
|
+
},
|
|
830
|
+
"subscribers": {
|
|
831
|
+
"description": "Users with a subscription carrying the recipe (kinds on).",
|
|
832
|
+
"type": "integer"
|
|
833
|
+
}
|
|
834
|
+
},
|
|
835
|
+
"required": [
|
|
836
|
+
"subscribers",
|
|
837
|
+
"alertsLast30d"
|
|
838
|
+
],
|
|
839
|
+
"type": "object"
|
|
840
|
+
}
|
|
841
|
+
},
|
|
842
|
+
"required": [
|
|
843
|
+
"data"
|
|
844
|
+
],
|
|
845
|
+
"type": "object"
|
|
846
|
+
},
|
|
847
|
+
"AdminAlertRecipesResponse": {
|
|
848
|
+
"properties": {
|
|
849
|
+
"data": {
|
|
850
|
+
"items": {
|
|
851
|
+
"$ref": "#/components/schemas/AdminAlertRecipe"
|
|
852
|
+
},
|
|
853
|
+
"type": "array"
|
|
854
|
+
}
|
|
855
|
+
},
|
|
856
|
+
"required": [
|
|
857
|
+
"data"
|
|
858
|
+
],
|
|
859
|
+
"type": "object"
|
|
860
|
+
},
|
|
395
861
|
"AdminAlertRunRecord": {
|
|
396
862
|
"properties": {
|
|
397
863
|
"correlationId": {
|
|
@@ -1012,6 +1478,404 @@
|
|
|
1012
1478
|
],
|
|
1013
1479
|
"type": "object"
|
|
1014
1480
|
},
|
|
1481
|
+
"AdminCreateAlertRecipeRequest": {
|
|
1482
|
+
"description": "A recipe definition. Created as a draft; publish it to show it to users.",
|
|
1483
|
+
"properties": {
|
|
1484
|
+
"category": {
|
|
1485
|
+
"maxLength": 32,
|
|
1486
|
+
"minLength": 1,
|
|
1487
|
+
"type": "string"
|
|
1488
|
+
},
|
|
1489
|
+
"copy": {
|
|
1490
|
+
"properties": {
|
|
1491
|
+
"headline": {
|
|
1492
|
+
"maxLength": 200,
|
|
1493
|
+
"minLength": 1,
|
|
1494
|
+
"type": "string"
|
|
1495
|
+
},
|
|
1496
|
+
"intro": {
|
|
1497
|
+
"maxLength": 1000,
|
|
1498
|
+
"type": "string"
|
|
1499
|
+
},
|
|
1500
|
+
"plural": {
|
|
1501
|
+
"maxLength": 40,
|
|
1502
|
+
"minLength": 1,
|
|
1503
|
+
"type": "string"
|
|
1504
|
+
},
|
|
1505
|
+
"subject": {
|
|
1506
|
+
"maxLength": 200,
|
|
1507
|
+
"minLength": 1,
|
|
1508
|
+
"type": "string"
|
|
1509
|
+
}
|
|
1510
|
+
},
|
|
1511
|
+
"required": [
|
|
1512
|
+
"subject",
|
|
1513
|
+
"headline",
|
|
1514
|
+
"intro",
|
|
1515
|
+
"plural"
|
|
1516
|
+
],
|
|
1517
|
+
"type": "object"
|
|
1518
|
+
},
|
|
1519
|
+
"description": {
|
|
1520
|
+
"maxLength": 500,
|
|
1521
|
+
"type": "string"
|
|
1522
|
+
},
|
|
1523
|
+
"family": {
|
|
1524
|
+
"enum": [
|
|
1525
|
+
"past-clients",
|
|
1526
|
+
"agent-partners",
|
|
1527
|
+
"farm-area",
|
|
1528
|
+
"watch-record"
|
|
1529
|
+
],
|
|
1530
|
+
"type": "string"
|
|
1531
|
+
},
|
|
1532
|
+
"featured": {
|
|
1533
|
+
"type": "boolean"
|
|
1534
|
+
},
|
|
1535
|
+
"grants": {
|
|
1536
|
+
"properties": {
|
|
1537
|
+
"agent": {
|
|
1538
|
+
"items": {
|
|
1539
|
+
"enum": [
|
|
1540
|
+
"area_new_listing",
|
|
1541
|
+
"watched_agent_pending",
|
|
1542
|
+
"borrower_listed",
|
|
1543
|
+
"epo_risk",
|
|
1544
|
+
"agent_sale_closed",
|
|
1545
|
+
"rate_term_refi_area",
|
|
1546
|
+
"watched_sale",
|
|
1547
|
+
"watched_property",
|
|
1548
|
+
"watched_loan"
|
|
1549
|
+
],
|
|
1550
|
+
"type": "string"
|
|
1551
|
+
},
|
|
1552
|
+
"type": "array"
|
|
1553
|
+
},
|
|
1554
|
+
"area": {
|
|
1555
|
+
"items": {
|
|
1556
|
+
"enum": [
|
|
1557
|
+
"area_new_listing",
|
|
1558
|
+
"watched_agent_pending",
|
|
1559
|
+
"borrower_listed",
|
|
1560
|
+
"epo_risk",
|
|
1561
|
+
"agent_sale_closed",
|
|
1562
|
+
"rate_term_refi_area",
|
|
1563
|
+
"watched_sale",
|
|
1564
|
+
"watched_property",
|
|
1565
|
+
"watched_loan"
|
|
1566
|
+
],
|
|
1567
|
+
"type": "string"
|
|
1568
|
+
},
|
|
1569
|
+
"type": "array"
|
|
1570
|
+
},
|
|
1571
|
+
"document": {
|
|
1572
|
+
"properties": {
|
|
1573
|
+
"loan": {
|
|
1574
|
+
"items": {
|
|
1575
|
+
"properties": {
|
|
1576
|
+
"match": {
|
|
1577
|
+
"enum": [
|
|
1578
|
+
"all",
|
|
1579
|
+
"any"
|
|
1580
|
+
],
|
|
1581
|
+
"type": "string"
|
|
1582
|
+
},
|
|
1583
|
+
"predicates": {
|
|
1584
|
+
"items": {
|
|
1585
|
+
"properties": {
|
|
1586
|
+
"field": {
|
|
1587
|
+
"type": "string"
|
|
1588
|
+
},
|
|
1589
|
+
"op": {
|
|
1590
|
+
"enum": [
|
|
1591
|
+
"gt",
|
|
1592
|
+
"gte",
|
|
1593
|
+
"lt",
|
|
1594
|
+
"lte",
|
|
1595
|
+
"eq",
|
|
1596
|
+
"between",
|
|
1597
|
+
"pct_change_gte",
|
|
1598
|
+
"abs_change_gte",
|
|
1599
|
+
"changed",
|
|
1600
|
+
"changed_to"
|
|
1601
|
+
],
|
|
1602
|
+
"type": "string"
|
|
1603
|
+
},
|
|
1604
|
+
"stringValue": {
|
|
1605
|
+
"type": "string"
|
|
1606
|
+
},
|
|
1607
|
+
"value": {
|
|
1608
|
+
"type": "number"
|
|
1609
|
+
},
|
|
1610
|
+
"value2": {
|
|
1611
|
+
"type": "number"
|
|
1612
|
+
}
|
|
1613
|
+
},
|
|
1614
|
+
"required": [
|
|
1615
|
+
"field",
|
|
1616
|
+
"op"
|
|
1617
|
+
],
|
|
1618
|
+
"type": "object"
|
|
1619
|
+
},
|
|
1620
|
+
"minItems": 1,
|
|
1621
|
+
"type": "array"
|
|
1622
|
+
}
|
|
1623
|
+
},
|
|
1624
|
+
"required": [
|
|
1625
|
+
"predicates"
|
|
1626
|
+
],
|
|
1627
|
+
"type": "object"
|
|
1628
|
+
},
|
|
1629
|
+
"type": "array"
|
|
1630
|
+
},
|
|
1631
|
+
"property": {
|
|
1632
|
+
"items": {
|
|
1633
|
+
"properties": {
|
|
1634
|
+
"match": {
|
|
1635
|
+
"enum": [
|
|
1636
|
+
"all",
|
|
1637
|
+
"any"
|
|
1638
|
+
],
|
|
1639
|
+
"type": "string"
|
|
1640
|
+
},
|
|
1641
|
+
"predicates": {
|
|
1642
|
+
"items": {
|
|
1643
|
+
"properties": {
|
|
1644
|
+
"field": {
|
|
1645
|
+
"type": "string"
|
|
1646
|
+
},
|
|
1647
|
+
"op": {
|
|
1648
|
+
"enum": [
|
|
1649
|
+
"gt",
|
|
1650
|
+
"gte",
|
|
1651
|
+
"lt",
|
|
1652
|
+
"lte",
|
|
1653
|
+
"eq",
|
|
1654
|
+
"between",
|
|
1655
|
+
"pct_change_gte",
|
|
1656
|
+
"abs_change_gte",
|
|
1657
|
+
"changed",
|
|
1658
|
+
"changed_to"
|
|
1659
|
+
],
|
|
1660
|
+
"type": "string"
|
|
1661
|
+
},
|
|
1662
|
+
"stringValue": {
|
|
1663
|
+
"type": "string"
|
|
1664
|
+
},
|
|
1665
|
+
"value": {
|
|
1666
|
+
"type": "number"
|
|
1667
|
+
},
|
|
1668
|
+
"value2": {
|
|
1669
|
+
"type": "number"
|
|
1670
|
+
}
|
|
1671
|
+
},
|
|
1672
|
+
"required": [
|
|
1673
|
+
"field",
|
|
1674
|
+
"op"
|
|
1675
|
+
],
|
|
1676
|
+
"type": "object"
|
|
1677
|
+
},
|
|
1678
|
+
"minItems": 1,
|
|
1679
|
+
"type": "array"
|
|
1680
|
+
}
|
|
1681
|
+
},
|
|
1682
|
+
"required": [
|
|
1683
|
+
"predicates"
|
|
1684
|
+
],
|
|
1685
|
+
"type": "object"
|
|
1686
|
+
},
|
|
1687
|
+
"type": "array"
|
|
1688
|
+
},
|
|
1689
|
+
"sale": {
|
|
1690
|
+
"items": {
|
|
1691
|
+
"properties": {
|
|
1692
|
+
"match": {
|
|
1693
|
+
"enum": [
|
|
1694
|
+
"all",
|
|
1695
|
+
"any"
|
|
1696
|
+
],
|
|
1697
|
+
"type": "string"
|
|
1698
|
+
},
|
|
1699
|
+
"predicates": {
|
|
1700
|
+
"items": {
|
|
1701
|
+
"properties": {
|
|
1702
|
+
"field": {
|
|
1703
|
+
"type": "string"
|
|
1704
|
+
},
|
|
1705
|
+
"op": {
|
|
1706
|
+
"enum": [
|
|
1707
|
+
"gt",
|
|
1708
|
+
"gte",
|
|
1709
|
+
"lt",
|
|
1710
|
+
"lte",
|
|
1711
|
+
"eq",
|
|
1712
|
+
"between",
|
|
1713
|
+
"pct_change_gte",
|
|
1714
|
+
"abs_change_gte",
|
|
1715
|
+
"changed",
|
|
1716
|
+
"changed_to"
|
|
1717
|
+
],
|
|
1718
|
+
"type": "string"
|
|
1719
|
+
},
|
|
1720
|
+
"stringValue": {
|
|
1721
|
+
"type": "string"
|
|
1722
|
+
},
|
|
1723
|
+
"value": {
|
|
1724
|
+
"type": "number"
|
|
1725
|
+
},
|
|
1726
|
+
"value2": {
|
|
1727
|
+
"type": "number"
|
|
1728
|
+
}
|
|
1729
|
+
},
|
|
1730
|
+
"required": [
|
|
1731
|
+
"field",
|
|
1732
|
+
"op"
|
|
1733
|
+
],
|
|
1734
|
+
"type": "object"
|
|
1735
|
+
},
|
|
1736
|
+
"minItems": 1,
|
|
1737
|
+
"type": "array"
|
|
1738
|
+
}
|
|
1739
|
+
},
|
|
1740
|
+
"required": [
|
|
1741
|
+
"predicates"
|
|
1742
|
+
],
|
|
1743
|
+
"type": "object"
|
|
1744
|
+
},
|
|
1745
|
+
"type": "array"
|
|
1746
|
+
}
|
|
1747
|
+
},
|
|
1748
|
+
"type": "object"
|
|
1749
|
+
},
|
|
1750
|
+
"nmls": {
|
|
1751
|
+
"items": {
|
|
1752
|
+
"enum": [
|
|
1753
|
+
"area_new_listing",
|
|
1754
|
+
"watched_agent_pending",
|
|
1755
|
+
"borrower_listed",
|
|
1756
|
+
"epo_risk",
|
|
1757
|
+
"agent_sale_closed",
|
|
1758
|
+
"rate_term_refi_area",
|
|
1759
|
+
"watched_sale",
|
|
1760
|
+
"watched_property",
|
|
1761
|
+
"watched_loan"
|
|
1762
|
+
],
|
|
1763
|
+
"type": "string"
|
|
1764
|
+
},
|
|
1765
|
+
"type": "array"
|
|
1766
|
+
}
|
|
1767
|
+
},
|
|
1768
|
+
"type": "object"
|
|
1769
|
+
},
|
|
1770
|
+
"howItWorks": {
|
|
1771
|
+
"maxLength": 2000,
|
|
1772
|
+
"type": "string"
|
|
1773
|
+
},
|
|
1774
|
+
"icon": {
|
|
1775
|
+
"description": "hugeicons component name, e.g. `UserSearch01Icon`.",
|
|
1776
|
+
"type": "string"
|
|
1777
|
+
},
|
|
1778
|
+
"id": {
|
|
1779
|
+
"description": "Kebab-case slug, at most 48 characters; immutable once created.",
|
|
1780
|
+
"example": "listing-watch",
|
|
1781
|
+
"type": "string"
|
|
1782
|
+
},
|
|
1783
|
+
"inputs": {
|
|
1784
|
+
"items": {
|
|
1785
|
+
"properties": {
|
|
1786
|
+
"documentType": {
|
|
1787
|
+
"enum": [
|
|
1788
|
+
"sale",
|
|
1789
|
+
"property",
|
|
1790
|
+
"loan"
|
|
1791
|
+
],
|
|
1792
|
+
"type": "string"
|
|
1793
|
+
},
|
|
1794
|
+
"help": {
|
|
1795
|
+
"maxLength": 400,
|
|
1796
|
+
"type": "string"
|
|
1797
|
+
},
|
|
1798
|
+
"label": {
|
|
1799
|
+
"maxLength": 80,
|
|
1800
|
+
"type": "string"
|
|
1801
|
+
},
|
|
1802
|
+
"max": {
|
|
1803
|
+
"minimum": 1,
|
|
1804
|
+
"type": "integer"
|
|
1805
|
+
},
|
|
1806
|
+
"min": {
|
|
1807
|
+
"minimum": 0,
|
|
1808
|
+
"type": "integer"
|
|
1809
|
+
},
|
|
1810
|
+
"required": {
|
|
1811
|
+
"type": "boolean"
|
|
1812
|
+
},
|
|
1813
|
+
"type": {
|
|
1814
|
+
"enum": [
|
|
1815
|
+
"nmls",
|
|
1816
|
+
"agent",
|
|
1817
|
+
"area",
|
|
1818
|
+
"document"
|
|
1819
|
+
],
|
|
1820
|
+
"type": "string"
|
|
1821
|
+
}
|
|
1822
|
+
},
|
|
1823
|
+
"required": [
|
|
1824
|
+
"type",
|
|
1825
|
+
"required"
|
|
1826
|
+
],
|
|
1827
|
+
"type": "object"
|
|
1828
|
+
},
|
|
1829
|
+
"maxItems": 4,
|
|
1830
|
+
"type": "array"
|
|
1831
|
+
},
|
|
1832
|
+
"maxItemsPerRun": {
|
|
1833
|
+
"maximum": 100,
|
|
1834
|
+
"minimum": 1,
|
|
1835
|
+
"type": "integer"
|
|
1836
|
+
},
|
|
1837
|
+
"sortOrder": {
|
|
1838
|
+
"maximum": 999999,
|
|
1839
|
+
"minimum": 0,
|
|
1840
|
+
"type": "integer"
|
|
1841
|
+
},
|
|
1842
|
+
"title": {
|
|
1843
|
+
"maxLength": 80,
|
|
1844
|
+
"minLength": 1,
|
|
1845
|
+
"type": "string"
|
|
1846
|
+
}
|
|
1847
|
+
},
|
|
1848
|
+
"required": [
|
|
1849
|
+
"id",
|
|
1850
|
+
"title",
|
|
1851
|
+
"description",
|
|
1852
|
+
"icon",
|
|
1853
|
+
"category",
|
|
1854
|
+
"family",
|
|
1855
|
+
"grants",
|
|
1856
|
+
"inputs",
|
|
1857
|
+
"copy",
|
|
1858
|
+
"featured",
|
|
1859
|
+
"sortOrder"
|
|
1860
|
+
],
|
|
1861
|
+
"type": "object"
|
|
1862
|
+
},
|
|
1863
|
+
"AdminPreviewAlertRecipeRequest": {
|
|
1864
|
+
"properties": {
|
|
1865
|
+
"inputs": {
|
|
1866
|
+
"$ref": "#/components/schemas/AlertRecipeInputs"
|
|
1867
|
+
},
|
|
1868
|
+
"userId": {
|
|
1869
|
+
"description": "Whose saved setup to replay with the recipe overlaid.",
|
|
1870
|
+
"minLength": 1,
|
|
1871
|
+
"type": "string"
|
|
1872
|
+
}
|
|
1873
|
+
},
|
|
1874
|
+
"required": [
|
|
1875
|
+
"userId"
|
|
1876
|
+
],
|
|
1877
|
+
"type": "object"
|
|
1878
|
+
},
|
|
1015
1879
|
"AdminPushAlertRequest": {
|
|
1016
1880
|
"properties": {
|
|
1017
1881
|
"dedupeKey": {
|
|
@@ -1085,6 +1949,439 @@
|
|
|
1085
1949
|
],
|
|
1086
1950
|
"type": "object"
|
|
1087
1951
|
},
|
|
1952
|
+
"AdminReplaceAlertRecipeRequest": {
|
|
1953
|
+
"description": "The full definition (everything but `id`); status is kept.",
|
|
1954
|
+
"properties": {
|
|
1955
|
+
"category": {
|
|
1956
|
+
"maxLength": 32,
|
|
1957
|
+
"minLength": 1,
|
|
1958
|
+
"type": "string"
|
|
1959
|
+
},
|
|
1960
|
+
"copy": {
|
|
1961
|
+
"properties": {
|
|
1962
|
+
"headline": {
|
|
1963
|
+
"maxLength": 200,
|
|
1964
|
+
"minLength": 1,
|
|
1965
|
+
"type": "string"
|
|
1966
|
+
},
|
|
1967
|
+
"intro": {
|
|
1968
|
+
"maxLength": 1000,
|
|
1969
|
+
"type": "string"
|
|
1970
|
+
},
|
|
1971
|
+
"plural": {
|
|
1972
|
+
"maxLength": 40,
|
|
1973
|
+
"minLength": 1,
|
|
1974
|
+
"type": "string"
|
|
1975
|
+
},
|
|
1976
|
+
"subject": {
|
|
1977
|
+
"maxLength": 200,
|
|
1978
|
+
"minLength": 1,
|
|
1979
|
+
"type": "string"
|
|
1980
|
+
}
|
|
1981
|
+
},
|
|
1982
|
+
"required": [
|
|
1983
|
+
"subject",
|
|
1984
|
+
"headline",
|
|
1985
|
+
"intro",
|
|
1986
|
+
"plural"
|
|
1987
|
+
],
|
|
1988
|
+
"type": "object"
|
|
1989
|
+
},
|
|
1990
|
+
"description": {
|
|
1991
|
+
"maxLength": 500,
|
|
1992
|
+
"type": "string"
|
|
1993
|
+
},
|
|
1994
|
+
"family": {
|
|
1995
|
+
"enum": [
|
|
1996
|
+
"past-clients",
|
|
1997
|
+
"agent-partners",
|
|
1998
|
+
"farm-area",
|
|
1999
|
+
"watch-record"
|
|
2000
|
+
],
|
|
2001
|
+
"type": "string"
|
|
2002
|
+
},
|
|
2003
|
+
"featured": {
|
|
2004
|
+
"type": "boolean"
|
|
2005
|
+
},
|
|
2006
|
+
"grants": {
|
|
2007
|
+
"properties": {
|
|
2008
|
+
"agent": {
|
|
2009
|
+
"items": {
|
|
2010
|
+
"enum": [
|
|
2011
|
+
"area_new_listing",
|
|
2012
|
+
"watched_agent_pending",
|
|
2013
|
+
"borrower_listed",
|
|
2014
|
+
"epo_risk",
|
|
2015
|
+
"agent_sale_closed",
|
|
2016
|
+
"rate_term_refi_area",
|
|
2017
|
+
"watched_sale",
|
|
2018
|
+
"watched_property",
|
|
2019
|
+
"watched_loan"
|
|
2020
|
+
],
|
|
2021
|
+
"type": "string"
|
|
2022
|
+
},
|
|
2023
|
+
"type": "array"
|
|
2024
|
+
},
|
|
2025
|
+
"area": {
|
|
2026
|
+
"items": {
|
|
2027
|
+
"enum": [
|
|
2028
|
+
"area_new_listing",
|
|
2029
|
+
"watched_agent_pending",
|
|
2030
|
+
"borrower_listed",
|
|
2031
|
+
"epo_risk",
|
|
2032
|
+
"agent_sale_closed",
|
|
2033
|
+
"rate_term_refi_area",
|
|
2034
|
+
"watched_sale",
|
|
2035
|
+
"watched_property",
|
|
2036
|
+
"watched_loan"
|
|
2037
|
+
],
|
|
2038
|
+
"type": "string"
|
|
2039
|
+
},
|
|
2040
|
+
"type": "array"
|
|
2041
|
+
},
|
|
2042
|
+
"document": {
|
|
2043
|
+
"properties": {
|
|
2044
|
+
"loan": {
|
|
2045
|
+
"items": {
|
|
2046
|
+
"properties": {
|
|
2047
|
+
"match": {
|
|
2048
|
+
"enum": [
|
|
2049
|
+
"all",
|
|
2050
|
+
"any"
|
|
2051
|
+
],
|
|
2052
|
+
"type": "string"
|
|
2053
|
+
},
|
|
2054
|
+
"predicates": {
|
|
2055
|
+
"items": {
|
|
2056
|
+
"properties": {
|
|
2057
|
+
"field": {
|
|
2058
|
+
"type": "string"
|
|
2059
|
+
},
|
|
2060
|
+
"op": {
|
|
2061
|
+
"enum": [
|
|
2062
|
+
"gt",
|
|
2063
|
+
"gte",
|
|
2064
|
+
"lt",
|
|
2065
|
+
"lte",
|
|
2066
|
+
"eq",
|
|
2067
|
+
"between",
|
|
2068
|
+
"pct_change_gte",
|
|
2069
|
+
"abs_change_gte",
|
|
2070
|
+
"changed",
|
|
2071
|
+
"changed_to"
|
|
2072
|
+
],
|
|
2073
|
+
"type": "string"
|
|
2074
|
+
},
|
|
2075
|
+
"stringValue": {
|
|
2076
|
+
"type": "string"
|
|
2077
|
+
},
|
|
2078
|
+
"value": {
|
|
2079
|
+
"type": "number"
|
|
2080
|
+
},
|
|
2081
|
+
"value2": {
|
|
2082
|
+
"type": "number"
|
|
2083
|
+
}
|
|
2084
|
+
},
|
|
2085
|
+
"required": [
|
|
2086
|
+
"field",
|
|
2087
|
+
"op"
|
|
2088
|
+
],
|
|
2089
|
+
"type": "object"
|
|
2090
|
+
},
|
|
2091
|
+
"minItems": 1,
|
|
2092
|
+
"type": "array"
|
|
2093
|
+
}
|
|
2094
|
+
},
|
|
2095
|
+
"required": [
|
|
2096
|
+
"predicates"
|
|
2097
|
+
],
|
|
2098
|
+
"type": "object"
|
|
2099
|
+
},
|
|
2100
|
+
"type": "array"
|
|
2101
|
+
},
|
|
2102
|
+
"property": {
|
|
2103
|
+
"items": {
|
|
2104
|
+
"properties": {
|
|
2105
|
+
"match": {
|
|
2106
|
+
"enum": [
|
|
2107
|
+
"all",
|
|
2108
|
+
"any"
|
|
2109
|
+
],
|
|
2110
|
+
"type": "string"
|
|
2111
|
+
},
|
|
2112
|
+
"predicates": {
|
|
2113
|
+
"items": {
|
|
2114
|
+
"properties": {
|
|
2115
|
+
"field": {
|
|
2116
|
+
"type": "string"
|
|
2117
|
+
},
|
|
2118
|
+
"op": {
|
|
2119
|
+
"enum": [
|
|
2120
|
+
"gt",
|
|
2121
|
+
"gte",
|
|
2122
|
+
"lt",
|
|
2123
|
+
"lte",
|
|
2124
|
+
"eq",
|
|
2125
|
+
"between",
|
|
2126
|
+
"pct_change_gte",
|
|
2127
|
+
"abs_change_gte",
|
|
2128
|
+
"changed",
|
|
2129
|
+
"changed_to"
|
|
2130
|
+
],
|
|
2131
|
+
"type": "string"
|
|
2132
|
+
},
|
|
2133
|
+
"stringValue": {
|
|
2134
|
+
"type": "string"
|
|
2135
|
+
},
|
|
2136
|
+
"value": {
|
|
2137
|
+
"type": "number"
|
|
2138
|
+
},
|
|
2139
|
+
"value2": {
|
|
2140
|
+
"type": "number"
|
|
2141
|
+
}
|
|
2142
|
+
},
|
|
2143
|
+
"required": [
|
|
2144
|
+
"field",
|
|
2145
|
+
"op"
|
|
2146
|
+
],
|
|
2147
|
+
"type": "object"
|
|
2148
|
+
},
|
|
2149
|
+
"minItems": 1,
|
|
2150
|
+
"type": "array"
|
|
2151
|
+
}
|
|
2152
|
+
},
|
|
2153
|
+
"required": [
|
|
2154
|
+
"predicates"
|
|
2155
|
+
],
|
|
2156
|
+
"type": "object"
|
|
2157
|
+
},
|
|
2158
|
+
"type": "array"
|
|
2159
|
+
},
|
|
2160
|
+
"sale": {
|
|
2161
|
+
"items": {
|
|
2162
|
+
"properties": {
|
|
2163
|
+
"match": {
|
|
2164
|
+
"enum": [
|
|
2165
|
+
"all",
|
|
2166
|
+
"any"
|
|
2167
|
+
],
|
|
2168
|
+
"type": "string"
|
|
2169
|
+
},
|
|
2170
|
+
"predicates": {
|
|
2171
|
+
"items": {
|
|
2172
|
+
"properties": {
|
|
2173
|
+
"field": {
|
|
2174
|
+
"type": "string"
|
|
2175
|
+
},
|
|
2176
|
+
"op": {
|
|
2177
|
+
"enum": [
|
|
2178
|
+
"gt",
|
|
2179
|
+
"gte",
|
|
2180
|
+
"lt",
|
|
2181
|
+
"lte",
|
|
2182
|
+
"eq",
|
|
2183
|
+
"between",
|
|
2184
|
+
"pct_change_gte",
|
|
2185
|
+
"abs_change_gte",
|
|
2186
|
+
"changed",
|
|
2187
|
+
"changed_to"
|
|
2188
|
+
],
|
|
2189
|
+
"type": "string"
|
|
2190
|
+
},
|
|
2191
|
+
"stringValue": {
|
|
2192
|
+
"type": "string"
|
|
2193
|
+
},
|
|
2194
|
+
"value": {
|
|
2195
|
+
"type": "number"
|
|
2196
|
+
},
|
|
2197
|
+
"value2": {
|
|
2198
|
+
"type": "number"
|
|
2199
|
+
}
|
|
2200
|
+
},
|
|
2201
|
+
"required": [
|
|
2202
|
+
"field",
|
|
2203
|
+
"op"
|
|
2204
|
+
],
|
|
2205
|
+
"type": "object"
|
|
2206
|
+
},
|
|
2207
|
+
"minItems": 1,
|
|
2208
|
+
"type": "array"
|
|
2209
|
+
}
|
|
2210
|
+
},
|
|
2211
|
+
"required": [
|
|
2212
|
+
"predicates"
|
|
2213
|
+
],
|
|
2214
|
+
"type": "object"
|
|
2215
|
+
},
|
|
2216
|
+
"type": "array"
|
|
2217
|
+
}
|
|
2218
|
+
},
|
|
2219
|
+
"type": "object"
|
|
2220
|
+
},
|
|
2221
|
+
"nmls": {
|
|
2222
|
+
"items": {
|
|
2223
|
+
"enum": [
|
|
2224
|
+
"area_new_listing",
|
|
2225
|
+
"watched_agent_pending",
|
|
2226
|
+
"borrower_listed",
|
|
2227
|
+
"epo_risk",
|
|
2228
|
+
"agent_sale_closed",
|
|
2229
|
+
"rate_term_refi_area",
|
|
2230
|
+
"watched_sale",
|
|
2231
|
+
"watched_property",
|
|
2232
|
+
"watched_loan"
|
|
2233
|
+
],
|
|
2234
|
+
"type": "string"
|
|
2235
|
+
},
|
|
2236
|
+
"type": "array"
|
|
2237
|
+
}
|
|
2238
|
+
},
|
|
2239
|
+
"type": "object"
|
|
2240
|
+
},
|
|
2241
|
+
"howItWorks": {
|
|
2242
|
+
"maxLength": 2000,
|
|
2243
|
+
"type": "string"
|
|
2244
|
+
},
|
|
2245
|
+
"icon": {
|
|
2246
|
+
"type": "string"
|
|
2247
|
+
},
|
|
2248
|
+
"inputs": {
|
|
2249
|
+
"items": {
|
|
2250
|
+
"properties": {
|
|
2251
|
+
"documentType": {
|
|
2252
|
+
"enum": [
|
|
2253
|
+
"sale",
|
|
2254
|
+
"property",
|
|
2255
|
+
"loan"
|
|
2256
|
+
],
|
|
2257
|
+
"type": "string"
|
|
2258
|
+
},
|
|
2259
|
+
"help": {
|
|
2260
|
+
"maxLength": 400,
|
|
2261
|
+
"type": "string"
|
|
2262
|
+
},
|
|
2263
|
+
"label": {
|
|
2264
|
+
"maxLength": 80,
|
|
2265
|
+
"type": "string"
|
|
2266
|
+
},
|
|
2267
|
+
"max": {
|
|
2268
|
+
"minimum": 1,
|
|
2269
|
+
"type": "integer"
|
|
2270
|
+
},
|
|
2271
|
+
"min": {
|
|
2272
|
+
"minimum": 0,
|
|
2273
|
+
"type": "integer"
|
|
2274
|
+
},
|
|
2275
|
+
"required": {
|
|
2276
|
+
"type": "boolean"
|
|
2277
|
+
},
|
|
2278
|
+
"type": {
|
|
2279
|
+
"enum": [
|
|
2280
|
+
"nmls",
|
|
2281
|
+
"agent",
|
|
2282
|
+
"area",
|
|
2283
|
+
"document"
|
|
2284
|
+
],
|
|
2285
|
+
"type": "string"
|
|
2286
|
+
}
|
|
2287
|
+
},
|
|
2288
|
+
"required": [
|
|
2289
|
+
"type",
|
|
2290
|
+
"required"
|
|
2291
|
+
],
|
|
2292
|
+
"type": "object"
|
|
2293
|
+
},
|
|
2294
|
+
"maxItems": 4,
|
|
2295
|
+
"type": "array"
|
|
2296
|
+
},
|
|
2297
|
+
"maxItemsPerRun": {
|
|
2298
|
+
"maximum": 100,
|
|
2299
|
+
"minimum": 1,
|
|
2300
|
+
"type": "integer"
|
|
2301
|
+
},
|
|
2302
|
+
"sortOrder": {
|
|
2303
|
+
"maximum": 999999,
|
|
2304
|
+
"minimum": 0,
|
|
2305
|
+
"type": "integer"
|
|
2306
|
+
},
|
|
2307
|
+
"title": {
|
|
2308
|
+
"maxLength": 80,
|
|
2309
|
+
"minLength": 1,
|
|
2310
|
+
"type": "string"
|
|
2311
|
+
},
|
|
2312
|
+
"version": {
|
|
2313
|
+
"description": "The version you edited; a stale one answers 409 `version_conflict`.",
|
|
2314
|
+
"minimum": 1,
|
|
2315
|
+
"type": "integer"
|
|
2316
|
+
}
|
|
2317
|
+
},
|
|
2318
|
+
"required": [
|
|
2319
|
+
"title",
|
|
2320
|
+
"description",
|
|
2321
|
+
"icon",
|
|
2322
|
+
"category",
|
|
2323
|
+
"family",
|
|
2324
|
+
"grants",
|
|
2325
|
+
"inputs",
|
|
2326
|
+
"copy",
|
|
2327
|
+
"featured",
|
|
2328
|
+
"sortOrder"
|
|
2329
|
+
],
|
|
2330
|
+
"type": "object"
|
|
2331
|
+
},
|
|
2332
|
+
"AdminResyncAlertRecipeRequest": {
|
|
2333
|
+
"properties": {
|
|
2334
|
+
"rules": {
|
|
2335
|
+
"description": "Also overwrite the rules on record subscriptions carrying the recipe with its current rule templates (replaces rules users entered). Default false: only the granted kinds are rewritten.",
|
|
2336
|
+
"type": "boolean"
|
|
2337
|
+
}
|
|
2338
|
+
},
|
|
2339
|
+
"type": "object"
|
|
2340
|
+
},
|
|
2341
|
+
"AdminResyncAlertRecipeResponse": {
|
|
2342
|
+
"properties": {
|
|
2343
|
+
"data": {
|
|
2344
|
+
"properties": {
|
|
2345
|
+
"deleted": {
|
|
2346
|
+
"description": "NMLS subscriptions left with nothing and removed.",
|
|
2347
|
+
"type": "integer"
|
|
2348
|
+
},
|
|
2349
|
+
"matched": {
|
|
2350
|
+
"description": "Subscriptions carrying the recipe's grant.",
|
|
2351
|
+
"type": "integer"
|
|
2352
|
+
},
|
|
2353
|
+
"revoked": {
|
|
2354
|
+
"description": "Grants dropped because the recipe no longer covers the subject type.",
|
|
2355
|
+
"type": "integer"
|
|
2356
|
+
},
|
|
2357
|
+
"scanned": {
|
|
2358
|
+
"description": "Subscriptions read (all users).",
|
|
2359
|
+
"type": "integer"
|
|
2360
|
+
},
|
|
2361
|
+
"unchanged": {
|
|
2362
|
+
"type": "integer"
|
|
2363
|
+
},
|
|
2364
|
+
"updated": {
|
|
2365
|
+
"description": "Grants (or rules) rewritten.",
|
|
2366
|
+
"type": "integer"
|
|
2367
|
+
}
|
|
2368
|
+
},
|
|
2369
|
+
"required": [
|
|
2370
|
+
"scanned",
|
|
2371
|
+
"matched",
|
|
2372
|
+
"updated",
|
|
2373
|
+
"unchanged",
|
|
2374
|
+
"revoked",
|
|
2375
|
+
"deleted"
|
|
2376
|
+
],
|
|
2377
|
+
"type": "object"
|
|
2378
|
+
}
|
|
2379
|
+
},
|
|
2380
|
+
"required": [
|
|
2381
|
+
"data"
|
|
2382
|
+
],
|
|
2383
|
+
"type": "object"
|
|
2384
|
+
},
|
|
1088
2385
|
"AdminUpdateAlertConditionsRequest": {
|
|
1089
2386
|
"properties": {
|
|
1090
2387
|
"conditions": {
|
|
@@ -2949,10 +4246,14 @@
|
|
|
2949
4246
|
},
|
|
2950
4247
|
"AlertRecipe": {
|
|
2951
4248
|
"properties": {
|
|
4249
|
+
"category": {
|
|
4250
|
+
"type": "string"
|
|
4251
|
+
},
|
|
2952
4252
|
"description": {
|
|
2953
4253
|
"type": "string"
|
|
2954
4254
|
},
|
|
2955
|
-
"
|
|
4255
|
+
"family": {
|
|
4256
|
+
"description": "Notification family (selects the email template).",
|
|
2956
4257
|
"enum": [
|
|
2957
4258
|
"past-clients",
|
|
2958
4259
|
"agent-partners",
|
|
@@ -2961,6 +4262,26 @@
|
|
|
2961
4262
|
],
|
|
2962
4263
|
"type": "string"
|
|
2963
4264
|
},
|
|
4265
|
+
"featured": {
|
|
4266
|
+
"type": "boolean"
|
|
4267
|
+
},
|
|
4268
|
+
"howItWorks": {
|
|
4269
|
+
"type": "string"
|
|
4270
|
+
},
|
|
4271
|
+
"icon": {
|
|
4272
|
+
"description": "hugeicons component name; render with a fallback.",
|
|
4273
|
+
"example": "UserGroupIcon",
|
|
4274
|
+
"type": "string"
|
|
4275
|
+
},
|
|
4276
|
+
"id": {
|
|
4277
|
+
"type": "string"
|
|
4278
|
+
},
|
|
4279
|
+
"inputs": {
|
|
4280
|
+
"items": {
|
|
4281
|
+
"$ref": "#/components/schemas/AlertRecipeInputSpec"
|
|
4282
|
+
},
|
|
4283
|
+
"type": "array"
|
|
4284
|
+
},
|
|
2964
4285
|
"inputsSchema": {
|
|
2965
4286
|
"additionalProperties": {
|
|
2966
4287
|
"nullable": true
|
|
@@ -2969,12 +4290,19 @@
|
|
|
2969
4290
|
"type": "object"
|
|
2970
4291
|
},
|
|
2971
4292
|
"label": {
|
|
4293
|
+
"description": "Same as `title` (kept for compatibility).",
|
|
2972
4294
|
"type": "string"
|
|
2973
4295
|
},
|
|
4296
|
+
"sortOrder": {
|
|
4297
|
+
"type": "integer"
|
|
4298
|
+
},
|
|
2974
4299
|
"subscribed": {
|
|
2975
4300
|
"description": "Whether you are subscribed: at least one of your subscriptions carries this recipe.",
|
|
2976
4301
|
"type": "boolean"
|
|
2977
4302
|
},
|
|
4303
|
+
"title": {
|
|
4304
|
+
"type": "string"
|
|
4305
|
+
},
|
|
2978
4306
|
"types": {
|
|
2979
4307
|
"description": "The alert triggers this recipe turns on.",
|
|
2980
4308
|
"items": {
|
|
@@ -2996,18 +4324,107 @@
|
|
|
2996
4324
|
},
|
|
2997
4325
|
"required": [
|
|
2998
4326
|
"id",
|
|
4327
|
+
"title",
|
|
2999
4328
|
"label",
|
|
3000
4329
|
"description",
|
|
4330
|
+
"icon",
|
|
4331
|
+
"category",
|
|
4332
|
+
"family",
|
|
3001
4333
|
"types",
|
|
4334
|
+
"inputs",
|
|
3002
4335
|
"inputsSchema",
|
|
4336
|
+
"featured",
|
|
4337
|
+
"sortOrder",
|
|
3003
4338
|
"subscribed"
|
|
3004
4339
|
],
|
|
3005
4340
|
"type": "object"
|
|
3006
4341
|
},
|
|
4342
|
+
"AlertRecipeError": {
|
|
4343
|
+
"properties": {
|
|
4344
|
+
"code": {
|
|
4345
|
+
"description": "Machine-readable reason (absent on a generic validation error).",
|
|
4346
|
+
"enum": [
|
|
4347
|
+
"unknown_recipe",
|
|
4348
|
+
"recipe_archived",
|
|
4349
|
+
"invalid_recipe",
|
|
4350
|
+
"invalid_recipe_id",
|
|
4351
|
+
"invalid_icon",
|
|
4352
|
+
"invalid_kind",
|
|
4353
|
+
"kind_not_allowed_for_subject",
|
|
4354
|
+
"unknown_field",
|
|
4355
|
+
"invalid_rule",
|
|
4356
|
+
"rule_edge_op_on_event_kind",
|
|
4357
|
+
"grants_empty",
|
|
4358
|
+
"family_mismatch",
|
|
4359
|
+
"inputs_mismatch",
|
|
4360
|
+
"invalid_inputs",
|
|
4361
|
+
"rules_required",
|
|
4362
|
+
"recipe_exists",
|
|
4363
|
+
"recipe_in_use",
|
|
4364
|
+
"version_conflict"
|
|
4365
|
+
],
|
|
4366
|
+
"type": "string"
|
|
4367
|
+
},
|
|
4368
|
+
"error": {
|
|
4369
|
+
"description": "Error message",
|
|
4370
|
+
"type": "string"
|
|
4371
|
+
}
|
|
4372
|
+
},
|
|
4373
|
+
"required": [
|
|
4374
|
+
"error"
|
|
4375
|
+
],
|
|
4376
|
+
"type": "object"
|
|
4377
|
+
},
|
|
4378
|
+
"AlertRecipeInputSpec": {
|
|
4379
|
+
"description": "One input the subscribe form asks for. `type` maps to body fields: nmls → nmlsId, agent → agents, area → areas, document → documentType + documentId + rules.",
|
|
4380
|
+
"properties": {
|
|
4381
|
+
"documentType": {
|
|
4382
|
+
"enum": [
|
|
4383
|
+
"sale",
|
|
4384
|
+
"property",
|
|
4385
|
+
"loan"
|
|
4386
|
+
],
|
|
4387
|
+
"type": "string"
|
|
4388
|
+
},
|
|
4389
|
+
"help": {
|
|
4390
|
+
"maxLength": 400,
|
|
4391
|
+
"type": "string"
|
|
4392
|
+
},
|
|
4393
|
+
"label": {
|
|
4394
|
+
"maxLength": 80,
|
|
4395
|
+
"type": "string"
|
|
4396
|
+
},
|
|
4397
|
+
"max": {
|
|
4398
|
+
"minimum": 1,
|
|
4399
|
+
"type": "integer"
|
|
4400
|
+
},
|
|
4401
|
+
"min": {
|
|
4402
|
+
"minimum": 0,
|
|
4403
|
+
"type": "integer"
|
|
4404
|
+
},
|
|
4405
|
+
"required": {
|
|
4406
|
+
"type": "boolean"
|
|
4407
|
+
},
|
|
4408
|
+
"type": {
|
|
4409
|
+
"enum": [
|
|
4410
|
+
"nmls",
|
|
4411
|
+
"agent",
|
|
4412
|
+
"area",
|
|
4413
|
+
"document"
|
|
4414
|
+
],
|
|
4415
|
+
"type": "string"
|
|
4416
|
+
}
|
|
4417
|
+
},
|
|
4418
|
+
"required": [
|
|
4419
|
+
"type",
|
|
4420
|
+
"required"
|
|
4421
|
+
],
|
|
4422
|
+
"type": "object"
|
|
4423
|
+
},
|
|
3007
4424
|
"AlertRecipeInputs": {
|
|
3008
4425
|
"properties": {
|
|
3009
4426
|
"agents": {
|
|
3010
|
-
"description": "`agent
|
|
4427
|
+
"description": "Recipes with an `agent` input: the agents.",
|
|
3011
4428
|
"items": {
|
|
3012
4429
|
"properties": {
|
|
3013
4430
|
"agentMmaId": {
|
|
@@ -3025,7 +4442,7 @@
|
|
|
3025
4442
|
"type": "array"
|
|
3026
4443
|
},
|
|
3027
4444
|
"areas": {
|
|
3028
|
-
"description": "`
|
|
4445
|
+
"description": "Recipes with an `area` input: the areas.",
|
|
3029
4446
|
"items": {
|
|
3030
4447
|
"$ref": "#/components/schemas/AddWatchedAreaRequest"
|
|
3031
4448
|
},
|
|
@@ -3033,12 +4450,12 @@
|
|
|
3033
4450
|
"type": "array"
|
|
3034
4451
|
},
|
|
3035
4452
|
"documentId": {
|
|
3036
|
-
"description": "`
|
|
4453
|
+
"description": "Recipes with a `document` input: the record id.",
|
|
3037
4454
|
"minLength": 1,
|
|
3038
4455
|
"type": "string"
|
|
3039
4456
|
},
|
|
3040
4457
|
"documentType": {
|
|
3041
|
-
"description": "`
|
|
4458
|
+
"description": "Recipes with a `document` input: the record type.",
|
|
3042
4459
|
"enum": [
|
|
3043
4460
|
"sale",
|
|
3044
4461
|
"property",
|
|
@@ -3048,11 +4465,11 @@
|
|
|
3048
4465
|
"type": "string"
|
|
3049
4466
|
},
|
|
3050
4467
|
"nmlsId": {
|
|
3051
|
-
"description": "`
|
|
4468
|
+
"description": "Recipes with an `nmls` input: the loan officer's NMLS id.",
|
|
3052
4469
|
"type": "string"
|
|
3053
4470
|
},
|
|
3054
4471
|
"rules": {
|
|
3055
|
-
"description": "`
|
|
4472
|
+
"description": "Recipes with a `document` input: what change to watch for. Empty or omitted applies the recipe's rule templates for the record type.",
|
|
3056
4473
|
"items": {
|
|
3057
4474
|
"properties": {
|
|
3058
4475
|
"match": {
|
|
@@ -3410,15 +4827,7 @@
|
|
|
3410
4827
|
"type": "array"
|
|
3411
4828
|
},
|
|
3412
4829
|
"recipeId": {
|
|
3413
|
-
"description": "Why the kinds are on: a recipe, `custom` (set directly), or `migration`.",
|
|
3414
|
-
"enum": [
|
|
3415
|
-
"past-clients",
|
|
3416
|
-
"agent-partners",
|
|
3417
|
-
"farm-area",
|
|
3418
|
-
"watch-record",
|
|
3419
|
-
"custom",
|
|
3420
|
-
"migration"
|
|
3421
|
-
],
|
|
4830
|
+
"description": "Why the kinds are on: a recipe id (see GET /alerts/recipes), `custom` (set directly), or `migration`.",
|
|
3422
4831
|
"type": "string"
|
|
3423
4832
|
}
|
|
3424
4833
|
},
|
|
@@ -26209,6 +27618,9 @@
|
|
|
26209
27618
|
],
|
|
26210
27619
|
"type": "string"
|
|
26211
27620
|
},
|
|
27621
|
+
"msa": {
|
|
27622
|
+
"$ref": "#/components/schemas/OriginatorMsaFilterValue"
|
|
27623
|
+
},
|
|
26212
27624
|
"name": {
|
|
26213
27625
|
"allOf": [
|
|
26214
27626
|
{
|
|
@@ -26312,6 +27724,9 @@
|
|
|
26312
27724
|
"producersOnly": {
|
|
26313
27725
|
"$ref": "#/components/schemas/BooleanFilterValue"
|
|
26314
27726
|
},
|
|
27727
|
+
"region": {
|
|
27728
|
+
"$ref": "#/components/schemas/OriginatorRegionFilterValue"
|
|
27729
|
+
},
|
|
26315
27730
|
"regulators": {
|
|
26316
27731
|
"$ref": "#/components/schemas/TextFilterValue"
|
|
26317
27732
|
},
|
|
@@ -26655,6 +28070,9 @@
|
|
|
26655
28070
|
"productMix": {
|
|
26656
28071
|
"$ref": "#/components/schemas/OriginatorProductMixFilter"
|
|
26657
28072
|
},
|
|
28073
|
+
"productionGeoPoint": {
|
|
28074
|
+
"$ref": "#/components/schemas/OriginatorProductionGeoPoint"
|
|
28075
|
+
},
|
|
26658
28076
|
"sort": {
|
|
26659
28077
|
"items": {
|
|
26660
28078
|
"properties": {
|
|
@@ -27322,6 +28740,25 @@
|
|
|
27322
28740
|
],
|
|
27323
28741
|
"type": "object"
|
|
27324
28742
|
},
|
|
28743
|
+
"OriginatorMsaFilterValue": {
|
|
28744
|
+
"anyOf": [
|
|
28745
|
+
{
|
|
28746
|
+
"type": "string"
|
|
28747
|
+
},
|
|
28748
|
+
{
|
|
28749
|
+
"items": {
|
|
28750
|
+
"type": "string"
|
|
28751
|
+
},
|
|
28752
|
+
"maxItems": 50,
|
|
28753
|
+
"minItems": 1,
|
|
28754
|
+
"type": "array"
|
|
28755
|
+
},
|
|
28756
|
+
{
|
|
28757
|
+
"nullable": true
|
|
28758
|
+
}
|
|
28759
|
+
],
|
|
28760
|
+
"description": "Production METRO AREA (MSA / CBSA): originators who originated loans in ANY county of the metro during the selected period (not office). 5-digit CBSA code (`12420`) or metro name (`Austin Metro`); an array matches any. Top-50 metros use the Model Match app's county lists, the rest OMB 2023. Unknown/ambiguous names are a 400 naming candidates."
|
|
28761
|
+
},
|
|
27325
28762
|
"OriginatorOfficeGeoPoint": {
|
|
27326
28763
|
"additionalProperties": false,
|
|
27327
28764
|
"description": "Originators whose NMLS-registered OFFICE is within `radiusMiles` of an anchor — the radius form of `officeState` / `officeCity` / `officeZip`, NOT production geography (that is `state` / `city` / `county` / `zip` / `footprint`). Anchor on a coordinate (`{lat, lon, radiusMiles}`) or on another originator's office (`{nmlsId: \"7206\", radiusMiles: 25}` — 'LOs near this LO'; that originator is excluded). Originators with no geocoded office never match. 400 when neither anchor form is complete or both are given; 404 `office_geo_anchor_not_found` for an unknown `nmlsId`; 400 `office_geo_anchor_unlocated` when that originator has no geocoded office.",
|
|
@@ -27430,6 +28867,34 @@
|
|
|
27430
28867
|
"minItems": 1,
|
|
27431
28868
|
"type": "array"
|
|
27432
28869
|
},
|
|
28870
|
+
"OriginatorProductionGeoPoint": {
|
|
28871
|
+
"additionalProperties": false,
|
|
28872
|
+
"description": "Production RADIUS (statute miles, 0 < r ≤ 500): originators who originated loans within the radius of the point during the selected period — where they PRODUCE, not their office. COUNTY-LEVEL APPROXIMATION: counties whose Census centroid lies within the radius (always including the nearest) are in with all their loans; a large county whose centroid is outside is out even where its border is close. Coarser than a true radius, especially under ~25 mi. Pair with `sort: [{ field: \"scopedVolume\" }]` to rank by production inside those counties.",
|
|
28873
|
+
"properties": {
|
|
28874
|
+
"lat": {
|
|
28875
|
+
"maximum": 90,
|
|
28876
|
+
"minimum": -90,
|
|
28877
|
+
"type": "number"
|
|
28878
|
+
},
|
|
28879
|
+
"lon": {
|
|
28880
|
+
"maximum": 180,
|
|
28881
|
+
"minimum": -180,
|
|
28882
|
+
"type": "number"
|
|
28883
|
+
},
|
|
28884
|
+
"radiusMiles": {
|
|
28885
|
+
"exclusiveMinimum": true,
|
|
28886
|
+
"maximum": 500,
|
|
28887
|
+
"minimum": 0,
|
|
28888
|
+
"type": "number"
|
|
28889
|
+
}
|
|
28890
|
+
},
|
|
28891
|
+
"required": [
|
|
28892
|
+
"lat",
|
|
28893
|
+
"lon",
|
|
28894
|
+
"radiusMiles"
|
|
28895
|
+
],
|
|
28896
|
+
"type": "object"
|
|
28897
|
+
},
|
|
27433
28898
|
"OriginatorProfileInsights": {
|
|
27434
28899
|
"description": "Profile read-outs computed server-side from the LO's production in the requested `period` (default `last12Months`) — the same `volume` / `units` this response reports. Labels and descriptions are display copy; branch on the enum fields.",
|
|
27435
28900
|
"properties": {
|
|
@@ -27465,6 +28930,55 @@
|
|
|
27465
28930
|
],
|
|
27466
28931
|
"type": "object"
|
|
27467
28932
|
},
|
|
28933
|
+
"OriginatorRegionFilterValue": {
|
|
28934
|
+
"anyOf": [
|
|
28935
|
+
{
|
|
28936
|
+
"enum": [
|
|
28937
|
+
"northeast",
|
|
28938
|
+
"northeast-division-1",
|
|
28939
|
+
"northeast-division-2",
|
|
28940
|
+
"midwest",
|
|
28941
|
+
"midwest-division-3",
|
|
28942
|
+
"midwest-division-4",
|
|
28943
|
+
"south",
|
|
28944
|
+
"south-division-5",
|
|
28945
|
+
"south-division-6",
|
|
28946
|
+
"south-division-7",
|
|
28947
|
+
"west",
|
|
28948
|
+
"west-division-8",
|
|
28949
|
+
"west-division-9"
|
|
28950
|
+
],
|
|
28951
|
+
"type": "string"
|
|
28952
|
+
},
|
|
28953
|
+
{
|
|
28954
|
+
"items": {
|
|
28955
|
+
"enum": [
|
|
28956
|
+
"northeast",
|
|
28957
|
+
"northeast-division-1",
|
|
28958
|
+
"northeast-division-2",
|
|
28959
|
+
"midwest",
|
|
28960
|
+
"midwest-division-3",
|
|
28961
|
+
"midwest-division-4",
|
|
28962
|
+
"south",
|
|
28963
|
+
"south-division-5",
|
|
28964
|
+
"south-division-6",
|
|
28965
|
+
"south-division-7",
|
|
28966
|
+
"west",
|
|
28967
|
+
"west-division-8",
|
|
28968
|
+
"west-division-9"
|
|
28969
|
+
],
|
|
28970
|
+
"type": "string"
|
|
28971
|
+
},
|
|
28972
|
+
"maxItems": 50,
|
|
28973
|
+
"minItems": 1,
|
|
28974
|
+
"type": "array"
|
|
28975
|
+
},
|
|
28976
|
+
{
|
|
28977
|
+
"nullable": true
|
|
28978
|
+
}
|
|
28979
|
+
],
|
|
28980
|
+
"description": "Production CENSUS REGION / DIVISION (`<region>-division-<n>`, Census numbering 1–9): originators who originated loans in ANY state of it during the selected period (not office). An array matches any."
|
|
28981
|
+
},
|
|
27468
28982
|
"OriginatorRegistration": {
|
|
27469
28983
|
"nullable": true,
|
|
27470
28984
|
"properties": {
|
|
@@ -33741,7 +35255,7 @@
|
|
|
33741
35255
|
"info": {
|
|
33742
35256
|
"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.",
|
|
33743
35257
|
"title": "ModelMatch API",
|
|
33744
|
-
"version": "3.
|
|
35258
|
+
"version": "3.69.0"
|
|
33745
35259
|
},
|
|
33746
35260
|
"openapi": "3.1.0",
|
|
33747
35261
|
"paths": {
|
|
@@ -36584,7 +38098,7 @@
|
|
|
36584
38098
|
},
|
|
36585
38099
|
"/v1/alerts/recipes": {
|
|
36586
38100
|
"get": {
|
|
36587
|
-
"description": "The alert recipes — named bundles of alert triggers — with the inputs each needs and whether you are subscribed.",
|
|
38101
|
+
"description": "The published alert recipes — named bundles of alert triggers — with the inputs each needs and whether you are subscribed.",
|
|
36588
38102
|
"operationId": "listAlertRecipes",
|
|
36589
38103
|
"responses": {
|
|
36590
38104
|
"200": {
|
|
@@ -36660,18 +38174,12 @@
|
|
|
36660
38174
|
"operationId": "unsubscribeAlertRecipe",
|
|
36661
38175
|
"parameters": [
|
|
36662
38176
|
{
|
|
36663
|
-
"description": "Recipe id.",
|
|
38177
|
+
"description": "Recipe id (from GET /alerts/recipes).",
|
|
36664
38178
|
"in": "path",
|
|
36665
38179
|
"name": "id",
|
|
36666
38180
|
"required": true,
|
|
36667
38181
|
"schema": {
|
|
36668
|
-
"description": "Recipe id.",
|
|
36669
|
-
"enum": [
|
|
36670
|
-
"past-clients",
|
|
36671
|
-
"agent-partners",
|
|
36672
|
-
"farm-area",
|
|
36673
|
-
"watch-record"
|
|
36674
|
-
],
|
|
38182
|
+
"description": "Recipe id (from GET /alerts/recipes).",
|
|
36675
38183
|
"example": "farm-area",
|
|
36676
38184
|
"type": "string"
|
|
36677
38185
|
}
|
|
@@ -36692,11 +38200,11 @@
|
|
|
36692
38200
|
"content": {
|
|
36693
38201
|
"application/json": {
|
|
36694
38202
|
"schema": {
|
|
36695
|
-
"$ref": "#/components/schemas/
|
|
38203
|
+
"$ref": "#/components/schemas/AlertRecipeError"
|
|
36696
38204
|
}
|
|
36697
38205
|
}
|
|
36698
38206
|
},
|
|
36699
|
-
"description": "
|
|
38207
|
+
"description": "Invalid request (see `code`: `unknown_recipe`, `recipe_archived`, `invalid_inputs`, `rules_required`, `unknown_field`, `invalid_rule`)"
|
|
36700
38208
|
},
|
|
36701
38209
|
"401": {
|
|
36702
38210
|
"content": {
|
|
@@ -36745,22 +38253,16 @@
|
|
|
36745
38253
|
]
|
|
36746
38254
|
},
|
|
36747
38255
|
"post": {
|
|
36748
|
-
"description": "Turns on the recipe's alert triggers, saves its inputs (NMLS id, agents, areas or a record), and backfills recent matches. For
|
|
38256
|
+
"description": "Turns on the recipe's alert triggers, saves its inputs (NMLS id, agents, areas or a record — see the recipe's `inputs`), and backfills recent matches. For a record input, empty rules apply the recipe's rule templates for the record type.",
|
|
36749
38257
|
"operationId": "subscribeAlertRecipe",
|
|
36750
38258
|
"parameters": [
|
|
36751
38259
|
{
|
|
36752
|
-
"description": "Recipe id.",
|
|
38260
|
+
"description": "Recipe id (from GET /alerts/recipes).",
|
|
36753
38261
|
"in": "path",
|
|
36754
38262
|
"name": "id",
|
|
36755
38263
|
"required": true,
|
|
36756
38264
|
"schema": {
|
|
36757
|
-
"description": "Recipe id.",
|
|
36758
|
-
"enum": [
|
|
36759
|
-
"past-clients",
|
|
36760
|
-
"agent-partners",
|
|
36761
|
-
"farm-area",
|
|
36762
|
-
"watch-record"
|
|
36763
|
-
],
|
|
38265
|
+
"description": "Recipe id (from GET /alerts/recipes).",
|
|
36764
38266
|
"example": "farm-area",
|
|
36765
38267
|
"type": "string"
|
|
36766
38268
|
}
|
|
@@ -36791,11 +38293,11 @@
|
|
|
36791
38293
|
"content": {
|
|
36792
38294
|
"application/json": {
|
|
36793
38295
|
"schema": {
|
|
36794
|
-
"$ref": "#/components/schemas/
|
|
38296
|
+
"$ref": "#/components/schemas/AlertRecipeError"
|
|
36795
38297
|
}
|
|
36796
38298
|
}
|
|
36797
38299
|
},
|
|
36798
|
-
"description": "
|
|
38300
|
+
"description": "Invalid request (see `code`: `unknown_recipe`, `recipe_archived`, `invalid_inputs`, `rules_required`, `unknown_field`, `invalid_rule`)"
|
|
36799
38301
|
},
|
|
36800
38302
|
"401": {
|
|
36801
38303
|
"content": {
|
|
@@ -36850,18 +38352,12 @@
|
|
|
36850
38352
|
"operationId": "previewAlertRecipe",
|
|
36851
38353
|
"parameters": [
|
|
36852
38354
|
{
|
|
36853
|
-
"description": "Recipe id.",
|
|
38355
|
+
"description": "Recipe id (from GET /alerts/recipes).",
|
|
36854
38356
|
"in": "path",
|
|
36855
38357
|
"name": "id",
|
|
36856
38358
|
"required": true,
|
|
36857
38359
|
"schema": {
|
|
36858
|
-
"description": "Recipe id.",
|
|
36859
|
-
"enum": [
|
|
36860
|
-
"past-clients",
|
|
36861
|
-
"agent-partners",
|
|
36862
|
-
"farm-area",
|
|
36863
|
-
"watch-record"
|
|
36864
|
-
],
|
|
38360
|
+
"description": "Recipe id (from GET /alerts/recipes).",
|
|
36865
38361
|
"example": "farm-area",
|
|
36866
38362
|
"type": "string"
|
|
36867
38363
|
}
|
|
@@ -36892,11 +38388,11 @@
|
|
|
36892
38388
|
"content": {
|
|
36893
38389
|
"application/json": {
|
|
36894
38390
|
"schema": {
|
|
36895
|
-
"$ref": "#/components/schemas/
|
|
38391
|
+
"$ref": "#/components/schemas/AlertRecipeError"
|
|
36896
38392
|
}
|
|
36897
38393
|
}
|
|
36898
38394
|
},
|
|
36899
|
-
"description": "
|
|
38395
|
+
"description": "Invalid request (see `code`: `unknown_recipe`, `recipe_archived`, `invalid_inputs`, `rules_required`, `unknown_field`, `invalid_rule`)"
|
|
36900
38396
|
},
|
|
36901
38397
|
"401": {
|
|
36902
38398
|
"content": {
|