@wix/auto_sdk_bookings_services 1.0.51 → 1.0.53
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 +252 -201
- 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 +450 -209
- 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 +252 -201
- 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 +450 -209
- 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 +252 -201
- 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 +450 -209
- 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 +252 -201
- 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 +450 -209
- 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;
|
|
@@ -917,12 +923,11 @@ export interface AvailabilityConstraints {
|
|
|
917
923
|
*/
|
|
918
924
|
durations?: Duration[];
|
|
919
925
|
/**
|
|
920
|
-
* List of supported session durations in minutes.
|
|
921
|
-
*
|
|
922
|
-
*
|
|
923
|
-
* session length are
|
|
924
|
-
*
|
|
925
|
-
* while this array is ignored.
|
|
926
|
+
* List of supported session durations in minutes.
|
|
927
|
+
*
|
|
928
|
+
* - For appointment-based services, specify `sessionDurations` when creating a service.
|
|
929
|
+
* - For appointment-based services with varied pricing by session length, you must still specify `sessionDurations`, but the values are ignored. Actual durations are taken from the service variants ([SDK](https://dev.wix.com/docs/sdk/backend-modules/bookings/service-options-and-variants/introduction) | [REST](https://dev.wix.com/docs/rest/business-solutions/bookings/services/service-options-and-variants/introduction)).
|
|
930
|
+
* - For classes or courses, don't specify `sessionDurations` when creating a service.
|
|
926
931
|
*
|
|
927
932
|
* Min: `1` minute
|
|
928
933
|
* Max: `44639` minutes (30 days, 23 hours, and 59 minutes)
|
|
@@ -1338,7 +1343,7 @@ export interface IdentificationData extends IdentificationDataIdOneOf {
|
|
|
1338
1343
|
*/
|
|
1339
1344
|
appId?: string;
|
|
1340
1345
|
/** @readonly */
|
|
1341
|
-
identityType?:
|
|
1346
|
+
identityType?: WebhookIdentityTypeWithLiterals;
|
|
1342
1347
|
}
|
|
1343
1348
|
/** @oneof */
|
|
1344
1349
|
export interface IdentificationDataIdOneOf {
|
|
@@ -1370,6 +1375,174 @@ export declare enum WebhookIdentityType {
|
|
|
1370
1375
|
WIX_USER = "WIX_USER",
|
|
1371
1376
|
APP = "APP"
|
|
1372
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
|
+
}
|
|
1373
1546
|
export interface CreateServiceRequest {
|
|
1374
1547
|
/** Service to create. */
|
|
1375
1548
|
service: Service;
|
|
@@ -1470,6 +1643,8 @@ export declare enum V2RequestedFields {
|
|
|
1470
1643
|
/** When passed, `service.service_resources.resource_type.name` is returned. */
|
|
1471
1644
|
RESOURCE_TYPE_DETAILS = "RESOURCE_TYPE_DETAILS"
|
|
1472
1645
|
}
|
|
1646
|
+
/** @enumType */
|
|
1647
|
+
export type V2RequestedFieldsWithLiterals = V2RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'STAFF_MEMBER_DETAILS' | 'RESOURCE_TYPE_DETAILS';
|
|
1473
1648
|
export interface GetServiceResponse {
|
|
1474
1649
|
/** Retrieved service. */
|
|
1475
1650
|
service?: Service;
|
|
@@ -1710,12 +1885,14 @@ export interface Sorting {
|
|
|
1710
1885
|
*/
|
|
1711
1886
|
fieldName?: string;
|
|
1712
1887
|
/** Sort order. */
|
|
1713
|
-
order?:
|
|
1888
|
+
order?: SortOrderWithLiterals;
|
|
1714
1889
|
}
|
|
1715
1890
|
export declare enum SortOrder {
|
|
1716
1891
|
ASC = "ASC",
|
|
1717
1892
|
DESC = "DESC"
|
|
1718
1893
|
}
|
|
1894
|
+
/** @enumType */
|
|
1895
|
+
export type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
|
|
1719
1896
|
export interface Paging {
|
|
1720
1897
|
/** Number of items to load. */
|
|
1721
1898
|
limit?: number | null;
|
|
@@ -1829,7 +2006,7 @@ export interface Aggregation extends AggregationKindOneOf {
|
|
|
1829
2006
|
*/
|
|
1830
2007
|
name?: string | null;
|
|
1831
2008
|
/** Type of aggregation, client must provide matching aggregation field below */
|
|
1832
|
-
type?:
|
|
2009
|
+
type?: AggregationTypeWithLiterals;
|
|
1833
2010
|
/**
|
|
1834
2011
|
* Field to aggregate by, use dot notation to specify json path
|
|
1835
2012
|
* @maxLength 200
|
|
@@ -1866,14 +2043,20 @@ export declare enum SortType {
|
|
|
1866
2043
|
COUNT = "COUNT",
|
|
1867
2044
|
VALUE = "VALUE"
|
|
1868
2045
|
}
|
|
2046
|
+
/** @enumType */
|
|
2047
|
+
export type SortTypeWithLiterals = SortType | 'COUNT' | 'VALUE';
|
|
1869
2048
|
export declare enum SortDirection {
|
|
1870
2049
|
DESC = "DESC",
|
|
1871
2050
|
ASC = "ASC"
|
|
1872
2051
|
}
|
|
2052
|
+
/** @enumType */
|
|
2053
|
+
export type SortDirectionWithLiterals = SortDirection | 'DESC' | 'ASC';
|
|
1873
2054
|
export declare enum MissingValues {
|
|
1874
2055
|
EXCLUDE = "EXCLUDE",
|
|
1875
2056
|
INCLUDE = "INCLUDE"
|
|
1876
2057
|
}
|
|
2058
|
+
/** @enumType */
|
|
2059
|
+
export type MissingValuesWithLiterals = MissingValues | 'EXCLUDE' | 'INCLUDE';
|
|
1877
2060
|
export interface IncludeMissingValuesOptions {
|
|
1878
2061
|
/**
|
|
1879
2062
|
* can specify custom bucket name. Defaults are [string -> "N/A"], [int -> "0"], [bool -> "false"] ...
|
|
@@ -1887,17 +2070,19 @@ export declare enum ScalarType {
|
|
|
1887
2070
|
MIN = "MIN",
|
|
1888
2071
|
MAX = "MAX"
|
|
1889
2072
|
}
|
|
2073
|
+
/** @enumType */
|
|
2074
|
+
export type ScalarTypeWithLiterals = ScalarType | 'UNKNOWN_SCALAR_TYPE' | 'COUNT_DISTINCT' | 'MIN' | 'MAX';
|
|
1890
2075
|
export interface ValueAggregation extends ValueAggregationOptionsOneOf {
|
|
1891
2076
|
/** options for including missing values */
|
|
1892
2077
|
includeOptions?: IncludeMissingValuesOptions;
|
|
1893
2078
|
/** Should sort by number of matches or value of the field */
|
|
1894
|
-
sortType?:
|
|
2079
|
+
sortType?: SortTypeWithLiterals;
|
|
1895
2080
|
/** Should sort in ascending or descending order */
|
|
1896
|
-
sortDirection?:
|
|
2081
|
+
sortDirection?: SortDirectionWithLiterals;
|
|
1897
2082
|
/** How many aggregations would you like to return? Can be between 1 and 250. 10 is the default. */
|
|
1898
2083
|
limit?: number | null;
|
|
1899
2084
|
/** should missing values be included or excluded from the aggregation results. Default is EXCLUDE */
|
|
1900
|
-
missingValues?:
|
|
2085
|
+
missingValues?: MissingValuesWithLiterals;
|
|
1901
2086
|
}
|
|
1902
2087
|
/** @oneof */
|
|
1903
2088
|
export interface ValueAggregationOptionsOneOf {
|
|
@@ -1911,6 +2096,8 @@ export declare enum NestedAggregationType {
|
|
|
1911
2096
|
SCALAR = "SCALAR",
|
|
1912
2097
|
DATE_HISTOGRAM = "DATE_HISTOGRAM"
|
|
1913
2098
|
}
|
|
2099
|
+
/** @enumType */
|
|
2100
|
+
export type NestedAggregationTypeWithLiterals = NestedAggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM';
|
|
1914
2101
|
export interface RangeAggregation {
|
|
1915
2102
|
/**
|
|
1916
2103
|
* Range buckets
|
|
@@ -1920,11 +2107,11 @@ export interface RangeAggregation {
|
|
|
1920
2107
|
}
|
|
1921
2108
|
export interface ScalarAggregation {
|
|
1922
2109
|
/** Define the operator for the scalar aggregation */
|
|
1923
|
-
type?:
|
|
2110
|
+
type?: ScalarTypeWithLiterals;
|
|
1924
2111
|
}
|
|
1925
2112
|
export interface DateHistogramAggregation {
|
|
1926
2113
|
/** Interval for date histogram aggregation */
|
|
1927
|
-
interval?:
|
|
2114
|
+
interval?: IntervalWithLiterals;
|
|
1928
2115
|
}
|
|
1929
2116
|
export declare enum Interval {
|
|
1930
2117
|
/** Unknown interval. */
|
|
@@ -1944,6 +2131,8 @@ export declare enum Interval {
|
|
|
1944
2131
|
/** Second interval. */
|
|
1945
2132
|
SECOND = "SECOND"
|
|
1946
2133
|
}
|
|
2134
|
+
/** @enumType */
|
|
2135
|
+
export type IntervalWithLiterals = Interval | 'UNKNOWN_INTERVAL' | 'YEAR' | 'MONTH' | 'WEEK' | 'DAY' | 'HOUR' | 'MINUTE' | 'SECOND';
|
|
1947
2136
|
export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
1948
2137
|
/** Value aggregation */
|
|
1949
2138
|
value?: ValueAggregation;
|
|
@@ -1959,7 +2148,7 @@ export interface NestedAggregationItem extends NestedAggregationItemKindOneOf {
|
|
|
1959
2148
|
*/
|
|
1960
2149
|
name?: string | null;
|
|
1961
2150
|
/** Type of aggregation, client must provide matching aggregation field below */
|
|
1962
|
-
type?:
|
|
2151
|
+
type?: NestedAggregationTypeWithLiterals;
|
|
1963
2152
|
/**
|
|
1964
2153
|
* Field to aggregate by, use dont notation to specify json path
|
|
1965
2154
|
* @maxLength 200
|
|
@@ -1985,6 +2174,8 @@ export declare enum AggregationType {
|
|
|
1985
2174
|
DATE_HISTOGRAM = "DATE_HISTOGRAM",
|
|
1986
2175
|
NESTED = "NESTED"
|
|
1987
2176
|
}
|
|
2177
|
+
/** @enumType */
|
|
2178
|
+
export type AggregationTypeWithLiterals = AggregationType | 'UNKNOWN_AGGREGATION_TYPE' | 'VALUE' | 'RANGE' | 'SCALAR' | 'DATE_HISTOGRAM' | 'NESTED';
|
|
1988
2179
|
/** nested aggregation expressed through a list of aggregation where each next aggregation is nested within previous one */
|
|
1989
2180
|
export interface NestedAggregation {
|
|
1990
2181
|
/**
|
|
@@ -2015,7 +2206,7 @@ export interface GroupByAggregationKindOneOf {
|
|
|
2015
2206
|
}
|
|
2016
2207
|
export interface SearchDetails {
|
|
2017
2208
|
/** Boolean search mode */
|
|
2018
|
-
mode?:
|
|
2209
|
+
mode?: ModeWithLiterals;
|
|
2019
2210
|
/**
|
|
2020
2211
|
* Search term or expression
|
|
2021
2212
|
* @maxLength 200
|
|
@@ -2036,6 +2227,8 @@ export declare enum Mode {
|
|
|
2036
2227
|
/** All */
|
|
2037
2228
|
AND = "AND"
|
|
2038
2229
|
}
|
|
2230
|
+
/** @enumType */
|
|
2231
|
+
export type ModeWithLiterals = Mode | 'OR' | 'AND';
|
|
2039
2232
|
export interface SearchServicesResponse {
|
|
2040
2233
|
/** The retrieved services. */
|
|
2041
2234
|
services?: Service[];
|
|
@@ -2093,7 +2286,7 @@ export interface NestedAggregationResults extends NestedAggregationResultsResult
|
|
|
2093
2286
|
*/
|
|
2094
2287
|
name?: string;
|
|
2095
2288
|
/** Type of aggregation that matches result */
|
|
2096
|
-
type?:
|
|
2289
|
+
type?: AggregationTypeWithLiterals;
|
|
2097
2290
|
/**
|
|
2098
2291
|
* Field to aggregate by, matches the one provided in request
|
|
2099
2292
|
* @maxLength 200
|
|
@@ -2125,7 +2318,7 @@ export interface RangeResults {
|
|
|
2125
2318
|
}
|
|
2126
2319
|
export interface AggregationResultsScalarResult {
|
|
2127
2320
|
/** Type of scalar aggregation */
|
|
2128
|
-
type?:
|
|
2321
|
+
type?: ScalarTypeWithLiterals;
|
|
2129
2322
|
/** Value of the scalar aggregation */
|
|
2130
2323
|
value?: number;
|
|
2131
2324
|
}
|
|
@@ -2237,7 +2430,7 @@ export interface AggregationResults extends AggregationResultsResultOneOf {
|
|
|
2237
2430
|
*/
|
|
2238
2431
|
name?: string;
|
|
2239
2432
|
/** Type of aggregation that must match provided kind as derived from search request */
|
|
2240
|
-
type?:
|
|
2433
|
+
type?: AggregationTypeWithLiterals;
|
|
2241
2434
|
/**
|
|
2242
2435
|
* Field to aggregate by as derived from search request
|
|
2243
2436
|
* @maxLength 200
|
|
@@ -2325,7 +2518,7 @@ export interface QueryBookingFormsRequest {
|
|
|
2325
2518
|
* Conditional fields to return.
|
|
2326
2519
|
* @maxSize 1
|
|
2327
2520
|
*/
|
|
2328
|
-
conditionalFields?:
|
|
2521
|
+
conditionalFields?: RequestedFieldsWithLiterals[];
|
|
2329
2522
|
}
|
|
2330
2523
|
export declare enum RequestedFields {
|
|
2331
2524
|
/** Unknown requested conditional field. */
|
|
@@ -2333,6 +2526,8 @@ export declare enum RequestedFields {
|
|
|
2333
2526
|
/** Whether to return the site's default booking form. */
|
|
2334
2527
|
DEFAULT_BOOKING_FORM = "DEFAULT_BOOKING_FORM"
|
|
2335
2528
|
}
|
|
2529
|
+
/** @enumType */
|
|
2530
|
+
export type RequestedFieldsWithLiterals = RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'DEFAULT_BOOKING_FORM';
|
|
2336
2531
|
export interface QueryBookingFormsResponse {
|
|
2337
2532
|
/** Retrieved booking forms and information about connected services. */
|
|
2338
2533
|
bookingForms?: BookingForm[];
|
|
@@ -2529,7 +2724,7 @@ export interface RemovedLocationSessionsAction extends RemovedLocationSessionsAc
|
|
|
2529
2724
|
*/
|
|
2530
2725
|
moveToLocationOptions?: MoveToNewLocationsOptions;
|
|
2531
2726
|
/** Information about what to do with future events at the removed location. */
|
|
2532
|
-
action?:
|
|
2727
|
+
action?: ActionWithLiterals;
|
|
2533
2728
|
}
|
|
2534
2729
|
/** @oneof */
|
|
2535
2730
|
export interface RemovedLocationSessionsActionActionOptionsOneOf {
|
|
@@ -2551,6 +2746,8 @@ export declare enum Action {
|
|
|
2551
2746
|
*/
|
|
2552
2747
|
DELETE = "DELETE"
|
|
2553
2748
|
}
|
|
2749
|
+
/** @enumType */
|
|
2750
|
+
export type ActionWithLiterals = Action | 'UNKNOWN_ACTION_TYPE' | 'KEEP_AT_CURRENT_LOCATION' | 'MOVE_TO_LOCATION' | 'DELETE';
|
|
2554
2751
|
export interface MoveToNewLocationsOptions {
|
|
2555
2752
|
/** The new location to move existing sessions currently set to a removed location, used when `action` is `MOVE_TO_LOCATION`. */
|
|
2556
2753
|
newLocation?: Location;
|
|
@@ -2651,7 +2848,7 @@ export interface ValidateSlugResponse {
|
|
|
2651
2848
|
* Reasons why the slug is invalid. Available only if `{"valid": false}`.
|
|
2652
2849
|
* @maxSize 3
|
|
2653
2850
|
*/
|
|
2654
|
-
errors?:
|
|
2851
|
+
errors?: InvalidSlugErrorWithLiterals[];
|
|
2655
2852
|
}
|
|
2656
2853
|
export declare enum InvalidSlugError {
|
|
2657
2854
|
/** Unknown slug error. */
|
|
@@ -2661,6 +2858,8 @@ export declare enum InvalidSlugError {
|
|
|
2661
2858
|
/** Slug is already associated with another service. */
|
|
2662
2859
|
SLUG_ALREADY_EXISTS = "SLUG_ALREADY_EXISTS"
|
|
2663
2860
|
}
|
|
2861
|
+
/** @enumType */
|
|
2862
|
+
export type InvalidSlugErrorWithLiterals = InvalidSlugError | 'UNKNOWN_SLUG_ERROR' | 'SLUG_CONTAINS_ILLEGAL_CHARACTERS' | 'SLUG_ALREADY_EXISTS';
|
|
2664
2863
|
export interface CloneServiceRequest {
|
|
2665
2864
|
/**
|
|
2666
2865
|
* ID of the service to clone.
|
|
@@ -2676,7 +2875,7 @@ export interface CloneServiceResponse {
|
|
|
2676
2875
|
* future recurring events, the booking form, service variants, and connected
|
|
2677
2876
|
* pricing plans.
|
|
2678
2877
|
*/
|
|
2679
|
-
errors?:
|
|
2878
|
+
errors?: CloneErrorsWithLiterals[];
|
|
2680
2879
|
}
|
|
2681
2880
|
export declare enum CloneErrors {
|
|
2682
2881
|
/**
|
|
@@ -2687,10 +2886,12 @@ export declare enum CloneErrors {
|
|
|
2687
2886
|
/** Failed to clone the original service's *booking form*. */
|
|
2688
2887
|
FORM = "FORM"
|
|
2689
2888
|
}
|
|
2889
|
+
/** @enumType */
|
|
2890
|
+
export type CloneErrorsWithLiterals = CloneErrors | 'OPTIONS_AND_VARIANTS' | 'FORM';
|
|
2690
2891
|
/** An event sent every time a category entity is changed. */
|
|
2691
2892
|
export interface CategoryNotification {
|
|
2692
2893
|
category?: Category;
|
|
2693
|
-
event?:
|
|
2894
|
+
event?: CategoryNotificationEventWithLiterals;
|
|
2694
2895
|
}
|
|
2695
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. */
|
|
2696
2897
|
export interface Category {
|
|
@@ -2711,7 +2912,7 @@ export interface Category {
|
|
|
2711
2912
|
* Default: `CREATED`
|
|
2712
2913
|
* @readonly
|
|
2713
2914
|
*/
|
|
2714
|
-
status?:
|
|
2915
|
+
status?: StatusWithLiterals;
|
|
2715
2916
|
/** Sort order of the category in the live site and dashboard. */
|
|
2716
2917
|
sortOrder?: number | null;
|
|
2717
2918
|
}
|
|
@@ -2721,6 +2922,8 @@ export declare enum Status {
|
|
|
2721
2922
|
/** The category was deleted. */
|
|
2722
2923
|
DELETED = "DELETED"
|
|
2723
2924
|
}
|
|
2925
|
+
/** @enumType */
|
|
2926
|
+
export type StatusWithLiterals = Status | 'CREATED' | 'DELETED';
|
|
2724
2927
|
export declare enum CategoryNotificationEvent {
|
|
2725
2928
|
/** Category was updated. */
|
|
2726
2929
|
Updated = "Updated",
|
|
@@ -2729,6 +2932,8 @@ export declare enum CategoryNotificationEvent {
|
|
|
2729
2932
|
/** Category was created. */
|
|
2730
2933
|
Created = "Created"
|
|
2731
2934
|
}
|
|
2935
|
+
/** @enumType */
|
|
2936
|
+
export type CategoryNotificationEventWithLiterals = CategoryNotificationEvent | 'Updated' | 'Deleted' | 'Created';
|
|
2732
2937
|
export interface Empty {
|
|
2733
2938
|
}
|
|
2734
2939
|
export interface BenefitNotification {
|
|
@@ -2747,7 +2952,7 @@ export interface BenefitNotification {
|
|
|
2747
2952
|
/** Previous benefit */
|
|
2748
2953
|
prevBenefit?: Benefit;
|
|
2749
2954
|
/** Notification event */
|
|
2750
|
-
event?:
|
|
2955
|
+
event?: EventWithLiterals;
|
|
2751
2956
|
}
|
|
2752
2957
|
export interface Benefit {
|
|
2753
2958
|
/**
|
|
@@ -2757,7 +2962,7 @@ export interface Benefit {
|
|
|
2757
2962
|
*/
|
|
2758
2963
|
id?: string | null;
|
|
2759
2964
|
/** Benefit Type */
|
|
2760
|
-
benefitType?:
|
|
2965
|
+
benefitType?: BenefitTypeWithLiterals;
|
|
2761
2966
|
/**
|
|
2762
2967
|
* Resource IDs that serves by this benefit
|
|
2763
2968
|
* @format GUID
|
|
@@ -2816,6 +3021,8 @@ export declare enum BenefitType {
|
|
|
2816
3021
|
/** Unlimited benefit type */
|
|
2817
3022
|
UNLIMITED = "UNLIMITED"
|
|
2818
3023
|
}
|
|
3024
|
+
/** @enumType */
|
|
3025
|
+
export type BenefitTypeWithLiterals = BenefitType | 'UNDEFINED' | 'LIMITED' | 'UNLIMITED';
|
|
2819
3026
|
export interface Behavior extends BehaviorBehaviorOneOf {
|
|
2820
3027
|
/** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
|
|
2821
3028
|
defaultBehavior?: EntryPass;
|
|
@@ -2834,9 +3041,11 @@ export declare enum Event {
|
|
|
2834
3041
|
Deleted = "Deleted",
|
|
2835
3042
|
Created = "Created"
|
|
2836
3043
|
}
|
|
3044
|
+
/** @enumType */
|
|
3045
|
+
export type EventWithLiterals = Event | 'Updated' | 'Deleted' | 'Created';
|
|
2837
3046
|
export interface UserDomainInfoChangedEvent {
|
|
2838
3047
|
domainName?: string;
|
|
2839
|
-
crudType?:
|
|
3048
|
+
crudType?: CrudTypeWithLiterals;
|
|
2840
3049
|
/** @format GUID */
|
|
2841
3050
|
metaSiteId?: string | null;
|
|
2842
3051
|
changeTime?: Date | null;
|
|
@@ -2849,6 +3058,8 @@ export declare enum CrudType {
|
|
|
2849
3058
|
/** Unfortunately this action is used by hibernate save in wix-war */
|
|
2850
3059
|
CREATE_OR_UPDATE = "CREATE_OR_UPDATE"
|
|
2851
3060
|
}
|
|
3061
|
+
/** @enumType */
|
|
3062
|
+
export type CrudTypeWithLiterals = CrudType | 'INVALID_CRUD_TYPE' | 'CREATE' | 'UPDATE' | 'DELETE' | 'CREATE_OR_UPDATE';
|
|
2852
3063
|
export interface HtmlSitePublished {
|
|
2853
3064
|
/**
|
|
2854
3065
|
* Application instance ID
|
|
@@ -3018,7 +3229,7 @@ export interface AddressHint {
|
|
|
3018
3229
|
/** Extra text displayed next to, or instead of, the actual address. */
|
|
3019
3230
|
text?: string;
|
|
3020
3231
|
/** Where the extra text should be displayed. */
|
|
3021
|
-
placement?:
|
|
3232
|
+
placement?: PlacementTypeWithLiterals;
|
|
3022
3233
|
}
|
|
3023
3234
|
/** Where the extra text should be displayed: before, after or instead of the actual address. */
|
|
3024
3235
|
export declare enum PlacementType {
|
|
@@ -3026,6 +3237,8 @@ export declare enum PlacementType {
|
|
|
3026
3237
|
AFTER = "AFTER",
|
|
3027
3238
|
REPLACE = "REPLACE"
|
|
3028
3239
|
}
|
|
3240
|
+
/** @enumType */
|
|
3241
|
+
export type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
|
|
3029
3242
|
/** Geocoordinates for a particular address. */
|
|
3030
3243
|
export interface GeoCoordinates {
|
|
3031
3244
|
/** Latitude of the location. Must be between -90 and 90. */
|
|
@@ -3049,14 +3262,14 @@ export interface BusinessSchedule {
|
|
|
3049
3262
|
/** Weekly recurring time periods when the business is regularly open or the service is available. */
|
|
3050
3263
|
export interface TimePeriod {
|
|
3051
3264
|
/** Day of the week the period starts on. */
|
|
3052
|
-
openDay?:
|
|
3265
|
+
openDay?: DayOfWeekWithLiterals;
|
|
3053
3266
|
/**
|
|
3054
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
|
|
3055
3268
|
* midnight at the end of the specified day.
|
|
3056
3269
|
*/
|
|
3057
3270
|
openTime?: string;
|
|
3058
3271
|
/** Day of the week the period ends on. */
|
|
3059
|
-
closeDay?:
|
|
3272
|
+
closeDay?: DayOfWeekWithLiterals;
|
|
3060
3273
|
/**
|
|
3061
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
|
|
3062
3275
|
* midnight at the end of the specified day.
|
|
@@ -3075,6 +3288,8 @@ export declare enum DayOfWeek {
|
|
|
3075
3288
|
SATURDAY = "SATURDAY",
|
|
3076
3289
|
SUNDAY = "SUNDAY"
|
|
3077
3290
|
}
|
|
3291
|
+
/** @enumType */
|
|
3292
|
+
export type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
|
|
3078
3293
|
/** Exception to the business's regular hours. The business can be open or closed during the exception. */
|
|
3079
3294
|
export interface SpecialHourPeriod {
|
|
3080
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). */
|
|
@@ -3109,13 +3324,15 @@ export interface SupportedLanguage {
|
|
|
3109
3324
|
/** Language icon. */
|
|
3110
3325
|
countryCode?: string;
|
|
3111
3326
|
/** How the language will be resolved. For internal use. */
|
|
3112
|
-
resolutionMethod?:
|
|
3327
|
+
resolutionMethod?: ResolutionMethodWithLiterals;
|
|
3113
3328
|
}
|
|
3114
3329
|
export declare enum ResolutionMethod {
|
|
3115
3330
|
QUERY_PARAM = "QUERY_PARAM",
|
|
3116
3331
|
SUBDOMAIN = "SUBDOMAIN",
|
|
3117
3332
|
SUBDIRECTORY = "SUBDIRECTORY"
|
|
3118
3333
|
}
|
|
3334
|
+
/** @enumType */
|
|
3335
|
+
export type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
|
|
3119
3336
|
export interface ConsentPolicy {
|
|
3120
3337
|
/** Whether the site uses cookies that are essential to site operation. Always `true`. */
|
|
3121
3338
|
essential?: boolean | null;
|
|
@@ -3164,169 +3381,3 @@ export interface SiteCloned {
|
|
|
3164
3381
|
/** Origin site id. */
|
|
3165
3382
|
originMetaSiteId?: string;
|
|
3166
3383
|
}
|
|
3167
|
-
export interface CreateAddOnGroupRequest {
|
|
3168
|
-
/** AddOnGroup to create. */
|
|
3169
|
-
addOnGroup?: AddOnGroup;
|
|
3170
|
-
/**
|
|
3171
|
-
* ID of the service to create the AddOnGroup for.
|
|
3172
|
-
* @format GUID
|
|
3173
|
-
*/
|
|
3174
|
-
serviceId?: string | null;
|
|
3175
|
-
}
|
|
3176
|
-
export interface CreateAddOnGroupResponse {
|
|
3177
|
-
/** Created AddOnGroup. */
|
|
3178
|
-
addOnGroup?: AddOnGroup;
|
|
3179
|
-
}
|
|
3180
|
-
export interface DeleteAddOnGroupRequest {
|
|
3181
|
-
/**
|
|
3182
|
-
* ID of the AddOnGroup to delete.
|
|
3183
|
-
* @format GUID
|
|
3184
|
-
*/
|
|
3185
|
-
addOnGroupId?: string | null;
|
|
3186
|
-
/**
|
|
3187
|
-
* ID of the service from which to delete the AddOnGroup.
|
|
3188
|
-
* @format GUID
|
|
3189
|
-
*/
|
|
3190
|
-
serviceId?: string | null;
|
|
3191
|
-
}
|
|
3192
|
-
export interface DeleteAddOnGroupResponse {
|
|
3193
|
-
}
|
|
3194
|
-
export interface UpdateAddOnGroupRequest {
|
|
3195
|
-
/** AddOnGroup to update. */
|
|
3196
|
-
addOnGroup?: AddOnGroup;
|
|
3197
|
-
/**
|
|
3198
|
-
* ID of the service that contains the AddOnGroup.
|
|
3199
|
-
* @format GUID
|
|
3200
|
-
*/
|
|
3201
|
-
serviceId?: string | null;
|
|
3202
|
-
}
|
|
3203
|
-
export interface UpdateAddOnGroupResponse {
|
|
3204
|
-
/** Updated AddOnGroup */
|
|
3205
|
-
addOnGroup?: AddOnGroup;
|
|
3206
|
-
}
|
|
3207
|
-
export interface ListAddOnGroupsByServiceIdRequest {
|
|
3208
|
-
/**
|
|
3209
|
-
* ID of the service to retrieve AddOnGroups for.
|
|
3210
|
-
* @format GUID
|
|
3211
|
-
*/
|
|
3212
|
-
serviceId?: string | null;
|
|
3213
|
-
/**
|
|
3214
|
-
* List of group ids to return. If not provided, all groups are returned.
|
|
3215
|
-
* @format GUID
|
|
3216
|
-
* @maxSize 3
|
|
3217
|
-
*/
|
|
3218
|
-
groupIds?: string[] | null;
|
|
3219
|
-
}
|
|
3220
|
-
export interface ListAddOnGroupsByServiceIdResponse {
|
|
3221
|
-
/**
|
|
3222
|
-
* List of group IDs and their linked AddOns.
|
|
3223
|
-
* @maxSize 3
|
|
3224
|
-
*/
|
|
3225
|
-
addOnGroupsDetails?: AddOnGroupDetail[];
|
|
3226
|
-
}
|
|
3227
|
-
export interface AddOn extends AddOnAddOnInfoOneOf {
|
|
3228
|
-
/** The AddOn description. */
|
|
3229
|
-
durationInMinutes?: number;
|
|
3230
|
-
/** The AddOn max quantity. */
|
|
3231
|
-
maxQuantity?: number;
|
|
3232
|
-
/**
|
|
3233
|
-
* The AddOn ID.
|
|
3234
|
-
* @format GUID
|
|
3235
|
-
*/
|
|
3236
|
-
addOnId?: string | null;
|
|
3237
|
-
/**
|
|
3238
|
-
* The AddOn name.
|
|
3239
|
-
* @maxLength 100
|
|
3240
|
-
*/
|
|
3241
|
-
name?: string | null;
|
|
3242
|
-
/** The AddOn price. */
|
|
3243
|
-
price?: Money;
|
|
3244
|
-
}
|
|
3245
|
-
/** @oneof */
|
|
3246
|
-
export interface AddOnAddOnInfoOneOf {
|
|
3247
|
-
/** The AddOn description. */
|
|
3248
|
-
durationInMinutes?: number;
|
|
3249
|
-
/** The AddOn max quantity. */
|
|
3250
|
-
maxQuantity?: number;
|
|
3251
|
-
}
|
|
3252
|
-
export interface AddOnGroupDetail {
|
|
3253
|
-
/**
|
|
3254
|
-
* The group ID.
|
|
3255
|
-
* @format GUID
|
|
3256
|
-
*/
|
|
3257
|
-
groupId?: string | null;
|
|
3258
|
-
/** The group max number of AddOns. */
|
|
3259
|
-
maxNumberOfAddOns?: number | null;
|
|
3260
|
-
/**
|
|
3261
|
-
* The group name.
|
|
3262
|
-
* @maxLength 100
|
|
3263
|
-
*/
|
|
3264
|
-
groupName?: string | null;
|
|
3265
|
-
/**
|
|
3266
|
-
* The AddOns information linked to the group.
|
|
3267
|
-
* @maxSize 7
|
|
3268
|
-
*/
|
|
3269
|
-
addOns?: AddOn[];
|
|
3270
|
-
/**
|
|
3271
|
-
* The group prompt.
|
|
3272
|
-
* @maxLength 200
|
|
3273
|
-
*/
|
|
3274
|
-
prompt?: string | null;
|
|
3275
|
-
}
|
|
3276
|
-
export interface SetAddOnsForGroupRequest {
|
|
3277
|
-
/**
|
|
3278
|
-
* The service ID to set AddOns for.
|
|
3279
|
-
* @format GUID
|
|
3280
|
-
*/
|
|
3281
|
-
serviceId?: string | null;
|
|
3282
|
-
/**
|
|
3283
|
-
* The group ID to set AddOns for.
|
|
3284
|
-
* @format GUID
|
|
3285
|
-
*/
|
|
3286
|
-
groupId?: string | null;
|
|
3287
|
-
/**
|
|
3288
|
-
* The IDs of AddOns to set.
|
|
3289
|
-
* @format GUID
|
|
3290
|
-
* @minSize 1
|
|
3291
|
-
* @maxSize 7
|
|
3292
|
-
*/
|
|
3293
|
-
addOnIds?: string[] | null;
|
|
3294
|
-
}
|
|
3295
|
-
export interface SetAddOnsForGroupResponse {
|
|
3296
|
-
/** The updated AddOnGroup. */
|
|
3297
|
-
addOnGroup?: AddOnGroup;
|
|
3298
|
-
}
|
|
3299
|
-
export interface ValidateAddOnsSelectionRequest {
|
|
3300
|
-
/**
|
|
3301
|
-
* The service ID to validate AddOns against.
|
|
3302
|
-
* @format GUID
|
|
3303
|
-
*/
|
|
3304
|
-
serviceId?: string | null;
|
|
3305
|
-
/**
|
|
3306
|
-
* The group ID to validate AddOns against.
|
|
3307
|
-
* @format GUID
|
|
3308
|
-
*/
|
|
3309
|
-
groupId?: string | null;
|
|
3310
|
-
/**
|
|
3311
|
-
* The IDs of AddOns to validate.
|
|
3312
|
-
* @format GUID
|
|
3313
|
-
* @minSize 1
|
|
3314
|
-
* @maxSize 7
|
|
3315
|
-
*/
|
|
3316
|
-
addOnIds?: string[] | null;
|
|
3317
|
-
}
|
|
3318
|
-
export interface ValidateAddOnsSelectionResponse {
|
|
3319
|
-
/** The validation result. */
|
|
3320
|
-
result?: ValidationResult;
|
|
3321
|
-
}
|
|
3322
|
-
export interface ValidationResult {
|
|
3323
|
-
/** Whether the AddOns selection is valid. */
|
|
3324
|
-
valid?: boolean | null;
|
|
3325
|
-
/**
|
|
3326
|
-
* A validation error message.
|
|
3327
|
-
* This field should populated when `valid` is `false`.
|
|
3328
|
-
* @minLength 1
|
|
3329
|
-
* @maxLength 300
|
|
3330
|
-
*/
|
|
3331
|
-
message?: string | null;
|
|
3332
|
-
}
|