@wix/auto_sdk_bookings_services 1.0.133 → 1.0.134

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.
@@ -225,6 +225,10 @@ interface Form {
225
225
  */
226
226
  id?: string;
227
227
  }
228
+ interface FormSettings {
229
+ /** Whether the service booking form should be hidden from the site. */
230
+ hidden?: boolean | null;
231
+ }
228
232
  interface Payment extends PaymentRateOneOf {
229
233
  /**
230
234
  * The details for the fixed price of the service.
@@ -514,6 +518,12 @@ interface StreetAddress {
514
518
  */
515
519
  apt?: string;
516
520
  }
521
+ interface AddressLocation {
522
+ /** Address latitude. */
523
+ latitude?: number | null;
524
+ /** Address longitude. */
525
+ longitude?: number | null;
526
+ }
517
527
  interface BusinessLocationOptions {
518
528
  /**
519
529
  * ID of the business *location*
@@ -895,6 +905,93 @@ interface SaveCreditCardPolicy {
895
905
  /** Default: `false` */
896
906
  enabled?: boolean;
897
907
  }
908
+ /**
909
+ * Policy for determining how staff members are sorted and selected during the booking process.
910
+ * This affects which staff member is chosen when multiple staff members are available for a service.
911
+ */
912
+ interface StaffSortingPolicy extends StaffSortingPolicyOptionsOneOf {
913
+ rankingOptions?: RankingOptions;
914
+ customOptions?: CustomOptions;
915
+ /**
916
+ * Method used for sorting and selecting staff members.
917
+ *
918
+ * Default: `RANDOM`
919
+ */
920
+ sortingMethodType?: SortingMethodTypeWithLiterals;
921
+ }
922
+ /** @oneof */
923
+ interface StaffSortingPolicyOptionsOneOf {
924
+ rankingOptions?: RankingOptions;
925
+ customOptions?: CustomOptions;
926
+ }
927
+ /** Order for ranking-based staff selection. */
928
+ declare enum RankingOrder {
929
+ UNKNOWN_RANKING_ORDER = "UNKNOWN_RANKING_ORDER",
930
+ /** Staff members with lower priority values are selected first. */
931
+ LOWEST_TO_HIGHEST = "LOWEST_TO_HIGHEST",
932
+ /** Staff members with higher priority values are selected first. */
933
+ HIGHEST_TO_LOWEST = "HIGHEST_TO_LOWEST"
934
+ }
935
+ /** @enumType */
936
+ type RankingOrderWithLiterals = RankingOrder | 'UNKNOWN_RANKING_ORDER' | 'LOWEST_TO_HIGHEST' | 'HIGHEST_TO_LOWEST';
937
+ /** Method used to sort and select staff members. */
938
+ declare enum SortingMethodType {
939
+ UNKNOWN_SORTING_METHOD_TYPE = "UNKNOWN_SORTING_METHOD_TYPE",
940
+ /** Staff members are selected randomly from available options. */
941
+ RANDOM = "RANDOM",
942
+ /** Staff members are selected based on their priority ranking. */
943
+ RANKING = "RANKING",
944
+ /**
945
+ * Staff members are selected using a custom method provided by StaffSelectionSPI.
946
+ * This allows third-party apps to implement custom staff selection logic.
947
+ */
948
+ CUSTOM = "CUSTOM"
949
+ }
950
+ /** @enumType */
951
+ type SortingMethodTypeWithLiterals = SortingMethodType | 'UNKNOWN_SORTING_METHOD_TYPE' | 'RANDOM' | 'RANKING' | 'CUSTOM';
952
+ /**
953
+ * Configuration options for ranking-based staff selection.
954
+ * Used when `sorting_method_type` is set to `RANKING`.
955
+ */
956
+ interface RankingOptions {
957
+ /**
958
+ * Order in which staff members are sorted by their priority ranking.
959
+ *
960
+ * Default: `LOWEST_TO_HIGHEST`
961
+ */
962
+ order?: RankingOrderWithLiterals;
963
+ }
964
+ /**
965
+ * Configuration options for custom staff selection methods.
966
+ * Used when `sorting_method_type` is set to `CUSTOM`.
967
+ */
968
+ interface CustomOptions {
969
+ /**
970
+ * ID of the custom selection method implemented in StaffSelectionSPI.
971
+ * This identifies which custom sorting algorithm to use.
972
+ * @format GUID
973
+ */
974
+ methodId?: string;
975
+ /**
976
+ * ID of the app that provides the custom selection method.
977
+ * @format GUID
978
+ */
979
+ appId?: string;
980
+ }
981
+ /** Policy for integrating with Intake form. Stores which form to use and when to present it. */
982
+ interface IntakeFormPolicy {
983
+ /**
984
+ * ID of the form used as an intake form for the service.
985
+ * @format GUID
986
+ */
987
+ formId?: string | null;
988
+ /**
989
+ * Whether the waiver must be completed before bookings.
990
+ * If `false`, the waiver is handled after bookings.
991
+ * Default: `false`
992
+ */
993
+ requireBeforeBook?: boolean;
994
+ }
898
995
  interface Schedule {
899
996
  /**
900
997
  * ID of the *schedule*
@@ -967,6 +1064,75 @@ interface Duration {
967
1064
  */
968
1065
  minutes?: number;
969
1066
  }
1067
+ interface StaffMember {
1068
+ /**
1069
+ * ID of the staff member providing the service, can be used to retrieve resource information using wix-bookings-backend resources API.
1070
+ * @format GUID
1071
+ * @readonly
1072
+ */
1073
+ staffMemberId?: string;
1074
+ /**
1075
+ * Name of the staff member
1076
+ * @maxLength 40
1077
+ * @readonly
1078
+ */
1079
+ name?: string | null;
1080
+ /**
1081
+ * Main media associated with the service.
1082
+ * @readonly
1083
+ */
1084
+ mainMedia?: StaffMediaItem;
1085
+ }
1086
+ interface StaffMediaItem extends StaffMediaItemItemOneOf {
1087
+ /** Details of the image associated with the staff, such as URL and size. */
1088
+ image?: Image;
1089
+ }
1090
+ /** @oneof */
1091
+ interface StaffMediaItemItemOneOf {
1092
+ /** Details of the image associated with the staff, such as URL and size. */
1093
+ image?: Image;
1094
+ }
1095
+ interface StaffMemberDetails {
1096
+ /**
1097
+ * Staff members providing the service. For appointments only.
1098
+ * @maxSize 220
1099
+ */
1100
+ staffMembers?: StaffMember[];
1101
+ }
1102
+ interface ResourceGroup {
1103
+ /**
1104
+ * An optional resource group ID. If specified, it references a resource group in the resource groups API.
1105
+ * TODO - referenced_entity annotation
1106
+ * @format GUID
1107
+ */
1108
+ resourceGroupId?: string | null;
1109
+ /**
1110
+ * Resource IDs. Each ID references a resource in the resources API and may be a subset of resources within a resource group.
1111
+ * TODO - referenced_entity annotation
1112
+ */
1113
+ resourceIds?: ResourceIds;
1114
+ /**
1115
+ * Specifies how many resources in the group / resource IDs are required to book the service.
1116
+ * Defaults to 1.
1117
+ * @min 1
1118
+ */
1119
+ requiredResourcesNumber?: number | null;
1120
+ /**
1121
+ * If set to `true`, the customer can select the specific resources while booking the service.
1122
+ * If set to `false`, the resources required to book the service will be auto-selected at the time of the booking.
1123
+ * Defaults to false.
1124
+ * @readonly
1125
+ */
1126
+ selectableResource?: boolean | null;
1127
+ }
1128
+ interface ResourceIds {
1129
+ /**
1130
+ * Values of the resource IDs.
1131
+ * @maxSize 100
1132
+ * @format GUID
1133
+ */
1134
+ values?: string[];
1135
+ }
970
1136
  interface ServiceResource extends ServiceResourceSelectionOneOf {
971
1137
  /**
972
1138
  * Details about the required *resource type*
@@ -1135,6 +1301,18 @@ interface AddOnGroup {
1135
1301
  */
1136
1302
  prompt?: string | null;
1137
1303
  }
1304
+ interface AddOnDetails {
1305
+ /**
1306
+ * ID of the AddOn.
1307
+ * @format GUID
1308
+ */
1309
+ addOnId?: string | null;
1310
+ /**
1311
+ * The duration of the AddOn in minutes.
1312
+ * This field can be empty if the AddOn has no specific duration.
1313
+ */
1314
+ durationInMinutes?: number | null;
1315
+ }
1138
1316
  /** `TaxableAddress` defines the taxable address used for the service. */
1139
1317
  interface TaxableAddress {
1140
1318
  /** Taxable address type. */
@@ -1147,6 +1325,177 @@ declare enum TaxableAddressType {
1147
1325
  }
1148
1326
  /** @enumType */
1149
1327
  type TaxableAddressTypeWithLiterals = TaxableAddressType | 'UNKNOWN_TAXABLE_ADDRESS_TYPE' | 'BUSINESS' | 'BILLING';
1328
+ /**
1329
+ * Message for reindexing search data to a given search schema. Support both upsert and delete flows as well as
1330
+ * performs context manipulation with adding tenant, provided in message to callscope.
1331
+ */
1332
+ interface ReindexMessage extends ReindexMessageActionOneOf {
1333
+ upsert?: Upsert;
1334
+ delete?: Delete;
1335
+ entityFqdn?: string;
1336
+ tenantId?: string;
1337
+ eventTime?: Date | null;
1338
+ entityEventSequence?: string | null;
1339
+ schema?: Schema;
1340
+ }
1341
+ /** @oneof */
1342
+ interface ReindexMessageActionOneOf {
1343
+ upsert?: Upsert;
1344
+ delete?: Delete;
1345
+ }
1346
+ interface Upsert {
1347
+ entityId?: string;
1348
+ entityAsJson?: string;
1349
+ }
1350
+ interface Delete {
1351
+ entityId?: string;
1352
+ }
1353
+ interface Schema {
1354
+ label?: string;
1355
+ clusterName?: string;
1356
+ }
1357
+ interface SetCustomSlugEvent {
1358
+ /** The main slug for the service after the update */
1359
+ mainSlug?: Slug;
1360
+ }
1361
+ interface ServicesUrlsChanged {
1362
+ }
1363
+ interface DomainEvent extends DomainEventBodyOneOf {
1364
+ createdEvent?: EntityCreatedEvent;
1365
+ updatedEvent?: EntityUpdatedEvent;
1366
+ deletedEvent?: EntityDeletedEvent;
1367
+ actionEvent?: ActionEvent;
1368
+ /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
1369
+ id?: string;
1370
+ /**
1371
+ * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
1372
+ * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
1373
+ */
1374
+ entityFqdn?: string;
1375
+ /**
1376
+ * Event action name, placed at the top level to make it easier for users to dispatch messages.
1377
+ * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
1378
+ */
1379
+ slug?: string;
1380
+ /** ID of the entity associated with the event. */
1381
+ entityId?: string;
1382
+ /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
1383
+ eventTime?: Date | null;
1384
+ /**
1385
+ * Whether the event was triggered as a result of a privacy regulation application
1386
+ * (for example, GDPR).
1387
+ */
1388
+ triggeredByAnonymizeRequest?: boolean | null;
1389
+ /** If present, indicates the action that triggered the event. */
1390
+ originatedFrom?: string | null;
1391
+ /**
1392
+ * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
1393
+ * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
1394
+ */
1395
+ entityEventSequence?: string | null;
1396
+ }
1397
+ /** @oneof */
1398
+ interface DomainEventBodyOneOf {
1399
+ createdEvent?: EntityCreatedEvent;
1400
+ updatedEvent?: EntityUpdatedEvent;
1401
+ deletedEvent?: EntityDeletedEvent;
1402
+ actionEvent?: ActionEvent;
1403
+ }
1404
+ interface EntityCreatedEvent {
1405
+ entityAsJson?: string;
1406
+ /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */
1407
+ restoreInfo?: RestoreInfo;
1408
+ }
1409
+ interface RestoreInfo {
1410
+ deletedDate?: Date | null;
1411
+ }
1412
+ interface EntityUpdatedEvent {
1413
+ /**
1414
+ * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
1415
+ * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
1416
+ * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
1417
+ */
1418
+ currentEntityAsJson?: string;
1419
+ }
1420
+ interface EntityDeletedEvent {
1421
+ /** Entity that was deleted. */
1422
+ deletedEntityAsJson?: string | null;
1423
+ }
1424
+ interface ActionEvent {
1425
+ bodyAsJson?: string;
1426
+ }
1427
+ interface MessageEnvelope {
1428
+ /**
1429
+ * App instance ID.
1430
+ * @format GUID
1431
+ */
1432
+ instanceId?: string | null;
1433
+ /**
1434
+ * Event type.
1435
+ * @maxLength 150
1436
+ */
1437
+ eventType?: string;
1438
+ /** The identification type and identity data. */
1439
+ identity?: IdentificationData;
1440
+ /** Stringify payload. */
1441
+ data?: string;
1442
+ }
1443
+ interface IdentificationData extends IdentificationDataIdOneOf {
1444
+ /**
1445
+ * ID of a site visitor that has not logged in to the site.
1446
+ * @format GUID
1447
+ */
1448
+ anonymousVisitorId?: string;
1449
+ /**
1450
+ * ID of a site visitor that has logged in to the site.
1451
+ * @format GUID
1452
+ */
1453
+ memberId?: string;
1454
+ /**
1455
+ * ID of a Wix user (site owner, contributor, etc.).
1456
+ * @format GUID
1457
+ */
1458
+ wixUserId?: string;
1459
+ /**
1460
+ * ID of an app.
1461
+ * @format GUID
1462
+ */
1463
+ appId?: string;
1464
+ /** @readonly */
1465
+ identityType?: WebhookIdentityTypeWithLiterals;
1466
+ }
1467
+ /** @oneof */
1468
+ interface IdentificationDataIdOneOf {
1469
+ /**
1470
+ * ID of a site visitor that has not logged in to the site.
1471
+ * @format GUID
1472
+ */
1473
+ anonymousVisitorId?: string;
1474
+ /**
1475
+ * ID of a site visitor that has logged in to the site.
1476
+ * @format GUID
1477
+ */
1478
+ memberId?: string;
1479
+ /**
1480
+ * ID of a Wix user (site owner, contributor, etc.).
1481
+ * @format GUID
1482
+ */
1483
+ wixUserId?: string;
1484
+ /**
1485
+ * ID of an app.
1486
+ * @format GUID
1487
+ */
1488
+ appId?: string;
1489
+ }
1490
+ declare enum WebhookIdentityType {
1491
+ UNKNOWN = "UNKNOWN",
1492
+ ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
1493
+ MEMBER = "MEMBER",
1494
+ WIX_USER = "WIX_USER",
1495
+ APP = "APP"
1496
+ }
1497
+ /** @enumType */
1498
+ type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1150
1499
  interface CreateAddOnGroupRequest {
1151
1500
  /** AddOnGroup to create. */
1152
1501
  addOnGroup: AddOnGroup;
@@ -1287,6 +1636,33 @@ interface CreateServiceResponse {
1287
1636
  /** Created service. */
1288
1637
  service?: Service;
1289
1638
  }
1639
+ interface ValidateServiceRequest {
1640
+ /** Service to validate. */
1641
+ service?: Service;
1642
+ }
1643
+ interface ValidateServiceResponse {
1644
+ /** Whether the service is valid. */
1645
+ valid?: boolean;
1646
+ /** Field violations. */
1647
+ fieldViolations?: FieldViolation[];
1648
+ }
1649
+ interface FieldViolation {
1650
+ /**
1651
+ * Path to the invalid field.
1652
+ * @maxLength 2000
1653
+ */
1654
+ fieldName?: string;
1655
+ /**
1656
+ * Description of the error.
1657
+ * @maxLength 2000
1658
+ */
1659
+ description?: string;
1660
+ /**
1661
+ * Rule name of the violation
1662
+ * @maxLength 2000
1663
+ */
1664
+ ruleName?: string;
1665
+ }
1290
1666
  interface BulkCreateServicesRequest {
1291
1667
  /**
1292
1668
  * Services to create.
@@ -1344,10 +1720,91 @@ interface GetServiceRequest {
1344
1720
  */
1345
1721
  serviceId: string;
1346
1722
  }
1723
+ declare enum V2RequestedFields {
1724
+ /** Unknown requested field. */
1725
+ UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
1726
+ /** When passed, `service.staff_members` is returned. */
1727
+ STAFF_MEMBER_DETAILS = "STAFF_MEMBER_DETAILS",
1728
+ /** When passed, `service.service_resources.resource_type.name` is returned. */
1729
+ RESOURCE_TYPE_DETAILS = "RESOURCE_TYPE_DETAILS"
1730
+ }
1731
+ /** @enumType */
1732
+ type V2RequestedFieldsWithLiterals = V2RequestedFields | 'UNKNOWN_REQUESTED_FIELD' | 'STAFF_MEMBER_DETAILS' | 'RESOURCE_TYPE_DETAILS';
1347
1733
  interface GetServiceResponse {
1348
1734
  /** Retrieved service. */
1349
1735
  service?: Service;
1350
1736
  }
1737
+ interface GetServiceAvailabilityConstraintsRequest {
1738
+ /**
1739
+ * ID of the service to retrieve.
1740
+ * @format GUID
1741
+ */
1742
+ serviceId?: string;
1743
+ }
1744
+ interface GetServiceAvailabilityConstraintsResponse {
1745
+ /** The retrieved availability constraints of the service. */
1746
+ constraints?: ServiceAvailabilityConstraints;
1747
+ }
1748
+ interface ServiceAvailabilityConstraints {
1749
+ /**
1750
+ * The booking policy.
1751
+ * @readonly
1752
+ */
1753
+ bookingPolicy?: BookingPolicy;
1754
+ /**
1755
+ * The service schedule, including the schedule ID and availability constraints.
1756
+ * @readonly
1757
+ */
1758
+ schedule?: Schedule;
1759
+ /**
1760
+ * The locations this service is offered at.
1761
+ * Only multiple locations of type `BUSINESS` are supported. Multiple locations of type `CUSTOM` or `CUSTOMER` are not supported.
1762
+ * For courses only: Currently, only one location is supported for all location types.
1763
+ * Use the `Set Service Locations` method to change the locations this service is offered at.
1764
+ * @readonly
1765
+ * @maxSize 100
1766
+ */
1767
+ locations?: Location[];
1768
+ /**
1769
+ * Resource groups required to book the service. For backward compatibility only. Use `Service Resources` instead.
1770
+ * @maxSize 3
1771
+ * @readonly
1772
+ * @deprecated Resource groups required to book the service. For backward compatibility only. Use `Service Resources` instead.
1773
+ * @replacedBy service_resources
1774
+ * @targetRemovalDate 2024-08-19
1775
+ */
1776
+ resourceGroups?: ResourceGroup[];
1777
+ /**
1778
+ * Resource groups required to book the service.
1779
+ * @maxSize 3
1780
+ * @readonly
1781
+ */
1782
+ serviceResources?: ServiceResource[];
1783
+ /**
1784
+ * The time between available slots' start times.
1785
+ * For example, for 5-minute slots: 3:00, 3:05, 3:10 etc. For 1-hour slots: 3:00, 4:00, 5:00 etc.
1786
+ * Applied to all schedules of the site.
1787
+ * For appointments only.
1788
+ * @readonly
1789
+ */
1790
+ slotsSplitInterval?: SplitInterval;
1791
+ /**
1792
+ * Online booking settings.
1793
+ * @readonly
1794
+ */
1795
+ onlineBooking?: OnlineBooking;
1796
+ }
1797
+ /** The time between available slots' start times. For example, For 5 minute slots, 3:00, 3:05, 3:15 etc. For 1 hour slots, 3:00, 4:00, 5:00 etc. */
1798
+ interface SplitInterval {
1799
+ /**
1800
+ * Whether the slot duration is used as the split interval value.
1801
+ * If `same_as_duration` is `true`, the `value_in_minutes` is the sum of the first duration in
1802
+ * `schedule.availabilityConstraints.SlotDurations` field, and `schedule.availabilityConstraints.TimeBetweenSlots` field.
1803
+ */
1804
+ sameAsDuration?: boolean | null;
1805
+ /** Number of minutes between available slots' start times when `same_as_duration` is `false`. */
1806
+ valueInMinutes?: number | null;
1807
+ }
1351
1808
  interface UpdateServiceRequest {
1352
1809
  /** Service to update. */
1353
1810
  service: Service;
@@ -2375,6 +2832,21 @@ interface QueryCategoriesResponse {
2375
2832
  /** Retrieved categories. */
2376
2833
  categories?: V2Category[];
2377
2834
  }
2835
+ interface QueryServicesMultiLanguageRequest {
2836
+ /** WQL expression. */
2837
+ query?: QueryV2;
2838
+ }
2839
+ interface QueryServicesMultiLanguageResponse {
2840
+ /** The retrieved services in the main language */
2841
+ services?: Service[];
2842
+ /**
2843
+ * the retrieved services in the requested language according to the
2844
+ * provided linguist aspect
2845
+ */
2846
+ translatedServices?: Service[];
2847
+ /** Paging metadata, including offset and count. */
2848
+ pagingMetadata?: PagingMetadataV2;
2849
+ }
2378
2850
  interface SetServiceLocationsRequest {
2379
2851
  /**
2380
2852
  * ID of the service.
@@ -2456,6 +2928,18 @@ interface EnablePricingPlansForServiceResponse {
2456
2928
  /** Updated service. */
2457
2929
  service?: Service;
2458
2930
  }
2931
+ interface InvalidPricingPlan {
2932
+ /**
2933
+ * ID of the invalid pricing plan.
2934
+ * @format GUID
2935
+ */
2936
+ id?: string;
2937
+ /**
2938
+ * Explanation why the pricing plan is considered invalid.
2939
+ * @maxLength 2000
2940
+ */
2941
+ message?: string;
2942
+ }
2459
2943
  interface DisablePricingPlansForServiceRequest {
2460
2944
  /**
2461
2945
  * ID of the service to update.
@@ -2557,6 +3041,639 @@ declare enum CloneErrors {
2557
3041
  }
2558
3042
  /** @enumType */
2559
3043
  type CloneErrorsWithLiterals = CloneErrors | 'OPTIONS_AND_VARIANTS' | 'FORM';
3044
+ /** An event sent every time a category entity is changed. */
3045
+ interface CategoryNotification {
3046
+ category?: Category;
3047
+ event?: CategoryNotificationEventWithLiterals;
3048
+ }
3049
+ /** 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. */
3050
+ interface Category {
3051
+ /**
3052
+ * Category ID.
3053
+ * @format GUID
3054
+ * @readonly
3055
+ */
3056
+ id?: string | null;
3057
+ /**
3058
+ * Category name.
3059
+ * @maxLength 500
3060
+ */
3061
+ name?: string | null;
3062
+ /**
3063
+ * Category status.
3064
+ *
3065
+ * Default: `CREATED`
3066
+ * @readonly
3067
+ */
3068
+ status?: StatusWithLiterals;
3069
+ /** Sort order of the category in the live site and dashboard. */
3070
+ sortOrder?: number | null;
3071
+ }
3072
+ declare enum Status {
3073
+ /** The category was created. */
3074
+ CREATED = "CREATED",
3075
+ /** The category was deleted. */
3076
+ DELETED = "DELETED"
3077
+ }
3078
+ /** @enumType */
3079
+ type StatusWithLiterals = Status | 'CREATED' | 'DELETED';
3080
+ declare enum CategoryNotificationEvent {
3081
+ /** Category was updated. */
3082
+ Updated = "Updated",
3083
+ /** Category was deleted. */
3084
+ Deleted = "Deleted",
3085
+ /** Category was created. */
3086
+ Created = "Created"
3087
+ }
3088
+ /** @enumType */
3089
+ type CategoryNotificationEventWithLiterals = CategoryNotificationEvent | 'Updated' | 'Deleted' | 'Created';
3090
+ interface Empty {
3091
+ }
3092
+ interface BenefitNotification {
3093
+ /**
3094
+ * Plan unique ID
3095
+ * @format GUID
3096
+ */
3097
+ planId?: string;
3098
+ /**
3099
+ * App def ID
3100
+ * @format GUID
3101
+ */
3102
+ appDefId?: string;
3103
+ /** Current benefit details */
3104
+ benefit?: Benefit;
3105
+ /** Previous benefit */
3106
+ prevBenefit?: Benefit;
3107
+ /** Notification event */
3108
+ event?: EventWithLiterals;
3109
+ }
3110
+ interface Benefit {
3111
+ /**
3112
+ * Benefit unique ID
3113
+ * @format GUID
3114
+ * @readonly
3115
+ */
3116
+ id?: string | null;
3117
+ /** Benefit Type */
3118
+ benefitType?: BenefitTypeWithLiterals;
3119
+ /**
3120
+ * Resource IDs that serves by this benefit
3121
+ * @format GUID
3122
+ */
3123
+ resourceIds?: string[];
3124
+ /** Amount of credits that provided by this benefit */
3125
+ creditAmount?: number | null;
3126
+ /**
3127
+ * additional details related to benefit; limited to 20 entries, 20 symbols for key and 20 symbols for value
3128
+ * @maxSize 20
3129
+ */
3130
+ customFields?: Record<string, string>;
3131
+ /** return value only in case it required in the ListRequest, true means that benefit's type could be updated */
3132
+ editable?: boolean | null;
3133
+ /** Benefit behavior */
3134
+ behavior?: Behavior;
3135
+ /**
3136
+ * Id of the app associated with this benefit
3137
+ * @format GUID
3138
+ * @readonly
3139
+ */
3140
+ appDefId?: string | null;
3141
+ }
3142
+ interface EntryPass {
3143
+ }
3144
+ interface Discount extends DiscountDiscountOneOf {
3145
+ /**
3146
+ * Fixed-rate percent off discount
3147
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
3148
+ */
3149
+ percentOffRate?: string;
3150
+ /**
3151
+ * Absolute amount discount
3152
+ * @decimalValue options { gt:0, maxScale:2 }
3153
+ */
3154
+ moneyOffAmount?: string;
3155
+ }
3156
+ /** @oneof */
3157
+ interface DiscountDiscountOneOf {
3158
+ /**
3159
+ * Fixed-rate percent off discount
3160
+ * @decimalValue options { gt:0, lte:100, maxScale:2 }
3161
+ */
3162
+ percentOffRate?: string;
3163
+ /**
3164
+ * Absolute amount discount
3165
+ * @decimalValue options { gt:0, maxScale:2 }
3166
+ */
3167
+ moneyOffAmount?: string;
3168
+ }
3169
+ declare enum BenefitType {
3170
+ /** Should never be used */
3171
+ UNDEFINED = "UNDEFINED",
3172
+ /** Limited benefit type */
3173
+ LIMITED = "LIMITED",
3174
+ /** Unlimited benefit type */
3175
+ UNLIMITED = "UNLIMITED"
3176
+ }
3177
+ /** @enumType */
3178
+ type BenefitTypeWithLiterals = BenefitType | 'UNDEFINED' | 'LIMITED' | 'UNLIMITED';
3179
+ interface Behavior extends BehaviorBehaviorOneOf {
3180
+ /** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
3181
+ defaultBehavior?: EntryPass;
3182
+ /** Discount applied to paid resources */
3183
+ discount?: Discount;
3184
+ }
3185
+ /** @oneof */
3186
+ interface BehaviorBehaviorOneOf {
3187
+ /** Entry pass for resources, e.g. a ticket for Bookings service or a ticket for Events. */
3188
+ defaultBehavior?: EntryPass;
3189
+ /** Discount applied to paid resources */
3190
+ discount?: Discount;
3191
+ }
3192
+ declare enum Event {
3193
+ Updated = "Updated",
3194
+ Deleted = "Deleted",
3195
+ Created = "Created"
3196
+ }
3197
+ /** @enumType */
3198
+ type EventWithLiterals = Event | 'Updated' | 'Deleted' | 'Created';
3199
+ interface UserDomainInfoChangedEvent {
3200
+ domainName?: string;
3201
+ crudType?: CrudTypeWithLiterals;
3202
+ /** @format GUID */
3203
+ metaSiteId?: string | null;
3204
+ changeTime?: Date | null;
3205
+ }
3206
+ declare enum CrudType {
3207
+ INVALID_CRUD_TYPE = "INVALID_CRUD_TYPE",
3208
+ CREATE = "CREATE",
3209
+ UPDATE = "UPDATE",
3210
+ DELETE = "DELETE",
3211
+ /** Unfortunately this action is used by hibernate save in wix-war */
3212
+ CREATE_OR_UPDATE = "CREATE_OR_UPDATE"
3213
+ }
3214
+ /** @enumType */
3215
+ type CrudTypeWithLiterals = CrudType | 'INVALID_CRUD_TYPE' | 'CREATE' | 'UPDATE' | 'DELETE' | 'CREATE_OR_UPDATE';
3216
+ interface HtmlSitePublished {
3217
+ /**
3218
+ * Application instance ID
3219
+ * @maxLength 50
3220
+ */
3221
+ appInstanceId?: string;
3222
+ /**
3223
+ * Application type
3224
+ * @maxLength 100
3225
+ */
3226
+ appType?: string;
3227
+ /** Revision */
3228
+ revision?: string;
3229
+ /**
3230
+ * MSID
3231
+ * @maxLength 100
3232
+ */
3233
+ metaSiteId?: string | null;
3234
+ /**
3235
+ * optional branch id if publish is done from branch
3236
+ * @format GUID
3237
+ */
3238
+ branchId?: string | null;
3239
+ /** The site's last transactionId */
3240
+ lastTransactionId?: string | null;
3241
+ /** A list of the site's pages */
3242
+ pages?: Page[];
3243
+ /** Site's publish date */
3244
+ publishDate?: string;
3245
+ }
3246
+ interface Page {
3247
+ /**
3248
+ * Page's Id
3249
+ * @maxLength 100
3250
+ */
3251
+ id?: string;
3252
+ }
3253
+ /** Encapsulates all details written to the Greyhound topic when a site's properties are updated. */
3254
+ interface SitePropertiesNotification {
3255
+ /** The site ID for which this update notification applies. */
3256
+ metasiteId?: string;
3257
+ /** The actual update event. */
3258
+ event?: SitePropertiesEvent;
3259
+ /**
3260
+ * A convenience set of mappings from the MetaSite ID to its constituent services.
3261
+ * @maxSize 500
3262
+ */
3263
+ translations?: Translation[];
3264
+ /** Context of the notification */
3265
+ changeContext?: ChangeContext;
3266
+ }
3267
+ /** The actual update event for a particular notification. */
3268
+ interface SitePropertiesEvent {
3269
+ /** Version of the site's properties represented by this update. */
3270
+ version?: number;
3271
+ /** Set of properties that were updated - corresponds to the fields in "properties". */
3272
+ fields?: string[];
3273
+ /** Updated properties. */
3274
+ properties?: Properties;
3275
+ }
3276
+ interface Properties {
3277
+ /** Site categories. */
3278
+ categories?: Categories;
3279
+ /** Site locale. */
3280
+ locale?: Locale;
3281
+ /**
3282
+ * Site language.
3283
+ *
3284
+ * Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format.
3285
+ */
3286
+ language?: string | null;
3287
+ /**
3288
+ * Site currency format used to bill customers.
3289
+ *
3290
+ * Three-letter currency code in [ISO-4217 alphabetic](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) format.
3291
+ */
3292
+ paymentCurrency?: string | null;
3293
+ /** Timezone in `America/New_York` format. */
3294
+ timeZone?: string | null;
3295
+ /** Email address. */
3296
+ email?: string | null;
3297
+ /** Phone number. */
3298
+ phone?: string | null;
3299
+ /** Fax number. */
3300
+ fax?: string | null;
3301
+ /** Address. */
3302
+ address?: Address;
3303
+ /** Site display name. */
3304
+ siteDisplayName?: string | null;
3305
+ /** Business name. */
3306
+ businessName?: string | null;
3307
+ /** Path to the site's logo in Wix Media (without Wix Media base URL). */
3308
+ logo?: string | null;
3309
+ /** Site description. */
3310
+ description?: string | null;
3311
+ /**
3312
+ * Business schedule. Regular and exceptional time periods when the business is open or the service is available.
3313
+ *
3314
+ * __Note:__ Not supported by Wix Bookings.
3315
+ */
3316
+ businessSchedule?: BusinessSchedule;
3317
+ /** Supported languages of a site and the primary language. */
3318
+ multilingual?: Multilingual;
3319
+ /** Cookie policy the Wix user defined for their site (before the site visitor interacts with/limits it). */
3320
+ consentPolicy?: ConsentPolicy;
3321
+ /**
3322
+ * Supported values: `FITNESS SERVICE`, `RESTAURANT`, `BLOG`, `STORE`, `EVENT`, `UNKNOWN`.
3323
+ *
3324
+ * Site business type.
3325
+ */
3326
+ businessConfig?: string | null;
3327
+ /** External site URL that uses Wix as its headless business solution. */
3328
+ externalSiteUrl?: string | null;
3329
+ /** Track clicks analytics. */
3330
+ trackClicksAnalytics?: boolean;
3331
+ }
3332
+ interface Categories {
3333
+ /** Primary site category. */
3334
+ primary?: string;
3335
+ /**
3336
+ * Secondary site category.
3337
+ * @maxSize 50
3338
+ */
3339
+ secondary?: string[];
3340
+ /** Business Term Id */
3341
+ businessTermId?: string | null;
3342
+ }
3343
+ interface Locale {
3344
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
3345
+ languageCode?: string;
3346
+ /** Two-letter country code in [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) format. */
3347
+ country?: string;
3348
+ }
3349
+ interface Address {
3350
+ /** Street name. */
3351
+ street?: string;
3352
+ /** City name. */
3353
+ city?: string;
3354
+ /** Two-letter country code in an [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) format. */
3355
+ country?: string;
3356
+ /** State. */
3357
+ state?: string;
3358
+ /**
3359
+ * Zip or postal code.
3360
+ * @maxLength 20
3361
+ */
3362
+ zip?: string;
3363
+ /** Extra information to be displayed in the address. */
3364
+ hint?: AddressHint;
3365
+ /** Whether this address represents a physical location. */
3366
+ isPhysical?: boolean;
3367
+ /** Google-formatted version of this address. */
3368
+ googleFormattedAddress?: string;
3369
+ /** Street number. */
3370
+ streetNumber?: string;
3371
+ /** Apartment number. */
3372
+ apartmentNumber?: string;
3373
+ /** Geographic coordinates of location. */
3374
+ coordinates?: GeoCoordinates;
3375
+ }
3376
+ /**
3377
+ * Extra information on displayed addresses.
3378
+ * This is used for display purposes. Used to add additional data about the address, such as "In the passage".
3379
+ * Free text. In addition, the user can state where to display the additional description - before, after, or instead of the address string.
3380
+ */
3381
+ interface AddressHint {
3382
+ /** Extra text displayed next to, or instead of, the actual address. */
3383
+ text?: string;
3384
+ /** Where the extra text should be displayed. */
3385
+ placement?: PlacementTypeWithLiterals;
3386
+ }
3387
+ /** Where the extra text should be displayed: before, after or instead of the actual address. */
3388
+ declare enum PlacementType {
3389
+ BEFORE = "BEFORE",
3390
+ AFTER = "AFTER",
3391
+ REPLACE = "REPLACE"
3392
+ }
3393
+ /** @enumType */
3394
+ type PlacementTypeWithLiterals = PlacementType | 'BEFORE' | 'AFTER' | 'REPLACE';
3395
+ /** Geocoordinates for a particular address. */
3396
+ interface GeoCoordinates {
3397
+ /** Latitude of the location. Must be between -90 and 90. */
3398
+ latitude?: number;
3399
+ /** Longitude of the location. Must be between -180 and 180. */
3400
+ longitude?: number;
3401
+ }
3402
+ /** Business schedule. Regular and exceptional time periods when the business is open or the service is available. */
3403
+ interface BusinessSchedule {
3404
+ /**
3405
+ * Weekly recurring time periods when the business is regularly open or the service is available. Limited to 100 time periods.
3406
+ * @maxSize 100
3407
+ */
3408
+ periods?: TimePeriod[];
3409
+ /**
3410
+ * Exceptions to the business's regular hours. The business can be open or closed during the exception.
3411
+ * @maxSize 100
3412
+ */
3413
+ specialHourPeriod?: SpecialHourPeriod[];
3414
+ }
3415
+ /** Weekly recurring time periods when the business is regularly open or the service is available. */
3416
+ interface TimePeriod {
3417
+ /** Day of the week the period starts on. */
3418
+ openDay?: DayOfWeekWithLiterals;
3419
+ /**
3420
+ * 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
3421
+ * midnight at the end of the specified day.
3422
+ */
3423
+ openTime?: string;
3424
+ /** Day of the week the period ends on. */
3425
+ closeDay?: DayOfWeekWithLiterals;
3426
+ /**
3427
+ * 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
3428
+ * midnight at the end of the specified day.
3429
+ *
3430
+ * __Note:__ If `openDay` and `closeDay` specify the same day of the week `closeTime` must be later than `openTime`.
3431
+ */
3432
+ closeTime?: string;
3433
+ }
3434
+ /** Enumerates the days of the week. */
3435
+ declare enum DayOfWeek {
3436
+ MONDAY = "MONDAY",
3437
+ TUESDAY = "TUESDAY",
3438
+ WEDNESDAY = "WEDNESDAY",
3439
+ THURSDAY = "THURSDAY",
3440
+ FRIDAY = "FRIDAY",
3441
+ SATURDAY = "SATURDAY",
3442
+ SUNDAY = "SUNDAY"
3443
+ }
3444
+ /** @enumType */
3445
+ type DayOfWeekWithLiterals = DayOfWeek | 'MONDAY' | 'TUESDAY' | 'WEDNESDAY' | 'THURSDAY' | 'FRIDAY' | 'SATURDAY' | 'SUNDAY';
3446
+ /** Exception to the business's regular hours. The business can be open or closed during the exception. */
3447
+ interface SpecialHourPeriod {
3448
+ /** 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). */
3449
+ startDate?: string;
3450
+ /** End 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). */
3451
+ endDate?: string;
3452
+ /**
3453
+ * Whether the business is closed (or the service is not available) during the exception.
3454
+ *
3455
+ * Default: `true`.
3456
+ */
3457
+ isClosed?: boolean;
3458
+ /** Additional info about the exception. For example, "We close earlier on New Year's Eve." */
3459
+ comment?: string;
3460
+ }
3461
+ interface Multilingual {
3462
+ /**
3463
+ * Supported languages list.
3464
+ * @maxSize 200
3465
+ */
3466
+ supportedLanguages?: SupportedLanguage[];
3467
+ /** Whether to redirect to user language. */
3468
+ autoRedirect?: boolean;
3469
+ }
3470
+ interface SupportedLanguage {
3471
+ /** Two-letter language code in [ISO 639-1 alpha-2](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) format. */
3472
+ languageCode?: string;
3473
+ /** Locale. */
3474
+ locale?: Locale;
3475
+ /** Whether the supported language is the primary language for the site. */
3476
+ isPrimary?: boolean;
3477
+ /** Language icon. */
3478
+ countryCode?: string;
3479
+ /** How the language will be resolved. For internal use. */
3480
+ resolutionMethod?: ResolutionMethodWithLiterals;
3481
+ /** Whether the supported language is the primary language for site visitors. */
3482
+ isVisitorPrimary?: boolean | null;
3483
+ }
3484
+ declare enum ResolutionMethod {
3485
+ QUERY_PARAM = "QUERY_PARAM",
3486
+ SUBDOMAIN = "SUBDOMAIN",
3487
+ SUBDIRECTORY = "SUBDIRECTORY"
3488
+ }
3489
+ /** @enumType */
3490
+ type ResolutionMethodWithLiterals = ResolutionMethod | 'QUERY_PARAM' | 'SUBDOMAIN' | 'SUBDIRECTORY';
3491
+ interface ConsentPolicy {
3492
+ /** Whether the site uses cookies that are essential to site operation. Always `true`. */
3493
+ essential?: boolean | null;
3494
+ /** Whether the site uses cookies that affect site performance and other functional measurements. */
3495
+ functional?: boolean | null;
3496
+ /** Whether the site uses cookies that collect analytics about how the site is used (in order to improve it). */
3497
+ analytics?: boolean | null;
3498
+ /** Whether the site uses cookies that collect information allowing better customization of the experience for a current visitor. */
3499
+ advertising?: boolean | null;
3500
+ /** CCPA compliance flag. */
3501
+ dataToThirdParty?: boolean | null;
3502
+ }
3503
+ /** A single mapping from the MetaSite ID to a particular service. */
3504
+ interface Translation {
3505
+ /** The service type. */
3506
+ serviceType?: string;
3507
+ /** The application definition ID; this only applies to services of type ThirdPartyApps. */
3508
+ appDefId?: string;
3509
+ /** The instance ID of the service. */
3510
+ instanceId?: string;
3511
+ }
3512
+ interface ChangeContext extends ChangeContextPayloadOneOf {
3513
+ /** Properties were updated. */
3514
+ propertiesChange?: PropertiesChange;
3515
+ /** Default properties were created on site creation. */
3516
+ siteCreated?: SiteCreated;
3517
+ /** Properties were cloned on site cloning. */
3518
+ siteCloned?: SiteCloned;
3519
+ }
3520
+ /** @oneof */
3521
+ interface ChangeContextPayloadOneOf {
3522
+ /** Properties were updated. */
3523
+ propertiesChange?: PropertiesChange;
3524
+ /** Default properties were created on site creation. */
3525
+ siteCreated?: SiteCreated;
3526
+ /** Properties were cloned on site cloning. */
3527
+ siteCloned?: SiteCloned;
3528
+ }
3529
+ interface PropertiesChange {
3530
+ }
3531
+ interface SiteCreated {
3532
+ /** Origin template site id. */
3533
+ originTemplateId?: string | null;
3534
+ }
3535
+ interface SiteCloned {
3536
+ /** Origin site id. */
3537
+ originMetaSiteId?: string;
3538
+ }
3539
+ /** @docsIgnore */
3540
+ type DeleteAddOnGroupApplicationErrors = {
3541
+ code?: 'GROUP_NOT_ON_SERVICE';
3542
+ description?: string;
3543
+ data?: Record<string, any>;
3544
+ };
3545
+ /** @docsIgnore */
3546
+ type UpdateAddOnGroupApplicationErrors = {
3547
+ code?: 'GROUP_NOT_ON_SERVICE';
3548
+ description?: string;
3549
+ data?: Record<string, any>;
3550
+ };
3551
+ /** @docsIgnore */
3552
+ type SetAddOnsForGroupApplicationErrors = {
3553
+ code?: 'ADD_ON_GROUP_NOT_FOUND';
3554
+ description?: string;
3555
+ data?: Record<string, any>;
3556
+ };
3557
+ /** @docsIgnore */
3558
+ type CreateServiceValidationErrors = {
3559
+ ruleName?: 'INVALID_FORM';
3560
+ } | {
3561
+ ruleName?: 'INVALID_CATEGORY';
3562
+ } | {
3563
+ ruleName?: 'INVALID_BOOKING_POLICY';
3564
+ } | {
3565
+ ruleName?: 'INVALID_SERVICE_TYPE';
3566
+ } | {
3567
+ ruleName?: 'INVALID_SERVICE_NAME';
3568
+ } | {
3569
+ ruleName?: 'INVALID_ONLINE_BOOKING';
3570
+ } | {
3571
+ ruleName?: 'INVALID_STAFF_MEMBER_IDS';
3572
+ } | {
3573
+ ruleName?: 'PAYMENT_REQUIRED';
3574
+ } | {
3575
+ ruleName?: 'INVALID_PAYMENT_TYPE';
3576
+ } | {
3577
+ ruleName?: 'INVALID_RATE';
3578
+ } | {
3579
+ ruleName?: 'INVALID_PAYMENT_OPTIONS';
3580
+ } | {
3581
+ ruleName?: 'INVALID_BUSINESS_LOCATIONS';
3582
+ } | {
3583
+ ruleName?: 'INVALID_LOCATIONS';
3584
+ } | {
3585
+ ruleName?: 'INVALID_BUSINESS_LOCATION';
3586
+ } | {
3587
+ ruleName?: 'INVALID_CUSTOM_LOCATION';
3588
+ } | {
3589
+ ruleName?: 'INVALID_CUSTOMER_LOCATION';
3590
+ } | {
3591
+ ruleName?: 'INVALID_UNKNOWN_LOCATION';
3592
+ } | {
3593
+ ruleName?: 'INVALID_MANUAL_APPROVAL_WITH_PRICING_PLANS';
3594
+ } | {
3595
+ ruleName?: 'INVALID_DEFAULT_CAPACITY';
3596
+ } | {
3597
+ ruleName?: 'INVALID_APPOINTMENT_CAPACITY';
3598
+ } | {
3599
+ ruleName?: 'INVALID_SESSION_DURATION';
3600
+ };
3601
+ /** @docsIgnore */
3602
+ type UpdateServiceValidationErrors = {
3603
+ ruleName?: 'INVALID_FORM';
3604
+ } | {
3605
+ ruleName?: 'INVALID_CATEGORY';
3606
+ } | {
3607
+ ruleName?: 'INVALID_BOOKING_POLICY';
3608
+ } | {
3609
+ ruleName?: 'INVALID_SERVICE_TYPE';
3610
+ } | {
3611
+ ruleName?: 'INVALID_SERVICE_NAME';
3612
+ } | {
3613
+ ruleName?: 'INVALID_ONLINE_BOOKING';
3614
+ } | {
3615
+ ruleName?: 'INVALID_STAFF_MEMBER_IDS';
3616
+ } | {
3617
+ ruleName?: 'PAYMENT_REQUIRED';
3618
+ } | {
3619
+ ruleName?: 'INVALID_PAYMENT_TYPE';
3620
+ } | {
3621
+ ruleName?: 'INVALID_RATE';
3622
+ } | {
3623
+ ruleName?: 'INVALID_PAYMENT_OPTIONS';
3624
+ } | {
3625
+ ruleName?: 'INVALID_BUSINESS_LOCATIONS';
3626
+ } | {
3627
+ ruleName?: 'INVALID_LOCATIONS';
3628
+ } | {
3629
+ ruleName?: 'INVALID_BUSINESS_LOCATION';
3630
+ } | {
3631
+ ruleName?: 'INVALID_CUSTOM_LOCATION';
3632
+ } | {
3633
+ ruleName?: 'INVALID_CUSTOMER_LOCATION';
3634
+ } | {
3635
+ ruleName?: 'INVALID_UNKNOWN_LOCATION';
3636
+ } | {
3637
+ ruleName?: 'INVALID_MANUAL_APPROVAL_WITH_PRICING_PLANS';
3638
+ } | {
3639
+ ruleName?: 'INVALID_DEFAULT_CAPACITY';
3640
+ } | {
3641
+ ruleName?: 'INVALID_APPOINTMENT_CAPACITY';
3642
+ } | {
3643
+ ruleName?: 'INVALID_SESSION_DURATION';
3644
+ };
3645
+ /** @docsIgnore */
3646
+ type QueryBookingFormsApplicationErrors = {
3647
+ code?: 'DEFAULT_BOOKING_FORM_NOT_FOUND';
3648
+ description?: string;
3649
+ data?: Record<string, any>;
3650
+ };
3651
+ /** @docsIgnore */
3652
+ type EnablePricingPlansForServiceApplicationErrors = {
3653
+ code?: 'INVALID_PRICING_PLAN';
3654
+ description?: string;
3655
+ data?: InvalidPricingPlan;
3656
+ } | {
3657
+ code?: 'SERVICE_DOES_NOT_SUPPORT_PRICING_PLANS';
3658
+ description?: string;
3659
+ data?: Record<string, any>;
3660
+ };
3661
+ /** @docsIgnore */
3662
+ type DisablePricingPlansForServiceApplicationErrors = {
3663
+ code?: 'INVALID_PRICING_PLAN';
3664
+ description?: string;
3665
+ data?: InvalidPricingPlan;
3666
+ };
3667
+ /** @docsIgnore */
3668
+ type SetCustomSlugApplicationErrors = {
3669
+ code?: 'SLUG_ALREADY_EXISTS';
3670
+ description?: string;
3671
+ data?: Record<string, any>;
3672
+ };
3673
+ /** @docsIgnore */
3674
+ type SetCustomSlugValidationErrors = {
3675
+ ruleName?: 'SLUG_CONTAINS_ILLEGAL_CHARACTERS';
3676
+ };
2560
3677
 
2561
3678
  type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
2562
3679
  getUrl: (context: any) => string;
@@ -2610,4 +3727,4 @@ declare function setCustomSlug(): __PublicMethodMetaInfo<'POST', {
2610
3727
  declare function validateSlug(): __PublicMethodMetaInfo<'POST', {}, ValidateSlugRequest$1, ValidateSlugRequest, ValidateSlugResponse$1, ValidateSlugResponse>;
2611
3728
  declare function cloneService(): __PublicMethodMetaInfo<'POST', {}, CloneServiceRequest$1, CloneServiceRequest, CloneServiceResponse$1, CloneServiceResponse>;
2612
3729
 
2613
- export { type __PublicMethodMetaInfo, bulkCreateServices, bulkDeleteServices, bulkDeleteServicesByFilter, bulkUpdateServices, bulkUpdateServicesByFilter, cloneService, countServices, createAddOnGroup, createService, deleteAddOnGroup, deleteService, disablePricingPlansForService, enablePricingPlansForService, getService, listAddOnGroupsByServiceId, queryBookingForms, queryCategories, queryLocations, queryPolicies, queryServices, searchServices, setAddOnsForGroup, setCustomSlug, setServiceLocations, updateAddOnGroup, updateService, validateSlug };
3730
+ export { type ActionEvent as ActionEventOriginal, Action as ActionOriginal, type ActionWithLiterals as ActionWithLiteralsOriginal, type AddOnAddOnInfoOneOf as AddOnAddOnInfoOneOfOriginal, type AddOnDetails as AddOnDetailsOriginal, type AddOnGroupDetail as AddOnGroupDetailOriginal, type AddOnGroup as AddOnGroupOriginal, type AddOn as AddOnOriginal, AddOnPaymentOptions as AddOnPaymentOptionsOriginal, type AddOnPaymentOptionsWithLiterals as AddOnPaymentOptionsWithLiteralsOriginal, type AddressHint as AddressHintOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AggregationData as AggregationDataOriginal, type AggregationKindOneOf as AggregationKindOneOfOriginal, type Aggregation as AggregationOriginal, type AggregationResults as AggregationResultsOriginal, type AggregationResultsResultOneOf as AggregationResultsResultOneOfOriginal, type AggregationResultsScalarResult as AggregationResultsScalarResultOriginal, AggregationType as AggregationTypeOriginal, type AggregationTypeWithLiterals as AggregationTypeWithLiteralsOriginal, type ApplicationError as ApplicationErrorOriginal, type AvailabilityConstraints as AvailabilityConstraintsOriginal, type BehaviorBehaviorOneOf as BehaviorBehaviorOneOfOriginal, type Behavior as BehaviorOriginal, type BenefitNotification as BenefitNotificationOriginal, type Benefit as BenefitOriginal, BenefitType as BenefitTypeOriginal, type BenefitTypeWithLiterals as BenefitTypeWithLiteralsOriginal, type BookAfterStartPolicy as BookAfterStartPolicyOriginal, type BookingForm as BookingFormOriginal, type BookingPolicy as BookingPolicyOriginal, type BookingPolicyWithServices as BookingPolicyWithServicesOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkCreateServicesRequest as BulkCreateServicesRequestOriginal, type BulkCreateServicesResponse as BulkCreateServicesResponseOriginal, type BulkDeleteServicesByFilterRequest as BulkDeleteServicesByFilterRequestOriginal, type BulkDeleteServicesByFilterResponse as BulkDeleteServicesByFilterResponseOriginal, type BulkDeleteServicesRequest as BulkDeleteServicesRequestOriginal, type BulkDeleteServicesResponse as BulkDeleteServicesResponseOriginal, type BulkServiceResult as BulkServiceResultOriginal, type BulkUpdateServicesByFilterRequest as BulkUpdateServicesByFilterRequestOriginal, type BulkUpdateServicesByFilterResponse as BulkUpdateServicesByFilterResponseOriginal, type BulkUpdateServicesRequest as BulkUpdateServicesRequestOriginal, type BulkUpdateServicesResponse as BulkUpdateServicesResponseOriginal, type BusinessLocationOptions as BusinessLocationOptionsOriginal, type BusinessLocations as BusinessLocationsOriginal, type BusinessSchedule as BusinessScheduleOriginal, type CancellationFeePolicy as CancellationFeePolicyOriginal, type CancellationPolicy as CancellationPolicyOriginal, type CancellationWindowFeeOneOf as CancellationWindowFeeOneOfOriginal, type CancellationWindow as CancellationWindowOriginal, type Categories as CategoriesOriginal, CategoryNotificationEvent as CategoryNotificationEventOriginal, type CategoryNotificationEventWithLiterals as CategoryNotificationEventWithLiteralsOriginal, type CategoryNotification as CategoryNotificationOriginal, type Category as CategoryOriginal, type ChangeContext as ChangeContextOriginal, type ChangeContextPayloadOneOf as ChangeContextPayloadOneOfOriginal, CloneErrors as CloneErrorsOriginal, type CloneErrorsWithLiterals as CloneErrorsWithLiteralsOriginal, type CloneServiceRequest as CloneServiceRequestOriginal, type CloneServiceResponse as CloneServiceResponseOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Conferencing as ConferencingOriginal, type ConnectedService as ConnectedServiceOriginal, type ConsentPolicy as ConsentPolicyOriginal, type CountServicesRequest as CountServicesRequestOriginal, type CountServicesResponse as CountServicesResponseOriginal, type CreateAddOnGroupRequest as CreateAddOnGroupRequestOriginal, type CreateAddOnGroupResponse as CreateAddOnGroupResponseOriginal, type CreateServiceRequest as CreateServiceRequestOriginal, type CreateServiceResponse as CreateServiceResponseOriginal, type CreateServiceValidationErrors as CreateServiceValidationErrorsOriginal, CrudType as CrudTypeOriginal, type CrudTypeWithLiterals as CrudTypeWithLiteralsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorQuery as CursorQueryOriginal, type CursorQueryPagingMethodOneOf as CursorQueryPagingMethodOneOfOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomLocationOptions as CustomLocationOptionsOriginal, type CustomLocations as CustomLocationsOriginal, type CustomOptions as CustomOptionsOriginal, type CustomPayment as CustomPaymentOriginal, type CustomerLocations as CustomerLocationsOriginal, type DateHistogramAggregation as DateHistogramAggregationOriginal, type DateHistogramResult as DateHistogramResultOriginal, type DateHistogramResults as DateHistogramResultsOriginal, DayOfWeek as DayOfWeekOriginal, type DayOfWeekWithLiterals as DayOfWeekWithLiteralsOriginal, type DeleteAddOnGroupApplicationErrors as DeleteAddOnGroupApplicationErrorsOriginal, type DeleteAddOnGroupRequest as DeleteAddOnGroupRequestOriginal, type DeleteAddOnGroupResponse as DeleteAddOnGroupResponseOriginal, type Delete as DeleteOriginal, type DeleteServiceRequest as DeleteServiceRequestOriginal, type DeleteServiceResponse as DeleteServiceResponseOriginal, type DisablePricingPlansForServiceApplicationErrors as DisablePricingPlansForServiceApplicationErrorsOriginal, type DisablePricingPlansForServiceRequest as DisablePricingPlansForServiceRequestOriginal, type DisablePricingPlansForServiceResponse as DisablePricingPlansForServiceResponseOriginal, type DiscountDiscountOneOf as DiscountDiscountOneOfOriginal, type Discount as DiscountOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type Duration as DurationOriginal, type Empty as EmptyOriginal, type EnablePricingPlansForServiceApplicationErrors as EnablePricingPlansForServiceApplicationErrorsOriginal, type EnablePricingPlansForServiceRequest as EnablePricingPlansForServiceRequestOriginal, type EnablePricingPlansForServiceResponse as EnablePricingPlansForServiceResponseOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type EntryPass as EntryPassOriginal, Event as EventOriginal, type EventWithLiterals as EventWithLiteralsOriginal, type ExtendedFields as ExtendedFieldsOriginal, type FieldViolation as FieldViolationOriginal, type FixedPayment as FixedPaymentOriginal, type FormDetails as FormDetailsOriginal, type Form as FormOriginal, type FormSettings as FormSettingsOriginal, type GeoCoordinates as GeoCoordinatesOriginal, type GetServiceAvailabilityConstraintsRequest as GetServiceAvailabilityConstraintsRequestOriginal, type GetServiceAvailabilityConstraintsResponse as GetServiceAvailabilityConstraintsResponseOriginal, type GetServiceRequest as GetServiceRequestOriginal, type GetServiceResponse as GetServiceResponseOriginal, type GroupByAggregationKindOneOf as GroupByAggregationKindOneOfOriginal, type GroupByAggregation as GroupByAggregationOriginal, type GroupByValueResults as GroupByValueResultsOriginal, type HtmlSitePublished as HtmlSitePublishedOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type IncludeMissingValuesOptions as IncludeMissingValuesOptionsOriginal, type IntakeFormPolicy as IntakeFormPolicyOriginal, Interval as IntervalOriginal, type IntervalWithLiterals as IntervalWithLiteralsOriginal, type InvalidPricingPlan as InvalidPricingPlanOriginal, InvalidSlugError as InvalidSlugErrorOriginal, type InvalidSlugErrorWithLiterals as InvalidSlugErrorWithLiteralsOriginal, type ItemMetadata as ItemMetadataOriginal, type Keyword as KeywordOriginal, type LimitEarlyBookingPolicy as LimitEarlyBookingPolicyOriginal, type LimitLateBookingPolicy as LimitLateBookingPolicyOriginal, type ListAddOnGroupsByServiceIdRequest as ListAddOnGroupsByServiceIdRequestOriginal, type ListAddOnGroupsByServiceIdResponse as ListAddOnGroupsByServiceIdResponseOriginal, type Locale as LocaleOriginal, type LocationOptionsOneOf as LocationOptionsOneOfOriginal, type Location as LocationOriginal, LocationType as LocationTypeOriginal, type LocationTypeWithLiterals as LocationTypeWithLiteralsOriginal, type MaskedService as MaskedServiceOriginal, type MediaItemItemOneOf as MediaItemItemOneOfOriginal, type MediaItem as MediaItemOriginal, type Media as MediaOriginal, type MessageEnvelope as MessageEnvelopeOriginal, MissingValues as MissingValuesOriginal, type MissingValuesWithLiterals as MissingValuesWithLiteralsOriginal, Mode as ModeOriginal, type ModeWithLiterals as ModeWithLiteralsOriginal, type Money as MoneyOriginal, type MoveToNewLocationsOptions as MoveToNewLocationsOptionsOriginal, type Multilingual as MultilingualOriginal, type NestedAggregationItemKindOneOf as NestedAggregationItemKindOneOfOriginal, type NestedAggregationItem as NestedAggregationItemOriginal, type NestedAggregation as NestedAggregationOriginal, type NestedAggregationResults as NestedAggregationResultsOriginal, type NestedAggregationResultsResultOneOf as NestedAggregationResultsResultOneOfOriginal, NestedAggregationType as NestedAggregationTypeOriginal, type NestedAggregationTypeWithLiterals as NestedAggregationTypeWithLiteralsOriginal, type NestedResultValue as NestedResultValueOriginal, type NestedResultValueResultOneOf as NestedResultValueResultOneOfOriginal, type NestedResults as NestedResultsOriginal, type NestedValueAggregationResult as NestedValueAggregationResultOriginal, type OnlineBooking as OnlineBookingOriginal, type Page as PageOriginal, type PageUrlV2 as PageUrlV2Original, type PagingMetadataV2 as PagingMetadataV2Original, type Paging as PagingOriginal, type ParticipantNotification as ParticipantNotificationOriginal, type ParticipantsPolicy as ParticipantsPolicyOriginal, type PaymentOptions as PaymentOptionsOriginal, type Payment as PaymentOriginal, type PaymentRateOneOf as PaymentRateOneOfOriginal, PlacementType as PlacementTypeOriginal, type PlacementTypeWithLiterals as PlacementTypeWithLiteralsOriginal, type PolicyDescription as PolicyDescriptionOriginal, type PropertiesChange as PropertiesChangeOriginal, type Properties as PropertiesOriginal, type QueryBookingFormsApplicationErrors as QueryBookingFormsApplicationErrorsOriginal, type QueryBookingFormsRequest as QueryBookingFormsRequestOriginal, type QueryBookingFormsResponse as QueryBookingFormsResponseOriginal, type QueryCategoriesFilter as QueryCategoriesFilterOriginal, type QueryCategoriesRequest as QueryCategoriesRequestOriginal, type QueryCategoriesResponse as QueryCategoriesResponseOriginal, type QueryLocationsFilter as QueryLocationsFilterOriginal, type QueryLocationsRequest as QueryLocationsRequestOriginal, type QueryLocationsResponse as QueryLocationsResponseOriginal, type QueryPoliciesRequest as QueryPoliciesRequestOriginal, type QueryPoliciesResponse as QueryPoliciesResponseOriginal, type QueryServicesMultiLanguageRequest as QueryServicesMultiLanguageRequestOriginal, type QueryServicesMultiLanguageResponse as QueryServicesMultiLanguageResponseOriginal, type QueryServicesRequest as QueryServicesRequestOriginal, type QueryServicesResponse as QueryServicesResponseOriginal, type QueryV2 as QueryV2Original, type QueryV2PagingMethodOneOf as QueryV2PagingMethodOneOfOriginal, type RangeAggregation as RangeAggregationOriginal, type RangeAggregationResult as RangeAggregationResultOriginal, type RangeBucket as RangeBucketOriginal, type RangeResult as RangeResultOriginal, type RangeResults as RangeResultsOriginal, type RankingOptions as RankingOptionsOriginal, RankingOrder as RankingOrderOriginal, type RankingOrderWithLiterals as RankingOrderWithLiteralsOriginal, RateType as RateTypeOriginal, type RateTypeWithLiterals as RateTypeWithLiteralsOriginal, type ReindexMessageActionOneOf as ReindexMessageActionOneOfOriginal, type ReindexMessage as ReindexMessageOriginal, type RemovedLocationSessionsActionActionOptionsOneOf as RemovedLocationSessionsActionActionOptionsOneOfOriginal, type RemovedLocationSessionsAction as RemovedLocationSessionsActionOriginal, RequestedFields as RequestedFieldsOriginal, type RequestedFieldsWithLiterals as RequestedFieldsWithLiteralsOriginal, type ReschedulePolicy as ReschedulePolicyOriginal, ResolutionMethod as ResolutionMethodOriginal, type ResolutionMethodWithLiterals as ResolutionMethodWithLiteralsOriginal, type ResourceGroup as ResourceGroupOriginal, type ResourceIds as ResourceIdsOriginal, type ResourceType as ResourceTypeOriginal, type ResourcesPolicy as ResourcesPolicyOriginal, type RestoreInfo as RestoreInfoOriginal, type Results as ResultsOriginal, type SaveCreditCardPolicy as SaveCreditCardPolicyOriginal, type ScalarAggregation as ScalarAggregationOriginal, type ScalarResult as ScalarResultOriginal, ScalarType as ScalarTypeOriginal, type ScalarTypeWithLiterals as ScalarTypeWithLiteralsOriginal, type Schedule as ScheduleOriginal, type Schema as SchemaOriginal, type SearchDetails as SearchDetailsOriginal, type SearchServicesRequest as SearchServicesRequestOriginal, type SearchServicesResponse as SearchServicesResponseOriginal, type SeoSchema as SeoSchemaOriginal, type ServiceAvailabilityConstraints as ServiceAvailabilityConstraintsOriginal, type Service as ServiceOriginal, type ServiceResource as ServiceResourceOriginal, type ServiceResourceSelectionOneOf as ServiceResourceSelectionOneOfOriginal, ServiceType as ServiceTypeOriginal, type ServiceTypeWithLiterals as ServiceTypeWithLiteralsOriginal, type ServicesUrlsChanged as ServicesUrlsChangedOriginal, type SetAddOnsForGroupApplicationErrors as SetAddOnsForGroupApplicationErrorsOriginal, type SetAddOnsForGroupRequest as SetAddOnsForGroupRequestOriginal, type SetAddOnsForGroupResponse as SetAddOnsForGroupResponseOriginal, type SetCustomSlugApplicationErrors as SetCustomSlugApplicationErrorsOriginal, type SetCustomSlugEvent as SetCustomSlugEventOriginal, type SetCustomSlugRequest as SetCustomSlugRequestOriginal, type SetCustomSlugResponse as SetCustomSlugResponseOriginal, type SetCustomSlugValidationErrors as SetCustomSlugValidationErrorsOriginal, type SetServiceLocationsRequest as SetServiceLocationsRequestOriginal, type SetServiceLocationsResponse as SetServiceLocationsResponseOriginal, type Settings as SettingsOriginal, type SiteCloned as SiteClonedOriginal, type SiteCreated as SiteCreatedOriginal, type SitePropertiesEvent as SitePropertiesEventOriginal, type SitePropertiesNotification as SitePropertiesNotificationOriginal, type Slug as SlugOriginal, SortDirection as SortDirectionOriginal, type SortDirectionWithLiterals as SortDirectionWithLiteralsOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, SortType as SortTypeOriginal, type SortTypeWithLiterals as SortTypeWithLiteralsOriginal, SortingMethodType as SortingMethodTypeOriginal, type SortingMethodTypeWithLiterals as SortingMethodTypeWithLiteralsOriginal, type Sorting as SortingOriginal, type SpecialHourPeriod as SpecialHourPeriodOriginal, type SplitInterval as SplitIntervalOriginal, type StaffMediaItemItemOneOf as StaffMediaItemItemOneOfOriginal, type StaffMediaItem as StaffMediaItemOriginal, type StaffMemberDetails as StaffMemberDetailsOriginal, type StaffMember as StaffMemberOriginal, type StaffSortingPolicyOptionsOneOf as StaffSortingPolicyOptionsOneOfOriginal, type StaffSortingPolicy as StaffSortingPolicyOriginal, Status as StatusOriginal, type StatusWithLiterals as StatusWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type SupportedLanguage as SupportedLanguageOriginal, type Tag as TagOriginal, type TaxableAddress as TaxableAddressOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TimePeriod as TimePeriodOriginal, type Translation as TranslationOriginal, type URLs as URLsOriginal, type UpdateAddOnGroupApplicationErrors as UpdateAddOnGroupApplicationErrorsOriginal, type UpdateAddOnGroupRequest as UpdateAddOnGroupRequestOriginal, type UpdateAddOnGroupResponse as UpdateAddOnGroupResponseOriginal, type UpdateServiceRequest as UpdateServiceRequestOriginal, type UpdateServiceResponse as UpdateServiceResponseOriginal, type UpdateServiceValidationErrors as UpdateServiceValidationErrorsOriginal, type Upsert as UpsertOriginal, type UserDomainInfoChangedEvent as UserDomainInfoChangedEventOriginal, type V2Category as V2CategoryOriginal, V2RequestedFields as V2RequestedFieldsOriginal, type V2RequestedFieldsWithLiterals as V2RequestedFieldsWithLiteralsOriginal, type ValidateServiceRequest as ValidateServiceRequestOriginal, type ValidateServiceResponse as ValidateServiceResponseOriginal, type ValidateSlugRequest as ValidateSlugRequestOriginal, type ValidateSlugResponse as ValidateSlugResponseOriginal, type ValueAggregationOptionsOneOf as ValueAggregationOptionsOneOfOriginal, type ValueAggregation as ValueAggregationOriginal, type ValueAggregationResult as ValueAggregationResultOriginal, type ValueResult as ValueResultOriginal, type ValueResults as ValueResultsOriginal, type VariedPayment as VariedPaymentOriginal, type WaitlistPolicy as WaitlistPolicyOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, type __PublicMethodMetaInfo, bulkCreateServices, bulkDeleteServices, bulkDeleteServicesByFilter, bulkUpdateServices, bulkUpdateServicesByFilter, cloneService, countServices, createAddOnGroup, createService, deleteAddOnGroup, deleteService, disablePricingPlansForService, enablePricingPlansForService, getService, listAddOnGroupsByServiceId, queryBookingForms, queryCategories, queryLocations, queryPolicies, queryServices, searchServices, setAddOnsForGroup, setCustomSlug, setServiceLocations, updateAddOnGroup, updateService, validateSlug };