@wix/auto_sdk_bookings_services 1.0.52 → 1.0.54
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/build/cjs/index.typings.d.ts +2 -0
- package/build/cjs/src/bookings-services-v2-service-services.context.d.ts +1 -1
- package/build/cjs/src/bookings-services-v2-service-services.public.d.ts +3 -3
- package/build/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
- package/build/cjs/src/bookings-services-v2-service-services.types.d.ts +249 -195
- package/build/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
- package/build/cjs/src/bookings-services-v2-service-services.universal.d.ts +447 -203
- package/build/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
- package/build/es/index.typings.d.ts +2 -0
- package/build/es/src/bookings-services-v2-service-services.context.d.ts +1 -1
- package/build/es/src/bookings-services-v2-service-services.public.d.ts +3 -3
- package/build/es/src/bookings-services-v2-service-services.public.js.map +1 -1
- package/build/es/src/bookings-services-v2-service-services.types.d.ts +249 -195
- package/build/es/src/bookings-services-v2-service-services.types.js.map +1 -1
- package/build/es/src/bookings-services-v2-service-services.universal.d.ts +447 -203
- package/build/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -0
- package/build/internal/cjs/src/bookings-services-v2-service-services.context.d.ts +1 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.public.d.ts +3 -3
- package/build/internal/cjs/src/bookings-services-v2-service-services.public.js.map +1 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.types.d.ts +249 -195
- package/build/internal/cjs/src/bookings-services-v2-service-services.types.js.map +1 -1
- package/build/internal/cjs/src/bookings-services-v2-service-services.universal.d.ts +447 -203
- package/build/internal/cjs/src/bookings-services-v2-service-services.universal.js.map +1 -1
- package/build/internal/es/index.typings.d.ts +2 -0
- package/build/internal/es/src/bookings-services-v2-service-services.context.d.ts +1 -1
- package/build/internal/es/src/bookings-services-v2-service-services.public.d.ts +3 -3
- package/build/internal/es/src/bookings-services-v2-service-services.public.js.map +1 -1
- package/build/internal/es/src/bookings-services-v2-service-services.types.d.ts +249 -195
- package/build/internal/es/src/bookings-services-v2-service-services.types.js.map +1 -1
- package/build/internal/es/src/bookings-services-v2-service-services.universal.d.ts +447 -203
- package/build/internal/es/src/bookings-services-v2-service-services.universal.js.map +1 -1
- package/package.json +3 -3
|
@@ -11,7 +11,7 @@ export interface Service {
|
|
|
11
11
|
* Learn more about *service types*
|
|
12
12
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/services/about-service-types) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/services-v2/about-service-types)).
|
|
13
13
|
*/
|
|
14
|
-
type?:
|
|
14
|
+
type?: ServiceTypeWithLiterals;
|
|
15
15
|
/**
|
|
16
16
|
* Order of the service within a *category*
|
|
17
17
|
* ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/categories/setup) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/categories-v1/category-object)).
|
|
@@ -144,6 +144,8 @@ export declare enum ServiceType {
|
|
|
144
144
|
/** Course service. */
|
|
145
145
|
COURSE = "COURSE"
|
|
146
146
|
}
|
|
147
|
+
/** @enumType */
|
|
148
|
+
export type ServiceTypeWithLiterals = ServiceType | 'APPOINTMENT' | 'CLASS' | 'COURSE';
|
|
147
149
|
export interface Media {
|
|
148
150
|
/**
|
|
149
151
|
* Media items associated with the service.
|
|
@@ -243,7 +245,7 @@ export interface Payment extends PaymentRateOneOf {
|
|
|
243
245
|
*/
|
|
244
246
|
varied?: VariedPayment;
|
|
245
247
|
/** The rate the customer is expected to pay for the service. */
|
|
246
|
-
rateType?:
|
|
248
|
+
rateType?: RateTypeWithLiterals;
|
|
247
249
|
/** The payment options a customer can use to pay for the service. */
|
|
248
250
|
options?: PaymentOptions;
|
|
249
251
|
/**
|
|
@@ -288,6 +290,8 @@ export declare enum RateType {
|
|
|
288
290
|
/** This service is offered free of charge. */
|
|
289
291
|
NO_FEE = "NO_FEE"
|
|
290
292
|
}
|
|
293
|
+
/** @enumType */
|
|
294
|
+
export type RateTypeWithLiterals = RateType | 'UNKNOWN_RATE_TYPE' | 'FIXED' | 'CUSTOM' | 'VARIED' | 'NO_FEE';
|
|
291
295
|
export interface FixedPayment {
|
|
292
296
|
/**
|
|
293
297
|
* The fixed price required to book the service.
|
|
@@ -404,7 +408,7 @@ export interface Location extends LocationOptionsOneOf {
|
|
|
404
408
|
*
|
|
405
409
|
* Default: `CUSTOM`
|
|
406
410
|
*/
|
|
407
|
-
type?:
|
|
411
|
+
type?: LocationTypeWithLiterals;
|
|
408
412
|
/**
|
|
409
413
|
* Location address. Empty for `{"type": "CUSTOMER"}`.
|
|
410
414
|
* @readonly
|
|
@@ -436,6 +440,8 @@ export declare enum LocationType {
|
|
|
436
440
|
*/
|
|
437
441
|
CUSTOMER = "CUSTOMER"
|
|
438
442
|
}
|
|
443
|
+
/** @enumType */
|
|
444
|
+
export type LocationTypeWithLiterals = LocationType | 'UNKNOWN_LOCATION_TYPE' | 'CUSTOM' | 'BUSINESS' | 'CUSTOMER';
|
|
439
445
|
export interface CommonAddress extends CommonAddressStreetOneOf {
|
|
440
446
|
/** Street name and number. */
|
|
441
447
|
streetAddress?: StreetAddress;
|
|
@@ -1337,7 +1343,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1337
1343
|
*/
|
|
1338
1344
|
appId?: string;
|
|
1339
1345
|
/** @readonly */
|
|
1340
|
-
identityType?:
|
|
1346
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1341
1347
|
}
|
|
1342
1348
|
/** @oneof */
|
|
1343
1349
|
export interface IdentificationDataIdOneOf {
|
|
@@ -1369,6 +1375,174 @@ export declare enum WebhookIdentityType {
|
|
|
1369
1375
|
WIX_USER = "WIX_USER",
|
|
1370
1376
|
APP = "APP"
|
|
1371
1377
|
}
|
|
1378
|
+
/** @enumType */
|
|
1379
|
+
export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
|
|
1380
|
+
export interface CreateAddOnGroupRequest {
|
|
1381
|
+
/** AddOnGroup to create. */
|
|
1382
|
+
addOnGroup?: AddOnGroup;
|
|
1383
|
+
/**
|
|
1384
|
+
* ID of the service to create the AddOnGroup for.
|
|
1385
|
+
* @format GUID
|
|
1386
|
+
*/
|
|
1387
|
+
serviceId?: string | null;
|
|
1388
|
+
}
|
|
1389
|
+
export interface CreateAddOnGroupResponse {
|
|
1390
|
+
/** Created AddOnGroup. */
|
|
1391
|
+
addOnGroup?: AddOnGroup;
|
|
1392
|
+
}
|
|
1393
|
+
export interface DeleteAddOnGroupRequest {
|
|
1394
|
+
/**
|
|
1395
|
+
* ID of the AddOnGroup to delete.
|
|
1396
|
+
* @format GUID
|
|
1397
|
+
*/
|
|
1398
|
+
addOnGroupId?: string | null;
|
|
1399
|
+
/**
|
|
1400
|
+
* ID of the service from which to delete the AddOnGroup.
|
|
1401
|
+
* @format GUID
|
|
1402
|
+
*/
|
|
1403
|
+
serviceId?: string | null;
|
|
1404
|
+
}
|
|
1405
|
+
export interface DeleteAddOnGroupResponse {
|
|
1406
|
+
}
|
|
1407
|
+
export interface UpdateAddOnGroupRequest {
|
|
1408
|
+
/** AddOnGroup to update. */
|
|
1409
|
+
addOnGroup?: AddOnGroup;
|
|
1410
|
+
/**
|
|
1411
|
+
* ID of the service that contains the AddOnGroup.
|
|
1412
|
+
* @format GUID
|
|
1413
|
+
*/
|
|
1414
|
+
serviceId?: string | null;
|
|
1415
|
+
}
|
|
1416
|
+
export interface UpdateAddOnGroupResponse {
|
|
1417
|
+
/** Updated AddOnGroup */
|
|
1418
|
+
addOnGroup?: AddOnGroup;
|
|
1419
|
+
}
|
|
1420
|
+
export interface ListAddOnGroupsByServiceIdRequest {
|
|
1421
|
+
/**
|
|
1422
|
+
* ID of the service to retrieve AddOnGroups for.
|
|
1423
|
+
* @format GUID
|
|
1424
|
+
*/
|
|
1425
|
+
serviceId?: string | null;
|
|
1426
|
+
/**
|
|
1427
|
+
* List of group ids to return. If not provided, all groups are returned.
|
|
1428
|
+
* @format GUID
|
|
1429
|
+
* @maxSize 3
|
|
1430
|
+
*/
|
|
1431
|
+
groupIds?: string[] | null;
|
|
1432
|
+
}
|
|
1433
|
+
export interface ListAddOnGroupsByServiceIdResponse {
|
|
1434
|
+
/**
|
|
1435
|
+
* List of group IDs and their linked AddOns.
|
|
1436
|
+
* @maxSize 3
|
|
1437
|
+
*/
|
|
1438
|
+
addOnGroupsDetails?: AddOnGroupDetail[];
|
|
1439
|
+
}
|
|
1440
|
+
export interface AddOn extends AddOnAddOnInfoOneOf {
|
|
1441
|
+
/** The AddOn description. */
|
|
1442
|
+
durationInMinutes?: number;
|
|
1443
|
+
/** The AddOn max quantity. */
|
|
1444
|
+
maxQuantity?: number;
|
|
1445
|
+
/**
|
|
1446
|
+
* The AddOn ID.
|
|
1447
|
+
* @format GUID
|
|
1448
|
+
*/
|
|
1449
|
+
addOnId?: string | null;
|
|
1450
|
+
/**
|
|
1451
|
+
* The AddOn name.
|
|
1452
|
+
* @maxLength 100
|
|
1453
|
+
*/
|
|
1454
|
+
name?: string | null;
|
|
1455
|
+
/** The AddOn price. */
|
|
1456
|
+
price?: Money;
|
|
1457
|
+
}
|
|
1458
|
+
/** @oneof */
|
|
1459
|
+
export interface AddOnAddOnInfoOneOf {
|
|
1460
|
+
/** The AddOn description. */
|
|
1461
|
+
durationInMinutes?: number;
|
|
1462
|
+
/** The AddOn max quantity. */
|
|
1463
|
+
maxQuantity?: number;
|
|
1464
|
+
}
|
|
1465
|
+
export interface AddOnGroupDetail {
|
|
1466
|
+
/**
|
|
1467
|
+
* The group ID.
|
|
1468
|
+
* @format GUID
|
|
1469
|
+
*/
|
|
1470
|
+
groupId?: string | null;
|
|
1471
|
+
/** The group max number of AddOns. */
|
|
1472
|
+
maxNumberOfAddOns?: number | null;
|
|
1473
|
+
/**
|
|
1474
|
+
* The group name.
|
|
1475
|
+
* @maxLength 100
|
|
1476
|
+
*/
|
|
1477
|
+
groupName?: string | null;
|
|
1478
|
+
/**
|
|
1479
|
+
* The AddOns information linked to the group.
|
|
1480
|
+
* @maxSize 7
|
|
1481
|
+
*/
|
|
1482
|
+
addOns?: AddOn[];
|
|
1483
|
+
/**
|
|
1484
|
+
* The group prompt.
|
|
1485
|
+
* @maxLength 200
|
|
1486
|
+
*/
|
|
1487
|
+
prompt?: string | null;
|
|
1488
|
+
}
|
|
1489
|
+
export interface SetAddOnsForGroupRequest {
|
|
1490
|
+
/**
|
|
1491
|
+
* The service ID to set AddOns for.
|
|
1492
|
+
* @format GUID
|
|
1493
|
+
*/
|
|
1494
|
+
serviceId?: string | null;
|
|
1495
|
+
/**
|
|
1496
|
+
* The group ID to set AddOns for.
|
|
1497
|
+
* @format GUID
|
|
1498
|
+
*/
|
|
1499
|
+
groupId?: string | null;
|
|
1500
|
+
/**
|
|
1501
|
+
* The IDs of AddOns to set.
|
|
1502
|
+
* @format GUID
|
|
1503
|
+
* @minSize 1
|
|
1504
|
+
* @maxSize 7
|
|
1505
|
+
*/
|
|
1506
|
+
addOnIds?: string[] | null;
|
|
1507
|
+
}
|
|
1508
|
+
export interface SetAddOnsForGroupResponse {
|
|
1509
|
+
/** The updated AddOnGroup. */
|
|
1510
|
+
addOnGroup?: AddOnGroup;
|
|
1511
|
+
}
|
|
1512
|
+
export interface ValidateAddOnsSelectionRequest {
|
|
1513
|
+
/**
|
|
1514
|
+
* The service ID to validate AddOns against.
|
|
1515
|
+
* @format GUID
|
|
1516
|
+
*/
|
|
1517
|
+
serviceId?: string | null;
|
|
1518
|
+
/**
|
|
1519
|
+
* The group ID to validate AddOns against.
|
|
1520
|
+
* @format GUID
|
|
1521
|
+
*/
|
|
1522
|
+
groupId?: string | null;
|
|
1523
|
+
/**
|
|
1524
|
+
* The IDs of AddOns to validate.
|
|
1525
|
+
* @format GUID
|
|
1526
|
+
* @minSize 1
|
|
1527
|
+
* @maxSize 7
|
|
1528
|
+
*/
|
|
1529
|
+
addOnIds?: string[] | null;
|
|
1530
|
+
}
|
|
1531
|
+
export interface ValidateAddOnsSelectionResponse {
|
|
1532
|
+
/** The validation result. */
|
|
1533
|
+
result?: ValidationResult;
|
|
1534
|
+
}
|
|
1535
|
+
export interface ValidationResult {
|
|
1536
|
+
/** Whether the AddOns selection is valid. */
|
|
1537
|
+
valid?: boolean | null;
|
|
1538
|
+
/**
|
|
1539
|
+
* A validation error message.
|
|
1540
|
+
* This field should populated when `valid` is `false`.
|
|
1541
|
+
* @minLength 1
|
|
1542
|
+
* @maxLength 300
|
|
1543
|
+
*/
|
|
1544
|
+
message?: string | null;
|
|
1545
|
+
}
|
|
1372
1546
|
export interface CreateServiceRequest {
|
|
1373
1547
|
/** Service to create. */
|
|
1374
1548
|
service: Service;
|
|
@@ -1469,6 +1643,8 @@ export declare enum V2RequestedFields {
|
|
|
1469
1643
|
/** When passed, `service.service_resources.resource_type.name` is returned. */
|
|
1470
1644
|
RESOURCE_TYPE_DETAILS = "RESOURCE_TYPE_DETAILS"
|
|
1471
1645
|
}
|
|
1646
|
+
/** @enumType */
|
|
1647
|
+
export type V2RequestedFieldsWithLiterals = V2RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'STAFF_MEMBER_DETAILS' | 'RESOURCE_TYPE_DETAILS';
|
|
1472
1648
|
export interface GetServiceResponse {
|
|
1473
1649
|
/** Retrieved service. */
|
|
1474
1650
|
service?: Service;
|
|
@@ -1709,12 +1885,14 @@ export interface Sorting {
|
|
|
1709
1885
|
*/
|
|
1710
1886
|
fieldName?: string;
|
|
1711
1887
|
/** Sort order. */
|
|
1712
|
-
order?:
|
|
1888
|
+
order?: SortOrderWithLiterals;
|
|
1713
1889
|
}
|
|
1714
1890
|
export declare enum SortOrder {
|
|
1715
1891
|
ASC = "ASC",
|
|
1716
1892
|
DESC = "DESC"
|
|
1717
1893
|
}
|
|
1894
|
+
/** @enumType */
|
|
1895
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1718
1896
|
export interface Paging {
|
|
1719
1897
|
/** Number of items to load. */
|
|
1720
1898
|
limit?: number | null;
|
|
@@ -1828,7 +2006,7 @@ export interface Aggregation extends AggregationKindOneOf {
|
|
|
1828
2006
|
*/
|
|
1829
2007
|
name?: string | null;
|
|
1830
2008
|
/** Type of aggregation, client must provide matching aggregation field below */
|
|
1831
|
-
type?:
|
|
2009
|
+
type?: AggregationTypeWithLiterals;
|
|
1832
2010
|
/**
|
|
1833
2011
|
* Field to aggregate by, use dot notation to specify json path
|
|
1834
2012
|
* @maxLength 200
|
|
@@ -1865,14 +2043,20 @@ export declare enum SortType {
|
|
|
1865
2043
|
COUNT = "COUNT",
|
|
1866
2044
|
VALUE = "VALUE"
|
|
1867
2045
|
}
|
|
2046
|
+
/** @enumType */
|
|
2047
|
+
export type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
1868
2048
|
export declare enum SortDirection {
|
|
1869
2049
|
DESC = "DESC",
|
|
1870
2050
|
ASC = "ASC"
|
|
1871
2051
|
}
|
|
2052
|
+
/** @enumType */
|
|
2053
|
+
export type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
1872
2054
|
export declare enum MissingValues {
|
|
1873
2055
|
EXCLUDE = "EXCLUDE",
|
|
1874
2056
|
INCLUDE = "INCLUDE"
|
|
1875
2057
|
}
|
|
2058
|
+
/** @enumType */
|
|
2059
|
+
export type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
1876
2060
|
export interface IncludeMissingValuesOptions {
|
|
1877
2061
|
/**
|
|
1878
2062
|
* can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
|
|
@@ -1886,17 +2070,19 @@ export declare enum ScalarType {
|
|
|
1886
2070
|
MIN = "MIN",
|
|
1887
2071
|
MAX = "MAX"
|
|
1888
2072
|
}
|
|
2073
|
+
/** @enumType */
|
|
2074
|
+
export type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
1889
2075
|
export interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
1890
2076
|
/** options for including missing values */
|
|
1891
2077
|
includeOptions?: IncludeMissingValuesOptions;
|
|
1892
2078
|
/** Should sort by number of matches or value of the field */
|
|
1893
|
-
sortType?:
|
|
2079
|
+
sortType?: SortTypeWithLiterals;
|
|
1894
2080
|
/** Should sort in ascending or descending order */
|
|
1895
|
-
sortDirection?:
|
|
2081
|
+
sortDirection?: SortDirectionWithLiterals;
|
|
1896
2082
|
/** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
|
|
1897
2083
|
limit?: number | null;
|
|
1898
2084
|
/** should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
|
|
1899
|
-
missingValues?:
|
|
2085
|
+
missingValues?: MissingValuesWithLiterals;
|
|
1900
2086
|
}
|
|
1901
2087
|
/** @oneof */
|
|
1902
2088
|
export interface ValueAggregationOptionsOneOf {
|
|
@@ -1910,6 +2096,8 @@ export declare enum NestedAggregationType {
|
|
|
1910
2096
|
SCALAR = "SCALAR",
|
|
1911
2097
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
1912
2098
|
}
|
|
2099
|
+
/** @enumType */
|
|
2100
|
+
export type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
1913
2101
|
export interface RangeAggregation {
|
|
1914
2102
|
/**
|
|
1915
2103
|
* Range buckets
|
|
@@ -1919,11 +2107,11 @@ export interface RangeAggregation {
|
|
|
1919
2107
|
}
|
|
1920
2108
|
export interface ScalarAggregation {
|
|
1921
2109
|
/** Define the operator for the scalar aggregation */
|
|
1922
|
-
type?:
|
|
2110
|
+
type?: ScalarTypeWithLiterals;
|
|
1923
2111
|
}
|
|
1924
2112
|
export interface DateHistogramAggregation {
|
|
1925
2113
|
/** Interval for date histogram aggregation */
|
|
1926
|
-
interval?:
|
|
2114
|
+
interval?: IntervalWithLiterals;
|
|
1927
2115
|
}
|
|
1928
2116
|
export declare enum Interval {
|
|
1929
2117
|
/** Unknown interval. */
|
|
@@ -1943,6 +2131,8 @@ export declare enum Interval {
|
|
|
1943
2131
|
/** Second interval. */
|
|
1944
2132
|
SECOND = "SECOND"
|
|
1945
2133
|
}
|
|
2134
|
+
/** @enumType */
|
|
2135
|
+
export type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
1946
2136
|
export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
1947
2137
|
/** Value aggregation */
|
|
1948
2138
|
value?: ValueAggregation;
|
|
@@ -1958,7 +2148,7 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
|
1958
2148
|
*/
|
|
1959
2149
|
name?: string | null;
|
|
1960
2150
|
/** Type of aggregation, client must provide matching aggregation field below */
|
|
1961
|
-
type?:
|
|
2151
|
+
type?: NestedAggregationTypeWithLiterals;
|
|
1962
2152
|
/**
|
|
1963
2153
|
* Field to aggregate by, use dont notation to specify json path
|
|
1964
2154
|
* @maxLength 200
|
|
@@ -1984,6 +2174,8 @@ export declare enum AggregationType {
|
|
|
1984
2174
|
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
1985
2175
|
NESTED = "NESTED"
|
|
1986
2176
|
}
|
|
2177
|
+
/** @enumType */
|
|
2178
|
+
export type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
1987
2179
|
/** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
1988
2180
|
export interface NestedAggregation {
|
|
1989
2181
|
/**
|
|
@@ -2014,7 +2206,7 @@ export interface GroupByAggregationKindOneOf {
|
|
|
2014
2206
|
}
|
|
2015
2207
|
export interface SearchDetails {
|
|
2016
2208
|
/** Boolean search mode */
|
|
2017
|
-
mode?:
|
|
2209
|
+
mode?: ModeWithLiterals;
|
|
2018
2210
|
/**
|
|
2019
2211
|
* Search term or expression
|
|
2020
2212
|
* @maxLength 200
|
|
@@ -2035,6 +2227,8 @@ export declare enum Mode {
|
|
|
2035
2227
|
/** All */
|
|
2036
2228
|
AND = "AND"
|
|
2037
2229
|
}
|
|
2230
|
+
/** @enumType */
|
|
2231
|
+
export type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
2038
2232
|
export interface SearchServicesResponse {
|
|
2039
2233
|
/** The retrieved services. */
|
|
2040
2234
|
services?: Service[];
|
|
@@ -2092,7 +2286,7 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
|
|
|
2092
2286
|
*/
|
|
2093
2287
|
name?: string;
|
|
2094
2288
|
/** Type of aggregation that matches result */
|
|
2095
|
-
type?:
|
|
2289
|
+
type?: AggregationTypeWithLiterals;
|
|
2096
2290
|
/**
|
|
2097
2291
|
* Field to aggregate by, matches the one provided in request
|
|
2098
2292
|
* @maxLength 200
|
|
@@ -2124,7 +2318,7 @@ export interface RangeResults {
|
|
|
2124
2318
|
}
|
|
2125
2319
|
export interface AggregationResultsScalarResult {
|
|
2126
2320
|
/** Type of scalar aggregation */
|
|
2127
|
-
type?:
|
|
2321
|
+
type?: ScalarTypeWithLiterals;
|
|
2128
2322
|
/** Value of the scalar aggregation */
|
|
2129
2323
|
value?: number;
|
|
2130
2324
|
}
|
|
@@ -2236,7 +2430,7 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
|
|
|
2236
2430
|
*/
|
|
2237
2431
|
name?: string;
|
|
2238
2432
|
/** Type of aggregation that must match provided kind as derived from search request */
|
|
2239
|
-
type?:
|
|
2433
|
+
type?: AggregationTypeWithLiterals;
|
|
2240
2434
|
/**
|
|
2241
2435
|
* Field to aggregate by as derived from search request
|
|
2242
2436
|
* @maxLength 200
|
|
@@ -2324,7 +2518,7 @@ export interface QueryBookingFormsRequest {
|
|
|
2324
2518
|
* Conditional fields to return.
|
|
2325
2519
|
* @maxSize 1
|
|
2326
2520
|
*/
|
|
2327
|
-
conditionalFields?:
|
|
2521
|
+
conditionalFields?: RequestedFieldsWithLiterals[];
|
|
2328
2522
|
}
|
|
2329
2523
|
export declare enum RequestedFields {
|
|
2330
2524
|
/** Unknown requested conditional field. */
|
|
@@ -2332,6 +2526,8 @@ export declare enum RequestedFields {
|
|
|
2332
2526
|
/** Whether to return the site's default booking form. */
|
|
2333
2527
|
DEFAULT_BOOKING_FORM = "DEFAULT_BOOKING_FORM"
|
|
2334
2528
|
}
|
|
2529
|
+
/** @enumType */
|
|
2530
|
+
export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DEFAULT_BOOKING_FORM';
|
|
2335
2531
|
export interface QueryBookingFormsResponse {
|
|
2336
2532
|
/** Retrieved booking forms and information about connected services. */
|
|
2337
2533
|
bookingForms?: BookingForm[];
|
|
@@ -2528,7 +2724,7 @@ export interface RemovedLocationSessionsAction extends RemovedLocationSessionsAc
|
|
|
2528
2724
|
*/
|
|
2529
2725
|
moveToLocationOptions?: MoveToNewLocationsOptions;
|
|
2530
2726
|
/** Information about what to do with future events at the removed location. */
|
|
2531
|
-
action?:
|
|
2727
|
+
action?: ActionWithLiterals;
|
|
2532
2728
|
}
|
|
2533
2729
|
/** @oneof */
|
|
2534
2730
|
export interface RemovedLocationSessionsActionActionOptionsOneOf {
|
|
@@ -2550,6 +2746,8 @@ export declare enum Action {
|
|
|
2550
2746
|
*/
|
|
2551
2747
|
DELETE = "DELETE"
|
|
2552
2748
|
}
|
|
2749
|
+
/** @enumType */
|
|
2750
|
+
export type ActionWithLiterals = Action | 'UNKNOWN_ACTION_TYPE' | 'KEEP_AT_CURRENT_LOCATION' | 'MOVE_TO_LOCATION' | 'DELETE';
|
|
2553
2751
|
export interface MoveToNewLocationsOptions {
|
|
2554
2752
|
/** The new location to move existing sessions currently set to a removed location, used when `action` is `MOVE_TO_LOCATION`. */
|
|
2555
2753
|
newLocation?: Location;
|
|
@@ -2650,7 +2848,7 @@ export interface ValidateSlugResponse {
|
|
|
2650
2848
|
* Reasons why the slug is invalid. Available only if `{"valid": false}`.
|
|
2651
2849
|
* @maxSize 3
|
|
2652
2850
|
*/
|
|
2653
|
-
errors?:
|
|
2851
|
+
errors?: InvalidSlugErrorWithLiterals[];
|
|
2654
2852
|
}
|
|
2655
2853
|
export declare enum InvalidSlugError {
|
|
2656
2854
|
/** Unknown slug error. */
|
|
@@ -2660,6 +2858,8 @@ export declare enum InvalidSlugError {
|
|
|
2660
2858
|
/** Slug is already associated with another service. */
|
|
2661
2859
|
SLUG_ALREADY_EXISTS = "SLUG_ALREADY_EXISTS"
|
|
2662
2860
|
}
|
|
2861
|
+
/** @enumType */
|
|
2862
|
+
export type InvalidSlugErrorWithLiterals = InvalidSlugError | 'UNKNOWN_SLUG_ERROR' | 'SLUG_CONTAINS_ILLEGAL_CHARACTERS' | 'SLUG_ALREADY_EXISTS';
|
|
2663
2863
|
export interface CloneServiceRequest {
|
|
2664
2864
|
/**
|
|
2665
2865
|
* ID of the service to clone.
|
|
@@ -2675,7 +2875,7 @@ export interface CloneServiceResponse {
|
|
|
2675
2875
|
* future recurring events, the booking form, service variants, and connected
|
|
2676
2876
|
* pricing plans.
|
|
2677
2877
|
*/
|
|
2678
|
-
errors?:
|
|
2878
|
+
errors?: CloneErrorsWithLiterals[];
|
|
2679
2879
|
}
|
|
2680
2880
|
export declare enum CloneErrors {
|
|
2681
2881
|
/**
|
|
@@ -2686,10 +2886,12 @@ export declare enum CloneErrors {
|
|
|
2686
2886
|
/** Failed to clone the original service's *booking form*. */
|
|
2687
2887
|
FORM = "FORM"
|
|
2688
2888
|
}
|
|
2889
|
+
/** @enumType */
|
|
2890
|
+
export type CloneErrorsWithLiterals = CloneErrors | 'OPTIONS_AND_VARIANTS' | 'FORM';
|
|
2689
2891
|
/** An event sent every time a category entity is changed. */
|
|
2690
2892
|
export interface CategoryNotification {
|
|
2691
2893
|
category?: Category;
|
|
2692
|
-
event?:
|
|
2894
|
+
event?: CategoryNotificationEventWithLiterals;
|
|
2693
2895
|
}
|
|
2694
2896
|
/** Categories are used to group multiple services together. A service must be associated with a category in order to be exposed in the Wix Bookings UI. */
|
|
2695
2897
|
export interface Category {
|
|
@@ -2710,7 +2912,7 @@ export interface Category {
|
|
|
2710
2912
|
* Default: `CREATED`
|
|
2711
2913
|
* @readonly
|
|
2712
2914
|
*/
|
|
2713
|
-
status?:
|
|
2915
|
+
status?: StatusWithLiterals;
|
|
2714
2916
|
/** Sort order of the category in the live site and dashboard. */
|
|
2715
2917
|
sortOrder?: number | null;
|
|
2716
2918
|
}
|
|
@@ -2720,6 +2922,8 @@ export declare enum Status {
|
|
|
2720
2922
|
/** The category was deleted. */
|
|
2721
2923
|
DELETED = "DELETED"
|
|
2722
2924
|
}
|
|
2925
|
+
/** @enumType */
|
|
2926
|
+
export type StatusWithLiterals = Status | 'CREATED' | 'DELETED';
|
|
2723
2927
|
export declare enum CategoryNotificationEvent {
|
|
2724
2928
|
/** Category was updated. */
|
|
2725
2929
|
Updated = "Updated",
|
|
@@ -2728,6 +2932,8 @@ export declare enum CategoryNotificationEvent {
|
|
|
2728
2932
|
/** Category was created. */
|
|
2729
2933
|
Created = "Created"
|
|
2730
2934
|
}
|
|
2935
|
+
/** @enumType */
|
|
2936
|
+
export type CategoryNotificationEventWithLiterals = CategoryNotificationEvent | 'Updated' | 'Deleted' | 'Created';
|
|
2731
2937
|
export interface Empty {
|
|
2732
2938
|
}
|
|
2733
2939
|
export interface BenefitNotification {
|
|
@@ -2746,7 +2952,7 @@ export interface BenefitNotification {
|
|
|
2746
2952
|
/** Previous benefit */
|
|
2747
2953
|
prevBenefit?: Benefit;
|
|
2748
2954
|
/** Notification event */
|
|
2749
|
-
event?:
|
|
2955
|
+
event?: EventWithLiterals;
|
|
2750
2956
|
}
|
|
2751
2957
|
export interface Benefit {
|
|
2752
2958
|
/**
|
|
@@ -2756,7 +2962,7 @@ export interface Benefit {
|
|
|
2756
2962
|
*/
|
|
2757
2963
|
id?: string | null;
|
|
2758
2964
|
/** Benefit Type */
|
|
2759
|
-
benefitType?:
|
|
2965
|
+
benefitType?: BenefitTypeWithLiterals;
|
|
2760
2966
|
/**
|
|
2761
2967
|
* Resource IDs that serves by this benefit
|
|
2762
2968
|
* @format GUID
|
|
@@ -2815,6 +3021,8 @@ export declare enum BenefitType {
|
|
|
2815
3021
|
/** Unlimited benefit type */
|
|
2816
3022
|
UNLIMITED = "UNLIMITED"
|
|
2817
3023
|
}
|
|
3024
|
+
/** @enumType */
|
|
3025
|
+
export type BenefitTypeWithLiterals = BenefitType | 'UNDEFINED' | 'LIMITED' | 'UNLIMITED';
|
|
2818
3026
|
export interface Behavior extends BehaviorBehaviorOneOf {
|
|
2819
3027
|
/** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
|
|
2820
3028
|
defaultBehavior?: EntryPass;
|
|
@@ -2833,9 +3041,11 @@ export declare enum Event {
|
|
|
2833
3041
|
Deleted = "Deleted",
|
|
2834
3042
|
Created = "Created"
|
|
2835
3043
|
}
|
|
3044
|
+
/** @enumType */
|
|
3045
|
+
export type EventWithLiterals = Event | 'Updated' | 'Deleted' | 'Created';
|
|
2836
3046
|
export interface UserDomainInfoChangedEvent {
|
|
2837
3047
|
domainName?: string;
|
|
2838
|
-
crudType?:
|
|
3048
|
+
crudType?: CrudTypeWithLiterals;
|
|
2839
3049
|
/** @format GUID */
|
|
2840
3050
|
metaSiteId?: string | null;
|
|
2841
3051
|
changeTime?: Date | null;
|
|
@@ -2848,6 +3058,8 @@ export declare enum CrudType {
|
|
|
2848
3058
|
/** Unfortunately this action is used by hibernate save in wix-war */
|
|
2849
3059
|
CREATE_OR_UPDATE = "CREATE_OR_UPDATE"
|
|
2850
3060
|
}
|
|
3061
|
+
/** @enumType */
|
|
3062
|
+
export type CrudTypeWithLiterals = CrudType | 'INVALID_CRUD_TYPE' | 'CREATE' | 'UPDATE' | 'DELETE' | 'CREATE_OR_UPDATE';
|
|
2851
3063
|
export interface HtmlSitePublished {
|
|
2852
3064
|
/**
|
|
2853
3065
|
* Application instance ID
|
|
@@ -3017,7 +3229,7 @@ export interface AddressHint {
|
|
|
3017
3229
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
3018
3230
|
text?: string;
|
|
3019
3231
|
/** Where the extra text should be displayed. */
|
|
3020
|
-
placement?:
|
|
3232
|
+
placement?: PlacementTypeWithLiterals;
|
|
3021
3233
|
}
|
|
3022
3234
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
3023
3235
|
export declare enum PlacementType {
|
|
@@ -3025,6 +3237,8 @@ export declare enum PlacementType {
|
|
|
3025
3237
|
AFTER = "AFTER",
|
|
3026
3238
|
REPLACE = "REPLACE"
|
|
3027
3239
|
}
|
|
3240
|
+
/** @enumType */
|
|
3241
|
+
export type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
3028
3242
|
/** Geocoordinates for a particular address. */
|
|
3029
3243
|
export interface GeoCoordinates {
|
|
3030
3244
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
@@ -3048,14 +3262,14 @@ export interface BusinessSchedule {
|
|
|
3048
3262
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
3049
3263
|
export interface TimePeriod {
|
|
3050
3264
|
/** Day of the week the period starts on. */
|
|
3051
|
-
openDay?:
|
|
3265
|
+
openDay?: DayOfWeekWithLiterals;
|
|
3052
3266
|
/**
|
|
3053
3267
|
* Time the period starts in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
3054
3268
|
* midnight at the end of the specified day.
|
|
3055
3269
|
*/
|
|
3056
3270
|
openTime?: string;
|
|
3057
3271
|
/** Day of the week the period ends on. */
|
|
3058
|
-
closeDay?:
|
|
3272
|
+
closeDay?: DayOfWeekWithLiterals;
|
|
3059
3273
|
/**
|
|
3060
3274
|
* Time the period ends in 24-hour [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) extended format. Valid values are `00:00` to `24:00`, where `24:00` represents
|
|
3061
3275
|
* midnight at the end of the specified day.
|
|
@@ -3074,6 +3288,8 @@ export declare enum DayOfWeek {
|
|
|
3074
3288
|
SATURDAY = "SATURDAY",
|
|
3075
3289
|
SUNDAY = "SUNDAY"
|
|
3076
3290
|
}
|
|
3291
|
+
/** @enumType */
|
|
3292
|
+
export type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
3077
3293
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
3078
3294
|
export interface SpecialHourPeriod {
|
|
3079
3295
|
/** Start date and time of the exception in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format and [Coordinated Universal Time (UTC)](https://en.wikipedia.org/wiki/Coordinated_Universal_Time). */
|
|
@@ -3108,13 +3324,17 @@ export interface SupportedLanguage {
|
|
|
3108
3324
|
/** Language icon. */
|
|
3109
3325
|
countryCode?: string;
|
|
3110
3326
|
/** How the language will be resolved. For internal use. */
|
|
3111
|
-
resolutionMethod?:
|
|
3327
|
+
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
3328
|
+
/** Whether the supported language is the primary language for site visitors. */
|
|
3329
|
+
isVisitorPrimary?: boolean | null;
|
|
3112
3330
|
}
|
|
3113
3331
|
export declare enum ResolutionMethod {
|
|
3114
3332
|
QUERY_PARAM = "QUERY_PARAM",
|
|
3115
3333
|
SUBDOMAIN = "SUBDOMAIN",
|
|
3116
3334
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
3117
3335
|
}
|
|
3336
|
+
/** @enumType */
|
|
3337
|
+
export type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
3118
3338
|
export interface ConsentPolicy {
|
|
3119
3339
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
3120
3340
|
essential?: boolean | null;
|
|
@@ -3163,169 +3383,3 @@ export interface SiteCloned {
|
|
|
3163
3383
|
/** Origin site id. */
|
|
3164
3384
|
originMetaSiteId?: string;
|
|
3165
3385
|
}
|
|
3166
|
-
export interface CreateAddOnGroupRequest {
|
|
3167
|
-
/** AddOnGroup to create. */
|
|
3168
|
-
addOnGroup?: AddOnGroup;
|
|
3169
|
-
/**
|
|
3170
|
-
* ID of the service to create the AddOnGroup for.
|
|
3171
|
-
* @format GUID
|
|
3172
|
-
*/
|
|
3173
|
-
serviceId?: string | null;
|
|
3174
|
-
}
|
|
3175
|
-
export interface CreateAddOnGroupResponse {
|
|
3176
|
-
/** Created AddOnGroup. */
|
|
3177
|
-
addOnGroup?: AddOnGroup;
|
|
3178
|
-
}
|
|
3179
|
-
export interface DeleteAddOnGroupRequest {
|
|
3180
|
-
/**
|
|
3181
|
-
* ID of the AddOnGroup to delete.
|
|
3182
|
-
* @format GUID
|
|
3183
|
-
*/
|
|
3184
|
-
addOnGroupId?: string | null;
|
|
3185
|
-
/**
|
|
3186
|
-
* ID of the service from which to delete the AddOnGroup.
|
|
3187
|
-
* @format GUID
|
|
3188
|
-
*/
|
|
3189
|
-
serviceId?: string | null;
|
|
3190
|
-
}
|
|
3191
|
-
export interface DeleteAddOnGroupResponse {
|
|
3192
|
-
}
|
|
3193
|
-
export interface UpdateAddOnGroupRequest {
|
|
3194
|
-
/** AddOnGroup to update. */
|
|
3195
|
-
addOnGroup?: AddOnGroup;
|
|
3196
|
-
/**
|
|
3197
|
-
* ID of the service that contains the AddOnGroup.
|
|
3198
|
-
* @format GUID
|
|
3199
|
-
*/
|
|
3200
|
-
serviceId?: string | null;
|
|
3201
|
-
}
|
|
3202
|
-
export interface UpdateAddOnGroupResponse {
|
|
3203
|
-
/** Updated AddOnGroup */
|
|
3204
|
-
addOnGroup?: AddOnGroup;
|
|
3205
|
-
}
|
|
3206
|
-
export interface ListAddOnGroupsByServiceIdRequest {
|
|
3207
|
-
/**
|
|
3208
|
-
* ID of the service to retrieve AddOnGroups for.
|
|
3209
|
-
* @format GUID
|
|
3210
|
-
*/
|
|
3211
|
-
serviceId?: string | null;
|
|
3212
|
-
/**
|
|
3213
|
-
* List of group ids to return. If not provided, all groups are returned.
|
|
3214
|
-
* @format GUID
|
|
3215
|
-
* @maxSize 3
|
|
3216
|
-
*/
|
|
3217
|
-
groupIds?: string[] | null;
|
|
3218
|
-
}
|
|
3219
|
-
export interface ListAddOnGroupsByServiceIdResponse {
|
|
3220
|
-
/**
|
|
3221
|
-
* List of group IDs and their linked AddOns.
|
|
3222
|
-
* @maxSize 3
|
|
3223
|
-
*/
|
|
3224
|
-
addOnGroupsDetails?: AddOnGroupDetail[];
|
|
3225
|
-
}
|
|
3226
|
-
export interface AddOn extends AddOnAddOnInfoOneOf {
|
|
3227
|
-
/** The AddOn description. */
|
|
3228
|
-
durationInMinutes?: number;
|
|
3229
|
-
/** The AddOn max quantity. */
|
|
3230
|
-
maxQuantity?: number;
|
|
3231
|
-
/**
|
|
3232
|
-
* The AddOn ID.
|
|
3233
|
-
* @format GUID
|
|
3234
|
-
*/
|
|
3235
|
-
addOnId?: string | null;
|
|
3236
|
-
/**
|
|
3237
|
-
* The AddOn name.
|
|
3238
|
-
* @maxLength 100
|
|
3239
|
-
*/
|
|
3240
|
-
name?: string | null;
|
|
3241
|
-
/** The AddOn price. */
|
|
3242
|
-
price?: Money;
|
|
3243
|
-
}
|
|
3244
|
-
/** @oneof */
|
|
3245
|
-
export interface AddOnAddOnInfoOneOf {
|
|
3246
|
-
/** The AddOn description. */
|
|
3247
|
-
durationInMinutes?: number;
|
|
3248
|
-
/** The AddOn max quantity. */
|
|
3249
|
-
maxQuantity?: number;
|
|
3250
|
-
}
|
|
3251
|
-
export interface AddOnGroupDetail {
|
|
3252
|
-
/**
|
|
3253
|
-
* The group ID.
|
|
3254
|
-
* @format GUID
|
|
3255
|
-
*/
|
|
3256
|
-
groupId?: string | null;
|
|
3257
|
-
/** The group max number of AddOns. */
|
|
3258
|
-
maxNumberOfAddOns?: number | null;
|
|
3259
|
-
/**
|
|
3260
|
-
* The group name.
|
|
3261
|
-
* @maxLength 100
|
|
3262
|
-
*/
|
|
3263
|
-
groupName?: string | null;
|
|
3264
|
-
/**
|
|
3265
|
-
* The AddOns information linked to the group.
|
|
3266
|
-
* @maxSize 7
|
|
3267
|
-
*/
|
|
3268
|
-
addOns?: AddOn[];
|
|
3269
|
-
/**
|
|
3270
|
-
* The group prompt.
|
|
3271
|
-
* @maxLength 200
|
|
3272
|
-
*/
|
|
3273
|
-
prompt?: string | null;
|
|
3274
|
-
}
|
|
3275
|
-
export interface SetAddOnsForGroupRequest {
|
|
3276
|
-
/**
|
|
3277
|
-
* The service ID to set AddOns for.
|
|
3278
|
-
* @format GUID
|
|
3279
|
-
*/
|
|
3280
|
-
serviceId?: string | null;
|
|
3281
|
-
/**
|
|
3282
|
-
* The group ID to set AddOns for.
|
|
3283
|
-
* @format GUID
|
|
3284
|
-
*/
|
|
3285
|
-
groupId?: string | null;
|
|
3286
|
-
/**
|
|
3287
|
-
* The IDs of AddOns to set.
|
|
3288
|
-
* @format GUID
|
|
3289
|
-
* @minSize 1
|
|
3290
|
-
* @maxSize 7
|
|
3291
|
-
*/
|
|
3292
|
-
addOnIds?: string[] | null;
|
|
3293
|
-
}
|
|
3294
|
-
export interface SetAddOnsForGroupResponse {
|
|
3295
|
-
/** The updated AddOnGroup. */
|
|
3296
|
-
addOnGroup?: AddOnGroup;
|
|
3297
|
-
}
|
|
3298
|
-
export interface ValidateAddOnsSelectionRequest {
|
|
3299
|
-
/**
|
|
3300
|
-
* The service ID to validate AddOns against.
|
|
3301
|
-
* @format GUID
|
|
3302
|
-
*/
|
|
3303
|
-
serviceId?: string | null;
|
|
3304
|
-
/**
|
|
3305
|
-
* The group ID to validate AddOns against.
|
|
3306
|
-
* @format GUID
|
|
3307
|
-
*/
|
|
3308
|
-
groupId?: string | null;
|
|
3309
|
-
/**
|
|
3310
|
-
* The IDs of AddOns to validate.
|
|
3311
|
-
* @format GUID
|
|
3312
|
-
* @minSize 1
|
|
3313
|
-
* @maxSize 7
|
|
3314
|
-
*/
|
|
3315
|
-
addOnIds?: string[] | null;
|
|
3316
|
-
}
|
|
3317
|
-
export interface ValidateAddOnsSelectionResponse {
|
|
3318
|
-
/** The validation result. */
|
|
3319
|
-
result?: ValidationResult;
|
|
3320
|
-
}
|
|
3321
|
-
export interface ValidationResult {
|
|
3322
|
-
/** Whether the AddOns selection is valid. */
|
|
3323
|
-
valid?: boolean | null;
|
|
3324
|
-
/**
|
|
3325
|
-
* A validation error message.
|
|
3326
|
-
* This field should populated when `valid` is `false`.
|
|
3327
|
-
* @minLength 1
|
|
3328
|
-
* @maxLength 300
|
|
3329
|
-
*/
|
|
3330
|
-
message?: string | null;
|
|
3331
|
-
}
|