@epilot/customer-portal-client 0.34.0 → 0.36.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/openapi.d.ts CHANGED
@@ -695,6 +695,46 @@ declare namespace Components {
695
695
  */
696
696
  visibility?: {
697
697
  [name: string]: any;
698
+ /**
699
+ * Block is fully hidden from portal users
700
+ */
701
+ is_hidden?: boolean;
702
+ /**
703
+ * Block is hidden on mobile viewports
704
+ */
705
+ hidden_on_mobile?: boolean;
706
+ /**
707
+ * Block is hidden on desktop viewports
708
+ */
709
+ hidden_on_desktop?: boolean;
710
+ /**
711
+ * Block is hidden in the mobile app
712
+ */
713
+ hidden_in_app?: boolean;
714
+ /**
715
+ * Schedule visibility start date. If only start_date is set, block is visible from this date onwards.
716
+ */
717
+ start_date?: string; // date-time
718
+ /**
719
+ * Schedule visibility end date. If only end_date is set, block is visible until this date.
720
+ */
721
+ end_date?: string; // date-time
722
+ /**
723
+ * Target IDs that must match for the block to be visible
724
+ */
725
+ visible_for_targets?: string[];
726
+ /**
727
+ * Operator for visible_for_targets matching
728
+ */
729
+ visible_for_operator?: "and" | "or";
730
+ /**
731
+ * Target IDs that if matched will hide the block
732
+ */
733
+ hidden_for_targets?: string[];
734
+ /**
735
+ * Operator for hidden_for_targets matching
736
+ */
737
+ hidden_for_operator?: "and" | "or";
698
738
  };
699
739
  /**
700
740
  * The content of the block
@@ -3126,6 +3166,7 @@ declare namespace Components {
3126
3166
  * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
3127
3167
  */
3128
3168
  use_static_ips?: boolean;
3169
+ secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
3129
3170
  }
3130
3171
  /**
3131
3172
  * Hook that replaces the built-in Contract identification for self-assignment. This hook involves an HTTP request whenever a user is trying to self-assign Contract(s).
@@ -3202,6 +3243,7 @@ declare namespace Components {
3202
3243
  * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
3203
3244
  */
3204
3245
  use_static_ips?: boolean;
3246
+ secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
3205
3247
  }
3206
3248
  /**
3207
3249
  * Hook that will allow using the specified source as data for consumption visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
@@ -3249,6 +3291,7 @@ declare namespace Components {
3249
3291
  * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
3250
3292
  */
3251
3293
  use_static_ips?: boolean;
3294
+ secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
3252
3295
  }
3253
3296
  /**
3254
3297
  * Hook that checks the plausibility of meter readings before they are saved. This hook makes a POST call whenever a user is trying to save a meter reading. The expected response to the call is:
@@ -3340,6 +3383,7 @@ declare namespace Components {
3340
3383
  * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
3341
3384
  */
3342
3385
  use_static_ips?: boolean;
3386
+ secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
3343
3387
  }
3344
3388
  /**
3345
3389
  * Hook that will allow using the specified source as data for price visualizations. This hook is triggered to fetch the data. Format of the request and response has to follow the following specification: TBD. The expected response to the call is:
@@ -3387,6 +3431,7 @@ declare namespace Components {
3387
3431
  * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
3388
3432
  */
3389
3433
  use_static_ips?: boolean;
3434
+ secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
3390
3435
  }
3391
3436
  /**
3392
3437
  * Hook that replaces the built-in registration identifiers check. This hook makes a POST call whenever a user is trying to register to find the corresponding contact. The expected response to the call is:
@@ -3433,6 +3478,7 @@ declare namespace Components {
3433
3478
  * If true, requests are made from a set of static IP addresses and only allow connections to a set of allowed IP addresses. Get in touch with us to add your IP addresses.
3434
3479
  */
3435
3480
  use_static_ips?: boolean;
3481
+ secure_proxy?: /* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips. */ SecureProxyConfig;
3436
3482
  }
3437
3483
  export type ExtensionHookSelection = {
3438
3484
  /**
@@ -4419,6 +4465,38 @@ declare namespace Components {
4419
4465
  */
4420
4466
  visibility?: {
4421
4467
  [name: string]: any;
4468
+ /**
4469
+ * Page is fully hidden from portal users
4470
+ */
4471
+ is_hidden?: boolean;
4472
+ /**
4473
+ * Page is hidden in the mobile app
4474
+ */
4475
+ hidden_in_app?: boolean;
4476
+ /**
4477
+ * Schedule visibility start date. If only start_date is set, page is visible from this date onwards.
4478
+ */
4479
+ start_date?: string; // date-time
4480
+ /**
4481
+ * Schedule visibility end date. If only end_date is set, page is visible until this date.
4482
+ */
4483
+ end_date?: string; // date-time
4484
+ /**
4485
+ * Target IDs that must match for the page to be visible
4486
+ */
4487
+ visible_for_targets?: string[];
4488
+ /**
4489
+ * Operator for visible_for_targets matching
4490
+ */
4491
+ visible_for_operator?: "and" | "or";
4492
+ /**
4493
+ * Target IDs that if matched will hide the page
4494
+ */
4495
+ hidden_for_targets?: string[];
4496
+ /**
4497
+ * Operator for hidden_for_targets matching
4498
+ */
4499
+ hidden_for_operator?: "and" | "or";
4422
4500
  };
4423
4501
  /**
4424
4502
  * The content of the page
@@ -4501,6 +4579,12 @@ declare namespace Components {
4501
4579
  * 2021-02-09T12:41:43.662Z
4502
4580
  */
4503
4581
  last_modified_at?: string; // date-time
4582
+ /**
4583
+ * The id of the portal
4584
+ * example:
4585
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
4586
+ */
4587
+ portal_id?: string;
4504
4588
  }
4505
4589
  export interface PageRequest {
4506
4590
  [name: string]: any;
@@ -4522,6 +4606,38 @@ declare namespace Components {
4522
4606
  */
4523
4607
  visibility?: {
4524
4608
  [name: string]: any;
4609
+ /**
4610
+ * Page is fully hidden from portal users
4611
+ */
4612
+ is_hidden?: boolean;
4613
+ /**
4614
+ * Page is hidden in the mobile app
4615
+ */
4616
+ hidden_in_app?: boolean;
4617
+ /**
4618
+ * Schedule visibility start date. If only start_date is set, page is visible from this date onwards.
4619
+ */
4620
+ start_date?: string; // date-time
4621
+ /**
4622
+ * Schedule visibility end date. If only end_date is set, page is visible until this date.
4623
+ */
4624
+ end_date?: string; // date-time
4625
+ /**
4626
+ * Target IDs that must match for the page to be visible
4627
+ */
4628
+ visible_for_targets?: string[];
4629
+ /**
4630
+ * Operator for visible_for_targets matching
4631
+ */
4632
+ visible_for_operator?: "and" | "or";
4633
+ /**
4634
+ * Target IDs that if matched will hide the page
4635
+ */
4636
+ hidden_for_targets?: string[];
4637
+ /**
4638
+ * Operator for hidden_for_targets matching
4639
+ */
4640
+ hidden_for_operator?: "and" | "or";
4525
4641
  };
4526
4642
  /**
4527
4643
  * The content of the page
@@ -6122,6 +6238,19 @@ declare namespace Components {
6122
6238
  };
6123
6239
  };
6124
6240
  }
6241
+ /**
6242
+ * Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips.
6243
+ */
6244
+ export interface SecureProxyConfig {
6245
+ /**
6246
+ * Integration ID that owns the secure_proxy use case.
6247
+ */
6248
+ integration_id: string; // uuid
6249
+ /**
6250
+ * Use case slug for the secure proxy use case.
6251
+ */
6252
+ use_case_slug: string;
6253
+ }
6125
6254
  export type Source = "ECP" | "ERP" | "360" | "journey-submission";
6126
6255
  export type SwappableConfig = "all" | "domain" | "users" | "email_templates";
6127
6256
  export type TariffType = "ht" | "nt";
@@ -7376,6 +7505,7 @@ declare namespace Paths {
7376
7505
  }
7377
7506
  namespace CheckContactExistsV3 {
7378
7507
  namespace Parameters {
7508
+ export type Domain = string;
7379
7509
  export type PortalId = /**
7380
7510
  * ID of the portal
7381
7511
  * example:
@@ -7384,7 +7514,8 @@ declare namespace Paths {
7384
7514
  Components.Schemas.PortalId;
7385
7515
  }
7386
7516
  export interface QueryParameters {
7387
- portal_id: Parameters.PortalId;
7517
+ portal_id?: Parameters.PortalId;
7518
+ domain?: Parameters.Domain;
7388
7519
  }
7389
7520
  export type RequestBody = Components.Schemas.ContactExistsRequest;
7390
7521
  namespace Responses {
@@ -7625,6 +7756,7 @@ declare namespace Paths {
7625
7756
  }
7626
7757
  namespace CreateUserV3 {
7627
7758
  namespace Parameters {
7759
+ export type Domain = string;
7628
7760
  export type PortalId = /**
7629
7761
  * ID of the portal
7630
7762
  * example:
@@ -7633,7 +7765,8 @@ declare namespace Paths {
7633
7765
  Components.Schemas.PortalId;
7634
7766
  }
7635
7767
  export interface QueryParameters {
7636
- portal_id: Parameters.PortalId;
7768
+ portal_id?: Parameters.PortalId;
7769
+ domain?: Parameters.Domain;
7637
7770
  }
7638
7771
  export type RequestBody = Components.Schemas.CreateUserRequest;
7639
7772
  namespace Responses {
@@ -10501,6 +10634,32 @@ declare namespace Paths {
10501
10634
  export type $500 = Components.Responses.InternalServerError;
10502
10635
  }
10503
10636
  }
10637
+ namespace GetPortalWidgetsV3 {
10638
+ namespace Parameters {
10639
+ export type ContractId = /**
10640
+ * Entity ID
10641
+ * example:
10642
+ * 5da0a718-c822-403d-9f5d-20d4584e0528
10643
+ */
10644
+ Components.Schemas.EntityId /* uuid */;
10645
+ export type PortalId = /**
10646
+ * ID of the portal
10647
+ * example:
10648
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
10649
+ */
10650
+ Components.Schemas.PortalId;
10651
+ }
10652
+ export interface QueryParameters {
10653
+ portal_id: Parameters.PortalId;
10654
+ contract_id?: Parameters.ContractId;
10655
+ }
10656
+ namespace Responses {
10657
+ export type $200 = Components.Schemas.UpsertPortalWidget;
10658
+ export type $401 = Components.Responses.Unauthorized;
10659
+ export type $403 = Components.Responses.Forbidden;
10660
+ export type $500 = Components.Responses.InternalServerError;
10661
+ }
10662
+ }
10504
10663
  namespace GetPrices {
10505
10664
  namespace Parameters {
10506
10665
  export type AppId = string;
@@ -11234,6 +11393,10 @@ declare namespace Paths {
11234
11393
  * ]
11235
11394
  */
11236
11395
  Components.Schemas.ContextEntities;
11396
+ /**
11397
+ * When true, evaluates targeting conditions and annotates each page/block visibility with _targeting_status ('visible' | 'hidden' | 'no_targeting'). Blocks and pages are never removed — for preview/builder use only.
11398
+ */
11399
+ evaluate_targeting?: boolean;
11237
11400
  }
11238
11401
  namespace Responses {
11239
11402
  export type $200 = Components.Schemas.Page[];
@@ -11257,10 +11420,20 @@ declare namespace Paths {
11257
11420
  /**
11258
11421
  * Additional contact entity fields to set when creating the contact for the invited user.
11259
11422
  * These are mapped directly to contact entity attributes (e.g. first_name, last_name, phone).
11423
+ * Values can be strings or arrays of strings (for multiselect attributes).
11260
11424
  *
11261
11425
  */
11262
11426
  contact_data?: {
11263
- [name: string]: string;
11427
+ [name: string]: string | string[];
11428
+ };
11429
+ /**
11430
+ * Additional portal user entity fields to set when creating the portal user for the invited user.
11431
+ * These are mapped directly to portal_user entity attributes.
11432
+ * Values can be strings or arrays of strings (for multiselect attributes).
11433
+ *
11434
+ */
11435
+ portal_user_data?: {
11436
+ [name: string]: string | string[];
11264
11437
  };
11265
11438
  }
11266
11439
  namespace Responses {
@@ -11307,6 +11480,14 @@ declare namespace Paths {
11307
11480
  */
11308
11481
  email?: string;
11309
11482
  origin?: /* Origin of the portal */ Components.Schemas.Origin;
11483
+ /**
11484
+ * The portal ID to look up the portal config. When provided, takes precedence over origin.
11485
+ */
11486
+ portal_id?: string;
11487
+ /**
11488
+ * Portal domain for identification. Alternative to portal_id or origin.
11489
+ */
11490
+ domain?: string;
11310
11491
  }
11311
11492
  namespace Responses {
11312
11493
  export interface $200 {
@@ -11643,6 +11824,30 @@ declare namespace Paths {
11643
11824
  export type $500 = Components.Responses.InternalServerError;
11644
11825
  }
11645
11826
  }
11827
+ namespace SavePortalFilesV3 {
11828
+ namespace Parameters {
11829
+ export type PortalId = /**
11830
+ * ID of the portal
11831
+ * example:
11832
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
11833
+ */
11834
+ Components.Schemas.PortalId;
11835
+ }
11836
+ export interface QueryParameters {
11837
+ portal_id: Parameters.PortalId;
11838
+ }
11839
+ export type RequestBody = Components.Schemas.SavePortalFile;
11840
+ namespace Responses {
11841
+ export interface $201 {
11842
+ createdFiles?: /* The file entity */ Components.Schemas.File[];
11843
+ }
11844
+ export type $400 = Components.Responses.InvalidRequest;
11845
+ export type $401 = Components.Responses.Unauthorized;
11846
+ export type $403 = Components.Responses.Forbidden;
11847
+ export type $404 = Components.Responses.NotFound;
11848
+ export type $500 = Components.Responses.InternalServerError;
11849
+ }
11850
+ }
11646
11851
  namespace SearchPaymentRelationsInEntities {
11647
11852
  namespace Parameters {
11648
11853
  export type Id = /**
@@ -11754,6 +11959,7 @@ declare namespace Paths {
11754
11959
  * 5da0a718-c822-403d-9f5d-20d4584e0528
11755
11960
  */
11756
11961
  export type ContactId = string; // uuid
11962
+ export type Domain = string;
11757
11963
  /**
11758
11964
  * example:
11759
11965
  * 123
@@ -11767,12 +11973,13 @@ declare namespace Paths {
11767
11973
  Components.Schemas.PortalId;
11768
11974
  }
11769
11975
  export interface QueryParameters {
11770
- portal_id: Parameters.PortalId;
11771
- org_id: /**
11976
+ portal_id?: Parameters.PortalId;
11977
+ org_id?: /**
11772
11978
  * example:
11773
11979
  * 123
11774
11980
  */
11775
11981
  Parameters.OrgId;
11982
+ domain?: Parameters.Domain;
11776
11983
  contact_id?: /**
11777
11984
  * example:
11778
11985
  * 5da0a718-c822-403d-9f5d-20d4584e0528
@@ -11931,6 +12138,7 @@ declare namespace Paths {
11931
12138
  }
11932
12139
  namespace TriggerEntityAccessEventV3 {
11933
12140
  namespace Parameters {
12141
+ export type Domain = string;
11934
12142
  export type EntityId = /**
11935
12143
  * Entity ID
11936
12144
  * example:
@@ -11958,7 +12166,8 @@ declare namespace Paths {
11958
12166
  }
11959
12167
  export interface QueryParameters {
11960
12168
  entity_id?: Parameters.EntityId;
11961
- portal_id: Parameters.PortalId;
12169
+ portal_id?: Parameters.PortalId;
12170
+ domain?: Parameters.Domain;
11962
12171
  }
11963
12172
  namespace Responses {
11964
12173
  export interface $200 {
@@ -12335,6 +12544,27 @@ declare namespace Paths {
12335
12544
  export type $500 = Components.Responses.InternalServerError;
12336
12545
  }
12337
12546
  }
12547
+ namespace UpsertPortalWidgetV3 {
12548
+ namespace Parameters {
12549
+ export type PortalId = /**
12550
+ * ID of the portal
12551
+ * example:
12552
+ * 453ad7bf-86d5-46c8-8252-bcc868df5e3c
12553
+ */
12554
+ Components.Schemas.PortalId;
12555
+ }
12556
+ export interface QueryParameters {
12557
+ portal_id: Parameters.PortalId;
12558
+ }
12559
+ export type RequestBody = Components.Schemas.UpsertPortalWidget;
12560
+ namespace Responses {
12561
+ export type $201 = Components.Schemas.UpsertPortalWidget;
12562
+ export type $400 = Components.Responses.InvalidRequest;
12563
+ export type $401 = Components.Responses.Unauthorized;
12564
+ export type $403 = Components.Responses.Forbidden;
12565
+ export type $500 = Components.Responses.InternalServerError;
12566
+ }
12567
+ }
12338
12568
  namespace UserExists {
12339
12569
  namespace Parameters {
12340
12570
  /**
@@ -12380,6 +12610,7 @@ declare namespace Paths {
12380
12610
  }
12381
12611
  namespace UserExistsV3 {
12382
12612
  namespace Parameters {
12613
+ export type Domain = string;
12383
12614
  /**
12384
12615
  * Email Address of the portal user
12385
12616
  * example:
@@ -12387,7 +12618,7 @@ declare namespace Paths {
12387
12618
  */
12388
12619
  export type Email = string;
12389
12620
  /**
12390
- * Organization ID
12621
+ * Organization ID (required if domain is not provided)
12391
12622
  * example:
12392
12623
  * 123
12393
12624
  */
@@ -12406,13 +12637,14 @@ declare namespace Paths {
12406
12637
  * user@example.com
12407
12638
  */
12408
12639
  Parameters.Email;
12409
- org_id: /**
12410
- * Organization ID
12640
+ org_id?: /**
12641
+ * Organization ID (required if domain is not provided)
12411
12642
  * example:
12412
12643
  * 123
12413
12644
  */
12414
12645
  Parameters.OrgId;
12415
12646
  portal_id?: Parameters.PortalId;
12647
+ domain?: Parameters.Domain;
12416
12648
  }
12417
12649
  namespace Responses {
12418
12650
  export interface $200 {
@@ -12644,7 +12876,11 @@ export interface OperationMethods {
12644
12876
  /**
12645
12877
  * createUserV3 - createUserV3
12646
12878
  *
12647
- * Registers a portal user with portal id
12879
+ * Registers a portal user.
12880
+ * Supports two identification methods:
12881
+ * 1. Using portal_id
12882
+ * 2. Using domain
12883
+ *
12648
12884
  */
12649
12885
  'createUserV3'(
12650
12886
  parameters?: Parameters<Paths.CreateUserV3.QueryParameters> | null,
@@ -12918,7 +13154,7 @@ export interface OperationMethods {
12918
13154
  /**
12919
13155
  * getPublicPortalWidgets - getPublicPortalWidgets
12920
13156
  *
12921
- * Retrieves the public widgets of a portal
13157
+ * Retrieves the public widgets of a portal.
12922
13158
  */
12923
13159
  'getPublicPortalWidgets'(
12924
13160
  parameters?: Parameters<Paths.GetPublicPortalWidgets.QueryParameters> | null,
@@ -12928,7 +13164,7 @@ export interface OperationMethods {
12928
13164
  /**
12929
13165
  * getPortalWidgets - getPortalWidgets
12930
13166
  *
12931
- * Retrieves the widgets of a portal
13167
+ * Retrieves the widgets of a portal.
12932
13168
  */
12933
13169
  'getPortalWidgets'(
12934
13170
  parameters?: Parameters<Paths.GetPortalWidgets.QueryParameters> | null,
@@ -12945,6 +13181,36 @@ export interface OperationMethods {
12945
13181
  data?: Paths.UpsertPortalWidget.RequestBody,
12946
13182
  config?: AxiosRequestConfig
12947
13183
  ): OperationResponse<Paths.UpsertPortalWidget.Responses.$201>
13184
+ /**
13185
+ * getPortalWidgetsV3 - getPortalWidgetsV3
13186
+ *
13187
+ * Retrieves the widgets of a portal by portal_id.
13188
+ */
13189
+ 'getPortalWidgetsV3'(
13190
+ parameters?: Parameters<Paths.GetPortalWidgetsV3.QueryParameters> | null,
13191
+ data?: any,
13192
+ config?: AxiosRequestConfig
13193
+ ): OperationResponse<Paths.GetPortalWidgetsV3.Responses.$200>
13194
+ /**
13195
+ * upsertPortalWidgetV3 - upsertPortalWidgetV3
13196
+ *
13197
+ * Upsert widget for a portal by portal_id.
13198
+ */
13199
+ 'upsertPortalWidgetV3'(
13200
+ parameters?: Parameters<Paths.UpsertPortalWidgetV3.QueryParameters> | null,
13201
+ data?: Paths.UpsertPortalWidgetV3.RequestBody,
13202
+ config?: AxiosRequestConfig
13203
+ ): OperationResponse<Paths.UpsertPortalWidgetV3.Responses.$201>
13204
+ /**
13205
+ * savePortalFilesV3 - savePortalFilesV3
13206
+ *
13207
+ * Add files to portal by portal_id
13208
+ */
13209
+ 'savePortalFilesV3'(
13210
+ parameters?: Parameters<Paths.SavePortalFilesV3.QueryParameters> | null,
13211
+ data?: Paths.SavePortalFilesV3.RequestBody,
13212
+ config?: AxiosRequestConfig
13213
+ ): OperationResponse<Paths.SavePortalFilesV3.Responses.$201>
12948
13214
  /**
12949
13215
  * replaceECPTemplateVariables - replaceECPTemplateVariables
12950
13216
  *
@@ -13069,6 +13335,10 @@ export interface OperationMethods {
13069
13335
  * checkContactExistsV3 - checkContactExistsV3
13070
13336
  *
13071
13337
  * True if contact with given identifiers exists.
13338
+ * Supports two identification methods:
13339
+ * 1. Using portal_id
13340
+ * 2. Using domain
13341
+ *
13072
13342
  */
13073
13343
  'checkContactExistsV3'(
13074
13344
  parameters?: Parameters<Paths.CheckContactExistsV3.QueryParameters> | null,
@@ -13178,7 +13448,11 @@ export interface OperationMethods {
13178
13448
  /**
13179
13449
  * userExistsV3 - userExistsV3
13180
13450
  *
13181
- * Checks whether a user exists in the portal
13451
+ * Checks whether a user exists in the portal.
13452
+ * Supports two identification methods:
13453
+ * 1. Using org_id + portal_id
13454
+ * 2. Using domain
13455
+ *
13182
13456
  */
13183
13457
  'userExistsV3'(
13184
13458
  parameters?: Parameters<Paths.UserExistsV3.QueryParameters> | null,
@@ -13218,7 +13492,7 @@ export interface OperationMethods {
13218
13492
  /**
13219
13493
  * getAllOrders - getAllOrders
13220
13494
  *
13221
- * Get all orders for the portal user
13495
+ * Get all orders for the portal user. Use searchPortalUserEntities instead.
13222
13496
  */
13223
13497
  'getAllOrders'(
13224
13498
  parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
@@ -13238,7 +13512,7 @@ export interface OperationMethods {
13238
13512
  /**
13239
13513
  * getOrder - getOrder
13240
13514
  *
13241
- * Get an order by id
13515
+ * Get an order by id. Use getPortalUserEntity instead.
13242
13516
  */
13243
13517
  'getOrder'(
13244
13518
  parameters?: Parameters<Paths.GetOrder.PathParameters> | null,
@@ -13248,7 +13522,7 @@ export interface OperationMethods {
13248
13522
  /**
13249
13523
  * updateOrder - updateOrder
13250
13524
  *
13251
- * Update an order by id
13525
+ * Update an order by id. Use getPortalUserEntity instead.
13252
13526
  */
13253
13527
  'updateOrder'(
13254
13528
  parameters?: Parameters<Paths.UpdateOrder.PathParameters> | null,
@@ -13258,7 +13532,7 @@ export interface OperationMethods {
13258
13532
  /**
13259
13533
  * getAllOpportunities - getAllOpportunities
13260
13534
  *
13261
- * Get all opportunities of a portal user
13535
+ * Get all opportunities of a portal user. Use searchPortalUserEntities instead.
13262
13536
  */
13263
13537
  'getAllOpportunities'(
13264
13538
  parameters?: Parameters<Paths.GetAllOpportunities.QueryParameters> | null,
@@ -13268,7 +13542,7 @@ export interface OperationMethods {
13268
13542
  /**
13269
13543
  * getSearchableAttributesForOpportunities - getSearchableAttributesForOpportunities
13270
13544
  *
13271
- * Get all opportunity searchable attributes for a portal user
13545
+ * Get all opportunity searchable attributes for a portal user. Use searchPortalUserEntities instead.
13272
13546
  */
13273
13547
  'getSearchableAttributesForOpportunities'(
13274
13548
  parameters?: Parameters<Paths.GetSearchableAttributesForOpportunities.QueryParameters> | null,
@@ -13278,7 +13552,7 @@ export interface OperationMethods {
13278
13552
  /**
13279
13553
  * getSearchResultsForOpportunities - getSearchResultsForOpportunities
13280
13554
  *
13281
- * Get all opportunity with the given serached attributes
13555
+ * Get all opportunity with the given searched attributes. Use searchPortalUserEntities instead.
13282
13556
  */
13283
13557
  'getSearchResultsForOpportunities'(
13284
13558
  parameters?: Parameters<Paths.GetSearchResultsForOpportunities.QueryParameters> | null,
@@ -13288,7 +13562,7 @@ export interface OperationMethods {
13288
13562
  /**
13289
13563
  * getOpportunity - getOpportunity
13290
13564
  *
13291
- * Get an opportunity by id
13565
+ * Get an opportunity by id. Use getPortalUserEntity instead.
13292
13566
  */
13293
13567
  'getOpportunity'(
13294
13568
  parameters?: Parameters<Paths.GetOpportunity.PathParameters> | null,
@@ -13298,7 +13572,7 @@ export interface OperationMethods {
13298
13572
  /**
13299
13573
  * updateOpportunity - updateOpportunity
13300
13574
  *
13301
- * Update an opportunity by id
13575
+ * Update an opportunity by id.
13302
13576
  */
13303
13577
  'updateOpportunity'(
13304
13578
  parameters?: Parameters<Paths.UpdateOpportunity.PathParameters> | null,
@@ -13308,7 +13582,7 @@ export interface OperationMethods {
13308
13582
  /**
13309
13583
  * getAllRequests - getAllRequests
13310
13584
  *
13311
- * Get all opportunities & orders of a portal user
13585
+ * Get all opportunities & orders of a portal user. Use searchPortalUserEntities instead.
13312
13586
  */
13313
13587
  'getAllRequests'(
13314
13588
  parameters?: Parameters<Paths.GetAllRequests.QueryParameters> | null,
@@ -13318,7 +13592,7 @@ export interface OperationMethods {
13318
13592
  /**
13319
13593
  * getAllContracts - getAllContracts
13320
13594
  *
13321
- * Get all contracts for a portal user
13595
+ * Get all contracts for a portal user. Use searchPortalUserEntities instead.
13322
13596
  */
13323
13597
  'getAllContracts'(
13324
13598
  parameters?: Parameters<Paths.GetAllContracts.QueryParameters> | null,
@@ -13328,7 +13602,7 @@ export interface OperationMethods {
13328
13602
  /**
13329
13603
  * getContract - getContract
13330
13604
  *
13331
- * Get a contract by id
13605
+ * Get a contract by id. Use getPortalUserEntity instead.
13332
13606
  */
13333
13607
  'getContract'(
13334
13608
  parameters?: Parameters<Paths.GetContract.PathParameters> | null,
@@ -13338,7 +13612,7 @@ export interface OperationMethods {
13338
13612
  /**
13339
13613
  * updateContract - updateContract
13340
13614
  *
13341
- * Update a contract by id
13615
+ * Update a contract by id. Use getPortalUserEntity instead.
13342
13616
  */
13343
13617
  'updateContract'(
13344
13618
  parameters?: Parameters<Paths.UpdateContract.PathParameters> | null,
@@ -13461,7 +13735,7 @@ export interface OperationMethods {
13461
13735
  /**
13462
13736
  * getFileById - getFileById
13463
13737
  *
13464
- * Fetch a document with ID
13738
+ * Fetch a document with ID. Use getPortalUserEntity instead.
13465
13739
  */
13466
13740
  'getFileById'(
13467
13741
  parameters?: Parameters<Paths.GetFileById.PathParameters> | null,
@@ -13525,6 +13799,11 @@ export interface OperationMethods {
13525
13799
  *
13526
13800
  * Token is valid for 5 minutes.
13527
13801
  *
13802
+ * Supports three identification methods (at least one required):
13803
+ * 1. Using portal_id (takes precedence)
13804
+ * 2. Using domain
13805
+ * 3. Using origin (legacy)
13806
+ *
13528
13807
  */
13529
13808
  'loginToPortalAsUser'(
13530
13809
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -13544,7 +13823,11 @@ export interface OperationMethods {
13544
13823
  /**
13545
13824
  * triggerEntityAccessEventV3 - triggerEntityAccessEventV3
13546
13825
  *
13547
- * Trigger entity access event for a portal user
13826
+ * Trigger entity access event for a portal user.
13827
+ * Supports two identification methods:
13828
+ * 1. Using portal_id
13829
+ * 2. Using domain
13830
+ *
13548
13831
  */
13549
13832
  'triggerEntityAccessEventV3'(
13550
13833
  parameters?: Parameters<Paths.TriggerEntityAccessEventV3.QueryParameters & Paths.TriggerEntityAccessEventV3.PathParameters> | null,
@@ -13664,7 +13947,11 @@ export interface OperationMethods {
13664
13947
  *
13665
13948
  * Verifies the user with the issuer and matches the identity to an epilot user (or creates a new user).
13666
13949
  *
13667
- * Returns parameters to be used with CUSTOM_AUTH flow against Cognito
13950
+ * Returns parameters to be used with CUSTOM_AUTH flow against Cognito.
13951
+ *
13952
+ * Supports two identification methods:
13953
+ * 1. Using org_id + portal_id
13954
+ * 2. Using domain
13668
13955
  *
13669
13956
  */
13670
13957
  'ssoLoginV3'(
@@ -14027,7 +14314,11 @@ export interface PathsDictionary {
14027
14314
  /**
14028
14315
  * createUserV3 - createUserV3
14029
14316
  *
14030
- * Registers a portal user with portal id
14317
+ * Registers a portal user.
14318
+ * Supports two identification methods:
14319
+ * 1. Using portal_id
14320
+ * 2. Using domain
14321
+ *
14031
14322
  */
14032
14323
  'post'(
14033
14324
  parameters?: Parameters<Paths.CreateUserV3.QueryParameters> | null,
@@ -14349,7 +14640,7 @@ export interface PathsDictionary {
14349
14640
  /**
14350
14641
  * getPublicPortalWidgets - getPublicPortalWidgets
14351
14642
  *
14352
- * Retrieves the public widgets of a portal
14643
+ * Retrieves the public widgets of a portal.
14353
14644
  */
14354
14645
  'get'(
14355
14646
  parameters?: Parameters<Paths.GetPublicPortalWidgets.QueryParameters> | null,
@@ -14371,7 +14662,7 @@ export interface PathsDictionary {
14371
14662
  /**
14372
14663
  * getPortalWidgets - getPortalWidgets
14373
14664
  *
14374
- * Retrieves the widgets of a portal
14665
+ * Retrieves the widgets of a portal.
14375
14666
  */
14376
14667
  'get'(
14377
14668
  parameters?: Parameters<Paths.GetPortalWidgets.QueryParameters> | null,
@@ -14379,6 +14670,40 @@ export interface PathsDictionary {
14379
14670
  config?: AxiosRequestConfig
14380
14671
  ): OperationResponse<Paths.GetPortalWidgets.Responses.$200>
14381
14672
  }
14673
+ ['/v3/portal/widgets']: {
14674
+ /**
14675
+ * getPortalWidgetsV3 - getPortalWidgetsV3
14676
+ *
14677
+ * Retrieves the widgets of a portal by portal_id.
14678
+ */
14679
+ 'get'(
14680
+ parameters?: Parameters<Paths.GetPortalWidgetsV3.QueryParameters> | null,
14681
+ data?: any,
14682
+ config?: AxiosRequestConfig
14683
+ ): OperationResponse<Paths.GetPortalWidgetsV3.Responses.$200>
14684
+ /**
14685
+ * upsertPortalWidgetV3 - upsertPortalWidgetV3
14686
+ *
14687
+ * Upsert widget for a portal by portal_id.
14688
+ */
14689
+ 'post'(
14690
+ parameters?: Parameters<Paths.UpsertPortalWidgetV3.QueryParameters> | null,
14691
+ data?: Paths.UpsertPortalWidgetV3.RequestBody,
14692
+ config?: AxiosRequestConfig
14693
+ ): OperationResponse<Paths.UpsertPortalWidgetV3.Responses.$201>
14694
+ }
14695
+ ['/v3/portal/portal/files']: {
14696
+ /**
14697
+ * savePortalFilesV3 - savePortalFilesV3
14698
+ *
14699
+ * Add files to portal by portal_id
14700
+ */
14701
+ 'post'(
14702
+ parameters?: Parameters<Paths.SavePortalFilesV3.QueryParameters> | null,
14703
+ data?: Paths.SavePortalFilesV3.RequestBody,
14704
+ config?: AxiosRequestConfig
14705
+ ): OperationResponse<Paths.SavePortalFilesV3.Responses.$201>
14706
+ }
14382
14707
  ['/v2/portal/replace-ecp-template-variables']: {
14383
14708
  /**
14384
14709
  * replaceECPTemplateVariables - replaceECPTemplateVariables
@@ -14526,6 +14851,10 @@ export interface PathsDictionary {
14526
14851
  * checkContactExistsV3 - checkContactExistsV3
14527
14852
  *
14528
14853
  * True if contact with given identifiers exists.
14854
+ * Supports two identification methods:
14855
+ * 1. Using portal_id
14856
+ * 2. Using domain
14857
+ *
14529
14858
  */
14530
14859
  'post'(
14531
14860
  parameters?: Parameters<Paths.CheckContactExistsV3.QueryParameters> | null,
@@ -14653,7 +14982,11 @@ export interface PathsDictionary {
14653
14982
  /**
14654
14983
  * userExistsV3 - userExistsV3
14655
14984
  *
14656
- * Checks whether a user exists in the portal
14985
+ * Checks whether a user exists in the portal.
14986
+ * Supports two identification methods:
14987
+ * 1. Using org_id + portal_id
14988
+ * 2. Using domain
14989
+ *
14657
14990
  */
14658
14991
  'get'(
14659
14992
  parameters?: Parameters<Paths.UserExistsV3.QueryParameters> | null,
@@ -14701,7 +15034,7 @@ export interface PathsDictionary {
14701
15034
  /**
14702
15035
  * getAllOrders - getAllOrders
14703
15036
  *
14704
- * Get all orders for the portal user
15037
+ * Get all orders for the portal user. Use searchPortalUserEntities instead.
14705
15038
  */
14706
15039
  'get'(
14707
15040
  parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
@@ -14725,7 +15058,7 @@ export interface PathsDictionary {
14725
15058
  /**
14726
15059
  * getOrder - getOrder
14727
15060
  *
14728
- * Get an order by id
15061
+ * Get an order by id. Use getPortalUserEntity instead.
14729
15062
  */
14730
15063
  'get'(
14731
15064
  parameters?: Parameters<Paths.GetOrder.PathParameters> | null,
@@ -14735,7 +15068,7 @@ export interface PathsDictionary {
14735
15068
  /**
14736
15069
  * updateOrder - updateOrder
14737
15070
  *
14738
- * Update an order by id
15071
+ * Update an order by id. Use getPortalUserEntity instead.
14739
15072
  */
14740
15073
  'patch'(
14741
15074
  parameters?: Parameters<Paths.UpdateOrder.PathParameters> | null,
@@ -14747,7 +15080,7 @@ export interface PathsDictionary {
14747
15080
  /**
14748
15081
  * getAllOpportunities - getAllOpportunities
14749
15082
  *
14750
- * Get all opportunities of a portal user
15083
+ * Get all opportunities of a portal user. Use searchPortalUserEntities instead.
14751
15084
  */
14752
15085
  'get'(
14753
15086
  parameters?: Parameters<Paths.GetAllOpportunities.QueryParameters> | null,
@@ -14759,7 +15092,7 @@ export interface PathsDictionary {
14759
15092
  /**
14760
15093
  * getSearchableAttributesForOpportunities - getSearchableAttributesForOpportunities
14761
15094
  *
14762
- * Get all opportunity searchable attributes for a portal user
15095
+ * Get all opportunity searchable attributes for a portal user. Use searchPortalUserEntities instead.
14763
15096
  */
14764
15097
  'get'(
14765
15098
  parameters?: Parameters<Paths.GetSearchableAttributesForOpportunities.QueryParameters> | null,
@@ -14771,7 +15104,7 @@ export interface PathsDictionary {
14771
15104
  /**
14772
15105
  * getSearchResultsForOpportunities - getSearchResultsForOpportunities
14773
15106
  *
14774
- * Get all opportunity with the given serached attributes
15107
+ * Get all opportunity with the given searched attributes. Use searchPortalUserEntities instead.
14775
15108
  */
14776
15109
  'post'(
14777
15110
  parameters?: Parameters<Paths.GetSearchResultsForOpportunities.QueryParameters> | null,
@@ -14783,7 +15116,7 @@ export interface PathsDictionary {
14783
15116
  /**
14784
15117
  * getOpportunity - getOpportunity
14785
15118
  *
14786
- * Get an opportunity by id
15119
+ * Get an opportunity by id. Use getPortalUserEntity instead.
14787
15120
  */
14788
15121
  'get'(
14789
15122
  parameters?: Parameters<Paths.GetOpportunity.PathParameters> | null,
@@ -14793,7 +15126,7 @@ export interface PathsDictionary {
14793
15126
  /**
14794
15127
  * updateOpportunity - updateOpportunity
14795
15128
  *
14796
- * Update an opportunity by id
15129
+ * Update an opportunity by id.
14797
15130
  */
14798
15131
  'patch'(
14799
15132
  parameters?: Parameters<Paths.UpdateOpportunity.PathParameters> | null,
@@ -14805,7 +15138,7 @@ export interface PathsDictionary {
14805
15138
  /**
14806
15139
  * getAllRequests - getAllRequests
14807
15140
  *
14808
- * Get all opportunities & orders of a portal user
15141
+ * Get all opportunities & orders of a portal user. Use searchPortalUserEntities instead.
14809
15142
  */
14810
15143
  'get'(
14811
15144
  parameters?: Parameters<Paths.GetAllRequests.QueryParameters> | null,
@@ -14817,7 +15150,7 @@ export interface PathsDictionary {
14817
15150
  /**
14818
15151
  * getAllContracts - getAllContracts
14819
15152
  *
14820
- * Get all contracts for a portal user
15153
+ * Get all contracts for a portal user. Use searchPortalUserEntities instead.
14821
15154
  */
14822
15155
  'get'(
14823
15156
  parameters?: Parameters<Paths.GetAllContracts.QueryParameters> | null,
@@ -14829,7 +15162,7 @@ export interface PathsDictionary {
14829
15162
  /**
14830
15163
  * getContract - getContract
14831
15164
  *
14832
- * Get a contract by id
15165
+ * Get a contract by id. Use getPortalUserEntity instead.
14833
15166
  */
14834
15167
  'get'(
14835
15168
  parameters?: Parameters<Paths.GetContract.PathParameters> | null,
@@ -14839,7 +15172,7 @@ export interface PathsDictionary {
14839
15172
  /**
14840
15173
  * updateContract - updateContract
14841
15174
  *
14842
- * Update a contract by id
15175
+ * Update a contract by id. Use getPortalUserEntity instead.
14843
15176
  */
14844
15177
  'patch'(
14845
15178
  parameters?: Parameters<Paths.UpdateContract.PathParameters> | null,
@@ -14984,7 +15317,7 @@ export interface PathsDictionary {
14984
15317
  /**
14985
15318
  * getFileById - getFileById
14986
15319
  *
14987
- * Fetch a document with ID
15320
+ * Fetch a document with ID. Use getPortalUserEntity instead.
14988
15321
  */
14989
15322
  'get'(
14990
15323
  parameters?: Parameters<Paths.GetFileById.PathParameters> | null,
@@ -15060,6 +15393,11 @@ export interface PathsDictionary {
15060
15393
  *
15061
15394
  * Token is valid for 5 minutes.
15062
15395
  *
15396
+ * Supports three identification methods (at least one required):
15397
+ * 1. Using portal_id (takes precedence)
15398
+ * 2. Using domain
15399
+ * 3. Using origin (legacy)
15400
+ *
15063
15401
  */
15064
15402
  'post'(
15065
15403
  parameters?: Parameters<UnknownParamsObject> | null,
@@ -15083,7 +15421,11 @@ export interface PathsDictionary {
15083
15421
  /**
15084
15422
  * triggerEntityAccessEventV3 - triggerEntityAccessEventV3
15085
15423
  *
15086
- * Trigger entity access event for a portal user
15424
+ * Trigger entity access event for a portal user.
15425
+ * Supports two identification methods:
15426
+ * 1. Using portal_id
15427
+ * 2. Using domain
15428
+ *
15087
15429
  */
15088
15430
  'post'(
15089
15431
  parameters?: Parameters<Paths.TriggerEntityAccessEventV3.QueryParameters & Paths.TriggerEntityAccessEventV3.PathParameters> | null,
@@ -15225,7 +15567,11 @@ export interface PathsDictionary {
15225
15567
  *
15226
15568
  * Verifies the user with the issuer and matches the identity to an epilot user (or creates a new user).
15227
15569
  *
15228
- * Returns parameters to be used with CUSTOM_AUTH flow against Cognito
15570
+ * Returns parameters to be used with CUSTOM_AUTH flow against Cognito.
15571
+ *
15572
+ * Supports two identification methods:
15573
+ * 1. Using org_id + portal_id
15574
+ * 2. Using domain
15229
15575
  *
15230
15576
  */
15231
15577
  'post'(
@@ -15737,6 +16083,7 @@ export type SaveEntityFile = Components.Schemas.SaveEntityFile;
15737
16083
  export type SavePortalFile = Components.Schemas.SavePortalFile;
15738
16084
  export type Schema = Components.Schemas.Schema;
15739
16085
  export type SearchIncludes = Components.Schemas.SearchIncludes;
16086
+ export type SecureProxyConfig = Components.Schemas.SecureProxyConfig;
15740
16087
  export type Source = Components.Schemas.Source;
15741
16088
  export type SwappableConfig = Components.Schemas.SwappableConfig;
15742
16089
  export type TariffType = Components.Schemas.TariffType;