@epilot/customer-portal-client 0.13.1 → 0.15.0-alpha

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/openapi.d.ts CHANGED
@@ -99,16 +99,18 @@ declare namespace Components {
99
99
  * john@doe.com
100
100
  */
101
101
  "cognito:username"?: string;
102
- /**
102
+ "custom:portal_user_id"?: /**
103
+ * Entity ID
103
104
  * example:
104
- * 06c78f9d-af75-4483-893d-a3fad524400f
105
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
105
106
  */
106
- "custom:portal_user_id"?: string;
107
- /**
107
+ EntityId /* uuid */;
108
+ "custom:contact_entity_id"?: /**
109
+ * Entity ID
108
110
  * example:
109
- * 7579d22f-9400-41d1-b460-04730239ee91
111
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
110
112
  */
111
- "custom:contact_entity_id"?: string;
113
+ EntityId /* uuid */;
112
114
  };
113
115
  };
114
116
  }
@@ -155,7 +157,12 @@ declare namespace Components {
155
157
  payload?: {
156
158
  [name: string]: any;
157
159
  entity?: {
158
- id?: string;
160
+ id?: /**
161
+ * Entity ID
162
+ * example:
163
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
164
+ */
165
+ EntityId /* uuid */;
159
166
  schema?: string;
160
167
  };
161
168
  caller?: ActivityCallerContext;
@@ -246,7 +253,7 @@ declare namespace Components {
246
253
  * example:
247
254
  * 5da0a718-c822-403d-9f5d-20d4584e0528
248
255
  */
249
- EntityId;
256
+ EntityId /* uuid */;
250
257
  /**
251
258
  * Title of the entity
252
259
  * example:
@@ -326,7 +333,7 @@ declare namespace Components {
326
333
  * example:
327
334
  * 5da0a718-c822-403d-9f5d-20d4584e0528
328
335
  */
329
- EntityId;
336
+ EntityId /* uuid */;
330
337
  /**
331
338
  * Title of the entity
332
339
  * example:
@@ -382,7 +389,7 @@ declare namespace Components {
382
389
  * example:
383
390
  * 5da0a718-c822-403d-9f5d-20d4584e0528
384
391
  */
385
- EntityId;
392
+ EntityId /* uuid */;
386
393
  /**
387
394
  * Title of the entity
388
395
  * example:
@@ -484,7 +491,7 @@ declare namespace Components {
484
491
  * example:
485
492
  * 5da0a718-c822-403d-9f5d-20d4584e0528
486
493
  */
487
- EntityId;
494
+ EntityId /* uuid */;
488
495
  /**
489
496
  * Title of the entity
490
497
  * example:
@@ -708,12 +715,12 @@ declare namespace Components {
708
715
  contactIdentifiers?: {
709
716
  [name: string]: string;
710
717
  };
711
- /**
712
- * ID of the contact
718
+ contactId?: /**
719
+ * Entity ID
713
720
  * example:
714
- * 123456
721
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
715
722
  */
716
- contactId?: string;
723
+ EntityId /* uuid */;
717
724
  /**
718
725
  * Identifier-value pairs per schema to identify a contact of a portal user during the resgistration
719
726
  * example:
@@ -739,12 +746,12 @@ declare namespace Components {
739
746
  */
740
747
  export type Currency = string;
741
748
  export interface DeleteEntityFile {
742
- /**
749
+ entity_id: /**
743
750
  * Entity ID
744
751
  * example:
745
- * 123456
752
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
746
753
  */
747
- entity_id: string;
754
+ EntityId /* uuid */;
748
755
  /**
749
756
  * Entity type
750
757
  * example:
@@ -754,7 +761,12 @@ declare namespace Components {
754
761
  /**
755
762
  * Array of file entity IDs
756
763
  */
757
- file_entity_ids: string[];
764
+ file_entity_ids: /**
765
+ * Entity ID
766
+ * example:
767
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
768
+ */
769
+ EntityId /* uuid */[];
758
770
  }
759
771
  export interface DocumentWidget {
760
772
  id: string;
@@ -778,40 +790,58 @@ declare namespace Components {
778
790
  export interface EmailTemplates {
779
791
  /**
780
792
  * ID of the confirmation email template upon registration
793
+ */
794
+ confirmAccount?: /**
795
+ * Entity ID
781
796
  * example:
782
- * 701f089d-6953-48b5-ac35-442de7c59cd3
797
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
783
798
  */
784
- confirmAccount?: string;
799
+ EntityId /* uuid */;
785
800
  /**
786
801
  * ID of the email template for forgot password
802
+ */
803
+ forgotPassword?: /**
804
+ * Entity ID
787
805
  * example:
788
- * 6538fddb-f0e9-4f0f-af51-6e57891ff20a
806
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
789
807
  */
790
- forgotPassword?: string;
808
+ EntityId /* uuid */;
791
809
  /**
792
810
  * ID of the email template for invitation
811
+ */
812
+ invitation?: /**
813
+ * Entity ID
793
814
  * example:
794
- * 14ae65fb-0dc1-4863-8743-6bc01da469f6
815
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
795
816
  */
796
- invitation?: string;
817
+ EntityId /* uuid */;
797
818
  /**
798
819
  * ID of the email template for new quote
820
+ */
821
+ onNewQuote?: /**
822
+ * Entity ID
799
823
  * example:
800
- * b03e2b88-8f3f-4a93-8118-1fb07e9198a1
824
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
801
825
  */
802
- onNewQuote?: string;
826
+ EntityId /* uuid */;
803
827
  /**
804
828
  * ID of the email template for mapping a pending portal user with a contact
829
+ */
830
+ onMapAPendingUser?: /**
831
+ * Entity ID
805
832
  * example:
806
- * 940134fa-50f2-4204-a08a-fd3afddbf39a
833
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
807
834
  */
808
- onMapAPendingUser?: string;
835
+ EntityId /* uuid */;
809
836
  /**
810
837
  * ID of the email template for document upload
838
+ */
839
+ onDocUpload?: /**
840
+ * Entity ID
811
841
  * example:
812
- * c8ee93c0-8158-4da7-82f3-114f0c7b20ff
842
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
813
843
  */
814
- onDocUpload?: string;
844
+ EntityId /* uuid */;
815
845
  }
816
846
  export interface Entity {
817
847
  [name: string]: any;
@@ -836,10 +866,13 @@ declare namespace Components {
836
866
  export interface EntityFileCount {
837
867
  /**
838
868
  * The ID of the parent entity
869
+ */
870
+ entity_id: /**
871
+ * Entity ID
839
872
  * example:
840
- * d8dffa9a-6c90-4c4e-b8d1-032194b25526
873
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
841
874
  */
842
- entity_id: string;
875
+ EntityId /* uuid */;
843
876
  _schema: /**
844
877
  * URL-friendly identifier for the entity schema
845
878
  * example:
@@ -864,7 +897,7 @@ declare namespace Components {
864
897
  * example:
865
898
  * 5da0a718-c822-403d-9f5d-20d4584e0528
866
899
  */
867
- export type EntityId = string;
900
+ export type EntityId = string; // uuid
868
901
  export interface EntityItem {
869
902
  [name: string]: any;
870
903
  _id: /**
@@ -872,7 +905,7 @@ declare namespace Components {
872
905
  * example:
873
906
  * 5da0a718-c822-403d-9f5d-20d4584e0528
874
907
  */
875
- EntityId;
908
+ EntityId /* uuid */;
876
909
  /**
877
910
  * Title of the entity
878
911
  * example:
@@ -1010,7 +1043,7 @@ declare namespace Components {
1010
1043
  * example:
1011
1044
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1012
1045
  */
1013
- EntityId;
1046
+ EntityId /* uuid */;
1014
1047
  /**
1015
1048
  * Title of the entity
1016
1049
  * example:
@@ -1056,7 +1089,7 @@ declare namespace Components {
1056
1089
  * example:
1057
1090
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1058
1091
  */
1059
- EntityId;
1092
+ EntityId /* uuid */;
1060
1093
  /**
1061
1094
  * Title of the entity
1062
1095
  * example:
@@ -1120,12 +1153,12 @@ declare namespace Components {
1120
1153
  */
1121
1154
  mime_type?: string;
1122
1155
  _relations?: {
1123
- /**
1124
- * The ID of the parent entity
1156
+ entity_id?: /**
1157
+ * Entity ID
1125
1158
  * example:
1126
- * d8dffa9a-6c90-4c4e-b8d1-032194b25526
1159
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
1127
1160
  */
1128
- entity_id?: string;
1161
+ EntityId /* uuid */;
1129
1162
  _schema?: /**
1130
1163
  * URL-friendly identifier for the entity schema
1131
1164
  * example:
@@ -1186,7 +1219,7 @@ declare namespace Components {
1186
1219
  * example:
1187
1220
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1188
1221
  */
1189
- EntityId;
1222
+ EntityId /* uuid */;
1190
1223
  /**
1191
1224
  * Title of the entity
1192
1225
  * example:
@@ -1279,7 +1312,7 @@ declare namespace Components {
1279
1312
  * example:
1280
1313
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1281
1314
  */
1282
- EntityId;
1315
+ EntityId /* uuid */;
1283
1316
  /**
1284
1317
  * Title of the entity
1285
1318
  * example:
@@ -1325,7 +1358,7 @@ declare namespace Components {
1325
1358
  * example:
1326
1359
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1327
1360
  */
1328
- EntityId;
1361
+ EntityId /* uuid */;
1329
1362
  /**
1330
1363
  * Title of the entity
1331
1364
  * example:
@@ -1518,12 +1551,12 @@ declare namespace Components {
1518
1551
  * Mark true if the domain is an Epilot domain
1519
1552
  */
1520
1553
  is_epilot_domain?: boolean;
1521
- /**
1522
- * ID of the design used to build the portal
1554
+ design_id: /**
1555
+ * Entity ID
1523
1556
  * example:
1524
- * 9ba94f20-b872-4217-a259-2a90a8ee1a29
1557
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
1525
1558
  */
1526
- design_id: string;
1559
+ EntityId /* uuid */;
1527
1560
  /**
1528
1561
  * Default 360 user to notify upon an internal notification
1529
1562
  */
@@ -1649,7 +1682,12 @@ declare namespace Components {
1649
1682
  * Journey actions allowed on an entity by a portal user
1650
1683
  */
1651
1684
  entity_actions?: {
1652
- journey_id?: string;
1685
+ journey_id?: /**
1686
+ * Entity ID
1687
+ * example:
1688
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
1689
+ */
1690
+ EntityId /* uuid */;
1653
1691
  slug?: /**
1654
1692
  * URL-friendly identifier for the entity schema
1655
1693
  * example:
@@ -1762,7 +1800,7 @@ declare namespace Components {
1762
1800
  * example:
1763
1801
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1764
1802
  */
1765
- EntityId;
1803
+ EntityId /* uuid */;
1766
1804
  /**
1767
1805
  * Title of the entity
1768
1806
  * example:
@@ -1809,7 +1847,7 @@ declare namespace Components {
1809
1847
  * example:
1810
1848
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1811
1849
  */
1812
- EntityId;
1850
+ EntityId /* uuid */;
1813
1851
  /**
1814
1852
  * Title of the entity
1815
1853
  * example:
@@ -1867,7 +1905,7 @@ declare namespace Components {
1867
1905
  * example:
1868
1906
  * 5da0a718-c822-403d-9f5d-20d4584e0528
1869
1907
  */
1870
- EntityId;
1908
+ EntityId /* uuid */;
1871
1909
  /**
1872
1910
  * Title of the entity
1873
1911
  * example:
@@ -1951,12 +1989,12 @@ declare namespace Components {
1951
1989
  paid_date?: string; // date
1952
1990
  }
1953
1991
  export interface SaveEntityFile {
1954
- /**
1992
+ entity_id: /**
1955
1993
  * Entity ID
1956
1994
  * example:
1957
- * 123456
1995
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
1958
1996
  */
1959
- entity_id: string;
1997
+ EntityId /* uuid */;
1960
1998
  /**
1961
1999
  * Entity type
1962
2000
  * example:
@@ -1970,12 +2008,12 @@ declare namespace Components {
1970
2008
  * 12345
1971
2009
  */
1972
2010
  filename: string;
1973
- /**
1974
- * File entity ID
2011
+ file_entity_id?: /**
2012
+ * Entity ID
1975
2013
  * example:
1976
- * 12345
2014
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
1977
2015
  */
1978
- file_entity_id?: string;
2016
+ EntityId /* uuid */;
1979
2017
  /**
1980
2018
  * Document type
1981
2019
  * example:
@@ -2120,10 +2158,13 @@ declare namespace Components {
2120
2158
  is_epilot_domain?: boolean;
2121
2159
  /**
2122
2160
  * ID of the design used to build the portal
2161
+ */
2162
+ design_id: /**
2163
+ * Entity ID
2123
2164
  * example:
2124
- * 9ba94f20-b872-4217-a259-2a90a8ee1a29
2165
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
2125
2166
  */
2126
- design_id: string;
2167
+ EntityId /* uuid */;
2127
2168
  /**
2128
2169
  * Default 360 user to notify upon an internal notification
2129
2170
  */
@@ -2249,7 +2290,12 @@ declare namespace Components {
2249
2290
  * Journey actions allowed on an entity by a portal user
2250
2291
  */
2251
2292
  entity_actions?: {
2252
- journey_id?: string;
2293
+ journey_id?: /**
2294
+ * Entity ID
2295
+ * example:
2296
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
2297
+ */
2298
+ EntityId /* uuid */;
2253
2299
  slug?: /**
2254
2300
  * URL-friendly identifier for the entity schema
2255
2301
  * example:
@@ -2460,7 +2506,7 @@ declare namespace Paths {
2460
2506
  * example:
2461
2507
  * 5da0a718-c822-403d-9f5d-20d4584e0528
2462
2508
  */
2463
- Components.Schemas.EntityId;
2509
+ Components.Schemas.EntityId /* uuid */;
2464
2510
  export type Slug = /**
2465
2511
  * URL-friendly identifier for the entity schema
2466
2512
  * example:
@@ -2551,7 +2597,7 @@ declare namespace Paths {
2551
2597
  * example:
2552
2598
  * 5da0a718-c822-403d-9f5d-20d4584e0528
2553
2599
  */
2554
- Components.Schemas.EntityId;
2600
+ Components.Schemas.EntityId /* uuid */;
2555
2601
  /**
2556
2602
  * example:
2557
2603
  * 123
@@ -2583,7 +2629,7 @@ declare namespace Paths {
2583
2629
  * example:
2584
2630
  * 5da0a718-c822-403d-9f5d-20d4584e0528
2585
2631
  */
2586
- Components.Schemas.EntityId[];
2632
+ Components.Schemas.EntityId /* uuid */[];
2587
2633
  }
2588
2634
  export interface QueryParameters {
2589
2635
  entities?: Parameters.Entities;
@@ -2634,7 +2680,12 @@ declare namespace Paths {
2634
2680
  export type RequestBody = Components.Schemas.DeleteEntityFile;
2635
2681
  namespace Responses {
2636
2682
  export interface $202 {
2637
- deletedFiles?: string[];
2683
+ deletedFiles?: /**
2684
+ * Entity ID
2685
+ * example:
2686
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
2687
+ */
2688
+ Components.Schemas.EntityId /* uuid */[];
2638
2689
  }
2639
2690
  export type $400 = Components.Responses.InvalidRequest;
2640
2691
  export type $401 = Components.Responses.Unauthorized;
@@ -2667,7 +2718,7 @@ declare namespace Paths {
2667
2718
  * example:
2668
2719
  * 5da0a718-c822-403d-9f5d-20d4584e0528
2669
2720
  */
2670
- Components.Schemas.EntityId;
2721
+ Components.Schemas.EntityId /* uuid */;
2671
2722
  }
2672
2723
  export type $401 = Components.Responses.Unauthorized;
2673
2724
  export type $500 = Components.Responses.InternalServerError;
@@ -2695,7 +2746,7 @@ declare namespace Paths {
2695
2746
  * example:
2696
2747
  * 5da0a718-c822-403d-9f5d-20d4584e0528
2697
2748
  */
2698
- Components.Schemas.EntityId;
2749
+ Components.Schemas.EntityId /* uuid */;
2699
2750
  export type Slug = /**
2700
2751
  * URL-friendly identifier for the entity schema
2701
2752
  * example:
@@ -2763,7 +2814,12 @@ declare namespace Paths {
2763
2814
  * "7c9f8536-6266-42e8-a0de-c60b61aa81a7"
2764
2815
  * ]
2765
2816
  */
2766
- export type EntityIds = string[];
2817
+ export type EntityIds = /**
2818
+ * Entity ID
2819
+ * example:
2820
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
2821
+ */
2822
+ Components.Schemas.EntityId /* uuid */[];
2767
2823
  /**
2768
2824
  * Initial offset to set for the search results
2769
2825
  * example:
@@ -2912,7 +2968,12 @@ declare namespace Paths {
2912
2968
  * List billing events before this date
2913
2969
  */
2914
2970
  export type DateBefore = string; // date-time
2915
- export type EntityId = string[];
2971
+ export type EntityId = /**
2972
+ * Entity ID
2973
+ * example:
2974
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
2975
+ */
2976
+ Components.Schemas.EntityId /* uuid */[];
2916
2977
  /**
2917
2978
  * Type of billing event to filter by
2918
2979
  */
@@ -3002,7 +3063,7 @@ declare namespace Paths {
3002
3063
  * example:
3003
3064
  * 5da0a718-c822-403d-9f5d-20d4584e0528
3004
3065
  */
3005
- Components.Schemas.EntityId;
3066
+ Components.Schemas.EntityId /* uuid */;
3006
3067
  }
3007
3068
  export interface PathParameters {
3008
3069
  id: Parameters.Id;
@@ -3078,6 +3139,29 @@ declare namespace Paths {
3078
3139
  export type $500 = Components.Responses.InternalServerError;
3079
3140
  }
3080
3141
  }
3142
+ namespace GetContractByIdentifiers {
3143
+ /**
3144
+ * example:
3145
+ * ```json
3146
+ * {
3147
+ * "name": "My Contract",
3148
+ * "contract_number": "123"
3149
+ * }
3150
+ * ```
3151
+ *
3152
+ */
3153
+ export type RequestBody = Components.Schemas.Entity;
3154
+ namespace Responses {
3155
+ export interface $200 {
3156
+ data?: Components.Schemas.EntityItem;
3157
+ hits: number;
3158
+ }
3159
+ export type $400 = Components.Responses.InvalidRequest;
3160
+ export type $401 = Components.Responses.Unauthorized;
3161
+ export type $403 = Components.Responses.Forbidden;
3162
+ export type $500 = Components.Responses.InternalServerError;
3163
+ }
3164
+ }
3081
3165
  namespace GetCountByEmail {
3082
3166
  namespace Parameters {
3083
3167
  /**
@@ -3126,20 +3210,15 @@ declare namespace Paths {
3126
3210
  }
3127
3211
  namespace GetECPContact {
3128
3212
  namespace Parameters {
3129
- /**
3130
- * ID of the mapped contact
3213
+ export type Id = /**
3214
+ * Entity ID
3131
3215
  * example:
3132
- * 1234
3216
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
3133
3217
  */
3134
- export type Id = string;
3218
+ Components.Schemas.EntityId /* uuid */;
3135
3219
  }
3136
3220
  export interface QueryParameters {
3137
- id: /**
3138
- * ID of the mapped contact
3139
- * example:
3140
- * 1234
3141
- */
3142
- Parameters.Id;
3221
+ id: Parameters.Id;
3143
3222
  }
3144
3223
  namespace Responses {
3145
3224
  export interface $200 {
@@ -3208,7 +3287,7 @@ declare namespace Paths {
3208
3287
  * example:
3209
3288
  * 5da0a718-c822-403d-9f5d-20d4584e0528
3210
3289
  */
3211
- Components.Schemas.EntityId;
3290
+ Components.Schemas.EntityId /* uuid */;
3212
3291
  export type IncludeRelations = boolean;
3213
3292
  export type Size = number;
3214
3293
  export type Slug = /**
@@ -3291,7 +3370,7 @@ declare namespace Paths {
3291
3370
  * example:
3292
3371
  * 5da0a718-c822-403d-9f5d-20d4584e0528
3293
3372
  */
3294
- Components.Schemas.EntityId;
3373
+ Components.Schemas.EntityId /* uuid */;
3295
3374
  }
3296
3375
  export interface PathParameters {
3297
3376
  id: Parameters.Id;
@@ -3322,7 +3401,7 @@ declare namespace Paths {
3322
3401
  * example:
3323
3402
  * 5da0a718-c822-403d-9f5d-20d4584e0528
3324
3403
  */
3325
- Components.Schemas.EntityId;
3404
+ Components.Schemas.EntityId /* uuid */;
3326
3405
  }
3327
3406
  export interface PathParameters {
3328
3407
  id: Parameters.Id;
@@ -3408,7 +3487,7 @@ declare namespace Paths {
3408
3487
  * example:
3409
3488
  * 5da0a718-c822-403d-9f5d-20d4584e0528
3410
3489
  */
3411
- Components.Schemas.EntityId;
3490
+ Components.Schemas.EntityId /* uuid */;
3412
3491
  }
3413
3492
  export interface PathParameters {
3414
3493
  id: Parameters.Id;
@@ -3635,10 +3714,13 @@ declare namespace Paths {
3635
3714
  emails: string[];
3636
3715
  /**
3637
3716
  * Email template ID that used on the automation
3717
+ */
3718
+ template_id: /**
3719
+ * Entity ID
3638
3720
  * example:
3639
- * d11eb11a-c4cf-4365-8a92-e7c05f61cde4
3721
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
3640
3722
  */
3641
- template_id: string;
3723
+ Components.Schemas.EntityId /* uuid */;
3642
3724
  }
3643
3725
  namespace Responses {
3644
3726
  export interface $200 {
@@ -3654,10 +3736,13 @@ declare namespace Paths {
3654
3736
  email: string;
3655
3737
  /**
3656
3738
  * ID of the recipient
3739
+ */
3740
+ recipient_id: /**
3741
+ * Entity ID
3657
3742
  * example:
3658
- * d11eb11a-c4cf-4365-8a92-e7c05f61cde4
3743
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
3659
3744
  */
3660
- recipient_id: string;
3745
+ Components.Schemas.EntityId /* uuid */;
3661
3746
  }[];
3662
3747
  /**
3663
3748
  * Reason to not notify the user
@@ -3739,7 +3824,12 @@ declare namespace Paths {
3739
3824
  export interface RequestBody {
3740
3825
  addresses?: string[];
3741
3826
  customers?: string[];
3742
- purposes?: string[];
3827
+ purposes?: /**
3828
+ * Entity ID
3829
+ * example:
3830
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
3831
+ */
3832
+ Components.Schemas.EntityId /* uuid */[];
3743
3833
  workflows?: any[];
3744
3834
  }
3745
3835
  namespace Responses {
@@ -3837,11 +3927,14 @@ declare namespace Paths {
3837
3927
  export interface RequestBody {
3838
3928
  [name: string]: {
3839
3929
  /**
3840
- * ID of the contact
3930
+ * ID of the entity
3931
+ */
3932
+ _id?: /**
3933
+ * Entity ID
3841
3934
  * example:
3842
- * 7aa44fb8-d60e-40cc-9a3a-ba09a1ff7f51
3935
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
3843
3936
  */
3844
- _id?: string;
3937
+ Components.Schemas.EntityId /* uuid */;
3845
3938
  is_main_entity?: boolean;
3846
3939
  };
3847
3940
  }
@@ -3952,7 +4045,7 @@ declare namespace Paths {
3952
4045
  * example:
3953
4046
  * 5da0a718-c822-403d-9f5d-20d4584e0528
3954
4047
  */
3955
- Components.Schemas.EntityId;
4048
+ Components.Schemas.EntityId /* uuid */;
3956
4049
  }
3957
4050
  export interface PathParameters {
3958
4051
  id: Parameters.Id;
@@ -3994,7 +4087,7 @@ declare namespace Paths {
3994
4087
  * example:
3995
4088
  * 5da0a718-c822-403d-9f5d-20d4584e0528
3996
4089
  */
3997
- Components.Schemas.EntityId;
4090
+ Components.Schemas.EntityId /* uuid */;
3998
4091
  }
3999
4092
  export interface PathParameters {
4000
4093
  id: Parameters.Id;
@@ -4011,11 +4104,12 @@ declare namespace Paths {
4011
4104
  }
4012
4105
  namespace TriggerEntityAccessEvent {
4013
4106
  namespace Parameters {
4014
- /**
4107
+ export type EntityId = /**
4108
+ * Entity ID
4015
4109
  * example:
4016
- * 1e3f0d58-69d2-4dbb-9a43-3ee63d862e8e
4110
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
4017
4111
  */
4018
- export type EntityId = string;
4112
+ Components.Schemas.EntityId /* uuid */;
4019
4113
  /**
4020
4114
  * Origin of the portal
4021
4115
  */
@@ -4034,11 +4128,7 @@ declare namespace Paths {
4034
4128
  Parameters.Schema;
4035
4129
  }
4036
4130
  export interface QueryParameters {
4037
- entity_id?: /**
4038
- * example:
4039
- * 1e3f0d58-69d2-4dbb-9a43-3ee63d862e8e
4040
- */
4041
- Parameters.EntityId;
4131
+ entity_id?: Parameters.EntityId;
4042
4132
  origin: /* Origin of the portal */ Parameters.Origin;
4043
4133
  }
4044
4134
  namespace Responses {
@@ -4069,7 +4159,7 @@ declare namespace Paths {
4069
4159
  * example:
4070
4160
  * 5da0a718-c822-403d-9f5d-20d4584e0528
4071
4161
  */
4072
- Components.Schemas.EntityId;
4162
+ Components.Schemas.EntityId /* uuid */;
4073
4163
  }
4074
4164
  export interface PathParameters {
4075
4165
  id: Parameters.Id;
@@ -4092,7 +4182,7 @@ declare namespace Paths {
4092
4182
  * example:
4093
4183
  * 5da0a718-c822-403d-9f5d-20d4584e0528
4094
4184
  */
4095
- Components.Schemas.EntityId;
4185
+ Components.Schemas.EntityId /* uuid */;
4096
4186
  }
4097
4187
  export interface PathParameters {
4098
4188
  id: Parameters.Id;
@@ -4115,7 +4205,7 @@ declare namespace Paths {
4115
4205
  * example:
4116
4206
  * 5da0a718-c822-403d-9f5d-20d4584e0528
4117
4207
  */
4118
- Components.Schemas.EntityId;
4208
+ Components.Schemas.EntityId /* uuid */;
4119
4209
  }
4120
4210
  export interface PathParameters {
4121
4211
  id: Parameters.Id;
@@ -4289,20 +4379,19 @@ declare namespace Paths {
4289
4379
  * true
4290
4380
  */
4291
4381
  exists: boolean;
4292
- user?: /* The portal user entity */ Components.Schemas.PortalUser;
4293
4382
  }
4294
4383
  export type $500 = Components.Responses.InternalServerError;
4295
4384
  }
4296
4385
  }
4297
4386
  namespace ValidateCadenceEntityEditRules {
4298
4387
  namespace Parameters {
4299
- export type Attribute = string; // date-time
4388
+ export type Attribute = string;
4300
4389
  export type Id = /**
4301
4390
  * Entity ID
4302
4391
  * example:
4303
4392
  * 5da0a718-c822-403d-9f5d-20d4584e0528
4304
4393
  */
4305
- Components.Schemas.EntityId;
4394
+ Components.Schemas.EntityId /* uuid */;
4306
4395
  export type Slug = /**
4307
4396
  * URL-friendly identifier for the entity schema
4308
4397
  * example:
@@ -4315,7 +4404,7 @@ declare namespace Paths {
4315
4404
  id: Parameters.Id;
4316
4405
  }
4317
4406
  export interface QueryParameters {
4318
- attribute?: Parameters.Attribute /* date-time */;
4407
+ attribute?: Parameters.Attribute;
4319
4408
  }
4320
4409
  namespace Responses {
4321
4410
  export interface $200 {
@@ -4328,6 +4417,14 @@ declare namespace Paths {
4328
4417
  }
4329
4418
  }
4330
4419
  }
4420
+ namespace ValidateToken {
4421
+ namespace Responses {
4422
+ export interface $204 {
4423
+ }
4424
+ export type $401 = Components.Responses.Unauthorized;
4425
+ export type $500 = Components.Responses.InternalServerError;
4426
+ }
4427
+ }
4331
4428
  }
4332
4429
 
4333
4430
  export interface OperationMethods {
@@ -4351,6 +4448,16 @@ export interface OperationMethods {
4351
4448
  data?: Paths.CreateUser.RequestBody,
4352
4449
  config?: AxiosRequestConfig
4353
4450
  ): OperationResponse<Paths.CreateUser.Responses.$201>
4451
+ /**
4452
+ * validateToken - validateToken
4453
+ *
4454
+ * Validates Portal Token is valid. Pass the token via Authorization Header.
4455
+ */
4456
+ 'validateToken'(
4457
+ parameters?: Parameters<UnknownParamsObject> | null,
4458
+ data?: any,
4459
+ config?: AxiosRequestConfig
4460
+ ): OperationResponse<Paths.ValidateToken.Responses.$204>
4354
4461
  /**
4355
4462
  * revokeToken - revokeToken
4356
4463
  *
@@ -4554,7 +4661,7 @@ export interface OperationMethods {
4554
4661
  /**
4555
4662
  * getCountByEmail - getCountByEmail
4556
4663
  *
4557
- * Check Contact by email
4664
+ * Check Contact by email. Deprecated in favor of /contact/exists.
4558
4665
  */
4559
4666
  'getCountByEmail'(
4560
4667
  parameters?: Parameters<Paths.GetCountByEmail.QueryParameters> | null,
@@ -4564,7 +4671,7 @@ export interface OperationMethods {
4564
4671
  /**
4565
4672
  * getContactCount - getContactCount
4566
4673
  *
4567
- * Return number of contacts matching identifier values.
4674
+ * Return number of contacts matching identifier values. Deprecated in favor of /contact/exists.
4568
4675
  */
4569
4676
  'getContactCount'(
4570
4677
  parameters?: Parameters<Paths.GetContactCount.QueryParameters> | null,
@@ -4781,6 +4888,16 @@ export interface OperationMethods {
4781
4888
  data?: Paths.UpdateContract.RequestBody,
4782
4889
  config?: AxiosRequestConfig
4783
4890
  ): OperationResponse<Paths.UpdateContract.Responses.$200>
4891
+ /**
4892
+ * getContractByIdentifiers - getContractByIdentifiers
4893
+ *
4894
+ * Get contract by pre-configured identifiers.
4895
+ */
4896
+ 'getContractByIdentifiers'(
4897
+ parameters?: Parameters<UnknownParamsObject> | null,
4898
+ data?: Paths.GetContractByIdentifiers.RequestBody,
4899
+ config?: AxiosRequestConfig
4900
+ ): OperationResponse<Paths.GetContractByIdentifiers.Responses.$200>
4784
4901
  /**
4785
4902
  * getEntityIdentifiers - getEntityIdentifiers
4786
4903
  *
@@ -4794,7 +4911,7 @@ export interface OperationMethods {
4794
4911
  /**
4795
4912
  * getEntitiesByIdentifiers - getEntitiesByIdentifiers
4796
4913
  *
4797
- * Get entities by identifiers by portal user
4914
+ * Get entities (contract) by identifiers. Deprecated in favor of /contract/by-identifiers.
4798
4915
  */
4799
4916
  'getEntitiesByIdentifiers'(
4800
4917
  parameters?: Parameters<Paths.GetEntitiesByIdentifiers.PathParameters> | null,
@@ -5034,6 +5151,18 @@ export interface PathsDictionary {
5034
5151
  config?: AxiosRequestConfig
5035
5152
  ): OperationResponse<Paths.CreateUser.Responses.$201>
5036
5153
  }
5154
+ ['/v2/portal/token/validate']: {
5155
+ /**
5156
+ * validateToken - validateToken
5157
+ *
5158
+ * Validates Portal Token is valid. Pass the token via Authorization Header.
5159
+ */
5160
+ 'post'(
5161
+ parameters?: Parameters<UnknownParamsObject> | null,
5162
+ data?: any,
5163
+ config?: AxiosRequestConfig
5164
+ ): OperationResponse<Paths.ValidateToken.Responses.$204>
5165
+ }
5037
5166
  ['/v2/portal/token/revoke']: {
5038
5167
  /**
5039
5168
  * revokeToken - revokeToken
@@ -5270,7 +5399,7 @@ export interface PathsDictionary {
5270
5399
  /**
5271
5400
  * getCountByEmail - getCountByEmail
5272
5401
  *
5273
- * Check Contact by email
5402
+ * Check Contact by email. Deprecated in favor of /contact/exists.
5274
5403
  */
5275
5404
  'get'(
5276
5405
  parameters?: Parameters<Paths.GetCountByEmail.QueryParameters> | null,
@@ -5282,7 +5411,7 @@ export interface PathsDictionary {
5282
5411
  /**
5283
5412
  * getContactCount - getContactCount
5284
5413
  *
5285
- * Return number of contacts matching identifier values.
5414
+ * Return number of contacts matching identifier values. Deprecated in favor of /contact/exists.
5286
5415
  */
5287
5416
  'post'(
5288
5417
  parameters?: Parameters<Paths.GetContactCount.QueryParameters> | null,
@@ -5532,6 +5661,18 @@ export interface PathsDictionary {
5532
5661
  config?: AxiosRequestConfig
5533
5662
  ): OperationResponse<Paths.UpdateContract.Responses.$200>
5534
5663
  }
5664
+ ['/v2/portal/contract/by-identifiers']: {
5665
+ /**
5666
+ * getContractByIdentifiers - getContractByIdentifiers
5667
+ *
5668
+ * Get contract by pre-configured identifiers.
5669
+ */
5670
+ 'post'(
5671
+ parameters?: Parameters<UnknownParamsObject> | null,
5672
+ data?: Paths.GetContractByIdentifiers.RequestBody,
5673
+ config?: AxiosRequestConfig
5674
+ ): OperationResponse<Paths.GetContractByIdentifiers.Responses.$200>
5675
+ }
5535
5676
  ['/v2/portal/entity/identifiers/{slug}']: {
5536
5677
  /**
5537
5678
  * getEntityIdentifiers - getEntityIdentifiers
@@ -5548,7 +5689,7 @@ export interface PathsDictionary {
5548
5689
  /**
5549
5690
  * getEntitiesByIdentifiers - getEntitiesByIdentifiers
5550
5691
  *
5551
- * Get entities by identifiers by portal user
5692
+ * Get entities (contract) by identifiers. Deprecated in favor of /contract/by-identifiers.
5552
5693
  */
5553
5694
  'post'(
5554
5695
  parameters?: Parameters<Paths.GetEntitiesByIdentifiers.PathParameters> | null,