@wix/auto_sdk_table-reservations_experiences 1.0.37 → 1.0.38
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.d.ts +11 -29
- package/build/cjs/index.js +32 -2977
- package/build/cjs/index.js.map +1 -1
- package/build/cjs/index.typings.d.ts +2 -2
- package/build/cjs/index.typings.js +10 -2955
- package/build/cjs/index.typings.js.map +1 -1
- package/build/cjs/meta.d.ts +66 -51
- package/build/cjs/meta.js.map +1 -1
- package/build/cjs/schemas.d.ts +3 -3
- package/build/cjs/{table-reservations-v1-experience-experiences.universal-CHddGarE.d.ts → table-reservations-v1-experience-experiences.universal-DBg6eXpp.d.ts} +67 -52
- package/build/es/index.d.mts +11 -29
- package/build/es/index.mjs +32 -2967
- package/build/es/index.mjs.map +1 -1
- package/build/es/index.typings.d.mts +2 -2
- package/build/es/index.typings.mjs +10 -2945
- package/build/es/index.typings.mjs.map +1 -1
- package/build/es/meta.d.mts +66 -51
- package/build/es/meta.mjs.map +1 -1
- package/build/es/schemas.d.mts +3 -3
- package/build/es/{table-reservations-v1-experience-experiences.universal-CHddGarE.d.mts → table-reservations-v1-experience-experiences.universal-DBg6eXpp.d.mts} +67 -52
- package/build/internal/cjs/index.d.ts +11 -29
- package/build/internal/cjs/index.js +32 -2977
- package/build/internal/cjs/index.js.map +1 -1
- package/build/internal/cjs/index.typings.d.ts +2 -2
- package/build/internal/cjs/index.typings.js +10 -2955
- package/build/internal/cjs/index.typings.js.map +1 -1
- package/build/internal/cjs/meta.d.ts +66 -51
- package/build/internal/cjs/meta.js.map +1 -1
- package/build/internal/cjs/schemas.d.ts +3 -3
- package/build/internal/cjs/{table-reservations-v1-experience-experiences.universal-CHddGarE.d.ts → table-reservations-v1-experience-experiences.universal-DBg6eXpp.d.ts} +67 -52
- package/build/internal/es/index.d.mts +11 -29
- package/build/internal/es/index.mjs +32 -2967
- package/build/internal/es/index.mjs.map +1 -1
- package/build/internal/es/index.typings.d.mts +2 -2
- package/build/internal/es/index.typings.mjs +10 -2945
- package/build/internal/es/index.typings.mjs.map +1 -1
- package/build/internal/es/meta.d.mts +66 -51
- package/build/internal/es/meta.mjs.map +1 -1
- package/build/internal/es/schemas.d.mts +3 -3
- package/build/internal/es/{table-reservations-v1-experience-experiences.universal-CHddGarE.d.mts → table-reservations-v1-experience-experiences.universal-DBg6eXpp.d.mts} +67 -52
- package/package.json +2 -2
|
@@ -1,9 +1,7 @@
|
|
|
1
1
|
"use strict";
|
|
2
|
-
var __create = Object.create;
|
|
3
2
|
var __defProp = Object.defineProperty;
|
|
4
3
|
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
|
|
5
4
|
var __getOwnPropNames = Object.getOwnPropertyNames;
|
|
6
|
-
var __getProtoOf = Object.getPrototypeOf;
|
|
7
5
|
var __hasOwnProp = Object.prototype.hasOwnProperty;
|
|
8
6
|
var __export = (target, all) => {
|
|
9
7
|
for (var name in all)
|
|
@@ -17,14 +15,6 @@ var __copyProps = (to, from, except, desc) => {
|
|
|
17
15
|
}
|
|
18
16
|
return to;
|
|
19
17
|
};
|
|
20
|
-
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
|
|
21
|
-
// If the importer is in node compatibility mode or this is not an ESM
|
|
22
|
-
// file that has been converted to a CommonJS file using a Babel-
|
|
23
|
-
// compatible transform (i.e. "__esModule" has not been set), then set
|
|
24
|
-
// "default" to the CommonJS "module.exports" for node compatibility.
|
|
25
|
-
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
|
|
26
|
-
mod
|
|
27
|
-
));
|
|
28
18
|
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
|
|
29
19
|
|
|
30
20
|
// index.typings.ts
|
|
@@ -1555,2911 +1545,6 @@ var import_image2 = require("@wix/sdk-runtime/transformations/image");
|
|
|
1555
1545
|
var import_page_url_v2 = require("@wix/sdk-runtime/transformations/page-url-v2");
|
|
1556
1546
|
var import_page_url_v22 = require("@wix/sdk-runtime/transformations/page-url-v2");
|
|
1557
1547
|
var import_transform_paths2 = require("@wix/sdk-runtime/transformations/transform-paths");
|
|
1558
|
-
|
|
1559
|
-
// src/table-reservations-v1-experience-experiences.schemas.ts
|
|
1560
|
-
var z = __toESM(require("zod"));
|
|
1561
|
-
var CreateExperienceRequest = z.object({
|
|
1562
|
-
experience: z.object({
|
|
1563
|
-
_id: z.string().describe("Experience ID.").regex(
|
|
1564
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1565
|
-
"Must be a valid GUID"
|
|
1566
|
-
).optional().nullable(),
|
|
1567
|
-
reservationLocationId: z.string().describe(
|
|
1568
|
-
"ID of the reservation location this experience is assigned to."
|
|
1569
|
-
).regex(
|
|
1570
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1571
|
-
"Must be a valid GUID"
|
|
1572
|
-
),
|
|
1573
|
-
revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
|
|
1574
|
-
"Revision number, which increments by 1 each time the experience is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the experience.\n\nIgnored when creating an experience."
|
|
1575
|
-
).optional().nullable(),
|
|
1576
|
-
_createdDate: z.date().describe("Date and time the experience was created.").optional().nullable(),
|
|
1577
|
-
_updatedDate: z.date().describe("Date and time the experience was last updated.").optional().nullable(),
|
|
1578
|
-
configuration: z.object({
|
|
1579
|
-
displayInfo: z.object({
|
|
1580
|
-
name: z.string().describe("Experience name.").min(1).max(120),
|
|
1581
|
-
shortDescription: z.string().describe("Brief description of the experience.").max(300).optional().nullable(),
|
|
1582
|
-
coverImage: z.string().describe("Cover image for the experience.").optional(),
|
|
1583
|
-
richContent: z.any().describe(
|
|
1584
|
-
"Detailed description of the experience using rich content formatting."
|
|
1585
|
-
).optional()
|
|
1586
|
-
}).describe("Display information for the experience."),
|
|
1587
|
-
paymentPolicy: z.intersection(
|
|
1588
|
-
z.object({ paymentPolicyType: z.enum(["PER_GUEST", "FREE"]) }),
|
|
1589
|
-
z.xor([
|
|
1590
|
-
z.object({ perGuestOptions: z.never().optional() }),
|
|
1591
|
-
z.object({
|
|
1592
|
-
perGuestOptions: z.object({
|
|
1593
|
-
price: z.string().describe(
|
|
1594
|
-
'Monetary amount to charge. Decimal string with a period as a decimal separator. For example, `"3.99"`.'
|
|
1595
|
-
).optional().nullable()
|
|
1596
|
-
}).describe("Per-guest pricing settings.")
|
|
1597
|
-
})
|
|
1598
|
-
])
|
|
1599
|
-
).describe(
|
|
1600
|
-
"Payment policy for the experience. This policy determines how the restaurant charges for reservations."
|
|
1601
|
-
),
|
|
1602
|
-
onlineReservations: z.object({
|
|
1603
|
-
partySize: z.object({
|
|
1604
|
-
min: z.number().int().describe(
|
|
1605
|
-
"Minimum number of guests allowed for a reservation."
|
|
1606
|
-
).min(1).max(1e4),
|
|
1607
|
-
max: z.number().int().describe(
|
|
1608
|
-
"Maximum number of guests allowed for a reservation."
|
|
1609
|
-
).min(1).max(1e4)
|
|
1610
|
-
}).describe("Party size."),
|
|
1611
|
-
minimumReservationNotice: z.object({
|
|
1612
|
-
number: z.number().int().describe(
|
|
1613
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
1614
|
-
).min(1).max(1e3),
|
|
1615
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"])
|
|
1616
|
-
}).describe("Minimum reservation notice.").optional(),
|
|
1617
|
-
maximumReservationNotice: z.object({
|
|
1618
|
-
number: z.number().int().describe(
|
|
1619
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
1620
|
-
).min(1).max(1e3),
|
|
1621
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"])
|
|
1622
|
-
}).describe("Maximum reservation notice.").optional(),
|
|
1623
|
-
approval: z.object({ mode: z.enum(["AUTOMATIC", "MANUAL"]) }).describe("Approval."),
|
|
1624
|
-
maxGuests: z.object({
|
|
1625
|
-
number: z.number().int().describe(
|
|
1626
|
-
"Maximum total number of guests that can have active reservations for this experience at the same time."
|
|
1627
|
-
).min(0).max(1e4)
|
|
1628
|
-
}).describe("Maximum number of guests.").optional(),
|
|
1629
|
-
businessSchedule: z.object({
|
|
1630
|
-
durationInMinutes: z.number().int().describe("Duration of the experience in minutes.").min(1).max(1440).optional().nullable(),
|
|
1631
|
-
entries: z.array(
|
|
1632
|
-
z.intersection(
|
|
1633
|
-
z.object({
|
|
1634
|
-
recurrence: z.enum(["WEEKLY", "ONE_TIME"]).optional()
|
|
1635
|
-
}),
|
|
1636
|
-
z.xor([
|
|
1637
|
-
z.object({
|
|
1638
|
-
weeklyOptions: z.never().optional(),
|
|
1639
|
-
oneTimeOptions: z.never().optional()
|
|
1640
|
-
}),
|
|
1641
|
-
z.object({
|
|
1642
|
-
oneTimeOptions: z.never().optional(),
|
|
1643
|
-
weeklyOptions: z.object({
|
|
1644
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
1645
|
-
endDate: z.string().describe("End date.").optional().nullable(),
|
|
1646
|
-
startDaysAndTimes: z.array(
|
|
1647
|
-
z.object({
|
|
1648
|
-
day: z.enum([
|
|
1649
|
-
"MONDAY",
|
|
1650
|
-
"TUESDAY",
|
|
1651
|
-
"WEDNESDAY",
|
|
1652
|
-
"THURSDAY",
|
|
1653
|
-
"FRIDAY",
|
|
1654
|
-
"SATURDAY",
|
|
1655
|
-
"SUNDAY"
|
|
1656
|
-
]).optional(),
|
|
1657
|
-
time: z.string().describe(
|
|
1658
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
1659
|
-
).max(5).min(5).optional().nullable()
|
|
1660
|
-
})
|
|
1661
|
-
).max(100).optional()
|
|
1662
|
-
}).describe("Weekly recurrence settings.")
|
|
1663
|
-
}),
|
|
1664
|
-
z.object({
|
|
1665
|
-
weeklyOptions: z.never().optional(),
|
|
1666
|
-
oneTimeOptions: z.object({
|
|
1667
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
1668
|
-
startTime: z.string().describe(
|
|
1669
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
1670
|
-
).max(5).min(5).optional().nullable()
|
|
1671
|
-
}).describe("1-time event settings.")
|
|
1672
|
-
})
|
|
1673
|
-
])
|
|
1674
|
-
)
|
|
1675
|
-
).max(10).optional()
|
|
1676
|
-
}).describe("Business schedule.").optional()
|
|
1677
|
-
}).describe(
|
|
1678
|
-
"Settings for this experience that are used to determine restaurant availability for reservations made online."
|
|
1679
|
-
),
|
|
1680
|
-
reservationForm: z.object({
|
|
1681
|
-
submitMessage: z.string().describe(
|
|
1682
|
-
"Message displayed to customers when they submit the reservation form."
|
|
1683
|
-
).max(1e6).optional().nullable(),
|
|
1684
|
-
policiesEnabled: z.boolean().describe(
|
|
1685
|
-
"Whether to display privacy policy and terms and conditions to customers."
|
|
1686
|
-
).optional().nullable(),
|
|
1687
|
-
privacyPolicy: z.intersection(
|
|
1688
|
-
z.object({
|
|
1689
|
-
enabled: z.boolean().describe(
|
|
1690
|
-
"Whether the privacy policy is displayed to customers.\n\nDefault: `false`"
|
|
1691
|
-
).optional().nullable()
|
|
1692
|
-
}),
|
|
1693
|
-
z.xor([
|
|
1694
|
-
z.object({
|
|
1695
|
-
url: z.never().optional(),
|
|
1696
|
-
text: z.never().optional()
|
|
1697
|
-
}),
|
|
1698
|
-
z.object({
|
|
1699
|
-
text: z.never().optional(),
|
|
1700
|
-
url: z.string().describe("Privacy policy URL.")
|
|
1701
|
-
}),
|
|
1702
|
-
z.object({
|
|
1703
|
-
url: z.never().optional(),
|
|
1704
|
-
text: z.string().describe("Privacy policy text.").max(1e6)
|
|
1705
|
-
})
|
|
1706
|
-
])
|
|
1707
|
-
).describe("Privacy policy display settings.").optional(),
|
|
1708
|
-
termsAndConditions: z.intersection(
|
|
1709
|
-
z.object({
|
|
1710
|
-
enabled: z.boolean().describe(
|
|
1711
|
-
"Whether the terms and conditions are displayed to customers.\n\nDefault: `false`"
|
|
1712
|
-
).optional().nullable()
|
|
1713
|
-
}),
|
|
1714
|
-
z.xor([
|
|
1715
|
-
z.object({
|
|
1716
|
-
url: z.never().optional(),
|
|
1717
|
-
text: z.never().optional()
|
|
1718
|
-
}),
|
|
1719
|
-
z.object({
|
|
1720
|
-
text: z.never().optional(),
|
|
1721
|
-
url: z.string().describe("Terms and conditions URL.")
|
|
1722
|
-
}),
|
|
1723
|
-
z.object({
|
|
1724
|
-
url: z.never().optional(),
|
|
1725
|
-
text: z.string().describe("Terms and conditions text.").max(1e6)
|
|
1726
|
-
})
|
|
1727
|
-
])
|
|
1728
|
-
).describe("Terms and conditions display settings.").optional(),
|
|
1729
|
-
customFieldDefinitions: z.array(
|
|
1730
|
-
z.object({
|
|
1731
|
-
_id: z.string().describe("Custom field ID.").regex(
|
|
1732
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1733
|
-
"Must be a valid GUID"
|
|
1734
|
-
).optional().nullable(),
|
|
1735
|
-
name: z.string().describe("Custom field name.").min(1).max(1e3).optional().nullable(),
|
|
1736
|
-
required: z.boolean().describe(
|
|
1737
|
-
"Whether the custom field is required.\n\nDefault: `false`"
|
|
1738
|
-
).optional().nullable()
|
|
1739
|
-
})
|
|
1740
|
-
).max(1e3).optional(),
|
|
1741
|
-
lastNameRequired: z.boolean().describe(
|
|
1742
|
-
"Whether a last name is required in the reservation form.\n\nDefault: `false`"
|
|
1743
|
-
).optional().nullable(),
|
|
1744
|
-
emailRequired: z.boolean().describe(
|
|
1745
|
-
"Whether an email is required in the reservation form.\n\nDefault: `false`"
|
|
1746
|
-
).optional().nullable(),
|
|
1747
|
-
emailMarketingCheckbox: z.object({
|
|
1748
|
-
enabled: z.boolean().describe(
|
|
1749
|
-
"Whether the email marketing checkbox is displayed to customers.\n\nDefault: `false`"
|
|
1750
|
-
).optional().nullable(),
|
|
1751
|
-
checkedByDefault: z.boolean().describe(
|
|
1752
|
-
"Whether the email marketing checkbox is checked by default.\n\nDefault: `false`"
|
|
1753
|
-
).optional().nullable()
|
|
1754
|
-
}).describe("Email marketing checkbox settings.").optional()
|
|
1755
|
-
}).describe(
|
|
1756
|
-
"Custom form fields and settings for the reservation booking form."
|
|
1757
|
-
).optional(),
|
|
1758
|
-
visible: z.boolean().describe("Whether the experience is visible on the live site.").optional().nullable()
|
|
1759
|
-
}).describe("Experience configuration."),
|
|
1760
|
-
currency: z.string().describe(
|
|
1761
|
-
"3-letter currency code in ISO-4217 alphabetic format. For exampled, `USD`."
|
|
1762
|
-
).optional().nullable(),
|
|
1763
|
-
extendedFields: z.object({
|
|
1764
|
-
namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
|
|
1765
|
-
"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
|
|
1766
|
-
).optional()
|
|
1767
|
-
}).describe("Extended fields.").optional(),
|
|
1768
|
-
tags: z.object({
|
|
1769
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
1770
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
1771
|
-
).optional(),
|
|
1772
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
1773
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
1774
|
-
).optional()
|
|
1775
|
-
}).describe(
|
|
1776
|
-
"Tags assigned to the experience. Tags must be created using the [Tags API](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) before they can be assigned."
|
|
1777
|
-
).optional(),
|
|
1778
|
-
slug: z.string().describe(
|
|
1779
|
-
'URL-friendly identifier for the experience page, derived from the experience display name in kebab-case format (e.g., "wine-tasting-event"). Used to create readable URLs for the experience page.'
|
|
1780
|
-
).max(300).optional().nullable(),
|
|
1781
|
-
seoSettings: z.object({
|
|
1782
|
-
seoSchema: z.object({
|
|
1783
|
-
tags: z.array(
|
|
1784
|
-
z.object({
|
|
1785
|
-
type: z.string().describe(
|
|
1786
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
1787
|
-
).optional(),
|
|
1788
|
-
props: z.record(z.string(), z.any()).describe(
|
|
1789
|
-
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
1790
|
-
).optional().nullable(),
|
|
1791
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
1792
|
-
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
1793
|
-
).optional().nullable(),
|
|
1794
|
-
children: z.string().describe(
|
|
1795
|
-
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
1796
|
-
).optional(),
|
|
1797
|
-
custom: z.boolean().describe(
|
|
1798
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
1799
|
-
).optional(),
|
|
1800
|
-
disabled: z.boolean().describe(
|
|
1801
|
-
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
1802
|
-
).optional()
|
|
1803
|
-
})
|
|
1804
|
-
).optional(),
|
|
1805
|
-
settings: z.object({
|
|
1806
|
-
preventAutoRedirect: z.boolean().describe(
|
|
1807
|
-
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
1808
|
-
).optional(),
|
|
1809
|
-
keywords: z.array(
|
|
1810
|
-
z.object({
|
|
1811
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
1812
|
-
isMain: z.boolean().describe(
|
|
1813
|
-
"Whether the keyword is the main focus keyword."
|
|
1814
|
-
).optional(),
|
|
1815
|
-
origin: z.string().describe(
|
|
1816
|
-
"The source that added the keyword terms to the SEO settings."
|
|
1817
|
-
).max(1e3).optional().nullable()
|
|
1818
|
-
})
|
|
1819
|
-
).max(5).optional()
|
|
1820
|
-
}).describe("SEO general settings.").optional()
|
|
1821
|
-
}).describe(
|
|
1822
|
-
"SEO schema data for customizing meta tags and search engine settings."
|
|
1823
|
-
).optional()
|
|
1824
|
-
}).describe("SEO settings for the experience page.").optional()
|
|
1825
|
-
}).describe("Experience to create.")
|
|
1826
|
-
});
|
|
1827
|
-
var CreateExperienceResponse = z.object({
|
|
1828
|
-
_id: z.string().describe("Experience ID.").regex(
|
|
1829
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1830
|
-
"Must be a valid GUID"
|
|
1831
|
-
).optional().nullable(),
|
|
1832
|
-
reservationLocationId: z.string().describe("ID of the reservation location this experience is assigned to.").regex(
|
|
1833
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1834
|
-
"Must be a valid GUID"
|
|
1835
|
-
).optional().nullable(),
|
|
1836
|
-
revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
|
|
1837
|
-
"Revision number, which increments by 1 each time the experience is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the experience.\n\nIgnored when creating an experience."
|
|
1838
|
-
).optional().nullable(),
|
|
1839
|
-
_createdDate: z.date().describe("Date and time the experience was created.").optional().nullable(),
|
|
1840
|
-
_updatedDate: z.date().describe("Date and time the experience was last updated.").optional().nullable(),
|
|
1841
|
-
configuration: z.object({
|
|
1842
|
-
displayInfo: z.object({
|
|
1843
|
-
name: z.string().describe("Experience name.").min(1).max(120).optional().nullable(),
|
|
1844
|
-
shortDescription: z.string().describe("Brief description of the experience.").max(300).optional().nullable(),
|
|
1845
|
-
coverImage: z.string().describe("Cover image for the experience.").optional(),
|
|
1846
|
-
richContent: z.any().describe(
|
|
1847
|
-
"Detailed description of the experience using rich content formatting."
|
|
1848
|
-
).optional()
|
|
1849
|
-
}).describe("Display information for the experience.").optional(),
|
|
1850
|
-
paymentPolicy: z.intersection(
|
|
1851
|
-
z.object({
|
|
1852
|
-
paymentPolicyType: z.enum(["PER_GUEST", "FREE"]).describe("Payment policy type for the experience.").optional()
|
|
1853
|
-
}),
|
|
1854
|
-
z.xor([
|
|
1855
|
-
z.object({ perGuestOptions: z.never().optional() }),
|
|
1856
|
-
z.object({
|
|
1857
|
-
perGuestOptions: z.object({
|
|
1858
|
-
price: z.string().describe(
|
|
1859
|
-
'Monetary amount to charge. Decimal string with a period as a decimal separator. For example, `"3.99"`.'
|
|
1860
|
-
).optional().nullable()
|
|
1861
|
-
}).describe("Per-guest pricing settings.")
|
|
1862
|
-
})
|
|
1863
|
-
])
|
|
1864
|
-
).describe(
|
|
1865
|
-
"Payment policy for the experience. This policy determines how the restaurant charges for reservations."
|
|
1866
|
-
).optional(),
|
|
1867
|
-
onlineReservations: z.object({
|
|
1868
|
-
partySize: z.object({
|
|
1869
|
-
min: z.number().int().describe("Minimum number of guests allowed for a reservation.").min(1).max(1e4).optional().nullable(),
|
|
1870
|
-
max: z.number().int().describe("Maximum number of guests allowed for a reservation.").min(1).max(1e4).optional().nullable()
|
|
1871
|
-
}).describe("Party size.").optional(),
|
|
1872
|
-
minimumReservationNotice: z.object({
|
|
1873
|
-
number: z.number().int().describe(
|
|
1874
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
1875
|
-
).min(1).max(1e3).optional().nullable(),
|
|
1876
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
1877
|
-
}).describe("Minimum reservation notice.").optional(),
|
|
1878
|
-
maximumReservationNotice: z.object({
|
|
1879
|
-
number: z.number().int().describe(
|
|
1880
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
1881
|
-
).min(1).max(1e3).optional().nullable(),
|
|
1882
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
1883
|
-
}).describe("Maximum reservation notice.").optional(),
|
|
1884
|
-
approval: z.object({
|
|
1885
|
-
mode: z.enum(["AUTOMATIC", "MANUAL"]).describe("Approval mode.").optional()
|
|
1886
|
-
}).describe("Approval.").optional(),
|
|
1887
|
-
maxGuests: z.object({
|
|
1888
|
-
number: z.number().int().describe(
|
|
1889
|
-
"Maximum total number of guests that can have active reservations for this experience at the same time."
|
|
1890
|
-
).min(0).max(1e4).optional().nullable()
|
|
1891
|
-
}).describe("Maximum number of guests.").optional(),
|
|
1892
|
-
businessSchedule: z.object({
|
|
1893
|
-
durationInMinutes: z.number().int().describe("Duration of the experience in minutes.").min(1).max(1440).optional().nullable(),
|
|
1894
|
-
entries: z.array(
|
|
1895
|
-
z.intersection(
|
|
1896
|
-
z.object({
|
|
1897
|
-
recurrence: z.enum(["WEEKLY", "ONE_TIME"]).describe("Recurrence settings for this entry.").optional()
|
|
1898
|
-
}),
|
|
1899
|
-
z.xor([
|
|
1900
|
-
z.object({
|
|
1901
|
-
weeklyOptions: z.never().optional(),
|
|
1902
|
-
oneTimeOptions: z.never().optional()
|
|
1903
|
-
}),
|
|
1904
|
-
z.object({
|
|
1905
|
-
oneTimeOptions: z.never().optional(),
|
|
1906
|
-
weeklyOptions: z.object({
|
|
1907
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
1908
|
-
endDate: z.string().describe("End date.").optional().nullable(),
|
|
1909
|
-
startDaysAndTimes: z.array(
|
|
1910
|
-
z.object({
|
|
1911
|
-
day: z.enum([
|
|
1912
|
-
"MONDAY",
|
|
1913
|
-
"TUESDAY",
|
|
1914
|
-
"WEDNESDAY",
|
|
1915
|
-
"THURSDAY",
|
|
1916
|
-
"FRIDAY",
|
|
1917
|
-
"SATURDAY",
|
|
1918
|
-
"SUNDAY"
|
|
1919
|
-
]).describe("Day of week.").optional(),
|
|
1920
|
-
time: z.string().describe(
|
|
1921
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
1922
|
-
).max(5).min(5).optional().nullable()
|
|
1923
|
-
})
|
|
1924
|
-
).max(100).optional()
|
|
1925
|
-
}).describe("Weekly recurrence settings.")
|
|
1926
|
-
}),
|
|
1927
|
-
z.object({
|
|
1928
|
-
weeklyOptions: z.never().optional(),
|
|
1929
|
-
oneTimeOptions: z.object({
|
|
1930
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
1931
|
-
startTime: z.string().describe(
|
|
1932
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
1933
|
-
).max(5).min(5).optional().nullable()
|
|
1934
|
-
}).describe("1-time event settings.")
|
|
1935
|
-
})
|
|
1936
|
-
])
|
|
1937
|
-
)
|
|
1938
|
-
).max(10).optional()
|
|
1939
|
-
}).describe("Business schedule.").optional()
|
|
1940
|
-
}).describe(
|
|
1941
|
-
"Settings for this experience that are used to determine restaurant availability for reservations made online."
|
|
1942
|
-
).optional(),
|
|
1943
|
-
reservationForm: z.object({
|
|
1944
|
-
submitMessage: z.string().describe(
|
|
1945
|
-
"Message displayed to customers when they submit the reservation form."
|
|
1946
|
-
).max(1e6).optional().nullable(),
|
|
1947
|
-
policiesEnabled: z.boolean().describe(
|
|
1948
|
-
"Whether to display privacy policy and terms and conditions to customers."
|
|
1949
|
-
).optional().nullable(),
|
|
1950
|
-
privacyPolicy: z.intersection(
|
|
1951
|
-
z.object({
|
|
1952
|
-
enabled: z.boolean().describe(
|
|
1953
|
-
"Whether the privacy policy is displayed to customers.\n\nDefault: `false`"
|
|
1954
|
-
).optional().nullable()
|
|
1955
|
-
}),
|
|
1956
|
-
z.xor([
|
|
1957
|
-
z.object({
|
|
1958
|
-
url: z.never().optional(),
|
|
1959
|
-
text: z.never().optional()
|
|
1960
|
-
}),
|
|
1961
|
-
z.object({
|
|
1962
|
-
text: z.never().optional(),
|
|
1963
|
-
url: z.string().describe("Privacy policy URL.")
|
|
1964
|
-
}),
|
|
1965
|
-
z.object({
|
|
1966
|
-
url: z.never().optional(),
|
|
1967
|
-
text: z.string().describe("Privacy policy text.").max(1e6)
|
|
1968
|
-
})
|
|
1969
|
-
])
|
|
1970
|
-
).describe("Privacy policy display settings.").optional(),
|
|
1971
|
-
termsAndConditions: z.intersection(
|
|
1972
|
-
z.object({
|
|
1973
|
-
enabled: z.boolean().describe(
|
|
1974
|
-
"Whether the terms and conditions are displayed to customers.\n\nDefault: `false`"
|
|
1975
|
-
).optional().nullable()
|
|
1976
|
-
}),
|
|
1977
|
-
z.xor([
|
|
1978
|
-
z.object({
|
|
1979
|
-
url: z.never().optional(),
|
|
1980
|
-
text: z.never().optional()
|
|
1981
|
-
}),
|
|
1982
|
-
z.object({
|
|
1983
|
-
text: z.never().optional(),
|
|
1984
|
-
url: z.string().describe("Terms and conditions URL.")
|
|
1985
|
-
}),
|
|
1986
|
-
z.object({
|
|
1987
|
-
url: z.never().optional(),
|
|
1988
|
-
text: z.string().describe("Terms and conditions text.").max(1e6)
|
|
1989
|
-
})
|
|
1990
|
-
])
|
|
1991
|
-
).describe("Terms and conditions display settings.").optional(),
|
|
1992
|
-
customFieldDefinitions: z.array(
|
|
1993
|
-
z.object({
|
|
1994
|
-
_id: z.string().describe("Custom field ID.").regex(
|
|
1995
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
1996
|
-
"Must be a valid GUID"
|
|
1997
|
-
).optional().nullable(),
|
|
1998
|
-
name: z.string().describe("Custom field name.").min(1).max(1e3).optional().nullable(),
|
|
1999
|
-
required: z.boolean().describe(
|
|
2000
|
-
"Whether the custom field is required.\n\nDefault: `false`"
|
|
2001
|
-
).optional().nullable()
|
|
2002
|
-
})
|
|
2003
|
-
).max(1e3).optional(),
|
|
2004
|
-
lastNameRequired: z.boolean().describe(
|
|
2005
|
-
"Whether a last name is required in the reservation form.\n\nDefault: `false`"
|
|
2006
|
-
).optional().nullable(),
|
|
2007
|
-
emailRequired: z.boolean().describe(
|
|
2008
|
-
"Whether an email is required in the reservation form.\n\nDefault: `false`"
|
|
2009
|
-
).optional().nullable(),
|
|
2010
|
-
emailMarketingCheckbox: z.object({
|
|
2011
|
-
enabled: z.boolean().describe(
|
|
2012
|
-
"Whether the email marketing checkbox is displayed to customers.\n\nDefault: `false`"
|
|
2013
|
-
).optional().nullable(),
|
|
2014
|
-
checkedByDefault: z.boolean().describe(
|
|
2015
|
-
"Whether the email marketing checkbox is checked by default.\n\nDefault: `false`"
|
|
2016
|
-
).optional().nullable()
|
|
2017
|
-
}).describe("Email marketing checkbox settings.").optional()
|
|
2018
|
-
}).describe(
|
|
2019
|
-
"Custom form fields and settings for the reservation booking form."
|
|
2020
|
-
).optional(),
|
|
2021
|
-
visible: z.boolean().describe("Whether the experience is visible on the live site.").optional().nullable()
|
|
2022
|
-
}).describe("Experience configuration.").optional(),
|
|
2023
|
-
currency: z.string().describe(
|
|
2024
|
-
"3-letter currency code in ISO-4217 alphabetic format. For exampled, `USD`."
|
|
2025
|
-
).optional().nullable(),
|
|
2026
|
-
extendedFields: z.object({
|
|
2027
|
-
namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
|
|
2028
|
-
"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
|
|
2029
|
-
).optional()
|
|
2030
|
-
}).describe("Extended fields.").optional(),
|
|
2031
|
-
tags: z.object({
|
|
2032
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
2033
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
2034
|
-
).optional(),
|
|
2035
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
2036
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
2037
|
-
).optional()
|
|
2038
|
-
}).describe(
|
|
2039
|
-
"Tags assigned to the experience. Tags must be created using the [Tags API](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) before they can be assigned."
|
|
2040
|
-
).optional(),
|
|
2041
|
-
slug: z.string().describe(
|
|
2042
|
-
'URL-friendly identifier for the experience page, derived from the experience display name in kebab-case format (e.g., "wine-tasting-event"). Used to create readable URLs for the experience page.'
|
|
2043
|
-
).max(300).optional().nullable(),
|
|
2044
|
-
seoSettings: z.object({
|
|
2045
|
-
seoSchema: z.object({
|
|
2046
|
-
tags: z.array(
|
|
2047
|
-
z.object({
|
|
2048
|
-
type: z.string().describe(
|
|
2049
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
2050
|
-
).optional(),
|
|
2051
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2052
|
-
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
2053
|
-
).optional().nullable(),
|
|
2054
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2055
|
-
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2056
|
-
).optional().nullable(),
|
|
2057
|
-
children: z.string().describe(
|
|
2058
|
-
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2059
|
-
).optional(),
|
|
2060
|
-
custom: z.boolean().describe(
|
|
2061
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
2062
|
-
).optional(),
|
|
2063
|
-
disabled: z.boolean().describe(
|
|
2064
|
-
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2065
|
-
).optional()
|
|
2066
|
-
})
|
|
2067
|
-
).optional(),
|
|
2068
|
-
settings: z.object({
|
|
2069
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2070
|
-
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
2071
|
-
).optional(),
|
|
2072
|
-
keywords: z.array(
|
|
2073
|
-
z.object({
|
|
2074
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2075
|
-
isMain: z.boolean().describe(
|
|
2076
|
-
"Whether the keyword is the main focus keyword."
|
|
2077
|
-
).optional(),
|
|
2078
|
-
origin: z.string().describe(
|
|
2079
|
-
"The source that added the keyword terms to the SEO settings."
|
|
2080
|
-
).max(1e3).optional().nullable()
|
|
2081
|
-
})
|
|
2082
|
-
).max(5).optional()
|
|
2083
|
-
}).describe("SEO general settings.").optional()
|
|
2084
|
-
}).describe(
|
|
2085
|
-
"SEO schema data for customizing meta tags and search engine settings."
|
|
2086
|
-
).optional()
|
|
2087
|
-
}).describe("SEO settings for the experience page.").optional()
|
|
2088
|
-
});
|
|
2089
|
-
var GetExperienceRequest = z.object({
|
|
2090
|
-
experienceId: z.string().describe("ID of the experience to retrieve.").regex(
|
|
2091
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2092
|
-
"Must be a valid GUID"
|
|
2093
|
-
)
|
|
2094
|
-
});
|
|
2095
|
-
var GetExperienceResponse = z.object({
|
|
2096
|
-
_id: z.string().describe("Experience ID.").regex(
|
|
2097
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2098
|
-
"Must be a valid GUID"
|
|
2099
|
-
).optional().nullable(),
|
|
2100
|
-
reservationLocationId: z.string().describe("ID of the reservation location this experience is assigned to.").regex(
|
|
2101
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2102
|
-
"Must be a valid GUID"
|
|
2103
|
-
).optional().nullable(),
|
|
2104
|
-
revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
|
|
2105
|
-
"Revision number, which increments by 1 each time the experience is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the experience.\n\nIgnored when creating an experience."
|
|
2106
|
-
).optional().nullable(),
|
|
2107
|
-
_createdDate: z.date().describe("Date and time the experience was created.").optional().nullable(),
|
|
2108
|
-
_updatedDate: z.date().describe("Date and time the experience was last updated.").optional().nullable(),
|
|
2109
|
-
configuration: z.object({
|
|
2110
|
-
displayInfo: z.object({
|
|
2111
|
-
name: z.string().describe("Experience name.").min(1).max(120).optional().nullable(),
|
|
2112
|
-
shortDescription: z.string().describe("Brief description of the experience.").max(300).optional().nullable(),
|
|
2113
|
-
coverImage: z.string().describe("Cover image for the experience.").optional(),
|
|
2114
|
-
richContent: z.any().describe(
|
|
2115
|
-
"Detailed description of the experience using rich content formatting."
|
|
2116
|
-
).optional()
|
|
2117
|
-
}).describe("Display information for the experience.").optional(),
|
|
2118
|
-
paymentPolicy: z.intersection(
|
|
2119
|
-
z.object({
|
|
2120
|
-
paymentPolicyType: z.enum(["PER_GUEST", "FREE"]).describe("Payment policy type for the experience.").optional()
|
|
2121
|
-
}),
|
|
2122
|
-
z.xor([
|
|
2123
|
-
z.object({ perGuestOptions: z.never().optional() }),
|
|
2124
|
-
z.object({
|
|
2125
|
-
perGuestOptions: z.object({
|
|
2126
|
-
price: z.string().describe(
|
|
2127
|
-
'Monetary amount to charge. Decimal string with a period as a decimal separator. For example, `"3.99"`.'
|
|
2128
|
-
).optional().nullable()
|
|
2129
|
-
}).describe("Per-guest pricing settings.")
|
|
2130
|
-
})
|
|
2131
|
-
])
|
|
2132
|
-
).describe(
|
|
2133
|
-
"Payment policy for the experience. This policy determines how the restaurant charges for reservations."
|
|
2134
|
-
).optional(),
|
|
2135
|
-
onlineReservations: z.object({
|
|
2136
|
-
partySize: z.object({
|
|
2137
|
-
min: z.number().int().describe("Minimum number of guests allowed for a reservation.").min(1).max(1e4).optional().nullable(),
|
|
2138
|
-
max: z.number().int().describe("Maximum number of guests allowed for a reservation.").min(1).max(1e4).optional().nullable()
|
|
2139
|
-
}).describe("Party size.").optional(),
|
|
2140
|
-
minimumReservationNotice: z.object({
|
|
2141
|
-
number: z.number().int().describe(
|
|
2142
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
2143
|
-
).min(1).max(1e3).optional().nullable(),
|
|
2144
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
2145
|
-
}).describe("Minimum reservation notice.").optional(),
|
|
2146
|
-
maximumReservationNotice: z.object({
|
|
2147
|
-
number: z.number().int().describe(
|
|
2148
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
2149
|
-
).min(1).max(1e3).optional().nullable(),
|
|
2150
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
2151
|
-
}).describe("Maximum reservation notice.").optional(),
|
|
2152
|
-
approval: z.object({
|
|
2153
|
-
mode: z.enum(["AUTOMATIC", "MANUAL"]).describe("Approval mode.").optional()
|
|
2154
|
-
}).describe("Approval.").optional(),
|
|
2155
|
-
maxGuests: z.object({
|
|
2156
|
-
number: z.number().int().describe(
|
|
2157
|
-
"Maximum total number of guests that can have active reservations for this experience at the same time."
|
|
2158
|
-
).min(0).max(1e4).optional().nullable()
|
|
2159
|
-
}).describe("Maximum number of guests.").optional(),
|
|
2160
|
-
businessSchedule: z.object({
|
|
2161
|
-
durationInMinutes: z.number().int().describe("Duration of the experience in minutes.").min(1).max(1440).optional().nullable(),
|
|
2162
|
-
entries: z.array(
|
|
2163
|
-
z.intersection(
|
|
2164
|
-
z.object({
|
|
2165
|
-
recurrence: z.enum(["WEEKLY", "ONE_TIME"]).describe("Recurrence settings for this entry.").optional()
|
|
2166
|
-
}),
|
|
2167
|
-
z.xor([
|
|
2168
|
-
z.object({
|
|
2169
|
-
weeklyOptions: z.never().optional(),
|
|
2170
|
-
oneTimeOptions: z.never().optional()
|
|
2171
|
-
}),
|
|
2172
|
-
z.object({
|
|
2173
|
-
oneTimeOptions: z.never().optional(),
|
|
2174
|
-
weeklyOptions: z.object({
|
|
2175
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
2176
|
-
endDate: z.string().describe("End date.").optional().nullable(),
|
|
2177
|
-
startDaysAndTimes: z.array(
|
|
2178
|
-
z.object({
|
|
2179
|
-
day: z.enum([
|
|
2180
|
-
"MONDAY",
|
|
2181
|
-
"TUESDAY",
|
|
2182
|
-
"WEDNESDAY",
|
|
2183
|
-
"THURSDAY",
|
|
2184
|
-
"FRIDAY",
|
|
2185
|
-
"SATURDAY",
|
|
2186
|
-
"SUNDAY"
|
|
2187
|
-
]).describe("Day of week.").optional(),
|
|
2188
|
-
time: z.string().describe(
|
|
2189
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
2190
|
-
).max(5).min(5).optional().nullable()
|
|
2191
|
-
})
|
|
2192
|
-
).max(100).optional()
|
|
2193
|
-
}).describe("Weekly recurrence settings.")
|
|
2194
|
-
}),
|
|
2195
|
-
z.object({
|
|
2196
|
-
weeklyOptions: z.never().optional(),
|
|
2197
|
-
oneTimeOptions: z.object({
|
|
2198
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
2199
|
-
startTime: z.string().describe(
|
|
2200
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
2201
|
-
).max(5).min(5).optional().nullable()
|
|
2202
|
-
}).describe("1-time event settings.")
|
|
2203
|
-
})
|
|
2204
|
-
])
|
|
2205
|
-
)
|
|
2206
|
-
).max(10).optional()
|
|
2207
|
-
}).describe("Business schedule.").optional()
|
|
2208
|
-
}).describe(
|
|
2209
|
-
"Settings for this experience that are used to determine restaurant availability for reservations made online."
|
|
2210
|
-
).optional(),
|
|
2211
|
-
reservationForm: z.object({
|
|
2212
|
-
submitMessage: z.string().describe(
|
|
2213
|
-
"Message displayed to customers when they submit the reservation form."
|
|
2214
|
-
).max(1e6).optional().nullable(),
|
|
2215
|
-
policiesEnabled: z.boolean().describe(
|
|
2216
|
-
"Whether to display privacy policy and terms and conditions to customers."
|
|
2217
|
-
).optional().nullable(),
|
|
2218
|
-
privacyPolicy: z.intersection(
|
|
2219
|
-
z.object({
|
|
2220
|
-
enabled: z.boolean().describe(
|
|
2221
|
-
"Whether the privacy policy is displayed to customers.\n\nDefault: `false`"
|
|
2222
|
-
).optional().nullable()
|
|
2223
|
-
}),
|
|
2224
|
-
z.xor([
|
|
2225
|
-
z.object({
|
|
2226
|
-
url: z.never().optional(),
|
|
2227
|
-
text: z.never().optional()
|
|
2228
|
-
}),
|
|
2229
|
-
z.object({
|
|
2230
|
-
text: z.never().optional(),
|
|
2231
|
-
url: z.string().describe("Privacy policy URL.")
|
|
2232
|
-
}),
|
|
2233
|
-
z.object({
|
|
2234
|
-
url: z.never().optional(),
|
|
2235
|
-
text: z.string().describe("Privacy policy text.").max(1e6)
|
|
2236
|
-
})
|
|
2237
|
-
])
|
|
2238
|
-
).describe("Privacy policy display settings.").optional(),
|
|
2239
|
-
termsAndConditions: z.intersection(
|
|
2240
|
-
z.object({
|
|
2241
|
-
enabled: z.boolean().describe(
|
|
2242
|
-
"Whether the terms and conditions are displayed to customers.\n\nDefault: `false`"
|
|
2243
|
-
).optional().nullable()
|
|
2244
|
-
}),
|
|
2245
|
-
z.xor([
|
|
2246
|
-
z.object({
|
|
2247
|
-
url: z.never().optional(),
|
|
2248
|
-
text: z.never().optional()
|
|
2249
|
-
}),
|
|
2250
|
-
z.object({
|
|
2251
|
-
text: z.never().optional(),
|
|
2252
|
-
url: z.string().describe("Terms and conditions URL.")
|
|
2253
|
-
}),
|
|
2254
|
-
z.object({
|
|
2255
|
-
url: z.never().optional(),
|
|
2256
|
-
text: z.string().describe("Terms and conditions text.").max(1e6)
|
|
2257
|
-
})
|
|
2258
|
-
])
|
|
2259
|
-
).describe("Terms and conditions display settings.").optional(),
|
|
2260
|
-
customFieldDefinitions: z.array(
|
|
2261
|
-
z.object({
|
|
2262
|
-
_id: z.string().describe("Custom field ID.").regex(
|
|
2263
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2264
|
-
"Must be a valid GUID"
|
|
2265
|
-
).optional().nullable(),
|
|
2266
|
-
name: z.string().describe("Custom field name.").min(1).max(1e3).optional().nullable(),
|
|
2267
|
-
required: z.boolean().describe(
|
|
2268
|
-
"Whether the custom field is required.\n\nDefault: `false`"
|
|
2269
|
-
).optional().nullable()
|
|
2270
|
-
})
|
|
2271
|
-
).max(1e3).optional(),
|
|
2272
|
-
lastNameRequired: z.boolean().describe(
|
|
2273
|
-
"Whether a last name is required in the reservation form.\n\nDefault: `false`"
|
|
2274
|
-
).optional().nullable(),
|
|
2275
|
-
emailRequired: z.boolean().describe(
|
|
2276
|
-
"Whether an email is required in the reservation form.\n\nDefault: `false`"
|
|
2277
|
-
).optional().nullable(),
|
|
2278
|
-
emailMarketingCheckbox: z.object({
|
|
2279
|
-
enabled: z.boolean().describe(
|
|
2280
|
-
"Whether the email marketing checkbox is displayed to customers.\n\nDefault: `false`"
|
|
2281
|
-
).optional().nullable(),
|
|
2282
|
-
checkedByDefault: z.boolean().describe(
|
|
2283
|
-
"Whether the email marketing checkbox is checked by default.\n\nDefault: `false`"
|
|
2284
|
-
).optional().nullable()
|
|
2285
|
-
}).describe("Email marketing checkbox settings.").optional()
|
|
2286
|
-
}).describe(
|
|
2287
|
-
"Custom form fields and settings for the reservation booking form."
|
|
2288
|
-
).optional(),
|
|
2289
|
-
visible: z.boolean().describe("Whether the experience is visible on the live site.").optional().nullable()
|
|
2290
|
-
}).describe("Experience configuration.").optional(),
|
|
2291
|
-
currency: z.string().describe(
|
|
2292
|
-
"3-letter currency code in ISO-4217 alphabetic format. For exampled, `USD`."
|
|
2293
|
-
).optional().nullable(),
|
|
2294
|
-
extendedFields: z.object({
|
|
2295
|
-
namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
|
|
2296
|
-
"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
|
|
2297
|
-
).optional()
|
|
2298
|
-
}).describe("Extended fields.").optional(),
|
|
2299
|
-
tags: z.object({
|
|
2300
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
2301
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
2302
|
-
).optional(),
|
|
2303
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
2304
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
2305
|
-
).optional()
|
|
2306
|
-
}).describe(
|
|
2307
|
-
"Tags assigned to the experience. Tags must be created using the [Tags API](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) before they can be assigned."
|
|
2308
|
-
).optional(),
|
|
2309
|
-
slug: z.string().describe(
|
|
2310
|
-
'URL-friendly identifier for the experience page, derived from the experience display name in kebab-case format (e.g., "wine-tasting-event"). Used to create readable URLs for the experience page.'
|
|
2311
|
-
).max(300).optional().nullable(),
|
|
2312
|
-
seoSettings: z.object({
|
|
2313
|
-
seoSchema: z.object({
|
|
2314
|
-
tags: z.array(
|
|
2315
|
-
z.object({
|
|
2316
|
-
type: z.string().describe(
|
|
2317
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
2318
|
-
).optional(),
|
|
2319
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2320
|
-
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
2321
|
-
).optional().nullable(),
|
|
2322
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2323
|
-
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2324
|
-
).optional().nullable(),
|
|
2325
|
-
children: z.string().describe(
|
|
2326
|
-
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2327
|
-
).optional(),
|
|
2328
|
-
custom: z.boolean().describe(
|
|
2329
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
2330
|
-
).optional(),
|
|
2331
|
-
disabled: z.boolean().describe(
|
|
2332
|
-
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2333
|
-
).optional()
|
|
2334
|
-
})
|
|
2335
|
-
).optional(),
|
|
2336
|
-
settings: z.object({
|
|
2337
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2338
|
-
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
2339
|
-
).optional(),
|
|
2340
|
-
keywords: z.array(
|
|
2341
|
-
z.object({
|
|
2342
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2343
|
-
isMain: z.boolean().describe(
|
|
2344
|
-
"Whether the keyword is the main focus keyword."
|
|
2345
|
-
).optional(),
|
|
2346
|
-
origin: z.string().describe(
|
|
2347
|
-
"The source that added the keyword terms to the SEO settings."
|
|
2348
|
-
).max(1e3).optional().nullable()
|
|
2349
|
-
})
|
|
2350
|
-
).max(5).optional()
|
|
2351
|
-
}).describe("SEO general settings.").optional()
|
|
2352
|
-
}).describe(
|
|
2353
|
-
"SEO schema data for customizing meta tags and search engine settings."
|
|
2354
|
-
).optional()
|
|
2355
|
-
}).describe("SEO settings for the experience page.").optional()
|
|
2356
|
-
});
|
|
2357
|
-
var GetExperienceBySlugRequest = z.object({
|
|
2358
|
-
slug: z.string().describe("Slug of the experience to retrieve.").max(200)
|
|
2359
|
-
});
|
|
2360
|
-
var GetExperienceBySlugResponse = z.object({
|
|
2361
|
-
experience: z.object({
|
|
2362
|
-
_id: z.string().describe("Experience ID.").regex(
|
|
2363
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2364
|
-
"Must be a valid GUID"
|
|
2365
|
-
).optional().nullable(),
|
|
2366
|
-
reservationLocationId: z.string().describe(
|
|
2367
|
-
"ID of the reservation location this experience is assigned to."
|
|
2368
|
-
).regex(
|
|
2369
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2370
|
-
"Must be a valid GUID"
|
|
2371
|
-
).optional().nullable(),
|
|
2372
|
-
revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
|
|
2373
|
-
"Revision number, which increments by 1 each time the experience is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the experience.\n\nIgnored when creating an experience."
|
|
2374
|
-
).optional().nullable(),
|
|
2375
|
-
_createdDate: z.date().describe("Date and time the experience was created.").optional().nullable(),
|
|
2376
|
-
_updatedDate: z.date().describe("Date and time the experience was last updated.").optional().nullable(),
|
|
2377
|
-
configuration: z.object({
|
|
2378
|
-
displayInfo: z.object({
|
|
2379
|
-
name: z.string().describe("Experience name.").min(1).max(120).optional().nullable(),
|
|
2380
|
-
shortDescription: z.string().describe("Brief description of the experience.").max(300).optional().nullable(),
|
|
2381
|
-
coverImage: z.string().describe("Cover image for the experience.").optional(),
|
|
2382
|
-
richContent: z.any().describe(
|
|
2383
|
-
"Detailed description of the experience using rich content formatting."
|
|
2384
|
-
).optional()
|
|
2385
|
-
}).describe("Display information for the experience.").optional(),
|
|
2386
|
-
paymentPolicy: z.intersection(
|
|
2387
|
-
z.object({
|
|
2388
|
-
paymentPolicyType: z.enum(["PER_GUEST", "FREE"]).describe("Payment policy type for the experience.").optional()
|
|
2389
|
-
}),
|
|
2390
|
-
z.xor([
|
|
2391
|
-
z.object({ perGuestOptions: z.never().optional() }),
|
|
2392
|
-
z.object({
|
|
2393
|
-
perGuestOptions: z.object({
|
|
2394
|
-
price: z.string().describe(
|
|
2395
|
-
'Monetary amount to charge. Decimal string with a period as a decimal separator. For example, `"3.99"`.'
|
|
2396
|
-
).optional().nullable()
|
|
2397
|
-
}).describe("Per-guest pricing settings.")
|
|
2398
|
-
})
|
|
2399
|
-
])
|
|
2400
|
-
).describe(
|
|
2401
|
-
"Payment policy for the experience. This policy determines how the restaurant charges for reservations."
|
|
2402
|
-
).optional(),
|
|
2403
|
-
onlineReservations: z.object({
|
|
2404
|
-
partySize: z.object({
|
|
2405
|
-
min: z.number().int().describe(
|
|
2406
|
-
"Minimum number of guests allowed for a reservation."
|
|
2407
|
-
).min(1).max(1e4).optional().nullable(),
|
|
2408
|
-
max: z.number().int().describe(
|
|
2409
|
-
"Maximum number of guests allowed for a reservation."
|
|
2410
|
-
).min(1).max(1e4).optional().nullable()
|
|
2411
|
-
}).describe("Party size.").optional(),
|
|
2412
|
-
minimumReservationNotice: z.object({
|
|
2413
|
-
number: z.number().int().describe(
|
|
2414
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
2415
|
-
).min(1).max(1e3).optional().nullable(),
|
|
2416
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
2417
|
-
}).describe("Minimum reservation notice.").optional(),
|
|
2418
|
-
maximumReservationNotice: z.object({
|
|
2419
|
-
number: z.number().int().describe(
|
|
2420
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
2421
|
-
).min(1).max(1e3).optional().nullable(),
|
|
2422
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
2423
|
-
}).describe("Maximum reservation notice.").optional(),
|
|
2424
|
-
approval: z.object({
|
|
2425
|
-
mode: z.enum(["AUTOMATIC", "MANUAL"]).describe("Approval mode.").optional()
|
|
2426
|
-
}).describe("Approval.").optional(),
|
|
2427
|
-
maxGuests: z.object({
|
|
2428
|
-
number: z.number().int().describe(
|
|
2429
|
-
"Maximum total number of guests that can have active reservations for this experience at the same time."
|
|
2430
|
-
).min(0).max(1e4).optional().nullable()
|
|
2431
|
-
}).describe("Maximum number of guests.").optional(),
|
|
2432
|
-
businessSchedule: z.object({
|
|
2433
|
-
durationInMinutes: z.number().int().describe("Duration of the experience in minutes.").min(1).max(1440).optional().nullable(),
|
|
2434
|
-
entries: z.array(
|
|
2435
|
-
z.intersection(
|
|
2436
|
-
z.object({
|
|
2437
|
-
recurrence: z.enum(["WEEKLY", "ONE_TIME"]).describe("Recurrence settings for this entry.").optional()
|
|
2438
|
-
}),
|
|
2439
|
-
z.xor([
|
|
2440
|
-
z.object({
|
|
2441
|
-
weeklyOptions: z.never().optional(),
|
|
2442
|
-
oneTimeOptions: z.never().optional()
|
|
2443
|
-
}),
|
|
2444
|
-
z.object({
|
|
2445
|
-
oneTimeOptions: z.never().optional(),
|
|
2446
|
-
weeklyOptions: z.object({
|
|
2447
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
2448
|
-
endDate: z.string().describe("End date.").optional().nullable(),
|
|
2449
|
-
startDaysAndTimes: z.array(
|
|
2450
|
-
z.object({
|
|
2451
|
-
day: z.enum([
|
|
2452
|
-
"MONDAY",
|
|
2453
|
-
"TUESDAY",
|
|
2454
|
-
"WEDNESDAY",
|
|
2455
|
-
"THURSDAY",
|
|
2456
|
-
"FRIDAY",
|
|
2457
|
-
"SATURDAY",
|
|
2458
|
-
"SUNDAY"
|
|
2459
|
-
]).describe("Day of week.").optional(),
|
|
2460
|
-
time: z.string().describe(
|
|
2461
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
2462
|
-
).max(5).min(5).optional().nullable()
|
|
2463
|
-
})
|
|
2464
|
-
).max(100).optional()
|
|
2465
|
-
}).describe("Weekly recurrence settings.")
|
|
2466
|
-
}),
|
|
2467
|
-
z.object({
|
|
2468
|
-
weeklyOptions: z.never().optional(),
|
|
2469
|
-
oneTimeOptions: z.object({
|
|
2470
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
2471
|
-
startTime: z.string().describe(
|
|
2472
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
2473
|
-
).max(5).min(5).optional().nullable()
|
|
2474
|
-
}).describe("1-time event settings.")
|
|
2475
|
-
})
|
|
2476
|
-
])
|
|
2477
|
-
)
|
|
2478
|
-
).max(10).optional()
|
|
2479
|
-
}).describe("Business schedule.").optional()
|
|
2480
|
-
}).describe(
|
|
2481
|
-
"Settings for this experience that are used to determine restaurant availability for reservations made online."
|
|
2482
|
-
).optional(),
|
|
2483
|
-
reservationForm: z.object({
|
|
2484
|
-
submitMessage: z.string().describe(
|
|
2485
|
-
"Message displayed to customers when they submit the reservation form."
|
|
2486
|
-
).max(1e6).optional().nullable(),
|
|
2487
|
-
policiesEnabled: z.boolean().describe(
|
|
2488
|
-
"Whether to display privacy policy and terms and conditions to customers."
|
|
2489
|
-
).optional().nullable(),
|
|
2490
|
-
privacyPolicy: z.intersection(
|
|
2491
|
-
z.object({
|
|
2492
|
-
enabled: z.boolean().describe(
|
|
2493
|
-
"Whether the privacy policy is displayed to customers.\n\nDefault: `false`"
|
|
2494
|
-
).optional().nullable()
|
|
2495
|
-
}),
|
|
2496
|
-
z.xor([
|
|
2497
|
-
z.object({
|
|
2498
|
-
url: z.never().optional(),
|
|
2499
|
-
text: z.never().optional()
|
|
2500
|
-
}),
|
|
2501
|
-
z.object({
|
|
2502
|
-
text: z.never().optional(),
|
|
2503
|
-
url: z.string().describe("Privacy policy URL.")
|
|
2504
|
-
}),
|
|
2505
|
-
z.object({
|
|
2506
|
-
url: z.never().optional(),
|
|
2507
|
-
text: z.string().describe("Privacy policy text.").max(1e6)
|
|
2508
|
-
})
|
|
2509
|
-
])
|
|
2510
|
-
).describe("Privacy policy display settings.").optional(),
|
|
2511
|
-
termsAndConditions: z.intersection(
|
|
2512
|
-
z.object({
|
|
2513
|
-
enabled: z.boolean().describe(
|
|
2514
|
-
"Whether the terms and conditions are displayed to customers.\n\nDefault: `false`"
|
|
2515
|
-
).optional().nullable()
|
|
2516
|
-
}),
|
|
2517
|
-
z.xor([
|
|
2518
|
-
z.object({
|
|
2519
|
-
url: z.never().optional(),
|
|
2520
|
-
text: z.never().optional()
|
|
2521
|
-
}),
|
|
2522
|
-
z.object({
|
|
2523
|
-
text: z.never().optional(),
|
|
2524
|
-
url: z.string().describe("Terms and conditions URL.")
|
|
2525
|
-
}),
|
|
2526
|
-
z.object({
|
|
2527
|
-
url: z.never().optional(),
|
|
2528
|
-
text: z.string().describe("Terms and conditions text.").max(1e6)
|
|
2529
|
-
})
|
|
2530
|
-
])
|
|
2531
|
-
).describe("Terms and conditions display settings.").optional(),
|
|
2532
|
-
customFieldDefinitions: z.array(
|
|
2533
|
-
z.object({
|
|
2534
|
-
_id: z.string().describe("Custom field ID.").regex(
|
|
2535
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2536
|
-
"Must be a valid GUID"
|
|
2537
|
-
).optional().nullable(),
|
|
2538
|
-
name: z.string().describe("Custom field name.").min(1).max(1e3).optional().nullable(),
|
|
2539
|
-
required: z.boolean().describe(
|
|
2540
|
-
"Whether the custom field is required.\n\nDefault: `false`"
|
|
2541
|
-
).optional().nullable()
|
|
2542
|
-
})
|
|
2543
|
-
).max(1e3).optional(),
|
|
2544
|
-
lastNameRequired: z.boolean().describe(
|
|
2545
|
-
"Whether a last name is required in the reservation form.\n\nDefault: `false`"
|
|
2546
|
-
).optional().nullable(),
|
|
2547
|
-
emailRequired: z.boolean().describe(
|
|
2548
|
-
"Whether an email is required in the reservation form.\n\nDefault: `false`"
|
|
2549
|
-
).optional().nullable(),
|
|
2550
|
-
emailMarketingCheckbox: z.object({
|
|
2551
|
-
enabled: z.boolean().describe(
|
|
2552
|
-
"Whether the email marketing checkbox is displayed to customers.\n\nDefault: `false`"
|
|
2553
|
-
).optional().nullable(),
|
|
2554
|
-
checkedByDefault: z.boolean().describe(
|
|
2555
|
-
"Whether the email marketing checkbox is checked by default.\n\nDefault: `false`"
|
|
2556
|
-
).optional().nullable()
|
|
2557
|
-
}).describe("Email marketing checkbox settings.").optional()
|
|
2558
|
-
}).describe(
|
|
2559
|
-
"Custom form fields and settings for the reservation booking form."
|
|
2560
|
-
).optional(),
|
|
2561
|
-
visible: z.boolean().describe("Whether the experience is visible on the live site.").optional().nullable()
|
|
2562
|
-
}).describe("Experience configuration.").optional(),
|
|
2563
|
-
currency: z.string().describe(
|
|
2564
|
-
"3-letter currency code in ISO-4217 alphabetic format. For exampled, `USD`."
|
|
2565
|
-
).optional().nullable(),
|
|
2566
|
-
extendedFields: z.object({
|
|
2567
|
-
namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
|
|
2568
|
-
"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
|
|
2569
|
-
).optional()
|
|
2570
|
-
}).describe("Extended fields.").optional(),
|
|
2571
|
-
tags: z.object({
|
|
2572
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
2573
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
2574
|
-
).optional(),
|
|
2575
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
2576
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
2577
|
-
).optional()
|
|
2578
|
-
}).describe(
|
|
2579
|
-
"Tags assigned to the experience. Tags must be created using the [Tags API](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) before they can be assigned."
|
|
2580
|
-
).optional(),
|
|
2581
|
-
slug: z.string().describe(
|
|
2582
|
-
'URL-friendly identifier for the experience page, derived from the experience display name in kebab-case format (e.g., "wine-tasting-event"). Used to create readable URLs for the experience page.'
|
|
2583
|
-
).max(300).optional().nullable(),
|
|
2584
|
-
seoSettings: z.object({
|
|
2585
|
-
seoSchema: z.object({
|
|
2586
|
-
tags: z.array(
|
|
2587
|
-
z.object({
|
|
2588
|
-
type: z.string().describe(
|
|
2589
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
2590
|
-
).optional(),
|
|
2591
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2592
|
-
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
2593
|
-
).optional().nullable(),
|
|
2594
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2595
|
-
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2596
|
-
).optional().nullable(),
|
|
2597
|
-
children: z.string().describe(
|
|
2598
|
-
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2599
|
-
).optional(),
|
|
2600
|
-
custom: z.boolean().describe(
|
|
2601
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
2602
|
-
).optional(),
|
|
2603
|
-
disabled: z.boolean().describe(
|
|
2604
|
-
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2605
|
-
).optional()
|
|
2606
|
-
})
|
|
2607
|
-
).optional(),
|
|
2608
|
-
settings: z.object({
|
|
2609
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2610
|
-
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
2611
|
-
).optional(),
|
|
2612
|
-
keywords: z.array(
|
|
2613
|
-
z.object({
|
|
2614
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2615
|
-
isMain: z.boolean().describe(
|
|
2616
|
-
"Whether the keyword is the main focus keyword."
|
|
2617
|
-
).optional(),
|
|
2618
|
-
origin: z.string().describe(
|
|
2619
|
-
"The source that added the keyword terms to the SEO settings."
|
|
2620
|
-
).max(1e3).optional().nullable()
|
|
2621
|
-
})
|
|
2622
|
-
).max(5).optional()
|
|
2623
|
-
}).describe("SEO general settings.").optional()
|
|
2624
|
-
}).describe(
|
|
2625
|
-
"SEO schema data for customizing meta tags and search engine settings."
|
|
2626
|
-
).optional()
|
|
2627
|
-
}).describe("SEO settings for the experience page.").optional()
|
|
2628
|
-
}).describe("Retrieved experience.").optional()
|
|
2629
|
-
});
|
|
2630
|
-
var UpdateExperienceRequest = z.object({
|
|
2631
|
-
_id: z.string().describe("Experience ID.").regex(
|
|
2632
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2633
|
-
"Must be a valid GUID"
|
|
2634
|
-
),
|
|
2635
|
-
experience: z.object({
|
|
2636
|
-
_id: z.string().describe("Experience ID.").regex(
|
|
2637
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2638
|
-
"Must be a valid GUID"
|
|
2639
|
-
).optional().nullable(),
|
|
2640
|
-
reservationLocationId: z.string().describe(
|
|
2641
|
-
"ID of the reservation location this experience is assigned to."
|
|
2642
|
-
).regex(
|
|
2643
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2644
|
-
"Must be a valid GUID"
|
|
2645
|
-
).optional().nullable(),
|
|
2646
|
-
revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
|
|
2647
|
-
"Revision number, which increments by 1 each time the experience is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the experience.\n\nIgnored when creating an experience."
|
|
2648
|
-
),
|
|
2649
|
-
_createdDate: z.date().describe("Date and time the experience was created.").optional().nullable(),
|
|
2650
|
-
_updatedDate: z.date().describe("Date and time the experience was last updated.").optional().nullable(),
|
|
2651
|
-
configuration: z.object({
|
|
2652
|
-
displayInfo: z.object({
|
|
2653
|
-
name: z.string().describe("Experience name.").min(1).max(120).optional().nullable(),
|
|
2654
|
-
shortDescription: z.string().describe("Brief description of the experience.").max(300).optional().nullable(),
|
|
2655
|
-
coverImage: z.string().describe("Cover image for the experience.").optional(),
|
|
2656
|
-
richContent: z.any().describe(
|
|
2657
|
-
"Detailed description of the experience using rich content formatting."
|
|
2658
|
-
).optional()
|
|
2659
|
-
}).describe("Display information for the experience.").optional(),
|
|
2660
|
-
paymentPolicy: z.intersection(
|
|
2661
|
-
z.object({
|
|
2662
|
-
paymentPolicyType: z.enum(["PER_GUEST", "FREE"]).optional()
|
|
2663
|
-
}),
|
|
2664
|
-
z.xor([
|
|
2665
|
-
z.object({ perGuestOptions: z.never().optional() }),
|
|
2666
|
-
z.object({
|
|
2667
|
-
perGuestOptions: z.object({
|
|
2668
|
-
price: z.string().describe(
|
|
2669
|
-
'Monetary amount to charge. Decimal string with a period as a decimal separator. For example, `"3.99"`.'
|
|
2670
|
-
).optional().nullable()
|
|
2671
|
-
}).describe("Per-guest pricing settings.")
|
|
2672
|
-
})
|
|
2673
|
-
])
|
|
2674
|
-
).describe(
|
|
2675
|
-
"Payment policy for the experience. This policy determines how the restaurant charges for reservations."
|
|
2676
|
-
).optional(),
|
|
2677
|
-
onlineReservations: z.object({
|
|
2678
|
-
partySize: z.object({
|
|
2679
|
-
min: z.number().int().describe(
|
|
2680
|
-
"Minimum number of guests allowed for a reservation."
|
|
2681
|
-
).min(1).max(1e4).optional().nullable(),
|
|
2682
|
-
max: z.number().int().describe(
|
|
2683
|
-
"Maximum number of guests allowed for a reservation."
|
|
2684
|
-
).min(1).max(1e4).optional().nullable()
|
|
2685
|
-
}).describe("Party size.").optional(),
|
|
2686
|
-
minimumReservationNotice: z.object({
|
|
2687
|
-
number: z.number().int().describe(
|
|
2688
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
2689
|
-
).min(1).max(1e3).optional().nullable(),
|
|
2690
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).optional()
|
|
2691
|
-
}).describe("Minimum reservation notice.").optional(),
|
|
2692
|
-
maximumReservationNotice: z.object({
|
|
2693
|
-
number: z.number().int().describe(
|
|
2694
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
2695
|
-
).min(1).max(1e3).optional().nullable(),
|
|
2696
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).optional()
|
|
2697
|
-
}).describe("Maximum reservation notice.").optional(),
|
|
2698
|
-
approval: z.object({ mode: z.enum(["AUTOMATIC", "MANUAL"]).optional() }).describe("Approval.").optional(),
|
|
2699
|
-
maxGuests: z.object({
|
|
2700
|
-
number: z.number().int().describe(
|
|
2701
|
-
"Maximum total number of guests that can have active reservations for this experience at the same time."
|
|
2702
|
-
).min(0).max(1e4).optional().nullable()
|
|
2703
|
-
}).describe("Maximum number of guests.").optional(),
|
|
2704
|
-
businessSchedule: z.object({
|
|
2705
|
-
durationInMinutes: z.number().int().describe("Duration of the experience in minutes.").min(1).max(1440).optional().nullable(),
|
|
2706
|
-
entries: z.array(
|
|
2707
|
-
z.intersection(
|
|
2708
|
-
z.object({
|
|
2709
|
-
recurrence: z.enum(["WEEKLY", "ONE_TIME"]).optional()
|
|
2710
|
-
}),
|
|
2711
|
-
z.xor([
|
|
2712
|
-
z.object({
|
|
2713
|
-
weeklyOptions: z.never().optional(),
|
|
2714
|
-
oneTimeOptions: z.never().optional()
|
|
2715
|
-
}),
|
|
2716
|
-
z.object({
|
|
2717
|
-
oneTimeOptions: z.never().optional(),
|
|
2718
|
-
weeklyOptions: z.object({
|
|
2719
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
2720
|
-
endDate: z.string().describe("End date.").optional().nullable(),
|
|
2721
|
-
startDaysAndTimes: z.array(
|
|
2722
|
-
z.object({
|
|
2723
|
-
day: z.enum([
|
|
2724
|
-
"MONDAY",
|
|
2725
|
-
"TUESDAY",
|
|
2726
|
-
"WEDNESDAY",
|
|
2727
|
-
"THURSDAY",
|
|
2728
|
-
"FRIDAY",
|
|
2729
|
-
"SATURDAY",
|
|
2730
|
-
"SUNDAY"
|
|
2731
|
-
]).optional(),
|
|
2732
|
-
time: z.string().describe(
|
|
2733
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
2734
|
-
).max(5).min(5).optional().nullable()
|
|
2735
|
-
})
|
|
2736
|
-
).max(100).optional()
|
|
2737
|
-
}).describe("Weekly recurrence settings.")
|
|
2738
|
-
}),
|
|
2739
|
-
z.object({
|
|
2740
|
-
weeklyOptions: z.never().optional(),
|
|
2741
|
-
oneTimeOptions: z.object({
|
|
2742
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
2743
|
-
startTime: z.string().describe(
|
|
2744
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
2745
|
-
).max(5).min(5).optional().nullable()
|
|
2746
|
-
}).describe("1-time event settings.")
|
|
2747
|
-
})
|
|
2748
|
-
])
|
|
2749
|
-
)
|
|
2750
|
-
).max(10).optional()
|
|
2751
|
-
}).describe("Business schedule.").optional()
|
|
2752
|
-
}).describe(
|
|
2753
|
-
"Settings for this experience that are used to determine restaurant availability for reservations made online."
|
|
2754
|
-
).optional(),
|
|
2755
|
-
reservationForm: z.object({
|
|
2756
|
-
submitMessage: z.string().describe(
|
|
2757
|
-
"Message displayed to customers when they submit the reservation form."
|
|
2758
|
-
).max(1e6).optional().nullable(),
|
|
2759
|
-
policiesEnabled: z.boolean().describe(
|
|
2760
|
-
"Whether to display privacy policy and terms and conditions to customers."
|
|
2761
|
-
).optional().nullable(),
|
|
2762
|
-
privacyPolicy: z.intersection(
|
|
2763
|
-
z.object({
|
|
2764
|
-
enabled: z.boolean().describe(
|
|
2765
|
-
"Whether the privacy policy is displayed to customers.\n\nDefault: `false`"
|
|
2766
|
-
).optional().nullable()
|
|
2767
|
-
}),
|
|
2768
|
-
z.xor([
|
|
2769
|
-
z.object({
|
|
2770
|
-
url: z.never().optional(),
|
|
2771
|
-
text: z.never().optional()
|
|
2772
|
-
}),
|
|
2773
|
-
z.object({
|
|
2774
|
-
text: z.never().optional(),
|
|
2775
|
-
url: z.string().describe("Privacy policy URL.")
|
|
2776
|
-
}),
|
|
2777
|
-
z.object({
|
|
2778
|
-
url: z.never().optional(),
|
|
2779
|
-
text: z.string().describe("Privacy policy text.").max(1e6)
|
|
2780
|
-
})
|
|
2781
|
-
])
|
|
2782
|
-
).describe("Privacy policy display settings.").optional(),
|
|
2783
|
-
termsAndConditions: z.intersection(
|
|
2784
|
-
z.object({
|
|
2785
|
-
enabled: z.boolean().describe(
|
|
2786
|
-
"Whether the terms and conditions are displayed to customers.\n\nDefault: `false`"
|
|
2787
|
-
).optional().nullable()
|
|
2788
|
-
}),
|
|
2789
|
-
z.xor([
|
|
2790
|
-
z.object({
|
|
2791
|
-
url: z.never().optional(),
|
|
2792
|
-
text: z.never().optional()
|
|
2793
|
-
}),
|
|
2794
|
-
z.object({
|
|
2795
|
-
text: z.never().optional(),
|
|
2796
|
-
url: z.string().describe("Terms and conditions URL.")
|
|
2797
|
-
}),
|
|
2798
|
-
z.object({
|
|
2799
|
-
url: z.never().optional(),
|
|
2800
|
-
text: z.string().describe("Terms and conditions text.").max(1e6)
|
|
2801
|
-
})
|
|
2802
|
-
])
|
|
2803
|
-
).describe("Terms and conditions display settings.").optional(),
|
|
2804
|
-
customFieldDefinitions: z.array(
|
|
2805
|
-
z.object({
|
|
2806
|
-
_id: z.string().describe("Custom field ID.").regex(
|
|
2807
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2808
|
-
"Must be a valid GUID"
|
|
2809
|
-
).optional().nullable(),
|
|
2810
|
-
name: z.string().describe("Custom field name.").min(1).max(1e3).optional().nullable(),
|
|
2811
|
-
required: z.boolean().describe(
|
|
2812
|
-
"Whether the custom field is required.\n\nDefault: `false`"
|
|
2813
|
-
).optional().nullable()
|
|
2814
|
-
})
|
|
2815
|
-
).max(1e3).optional(),
|
|
2816
|
-
lastNameRequired: z.boolean().describe(
|
|
2817
|
-
"Whether a last name is required in the reservation form.\n\nDefault: `false`"
|
|
2818
|
-
).optional().nullable(),
|
|
2819
|
-
emailRequired: z.boolean().describe(
|
|
2820
|
-
"Whether an email is required in the reservation form.\n\nDefault: `false`"
|
|
2821
|
-
).optional().nullable(),
|
|
2822
|
-
emailMarketingCheckbox: z.object({
|
|
2823
|
-
enabled: z.boolean().describe(
|
|
2824
|
-
"Whether the email marketing checkbox is displayed to customers.\n\nDefault: `false`"
|
|
2825
|
-
).optional().nullable(),
|
|
2826
|
-
checkedByDefault: z.boolean().describe(
|
|
2827
|
-
"Whether the email marketing checkbox is checked by default.\n\nDefault: `false`"
|
|
2828
|
-
).optional().nullable()
|
|
2829
|
-
}).describe("Email marketing checkbox settings.").optional()
|
|
2830
|
-
}).describe(
|
|
2831
|
-
"Custom form fields and settings for the reservation booking form."
|
|
2832
|
-
).optional(),
|
|
2833
|
-
visible: z.boolean().describe("Whether the experience is visible on the live site.").optional().nullable()
|
|
2834
|
-
}).describe("Experience configuration.").optional(),
|
|
2835
|
-
currency: z.string().describe(
|
|
2836
|
-
"3-letter currency code in ISO-4217 alphabetic format. For exampled, `USD`."
|
|
2837
|
-
).optional().nullable(),
|
|
2838
|
-
extendedFields: z.object({
|
|
2839
|
-
namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
|
|
2840
|
-
"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
|
|
2841
|
-
).optional()
|
|
2842
|
-
}).describe("Extended fields.").optional(),
|
|
2843
|
-
tags: z.object({
|
|
2844
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
2845
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
2846
|
-
).optional(),
|
|
2847
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
2848
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
2849
|
-
).optional()
|
|
2850
|
-
}).describe(
|
|
2851
|
-
"Tags assigned to the experience. Tags must be created using the [Tags API](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) before they can be assigned."
|
|
2852
|
-
).optional(),
|
|
2853
|
-
slug: z.string().describe(
|
|
2854
|
-
'URL-friendly identifier for the experience page, derived from the experience display name in kebab-case format (e.g., "wine-tasting-event"). Used to create readable URLs for the experience page.'
|
|
2855
|
-
).max(300).optional().nullable(),
|
|
2856
|
-
seoSettings: z.object({
|
|
2857
|
-
seoSchema: z.object({
|
|
2858
|
-
tags: z.array(
|
|
2859
|
-
z.object({
|
|
2860
|
-
type: z.string().describe(
|
|
2861
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
2862
|
-
).optional(),
|
|
2863
|
-
props: z.record(z.string(), z.any()).describe(
|
|
2864
|
-
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
2865
|
-
).optional().nullable(),
|
|
2866
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
2867
|
-
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
2868
|
-
).optional().nullable(),
|
|
2869
|
-
children: z.string().describe(
|
|
2870
|
-
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
2871
|
-
).optional(),
|
|
2872
|
-
custom: z.boolean().describe(
|
|
2873
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
2874
|
-
).optional(),
|
|
2875
|
-
disabled: z.boolean().describe(
|
|
2876
|
-
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
2877
|
-
).optional()
|
|
2878
|
-
})
|
|
2879
|
-
).optional(),
|
|
2880
|
-
settings: z.object({
|
|
2881
|
-
preventAutoRedirect: z.boolean().describe(
|
|
2882
|
-
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
2883
|
-
).optional(),
|
|
2884
|
-
keywords: z.array(
|
|
2885
|
-
z.object({
|
|
2886
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
2887
|
-
isMain: z.boolean().describe(
|
|
2888
|
-
"Whether the keyword is the main focus keyword."
|
|
2889
|
-
).optional(),
|
|
2890
|
-
origin: z.string().describe(
|
|
2891
|
-
"The source that added the keyword terms to the SEO settings."
|
|
2892
|
-
).max(1e3).optional().nullable()
|
|
2893
|
-
})
|
|
2894
|
-
).max(5).optional()
|
|
2895
|
-
}).describe("SEO general settings.").optional()
|
|
2896
|
-
}).describe(
|
|
2897
|
-
"SEO schema data for customizing meta tags and search engine settings."
|
|
2898
|
-
).optional()
|
|
2899
|
-
}).describe("SEO settings for the experience page.").optional()
|
|
2900
|
-
}).describe("Experience to update. May be partial.")
|
|
2901
|
-
});
|
|
2902
|
-
var UpdateExperienceResponse = z.object({
|
|
2903
|
-
_id: z.string().describe("Experience ID.").regex(
|
|
2904
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2905
|
-
"Must be a valid GUID"
|
|
2906
|
-
).optional().nullable(),
|
|
2907
|
-
reservationLocationId: z.string().describe("ID of the reservation location this experience is assigned to.").regex(
|
|
2908
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
2909
|
-
"Must be a valid GUID"
|
|
2910
|
-
).optional().nullable(),
|
|
2911
|
-
revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
|
|
2912
|
-
"Revision number, which increments by 1 each time the experience is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the experience.\n\nIgnored when creating an experience."
|
|
2913
|
-
).optional().nullable(),
|
|
2914
|
-
_createdDate: z.date().describe("Date and time the experience was created.").optional().nullable(),
|
|
2915
|
-
_updatedDate: z.date().describe("Date and time the experience was last updated.").optional().nullable(),
|
|
2916
|
-
configuration: z.object({
|
|
2917
|
-
displayInfo: z.object({
|
|
2918
|
-
name: z.string().describe("Experience name.").min(1).max(120).optional().nullable(),
|
|
2919
|
-
shortDescription: z.string().describe("Brief description of the experience.").max(300).optional().nullable(),
|
|
2920
|
-
coverImage: z.string().describe("Cover image for the experience.").optional(),
|
|
2921
|
-
richContent: z.any().describe(
|
|
2922
|
-
"Detailed description of the experience using rich content formatting."
|
|
2923
|
-
).optional()
|
|
2924
|
-
}).describe("Display information for the experience.").optional(),
|
|
2925
|
-
paymentPolicy: z.intersection(
|
|
2926
|
-
z.object({
|
|
2927
|
-
paymentPolicyType: z.enum(["PER_GUEST", "FREE"]).describe("Payment policy type for the experience.").optional()
|
|
2928
|
-
}),
|
|
2929
|
-
z.xor([
|
|
2930
|
-
z.object({ perGuestOptions: z.never().optional() }),
|
|
2931
|
-
z.object({
|
|
2932
|
-
perGuestOptions: z.object({
|
|
2933
|
-
price: z.string().describe(
|
|
2934
|
-
'Monetary amount to charge. Decimal string with a period as a decimal separator. For example, `"3.99"`.'
|
|
2935
|
-
).optional().nullable()
|
|
2936
|
-
}).describe("Per-guest pricing settings.")
|
|
2937
|
-
})
|
|
2938
|
-
])
|
|
2939
|
-
).describe(
|
|
2940
|
-
"Payment policy for the experience. This policy determines how the restaurant charges for reservations."
|
|
2941
|
-
).optional(),
|
|
2942
|
-
onlineReservations: z.object({
|
|
2943
|
-
partySize: z.object({
|
|
2944
|
-
min: z.number().int().describe("Minimum number of guests allowed for a reservation.").min(1).max(1e4).optional().nullable(),
|
|
2945
|
-
max: z.number().int().describe("Maximum number of guests allowed for a reservation.").min(1).max(1e4).optional().nullable()
|
|
2946
|
-
}).describe("Party size.").optional(),
|
|
2947
|
-
minimumReservationNotice: z.object({
|
|
2948
|
-
number: z.number().int().describe(
|
|
2949
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
2950
|
-
).min(1).max(1e3).optional().nullable(),
|
|
2951
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
2952
|
-
}).describe("Minimum reservation notice.").optional(),
|
|
2953
|
-
maximumReservationNotice: z.object({
|
|
2954
|
-
number: z.number().int().describe(
|
|
2955
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
2956
|
-
).min(1).max(1e3).optional().nullable(),
|
|
2957
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
2958
|
-
}).describe("Maximum reservation notice.").optional(),
|
|
2959
|
-
approval: z.object({
|
|
2960
|
-
mode: z.enum(["AUTOMATIC", "MANUAL"]).describe("Approval mode.").optional()
|
|
2961
|
-
}).describe("Approval.").optional(),
|
|
2962
|
-
maxGuests: z.object({
|
|
2963
|
-
number: z.number().int().describe(
|
|
2964
|
-
"Maximum total number of guests that can have active reservations for this experience at the same time."
|
|
2965
|
-
).min(0).max(1e4).optional().nullable()
|
|
2966
|
-
}).describe("Maximum number of guests.").optional(),
|
|
2967
|
-
businessSchedule: z.object({
|
|
2968
|
-
durationInMinutes: z.number().int().describe("Duration of the experience in minutes.").min(1).max(1440).optional().nullable(),
|
|
2969
|
-
entries: z.array(
|
|
2970
|
-
z.intersection(
|
|
2971
|
-
z.object({
|
|
2972
|
-
recurrence: z.enum(["WEEKLY", "ONE_TIME"]).describe("Recurrence settings for this entry.").optional()
|
|
2973
|
-
}),
|
|
2974
|
-
z.xor([
|
|
2975
|
-
z.object({
|
|
2976
|
-
weeklyOptions: z.never().optional(),
|
|
2977
|
-
oneTimeOptions: z.never().optional()
|
|
2978
|
-
}),
|
|
2979
|
-
z.object({
|
|
2980
|
-
oneTimeOptions: z.never().optional(),
|
|
2981
|
-
weeklyOptions: z.object({
|
|
2982
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
2983
|
-
endDate: z.string().describe("End date.").optional().nullable(),
|
|
2984
|
-
startDaysAndTimes: z.array(
|
|
2985
|
-
z.object({
|
|
2986
|
-
day: z.enum([
|
|
2987
|
-
"MONDAY",
|
|
2988
|
-
"TUESDAY",
|
|
2989
|
-
"WEDNESDAY",
|
|
2990
|
-
"THURSDAY",
|
|
2991
|
-
"FRIDAY",
|
|
2992
|
-
"SATURDAY",
|
|
2993
|
-
"SUNDAY"
|
|
2994
|
-
]).describe("Day of week.").optional(),
|
|
2995
|
-
time: z.string().describe(
|
|
2996
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
2997
|
-
).max(5).min(5).optional().nullable()
|
|
2998
|
-
})
|
|
2999
|
-
).max(100).optional()
|
|
3000
|
-
}).describe("Weekly recurrence settings.")
|
|
3001
|
-
}),
|
|
3002
|
-
z.object({
|
|
3003
|
-
weeklyOptions: z.never().optional(),
|
|
3004
|
-
oneTimeOptions: z.object({
|
|
3005
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
3006
|
-
startTime: z.string().describe(
|
|
3007
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
3008
|
-
).max(5).min(5).optional().nullable()
|
|
3009
|
-
}).describe("1-time event settings.")
|
|
3010
|
-
})
|
|
3011
|
-
])
|
|
3012
|
-
)
|
|
3013
|
-
).max(10).optional()
|
|
3014
|
-
}).describe("Business schedule.").optional()
|
|
3015
|
-
}).describe(
|
|
3016
|
-
"Settings for this experience that are used to determine restaurant availability for reservations made online."
|
|
3017
|
-
).optional(),
|
|
3018
|
-
reservationForm: z.object({
|
|
3019
|
-
submitMessage: z.string().describe(
|
|
3020
|
-
"Message displayed to customers when they submit the reservation form."
|
|
3021
|
-
).max(1e6).optional().nullable(),
|
|
3022
|
-
policiesEnabled: z.boolean().describe(
|
|
3023
|
-
"Whether to display privacy policy and terms and conditions to customers."
|
|
3024
|
-
).optional().nullable(),
|
|
3025
|
-
privacyPolicy: z.intersection(
|
|
3026
|
-
z.object({
|
|
3027
|
-
enabled: z.boolean().describe(
|
|
3028
|
-
"Whether the privacy policy is displayed to customers.\n\nDefault: `false`"
|
|
3029
|
-
).optional().nullable()
|
|
3030
|
-
}),
|
|
3031
|
-
z.xor([
|
|
3032
|
-
z.object({
|
|
3033
|
-
url: z.never().optional(),
|
|
3034
|
-
text: z.never().optional()
|
|
3035
|
-
}),
|
|
3036
|
-
z.object({
|
|
3037
|
-
text: z.never().optional(),
|
|
3038
|
-
url: z.string().describe("Privacy policy URL.")
|
|
3039
|
-
}),
|
|
3040
|
-
z.object({
|
|
3041
|
-
url: z.never().optional(),
|
|
3042
|
-
text: z.string().describe("Privacy policy text.").max(1e6)
|
|
3043
|
-
})
|
|
3044
|
-
])
|
|
3045
|
-
).describe("Privacy policy display settings.").optional(),
|
|
3046
|
-
termsAndConditions: z.intersection(
|
|
3047
|
-
z.object({
|
|
3048
|
-
enabled: z.boolean().describe(
|
|
3049
|
-
"Whether the terms and conditions are displayed to customers.\n\nDefault: `false`"
|
|
3050
|
-
).optional().nullable()
|
|
3051
|
-
}),
|
|
3052
|
-
z.xor([
|
|
3053
|
-
z.object({
|
|
3054
|
-
url: z.never().optional(),
|
|
3055
|
-
text: z.never().optional()
|
|
3056
|
-
}),
|
|
3057
|
-
z.object({
|
|
3058
|
-
text: z.never().optional(),
|
|
3059
|
-
url: z.string().describe("Terms and conditions URL.")
|
|
3060
|
-
}),
|
|
3061
|
-
z.object({
|
|
3062
|
-
url: z.never().optional(),
|
|
3063
|
-
text: z.string().describe("Terms and conditions text.").max(1e6)
|
|
3064
|
-
})
|
|
3065
|
-
])
|
|
3066
|
-
).describe("Terms and conditions display settings.").optional(),
|
|
3067
|
-
customFieldDefinitions: z.array(
|
|
3068
|
-
z.object({
|
|
3069
|
-
_id: z.string().describe("Custom field ID.").regex(
|
|
3070
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
3071
|
-
"Must be a valid GUID"
|
|
3072
|
-
).optional().nullable(),
|
|
3073
|
-
name: z.string().describe("Custom field name.").min(1).max(1e3).optional().nullable(),
|
|
3074
|
-
required: z.boolean().describe(
|
|
3075
|
-
"Whether the custom field is required.\n\nDefault: `false`"
|
|
3076
|
-
).optional().nullable()
|
|
3077
|
-
})
|
|
3078
|
-
).max(1e3).optional(),
|
|
3079
|
-
lastNameRequired: z.boolean().describe(
|
|
3080
|
-
"Whether a last name is required in the reservation form.\n\nDefault: `false`"
|
|
3081
|
-
).optional().nullable(),
|
|
3082
|
-
emailRequired: z.boolean().describe(
|
|
3083
|
-
"Whether an email is required in the reservation form.\n\nDefault: `false`"
|
|
3084
|
-
).optional().nullable(),
|
|
3085
|
-
emailMarketingCheckbox: z.object({
|
|
3086
|
-
enabled: z.boolean().describe(
|
|
3087
|
-
"Whether the email marketing checkbox is displayed to customers.\n\nDefault: `false`"
|
|
3088
|
-
).optional().nullable(),
|
|
3089
|
-
checkedByDefault: z.boolean().describe(
|
|
3090
|
-
"Whether the email marketing checkbox is checked by default.\n\nDefault: `false`"
|
|
3091
|
-
).optional().nullable()
|
|
3092
|
-
}).describe("Email marketing checkbox settings.").optional()
|
|
3093
|
-
}).describe(
|
|
3094
|
-
"Custom form fields and settings for the reservation booking form."
|
|
3095
|
-
).optional(),
|
|
3096
|
-
visible: z.boolean().describe("Whether the experience is visible on the live site.").optional().nullable()
|
|
3097
|
-
}).describe("Experience configuration.").optional(),
|
|
3098
|
-
currency: z.string().describe(
|
|
3099
|
-
"3-letter currency code in ISO-4217 alphabetic format. For exampled, `USD`."
|
|
3100
|
-
).optional().nullable(),
|
|
3101
|
-
extendedFields: z.object({
|
|
3102
|
-
namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
|
|
3103
|
-
"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
|
|
3104
|
-
).optional()
|
|
3105
|
-
}).describe("Extended fields.").optional(),
|
|
3106
|
-
tags: z.object({
|
|
3107
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
3108
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
3109
|
-
).optional(),
|
|
3110
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
3111
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
3112
|
-
).optional()
|
|
3113
|
-
}).describe(
|
|
3114
|
-
"Tags assigned to the experience. Tags must be created using the [Tags API](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) before they can be assigned."
|
|
3115
|
-
).optional(),
|
|
3116
|
-
slug: z.string().describe(
|
|
3117
|
-
'URL-friendly identifier for the experience page, derived from the experience display name in kebab-case format (e.g., "wine-tasting-event"). Used to create readable URLs for the experience page.'
|
|
3118
|
-
).max(300).optional().nullable(),
|
|
3119
|
-
seoSettings: z.object({
|
|
3120
|
-
seoSchema: z.object({
|
|
3121
|
-
tags: z.array(
|
|
3122
|
-
z.object({
|
|
3123
|
-
type: z.string().describe(
|
|
3124
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
3125
|
-
).optional(),
|
|
3126
|
-
props: z.record(z.string(), z.any()).describe(
|
|
3127
|
-
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
3128
|
-
).optional().nullable(),
|
|
3129
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
3130
|
-
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
3131
|
-
).optional().nullable(),
|
|
3132
|
-
children: z.string().describe(
|
|
3133
|
-
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
3134
|
-
).optional(),
|
|
3135
|
-
custom: z.boolean().describe(
|
|
3136
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
3137
|
-
).optional(),
|
|
3138
|
-
disabled: z.boolean().describe(
|
|
3139
|
-
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
3140
|
-
).optional()
|
|
3141
|
-
})
|
|
3142
|
-
).optional(),
|
|
3143
|
-
settings: z.object({
|
|
3144
|
-
preventAutoRedirect: z.boolean().describe(
|
|
3145
|
-
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
3146
|
-
).optional(),
|
|
3147
|
-
keywords: z.array(
|
|
3148
|
-
z.object({
|
|
3149
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
3150
|
-
isMain: z.boolean().describe(
|
|
3151
|
-
"Whether the keyword is the main focus keyword."
|
|
3152
|
-
).optional(),
|
|
3153
|
-
origin: z.string().describe(
|
|
3154
|
-
"The source that added the keyword terms to the SEO settings."
|
|
3155
|
-
).max(1e3).optional().nullable()
|
|
3156
|
-
})
|
|
3157
|
-
).max(5).optional()
|
|
3158
|
-
}).describe("SEO general settings.").optional()
|
|
3159
|
-
}).describe(
|
|
3160
|
-
"SEO schema data for customizing meta tags and search engine settings."
|
|
3161
|
-
).optional()
|
|
3162
|
-
}).describe("SEO settings for the experience page.").optional()
|
|
3163
|
-
});
|
|
3164
|
-
var QueryExperiencesRequest = z.object({
|
|
3165
|
-
query: z.intersection(
|
|
3166
|
-
z.object({
|
|
3167
|
-
filter: z.record(z.string(), z.any()).describe(
|
|
3168
|
-
"Filter object.\n\nLearn more about the [filter section](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#the-filter-section)."
|
|
3169
|
-
).optional().nullable(),
|
|
3170
|
-
sort: z.array(
|
|
3171
|
-
z.object({
|
|
3172
|
-
fieldName: z.string().describe("Name of the field to sort by.").max(512).optional(),
|
|
3173
|
-
order: z.enum(["ASC", "DESC"]).optional()
|
|
3174
|
-
})
|
|
3175
|
-
).max(5).optional()
|
|
3176
|
-
}),
|
|
3177
|
-
z.xor([
|
|
3178
|
-
z.object({ cursorPaging: z.never().optional() }),
|
|
3179
|
-
z.object({
|
|
3180
|
-
cursorPaging: z.object({
|
|
3181
|
-
limit: z.number().int().describe("Maximum number of items to return in the results.").min(0).max(100).optional().nullable(),
|
|
3182
|
-
cursor: z.string().describe(
|
|
3183
|
-
"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."
|
|
3184
|
-
).max(16e3).optional().nullable()
|
|
3185
|
-
}).describe(
|
|
3186
|
-
"Cursor paging options.\n\nLearn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging)."
|
|
3187
|
-
)
|
|
3188
|
-
})
|
|
3189
|
-
])
|
|
3190
|
-
).describe("Query criteria for filtering and sorting experiences.")
|
|
3191
|
-
});
|
|
3192
|
-
var QueryExperiencesResponse = z.object({
|
|
3193
|
-
experiences: z.array(
|
|
3194
|
-
z.object({
|
|
3195
|
-
_id: z.string().describe("Experience ID.").regex(
|
|
3196
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
3197
|
-
"Must be a valid GUID"
|
|
3198
|
-
).optional().nullable(),
|
|
3199
|
-
reservationLocationId: z.string().describe(
|
|
3200
|
-
"ID of the reservation location this experience is assigned to."
|
|
3201
|
-
).regex(
|
|
3202
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
3203
|
-
"Must be a valid GUID"
|
|
3204
|
-
).optional().nullable(),
|
|
3205
|
-
revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
|
|
3206
|
-
"Revision number, which increments by 1 each time the experience is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the experience.\n\nIgnored when creating an experience."
|
|
3207
|
-
).optional().nullable(),
|
|
3208
|
-
_createdDate: z.date().describe("Date and time the experience was created.").optional().nullable(),
|
|
3209
|
-
_updatedDate: z.date().describe("Date and time the experience was last updated.").optional().nullable(),
|
|
3210
|
-
configuration: z.object({
|
|
3211
|
-
displayInfo: z.object({
|
|
3212
|
-
name: z.string().describe("Experience name.").min(1).max(120).optional().nullable(),
|
|
3213
|
-
shortDescription: z.string().describe("Brief description of the experience.").max(300).optional().nullable(),
|
|
3214
|
-
coverImage: z.string().describe("Cover image for the experience.").optional(),
|
|
3215
|
-
richContent: z.any().describe(
|
|
3216
|
-
"Detailed description of the experience using rich content formatting."
|
|
3217
|
-
).optional()
|
|
3218
|
-
}).describe("Display information for the experience.").optional(),
|
|
3219
|
-
paymentPolicy: z.intersection(
|
|
3220
|
-
z.object({
|
|
3221
|
-
paymentPolicyType: z.enum(["PER_GUEST", "FREE"]).describe("Payment policy type for the experience.").optional()
|
|
3222
|
-
}),
|
|
3223
|
-
z.xor([
|
|
3224
|
-
z.object({ perGuestOptions: z.never().optional() }),
|
|
3225
|
-
z.object({
|
|
3226
|
-
perGuestOptions: z.object({
|
|
3227
|
-
price: z.string().describe(
|
|
3228
|
-
'Monetary amount to charge. Decimal string with a period as a decimal separator. For example, `"3.99"`.'
|
|
3229
|
-
).optional().nullable()
|
|
3230
|
-
}).describe("Per-guest pricing settings.")
|
|
3231
|
-
})
|
|
3232
|
-
])
|
|
3233
|
-
).describe(
|
|
3234
|
-
"Payment policy for the experience. This policy determines how the restaurant charges for reservations."
|
|
3235
|
-
).optional(),
|
|
3236
|
-
onlineReservations: z.object({
|
|
3237
|
-
partySize: z.object({
|
|
3238
|
-
min: z.number().int().describe(
|
|
3239
|
-
"Minimum number of guests allowed for a reservation."
|
|
3240
|
-
).min(1).max(1e4).optional().nullable(),
|
|
3241
|
-
max: z.number().int().describe(
|
|
3242
|
-
"Maximum number of guests allowed for a reservation."
|
|
3243
|
-
).min(1).max(1e4).optional().nullable()
|
|
3244
|
-
}).describe("Party size.").optional(),
|
|
3245
|
-
minimumReservationNotice: z.object({
|
|
3246
|
-
number: z.number().int().describe(
|
|
3247
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
3248
|
-
).min(1).max(1e3).optional().nullable(),
|
|
3249
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
3250
|
-
}).describe("Minimum reservation notice.").optional(),
|
|
3251
|
-
maximumReservationNotice: z.object({
|
|
3252
|
-
number: z.number().int().describe(
|
|
3253
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
3254
|
-
).min(1).max(1e3).optional().nullable(),
|
|
3255
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
3256
|
-
}).describe("Maximum reservation notice.").optional(),
|
|
3257
|
-
approval: z.object({
|
|
3258
|
-
mode: z.enum(["AUTOMATIC", "MANUAL"]).describe("Approval mode.").optional()
|
|
3259
|
-
}).describe("Approval.").optional(),
|
|
3260
|
-
maxGuests: z.object({
|
|
3261
|
-
number: z.number().int().describe(
|
|
3262
|
-
"Maximum total number of guests that can have active reservations for this experience at the same time."
|
|
3263
|
-
).min(0).max(1e4).optional().nullable()
|
|
3264
|
-
}).describe("Maximum number of guests.").optional(),
|
|
3265
|
-
businessSchedule: z.object({
|
|
3266
|
-
durationInMinutes: z.number().int().describe("Duration of the experience in minutes.").min(1).max(1440).optional().nullable(),
|
|
3267
|
-
entries: z.array(
|
|
3268
|
-
z.intersection(
|
|
3269
|
-
z.object({
|
|
3270
|
-
recurrence: z.enum(["WEEKLY", "ONE_TIME"]).describe("Recurrence settings for this entry.").optional()
|
|
3271
|
-
}),
|
|
3272
|
-
z.xor([
|
|
3273
|
-
z.object({
|
|
3274
|
-
weeklyOptions: z.never().optional(),
|
|
3275
|
-
oneTimeOptions: z.never().optional()
|
|
3276
|
-
}),
|
|
3277
|
-
z.object({
|
|
3278
|
-
oneTimeOptions: z.never().optional(),
|
|
3279
|
-
weeklyOptions: z.object({
|
|
3280
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
3281
|
-
endDate: z.string().describe("End date.").optional().nullable(),
|
|
3282
|
-
startDaysAndTimes: z.array(
|
|
3283
|
-
z.object({
|
|
3284
|
-
day: z.enum([
|
|
3285
|
-
"MONDAY",
|
|
3286
|
-
"TUESDAY",
|
|
3287
|
-
"WEDNESDAY",
|
|
3288
|
-
"THURSDAY",
|
|
3289
|
-
"FRIDAY",
|
|
3290
|
-
"SATURDAY",
|
|
3291
|
-
"SUNDAY"
|
|
3292
|
-
]).describe("Day of week.").optional(),
|
|
3293
|
-
time: z.string().describe(
|
|
3294
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
3295
|
-
).max(5).min(5).optional().nullable()
|
|
3296
|
-
})
|
|
3297
|
-
).max(100).optional()
|
|
3298
|
-
}).describe("Weekly recurrence settings.")
|
|
3299
|
-
}),
|
|
3300
|
-
z.object({
|
|
3301
|
-
weeklyOptions: z.never().optional(),
|
|
3302
|
-
oneTimeOptions: z.object({
|
|
3303
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
3304
|
-
startTime: z.string().describe(
|
|
3305
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
3306
|
-
).max(5).min(5).optional().nullable()
|
|
3307
|
-
}).describe("1-time event settings.")
|
|
3308
|
-
})
|
|
3309
|
-
])
|
|
3310
|
-
)
|
|
3311
|
-
).max(10).optional()
|
|
3312
|
-
}).describe("Business schedule.").optional()
|
|
3313
|
-
}).describe(
|
|
3314
|
-
"Settings for this experience that are used to determine restaurant availability for reservations made online."
|
|
3315
|
-
).optional(),
|
|
3316
|
-
reservationForm: z.object({
|
|
3317
|
-
submitMessage: z.string().describe(
|
|
3318
|
-
"Message displayed to customers when they submit the reservation form."
|
|
3319
|
-
).max(1e6).optional().nullable(),
|
|
3320
|
-
policiesEnabled: z.boolean().describe(
|
|
3321
|
-
"Whether to display privacy policy and terms and conditions to customers."
|
|
3322
|
-
).optional().nullable(),
|
|
3323
|
-
privacyPolicy: z.intersection(
|
|
3324
|
-
z.object({
|
|
3325
|
-
enabled: z.boolean().describe(
|
|
3326
|
-
"Whether the privacy policy is displayed to customers.\n\nDefault: `false`"
|
|
3327
|
-
).optional().nullable()
|
|
3328
|
-
}),
|
|
3329
|
-
z.xor([
|
|
3330
|
-
z.object({
|
|
3331
|
-
url: z.never().optional(),
|
|
3332
|
-
text: z.never().optional()
|
|
3333
|
-
}),
|
|
3334
|
-
z.object({
|
|
3335
|
-
text: z.never().optional(),
|
|
3336
|
-
url: z.string().describe("Privacy policy URL.")
|
|
3337
|
-
}),
|
|
3338
|
-
z.object({
|
|
3339
|
-
url: z.never().optional(),
|
|
3340
|
-
text: z.string().describe("Privacy policy text.").max(1e6)
|
|
3341
|
-
})
|
|
3342
|
-
])
|
|
3343
|
-
).describe("Privacy policy display settings.").optional(),
|
|
3344
|
-
termsAndConditions: z.intersection(
|
|
3345
|
-
z.object({
|
|
3346
|
-
enabled: z.boolean().describe(
|
|
3347
|
-
"Whether the terms and conditions are displayed to customers.\n\nDefault: `false`"
|
|
3348
|
-
).optional().nullable()
|
|
3349
|
-
}),
|
|
3350
|
-
z.xor([
|
|
3351
|
-
z.object({
|
|
3352
|
-
url: z.never().optional(),
|
|
3353
|
-
text: z.never().optional()
|
|
3354
|
-
}),
|
|
3355
|
-
z.object({
|
|
3356
|
-
text: z.never().optional(),
|
|
3357
|
-
url: z.string().describe("Terms and conditions URL.")
|
|
3358
|
-
}),
|
|
3359
|
-
z.object({
|
|
3360
|
-
url: z.never().optional(),
|
|
3361
|
-
text: z.string().describe("Terms and conditions text.").max(1e6)
|
|
3362
|
-
})
|
|
3363
|
-
])
|
|
3364
|
-
).describe("Terms and conditions display settings.").optional(),
|
|
3365
|
-
customFieldDefinitions: z.array(
|
|
3366
|
-
z.object({
|
|
3367
|
-
_id: z.string().describe("Custom field ID.").regex(
|
|
3368
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
3369
|
-
"Must be a valid GUID"
|
|
3370
|
-
).optional().nullable(),
|
|
3371
|
-
name: z.string().describe("Custom field name.").min(1).max(1e3).optional().nullable(),
|
|
3372
|
-
required: z.boolean().describe(
|
|
3373
|
-
"Whether the custom field is required.\n\nDefault: `false`"
|
|
3374
|
-
).optional().nullable()
|
|
3375
|
-
})
|
|
3376
|
-
).max(1e3).optional(),
|
|
3377
|
-
lastNameRequired: z.boolean().describe(
|
|
3378
|
-
"Whether a last name is required in the reservation form.\n\nDefault: `false`"
|
|
3379
|
-
).optional().nullable(),
|
|
3380
|
-
emailRequired: z.boolean().describe(
|
|
3381
|
-
"Whether an email is required in the reservation form.\n\nDefault: `false`"
|
|
3382
|
-
).optional().nullable(),
|
|
3383
|
-
emailMarketingCheckbox: z.object({
|
|
3384
|
-
enabled: z.boolean().describe(
|
|
3385
|
-
"Whether the email marketing checkbox is displayed to customers.\n\nDefault: `false`"
|
|
3386
|
-
).optional().nullable(),
|
|
3387
|
-
checkedByDefault: z.boolean().describe(
|
|
3388
|
-
"Whether the email marketing checkbox is checked by default.\n\nDefault: `false`"
|
|
3389
|
-
).optional().nullable()
|
|
3390
|
-
}).describe("Email marketing checkbox settings.").optional()
|
|
3391
|
-
}).describe(
|
|
3392
|
-
"Custom form fields and settings for the reservation booking form."
|
|
3393
|
-
).optional(),
|
|
3394
|
-
visible: z.boolean().describe("Whether the experience is visible on the live site.").optional().nullable()
|
|
3395
|
-
}).describe("Experience configuration.").optional(),
|
|
3396
|
-
currency: z.string().describe(
|
|
3397
|
-
"3-letter currency code in ISO-4217 alphabetic format. For exampled, `USD`."
|
|
3398
|
-
).optional().nullable(),
|
|
3399
|
-
extendedFields: z.object({
|
|
3400
|
-
namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
|
|
3401
|
-
"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
|
|
3402
|
-
).optional()
|
|
3403
|
-
}).describe("Extended fields.").optional(),
|
|
3404
|
-
tags: z.object({
|
|
3405
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
3406
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
3407
|
-
).optional(),
|
|
3408
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
3409
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
3410
|
-
).optional()
|
|
3411
|
-
}).describe(
|
|
3412
|
-
"Tags assigned to the experience. Tags must be created using the [Tags API](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) before they can be assigned."
|
|
3413
|
-
).optional(),
|
|
3414
|
-
slug: z.string().describe(
|
|
3415
|
-
'URL-friendly identifier for the experience page, derived from the experience display name in kebab-case format (e.g., "wine-tasting-event"). Used to create readable URLs for the experience page.'
|
|
3416
|
-
).max(300).optional().nullable(),
|
|
3417
|
-
seoSettings: z.object({
|
|
3418
|
-
seoSchema: z.object({
|
|
3419
|
-
tags: z.array(
|
|
3420
|
-
z.object({
|
|
3421
|
-
type: z.string().describe(
|
|
3422
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
3423
|
-
).optional(),
|
|
3424
|
-
props: z.record(z.string(), z.any()).describe(
|
|
3425
|
-
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
3426
|
-
).optional().nullable(),
|
|
3427
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
3428
|
-
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
3429
|
-
).optional().nullable(),
|
|
3430
|
-
children: z.string().describe(
|
|
3431
|
-
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
3432
|
-
).optional(),
|
|
3433
|
-
custom: z.boolean().describe(
|
|
3434
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
3435
|
-
).optional(),
|
|
3436
|
-
disabled: z.boolean().describe(
|
|
3437
|
-
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
3438
|
-
).optional()
|
|
3439
|
-
})
|
|
3440
|
-
).optional(),
|
|
3441
|
-
settings: z.object({
|
|
3442
|
-
preventAutoRedirect: z.boolean().describe(
|
|
3443
|
-
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
3444
|
-
).optional(),
|
|
3445
|
-
keywords: z.array(
|
|
3446
|
-
z.object({
|
|
3447
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
3448
|
-
isMain: z.boolean().describe(
|
|
3449
|
-
"Whether the keyword is the main focus keyword."
|
|
3450
|
-
).optional(),
|
|
3451
|
-
origin: z.string().describe(
|
|
3452
|
-
"The source that added the keyword terms to the SEO settings."
|
|
3453
|
-
).max(1e3).optional().nullable()
|
|
3454
|
-
})
|
|
3455
|
-
).max(5).optional()
|
|
3456
|
-
}).describe("SEO general settings.").optional()
|
|
3457
|
-
}).describe(
|
|
3458
|
-
"SEO schema data for customizing meta tags and search engine settings."
|
|
3459
|
-
).optional()
|
|
3460
|
-
}).describe("SEO settings for the experience page.").optional()
|
|
3461
|
-
})
|
|
3462
|
-
).optional(),
|
|
3463
|
-
pagingMetadata: z.object({
|
|
3464
|
-
count: z.number().int().describe("Number of items returned in current page.").optional().nullable(),
|
|
3465
|
-
cursors: z.object({
|
|
3466
|
-
next: z.string().describe(
|
|
3467
|
-
"Cursor string pointing to the next page in the list of results."
|
|
3468
|
-
).max(16e3).optional().nullable(),
|
|
3469
|
-
prev: z.string().describe(
|
|
3470
|
-
"Cursor pointing to the previous page in the list of results."
|
|
3471
|
-
).max(16e3).optional().nullable()
|
|
3472
|
-
}).describe(
|
|
3473
|
-
"Cursor strings that point to the next page, previous page, or both."
|
|
3474
|
-
).optional(),
|
|
3475
|
-
hasNext: z.boolean().describe(
|
|
3476
|
-
"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page."
|
|
3477
|
-
).optional().nullable()
|
|
3478
|
-
}).describe("Pagination information for the query results.").optional()
|
|
3479
|
-
});
|
|
3480
|
-
var SearchExperiencesRequest = z.object({
|
|
3481
|
-
search: z.intersection(
|
|
3482
|
-
z.object({
|
|
3483
|
-
filter: z.record(z.string(), z.any()).describe(
|
|
3484
|
-
"Filter object.\n\nLearn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters)."
|
|
3485
|
-
).optional().nullable(),
|
|
3486
|
-
sort: z.array(
|
|
3487
|
-
z.object({
|
|
3488
|
-
fieldName: z.string().describe("Name of the field to sort by.").max(512).optional(),
|
|
3489
|
-
order: z.enum(["ASC", "DESC"]).optional()
|
|
3490
|
-
})
|
|
3491
|
-
).max(100).optional(),
|
|
3492
|
-
aggregations: z.array(
|
|
3493
|
-
z.intersection(
|
|
3494
|
-
z.object({
|
|
3495
|
-
name: z.string().max(1e3).optional().nullable(),
|
|
3496
|
-
type: z.enum([
|
|
3497
|
-
"UNKNOWN_AGGREGATION_TYPE",
|
|
3498
|
-
"VALUE",
|
|
3499
|
-
"RANGE",
|
|
3500
|
-
"SCALAR",
|
|
3501
|
-
"DATE_HISTOGRAM",
|
|
3502
|
-
"NESTED"
|
|
3503
|
-
]).optional(),
|
|
3504
|
-
fieldPath: z.string().max(1e3).optional()
|
|
3505
|
-
}),
|
|
3506
|
-
z.xor([
|
|
3507
|
-
z.object({
|
|
3508
|
-
value: z.never().optional(),
|
|
3509
|
-
range: z.never().optional(),
|
|
3510
|
-
scalar: z.never().optional(),
|
|
3511
|
-
dateHistogram: z.never().optional(),
|
|
3512
|
-
nested: z.never().optional()
|
|
3513
|
-
}),
|
|
3514
|
-
z.object({
|
|
3515
|
-
range: z.never().optional(),
|
|
3516
|
-
scalar: z.never().optional(),
|
|
3517
|
-
dateHistogram: z.never().optional(),
|
|
3518
|
-
nested: z.never().optional(),
|
|
3519
|
-
value: z.intersection(
|
|
3520
|
-
z.object({
|
|
3521
|
-
sortType: z.enum(["COUNT", "VALUE"]).describe(
|
|
3522
|
-
"Whether to sort by the number of matches or the value of the field."
|
|
3523
|
-
).optional(),
|
|
3524
|
-
sortDirection: z.enum(["DESC", "ASC"]).describe(
|
|
3525
|
-
"Whether to sort in ascending or descending order."
|
|
3526
|
-
).optional(),
|
|
3527
|
-
limit: z.number().int().describe(
|
|
3528
|
-
"Number of aggregation results to return.\nMin: `1`\nMax: `250`\nDefault: `10`"
|
|
3529
|
-
).optional().nullable(),
|
|
3530
|
-
missingValues: z.enum(["EXCLUDE", "INCLUDE"]).describe(
|
|
3531
|
-
"Whether missing values should be included or excluded from the aggregation results.\nDefault: `EXCLUDE`."
|
|
3532
|
-
).optional()
|
|
3533
|
-
}),
|
|
3534
|
-
z.xor([
|
|
3535
|
-
z.object({ includeOptions: z.never().optional() }),
|
|
3536
|
-
z.object({
|
|
3537
|
-
includeOptions: z.object({
|
|
3538
|
-
addToBucket: z.string().describe(
|
|
3539
|
-
'Specify a custom name for the bucket containing the missing values. Defaults are "N/A" for strings, "0" for integers, and "false" for booleans.'
|
|
3540
|
-
).max(1e3).optional()
|
|
3541
|
-
}).describe(
|
|
3542
|
-
"Options for including missing values in results."
|
|
3543
|
-
)
|
|
3544
|
-
})
|
|
3545
|
-
])
|
|
3546
|
-
).describe(
|
|
3547
|
-
'A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site.'
|
|
3548
|
-
)
|
|
3549
|
-
}),
|
|
3550
|
-
z.object({
|
|
3551
|
-
value: z.never().optional(),
|
|
3552
|
-
scalar: z.never().optional(),
|
|
3553
|
-
dateHistogram: z.never().optional(),
|
|
3554
|
-
nested: z.never().optional(),
|
|
3555
|
-
range: z.object({
|
|
3556
|
-
buckets: z.array(
|
|
3557
|
-
z.object({
|
|
3558
|
-
from: z.number().describe(
|
|
3559
|
-
"Inclusive lower bound of the range. Required if `to` is not provided."
|
|
3560
|
-
).optional().nullable(),
|
|
3561
|
-
to: z.number().describe(
|
|
3562
|
-
"Exclusive upper bound of the range. Required if `from` is not provided."
|
|
3563
|
-
).optional().nullable()
|
|
3564
|
-
})
|
|
3565
|
-
).max(1e3).optional()
|
|
3566
|
-
}).describe(
|
|
3567
|
-
"A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more."
|
|
3568
|
-
)
|
|
3569
|
-
}),
|
|
3570
|
-
z.object({
|
|
3571
|
-
value: z.never().optional(),
|
|
3572
|
-
range: z.never().optional(),
|
|
3573
|
-
dateHistogram: z.never().optional(),
|
|
3574
|
-
nested: z.never().optional(),
|
|
3575
|
-
scalar: z.object({
|
|
3576
|
-
type: z.enum([
|
|
3577
|
-
"UNKNOWN_SCALAR_TYPE",
|
|
3578
|
-
"COUNT_DISTINCT",
|
|
3579
|
-
"MIN",
|
|
3580
|
-
"MAX"
|
|
3581
|
-
]).describe("Operation type for the scalar aggregation.").optional()
|
|
3582
|
-
}).describe(
|
|
3583
|
-
"A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site."
|
|
3584
|
-
)
|
|
3585
|
-
}),
|
|
3586
|
-
z.object({
|
|
3587
|
-
value: z.never().optional(),
|
|
3588
|
-
range: z.never().optional(),
|
|
3589
|
-
scalar: z.never().optional(),
|
|
3590
|
-
nested: z.never().optional(),
|
|
3591
|
-
dateHistogram: z.object({
|
|
3592
|
-
interval: z.enum([
|
|
3593
|
-
"YEAR",
|
|
3594
|
-
"MONTH",
|
|
3595
|
-
"WEEK",
|
|
3596
|
-
"DAY",
|
|
3597
|
-
"HOUR",
|
|
3598
|
-
"MINUTE",
|
|
3599
|
-
"SECOND"
|
|
3600
|
-
]).describe("Interval for date histogram aggregation.").optional()
|
|
3601
|
-
}).describe(
|
|
3602
|
-
"A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week."
|
|
3603
|
-
)
|
|
3604
|
-
}),
|
|
3605
|
-
z.object({
|
|
3606
|
-
value: z.never().optional(),
|
|
3607
|
-
range: z.never().optional(),
|
|
3608
|
-
scalar: z.never().optional(),
|
|
3609
|
-
dateHistogram: z.never().optional(),
|
|
3610
|
-
nested: z.object({
|
|
3611
|
-
nestedAggregations: z.array(
|
|
3612
|
-
z.intersection(
|
|
3613
|
-
z.object({
|
|
3614
|
-
name: z.string().describe(
|
|
3615
|
-
"Aggregation name displayed in the return."
|
|
3616
|
-
).max(1e3).optional().nullable(),
|
|
3617
|
-
type: z.enum([
|
|
3618
|
-
"UNKNOWN_AGGREGATION_TYPE",
|
|
3619
|
-
"VALUE",
|
|
3620
|
-
"RANGE",
|
|
3621
|
-
"SCALAR",
|
|
3622
|
-
"DATE_HISTOGRAM"
|
|
3623
|
-
]).optional(),
|
|
3624
|
-
fieldPath: z.string().describe("Field to aggregate by.").max(1e3).optional()
|
|
3625
|
-
}),
|
|
3626
|
-
z.xor([
|
|
3627
|
-
z.object({
|
|
3628
|
-
value: z.never().optional(),
|
|
3629
|
-
range: z.never().optional(),
|
|
3630
|
-
scalar: z.never().optional(),
|
|
3631
|
-
dateHistogram: z.never().optional()
|
|
3632
|
-
}),
|
|
3633
|
-
z.object({
|
|
3634
|
-
range: z.never().optional(),
|
|
3635
|
-
scalar: z.never().optional(),
|
|
3636
|
-
dateHistogram: z.never().optional(),
|
|
3637
|
-
value: z.intersection(
|
|
3638
|
-
z.object({
|
|
3639
|
-
sortType: z.enum(["COUNT", "VALUE"]).describe(
|
|
3640
|
-
"Whether to sort by the number of matches or the value of the field."
|
|
3641
|
-
).optional(),
|
|
3642
|
-
sortDirection: z.enum(["DESC", "ASC"]).describe(
|
|
3643
|
-
"Whether to sort in ascending or descending order."
|
|
3644
|
-
).optional(),
|
|
3645
|
-
limit: z.number().int().describe(
|
|
3646
|
-
"Number of aggregation results to return.\nMin: `1`\nMax: `250`\nDefault: `10`"
|
|
3647
|
-
).optional().nullable(),
|
|
3648
|
-
missingValues: z.enum(["EXCLUDE", "INCLUDE"]).describe(
|
|
3649
|
-
"Whether missing values should be included or excluded from the aggregation results.\nDefault: `EXCLUDE`."
|
|
3650
|
-
).optional()
|
|
3651
|
-
}),
|
|
3652
|
-
z.xor([
|
|
3653
|
-
z.object({
|
|
3654
|
-
includeOptions: z.never().optional()
|
|
3655
|
-
}),
|
|
3656
|
-
z.object({
|
|
3657
|
-
includeOptions: z.object({
|
|
3658
|
-
addToBucket: z.string().describe(
|
|
3659
|
-
'Specify a custom name for the bucket containing the missing values. Defaults are "N/A" for strings, "0" for integers, and "false" for booleans.'
|
|
3660
|
-
).max(1e3).optional()
|
|
3661
|
-
}).describe(
|
|
3662
|
-
"Options for including missing values in results."
|
|
3663
|
-
)
|
|
3664
|
-
})
|
|
3665
|
-
])
|
|
3666
|
-
).describe(
|
|
3667
|
-
'A value aggregation calculates metrics such as "count" for specific fields within a dataset, providing insights into the overall distribution and key statistics of those values. For example, use a value aggregation to get the number of reservations (count) of each status that have been made on the site.'
|
|
3668
|
-
)
|
|
3669
|
-
}),
|
|
3670
|
-
z.object({
|
|
3671
|
-
value: z.never().optional(),
|
|
3672
|
-
scalar: z.never().optional(),
|
|
3673
|
-
dateHistogram: z.never().optional(),
|
|
3674
|
-
range: z.object({
|
|
3675
|
-
buckets: z.array(
|
|
3676
|
-
z.object({
|
|
3677
|
-
from: z.number().describe(
|
|
3678
|
-
"Inclusive lower bound of the range. Required if `to` is not provided."
|
|
3679
|
-
).optional().nullable(),
|
|
3680
|
-
to: z.number().describe(
|
|
3681
|
-
"Exclusive upper bound of the range. Required if `from` is not provided."
|
|
3682
|
-
).optional().nullable()
|
|
3683
|
-
})
|
|
3684
|
-
).max(1e3).optional()
|
|
3685
|
-
}).describe(
|
|
3686
|
-
"A range aggregation calculates the count of the values from the specified field in the dataset that fall within the range of each bucket you define. For example, use a range aggregation to compare the number of reservations made for parties of 4 or less to the number of reservations made for parties with 5 or more."
|
|
3687
|
-
)
|
|
3688
|
-
}),
|
|
3689
|
-
z.object({
|
|
3690
|
-
value: z.never().optional(),
|
|
3691
|
-
range: z.never().optional(),
|
|
3692
|
-
dateHistogram: z.never().optional(),
|
|
3693
|
-
scalar: z.object({
|
|
3694
|
-
type: z.enum([
|
|
3695
|
-
"UNKNOWN_SCALAR_TYPE",
|
|
3696
|
-
"COUNT_DISTINCT",
|
|
3697
|
-
"MIN",
|
|
3698
|
-
"MAX"
|
|
3699
|
-
]).describe(
|
|
3700
|
-
"Operation type for the scalar aggregation."
|
|
3701
|
-
).optional()
|
|
3702
|
-
}).describe(
|
|
3703
|
-
"A scalar aggregation calculates a single numerical value from a dataset, such as the total sum, average, min, or max, summarizing the dataset into one key metric. For example, use a scalar aggregation to get the average part size of reservations made on a site."
|
|
3704
|
-
)
|
|
3705
|
-
}),
|
|
3706
|
-
z.object({
|
|
3707
|
-
value: z.never().optional(),
|
|
3708
|
-
range: z.never().optional(),
|
|
3709
|
-
scalar: z.never().optional(),
|
|
3710
|
-
dateHistogram: z.object({
|
|
3711
|
-
interval: z.enum([
|
|
3712
|
-
"YEAR",
|
|
3713
|
-
"MONTH",
|
|
3714
|
-
"WEEK",
|
|
3715
|
-
"DAY",
|
|
3716
|
-
"HOUR",
|
|
3717
|
-
"MINUTE",
|
|
3718
|
-
"SECOND"
|
|
3719
|
-
]).describe(
|
|
3720
|
-
"Interval for date histogram aggregation."
|
|
3721
|
-
).optional()
|
|
3722
|
-
}).describe(
|
|
3723
|
-
"A date histogram calculates the count of time values from the specified field in the dataset that fall within each time interval you define (hour, day, week, etc.) For example, use a date histogram to find how many reservations have been made at a restaurant each week."
|
|
3724
|
-
)
|
|
3725
|
-
})
|
|
3726
|
-
])
|
|
3727
|
-
)
|
|
3728
|
-
).min(2).max(10).optional()
|
|
3729
|
-
}).describe(
|
|
3730
|
-
"A nested aggregation is applied within the results of another aggregation. Rather than aggregating directly on the primary dataset, first group data using one aggregation and then apply another aggregation within each group. It allows for more complex analyses where you can summarize data at different levels of detail or hierarchy.\nFor example, to get the number of reservations by party size for each week, first perform a date histogram aggregation on `details.startDate` with the interval `WEEK`, and a second value aggregation on `details.partySize`."
|
|
3731
|
-
)
|
|
3732
|
-
})
|
|
3733
|
-
])
|
|
3734
|
-
)
|
|
3735
|
-
).max(100).optional(),
|
|
3736
|
-
search: z.object({
|
|
3737
|
-
mode: z.enum(["OR", "AND"]).optional(),
|
|
3738
|
-
expression: z.string().describe("Search term or expression.").max(100).optional().nullable(),
|
|
3739
|
-
fields: z.array(z.string()).max(100).optional(),
|
|
3740
|
-
fuzzy: z.boolean().describe(
|
|
3741
|
-
"Whether to enable the search function to use an algorithm to automatically find results that are close to the search expression, such as typos and declensions."
|
|
3742
|
-
).optional()
|
|
3743
|
-
}).describe("Free text to match in searchable fields.").optional(),
|
|
3744
|
-
timeZone: z.string().describe(
|
|
3745
|
-
'Time zone to adjust date-time-based filters and aggregations, in ISO 8601 (including offsets) or IANA time zone database (including time zone IDs) format.\nApplies to all relevant filters and aggregations, unless overridden by providing timestamps including time zone. For example, "2023-12-20T10:52:34.795Z".'
|
|
3746
|
-
).max(100).optional().nullable()
|
|
3747
|
-
}),
|
|
3748
|
-
z.xor([
|
|
3749
|
-
z.object({ cursorPaging: z.never().optional() }),
|
|
3750
|
-
z.object({
|
|
3751
|
-
cursorPaging: z.object({
|
|
3752
|
-
limit: z.number().int().describe("Maximum number of items to return in the results.").min(0).max(100).optional().nullable(),
|
|
3753
|
-
cursor: z.string().describe(
|
|
3754
|
-
"Pointer to the next or previous page in the list of results.\n\nPass the relevant cursor token from the `pagingMetadata` object in the previous call's response.\nNot relevant for the first request."
|
|
3755
|
-
).max(16e3).optional().nullable()
|
|
3756
|
-
}).describe(
|
|
3757
|
-
"Cursor paging options.\n\nLearn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#cursor-paging)."
|
|
3758
|
-
)
|
|
3759
|
-
})
|
|
3760
|
-
])
|
|
3761
|
-
).describe("Search query.")
|
|
3762
|
-
});
|
|
3763
|
-
var SearchExperiencesResponse = z.object({
|
|
3764
|
-
experiences: z.array(
|
|
3765
|
-
z.object({
|
|
3766
|
-
_id: z.string().describe("Experience ID.").regex(
|
|
3767
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
3768
|
-
"Must be a valid GUID"
|
|
3769
|
-
).optional().nullable(),
|
|
3770
|
-
reservationLocationId: z.string().describe(
|
|
3771
|
-
"ID of the reservation location this experience is assigned to."
|
|
3772
|
-
).regex(
|
|
3773
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
3774
|
-
"Must be a valid GUID"
|
|
3775
|
-
).optional().nullable(),
|
|
3776
|
-
revision: z.string().regex(/^-?\d+$/, "Must be a valid Int64 string").describe(
|
|
3777
|
-
"Revision number, which increments by 1 each time the experience is updated.\nTo prevent conflicting changes, the current revision must be passed when updating the experience.\n\nIgnored when creating an experience."
|
|
3778
|
-
).optional().nullable(),
|
|
3779
|
-
_createdDate: z.date().describe("Date and time the experience was created.").optional().nullable(),
|
|
3780
|
-
_updatedDate: z.date().describe("Date and time the experience was last updated.").optional().nullable(),
|
|
3781
|
-
configuration: z.object({
|
|
3782
|
-
displayInfo: z.object({
|
|
3783
|
-
name: z.string().describe("Experience name.").min(1).max(120).optional().nullable(),
|
|
3784
|
-
shortDescription: z.string().describe("Brief description of the experience.").max(300).optional().nullable(),
|
|
3785
|
-
coverImage: z.string().describe("Cover image for the experience.").optional(),
|
|
3786
|
-
richContent: z.any().describe(
|
|
3787
|
-
"Detailed description of the experience using rich content formatting."
|
|
3788
|
-
).optional()
|
|
3789
|
-
}).describe("Display information for the experience.").optional(),
|
|
3790
|
-
paymentPolicy: z.intersection(
|
|
3791
|
-
z.object({
|
|
3792
|
-
paymentPolicyType: z.enum(["PER_GUEST", "FREE"]).describe("Payment policy type for the experience.").optional()
|
|
3793
|
-
}),
|
|
3794
|
-
z.xor([
|
|
3795
|
-
z.object({ perGuestOptions: z.never().optional() }),
|
|
3796
|
-
z.object({
|
|
3797
|
-
perGuestOptions: z.object({
|
|
3798
|
-
price: z.string().describe(
|
|
3799
|
-
'Monetary amount to charge. Decimal string with a period as a decimal separator. For example, `"3.99"`.'
|
|
3800
|
-
).optional().nullable()
|
|
3801
|
-
}).describe("Per-guest pricing settings.")
|
|
3802
|
-
})
|
|
3803
|
-
])
|
|
3804
|
-
).describe(
|
|
3805
|
-
"Payment policy for the experience. This policy determines how the restaurant charges for reservations."
|
|
3806
|
-
).optional(),
|
|
3807
|
-
onlineReservations: z.object({
|
|
3808
|
-
partySize: z.object({
|
|
3809
|
-
min: z.number().int().describe(
|
|
3810
|
-
"Minimum number of guests allowed for a reservation."
|
|
3811
|
-
).min(1).max(1e4).optional().nullable(),
|
|
3812
|
-
max: z.number().int().describe(
|
|
3813
|
-
"Maximum number of guests allowed for a reservation."
|
|
3814
|
-
).min(1).max(1e4).optional().nullable()
|
|
3815
|
-
}).describe("Party size.").optional(),
|
|
3816
|
-
minimumReservationNotice: z.object({
|
|
3817
|
-
number: z.number().int().describe(
|
|
3818
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
3819
|
-
).min(1).max(1e3).optional().nullable(),
|
|
3820
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
3821
|
-
}).describe("Minimum reservation notice.").optional(),
|
|
3822
|
-
maximumReservationNotice: z.object({
|
|
3823
|
-
number: z.number().int().describe(
|
|
3824
|
-
"Number of time units for the notice period. For example, `2` for 2 hours or `30` for 30 days."
|
|
3825
|
-
).min(1).max(1e3).optional().nullable(),
|
|
3826
|
-
unit: z.enum(["MINUTES", "HOURS", "DAYS"]).describe("Time unit for the notice period.").optional()
|
|
3827
|
-
}).describe("Maximum reservation notice.").optional(),
|
|
3828
|
-
approval: z.object({
|
|
3829
|
-
mode: z.enum(["AUTOMATIC", "MANUAL"]).describe("Approval mode.").optional()
|
|
3830
|
-
}).describe("Approval.").optional(),
|
|
3831
|
-
maxGuests: z.object({
|
|
3832
|
-
number: z.number().int().describe(
|
|
3833
|
-
"Maximum total number of guests that can have active reservations for this experience at the same time."
|
|
3834
|
-
).min(0).max(1e4).optional().nullable()
|
|
3835
|
-
}).describe("Maximum number of guests.").optional(),
|
|
3836
|
-
businessSchedule: z.object({
|
|
3837
|
-
durationInMinutes: z.number().int().describe("Duration of the experience in minutes.").min(1).max(1440).optional().nullable(),
|
|
3838
|
-
entries: z.array(
|
|
3839
|
-
z.intersection(
|
|
3840
|
-
z.object({
|
|
3841
|
-
recurrence: z.enum(["WEEKLY", "ONE_TIME"]).describe("Recurrence settings for this entry.").optional()
|
|
3842
|
-
}),
|
|
3843
|
-
z.xor([
|
|
3844
|
-
z.object({
|
|
3845
|
-
weeklyOptions: z.never().optional(),
|
|
3846
|
-
oneTimeOptions: z.never().optional()
|
|
3847
|
-
}),
|
|
3848
|
-
z.object({
|
|
3849
|
-
oneTimeOptions: z.never().optional(),
|
|
3850
|
-
weeklyOptions: z.object({
|
|
3851
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
3852
|
-
endDate: z.string().describe("End date.").optional().nullable(),
|
|
3853
|
-
startDaysAndTimes: z.array(
|
|
3854
|
-
z.object({
|
|
3855
|
-
day: z.enum([
|
|
3856
|
-
"MONDAY",
|
|
3857
|
-
"TUESDAY",
|
|
3858
|
-
"WEDNESDAY",
|
|
3859
|
-
"THURSDAY",
|
|
3860
|
-
"FRIDAY",
|
|
3861
|
-
"SATURDAY",
|
|
3862
|
-
"SUNDAY"
|
|
3863
|
-
]).describe("Day of week.").optional(),
|
|
3864
|
-
time: z.string().describe(
|
|
3865
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
3866
|
-
).max(5).min(5).optional().nullable()
|
|
3867
|
-
})
|
|
3868
|
-
).max(100).optional()
|
|
3869
|
-
}).describe("Weekly recurrence settings.")
|
|
3870
|
-
}),
|
|
3871
|
-
z.object({
|
|
3872
|
-
weeklyOptions: z.never().optional(),
|
|
3873
|
-
oneTimeOptions: z.object({
|
|
3874
|
-
startDate: z.string().describe("Start date.").optional().nullable(),
|
|
3875
|
-
startTime: z.string().describe(
|
|
3876
|
-
'Start time. ISO-8601 extended local time format (hh:mm). For example, `"11:00"`, or `"23:30"`.'
|
|
3877
|
-
).max(5).min(5).optional().nullable()
|
|
3878
|
-
}).describe("1-time event settings.")
|
|
3879
|
-
})
|
|
3880
|
-
])
|
|
3881
|
-
)
|
|
3882
|
-
).max(10).optional()
|
|
3883
|
-
}).describe("Business schedule.").optional()
|
|
3884
|
-
}).describe(
|
|
3885
|
-
"Settings for this experience that are used to determine restaurant availability for reservations made online."
|
|
3886
|
-
).optional(),
|
|
3887
|
-
reservationForm: z.object({
|
|
3888
|
-
submitMessage: z.string().describe(
|
|
3889
|
-
"Message displayed to customers when they submit the reservation form."
|
|
3890
|
-
).max(1e6).optional().nullable(),
|
|
3891
|
-
policiesEnabled: z.boolean().describe(
|
|
3892
|
-
"Whether to display privacy policy and terms and conditions to customers."
|
|
3893
|
-
).optional().nullable(),
|
|
3894
|
-
privacyPolicy: z.intersection(
|
|
3895
|
-
z.object({
|
|
3896
|
-
enabled: z.boolean().describe(
|
|
3897
|
-
"Whether the privacy policy is displayed to customers.\n\nDefault: `false`"
|
|
3898
|
-
).optional().nullable()
|
|
3899
|
-
}),
|
|
3900
|
-
z.xor([
|
|
3901
|
-
z.object({
|
|
3902
|
-
url: z.never().optional(),
|
|
3903
|
-
text: z.never().optional()
|
|
3904
|
-
}),
|
|
3905
|
-
z.object({
|
|
3906
|
-
text: z.never().optional(),
|
|
3907
|
-
url: z.string().describe("Privacy policy URL.")
|
|
3908
|
-
}),
|
|
3909
|
-
z.object({
|
|
3910
|
-
url: z.never().optional(),
|
|
3911
|
-
text: z.string().describe("Privacy policy text.").max(1e6)
|
|
3912
|
-
})
|
|
3913
|
-
])
|
|
3914
|
-
).describe("Privacy policy display settings.").optional(),
|
|
3915
|
-
termsAndConditions: z.intersection(
|
|
3916
|
-
z.object({
|
|
3917
|
-
enabled: z.boolean().describe(
|
|
3918
|
-
"Whether the terms and conditions are displayed to customers.\n\nDefault: `false`"
|
|
3919
|
-
).optional().nullable()
|
|
3920
|
-
}),
|
|
3921
|
-
z.xor([
|
|
3922
|
-
z.object({
|
|
3923
|
-
url: z.never().optional(),
|
|
3924
|
-
text: z.never().optional()
|
|
3925
|
-
}),
|
|
3926
|
-
z.object({
|
|
3927
|
-
text: z.never().optional(),
|
|
3928
|
-
url: z.string().describe("Terms and conditions URL.")
|
|
3929
|
-
}),
|
|
3930
|
-
z.object({
|
|
3931
|
-
url: z.never().optional(),
|
|
3932
|
-
text: z.string().describe("Terms and conditions text.").max(1e6)
|
|
3933
|
-
})
|
|
3934
|
-
])
|
|
3935
|
-
).describe("Terms and conditions display settings.").optional(),
|
|
3936
|
-
customFieldDefinitions: z.array(
|
|
3937
|
-
z.object({
|
|
3938
|
-
_id: z.string().describe("Custom field ID.").regex(
|
|
3939
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
3940
|
-
"Must be a valid GUID"
|
|
3941
|
-
).optional().nullable(),
|
|
3942
|
-
name: z.string().describe("Custom field name.").min(1).max(1e3).optional().nullable(),
|
|
3943
|
-
required: z.boolean().describe(
|
|
3944
|
-
"Whether the custom field is required.\n\nDefault: `false`"
|
|
3945
|
-
).optional().nullable()
|
|
3946
|
-
})
|
|
3947
|
-
).max(1e3).optional(),
|
|
3948
|
-
lastNameRequired: z.boolean().describe(
|
|
3949
|
-
"Whether a last name is required in the reservation form.\n\nDefault: `false`"
|
|
3950
|
-
).optional().nullable(),
|
|
3951
|
-
emailRequired: z.boolean().describe(
|
|
3952
|
-
"Whether an email is required in the reservation form.\n\nDefault: `false`"
|
|
3953
|
-
).optional().nullable(),
|
|
3954
|
-
emailMarketingCheckbox: z.object({
|
|
3955
|
-
enabled: z.boolean().describe(
|
|
3956
|
-
"Whether the email marketing checkbox is displayed to customers.\n\nDefault: `false`"
|
|
3957
|
-
).optional().nullable(),
|
|
3958
|
-
checkedByDefault: z.boolean().describe(
|
|
3959
|
-
"Whether the email marketing checkbox is checked by default.\n\nDefault: `false`"
|
|
3960
|
-
).optional().nullable()
|
|
3961
|
-
}).describe("Email marketing checkbox settings.").optional()
|
|
3962
|
-
}).describe(
|
|
3963
|
-
"Custom form fields and settings for the reservation booking form."
|
|
3964
|
-
).optional(),
|
|
3965
|
-
visible: z.boolean().describe("Whether the experience is visible on the live site.").optional().nullable()
|
|
3966
|
-
}).describe("Experience configuration.").optional(),
|
|
3967
|
-
currency: z.string().describe(
|
|
3968
|
-
"3-letter currency code in ISO-4217 alphabetic format. For exampled, `USD`."
|
|
3969
|
-
).optional().nullable(),
|
|
3970
|
-
extendedFields: z.object({
|
|
3971
|
-
namespaces: z.record(z.string(), z.record(z.string(), z.any())).describe(
|
|
3972
|
-
"Extended field data. Each key corresponds to the namespace of the app that created the extended fields.\nThe value of each key is structured according to the schema defined when the extended fields were configured.\n\nYou can only access fields for which you have the appropriate permissions.\n\nLearn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields)."
|
|
3973
|
-
).optional()
|
|
3974
|
-
}).describe("Extended fields.").optional(),
|
|
3975
|
-
tags: z.object({
|
|
3976
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
3977
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
3978
|
-
).optional(),
|
|
3979
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
3980
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
3981
|
-
).optional()
|
|
3982
|
-
}).describe(
|
|
3983
|
-
"Tags assigned to the experience. Tags must be created using the [Tags API](https://dev.wix.com/docs/api-reference/business-management/tags/introduction) before they can be assigned."
|
|
3984
|
-
).optional(),
|
|
3985
|
-
slug: z.string().describe(
|
|
3986
|
-
'URL-friendly identifier for the experience page, derived from the experience display name in kebab-case format (e.g., "wine-tasting-event"). Used to create readable URLs for the experience page.'
|
|
3987
|
-
).max(300).optional().nullable(),
|
|
3988
|
-
seoSettings: z.object({
|
|
3989
|
-
seoSchema: z.object({
|
|
3990
|
-
tags: z.array(
|
|
3991
|
-
z.object({
|
|
3992
|
-
type: z.string().describe(
|
|
3993
|
-
"SEO tag type.\n\n\nSupported values: `title`, `meta`, `script`, `link`."
|
|
3994
|
-
).optional(),
|
|
3995
|
-
props: z.record(z.string(), z.any()).describe(
|
|
3996
|
-
'A `{"key": "value"}` pair object where each SEO tag property (`"name"`, `"content"`, `"rel"`, `"href"`) contains a value.\nFor example: `{"name": "description", "content": "the description itself"}`.'
|
|
3997
|
-
).optional().nullable(),
|
|
3998
|
-
meta: z.record(z.string(), z.any()).describe(
|
|
3999
|
-
'SEO tag metadata. For example, `{"height": 300, "width": 240}`.'
|
|
4000
|
-
).optional().nullable(),
|
|
4001
|
-
children: z.string().describe(
|
|
4002
|
-
"SEO tag inner content. For example, `<title> inner content </title>`."
|
|
4003
|
-
).optional(),
|
|
4004
|
-
custom: z.boolean().describe(
|
|
4005
|
-
"Whether the tag is a [custom tag](https://support.wix.com/en/article/adding-additional-meta-tags-to-your-sites-pages)."
|
|
4006
|
-
).optional(),
|
|
4007
|
-
disabled: z.boolean().describe(
|
|
4008
|
-
"Whether the tag is disabled. If the tag is disabled, people can't find your page when searching for this phrase in search engines."
|
|
4009
|
-
).optional()
|
|
4010
|
-
})
|
|
4011
|
-
).optional(),
|
|
4012
|
-
settings: z.object({
|
|
4013
|
-
preventAutoRedirect: z.boolean().describe(
|
|
4014
|
-
"Whether the [automatical redirect visits](https://support.wix.com/en/article/customizing-your-pages-seo-settings-in-the-seo-panel) from the old URL to the new one is enabled.\n\n\nDefault: `false` (automatical redirect is enabled)."
|
|
4015
|
-
).optional(),
|
|
4016
|
-
keywords: z.array(
|
|
4017
|
-
z.object({
|
|
4018
|
-
term: z.string().describe("Keyword value.").optional(),
|
|
4019
|
-
isMain: z.boolean().describe(
|
|
4020
|
-
"Whether the keyword is the main focus keyword."
|
|
4021
|
-
).optional(),
|
|
4022
|
-
origin: z.string().describe(
|
|
4023
|
-
"The source that added the keyword terms to the SEO settings."
|
|
4024
|
-
).max(1e3).optional().nullable()
|
|
4025
|
-
})
|
|
4026
|
-
).max(5).optional()
|
|
4027
|
-
}).describe("SEO general settings.").optional()
|
|
4028
|
-
}).describe(
|
|
4029
|
-
"SEO schema data for customizing meta tags and search engine settings."
|
|
4030
|
-
).optional()
|
|
4031
|
-
}).describe("SEO settings for the experience page.").optional()
|
|
4032
|
-
})
|
|
4033
|
-
).optional(),
|
|
4034
|
-
pagingMetadata: z.object({
|
|
4035
|
-
count: z.number().int().describe("Number of items returned in current page.").optional().nullable(),
|
|
4036
|
-
cursors: z.object({
|
|
4037
|
-
next: z.string().describe(
|
|
4038
|
-
"Cursor string pointing to the next page in the list of results."
|
|
4039
|
-
).max(16e3).optional().nullable(),
|
|
4040
|
-
prev: z.string().describe(
|
|
4041
|
-
"Cursor pointing to the previous page in the list of results."
|
|
4042
|
-
).max(16e3).optional().nullable()
|
|
4043
|
-
}).describe(
|
|
4044
|
-
"Cursor strings that point to the next page, previous page, or both."
|
|
4045
|
-
).optional(),
|
|
4046
|
-
hasNext: z.boolean().describe(
|
|
4047
|
-
"Whether there are more pages to retrieve following the current page.\n\n+ `true`: Another page of results can be retrieved.\n+ `false`: This is the last page."
|
|
4048
|
-
).optional().nullable()
|
|
4049
|
-
}).describe("Cursor paging metadata.").optional(),
|
|
4050
|
-
aggregationData: z.object({
|
|
4051
|
-
results: z.array(
|
|
4052
|
-
z.intersection(
|
|
4053
|
-
z.object({
|
|
4054
|
-
name: z.string().describe("Aggregation name defined in the request.").max(1e3).optional(),
|
|
4055
|
-
type: z.enum([
|
|
4056
|
-
"UNKNOWN_AGGREGATION_TYPE",
|
|
4057
|
-
"VALUE",
|
|
4058
|
-
"RANGE",
|
|
4059
|
-
"SCALAR",
|
|
4060
|
-
"DATE_HISTOGRAM",
|
|
4061
|
-
"NESTED"
|
|
4062
|
-
]).describe("Type of aggregation that was performed.").optional(),
|
|
4063
|
-
fieldPath: z.string().describe("Field the data was aggregated by.").max(1e3).optional()
|
|
4064
|
-
}),
|
|
4065
|
-
z.xor([
|
|
4066
|
-
z.object({
|
|
4067
|
-
values: z.never().optional(),
|
|
4068
|
-
ranges: z.never().optional(),
|
|
4069
|
-
scalar: z.never().optional(),
|
|
4070
|
-
groupedByValue: z.never().optional(),
|
|
4071
|
-
dateHistogram: z.never().optional(),
|
|
4072
|
-
nested: z.never().optional()
|
|
4073
|
-
}),
|
|
4074
|
-
z.object({
|
|
4075
|
-
ranges: z.never().optional(),
|
|
4076
|
-
scalar: z.never().optional(),
|
|
4077
|
-
groupedByValue: z.never().optional(),
|
|
4078
|
-
dateHistogram: z.never().optional(),
|
|
4079
|
-
nested: z.never().optional(),
|
|
4080
|
-
values: z.object({
|
|
4081
|
-
results: z.array(
|
|
4082
|
-
z.object({
|
|
4083
|
-
value: z.string().describe("Value of the field").max(1e3).optional(),
|
|
4084
|
-
count: z.number().int().describe("Count of entities with this value").optional()
|
|
4085
|
-
})
|
|
4086
|
-
).max(1e3).optional()
|
|
4087
|
-
}).describe("Value aggregation results.")
|
|
4088
|
-
}),
|
|
4089
|
-
z.object({
|
|
4090
|
-
values: z.never().optional(),
|
|
4091
|
-
scalar: z.never().optional(),
|
|
4092
|
-
groupedByValue: z.never().optional(),
|
|
4093
|
-
dateHistogram: z.never().optional(),
|
|
4094
|
-
nested: z.never().optional(),
|
|
4095
|
-
ranges: z.object({
|
|
4096
|
-
results: z.array(
|
|
4097
|
-
z.object({
|
|
4098
|
-
from: z.number().describe("Inclusive lower bound of the range.").optional().nullable(),
|
|
4099
|
-
to: z.number().describe("Exclusive upper bound of the range.").optional().nullable(),
|
|
4100
|
-
count: z.number().int().describe("Count of entities in the range.").optional()
|
|
4101
|
-
})
|
|
4102
|
-
).max(1e3).optional()
|
|
4103
|
-
}).describe("Range aggregation results.")
|
|
4104
|
-
}),
|
|
4105
|
-
z.object({
|
|
4106
|
-
values: z.never().optional(),
|
|
4107
|
-
ranges: z.never().optional(),
|
|
4108
|
-
groupedByValue: z.never().optional(),
|
|
4109
|
-
dateHistogram: z.never().optional(),
|
|
4110
|
-
nested: z.never().optional(),
|
|
4111
|
-
scalar: z.object({
|
|
4112
|
-
type: z.enum([
|
|
4113
|
-
"UNKNOWN_SCALAR_TYPE",
|
|
4114
|
-
"COUNT_DISTINCT",
|
|
4115
|
-
"MIN",
|
|
4116
|
-
"MAX"
|
|
4117
|
-
]).describe("Type of scalar aggregation.").optional(),
|
|
4118
|
-
value: z.number().describe("Value of the scalar aggregation.").optional()
|
|
4119
|
-
}).describe("Scalar aggregation results.")
|
|
4120
|
-
}),
|
|
4121
|
-
z.object({
|
|
4122
|
-
values: z.never().optional(),
|
|
4123
|
-
ranges: z.never().optional(),
|
|
4124
|
-
scalar: z.never().optional(),
|
|
4125
|
-
dateHistogram: z.never().optional(),
|
|
4126
|
-
nested: z.never().optional(),
|
|
4127
|
-
groupedByValue: z.object({
|
|
4128
|
-
results: z.array(
|
|
4129
|
-
z.object({
|
|
4130
|
-
value: z.string().max(1e3).optional(),
|
|
4131
|
-
nestedResults: z.intersection(
|
|
4132
|
-
z.object({
|
|
4133
|
-
name: z.string().describe(
|
|
4134
|
-
"Aggregation name defined in the request."
|
|
4135
|
-
).max(1e3).optional(),
|
|
4136
|
-
type: z.enum([
|
|
4137
|
-
"UNKNOWN_AGGREGATION_TYPE",
|
|
4138
|
-
"VALUE",
|
|
4139
|
-
"RANGE",
|
|
4140
|
-
"SCALAR",
|
|
4141
|
-
"DATE_HISTOGRAM",
|
|
4142
|
-
"NESTED"
|
|
4143
|
-
]).describe("Type of aggregation performed.").optional(),
|
|
4144
|
-
fieldPath: z.string().describe("Field the data was aggregated by.").max(1e3).optional()
|
|
4145
|
-
}),
|
|
4146
|
-
z.xor([
|
|
4147
|
-
z.object({
|
|
4148
|
-
values: z.never().optional(),
|
|
4149
|
-
ranges: z.never().optional(),
|
|
4150
|
-
scalar: z.never().optional()
|
|
4151
|
-
}),
|
|
4152
|
-
z.object({
|
|
4153
|
-
ranges: z.never().optional(),
|
|
4154
|
-
scalar: z.never().optional(),
|
|
4155
|
-
values: z.object({
|
|
4156
|
-
results: z.array(
|
|
4157
|
-
z.object({
|
|
4158
|
-
value: z.string().describe("Value of the field").max(1e3).optional(),
|
|
4159
|
-
count: z.number().int().describe(
|
|
4160
|
-
"Count of entities with this value"
|
|
4161
|
-
).optional()
|
|
4162
|
-
})
|
|
4163
|
-
).max(1e3).optional()
|
|
4164
|
-
}).describe(
|
|
4165
|
-
"List of the value aggregation results."
|
|
4166
|
-
)
|
|
4167
|
-
}),
|
|
4168
|
-
z.object({
|
|
4169
|
-
values: z.never().optional(),
|
|
4170
|
-
scalar: z.never().optional(),
|
|
4171
|
-
ranges: z.object({
|
|
4172
|
-
results: z.array(
|
|
4173
|
-
z.object({
|
|
4174
|
-
from: z.number().describe(
|
|
4175
|
-
"Inclusive lower bound of the range."
|
|
4176
|
-
).optional().nullable(),
|
|
4177
|
-
to: z.number().describe(
|
|
4178
|
-
"Exclusive upper bound of the range."
|
|
4179
|
-
).optional().nullable(),
|
|
4180
|
-
count: z.number().int().describe(
|
|
4181
|
-
"Count of entities in the range."
|
|
4182
|
-
).optional()
|
|
4183
|
-
})
|
|
4184
|
-
).max(1e3).optional()
|
|
4185
|
-
}).describe(
|
|
4186
|
-
"List of the range aggregation results."
|
|
4187
|
-
)
|
|
4188
|
-
}),
|
|
4189
|
-
z.object({
|
|
4190
|
-
values: z.never().optional(),
|
|
4191
|
-
ranges: z.never().optional(),
|
|
4192
|
-
scalar: z.object({
|
|
4193
|
-
type: z.enum([
|
|
4194
|
-
"UNKNOWN_SCALAR_TYPE",
|
|
4195
|
-
"COUNT_DISTINCT",
|
|
4196
|
-
"MIN",
|
|
4197
|
-
"MAX"
|
|
4198
|
-
]).describe("Type of scalar aggregation.").optional(),
|
|
4199
|
-
value: z.number().describe(
|
|
4200
|
-
"Value of the scalar aggregation."
|
|
4201
|
-
).optional()
|
|
4202
|
-
}).describe(
|
|
4203
|
-
"List of the scalar aggregation results."
|
|
4204
|
-
)
|
|
4205
|
-
})
|
|
4206
|
-
])
|
|
4207
|
-
).optional()
|
|
4208
|
-
})
|
|
4209
|
-
).max(1e3).optional()
|
|
4210
|
-
}).describe("deprecated")
|
|
4211
|
-
}),
|
|
4212
|
-
z.object({
|
|
4213
|
-
values: z.never().optional(),
|
|
4214
|
-
ranges: z.never().optional(),
|
|
4215
|
-
scalar: z.never().optional(),
|
|
4216
|
-
groupedByValue: z.never().optional(),
|
|
4217
|
-
nested: z.never().optional(),
|
|
4218
|
-
dateHistogram: z.object({
|
|
4219
|
-
results: z.array(
|
|
4220
|
-
z.object({
|
|
4221
|
-
value: z.string().describe("Date in ISO 8601 format.").max(100).optional(),
|
|
4222
|
-
count: z.number().int().describe("Count of entities in the interval.").optional()
|
|
4223
|
-
})
|
|
4224
|
-
).max(200).optional()
|
|
4225
|
-
}).describe("Date histogram aggregation results.")
|
|
4226
|
-
}),
|
|
4227
|
-
z.object({
|
|
4228
|
-
values: z.never().optional(),
|
|
4229
|
-
ranges: z.never().optional(),
|
|
4230
|
-
scalar: z.never().optional(),
|
|
4231
|
-
groupedByValue: z.never().optional(),
|
|
4232
|
-
dateHistogram: z.never().optional(),
|
|
4233
|
-
nested: z.object({
|
|
4234
|
-
results: z.array(
|
|
4235
|
-
z.object({
|
|
4236
|
-
results: z.record(
|
|
4237
|
-
z.string(),
|
|
4238
|
-
z.intersection(
|
|
4239
|
-
z.object({}),
|
|
4240
|
-
z.xor([
|
|
4241
|
-
z.object({
|
|
4242
|
-
value: z.never().optional(),
|
|
4243
|
-
range: z.never().optional(),
|
|
4244
|
-
scalar: z.never().optional(),
|
|
4245
|
-
dateHistogram: z.never().optional()
|
|
4246
|
-
}),
|
|
4247
|
-
z.object({
|
|
4248
|
-
range: z.never().optional(),
|
|
4249
|
-
scalar: z.never().optional(),
|
|
4250
|
-
dateHistogram: z.never().optional(),
|
|
4251
|
-
value: z.object({
|
|
4252
|
-
value: z.string().describe("Value of the field.").max(1e3).optional(),
|
|
4253
|
-
count: z.number().int().describe(
|
|
4254
|
-
"Count of entities with this value."
|
|
4255
|
-
).optional().nullable()
|
|
4256
|
-
}).describe("Value aggregation results.")
|
|
4257
|
-
}),
|
|
4258
|
-
z.object({
|
|
4259
|
-
value: z.never().optional(),
|
|
4260
|
-
scalar: z.never().optional(),
|
|
4261
|
-
dateHistogram: z.never().optional(),
|
|
4262
|
-
range: z.object({
|
|
4263
|
-
from: z.number().describe(
|
|
4264
|
-
"Inclusive lower bound of the range."
|
|
4265
|
-
).optional().nullable(),
|
|
4266
|
-
to: z.number().describe(
|
|
4267
|
-
"Exclusive upper bound of the range."
|
|
4268
|
-
).optional().nullable(),
|
|
4269
|
-
count: z.number().int().describe(
|
|
4270
|
-
"Count of entities in the range."
|
|
4271
|
-
).optional().nullable()
|
|
4272
|
-
}).describe("Range aggregation results.")
|
|
4273
|
-
}),
|
|
4274
|
-
z.object({
|
|
4275
|
-
value: z.never().optional(),
|
|
4276
|
-
range: z.never().optional(),
|
|
4277
|
-
dateHistogram: z.never().optional(),
|
|
4278
|
-
scalar: z.object({
|
|
4279
|
-
value: z.number().describe(
|
|
4280
|
-
"Scalar aggregation results."
|
|
4281
|
-
).optional()
|
|
4282
|
-
}).describe("Scalar aggregation results.")
|
|
4283
|
-
}),
|
|
4284
|
-
z.object({
|
|
4285
|
-
value: z.never().optional(),
|
|
4286
|
-
range: z.never().optional(),
|
|
4287
|
-
scalar: z.never().optional(),
|
|
4288
|
-
dateHistogram: z.object({
|
|
4289
|
-
value: z.string().describe("Value of the field.").max(1e3).optional(),
|
|
4290
|
-
count: z.number().int().describe(
|
|
4291
|
-
"Count of entities with this value."
|
|
4292
|
-
).optional().nullable()
|
|
4293
|
-
}).describe(
|
|
4294
|
-
"Date histogram aggregation results."
|
|
4295
|
-
)
|
|
4296
|
-
})
|
|
4297
|
-
])
|
|
4298
|
-
)
|
|
4299
|
-
).describe("List of nested aggregation results.").optional()
|
|
4300
|
-
})
|
|
4301
|
-
).max(1e3).optional()
|
|
4302
|
-
}).describe("Nested aggregation results.")
|
|
4303
|
-
})
|
|
4304
|
-
])
|
|
4305
|
-
)
|
|
4306
|
-
).max(1e3).optional()
|
|
4307
|
-
}).describe("Aggregation data.").optional()
|
|
4308
|
-
});
|
|
4309
|
-
var BulkUpdateExperienceTagsRequest = z.object({
|
|
4310
|
-
experienceIds: z.array(z.string()).min(1).max(100),
|
|
4311
|
-
options: z.object({
|
|
4312
|
-
assignTags: z.object({
|
|
4313
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
4314
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
4315
|
-
).optional(),
|
|
4316
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
4317
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
4318
|
-
).optional()
|
|
4319
|
-
}).describe("Tags to assign to the experiences.").optional(),
|
|
4320
|
-
unassignTags: z.object({
|
|
4321
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
4322
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
4323
|
-
).optional(),
|
|
4324
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
4325
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
4326
|
-
).optional()
|
|
4327
|
-
}).describe("Tags to unassign from the experiences.").optional()
|
|
4328
|
-
}).optional()
|
|
4329
|
-
});
|
|
4330
|
-
var BulkUpdateExperienceTagsResponse = z.object({
|
|
4331
|
-
results: z.array(
|
|
4332
|
-
z.object({
|
|
4333
|
-
itemMetadata: z.object({
|
|
4334
|
-
_id: z.string().describe(
|
|
4335
|
-
"Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed."
|
|
4336
|
-
).regex(
|
|
4337
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
4338
|
-
"Must be a valid GUID"
|
|
4339
|
-
).optional().nullable(),
|
|
4340
|
-
originalIndex: z.number().int().describe(
|
|
4341
|
-
"Index of the item within the request array. Allows for correlation between request and response items."
|
|
4342
|
-
).min(0).optional(),
|
|
4343
|
-
success: z.boolean().describe(
|
|
4344
|
-
"Whether the requested action for this item was successful. When `false`, the `error` field is returned."
|
|
4345
|
-
).optional(),
|
|
4346
|
-
error: z.object({
|
|
4347
|
-
code: z.string().describe("Error code.").optional(),
|
|
4348
|
-
description: z.string().describe("Description of the error.").optional(),
|
|
4349
|
-
data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
|
|
4350
|
-
}).describe("Details about the error in case of failure.").optional()
|
|
4351
|
-
}).describe(
|
|
4352
|
-
"Metadata about the individual experience tag update operation."
|
|
4353
|
-
).optional()
|
|
4354
|
-
})
|
|
4355
|
-
).min(1).max(100).optional(),
|
|
4356
|
-
bulkActionMetadata: z.object({
|
|
4357
|
-
totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").min(0).optional(),
|
|
4358
|
-
totalFailures: z.number().int().describe("Number of items that couldn't be processed.").min(0).optional(),
|
|
4359
|
-
undetailedFailures: z.number().int().describe(
|
|
4360
|
-
"Number of failures without details because detailed failure threshold was exceeded."
|
|
4361
|
-
).min(0).optional()
|
|
4362
|
-
}).describe("Metadata about the bulk update operation.").optional()
|
|
4363
|
-
});
|
|
4364
|
-
var BulkUpdateExperienceTagsByFilterRequest = z.object({
|
|
4365
|
-
filter: z.record(z.string(), z.any()).describe("Filter criteria to select experiences for tag updates."),
|
|
4366
|
-
options: z.object({
|
|
4367
|
-
assignTags: z.object({
|
|
4368
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
4369
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
4370
|
-
).optional(),
|
|
4371
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
4372
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
4373
|
-
).optional()
|
|
4374
|
-
}).describe("Tags to assign to the filtered experiences.").optional(),
|
|
4375
|
-
unassignTags: z.object({
|
|
4376
|
-
privateTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
4377
|
-
"Tags that require an additional permission in order to access them, normally not given to site members or visitors."
|
|
4378
|
-
).optional(),
|
|
4379
|
-
publicTags: z.object({ tagIds: z.array(z.string()).max(100).optional() }).describe(
|
|
4380
|
-
"Tags that are exposed to anyone who has access to the labeled entity itself, including site members and visitors."
|
|
4381
|
-
).optional()
|
|
4382
|
-
}).describe("Tags to unassign from the filtered experiences.").optional()
|
|
4383
|
-
}).optional()
|
|
4384
|
-
});
|
|
4385
|
-
var BulkUpdateExperienceTagsByFilterResponse = z.object({
|
|
4386
|
-
jobId: z.string().describe("Job ID for tracking the asynchronous bulk update operation.").regex(
|
|
4387
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
4388
|
-
"Must be a valid GUID"
|
|
4389
|
-
).optional()
|
|
4390
|
-
});
|
|
4391
|
-
var BulkArchiveExperiencesRequest = z.object({
|
|
4392
|
-
experienceIds: z.array(z.string()).min(1).max(100)
|
|
4393
|
-
});
|
|
4394
|
-
var BulkArchiveExperiencesResponse = z.object({
|
|
4395
|
-
results: z.array(
|
|
4396
|
-
z.object({
|
|
4397
|
-
itemMetadata: z.object({
|
|
4398
|
-
_id: z.string().describe(
|
|
4399
|
-
"Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed."
|
|
4400
|
-
).regex(
|
|
4401
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
4402
|
-
"Must be a valid GUID"
|
|
4403
|
-
).optional().nullable(),
|
|
4404
|
-
originalIndex: z.number().int().describe(
|
|
4405
|
-
"Index of the item within the request array. Allows for correlation between request and response items."
|
|
4406
|
-
).min(0).optional(),
|
|
4407
|
-
success: z.boolean().describe(
|
|
4408
|
-
"Whether the requested action for this item was successful. When `false`, the `error` field is returned."
|
|
4409
|
-
).optional(),
|
|
4410
|
-
error: z.object({
|
|
4411
|
-
code: z.string().describe("Error code.").optional(),
|
|
4412
|
-
description: z.string().describe("Description of the error.").optional(),
|
|
4413
|
-
data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
|
|
4414
|
-
}).describe("Details about the error in case of failure.").optional()
|
|
4415
|
-
}).describe("Metadata about archiving the experience.").optional()
|
|
4416
|
-
})
|
|
4417
|
-
).min(1).max(100).optional(),
|
|
4418
|
-
bulkActionMetadata: z.object({
|
|
4419
|
-
totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").min(0).optional(),
|
|
4420
|
-
totalFailures: z.number().int().describe("Number of items that couldn't be processed.").min(0).optional(),
|
|
4421
|
-
undetailedFailures: z.number().int().describe(
|
|
4422
|
-
"Number of failures without details because detailed failure threshold was exceeded."
|
|
4423
|
-
).min(0).optional()
|
|
4424
|
-
}).describe("Bulk action metadata.").optional()
|
|
4425
|
-
});
|
|
4426
|
-
var BulkUnarchiveExperiencesRequest = z.object({
|
|
4427
|
-
experienceIds: z.array(z.string()).min(1).max(100)
|
|
4428
|
-
});
|
|
4429
|
-
var BulkUnarchiveExperiencesResponse = z.object({
|
|
4430
|
-
results: z.array(
|
|
4431
|
-
z.object({
|
|
4432
|
-
itemMetadata: z.object({
|
|
4433
|
-
_id: z.string().describe(
|
|
4434
|
-
"Item ID. Provided only whenever possible. For example, `itemId` can't be provided when item creation has failed."
|
|
4435
|
-
).regex(
|
|
4436
|
-
/^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/,
|
|
4437
|
-
"Must be a valid GUID"
|
|
4438
|
-
).optional().nullable(),
|
|
4439
|
-
originalIndex: z.number().int().describe(
|
|
4440
|
-
"Index of the item within the request array. Allows for correlation between request and response items."
|
|
4441
|
-
).min(0).optional(),
|
|
4442
|
-
success: z.boolean().describe(
|
|
4443
|
-
"Whether the requested action for this item was successful. When `false`, the `error` field is returned."
|
|
4444
|
-
).optional(),
|
|
4445
|
-
error: z.object({
|
|
4446
|
-
code: z.string().describe("Error code.").optional(),
|
|
4447
|
-
description: z.string().describe("Description of the error.").optional(),
|
|
4448
|
-
data: z.record(z.string(), z.any()).describe("Data related to the error.").optional().nullable()
|
|
4449
|
-
}).describe("Details about the error in case of failure.").optional()
|
|
4450
|
-
}).describe("Metadata about unarchiving the experience.").optional()
|
|
4451
|
-
})
|
|
4452
|
-
).min(1).max(100).optional(),
|
|
4453
|
-
bulkActionMetadata: z.object({
|
|
4454
|
-
totalSuccesses: z.number().int().describe("Number of items that were successfully processed.").min(0).optional(),
|
|
4455
|
-
totalFailures: z.number().int().describe("Number of items that couldn't be processed.").min(0).optional(),
|
|
4456
|
-
undetailedFailures: z.number().int().describe(
|
|
4457
|
-
"Number of failures without details because detailed failure threshold was exceeded."
|
|
4458
|
-
).min(0).optional()
|
|
4459
|
-
}).describe("Bulk action metadata.").optional()
|
|
4460
|
-
});
|
|
4461
|
-
|
|
4462
|
-
// src/table-reservations-v1-experience-experiences.universal.ts
|
|
4463
1548
|
var import_query_builder_utils = require("@wix/sdk-runtime/query-builder-utils");
|
|
4464
1549
|
var import_search_builder_utils = require("@wix/sdk-runtime/search-builder-utils");
|
|
4465
1550
|
var TableAvailabilityType = /* @__PURE__ */ ((TableAvailabilityType2) => {
|
|
@@ -4988,10 +2073,7 @@ var WebhookIdentityType = /* @__PURE__ */ ((WebhookIdentityType2) => {
|
|
|
4988
2073
|
return WebhookIdentityType2;
|
|
4989
2074
|
})(WebhookIdentityType || {});
|
|
4990
2075
|
async function createExperience2(experience) {
|
|
4991
|
-
const { httpClient, sideEffects
|
|
4992
|
-
if (validateRequestSchema) {
|
|
4993
|
-
CreateExperienceRequest.parse({ experience });
|
|
4994
|
-
}
|
|
2076
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
4995
2077
|
const payload = (0, import_transform_paths2.transformPaths)(
|
|
4996
2078
|
(0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ experience }, [
|
|
4997
2079
|
"experience.configuration.displayInfo.richContent"
|
|
@@ -5056,10 +2138,7 @@ async function createExperience2(experience) {
|
|
|
5056
2138
|
}
|
|
5057
2139
|
}
|
|
5058
2140
|
async function getExperience2(experienceId) {
|
|
5059
|
-
const { httpClient, sideEffects
|
|
5060
|
-
if (validateRequestSchema) {
|
|
5061
|
-
GetExperienceRequest.parse({ experienceId });
|
|
5062
|
-
}
|
|
2141
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
5063
2142
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)(
|
|
5064
2143
|
{ experienceId },
|
|
5065
2144
|
[]
|
|
@@ -5105,10 +2184,7 @@ async function getExperience2(experienceId) {
|
|
|
5105
2184
|
}
|
|
5106
2185
|
}
|
|
5107
2186
|
async function getExperienceBySlug2(slug) {
|
|
5108
|
-
const { httpClient, sideEffects
|
|
5109
|
-
if (validateRequestSchema) {
|
|
5110
|
-
GetExperienceBySlugRequest.parse({ slug });
|
|
5111
|
-
}
|
|
2187
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
5112
2188
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ slug }, []);
|
|
5113
2189
|
const reqOpts = getExperienceBySlug(payload);
|
|
5114
2190
|
sideEffects?.onSiteCall?.();
|
|
@@ -5151,10 +2227,7 @@ async function getExperienceBySlug2(slug) {
|
|
|
5151
2227
|
}
|
|
5152
2228
|
}
|
|
5153
2229
|
async function updateExperience2(_id, experience) {
|
|
5154
|
-
const { httpClient, sideEffects
|
|
5155
|
-
if (validateRequestSchema) {
|
|
5156
|
-
UpdateExperienceRequest.parse({ _id, experience });
|
|
5157
|
-
}
|
|
2230
|
+
const { httpClient, sideEffects } = arguments[2];
|
|
5158
2231
|
const payload = (0, import_transform_paths2.transformPaths)(
|
|
5159
2232
|
(0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)(
|
|
5160
2233
|
{ experience: { ...experience, id: _id } },
|
|
@@ -5283,10 +2356,7 @@ function queryExperiences2() {
|
|
|
5283
2356
|
});
|
|
5284
2357
|
}
|
|
5285
2358
|
async function typedQueryExperiences(query) {
|
|
5286
|
-
const { httpClient, sideEffects
|
|
5287
|
-
if (validateRequestSchema) {
|
|
5288
|
-
QueryExperiencesRequest.parse({ query });
|
|
5289
|
-
}
|
|
2359
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
5290
2360
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ query }, []);
|
|
5291
2361
|
const reqOpts = queryExperiences(payload);
|
|
5292
2362
|
sideEffects?.onSiteCall?.();
|
|
@@ -5337,10 +2407,7 @@ var utils = {
|
|
|
5337
2407
|
}
|
|
5338
2408
|
};
|
|
5339
2409
|
async function searchExperiences2(search) {
|
|
5340
|
-
const { httpClient, sideEffects
|
|
5341
|
-
if (validateRequestSchema) {
|
|
5342
|
-
SearchExperiencesRequest.parse({ search });
|
|
5343
|
-
}
|
|
2410
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
5344
2411
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)({ search }, []);
|
|
5345
2412
|
const reqOpts = searchExperiences(payload);
|
|
5346
2413
|
sideEffects?.onSiteCall?.();
|
|
@@ -5383,10 +2450,7 @@ async function searchExperiences2(search) {
|
|
|
5383
2450
|
}
|
|
5384
2451
|
}
|
|
5385
2452
|
async function bulkUpdateExperienceTags2(experienceIds, options) {
|
|
5386
|
-
const { httpClient, sideEffects
|
|
5387
|
-
if (validateRequestSchema) {
|
|
5388
|
-
BulkUpdateExperienceTagsRequest.parse({ experienceIds, options });
|
|
5389
|
-
}
|
|
2453
|
+
const { httpClient, sideEffects } = arguments[2];
|
|
5390
2454
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)(
|
|
5391
2455
|
{
|
|
5392
2456
|
experienceIds,
|
|
@@ -5422,10 +2486,7 @@ async function bulkUpdateExperienceTags2(experienceIds, options) {
|
|
|
5422
2486
|
}
|
|
5423
2487
|
}
|
|
5424
2488
|
async function bulkUpdateExperienceTagsByFilter2(filter, options) {
|
|
5425
|
-
const { httpClient, sideEffects
|
|
5426
|
-
if (validateRequestSchema) {
|
|
5427
|
-
BulkUpdateExperienceTagsByFilterRequest.parse({ filter, options });
|
|
5428
|
-
}
|
|
2489
|
+
const { httpClient, sideEffects } = arguments[2];
|
|
5429
2490
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)(
|
|
5430
2491
|
{
|
|
5431
2492
|
filter,
|
|
@@ -5461,10 +2522,7 @@ async function bulkUpdateExperienceTagsByFilter2(filter, options) {
|
|
|
5461
2522
|
}
|
|
5462
2523
|
}
|
|
5463
2524
|
async function bulkArchiveExperiences2(experienceIds) {
|
|
5464
|
-
const { httpClient, sideEffects
|
|
5465
|
-
if (validateRequestSchema) {
|
|
5466
|
-
BulkArchiveExperiencesRequest.parse({ experienceIds });
|
|
5467
|
-
}
|
|
2525
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
5468
2526
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)(
|
|
5469
2527
|
{ experienceIds },
|
|
5470
2528
|
[]
|
|
@@ -5490,10 +2548,7 @@ async function bulkArchiveExperiences2(experienceIds) {
|
|
|
5490
2548
|
}
|
|
5491
2549
|
}
|
|
5492
2550
|
async function bulkUnarchiveExperiences2(experienceIds) {
|
|
5493
|
-
const { httpClient, sideEffects
|
|
5494
|
-
if (validateRequestSchema) {
|
|
5495
|
-
BulkUnarchiveExperiencesRequest.parse({ experienceIds });
|
|
5496
|
-
}
|
|
2551
|
+
const { httpClient, sideEffects } = arguments[1];
|
|
5497
2552
|
const payload = (0, import_rename_all_nested_keys.renameKeysFromSDKRequestToRESTRequest)(
|
|
5498
2553
|
{ experienceIds },
|
|
5499
2554
|
[]
|