@epilot/customer-portal-client 0.34.0 → 0.35.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/definition.js +1 -1
- package/dist/openapi-runtime.json +17 -0
- package/dist/openapi.d.ts +173 -31
- package/package.json +14 -13
- package/src/openapi-runtime.json +17 -0
- package/src/openapi.json +216 -19
- package/LICENSE +0 -21
- package/src/openapi.d.ts +0 -15754
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
|
|
@@ -4522,6 +4600,38 @@ declare namespace Components {
|
|
|
4522
4600
|
*/
|
|
4523
4601
|
visibility?: {
|
|
4524
4602
|
[name: string]: any;
|
|
4603
|
+
/**
|
|
4604
|
+
* Page is fully hidden from portal users
|
|
4605
|
+
*/
|
|
4606
|
+
is_hidden?: boolean;
|
|
4607
|
+
/**
|
|
4608
|
+
* Page is hidden in the mobile app
|
|
4609
|
+
*/
|
|
4610
|
+
hidden_in_app?: boolean;
|
|
4611
|
+
/**
|
|
4612
|
+
* Schedule visibility start date. If only start_date is set, page is visible from this date onwards.
|
|
4613
|
+
*/
|
|
4614
|
+
start_date?: string; // date-time
|
|
4615
|
+
/**
|
|
4616
|
+
* Schedule visibility end date. If only end_date is set, page is visible until this date.
|
|
4617
|
+
*/
|
|
4618
|
+
end_date?: string; // date-time
|
|
4619
|
+
/**
|
|
4620
|
+
* Target IDs that must match for the page to be visible
|
|
4621
|
+
*/
|
|
4622
|
+
visible_for_targets?: string[];
|
|
4623
|
+
/**
|
|
4624
|
+
* Operator for visible_for_targets matching
|
|
4625
|
+
*/
|
|
4626
|
+
visible_for_operator?: "and" | "or";
|
|
4627
|
+
/**
|
|
4628
|
+
* Target IDs that if matched will hide the page
|
|
4629
|
+
*/
|
|
4630
|
+
hidden_for_targets?: string[];
|
|
4631
|
+
/**
|
|
4632
|
+
* Operator for hidden_for_targets matching
|
|
4633
|
+
*/
|
|
4634
|
+
hidden_for_operator?: "and" | "or";
|
|
4525
4635
|
};
|
|
4526
4636
|
/**
|
|
4527
4637
|
* The content of the page
|
|
@@ -6122,6 +6232,19 @@ declare namespace Components {
|
|
|
6122
6232
|
};
|
|
6123
6233
|
};
|
|
6124
6234
|
}
|
|
6235
|
+
/**
|
|
6236
|
+
* Configuration for routing requests through the ERP Integration secure proxy. Mutually exclusive with use_static_ips.
|
|
6237
|
+
*/
|
|
6238
|
+
export interface SecureProxyConfig {
|
|
6239
|
+
/**
|
|
6240
|
+
* Integration ID that owns the secure_proxy use case.
|
|
6241
|
+
*/
|
|
6242
|
+
integration_id: string; // uuid
|
|
6243
|
+
/**
|
|
6244
|
+
* Use case slug for the secure proxy use case.
|
|
6245
|
+
*/
|
|
6246
|
+
use_case_slug: string;
|
|
6247
|
+
}
|
|
6125
6248
|
export type Source = "ECP" | "ERP" | "360" | "journey-submission";
|
|
6126
6249
|
export type SwappableConfig = "all" | "domain" | "users" | "email_templates";
|
|
6127
6250
|
export type TariffType = "ht" | "nt";
|
|
@@ -11234,6 +11357,10 @@ declare namespace Paths {
|
|
|
11234
11357
|
* ]
|
|
11235
11358
|
*/
|
|
11236
11359
|
Components.Schemas.ContextEntities;
|
|
11360
|
+
/**
|
|
11361
|
+
* 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.
|
|
11362
|
+
*/
|
|
11363
|
+
evaluate_targeting?: boolean;
|
|
11237
11364
|
}
|
|
11238
11365
|
namespace Responses {
|
|
11239
11366
|
export type $200 = Components.Schemas.Page[];
|
|
@@ -11257,10 +11384,20 @@ declare namespace Paths {
|
|
|
11257
11384
|
/**
|
|
11258
11385
|
* Additional contact entity fields to set when creating the contact for the invited user.
|
|
11259
11386
|
* These are mapped directly to contact entity attributes (e.g. first_name, last_name, phone).
|
|
11387
|
+
* Values can be strings or arrays of strings (for multiselect attributes).
|
|
11260
11388
|
*
|
|
11261
11389
|
*/
|
|
11262
11390
|
contact_data?: {
|
|
11263
|
-
[name: string]: string;
|
|
11391
|
+
[name: string]: string | string[];
|
|
11392
|
+
};
|
|
11393
|
+
/**
|
|
11394
|
+
* Additional portal user entity fields to set when creating the portal user for the invited user.
|
|
11395
|
+
* These are mapped directly to portal_user entity attributes.
|
|
11396
|
+
* Values can be strings or arrays of strings (for multiselect attributes).
|
|
11397
|
+
*
|
|
11398
|
+
*/
|
|
11399
|
+
portal_user_data?: {
|
|
11400
|
+
[name: string]: string | string[];
|
|
11264
11401
|
};
|
|
11265
11402
|
}
|
|
11266
11403
|
namespace Responses {
|
|
@@ -11307,6 +11444,10 @@ declare namespace Paths {
|
|
|
11307
11444
|
*/
|
|
11308
11445
|
email?: string;
|
|
11309
11446
|
origin?: /* Origin of the portal */ Components.Schemas.Origin;
|
|
11447
|
+
/**
|
|
11448
|
+
* The portal ID to look up the portal config. When provided, takes precedence over origin.
|
|
11449
|
+
*/
|
|
11450
|
+
portal_id?: string;
|
|
11310
11451
|
}
|
|
11311
11452
|
namespace Responses {
|
|
11312
11453
|
export interface $200 {
|
|
@@ -12918,7 +13059,7 @@ export interface OperationMethods {
|
|
|
12918
13059
|
/**
|
|
12919
13060
|
* getPublicPortalWidgets - getPublicPortalWidgets
|
|
12920
13061
|
*
|
|
12921
|
-
* Retrieves the public widgets of a portal
|
|
13062
|
+
* Retrieves the public widgets of a portal.
|
|
12922
13063
|
*/
|
|
12923
13064
|
'getPublicPortalWidgets'(
|
|
12924
13065
|
parameters?: Parameters<Paths.GetPublicPortalWidgets.QueryParameters> | null,
|
|
@@ -12928,7 +13069,7 @@ export interface OperationMethods {
|
|
|
12928
13069
|
/**
|
|
12929
13070
|
* getPortalWidgets - getPortalWidgets
|
|
12930
13071
|
*
|
|
12931
|
-
* Retrieves the widgets of a portal
|
|
13072
|
+
* Retrieves the widgets of a portal.
|
|
12932
13073
|
*/
|
|
12933
13074
|
'getPortalWidgets'(
|
|
12934
13075
|
parameters?: Parameters<Paths.GetPortalWidgets.QueryParameters> | null,
|
|
@@ -13218,7 +13359,7 @@ export interface OperationMethods {
|
|
|
13218
13359
|
/**
|
|
13219
13360
|
* getAllOrders - getAllOrders
|
|
13220
13361
|
*
|
|
13221
|
-
* Get all orders for the portal user
|
|
13362
|
+
* Get all orders for the portal user. Use searchPortalUserEntities instead.
|
|
13222
13363
|
*/
|
|
13223
13364
|
'getAllOrders'(
|
|
13224
13365
|
parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
|
|
@@ -13238,7 +13379,7 @@ export interface OperationMethods {
|
|
|
13238
13379
|
/**
|
|
13239
13380
|
* getOrder - getOrder
|
|
13240
13381
|
*
|
|
13241
|
-
* Get an order by id
|
|
13382
|
+
* Get an order by id. Use getPortalUserEntity instead.
|
|
13242
13383
|
*/
|
|
13243
13384
|
'getOrder'(
|
|
13244
13385
|
parameters?: Parameters<Paths.GetOrder.PathParameters> | null,
|
|
@@ -13248,7 +13389,7 @@ export interface OperationMethods {
|
|
|
13248
13389
|
/**
|
|
13249
13390
|
* updateOrder - updateOrder
|
|
13250
13391
|
*
|
|
13251
|
-
* Update an order by id
|
|
13392
|
+
* Update an order by id. Use getPortalUserEntity instead.
|
|
13252
13393
|
*/
|
|
13253
13394
|
'updateOrder'(
|
|
13254
13395
|
parameters?: Parameters<Paths.UpdateOrder.PathParameters> | null,
|
|
@@ -13258,7 +13399,7 @@ export interface OperationMethods {
|
|
|
13258
13399
|
/**
|
|
13259
13400
|
* getAllOpportunities - getAllOpportunities
|
|
13260
13401
|
*
|
|
13261
|
-
* Get all opportunities of a portal user
|
|
13402
|
+
* Get all opportunities of a portal user. Use searchPortalUserEntities instead.
|
|
13262
13403
|
*/
|
|
13263
13404
|
'getAllOpportunities'(
|
|
13264
13405
|
parameters?: Parameters<Paths.GetAllOpportunities.QueryParameters> | null,
|
|
@@ -13268,7 +13409,7 @@ export interface OperationMethods {
|
|
|
13268
13409
|
/**
|
|
13269
13410
|
* getSearchableAttributesForOpportunities - getSearchableAttributesForOpportunities
|
|
13270
13411
|
*
|
|
13271
|
-
* Get all opportunity searchable attributes for a portal user
|
|
13412
|
+
* Get all opportunity searchable attributes for a portal user. Use searchPortalUserEntities instead.
|
|
13272
13413
|
*/
|
|
13273
13414
|
'getSearchableAttributesForOpportunities'(
|
|
13274
13415
|
parameters?: Parameters<Paths.GetSearchableAttributesForOpportunities.QueryParameters> | null,
|
|
@@ -13278,7 +13419,7 @@ export interface OperationMethods {
|
|
|
13278
13419
|
/**
|
|
13279
13420
|
* getSearchResultsForOpportunities - getSearchResultsForOpportunities
|
|
13280
13421
|
*
|
|
13281
|
-
* Get all opportunity with the given
|
|
13422
|
+
* Get all opportunity with the given searched attributes. Use searchPortalUserEntities instead.
|
|
13282
13423
|
*/
|
|
13283
13424
|
'getSearchResultsForOpportunities'(
|
|
13284
13425
|
parameters?: Parameters<Paths.GetSearchResultsForOpportunities.QueryParameters> | null,
|
|
@@ -13288,7 +13429,7 @@ export interface OperationMethods {
|
|
|
13288
13429
|
/**
|
|
13289
13430
|
* getOpportunity - getOpportunity
|
|
13290
13431
|
*
|
|
13291
|
-
* Get an opportunity by id
|
|
13432
|
+
* Get an opportunity by id. Use getPortalUserEntity instead.
|
|
13292
13433
|
*/
|
|
13293
13434
|
'getOpportunity'(
|
|
13294
13435
|
parameters?: Parameters<Paths.GetOpportunity.PathParameters> | null,
|
|
@@ -13298,7 +13439,7 @@ export interface OperationMethods {
|
|
|
13298
13439
|
/**
|
|
13299
13440
|
* updateOpportunity - updateOpportunity
|
|
13300
13441
|
*
|
|
13301
|
-
* Update an opportunity by id
|
|
13442
|
+
* Update an opportunity by id.
|
|
13302
13443
|
*/
|
|
13303
13444
|
'updateOpportunity'(
|
|
13304
13445
|
parameters?: Parameters<Paths.UpdateOpportunity.PathParameters> | null,
|
|
@@ -13308,7 +13449,7 @@ export interface OperationMethods {
|
|
|
13308
13449
|
/**
|
|
13309
13450
|
* getAllRequests - getAllRequests
|
|
13310
13451
|
*
|
|
13311
|
-
* Get all opportunities & orders of a portal user
|
|
13452
|
+
* Get all opportunities & orders of a portal user. Use searchPortalUserEntities instead.
|
|
13312
13453
|
*/
|
|
13313
13454
|
'getAllRequests'(
|
|
13314
13455
|
parameters?: Parameters<Paths.GetAllRequests.QueryParameters> | null,
|
|
@@ -13318,7 +13459,7 @@ export interface OperationMethods {
|
|
|
13318
13459
|
/**
|
|
13319
13460
|
* getAllContracts - getAllContracts
|
|
13320
13461
|
*
|
|
13321
|
-
* Get all contracts for a portal user
|
|
13462
|
+
* Get all contracts for a portal user. Use searchPortalUserEntities instead.
|
|
13322
13463
|
*/
|
|
13323
13464
|
'getAllContracts'(
|
|
13324
13465
|
parameters?: Parameters<Paths.GetAllContracts.QueryParameters> | null,
|
|
@@ -13328,7 +13469,7 @@ export interface OperationMethods {
|
|
|
13328
13469
|
/**
|
|
13329
13470
|
* getContract - getContract
|
|
13330
13471
|
*
|
|
13331
|
-
* Get a contract by id
|
|
13472
|
+
* Get a contract by id. Use getPortalUserEntity instead.
|
|
13332
13473
|
*/
|
|
13333
13474
|
'getContract'(
|
|
13334
13475
|
parameters?: Parameters<Paths.GetContract.PathParameters> | null,
|
|
@@ -13338,7 +13479,7 @@ export interface OperationMethods {
|
|
|
13338
13479
|
/**
|
|
13339
13480
|
* updateContract - updateContract
|
|
13340
13481
|
*
|
|
13341
|
-
* Update a contract by id
|
|
13482
|
+
* Update a contract by id. Use getPortalUserEntity instead.
|
|
13342
13483
|
*/
|
|
13343
13484
|
'updateContract'(
|
|
13344
13485
|
parameters?: Parameters<Paths.UpdateContract.PathParameters> | null,
|
|
@@ -13461,7 +13602,7 @@ export interface OperationMethods {
|
|
|
13461
13602
|
/**
|
|
13462
13603
|
* getFileById - getFileById
|
|
13463
13604
|
*
|
|
13464
|
-
* Fetch a document with ID
|
|
13605
|
+
* Fetch a document with ID. Use getPortalUserEntity instead.
|
|
13465
13606
|
*/
|
|
13466
13607
|
'getFileById'(
|
|
13467
13608
|
parameters?: Parameters<Paths.GetFileById.PathParameters> | null,
|
|
@@ -14349,7 +14490,7 @@ export interface PathsDictionary {
|
|
|
14349
14490
|
/**
|
|
14350
14491
|
* getPublicPortalWidgets - getPublicPortalWidgets
|
|
14351
14492
|
*
|
|
14352
|
-
* Retrieves the public widgets of a portal
|
|
14493
|
+
* Retrieves the public widgets of a portal.
|
|
14353
14494
|
*/
|
|
14354
14495
|
'get'(
|
|
14355
14496
|
parameters?: Parameters<Paths.GetPublicPortalWidgets.QueryParameters> | null,
|
|
@@ -14371,7 +14512,7 @@ export interface PathsDictionary {
|
|
|
14371
14512
|
/**
|
|
14372
14513
|
* getPortalWidgets - getPortalWidgets
|
|
14373
14514
|
*
|
|
14374
|
-
* Retrieves the widgets of a portal
|
|
14515
|
+
* Retrieves the widgets of a portal.
|
|
14375
14516
|
*/
|
|
14376
14517
|
'get'(
|
|
14377
14518
|
parameters?: Parameters<Paths.GetPortalWidgets.QueryParameters> | null,
|
|
@@ -14701,7 +14842,7 @@ export interface PathsDictionary {
|
|
|
14701
14842
|
/**
|
|
14702
14843
|
* getAllOrders - getAllOrders
|
|
14703
14844
|
*
|
|
14704
|
-
* Get all orders for the portal user
|
|
14845
|
+
* Get all orders for the portal user. Use searchPortalUserEntities instead.
|
|
14705
14846
|
*/
|
|
14706
14847
|
'get'(
|
|
14707
14848
|
parameters?: Parameters<Paths.GetAllOrders.QueryParameters> | null,
|
|
@@ -14725,7 +14866,7 @@ export interface PathsDictionary {
|
|
|
14725
14866
|
/**
|
|
14726
14867
|
* getOrder - getOrder
|
|
14727
14868
|
*
|
|
14728
|
-
* Get an order by id
|
|
14869
|
+
* Get an order by id. Use getPortalUserEntity instead.
|
|
14729
14870
|
*/
|
|
14730
14871
|
'get'(
|
|
14731
14872
|
parameters?: Parameters<Paths.GetOrder.PathParameters> | null,
|
|
@@ -14735,7 +14876,7 @@ export interface PathsDictionary {
|
|
|
14735
14876
|
/**
|
|
14736
14877
|
* updateOrder - updateOrder
|
|
14737
14878
|
*
|
|
14738
|
-
* Update an order by id
|
|
14879
|
+
* Update an order by id. Use getPortalUserEntity instead.
|
|
14739
14880
|
*/
|
|
14740
14881
|
'patch'(
|
|
14741
14882
|
parameters?: Parameters<Paths.UpdateOrder.PathParameters> | null,
|
|
@@ -14747,7 +14888,7 @@ export interface PathsDictionary {
|
|
|
14747
14888
|
/**
|
|
14748
14889
|
* getAllOpportunities - getAllOpportunities
|
|
14749
14890
|
*
|
|
14750
|
-
* Get all opportunities of a portal user
|
|
14891
|
+
* Get all opportunities of a portal user. Use searchPortalUserEntities instead.
|
|
14751
14892
|
*/
|
|
14752
14893
|
'get'(
|
|
14753
14894
|
parameters?: Parameters<Paths.GetAllOpportunities.QueryParameters> | null,
|
|
@@ -14759,7 +14900,7 @@ export interface PathsDictionary {
|
|
|
14759
14900
|
/**
|
|
14760
14901
|
* getSearchableAttributesForOpportunities - getSearchableAttributesForOpportunities
|
|
14761
14902
|
*
|
|
14762
|
-
* Get all opportunity searchable attributes for a portal user
|
|
14903
|
+
* Get all opportunity searchable attributes for a portal user. Use searchPortalUserEntities instead.
|
|
14763
14904
|
*/
|
|
14764
14905
|
'get'(
|
|
14765
14906
|
parameters?: Parameters<Paths.GetSearchableAttributesForOpportunities.QueryParameters> | null,
|
|
@@ -14771,7 +14912,7 @@ export interface PathsDictionary {
|
|
|
14771
14912
|
/**
|
|
14772
14913
|
* getSearchResultsForOpportunities - getSearchResultsForOpportunities
|
|
14773
14914
|
*
|
|
14774
|
-
* Get all opportunity with the given
|
|
14915
|
+
* Get all opportunity with the given searched attributes. Use searchPortalUserEntities instead.
|
|
14775
14916
|
*/
|
|
14776
14917
|
'post'(
|
|
14777
14918
|
parameters?: Parameters<Paths.GetSearchResultsForOpportunities.QueryParameters> | null,
|
|
@@ -14783,7 +14924,7 @@ export interface PathsDictionary {
|
|
|
14783
14924
|
/**
|
|
14784
14925
|
* getOpportunity - getOpportunity
|
|
14785
14926
|
*
|
|
14786
|
-
* Get an opportunity by id
|
|
14927
|
+
* Get an opportunity by id. Use getPortalUserEntity instead.
|
|
14787
14928
|
*/
|
|
14788
14929
|
'get'(
|
|
14789
14930
|
parameters?: Parameters<Paths.GetOpportunity.PathParameters> | null,
|
|
@@ -14793,7 +14934,7 @@ export interface PathsDictionary {
|
|
|
14793
14934
|
/**
|
|
14794
14935
|
* updateOpportunity - updateOpportunity
|
|
14795
14936
|
*
|
|
14796
|
-
* Update an opportunity by id
|
|
14937
|
+
* Update an opportunity by id.
|
|
14797
14938
|
*/
|
|
14798
14939
|
'patch'(
|
|
14799
14940
|
parameters?: Parameters<Paths.UpdateOpportunity.PathParameters> | null,
|
|
@@ -14805,7 +14946,7 @@ export interface PathsDictionary {
|
|
|
14805
14946
|
/**
|
|
14806
14947
|
* getAllRequests - getAllRequests
|
|
14807
14948
|
*
|
|
14808
|
-
* Get all opportunities & orders of a portal user
|
|
14949
|
+
* Get all opportunities & orders of a portal user. Use searchPortalUserEntities instead.
|
|
14809
14950
|
*/
|
|
14810
14951
|
'get'(
|
|
14811
14952
|
parameters?: Parameters<Paths.GetAllRequests.QueryParameters> | null,
|
|
@@ -14817,7 +14958,7 @@ export interface PathsDictionary {
|
|
|
14817
14958
|
/**
|
|
14818
14959
|
* getAllContracts - getAllContracts
|
|
14819
14960
|
*
|
|
14820
|
-
* Get all contracts for a portal user
|
|
14961
|
+
* Get all contracts for a portal user. Use searchPortalUserEntities instead.
|
|
14821
14962
|
*/
|
|
14822
14963
|
'get'(
|
|
14823
14964
|
parameters?: Parameters<Paths.GetAllContracts.QueryParameters> | null,
|
|
@@ -14829,7 +14970,7 @@ export interface PathsDictionary {
|
|
|
14829
14970
|
/**
|
|
14830
14971
|
* getContract - getContract
|
|
14831
14972
|
*
|
|
14832
|
-
* Get a contract by id
|
|
14973
|
+
* Get a contract by id. Use getPortalUserEntity instead.
|
|
14833
14974
|
*/
|
|
14834
14975
|
'get'(
|
|
14835
14976
|
parameters?: Parameters<Paths.GetContract.PathParameters> | null,
|
|
@@ -14839,7 +14980,7 @@ export interface PathsDictionary {
|
|
|
14839
14980
|
/**
|
|
14840
14981
|
* updateContract - updateContract
|
|
14841
14982
|
*
|
|
14842
|
-
* Update a contract by id
|
|
14983
|
+
* Update a contract by id. Use getPortalUserEntity instead.
|
|
14843
14984
|
*/
|
|
14844
14985
|
'patch'(
|
|
14845
14986
|
parameters?: Parameters<Paths.UpdateContract.PathParameters> | null,
|
|
@@ -14984,7 +15125,7 @@ export interface PathsDictionary {
|
|
|
14984
15125
|
/**
|
|
14985
15126
|
* getFileById - getFileById
|
|
14986
15127
|
*
|
|
14987
|
-
* Fetch a document with ID
|
|
15128
|
+
* Fetch a document with ID. Use getPortalUserEntity instead.
|
|
14988
15129
|
*/
|
|
14989
15130
|
'get'(
|
|
14990
15131
|
parameters?: Parameters<Paths.GetFileById.PathParameters> | null,
|
|
@@ -15737,6 +15878,7 @@ export type SaveEntityFile = Components.Schemas.SaveEntityFile;
|
|
|
15737
15878
|
export type SavePortalFile = Components.Schemas.SavePortalFile;
|
|
15738
15879
|
export type Schema = Components.Schemas.Schema;
|
|
15739
15880
|
export type SearchIncludes = Components.Schemas.SearchIncludes;
|
|
15881
|
+
export type SecureProxyConfig = Components.Schemas.SecureProxyConfig;
|
|
15740
15882
|
export type Source = Components.Schemas.Source;
|
|
15741
15883
|
export type SwappableConfig = Components.Schemas.SwappableConfig;
|
|
15742
15884
|
export type TariffType = Components.Schemas.TariffType;
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@epilot/customer-portal-client",
|
|
3
|
-
"version": "0.
|
|
3
|
+
"version": "0.35.0",
|
|
4
4
|
"description": "API Client for epilot portal API",
|
|
5
5
|
"main": "dist/index.js",
|
|
6
6
|
"types": "dist/index.d.ts",
|
|
@@ -18,6 +18,18 @@
|
|
|
18
18
|
"sdk",
|
|
19
19
|
"customer-portal"
|
|
20
20
|
],
|
|
21
|
+
"scripts": {
|
|
22
|
+
"test": "vitest",
|
|
23
|
+
"typescript": "tsc",
|
|
24
|
+
"bundle-definition": "webpack",
|
|
25
|
+
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/customer-portal.yaml",
|
|
26
|
+
"typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
|
|
27
|
+
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
28
|
+
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
29
|
+
"build:watch": "npm run build && tsc -w",
|
|
30
|
+
"prepublishOnly": "npm run typegen && npm run build",
|
|
31
|
+
"lint": "biome check src"
|
|
32
|
+
},
|
|
21
33
|
"files": [
|
|
22
34
|
"*.js",
|
|
23
35
|
"*.d.ts",
|
|
@@ -55,16 +67,5 @@
|
|
|
55
67
|
"typescript": "^4.1.3",
|
|
56
68
|
"webpack": "^5.18.0",
|
|
57
69
|
"webpack-cli": "^4.4.0"
|
|
58
|
-
},
|
|
59
|
-
"scripts": {
|
|
60
|
-
"test": "vitest",
|
|
61
|
-
"typescript": "tsc",
|
|
62
|
-
"bundle-definition": "webpack",
|
|
63
|
-
"openapi": "node ../../scripts/update-openapi.js https://docs.api.epilot.io/customer-portal.yaml",
|
|
64
|
-
"typegen": "openapi typegen src/openapi.json --client > src/openapi.d.ts",
|
|
65
|
-
"build": "tsc && npm run build:patch && npm run bundle-definition",
|
|
66
|
-
"build:patch": "sed -i'' -e '/^__exportStar.*openapi.*$/d' dist/index.js",
|
|
67
|
-
"build:watch": "npm run build && tsc -w",
|
|
68
|
-
"lint": "biome check src"
|
|
69
70
|
}
|
|
70
|
-
}
|
|
71
|
+
}
|
package/src/openapi-runtime.json
CHANGED
|
@@ -579,6 +579,7 @@
|
|
|
579
579
|
"/v2/portal/public-widgets": {
|
|
580
580
|
"get": {
|
|
581
581
|
"operationId": "getPublicPortalWidgets",
|
|
582
|
+
"deprecated": true,
|
|
582
583
|
"parameters": [
|
|
583
584
|
{
|
|
584
585
|
"in": "query",
|
|
@@ -597,6 +598,7 @@
|
|
|
597
598
|
"/v2/portal/widgets": {
|
|
598
599
|
"post": {
|
|
599
600
|
"operationId": "upsertPortalWidget",
|
|
601
|
+
"deprecated": true,
|
|
600
602
|
"parameters": [
|
|
601
603
|
{
|
|
602
604
|
"in": "query",
|
|
@@ -614,6 +616,7 @@
|
|
|
614
616
|
},
|
|
615
617
|
"get": {
|
|
616
618
|
"operationId": "getPortalWidgets",
|
|
619
|
+
"deprecated": true,
|
|
617
620
|
"parameters": [
|
|
618
621
|
{
|
|
619
622
|
"in": "query",
|
|
@@ -718,6 +721,7 @@
|
|
|
718
721
|
},
|
|
719
722
|
"patch": {
|
|
720
723
|
"operationId": "updateContact",
|
|
724
|
+
"deprecated": true,
|
|
721
725
|
"requestBody": {
|
|
722
726
|
"content": {
|
|
723
727
|
"application/json": {}
|
|
@@ -972,6 +976,7 @@
|
|
|
972
976
|
"/v2/portal/order": {
|
|
973
977
|
"get": {
|
|
974
978
|
"operationId": "getAllOrders",
|
|
979
|
+
"deprecated": true,
|
|
975
980
|
"parameters": [
|
|
976
981
|
{
|
|
977
982
|
"in": "query",
|
|
@@ -1008,6 +1013,7 @@
|
|
|
1008
1013
|
"/v2/portal/order/{id}": {
|
|
1009
1014
|
"get": {
|
|
1010
1015
|
"operationId": "getOrder",
|
|
1016
|
+
"deprecated": true,
|
|
1011
1017
|
"parameters": [
|
|
1012
1018
|
{
|
|
1013
1019
|
"in": "path",
|
|
@@ -1019,6 +1025,7 @@
|
|
|
1019
1025
|
},
|
|
1020
1026
|
"patch": {
|
|
1021
1027
|
"operationId": "updateOrder",
|
|
1028
|
+
"deprecated": true,
|
|
1022
1029
|
"parameters": [
|
|
1023
1030
|
{
|
|
1024
1031
|
"in": "path",
|
|
@@ -1037,6 +1044,7 @@
|
|
|
1037
1044
|
"/v2/portal/opportunity": {
|
|
1038
1045
|
"get": {
|
|
1039
1046
|
"operationId": "getAllOpportunities",
|
|
1047
|
+
"deprecated": true,
|
|
1040
1048
|
"parameters": [
|
|
1041
1049
|
{
|
|
1042
1050
|
"in": "query",
|
|
@@ -1055,6 +1063,7 @@
|
|
|
1055
1063
|
"/v2/portal/opportunities/searchable-attributes": {
|
|
1056
1064
|
"get": {
|
|
1057
1065
|
"operationId": "getSearchableAttributesForOpportunities",
|
|
1066
|
+
"deprecated": true,
|
|
1058
1067
|
"parameters": [
|
|
1059
1068
|
{
|
|
1060
1069
|
"in": "query",
|
|
@@ -1073,6 +1082,7 @@
|
|
|
1073
1082
|
"/v2/portal/opportunities/search": {
|
|
1074
1083
|
"post": {
|
|
1075
1084
|
"operationId": "getSearchResultsForOpportunities",
|
|
1085
|
+
"deprecated": true,
|
|
1076
1086
|
"parameters": [
|
|
1077
1087
|
{
|
|
1078
1088
|
"in": "query",
|
|
@@ -1097,6 +1107,7 @@
|
|
|
1097
1107
|
"/v2/portal/opportunities/{id}": {
|
|
1098
1108
|
"get": {
|
|
1099
1109
|
"operationId": "getOpportunity",
|
|
1110
|
+
"deprecated": true,
|
|
1100
1111
|
"parameters": [
|
|
1101
1112
|
{
|
|
1102
1113
|
"in": "path",
|
|
@@ -1108,6 +1119,7 @@
|
|
|
1108
1119
|
},
|
|
1109
1120
|
"patch": {
|
|
1110
1121
|
"operationId": "updateOpportunity",
|
|
1122
|
+
"deprecated": true,
|
|
1111
1123
|
"parameters": [
|
|
1112
1124
|
{
|
|
1113
1125
|
"in": "path",
|
|
@@ -1127,6 +1139,7 @@
|
|
|
1127
1139
|
"/v2/portal/request": {
|
|
1128
1140
|
"get": {
|
|
1129
1141
|
"operationId": "getAllRequests",
|
|
1142
|
+
"deprecated": true,
|
|
1130
1143
|
"parameters": [
|
|
1131
1144
|
{
|
|
1132
1145
|
"in": "query",
|
|
@@ -1145,6 +1158,7 @@
|
|
|
1145
1158
|
"/v2/portal/contract": {
|
|
1146
1159
|
"get": {
|
|
1147
1160
|
"operationId": "getAllContracts",
|
|
1161
|
+
"deprecated": true,
|
|
1148
1162
|
"parameters": [
|
|
1149
1163
|
{
|
|
1150
1164
|
"in": "query",
|
|
@@ -1163,6 +1177,7 @@
|
|
|
1163
1177
|
"/v2/portal/contract/{id}": {
|
|
1164
1178
|
"get": {
|
|
1165
1179
|
"operationId": "getContract",
|
|
1180
|
+
"deprecated": true,
|
|
1166
1181
|
"parameters": [
|
|
1167
1182
|
{
|
|
1168
1183
|
"in": "path",
|
|
@@ -1174,6 +1189,7 @@
|
|
|
1174
1189
|
},
|
|
1175
1190
|
"patch": {
|
|
1176
1191
|
"operationId": "updateContract",
|
|
1192
|
+
"deprecated": true,
|
|
1177
1193
|
"parameters": [
|
|
1178
1194
|
{
|
|
1179
1195
|
"in": "path",
|
|
@@ -1381,6 +1397,7 @@
|
|
|
1381
1397
|
"/v2/portal/user/file/{id}": {
|
|
1382
1398
|
"get": {
|
|
1383
1399
|
"operationId": "getFileById",
|
|
1400
|
+
"deprecated": true,
|
|
1384
1401
|
"parameters": [
|
|
1385
1402
|
{
|
|
1386
1403
|
"in": "path",
|