@savvycal/appointments-core 1.5.0 → 1.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.cts +578 -383
- package/dist/index.d.ts +578 -383
- package/package.json +2 -2
package/dist/index.d.cts
CHANGED
|
@@ -1479,6 +1479,8 @@ interface components {
|
|
|
1479
1479
|
* PublicAppointment
|
|
1480
1480
|
* @description A public appointment represents a booking that a client has made with a provider for a service.
|
|
1481
1481
|
* @example {
|
|
1482
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
1483
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
1482
1484
|
* "cancellation": {
|
|
1483
1485
|
* "allowed": true,
|
|
1484
1486
|
* "disabled_message": null
|
|
@@ -1491,8 +1493,10 @@ interface components {
|
|
|
1491
1493
|
* "unix_ts": 1736464800,
|
|
1492
1494
|
* "utc": "2025-03-01T04:00:00Z"
|
|
1493
1495
|
* },
|
|
1496
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
1494
1497
|
* "id": "appt_a1b2c3d4e5f6",
|
|
1495
1498
|
* "object": "public_appointment",
|
|
1499
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
1496
1500
|
* "rescheduling": {
|
|
1497
1501
|
* "allowed": false,
|
|
1498
1502
|
* "disabled_message": "Rescheduling is not available within 24 hours of your appointment"
|
|
@@ -1507,24 +1511,34 @@ interface components {
|
|
|
1507
1511
|
* "status": "scheduled",
|
|
1508
1512
|
* "urls": {
|
|
1509
1513
|
* "add_to_calendar": [
|
|
1510
|
-
* "https://
|
|
1514
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
1511
1515
|
* ],
|
|
1512
1516
|
* "add_to_google_calendar": [
|
|
1513
|
-
* "https://
|
|
1517
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
1514
1518
|
* ],
|
|
1515
1519
|
* "cancel": [
|
|
1516
|
-
* "https://
|
|
1520
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
1517
1521
|
* ],
|
|
1518
1522
|
* "ics": [
|
|
1519
|
-
* "https://
|
|
1523
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
1520
1524
|
* ],
|
|
1521
1525
|
* "reschedule": [
|
|
1522
|
-
* "https://
|
|
1526
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
1523
1527
|
* ]
|
|
1524
1528
|
* }
|
|
1525
1529
|
* }
|
|
1526
1530
|
*/
|
|
1527
1531
|
PublicAppointment: {
|
|
1532
|
+
/**
|
|
1533
|
+
* Format: uri
|
|
1534
|
+
* @description Canonical URL for adding the appointment to a calendar. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.
|
|
1535
|
+
*/
|
|
1536
|
+
add_to_calendar_url: string;
|
|
1537
|
+
/**
|
|
1538
|
+
* Format: uri
|
|
1539
|
+
* @description Canonical URL for canceling the appointment. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.
|
|
1540
|
+
*/
|
|
1541
|
+
cancel_url: string;
|
|
1528
1542
|
/** @description Information about whether the appointment can be canceled by the client. */
|
|
1529
1543
|
cancellation: {
|
|
1530
1544
|
/** @description Whether the appointment can be canceled by the client. */
|
|
@@ -1538,6 +1552,11 @@ interface components {
|
|
|
1538
1552
|
*/
|
|
1539
1553
|
confirmed_at: string | null;
|
|
1540
1554
|
end_at: components["schemas"]["ZonedDateTime"];
|
|
1555
|
+
/**
|
|
1556
|
+
* Format: uri
|
|
1557
|
+
* @description Canonical URL for downloading an ICS file for the appointment. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.
|
|
1558
|
+
*/
|
|
1559
|
+
ics_url: string;
|
|
1541
1560
|
/** @description Unique identifier for the object. */
|
|
1542
1561
|
id: string;
|
|
1543
1562
|
/**
|
|
@@ -1545,6 +1564,11 @@ interface components {
|
|
|
1545
1564
|
* @enum {string}
|
|
1546
1565
|
*/
|
|
1547
1566
|
object: "public_appointment";
|
|
1567
|
+
/**
|
|
1568
|
+
* Format: uri
|
|
1569
|
+
* @description Canonical URL for rescheduling the appointment. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.
|
|
1570
|
+
*/
|
|
1571
|
+
reschedule_url: string;
|
|
1548
1572
|
/** @description Information about whether the appointment can be rescheduled by the client. */
|
|
1549
1573
|
rescheduling: {
|
|
1550
1574
|
/** @description Whether the appointment can be rescheduled by the client. */
|
|
@@ -1558,17 +1582,15 @@ interface components {
|
|
|
1558
1582
|
* @enum {string}
|
|
1559
1583
|
*/
|
|
1560
1584
|
status: "scheduled" | "canceled";
|
|
1561
|
-
/**
|
|
1585
|
+
/**
|
|
1586
|
+
* @deprecated
|
|
1587
|
+
* @description Deprecated nested URL collections for this public appointment. Use the flat *_url fields instead.
|
|
1588
|
+
*/
|
|
1562
1589
|
urls: {
|
|
1563
|
-
/** @description URLs for adding the appointment to a calendar. */
|
|
1564
1590
|
add_to_calendar: string[];
|
|
1565
|
-
/** @description URLs for adding the appointment to Google Calendar. */
|
|
1566
1591
|
add_to_google_calendar: string[];
|
|
1567
|
-
/** @description URLs for canceling the appointment. */
|
|
1568
1592
|
cancel: string[];
|
|
1569
|
-
/** @description URLs for downloading an ICS file for the appointment. */
|
|
1570
1593
|
ics: string[];
|
|
1571
|
-
/** @description URLs for rescheduling the appointment. */
|
|
1572
1594
|
reschedule: string[];
|
|
1573
1595
|
};
|
|
1574
1596
|
};
|
|
@@ -1652,7 +1674,9 @@ interface components {
|
|
|
1652
1674
|
* @description This is an object representing data for the appointment rescheduled event.
|
|
1653
1675
|
* @example {
|
|
1654
1676
|
* "object": {
|
|
1677
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
1655
1678
|
* "appointment_type": "in_person",
|
|
1679
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
1656
1680
|
* "cancellation_events": [
|
|
1657
1681
|
* {
|
|
1658
1682
|
* "actor": null,
|
|
@@ -1687,6 +1711,9 @@ interface components {
|
|
|
1687
1711
|
* },
|
|
1688
1712
|
* "client_data": {
|
|
1689
1713
|
* "email": "jane.smith@example.com",
|
|
1714
|
+
* "fields": {
|
|
1715
|
+
* "age": 30
|
|
1716
|
+
* },
|
|
1690
1717
|
* "first_name": "Jane",
|
|
1691
1718
|
* "last_name": "Smith",
|
|
1692
1719
|
* "locale": "en-US",
|
|
@@ -1694,6 +1721,7 @@ interface components {
|
|
|
1694
1721
|
* "reference_id": "ext_12345",
|
|
1695
1722
|
* "time_zone": "America/Chicago"
|
|
1696
1723
|
* },
|
|
1724
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
1697
1725
|
* "confirmation_events": [
|
|
1698
1726
|
* {
|
|
1699
1727
|
* "actor": null,
|
|
@@ -1726,11 +1754,14 @@ interface components {
|
|
|
1726
1754
|
* "unix_ts": 1736464800,
|
|
1727
1755
|
* "utc": "2025-03-01T04:00:00Z"
|
|
1728
1756
|
* },
|
|
1757
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
1729
1758
|
* "id": "appt_a1b2c3d4e5f6",
|
|
1759
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
1730
1760
|
* "meeting": {
|
|
1731
1761
|
* "conferencing_provider": "zoom_admin",
|
|
1732
1762
|
* "error_message": null,
|
|
1733
1763
|
* "external_meeting_id": "82912345678",
|
|
1764
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
1734
1765
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
1735
1766
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
1736
1767
|
* "object": "appointment_meeting",
|
|
@@ -1802,6 +1833,7 @@ interface components {
|
|
|
1802
1833
|
* "source": "client_ui"
|
|
1803
1834
|
* }
|
|
1804
1835
|
* ],
|
|
1836
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
1805
1837
|
* "service": {
|
|
1806
1838
|
* "appointment_type": "in_person",
|
|
1807
1839
|
* "booking_policy": {
|
|
@@ -1895,23 +1927,26 @@ interface components {
|
|
|
1895
1927
|
* "status": "scheduled",
|
|
1896
1928
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
1897
1929
|
* "urls": {
|
|
1930
|
+
* "add_to_calendar": [
|
|
1931
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
1932
|
+
* ],
|
|
1898
1933
|
* "add_to_google_calendar": [
|
|
1899
|
-
* "https://
|
|
1934
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
1900
1935
|
* ],
|
|
1901
1936
|
* "cancel": [
|
|
1902
|
-
* "https://
|
|
1937
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
1903
1938
|
* ],
|
|
1904
1939
|
* "confirm": [
|
|
1905
|
-
* "https://
|
|
1940
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
1906
1941
|
* ],
|
|
1907
1942
|
* "ics": [
|
|
1908
|
-
* "https://
|
|
1943
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
1909
1944
|
* ],
|
|
1910
1945
|
* "join": [
|
|
1911
|
-
* "https://
|
|
1946
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
1912
1947
|
* ],
|
|
1913
1948
|
* "reschedule": [
|
|
1914
|
-
* "https://
|
|
1949
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
1915
1950
|
* ]
|
|
1916
1951
|
* }
|
|
1917
1952
|
* },
|
|
@@ -2232,6 +2267,9 @@ interface components {
|
|
|
2232
2267
|
* "client": null,
|
|
2233
2268
|
* "client_data": {
|
|
2234
2269
|
* "email": "jane@example.com",
|
|
2270
|
+
* "fields": {
|
|
2271
|
+
* "age": 30
|
|
2272
|
+
* },
|
|
2235
2273
|
* "first_name": "Jane",
|
|
2236
2274
|
* "last_name": "Doe",
|
|
2237
2275
|
* "locale": "en",
|
|
@@ -2439,7 +2477,9 @@ interface components {
|
|
|
2439
2477
|
* @description Emitted when meeting cancellation with the conferencing provider terminally fails. The `object.meeting.error_message` field carries the failure reason.
|
|
2440
2478
|
* @example {
|
|
2441
2479
|
* "object": {
|
|
2480
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
2442
2481
|
* "appointment_type": "in_person",
|
|
2482
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
2443
2483
|
* "cancellation_events": [
|
|
2444
2484
|
* {
|
|
2445
2485
|
* "actor": null,
|
|
@@ -2474,6 +2514,9 @@ interface components {
|
|
|
2474
2514
|
* },
|
|
2475
2515
|
* "client_data": {
|
|
2476
2516
|
* "email": "jane.smith@example.com",
|
|
2517
|
+
* "fields": {
|
|
2518
|
+
* "age": 30
|
|
2519
|
+
* },
|
|
2477
2520
|
* "first_name": "Jane",
|
|
2478
2521
|
* "last_name": "Smith",
|
|
2479
2522
|
* "locale": "en-US",
|
|
@@ -2481,6 +2524,7 @@ interface components {
|
|
|
2481
2524
|
* "reference_id": "ext_12345",
|
|
2482
2525
|
* "time_zone": "America/Chicago"
|
|
2483
2526
|
* },
|
|
2527
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
2484
2528
|
* "confirmation_events": [
|
|
2485
2529
|
* {
|
|
2486
2530
|
* "actor": null,
|
|
@@ -2513,11 +2557,14 @@ interface components {
|
|
|
2513
2557
|
* "unix_ts": 1736464800,
|
|
2514
2558
|
* "utc": "2025-03-01T04:00:00Z"
|
|
2515
2559
|
* },
|
|
2560
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
2516
2561
|
* "id": "appt_a1b2c3d4e5f6",
|
|
2562
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
2517
2563
|
* "meeting": {
|
|
2518
2564
|
* "conferencing_provider": "zoom_admin",
|
|
2519
2565
|
* "error_message": null,
|
|
2520
2566
|
* "external_meeting_id": "82912345678",
|
|
2567
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
2521
2568
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
2522
2569
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
2523
2570
|
* "object": "appointment_meeting",
|
|
@@ -2589,6 +2636,7 @@ interface components {
|
|
|
2589
2636
|
* "source": "client_ui"
|
|
2590
2637
|
* }
|
|
2591
2638
|
* ],
|
|
2639
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
2592
2640
|
* "service": {
|
|
2593
2641
|
* "appointment_type": "in_person",
|
|
2594
2642
|
* "booking_policy": {
|
|
@@ -2682,23 +2730,26 @@ interface components {
|
|
|
2682
2730
|
* "status": "scheduled",
|
|
2683
2731
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
2684
2732
|
* "urls": {
|
|
2733
|
+
* "add_to_calendar": [
|
|
2734
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
2735
|
+
* ],
|
|
2685
2736
|
* "add_to_google_calendar": [
|
|
2686
|
-
* "https://
|
|
2737
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
2687
2738
|
* ],
|
|
2688
2739
|
* "cancel": [
|
|
2689
|
-
* "https://
|
|
2740
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
2690
2741
|
* ],
|
|
2691
2742
|
* "confirm": [
|
|
2692
|
-
* "https://
|
|
2743
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
2693
2744
|
* ],
|
|
2694
2745
|
* "ics": [
|
|
2695
|
-
* "https://
|
|
2746
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
2696
2747
|
* ],
|
|
2697
2748
|
* "join": [
|
|
2698
|
-
* "https://
|
|
2749
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
2699
2750
|
* ],
|
|
2700
2751
|
* "reschedule": [
|
|
2701
|
-
* "https://
|
|
2752
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
2702
2753
|
* ]
|
|
2703
2754
|
* }
|
|
2704
2755
|
* },
|
|
@@ -2781,19 +2832,7 @@ interface components {
|
|
|
2781
2832
|
} | null;
|
|
2782
2833
|
} | null;
|
|
2783
2834
|
/** @description Progressive client data to collect during the booking flow. */
|
|
2784
|
-
client_data?:
|
|
2785
|
-
email?: string | null;
|
|
2786
|
-
/** @description A map of custom field key-value pairs. */
|
|
2787
|
-
fields?: {
|
|
2788
|
-
[key: string]: unknown;
|
|
2789
|
-
} | null;
|
|
2790
|
-
first_name?: string | null;
|
|
2791
|
-
last_name?: string | null;
|
|
2792
|
-
locale?: string | null;
|
|
2793
|
-
phone?: string | null;
|
|
2794
|
-
reference_id?: string | null;
|
|
2795
|
-
time_zone?: string | null;
|
|
2796
|
-
} | null;
|
|
2835
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
2797
2836
|
/** @description The ID of an existing client to link. */
|
|
2798
2837
|
client_id?: string | null;
|
|
2799
2838
|
/**
|
|
@@ -2847,6 +2886,9 @@ interface components {
|
|
|
2847
2886
|
* "client": null,
|
|
2848
2887
|
* "client_data": {
|
|
2849
2888
|
* "email": "jane@example.com",
|
|
2889
|
+
* "fields": {
|
|
2890
|
+
* "age": 30
|
|
2891
|
+
* },
|
|
2850
2892
|
* "first_name": "Jane",
|
|
2851
2893
|
* "last_name": "Doe",
|
|
2852
2894
|
* "locale": "en",
|
|
@@ -3439,6 +3481,9 @@ interface components {
|
|
|
3439
3481
|
* "client": null,
|
|
3440
3482
|
* "client_data": {
|
|
3441
3483
|
* "email": "jane@example.com",
|
|
3484
|
+
* "fields": {
|
|
3485
|
+
* "age": 30
|
|
3486
|
+
* },
|
|
3442
3487
|
* "first_name": "Jane",
|
|
3443
3488
|
* "last_name": "Doe",
|
|
3444
3489
|
* "locale": "en",
|
|
@@ -3793,19 +3838,7 @@ interface components {
|
|
|
3793
3838
|
/** @description When true, automatically assigns an available provider for the selected time slot if no provider_id is specified. */
|
|
3794
3839
|
auto_assign_provider?: boolean | null;
|
|
3795
3840
|
/** @description Progressive client data. Provided fields are merged with existing values. */
|
|
3796
|
-
client_data?:
|
|
3797
|
-
email?: string | null;
|
|
3798
|
-
/** @description A map of custom field key-value pairs. */
|
|
3799
|
-
fields?: {
|
|
3800
|
-
[key: string]: unknown;
|
|
3801
|
-
} | null;
|
|
3802
|
-
first_name?: string | null;
|
|
3803
|
-
last_name?: string | null;
|
|
3804
|
-
locale?: string | null;
|
|
3805
|
-
phone?: string | null;
|
|
3806
|
-
reference_id?: string | null;
|
|
3807
|
-
time_zone?: string | null;
|
|
3808
|
-
} | null;
|
|
3841
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
3809
3842
|
/** @description The ID of an existing client to link. */
|
|
3810
3843
|
client_id?: string | null;
|
|
3811
3844
|
/**
|
|
@@ -3886,6 +3919,9 @@ interface components {
|
|
|
3886
3919
|
* "client": null,
|
|
3887
3920
|
* "client_data": {
|
|
3888
3921
|
* "email": "jane@example.com",
|
|
3922
|
+
* "fields": {
|
|
3923
|
+
* "age": 30
|
|
3924
|
+
* },
|
|
3889
3925
|
* "first_name": "Jane",
|
|
3890
3926
|
* "last_name": "Doe",
|
|
3891
3927
|
* "locale": "en",
|
|
@@ -4250,6 +4286,9 @@ interface components {
|
|
|
4250
4286
|
* "client": null,
|
|
4251
4287
|
* "client_data": {
|
|
4252
4288
|
* "email": "jane@example.com",
|
|
4289
|
+
* "fields": {
|
|
4290
|
+
* "age": 30
|
|
4291
|
+
* },
|
|
4253
4292
|
* "first_name": "Jane",
|
|
4254
4293
|
* "last_name": "Doe",
|
|
4255
4294
|
* "locale": "en",
|
|
@@ -5020,7 +5059,9 @@ interface components {
|
|
|
5020
5059
|
* @description This is an object representing data for the appointment confirmed event.
|
|
5021
5060
|
* @example {
|
|
5022
5061
|
* "object": {
|
|
5062
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
5023
5063
|
* "appointment_type": "in_person",
|
|
5064
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
5024
5065
|
* "cancellation_events": [
|
|
5025
5066
|
* {
|
|
5026
5067
|
* "actor": null,
|
|
@@ -5055,6 +5096,9 @@ interface components {
|
|
|
5055
5096
|
* },
|
|
5056
5097
|
* "client_data": {
|
|
5057
5098
|
* "email": "jane.smith@example.com",
|
|
5099
|
+
* "fields": {
|
|
5100
|
+
* "age": 30
|
|
5101
|
+
* },
|
|
5058
5102
|
* "first_name": "Jane",
|
|
5059
5103
|
* "last_name": "Smith",
|
|
5060
5104
|
* "locale": "en-US",
|
|
@@ -5062,6 +5106,7 @@ interface components {
|
|
|
5062
5106
|
* "reference_id": "ext_12345",
|
|
5063
5107
|
* "time_zone": "America/Chicago"
|
|
5064
5108
|
* },
|
|
5109
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
5065
5110
|
* "confirmation_events": [
|
|
5066
5111
|
* {
|
|
5067
5112
|
* "actor": null,
|
|
@@ -5094,11 +5139,14 @@ interface components {
|
|
|
5094
5139
|
* "unix_ts": 1736464800,
|
|
5095
5140
|
* "utc": "2025-03-01T04:00:00Z"
|
|
5096
5141
|
* },
|
|
5142
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
5097
5143
|
* "id": "appt_a1b2c3d4e5f6",
|
|
5144
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
5098
5145
|
* "meeting": {
|
|
5099
5146
|
* "conferencing_provider": "zoom_admin",
|
|
5100
5147
|
* "error_message": null,
|
|
5101
5148
|
* "external_meeting_id": "82912345678",
|
|
5149
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
5102
5150
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
5103
5151
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
5104
5152
|
* "object": "appointment_meeting",
|
|
@@ -5170,6 +5218,7 @@ interface components {
|
|
|
5170
5218
|
* "source": "client_ui"
|
|
5171
5219
|
* }
|
|
5172
5220
|
* ],
|
|
5221
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
5173
5222
|
* "service": {
|
|
5174
5223
|
* "appointment_type": "in_person",
|
|
5175
5224
|
* "booking_policy": {
|
|
@@ -5263,23 +5312,26 @@ interface components {
|
|
|
5263
5312
|
* "status": "scheduled",
|
|
5264
5313
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
5265
5314
|
* "urls": {
|
|
5315
|
+
* "add_to_calendar": [
|
|
5316
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
5317
|
+
* ],
|
|
5266
5318
|
* "add_to_google_calendar": [
|
|
5267
|
-
* "https://
|
|
5319
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
5268
5320
|
* ],
|
|
5269
5321
|
* "cancel": [
|
|
5270
|
-
* "https://
|
|
5322
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
5271
5323
|
* ],
|
|
5272
5324
|
* "confirm": [
|
|
5273
|
-
* "https://
|
|
5325
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
5274
5326
|
* ],
|
|
5275
5327
|
* "ics": [
|
|
5276
|
-
* "https://
|
|
5328
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
5277
5329
|
* ],
|
|
5278
5330
|
* "join": [
|
|
5279
|
-
* "https://
|
|
5331
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
5280
5332
|
* ],
|
|
5281
5333
|
* "reschedule": [
|
|
5282
|
-
* "https://
|
|
5334
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
5283
5335
|
* ]
|
|
5284
5336
|
* }
|
|
5285
5337
|
* },
|
|
@@ -5461,7 +5513,9 @@ interface components {
|
|
|
5461
5513
|
* "created_at": "2025-03-12T12:34:55Z",
|
|
5462
5514
|
* "data": {
|
|
5463
5515
|
* "object": {
|
|
5516
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
5464
5517
|
* "appointment_type": "in_person",
|
|
5518
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
5465
5519
|
* "cancellation_events": [
|
|
5466
5520
|
* {
|
|
5467
5521
|
* "actor": null,
|
|
@@ -5496,6 +5550,9 @@ interface components {
|
|
|
5496
5550
|
* },
|
|
5497
5551
|
* "client_data": {
|
|
5498
5552
|
* "email": "jane.smith@example.com",
|
|
5553
|
+
* "fields": {
|
|
5554
|
+
* "age": 30
|
|
5555
|
+
* },
|
|
5499
5556
|
* "first_name": "Jane",
|
|
5500
5557
|
* "last_name": "Smith",
|
|
5501
5558
|
* "locale": "en-US",
|
|
@@ -5503,6 +5560,7 @@ interface components {
|
|
|
5503
5560
|
* "reference_id": "ext_12345",
|
|
5504
5561
|
* "time_zone": "America/Chicago"
|
|
5505
5562
|
* },
|
|
5563
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
5506
5564
|
* "confirmation_events": [
|
|
5507
5565
|
* {
|
|
5508
5566
|
* "actor": null,
|
|
@@ -5535,11 +5593,14 @@ interface components {
|
|
|
5535
5593
|
* "unix_ts": 1736464800,
|
|
5536
5594
|
* "utc": "2025-03-01T04:00:00Z"
|
|
5537
5595
|
* },
|
|
5596
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
5538
5597
|
* "id": "appt_a1b2c3d4e5f6",
|
|
5598
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
5539
5599
|
* "meeting": {
|
|
5540
5600
|
* "conferencing_provider": "zoom_admin",
|
|
5541
5601
|
* "error_message": null,
|
|
5542
5602
|
* "external_meeting_id": "82912345678",
|
|
5603
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
5543
5604
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
5544
5605
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
5545
5606
|
* "object": "appointment_meeting",
|
|
@@ -5611,6 +5672,7 @@ interface components {
|
|
|
5611
5672
|
* "source": "client_ui"
|
|
5612
5673
|
* }
|
|
5613
5674
|
* ],
|
|
5675
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
5614
5676
|
* "service": {
|
|
5615
5677
|
* "appointment_type": "in_person",
|
|
5616
5678
|
* "booking_policy": {
|
|
@@ -5704,23 +5766,26 @@ interface components {
|
|
|
5704
5766
|
* "status": "scheduled",
|
|
5705
5767
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
5706
5768
|
* "urls": {
|
|
5769
|
+
* "add_to_calendar": [
|
|
5770
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
5771
|
+
* ],
|
|
5707
5772
|
* "add_to_google_calendar": [
|
|
5708
|
-
* "https://
|
|
5773
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
5709
5774
|
* ],
|
|
5710
5775
|
* "cancel": [
|
|
5711
|
-
* "https://
|
|
5776
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
5712
5777
|
* ],
|
|
5713
5778
|
* "confirm": [
|
|
5714
|
-
* "https://
|
|
5779
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
5715
5780
|
* ],
|
|
5716
5781
|
* "ics": [
|
|
5717
|
-
* "https://
|
|
5782
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
5718
5783
|
* ],
|
|
5719
5784
|
* "join": [
|
|
5720
|
-
* "https://
|
|
5785
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
5721
5786
|
* ],
|
|
5722
5787
|
* "reschedule": [
|
|
5723
|
-
* "https://
|
|
5788
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
5724
5789
|
* ]
|
|
5725
5790
|
* }
|
|
5726
5791
|
* },
|
|
@@ -5804,19 +5869,7 @@ interface components {
|
|
|
5804
5869
|
} | null;
|
|
5805
5870
|
} | null;
|
|
5806
5871
|
/** @description Progressive client data. Provided fields are merged with existing values. */
|
|
5807
|
-
client_data?:
|
|
5808
|
-
email?: string | null;
|
|
5809
|
-
/** @description A map of custom field key-value pairs. */
|
|
5810
|
-
fields?: {
|
|
5811
|
-
[key: string]: unknown;
|
|
5812
|
-
} | null;
|
|
5813
|
-
first_name?: string | null;
|
|
5814
|
-
last_name?: string | null;
|
|
5815
|
-
locale?: string | null;
|
|
5816
|
-
phone?: string | null;
|
|
5817
|
-
reference_id?: string | null;
|
|
5818
|
-
time_zone?: string | null;
|
|
5819
|
-
} | null;
|
|
5872
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
5820
5873
|
/** @description The ID of an existing client to link. */
|
|
5821
5874
|
client_id?: string | null;
|
|
5822
5875
|
/**
|
|
@@ -5893,7 +5946,9 @@ interface components {
|
|
|
5893
5946
|
* @example {
|
|
5894
5947
|
* "data": [
|
|
5895
5948
|
* {
|
|
5949
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
5896
5950
|
* "appointment_type": "in_person",
|
|
5951
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
5897
5952
|
* "cancellation_events": [
|
|
5898
5953
|
* {
|
|
5899
5954
|
* "actor": null,
|
|
@@ -5928,6 +5983,9 @@ interface components {
|
|
|
5928
5983
|
* },
|
|
5929
5984
|
* "client_data": {
|
|
5930
5985
|
* "email": "jane.smith@example.com",
|
|
5986
|
+
* "fields": {
|
|
5987
|
+
* "age": 30
|
|
5988
|
+
* },
|
|
5931
5989
|
* "first_name": "Jane",
|
|
5932
5990
|
* "last_name": "Smith",
|
|
5933
5991
|
* "locale": "en-US",
|
|
@@ -5935,6 +5993,7 @@ interface components {
|
|
|
5935
5993
|
* "reference_id": "ext_12345",
|
|
5936
5994
|
* "time_zone": "America/Chicago"
|
|
5937
5995
|
* },
|
|
5996
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
5938
5997
|
* "confirmation_events": [
|
|
5939
5998
|
* {
|
|
5940
5999
|
* "actor": null,
|
|
@@ -5967,11 +6026,14 @@ interface components {
|
|
|
5967
6026
|
* "unix_ts": 1736464800,
|
|
5968
6027
|
* "utc": "2025-03-01T04:00:00Z"
|
|
5969
6028
|
* },
|
|
6029
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
5970
6030
|
* "id": "appt_a1b2c3d4e5f6",
|
|
6031
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
5971
6032
|
* "meeting": {
|
|
5972
6033
|
* "conferencing_provider": "zoom_admin",
|
|
5973
6034
|
* "error_message": null,
|
|
5974
6035
|
* "external_meeting_id": "82912345678",
|
|
6036
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
5975
6037
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
5976
6038
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
5977
6039
|
* "object": "appointment_meeting",
|
|
@@ -6043,6 +6105,7 @@ interface components {
|
|
|
6043
6105
|
* "source": "client_ui"
|
|
6044
6106
|
* }
|
|
6045
6107
|
* ],
|
|
6108
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
6046
6109
|
* "service": {
|
|
6047
6110
|
* "appointment_type": "in_person",
|
|
6048
6111
|
* "booking_policy": {
|
|
@@ -6136,23 +6199,26 @@ interface components {
|
|
|
6136
6199
|
* "status": "scheduled",
|
|
6137
6200
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
6138
6201
|
* "urls": {
|
|
6202
|
+
* "add_to_calendar": [
|
|
6203
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
6204
|
+
* ],
|
|
6139
6205
|
* "add_to_google_calendar": [
|
|
6140
|
-
* "https://
|
|
6206
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
6141
6207
|
* ],
|
|
6142
6208
|
* "cancel": [
|
|
6143
|
-
* "https://
|
|
6209
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
6144
6210
|
* ],
|
|
6145
6211
|
* "confirm": [
|
|
6146
|
-
* "https://
|
|
6212
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
6147
6213
|
* ],
|
|
6148
6214
|
* "ics": [
|
|
6149
|
-
* "https://
|
|
6215
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
6150
6216
|
* ],
|
|
6151
6217
|
* "join": [
|
|
6152
|
-
* "https://
|
|
6218
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
6153
6219
|
* ],
|
|
6154
6220
|
* "reschedule": [
|
|
6155
|
-
* "https://
|
|
6221
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
6156
6222
|
* ]
|
|
6157
6223
|
* }
|
|
6158
6224
|
* }
|
|
@@ -6436,7 +6502,9 @@ interface components {
|
|
|
6436
6502
|
* @description Response schema for a single appointment
|
|
6437
6503
|
* @example {
|
|
6438
6504
|
* "data": {
|
|
6505
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
6439
6506
|
* "appointment_type": "in_person",
|
|
6507
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
6440
6508
|
* "cancellation_events": [
|
|
6441
6509
|
* {
|
|
6442
6510
|
* "actor": null,
|
|
@@ -6471,6 +6539,9 @@ interface components {
|
|
|
6471
6539
|
* },
|
|
6472
6540
|
* "client_data": {
|
|
6473
6541
|
* "email": "jane.smith@example.com",
|
|
6542
|
+
* "fields": {
|
|
6543
|
+
* "age": 30
|
|
6544
|
+
* },
|
|
6474
6545
|
* "first_name": "Jane",
|
|
6475
6546
|
* "last_name": "Smith",
|
|
6476
6547
|
* "locale": "en-US",
|
|
@@ -6478,6 +6549,7 @@ interface components {
|
|
|
6478
6549
|
* "reference_id": "ext_12345",
|
|
6479
6550
|
* "time_zone": "America/Chicago"
|
|
6480
6551
|
* },
|
|
6552
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
6481
6553
|
* "confirmation_events": [
|
|
6482
6554
|
* {
|
|
6483
6555
|
* "actor": null,
|
|
@@ -6510,11 +6582,14 @@ interface components {
|
|
|
6510
6582
|
* "unix_ts": 1736464800,
|
|
6511
6583
|
* "utc": "2025-03-01T04:00:00Z"
|
|
6512
6584
|
* },
|
|
6585
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
6513
6586
|
* "id": "appt_a1b2c3d4e5f6",
|
|
6587
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
6514
6588
|
* "meeting": {
|
|
6515
6589
|
* "conferencing_provider": "zoom_admin",
|
|
6516
6590
|
* "error_message": null,
|
|
6517
6591
|
* "external_meeting_id": "82912345678",
|
|
6592
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
6518
6593
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
6519
6594
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
6520
6595
|
* "object": "appointment_meeting",
|
|
@@ -6586,6 +6661,7 @@ interface components {
|
|
|
6586
6661
|
* "source": "client_ui"
|
|
6587
6662
|
* }
|
|
6588
6663
|
* ],
|
|
6664
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
6589
6665
|
* "service": {
|
|
6590
6666
|
* "appointment_type": "in_person",
|
|
6591
6667
|
* "booking_policy": {
|
|
@@ -6679,23 +6755,26 @@ interface components {
|
|
|
6679
6755
|
* "status": "scheduled",
|
|
6680
6756
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
6681
6757
|
* "urls": {
|
|
6758
|
+
* "add_to_calendar": [
|
|
6759
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
6760
|
+
* ],
|
|
6682
6761
|
* "add_to_google_calendar": [
|
|
6683
|
-
* "https://
|
|
6762
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
6684
6763
|
* ],
|
|
6685
6764
|
* "cancel": [
|
|
6686
|
-
* "https://
|
|
6765
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
6687
6766
|
* ],
|
|
6688
6767
|
* "confirm": [
|
|
6689
|
-
* "https://
|
|
6768
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
6690
6769
|
* ],
|
|
6691
6770
|
* "ics": [
|
|
6692
|
-
* "https://
|
|
6771
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
6693
6772
|
* ],
|
|
6694
6773
|
* "join": [
|
|
6695
|
-
* "https://
|
|
6774
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
6696
6775
|
* ],
|
|
6697
6776
|
* "reschedule": [
|
|
6698
|
-
* "https://
|
|
6777
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
6699
6778
|
* ]
|
|
6700
6779
|
* }
|
|
6701
6780
|
* }
|
|
@@ -7146,7 +7225,9 @@ interface components {
|
|
|
7146
7225
|
* @description Emitted when *initial* meeting creation with the conferencing provider terminally fails. The `object.meeting.error_message` field carries the failure reason.
|
|
7147
7226
|
* @example {
|
|
7148
7227
|
* "object": {
|
|
7228
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
7149
7229
|
* "appointment_type": "in_person",
|
|
7230
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
7150
7231
|
* "cancellation_events": [
|
|
7151
7232
|
* {
|
|
7152
7233
|
* "actor": null,
|
|
@@ -7181,6 +7262,9 @@ interface components {
|
|
|
7181
7262
|
* },
|
|
7182
7263
|
* "client_data": {
|
|
7183
7264
|
* "email": "jane.smith@example.com",
|
|
7265
|
+
* "fields": {
|
|
7266
|
+
* "age": 30
|
|
7267
|
+
* },
|
|
7184
7268
|
* "first_name": "Jane",
|
|
7185
7269
|
* "last_name": "Smith",
|
|
7186
7270
|
* "locale": "en-US",
|
|
@@ -7188,6 +7272,7 @@ interface components {
|
|
|
7188
7272
|
* "reference_id": "ext_12345",
|
|
7189
7273
|
* "time_zone": "America/Chicago"
|
|
7190
7274
|
* },
|
|
7275
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
7191
7276
|
* "confirmation_events": [
|
|
7192
7277
|
* {
|
|
7193
7278
|
* "actor": null,
|
|
@@ -7220,11 +7305,14 @@ interface components {
|
|
|
7220
7305
|
* "unix_ts": 1736464800,
|
|
7221
7306
|
* "utc": "2025-03-01T04:00:00Z"
|
|
7222
7307
|
* },
|
|
7308
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
7223
7309
|
* "id": "appt_a1b2c3d4e5f6",
|
|
7310
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
7224
7311
|
* "meeting": {
|
|
7225
7312
|
* "conferencing_provider": "zoom_admin",
|
|
7226
7313
|
* "error_message": null,
|
|
7227
7314
|
* "external_meeting_id": "82912345678",
|
|
7315
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
7228
7316
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
7229
7317
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
7230
7318
|
* "object": "appointment_meeting",
|
|
@@ -7296,6 +7384,7 @@ interface components {
|
|
|
7296
7384
|
* "source": "client_ui"
|
|
7297
7385
|
* }
|
|
7298
7386
|
* ],
|
|
7387
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
7299
7388
|
* "service": {
|
|
7300
7389
|
* "appointment_type": "in_person",
|
|
7301
7390
|
* "booking_policy": {
|
|
@@ -7389,23 +7478,26 @@ interface components {
|
|
|
7389
7478
|
* "status": "scheduled",
|
|
7390
7479
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
7391
7480
|
* "urls": {
|
|
7481
|
+
* "add_to_calendar": [
|
|
7482
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
7483
|
+
* ],
|
|
7392
7484
|
* "add_to_google_calendar": [
|
|
7393
|
-
* "https://
|
|
7485
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
7394
7486
|
* ],
|
|
7395
7487
|
* "cancel": [
|
|
7396
|
-
* "https://
|
|
7488
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
7397
7489
|
* ],
|
|
7398
7490
|
* "confirm": [
|
|
7399
|
-
* "https://
|
|
7491
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
7400
7492
|
* ],
|
|
7401
7493
|
* "ics": [
|
|
7402
|
-
* "https://
|
|
7494
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
7403
7495
|
* ],
|
|
7404
7496
|
* "join": [
|
|
7405
|
-
* "https://
|
|
7497
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
7406
7498
|
* ],
|
|
7407
7499
|
* "reschedule": [
|
|
7408
|
-
* "https://
|
|
7500
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
7409
7501
|
* ]
|
|
7410
7502
|
* }
|
|
7411
7503
|
* },
|
|
@@ -7435,19 +7527,7 @@ interface components {
|
|
|
7435
7527
|
/** @description When true, automatically assigns an available provider for the selected time slot if no provider_id is specified. */
|
|
7436
7528
|
auto_assign_provider?: boolean | null;
|
|
7437
7529
|
/** @description Progressive client data. Provided fields are merged with existing values. */
|
|
7438
|
-
client_data?:
|
|
7439
|
-
email?: string | null;
|
|
7440
|
-
/** @description A map of custom field key-value pairs. */
|
|
7441
|
-
fields?: {
|
|
7442
|
-
[key: string]: unknown;
|
|
7443
|
-
} | null;
|
|
7444
|
-
first_name?: string | null;
|
|
7445
|
-
last_name?: string | null;
|
|
7446
|
-
locale?: string | null;
|
|
7447
|
-
phone?: string | null;
|
|
7448
|
-
reference_id?: string | null;
|
|
7449
|
-
time_zone?: string | null;
|
|
7450
|
-
} | null;
|
|
7530
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
7451
7531
|
/**
|
|
7452
7532
|
* Format: date-time
|
|
7453
7533
|
* @description The end time of the slot as an ISO-8601 datetime string with a timezone offset.
|
|
@@ -7525,6 +7605,61 @@ interface components {
|
|
|
7525
7605
|
data: components["schemas"]["ProviderSchedule"][];
|
|
7526
7606
|
meta: components["schemas"]["PaginationMeta"];
|
|
7527
7607
|
};
|
|
7608
|
+
/**
|
|
7609
|
+
* AppointmentClientDataInput
|
|
7610
|
+
* @description Information about the client booking the appointment. You can either provide an `id` or `reference_id` for an existing client,
|
|
7611
|
+
* or provide a new client's details.
|
|
7612
|
+
* @example {
|
|
7613
|
+
* "email": "john.doe@example.com",
|
|
7614
|
+
* "fields": {
|
|
7615
|
+
* "age": 30
|
|
7616
|
+
* },
|
|
7617
|
+
* "first_name": "John",
|
|
7618
|
+
* "last_name": "Doe",
|
|
7619
|
+
* "locale": "en-US",
|
|
7620
|
+
* "phone": "+15551234567",
|
|
7621
|
+
* "reference_id": "1234567890",
|
|
7622
|
+
* "time_zone": "America/New_York"
|
|
7623
|
+
* }
|
|
7624
|
+
*/
|
|
7625
|
+
AppointmentClientDataInput: {
|
|
7626
|
+
/**
|
|
7627
|
+
* Format: email
|
|
7628
|
+
* @description The client's email address. Required if no existing client is provided.
|
|
7629
|
+
*/
|
|
7630
|
+
email?: string | null;
|
|
7631
|
+
/** @description A map of custom field values to set on the client, keyed by field slug. Each key must correspond to a Client Field that has been defined in the account; arbitrary key-value pairs are not accepted. */
|
|
7632
|
+
fields?: {
|
|
7633
|
+
[key: string]: unknown;
|
|
7634
|
+
} | null;
|
|
7635
|
+
/** @description The client's first name. Required if no existing client is provided. */
|
|
7636
|
+
first_name?: string | null;
|
|
7637
|
+
/**
|
|
7638
|
+
* @description The ID of an existing client to attach to the appointment. If not provided, a new client will be created
|
|
7639
|
+
* if the `reference_id` does not correspond to an existing client. If there does exist a client with
|
|
7640
|
+
* the `reference_id` provided, the existing client will be attached to the appointment.
|
|
7641
|
+
*/
|
|
7642
|
+
id?: string | null;
|
|
7643
|
+
/** @description The client's last name. Required if no existing client is provided. */
|
|
7644
|
+
last_name?: string | null;
|
|
7645
|
+
/**
|
|
7646
|
+
* @description The locale of the client booking the appointment.
|
|
7647
|
+
* @example en-US
|
|
7648
|
+
*/
|
|
7649
|
+
locale?: string | null;
|
|
7650
|
+
/**
|
|
7651
|
+
* @description The client's phone number (E.164 format).
|
|
7652
|
+
* @example +1234567890
|
|
7653
|
+
*/
|
|
7654
|
+
phone?: string | null;
|
|
7655
|
+
/** @description External reference identifier for the client. */
|
|
7656
|
+
reference_id?: string | null;
|
|
7657
|
+
/**
|
|
7658
|
+
* @description The client's time zone (IANA format). This field will be used to represent the appointment time slot in the client's local time zone (in the event that it differs from the appointment's local time zone).
|
|
7659
|
+
* @example America/New_York
|
|
7660
|
+
*/
|
|
7661
|
+
time_zone: string;
|
|
7662
|
+
};
|
|
7528
7663
|
/**
|
|
7529
7664
|
* NotFoundResponse
|
|
7530
7665
|
* @description Response schema for not found requests
|
|
@@ -7556,7 +7691,9 @@ interface components {
|
|
|
7556
7691
|
* @description Emitted when the *replacement* meeting created during a meeting replace (typically following a reschedule that changed the primary provider) terminally fails at the conferencing provider. Distinct from `appointment.meeting.create_failed` (initial-creation failure): the appointment previously had a working meeting (now superseded), and the replacement attempt failed. The `object.meeting.error_message` field carries the failure reason.
|
|
7557
7692
|
* @example {
|
|
7558
7693
|
* "object": {
|
|
7694
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
7559
7695
|
* "appointment_type": "in_person",
|
|
7696
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
7560
7697
|
* "cancellation_events": [
|
|
7561
7698
|
* {
|
|
7562
7699
|
* "actor": null,
|
|
@@ -7591,6 +7728,9 @@ interface components {
|
|
|
7591
7728
|
* },
|
|
7592
7729
|
* "client_data": {
|
|
7593
7730
|
* "email": "jane.smith@example.com",
|
|
7731
|
+
* "fields": {
|
|
7732
|
+
* "age": 30
|
|
7733
|
+
* },
|
|
7594
7734
|
* "first_name": "Jane",
|
|
7595
7735
|
* "last_name": "Smith",
|
|
7596
7736
|
* "locale": "en-US",
|
|
@@ -7598,6 +7738,7 @@ interface components {
|
|
|
7598
7738
|
* "reference_id": "ext_12345",
|
|
7599
7739
|
* "time_zone": "America/Chicago"
|
|
7600
7740
|
* },
|
|
7741
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
7601
7742
|
* "confirmation_events": [
|
|
7602
7743
|
* {
|
|
7603
7744
|
* "actor": null,
|
|
@@ -7630,11 +7771,14 @@ interface components {
|
|
|
7630
7771
|
* "unix_ts": 1736464800,
|
|
7631
7772
|
* "utc": "2025-03-01T04:00:00Z"
|
|
7632
7773
|
* },
|
|
7774
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
7633
7775
|
* "id": "appt_a1b2c3d4e5f6",
|
|
7776
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
7634
7777
|
* "meeting": {
|
|
7635
7778
|
* "conferencing_provider": "zoom_admin",
|
|
7636
7779
|
* "error_message": null,
|
|
7637
7780
|
* "external_meeting_id": "82912345678",
|
|
7781
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
7638
7782
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
7639
7783
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
7640
7784
|
* "object": "appointment_meeting",
|
|
@@ -7706,6 +7850,7 @@ interface components {
|
|
|
7706
7850
|
* "source": "client_ui"
|
|
7707
7851
|
* }
|
|
7708
7852
|
* ],
|
|
7853
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
7709
7854
|
* "service": {
|
|
7710
7855
|
* "appointment_type": "in_person",
|
|
7711
7856
|
* "booking_policy": {
|
|
@@ -7799,23 +7944,26 @@ interface components {
|
|
|
7799
7944
|
* "status": "scheduled",
|
|
7800
7945
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
7801
7946
|
* "urls": {
|
|
7947
|
+
* "add_to_calendar": [
|
|
7948
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
7949
|
+
* ],
|
|
7802
7950
|
* "add_to_google_calendar": [
|
|
7803
|
-
* "https://
|
|
7951
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
7804
7952
|
* ],
|
|
7805
7953
|
* "cancel": [
|
|
7806
|
-
* "https://
|
|
7954
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
7807
7955
|
* ],
|
|
7808
7956
|
* "confirm": [
|
|
7809
|
-
* "https://
|
|
7957
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
7810
7958
|
* ],
|
|
7811
7959
|
* "ics": [
|
|
7812
|
-
* "https://
|
|
7960
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
7813
7961
|
* ],
|
|
7814
7962
|
* "join": [
|
|
7815
|
-
* "https://
|
|
7963
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
7816
7964
|
* ],
|
|
7817
7965
|
* "reschedule": [
|
|
7818
|
-
* "https://
|
|
7966
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
7819
7967
|
* ]
|
|
7820
7968
|
* }
|
|
7821
7969
|
* },
|
|
@@ -7976,7 +8124,9 @@ interface components {
|
|
|
7976
8124
|
* @description Emitted asynchronously after a meeting was successfully created with the conferencing provider. The `object.meeting` field carries the populated meeting details.
|
|
7977
8125
|
* @example {
|
|
7978
8126
|
* "object": {
|
|
8127
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
7979
8128
|
* "appointment_type": "in_person",
|
|
8129
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
7980
8130
|
* "cancellation_events": [
|
|
7981
8131
|
* {
|
|
7982
8132
|
* "actor": null,
|
|
@@ -8011,6 +8161,9 @@ interface components {
|
|
|
8011
8161
|
* },
|
|
8012
8162
|
* "client_data": {
|
|
8013
8163
|
* "email": "jane.smith@example.com",
|
|
8164
|
+
* "fields": {
|
|
8165
|
+
* "age": 30
|
|
8166
|
+
* },
|
|
8014
8167
|
* "first_name": "Jane",
|
|
8015
8168
|
* "last_name": "Smith",
|
|
8016
8169
|
* "locale": "en-US",
|
|
@@ -8018,6 +8171,7 @@ interface components {
|
|
|
8018
8171
|
* "reference_id": "ext_12345",
|
|
8019
8172
|
* "time_zone": "America/Chicago"
|
|
8020
8173
|
* },
|
|
8174
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
8021
8175
|
* "confirmation_events": [
|
|
8022
8176
|
* {
|
|
8023
8177
|
* "actor": null,
|
|
@@ -8050,11 +8204,14 @@ interface components {
|
|
|
8050
8204
|
* "unix_ts": 1736464800,
|
|
8051
8205
|
* "utc": "2025-03-01T04:00:00Z"
|
|
8052
8206
|
* },
|
|
8207
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
8053
8208
|
* "id": "appt_a1b2c3d4e5f6",
|
|
8209
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
8054
8210
|
* "meeting": {
|
|
8055
8211
|
* "conferencing_provider": "zoom_admin",
|
|
8056
8212
|
* "error_message": null,
|
|
8057
8213
|
* "external_meeting_id": "82912345678",
|
|
8214
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
8058
8215
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
8059
8216
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
8060
8217
|
* "object": "appointment_meeting",
|
|
@@ -8126,6 +8283,7 @@ interface components {
|
|
|
8126
8283
|
* "source": "client_ui"
|
|
8127
8284
|
* }
|
|
8128
8285
|
* ],
|
|
8286
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
8129
8287
|
* "service": {
|
|
8130
8288
|
* "appointment_type": "in_person",
|
|
8131
8289
|
* "booking_policy": {
|
|
@@ -8219,23 +8377,26 @@ interface components {
|
|
|
8219
8377
|
* "status": "scheduled",
|
|
8220
8378
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
8221
8379
|
* "urls": {
|
|
8380
|
+
* "add_to_calendar": [
|
|
8381
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
8382
|
+
* ],
|
|
8222
8383
|
* "add_to_google_calendar": [
|
|
8223
|
-
* "https://
|
|
8384
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
8224
8385
|
* ],
|
|
8225
8386
|
* "cancel": [
|
|
8226
|
-
* "https://
|
|
8387
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
8227
8388
|
* ],
|
|
8228
8389
|
* "confirm": [
|
|
8229
|
-
* "https://
|
|
8390
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
8230
8391
|
* ],
|
|
8231
8392
|
* "ics": [
|
|
8232
|
-
* "https://
|
|
8393
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
8233
8394
|
* ],
|
|
8234
8395
|
* "join": [
|
|
8235
|
-
* "https://
|
|
8396
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
8236
8397
|
* ],
|
|
8237
8398
|
* "reschedule": [
|
|
8238
|
-
* "https://
|
|
8399
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
8239
8400
|
* ]
|
|
8240
8401
|
* }
|
|
8241
8402
|
* },
|
|
@@ -8368,7 +8529,9 @@ interface components {
|
|
|
8368
8529
|
* @description Emitted asynchronously after a meeting was successfully canceled with the conferencing provider, following an appointment cancellation.
|
|
8369
8530
|
* @example {
|
|
8370
8531
|
* "object": {
|
|
8532
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
8371
8533
|
* "appointment_type": "in_person",
|
|
8534
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
8372
8535
|
* "cancellation_events": [
|
|
8373
8536
|
* {
|
|
8374
8537
|
* "actor": null,
|
|
@@ -8403,6 +8566,9 @@ interface components {
|
|
|
8403
8566
|
* },
|
|
8404
8567
|
* "client_data": {
|
|
8405
8568
|
* "email": "jane.smith@example.com",
|
|
8569
|
+
* "fields": {
|
|
8570
|
+
* "age": 30
|
|
8571
|
+
* },
|
|
8406
8572
|
* "first_name": "Jane",
|
|
8407
8573
|
* "last_name": "Smith",
|
|
8408
8574
|
* "locale": "en-US",
|
|
@@ -8410,6 +8576,7 @@ interface components {
|
|
|
8410
8576
|
* "reference_id": "ext_12345",
|
|
8411
8577
|
* "time_zone": "America/Chicago"
|
|
8412
8578
|
* },
|
|
8579
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
8413
8580
|
* "confirmation_events": [
|
|
8414
8581
|
* {
|
|
8415
8582
|
* "actor": null,
|
|
@@ -8442,11 +8609,14 @@ interface components {
|
|
|
8442
8609
|
* "unix_ts": 1736464800,
|
|
8443
8610
|
* "utc": "2025-03-01T04:00:00Z"
|
|
8444
8611
|
* },
|
|
8612
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
8445
8613
|
* "id": "appt_a1b2c3d4e5f6",
|
|
8614
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
8446
8615
|
* "meeting": {
|
|
8447
8616
|
* "conferencing_provider": "zoom_admin",
|
|
8448
8617
|
* "error_message": null,
|
|
8449
8618
|
* "external_meeting_id": "82912345678",
|
|
8619
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
8450
8620
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
8451
8621
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
8452
8622
|
* "object": "appointment_meeting",
|
|
@@ -8518,6 +8688,7 @@ interface components {
|
|
|
8518
8688
|
* "source": "client_ui"
|
|
8519
8689
|
* }
|
|
8520
8690
|
* ],
|
|
8691
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
8521
8692
|
* "service": {
|
|
8522
8693
|
* "appointment_type": "in_person",
|
|
8523
8694
|
* "booking_policy": {
|
|
@@ -8611,23 +8782,26 @@ interface components {
|
|
|
8611
8782
|
* "status": "scheduled",
|
|
8612
8783
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
8613
8784
|
* "urls": {
|
|
8785
|
+
* "add_to_calendar": [
|
|
8786
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
8787
|
+
* ],
|
|
8614
8788
|
* "add_to_google_calendar": [
|
|
8615
|
-
* "https://
|
|
8789
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
8616
8790
|
* ],
|
|
8617
8791
|
* "cancel": [
|
|
8618
|
-
* "https://
|
|
8792
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
8619
8793
|
* ],
|
|
8620
8794
|
* "confirm": [
|
|
8621
|
-
* "https://
|
|
8795
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
8622
8796
|
* ],
|
|
8623
8797
|
* "ics": [
|
|
8624
|
-
* "https://
|
|
8798
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
8625
8799
|
* ],
|
|
8626
8800
|
* "join": [
|
|
8627
|
-
* "https://
|
|
8801
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
8628
8802
|
* ],
|
|
8629
8803
|
* "reschedule": [
|
|
8630
|
-
* "https://
|
|
8804
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
8631
8805
|
* ]
|
|
8632
8806
|
* }
|
|
8633
8807
|
* },
|
|
@@ -8743,10 +8917,23 @@ interface components {
|
|
|
8743
8917
|
* Meetings are created asynchronously after an appointment is scheduled, so the
|
|
8744
8918
|
* `status` field reflects where the meeting is in its lifecycle. Meeting details
|
|
8745
8919
|
* such as `join_url` are populated only once the status is `created`.
|
|
8920
|
+
*
|
|
8921
|
+
* The `host_url` field is a stable proxy URL on the account's booking domain
|
|
8922
|
+
* (the canonical SavvyCal host, or an active custom domain when one is
|
|
8923
|
+
* configured) that the meeting host follows to start the meeting. **Treat
|
|
8924
|
+
* this URL as a credential — anyone with it can start the meeting as the
|
|
8925
|
+
* host.** It is valid through the appointment's end time + a 24h grace
|
|
8926
|
+
* window, after which it returns 410 Gone. SavvyCal handles refresh of the
|
|
8927
|
+
* underlying conferencing-provider URL transparently behind the proxy, so
|
|
8928
|
+
* the proxy URL itself remains stable across `appointment.updated` webhook
|
|
8929
|
+
* events. `host_url` is null when the meeting is not yet `created` or when
|
|
8930
|
+
* the conferencing provider has no distinct host start URL (e.g., Google
|
|
8931
|
+
* Meet uses a single shared URL).
|
|
8746
8932
|
* @example {
|
|
8747
8933
|
* "conferencing_provider": "zoom_admin",
|
|
8748
8934
|
* "error_message": null,
|
|
8749
8935
|
* "external_meeting_id": "82912345678",
|
|
8936
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
8750
8937
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
8751
8938
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
8752
8939
|
* "object": "appointment_meeting",
|
|
@@ -8767,6 +8954,15 @@ interface components {
|
|
|
8767
8954
|
* @example 82912345678
|
|
8768
8955
|
*/
|
|
8769
8956
|
external_meeting_id: string | null;
|
|
8957
|
+
/**
|
|
8958
|
+
* Format: uri
|
|
8959
|
+
* @description Stable proxy URL the host follows to start the meeting. Treat as a
|
|
8960
|
+
* credential — anyone with this URL can start the meeting as host.
|
|
8961
|
+
* Valid through the appointment's end time + 24h grace window, then
|
|
8962
|
+
* returns 410 Gone. Null when the meeting is not `created` or when
|
|
8963
|
+
* the conferencing provider has no distinct host start URL.
|
|
8964
|
+
*/
|
|
8965
|
+
host_url: string | null;
|
|
8770
8966
|
/** @description Unique identifier for the object. */
|
|
8771
8967
|
id: string;
|
|
8772
8968
|
/**
|
|
@@ -8902,7 +9098,9 @@ interface components {
|
|
|
8902
9098
|
* @description Emitted when an update to an existing meeting with the conferencing provider terminally fails — including when the provider reports the meeting was deleted out-of-band. The `object.meeting.error_message` field carries the failure reason.
|
|
8903
9099
|
* @example {
|
|
8904
9100
|
* "object": {
|
|
9101
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
8905
9102
|
* "appointment_type": "in_person",
|
|
9103
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
8906
9104
|
* "cancellation_events": [
|
|
8907
9105
|
* {
|
|
8908
9106
|
* "actor": null,
|
|
@@ -8937,6 +9135,9 @@ interface components {
|
|
|
8937
9135
|
* },
|
|
8938
9136
|
* "client_data": {
|
|
8939
9137
|
* "email": "jane.smith@example.com",
|
|
9138
|
+
* "fields": {
|
|
9139
|
+
* "age": 30
|
|
9140
|
+
* },
|
|
8940
9141
|
* "first_name": "Jane",
|
|
8941
9142
|
* "last_name": "Smith",
|
|
8942
9143
|
* "locale": "en-US",
|
|
@@ -8944,6 +9145,7 @@ interface components {
|
|
|
8944
9145
|
* "reference_id": "ext_12345",
|
|
8945
9146
|
* "time_zone": "America/Chicago"
|
|
8946
9147
|
* },
|
|
9148
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
8947
9149
|
* "confirmation_events": [
|
|
8948
9150
|
* {
|
|
8949
9151
|
* "actor": null,
|
|
@@ -8976,11 +9178,14 @@ interface components {
|
|
|
8976
9178
|
* "unix_ts": 1736464800,
|
|
8977
9179
|
* "utc": "2025-03-01T04:00:00Z"
|
|
8978
9180
|
* },
|
|
9181
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
8979
9182
|
* "id": "appt_a1b2c3d4e5f6",
|
|
9183
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
8980
9184
|
* "meeting": {
|
|
8981
9185
|
* "conferencing_provider": "zoom_admin",
|
|
8982
9186
|
* "error_message": null,
|
|
8983
9187
|
* "external_meeting_id": "82912345678",
|
|
9188
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
8984
9189
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
8985
9190
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
8986
9191
|
* "object": "appointment_meeting",
|
|
@@ -9052,6 +9257,7 @@ interface components {
|
|
|
9052
9257
|
* "source": "client_ui"
|
|
9053
9258
|
* }
|
|
9054
9259
|
* ],
|
|
9260
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
9055
9261
|
* "service": {
|
|
9056
9262
|
* "appointment_type": "in_person",
|
|
9057
9263
|
* "booking_policy": {
|
|
@@ -9145,23 +9351,26 @@ interface components {
|
|
|
9145
9351
|
* "status": "scheduled",
|
|
9146
9352
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
9147
9353
|
* "urls": {
|
|
9354
|
+
* "add_to_calendar": [
|
|
9355
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
9356
|
+
* ],
|
|
9148
9357
|
* "add_to_google_calendar": [
|
|
9149
|
-
* "https://
|
|
9358
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
9150
9359
|
* ],
|
|
9151
9360
|
* "cancel": [
|
|
9152
|
-
* "https://
|
|
9361
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
9153
9362
|
* ],
|
|
9154
9363
|
* "confirm": [
|
|
9155
|
-
* "https://
|
|
9364
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
9156
9365
|
* ],
|
|
9157
9366
|
* "ics": [
|
|
9158
|
-
* "https://
|
|
9367
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
9159
9368
|
* ],
|
|
9160
9369
|
* "join": [
|
|
9161
|
-
* "https://
|
|
9370
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
9162
9371
|
* ],
|
|
9163
9372
|
* "reschedule": [
|
|
9164
|
-
* "https://
|
|
9373
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
9165
9374
|
* ]
|
|
9166
9375
|
* }
|
|
9167
9376
|
* },
|
|
@@ -9419,7 +9628,9 @@ interface components {
|
|
|
9419
9628
|
* @description This is an object representing data for the appointment canceled event.
|
|
9420
9629
|
* @example {
|
|
9421
9630
|
* "object": {
|
|
9631
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
9422
9632
|
* "appointment_type": "in_person",
|
|
9633
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
9423
9634
|
* "cancellation_events": [
|
|
9424
9635
|
* {
|
|
9425
9636
|
* "actor": null,
|
|
@@ -9454,6 +9665,9 @@ interface components {
|
|
|
9454
9665
|
* },
|
|
9455
9666
|
* "client_data": {
|
|
9456
9667
|
* "email": "jane.smith@example.com",
|
|
9668
|
+
* "fields": {
|
|
9669
|
+
* "age": 30
|
|
9670
|
+
* },
|
|
9457
9671
|
* "first_name": "Jane",
|
|
9458
9672
|
* "last_name": "Smith",
|
|
9459
9673
|
* "locale": "en-US",
|
|
@@ -9461,6 +9675,7 @@ interface components {
|
|
|
9461
9675
|
* "reference_id": "ext_12345",
|
|
9462
9676
|
* "time_zone": "America/Chicago"
|
|
9463
9677
|
* },
|
|
9678
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
9464
9679
|
* "confirmation_events": [
|
|
9465
9680
|
* {
|
|
9466
9681
|
* "actor": null,
|
|
@@ -9493,11 +9708,14 @@ interface components {
|
|
|
9493
9708
|
* "unix_ts": 1736464800,
|
|
9494
9709
|
* "utc": "2025-03-01T04:00:00Z"
|
|
9495
9710
|
* },
|
|
9711
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
9496
9712
|
* "id": "appt_a1b2c3d4e5f6",
|
|
9713
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
9497
9714
|
* "meeting": {
|
|
9498
9715
|
* "conferencing_provider": "zoom_admin",
|
|
9499
9716
|
* "error_message": null,
|
|
9500
9717
|
* "external_meeting_id": "82912345678",
|
|
9718
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
9501
9719
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
9502
9720
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
9503
9721
|
* "object": "appointment_meeting",
|
|
@@ -9569,6 +9787,7 @@ interface components {
|
|
|
9569
9787
|
* "source": "client_ui"
|
|
9570
9788
|
* }
|
|
9571
9789
|
* ],
|
|
9790
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
9572
9791
|
* "service": {
|
|
9573
9792
|
* "appointment_type": "in_person",
|
|
9574
9793
|
* "booking_policy": {
|
|
@@ -9662,23 +9881,26 @@ interface components {
|
|
|
9662
9881
|
* "status": "scheduled",
|
|
9663
9882
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
9664
9883
|
* "urls": {
|
|
9884
|
+
* "add_to_calendar": [
|
|
9885
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
9886
|
+
* ],
|
|
9665
9887
|
* "add_to_google_calendar": [
|
|
9666
|
-
* "https://
|
|
9888
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
9667
9889
|
* ],
|
|
9668
9890
|
* "cancel": [
|
|
9669
|
-
* "https://
|
|
9891
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
9670
9892
|
* ],
|
|
9671
9893
|
* "confirm": [
|
|
9672
|
-
* "https://
|
|
9894
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
9673
9895
|
* ],
|
|
9674
9896
|
* "ics": [
|
|
9675
|
-
* "https://
|
|
9897
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
9676
9898
|
* ],
|
|
9677
9899
|
* "join": [
|
|
9678
|
-
* "https://
|
|
9900
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
9679
9901
|
* ],
|
|
9680
9902
|
* "reschedule": [
|
|
9681
|
-
* "https://
|
|
9903
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
9682
9904
|
* ]
|
|
9683
9905
|
* }
|
|
9684
9906
|
* },
|
|
@@ -9729,19 +9951,7 @@ interface components {
|
|
|
9729
9951
|
/** @description When true, automatically assigns an available provider for the selected time slot if no provider_id is specified. */
|
|
9730
9952
|
auto_assign_provider?: boolean | null;
|
|
9731
9953
|
/** @description Progressive client data. Provided fields are merged with existing values. */
|
|
9732
|
-
client_data?:
|
|
9733
|
-
email?: string | null;
|
|
9734
|
-
/** @description A map of custom field key-value pairs. */
|
|
9735
|
-
fields?: {
|
|
9736
|
-
[key: string]: unknown;
|
|
9737
|
-
} | null;
|
|
9738
|
-
first_name?: string | null;
|
|
9739
|
-
last_name?: string | null;
|
|
9740
|
-
locale?: string | null;
|
|
9741
|
-
phone?: string | null;
|
|
9742
|
-
reference_id?: string | null;
|
|
9743
|
-
time_zone?: string | null;
|
|
9744
|
-
} | null;
|
|
9954
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
9745
9955
|
/**
|
|
9746
9956
|
* Format: date-time
|
|
9747
9957
|
* @description The end time of the slot as an ISO-8601 datetime string with a timezone offset.
|
|
@@ -10368,48 +10578,7 @@ interface components {
|
|
|
10368
10578
|
* }
|
|
10369
10579
|
*/
|
|
10370
10580
|
CreateAppointmentRequest: {
|
|
10371
|
-
|
|
10372
|
-
* @description Information about the client booking the appointment. You can either provide an `id` or `reference_id` for an existing client,
|
|
10373
|
-
* or provide a new client's details.
|
|
10374
|
-
*/
|
|
10375
|
-
client_data: {
|
|
10376
|
-
/**
|
|
10377
|
-
* Format: email
|
|
10378
|
-
* @description The client's email address. Required if no existing client is provided.
|
|
10379
|
-
*/
|
|
10380
|
-
email?: string | null;
|
|
10381
|
-
/** @description A map of custom field key-value pairs to set on the client. */
|
|
10382
|
-
fields?: {
|
|
10383
|
-
[key: string]: unknown;
|
|
10384
|
-
} | null;
|
|
10385
|
-
/** @description The client's first name. Required if no existing client is provided. */
|
|
10386
|
-
first_name?: string | null;
|
|
10387
|
-
/**
|
|
10388
|
-
* @description The ID of an existing client to attach to the appointment. If not provided, a new client will be created
|
|
10389
|
-
* if the `reference_id` does not correspond to an existing client. If there does exist a client with
|
|
10390
|
-
* the `reference_id` provided, the existing client will be attached to the appointment.
|
|
10391
|
-
*/
|
|
10392
|
-
id?: string | null;
|
|
10393
|
-
/** @description The client's last name. Required if no existing client is provided. */
|
|
10394
|
-
last_name?: string | null;
|
|
10395
|
-
/**
|
|
10396
|
-
* @description The locale of the client booking the appointment.
|
|
10397
|
-
* @example en-US
|
|
10398
|
-
*/
|
|
10399
|
-
locale?: string | null;
|
|
10400
|
-
/**
|
|
10401
|
-
* @description The client's phone number (E.164 format).
|
|
10402
|
-
* @example +1234567890
|
|
10403
|
-
*/
|
|
10404
|
-
phone?: string | null;
|
|
10405
|
-
/** @description External reference identifier for the client. */
|
|
10406
|
-
reference_id?: string | null;
|
|
10407
|
-
/**
|
|
10408
|
-
* @description The client's time zone (IANA format). This field will be used to represent the appointment time slot in the client's local time zone (in the event that it differs from the appointment's local time zone).
|
|
10409
|
-
* @example America/New_York
|
|
10410
|
-
*/
|
|
10411
|
-
time_zone: string;
|
|
10412
|
-
};
|
|
10581
|
+
client_data: components["schemas"]["AppointmentClientDataInput"];
|
|
10413
10582
|
/**
|
|
10414
10583
|
* Format: date-time
|
|
10415
10584
|
* @description The end time of the appointment as an ISO-8601 datetime string with a timezone offset (e.g., `2025-03-01T11:00:00-05:00` or `2025-03-01T16:00:00Z`). The `time_zone` field determines the canonical timezone.
|
|
@@ -10505,7 +10674,9 @@ interface components {
|
|
|
10505
10674
|
* @description Emitted when the meeting attached to an appointment is replaced by a brand-new meeting at the conferencing provider — typically because a reschedule changed the primary provider and the new provider's conferencing maps to a different connected user/account. Distinct from `appointment.meeting.updated` (attribute-level change to the *same* provider meeting): consumers caching `external_meeting_id`, `join_url`, `password`, or dial-in numbers should treat this event as an invalidation signal.
|
|
10506
10675
|
* @example {
|
|
10507
10676
|
* "object": {
|
|
10677
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
10508
10678
|
* "appointment_type": "in_person",
|
|
10679
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
10509
10680
|
* "cancellation_events": [
|
|
10510
10681
|
* {
|
|
10511
10682
|
* "actor": null,
|
|
@@ -10540,6 +10711,9 @@ interface components {
|
|
|
10540
10711
|
* },
|
|
10541
10712
|
* "client_data": {
|
|
10542
10713
|
* "email": "jane.smith@example.com",
|
|
10714
|
+
* "fields": {
|
|
10715
|
+
* "age": 30
|
|
10716
|
+
* },
|
|
10543
10717
|
* "first_name": "Jane",
|
|
10544
10718
|
* "last_name": "Smith",
|
|
10545
10719
|
* "locale": "en-US",
|
|
@@ -10547,6 +10721,7 @@ interface components {
|
|
|
10547
10721
|
* "reference_id": "ext_12345",
|
|
10548
10722
|
* "time_zone": "America/Chicago"
|
|
10549
10723
|
* },
|
|
10724
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
10550
10725
|
* "confirmation_events": [
|
|
10551
10726
|
* {
|
|
10552
10727
|
* "actor": null,
|
|
@@ -10579,11 +10754,14 @@ interface components {
|
|
|
10579
10754
|
* "unix_ts": 1736464800,
|
|
10580
10755
|
* "utc": "2025-03-01T04:00:00Z"
|
|
10581
10756
|
* },
|
|
10757
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
10582
10758
|
* "id": "appt_a1b2c3d4e5f6",
|
|
10759
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
10583
10760
|
* "meeting": {
|
|
10584
10761
|
* "conferencing_provider": "zoom_admin",
|
|
10585
10762
|
* "error_message": null,
|
|
10586
10763
|
* "external_meeting_id": "82912345678",
|
|
10764
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
10587
10765
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
10588
10766
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
10589
10767
|
* "object": "appointment_meeting",
|
|
@@ -10655,6 +10833,7 @@ interface components {
|
|
|
10655
10833
|
* "source": "client_ui"
|
|
10656
10834
|
* }
|
|
10657
10835
|
* ],
|
|
10836
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
10658
10837
|
* "service": {
|
|
10659
10838
|
* "appointment_type": "in_person",
|
|
10660
10839
|
* "booking_policy": {
|
|
@@ -10748,23 +10927,26 @@ interface components {
|
|
|
10748
10927
|
* "status": "scheduled",
|
|
10749
10928
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
10750
10929
|
* "urls": {
|
|
10930
|
+
* "add_to_calendar": [
|
|
10931
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
10932
|
+
* ],
|
|
10751
10933
|
* "add_to_google_calendar": [
|
|
10752
|
-
* "https://
|
|
10934
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
10753
10935
|
* ],
|
|
10754
10936
|
* "cancel": [
|
|
10755
|
-
* "https://
|
|
10937
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
10756
10938
|
* ],
|
|
10757
10939
|
* "confirm": [
|
|
10758
|
-
* "https://
|
|
10940
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
10759
10941
|
* ],
|
|
10760
10942
|
* "ics": [
|
|
10761
|
-
* "https://
|
|
10943
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
10762
10944
|
* ],
|
|
10763
10945
|
* "join": [
|
|
10764
|
-
* "https://
|
|
10946
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
10765
10947
|
* ],
|
|
10766
10948
|
* "reschedule": [
|
|
10767
|
-
* "https://
|
|
10949
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
10768
10950
|
* ]
|
|
10769
10951
|
* }
|
|
10770
10952
|
* },
|
|
@@ -10796,19 +10978,7 @@ interface components {
|
|
|
10796
10978
|
/** @description When true, automatically assigns an available provider for the selected time slot if no provider_id is specified. */
|
|
10797
10979
|
auto_assign_provider?: boolean | null;
|
|
10798
10980
|
/** @description Progressive client data to collect during the booking flow. */
|
|
10799
|
-
client_data?:
|
|
10800
|
-
email?: string | null;
|
|
10801
|
-
/** @description A map of custom field key-value pairs. */
|
|
10802
|
-
fields?: {
|
|
10803
|
-
[key: string]: unknown;
|
|
10804
|
-
} | null;
|
|
10805
|
-
first_name?: string | null;
|
|
10806
|
-
last_name?: string | null;
|
|
10807
|
-
locale?: string | null;
|
|
10808
|
-
phone?: string | null;
|
|
10809
|
-
reference_id?: string | null;
|
|
10810
|
-
time_zone?: string | null;
|
|
10811
|
-
} | null;
|
|
10981
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
10812
10982
|
/**
|
|
10813
10983
|
* Format: date-time
|
|
10814
10984
|
* @description The end time of the slot as an ISO-8601 datetime string with a timezone offset.
|
|
@@ -10844,6 +11014,9 @@ interface components {
|
|
|
10844
11014
|
* "client": null,
|
|
10845
11015
|
* "client_data": {
|
|
10846
11016
|
* "email": "jane@example.com",
|
|
11017
|
+
* "fields": {
|
|
11018
|
+
* "age": 30
|
|
11019
|
+
* },
|
|
10847
11020
|
* "first_name": "Jane",
|
|
10848
11021
|
* "last_name": "Doe",
|
|
10849
11022
|
* "locale": "en",
|
|
@@ -11039,7 +11212,9 @@ interface components {
|
|
|
11039
11212
|
* @description This is an object representing data for the appointment deleted event.
|
|
11040
11213
|
* @example {
|
|
11041
11214
|
* "object": {
|
|
11215
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
11042
11216
|
* "appointment_type": "in_person",
|
|
11217
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
11043
11218
|
* "cancellation_events": [
|
|
11044
11219
|
* {
|
|
11045
11220
|
* "actor": null,
|
|
@@ -11074,6 +11249,9 @@ interface components {
|
|
|
11074
11249
|
* },
|
|
11075
11250
|
* "client_data": {
|
|
11076
11251
|
* "email": "jane.smith@example.com",
|
|
11252
|
+
* "fields": {
|
|
11253
|
+
* "age": 30
|
|
11254
|
+
* },
|
|
11077
11255
|
* "first_name": "Jane",
|
|
11078
11256
|
* "last_name": "Smith",
|
|
11079
11257
|
* "locale": "en-US",
|
|
@@ -11081,6 +11259,7 @@ interface components {
|
|
|
11081
11259
|
* "reference_id": "ext_12345",
|
|
11082
11260
|
* "time_zone": "America/Chicago"
|
|
11083
11261
|
* },
|
|
11262
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
11084
11263
|
* "confirmation_events": [
|
|
11085
11264
|
* {
|
|
11086
11265
|
* "actor": null,
|
|
@@ -11113,11 +11292,14 @@ interface components {
|
|
|
11113
11292
|
* "unix_ts": 1736464800,
|
|
11114
11293
|
* "utc": "2025-03-01T04:00:00Z"
|
|
11115
11294
|
* },
|
|
11295
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
11116
11296
|
* "id": "appt_a1b2c3d4e5f6",
|
|
11297
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
11117
11298
|
* "meeting": {
|
|
11118
11299
|
* "conferencing_provider": "zoom_admin",
|
|
11119
11300
|
* "error_message": null,
|
|
11120
11301
|
* "external_meeting_id": "82912345678",
|
|
11302
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
11121
11303
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
11122
11304
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
11123
11305
|
* "object": "appointment_meeting",
|
|
@@ -11189,6 +11371,7 @@ interface components {
|
|
|
11189
11371
|
* "source": "client_ui"
|
|
11190
11372
|
* }
|
|
11191
11373
|
* ],
|
|
11374
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
11192
11375
|
* "service": {
|
|
11193
11376
|
* "appointment_type": "in_person",
|
|
11194
11377
|
* "booking_policy": {
|
|
@@ -11282,23 +11465,26 @@ interface components {
|
|
|
11282
11465
|
* "status": "scheduled",
|
|
11283
11466
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
11284
11467
|
* "urls": {
|
|
11468
|
+
* "add_to_calendar": [
|
|
11469
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
11470
|
+
* ],
|
|
11285
11471
|
* "add_to_google_calendar": [
|
|
11286
|
-
* "https://
|
|
11472
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
11287
11473
|
* ],
|
|
11288
11474
|
* "cancel": [
|
|
11289
|
-
* "https://
|
|
11475
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
11290
11476
|
* ],
|
|
11291
11477
|
* "confirm": [
|
|
11292
|
-
* "https://
|
|
11478
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
11293
11479
|
* ],
|
|
11294
11480
|
* "ics": [
|
|
11295
|
-
* "https://
|
|
11481
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
11296
11482
|
* ],
|
|
11297
11483
|
* "join": [
|
|
11298
|
-
* "https://
|
|
11484
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
11299
11485
|
* ],
|
|
11300
11486
|
* "reschedule": [
|
|
11301
|
-
* "https://
|
|
11487
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
11302
11488
|
* ]
|
|
11303
11489
|
* }
|
|
11304
11490
|
* },
|
|
@@ -11372,6 +11558,9 @@ interface components {
|
|
|
11372
11558
|
* @example {
|
|
11373
11559
|
* "client_data": {
|
|
11374
11560
|
* "email": "john.doe@example.com",
|
|
11561
|
+
* "fields": {
|
|
11562
|
+
* "age": 30
|
|
11563
|
+
* },
|
|
11375
11564
|
* "first_name": "John",
|
|
11376
11565
|
* "last_name": "Doe",
|
|
11377
11566
|
* "locale": "en-US",
|
|
@@ -11386,44 +11575,7 @@ interface components {
|
|
|
11386
11575
|
* }
|
|
11387
11576
|
*/
|
|
11388
11577
|
CreatePublicAppointmentRequest: {
|
|
11389
|
-
|
|
11390
|
-
* @description Information about the client booking the appointment. You can either provide an `id` or `reference_id` for an existing client,
|
|
11391
|
-
* or provide a new client's details.
|
|
11392
|
-
*/
|
|
11393
|
-
client_data: {
|
|
11394
|
-
/**
|
|
11395
|
-
* Format: email
|
|
11396
|
-
* @description The client's email address. Required if no existing client is provided.
|
|
11397
|
-
*/
|
|
11398
|
-
email?: string | null;
|
|
11399
|
-
/** @description The client's first name. Required if no existing client is provided. */
|
|
11400
|
-
first_name?: string | null;
|
|
11401
|
-
/**
|
|
11402
|
-
* @description The ID of an existing client to attach to the appointment. If not provided, a new client will be created
|
|
11403
|
-
* if the `reference_id` does not correspond to an existing client. If there does exist a client with
|
|
11404
|
-
* the `reference_id` provided, the existing client will be attached to the appointment.
|
|
11405
|
-
*/
|
|
11406
|
-
id?: string | null;
|
|
11407
|
-
/** @description The client's last name. Required if no existing client is provided. */
|
|
11408
|
-
last_name?: string | null;
|
|
11409
|
-
/**
|
|
11410
|
-
* @description The locale of the client booking the appointment.
|
|
11411
|
-
* @example en-US
|
|
11412
|
-
*/
|
|
11413
|
-
locale?: string | null;
|
|
11414
|
-
/**
|
|
11415
|
-
* @description The client's phone number (E.164 format).
|
|
11416
|
-
* @example +1234567890
|
|
11417
|
-
*/
|
|
11418
|
-
phone?: string | null;
|
|
11419
|
-
/** @description External reference identifier for the client. */
|
|
11420
|
-
reference_id?: string | null;
|
|
11421
|
-
/**
|
|
11422
|
-
* @description The client's time zone (IANA format). This field will be used to represent the appointment time slot in the client's local time zone (in the event that it differs from the appointment's local time zone).
|
|
11423
|
-
* @example America/New_York
|
|
11424
|
-
*/
|
|
11425
|
-
time_zone: string;
|
|
11426
|
-
};
|
|
11578
|
+
client_data: components["schemas"]["AppointmentClientDataInput"];
|
|
11427
11579
|
/**
|
|
11428
11580
|
* Format: date-time
|
|
11429
11581
|
* @description The end time of the appointment as an ISO-8601 datetime string with a timezone offset (e.g., `2025-03-01T11:00:00-05:00` or `2025-03-01T16:00:00Z`). The `time_zone` field determines the canonical timezone.
|
|
@@ -11553,6 +11705,54 @@ interface components {
|
|
|
11553
11705
|
/** @description The client fields details */
|
|
11554
11706
|
data: components["schemas"]["ClientField"][];
|
|
11555
11707
|
};
|
|
11708
|
+
/**
|
|
11709
|
+
* ClientDataInput
|
|
11710
|
+
* @description Progressive client data for a booking intent. All fields are optional; provided fields are merged with existing values.
|
|
11711
|
+
* @example {
|
|
11712
|
+
* "email": "jane@example.com",
|
|
11713
|
+
* "fields": {
|
|
11714
|
+
* "age": 30
|
|
11715
|
+
* },
|
|
11716
|
+
* "first_name": "Jane",
|
|
11717
|
+
* "last_name": "Doe",
|
|
11718
|
+
* "locale": "en-US",
|
|
11719
|
+
* "phone": "+15551234567",
|
|
11720
|
+
* "reference_id": "ext_123",
|
|
11721
|
+
* "time_zone": "America/New_York"
|
|
11722
|
+
* }
|
|
11723
|
+
*/
|
|
11724
|
+
ClientDataInput: {
|
|
11725
|
+
/**
|
|
11726
|
+
* Format: email
|
|
11727
|
+
* @description The client's email address.
|
|
11728
|
+
*/
|
|
11729
|
+
email?: string | null;
|
|
11730
|
+
/** @description A map of custom field values to set on the client, keyed by field slug. Each key must correspond to a Client Field that has been defined in the account; arbitrary key-value pairs are not accepted. */
|
|
11731
|
+
fields?: {
|
|
11732
|
+
[key: string]: unknown;
|
|
11733
|
+
} | null;
|
|
11734
|
+
/** @description The client's first name. */
|
|
11735
|
+
first_name?: string | null;
|
|
11736
|
+
/** @description The client's last name. */
|
|
11737
|
+
last_name?: string | null;
|
|
11738
|
+
/**
|
|
11739
|
+
* @description The locale of the client booking the appointment.
|
|
11740
|
+
* @example en-US
|
|
11741
|
+
*/
|
|
11742
|
+
locale?: string | null;
|
|
11743
|
+
/**
|
|
11744
|
+
* @description The client's phone number (E.164 format).
|
|
11745
|
+
* @example +1234567890
|
|
11746
|
+
*/
|
|
11747
|
+
phone?: string | null;
|
|
11748
|
+
/** @description External reference identifier for the client. */
|
|
11749
|
+
reference_id?: string | null;
|
|
11750
|
+
/**
|
|
11751
|
+
* @description The client's time zone (IANA format).
|
|
11752
|
+
* @example America/New_York
|
|
11753
|
+
*/
|
|
11754
|
+
time_zone?: string | null;
|
|
11755
|
+
};
|
|
11556
11756
|
/**
|
|
11557
11757
|
* BlockResponse
|
|
11558
11758
|
* @description Response schema for a block
|
|
@@ -11603,7 +11803,9 @@ interface components {
|
|
|
11603
11803
|
* @description Emitted asynchronously after a meeting was successfully updated with the conferencing provider, typically following an appointment reschedule.
|
|
11604
11804
|
* @example {
|
|
11605
11805
|
* "object": {
|
|
11806
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
11606
11807
|
* "appointment_type": "in_person",
|
|
11808
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
11607
11809
|
* "cancellation_events": [
|
|
11608
11810
|
* {
|
|
11609
11811
|
* "actor": null,
|
|
@@ -11638,6 +11840,9 @@ interface components {
|
|
|
11638
11840
|
* },
|
|
11639
11841
|
* "client_data": {
|
|
11640
11842
|
* "email": "jane.smith@example.com",
|
|
11843
|
+
* "fields": {
|
|
11844
|
+
* "age": 30
|
|
11845
|
+
* },
|
|
11641
11846
|
* "first_name": "Jane",
|
|
11642
11847
|
* "last_name": "Smith",
|
|
11643
11848
|
* "locale": "en-US",
|
|
@@ -11645,6 +11850,7 @@ interface components {
|
|
|
11645
11850
|
* "reference_id": "ext_12345",
|
|
11646
11851
|
* "time_zone": "America/Chicago"
|
|
11647
11852
|
* },
|
|
11853
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
11648
11854
|
* "confirmation_events": [
|
|
11649
11855
|
* {
|
|
11650
11856
|
* "actor": null,
|
|
@@ -11677,11 +11883,14 @@ interface components {
|
|
|
11677
11883
|
* "unix_ts": 1736464800,
|
|
11678
11884
|
* "utc": "2025-03-01T04:00:00Z"
|
|
11679
11885
|
* },
|
|
11886
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
11680
11887
|
* "id": "appt_a1b2c3d4e5f6",
|
|
11888
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
11681
11889
|
* "meeting": {
|
|
11682
11890
|
* "conferencing_provider": "zoom_admin",
|
|
11683
11891
|
* "error_message": null,
|
|
11684
11892
|
* "external_meeting_id": "82912345678",
|
|
11893
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
11685
11894
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
11686
11895
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
11687
11896
|
* "object": "appointment_meeting",
|
|
@@ -11753,6 +11962,7 @@ interface components {
|
|
|
11753
11962
|
* "source": "client_ui"
|
|
11754
11963
|
* }
|
|
11755
11964
|
* ],
|
|
11965
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
11756
11966
|
* "service": {
|
|
11757
11967
|
* "appointment_type": "in_person",
|
|
11758
11968
|
* "booking_policy": {
|
|
@@ -11846,23 +12056,26 @@ interface components {
|
|
|
11846
12056
|
* "status": "scheduled",
|
|
11847
12057
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
11848
12058
|
* "urls": {
|
|
12059
|
+
* "add_to_calendar": [
|
|
12060
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
12061
|
+
* ],
|
|
11849
12062
|
* "add_to_google_calendar": [
|
|
11850
|
-
* "https://
|
|
12063
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
11851
12064
|
* ],
|
|
11852
12065
|
* "cancel": [
|
|
11853
|
-
* "https://
|
|
12066
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
11854
12067
|
* ],
|
|
11855
12068
|
* "confirm": [
|
|
11856
|
-
* "https://
|
|
12069
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
11857
12070
|
* ],
|
|
11858
12071
|
* "ics": [
|
|
11859
|
-
* "https://
|
|
12072
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
11860
12073
|
* ],
|
|
11861
12074
|
* "join": [
|
|
11862
|
-
* "https://
|
|
12075
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
11863
12076
|
* ],
|
|
11864
12077
|
* "reschedule": [
|
|
11865
|
-
* "https://
|
|
12078
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
11866
12079
|
* ]
|
|
11867
12080
|
* }
|
|
11868
12081
|
* },
|
|
@@ -11881,7 +12094,9 @@ interface components {
|
|
|
11881
12094
|
* Appointment
|
|
11882
12095
|
* @description An appointment represents a booking that a client has made with a provider for a service.
|
|
11883
12096
|
* @example {
|
|
12097
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
11884
12098
|
* "appointment_type": "in_person",
|
|
12099
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
11885
12100
|
* "cancellation_events": [
|
|
11886
12101
|
* {
|
|
11887
12102
|
* "actor": null,
|
|
@@ -11916,6 +12131,9 @@ interface components {
|
|
|
11916
12131
|
* },
|
|
11917
12132
|
* "client_data": {
|
|
11918
12133
|
* "email": "jane.smith@example.com",
|
|
12134
|
+
* "fields": {
|
|
12135
|
+
* "age": 30
|
|
12136
|
+
* },
|
|
11919
12137
|
* "first_name": "Jane",
|
|
11920
12138
|
* "last_name": "Smith",
|
|
11921
12139
|
* "locale": "en-US",
|
|
@@ -11923,6 +12141,7 @@ interface components {
|
|
|
11923
12141
|
* "reference_id": "ext_12345",
|
|
11924
12142
|
* "time_zone": "America/Chicago"
|
|
11925
12143
|
* },
|
|
12144
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
11926
12145
|
* "confirmation_events": [
|
|
11927
12146
|
* {
|
|
11928
12147
|
* "actor": null,
|
|
@@ -11955,11 +12174,14 @@ interface components {
|
|
|
11955
12174
|
* "unix_ts": 1736464800,
|
|
11956
12175
|
* "utc": "2025-03-01T04:00:00Z"
|
|
11957
12176
|
* },
|
|
12177
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
11958
12178
|
* "id": "appt_a1b2c3d4e5f6",
|
|
12179
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
11959
12180
|
* "meeting": {
|
|
11960
12181
|
* "conferencing_provider": "zoom_admin",
|
|
11961
12182
|
* "error_message": null,
|
|
11962
12183
|
* "external_meeting_id": "82912345678",
|
|
12184
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
11963
12185
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
11964
12186
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
11965
12187
|
* "object": "appointment_meeting",
|
|
@@ -12031,6 +12253,7 @@ interface components {
|
|
|
12031
12253
|
* "source": "client_ui"
|
|
12032
12254
|
* }
|
|
12033
12255
|
* ],
|
|
12256
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
12034
12257
|
* "service": {
|
|
12035
12258
|
* "appointment_type": "in_person",
|
|
12036
12259
|
* "booking_policy": {
|
|
@@ -12124,33 +12347,46 @@ interface components {
|
|
|
12124
12347
|
* "status": "scheduled",
|
|
12125
12348
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
12126
12349
|
* "urls": {
|
|
12350
|
+
* "add_to_calendar": [
|
|
12351
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
12352
|
+
* ],
|
|
12127
12353
|
* "add_to_google_calendar": [
|
|
12128
|
-
* "https://
|
|
12354
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
12129
12355
|
* ],
|
|
12130
12356
|
* "cancel": [
|
|
12131
|
-
* "https://
|
|
12357
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
12132
12358
|
* ],
|
|
12133
12359
|
* "confirm": [
|
|
12134
|
-
* "https://
|
|
12360
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
12135
12361
|
* ],
|
|
12136
12362
|
* "ics": [
|
|
12137
|
-
* "https://
|
|
12363
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
12138
12364
|
* ],
|
|
12139
12365
|
* "join": [
|
|
12140
|
-
* "https://
|
|
12366
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
12141
12367
|
* ],
|
|
12142
12368
|
* "reschedule": [
|
|
12143
|
-
* "https://
|
|
12369
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
12144
12370
|
* ]
|
|
12145
12371
|
* }
|
|
12146
12372
|
* }
|
|
12147
12373
|
*/
|
|
12148
12374
|
Appointment: {
|
|
12375
|
+
/**
|
|
12376
|
+
* Format: uri
|
|
12377
|
+
* @description Canonical URL for the client to add this appointment to their calendar. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.
|
|
12378
|
+
*/
|
|
12379
|
+
add_to_calendar_url: string;
|
|
12149
12380
|
/**
|
|
12150
12381
|
* @description The type of appointment.
|
|
12151
12382
|
* @enum {string}
|
|
12152
12383
|
*/
|
|
12153
12384
|
appointment_type: "in_person" | "virtual";
|
|
12385
|
+
/**
|
|
12386
|
+
* Format: uri
|
|
12387
|
+
* @description Canonical URL for the client to cancel this appointment. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.
|
|
12388
|
+
*/
|
|
12389
|
+
cancel_url: string;
|
|
12154
12390
|
cancellation_events: components["schemas"]["CancellationEvent"][];
|
|
12155
12391
|
client: components["schemas"]["Client"];
|
|
12156
12392
|
/** @description Client data provided while creating the appointment. Some fields will be `null` unless `include_sensitive` is `true`. */
|
|
@@ -12160,6 +12396,10 @@ interface components {
|
|
|
12160
12396
|
* @description The client's email address. This field will be `null` unless `include_sensitive` is `true`.
|
|
12161
12397
|
*/
|
|
12162
12398
|
email?: string | null;
|
|
12399
|
+
/** @description A map of custom field values set on the client, keyed by field slug. Values for fields marked as sensitive will be `null` unless `include_sensitive` is `true`. */
|
|
12400
|
+
fields: {
|
|
12401
|
+
[key: string]: unknown;
|
|
12402
|
+
};
|
|
12163
12403
|
/** @description The client's first name. This field will be `null` unless `include_sensitive` is `true`. */
|
|
12164
12404
|
first_name?: string | null;
|
|
12165
12405
|
/** @description The client's last name. This field will be `null` unless `include_sensitive` is `true`. */
|
|
@@ -12179,6 +12419,11 @@ interface components {
|
|
|
12179
12419
|
*/
|
|
12180
12420
|
time_zone: string;
|
|
12181
12421
|
};
|
|
12422
|
+
/**
|
|
12423
|
+
* Format: uri
|
|
12424
|
+
* @description Canonical URL for the client to confirm this appointment. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.
|
|
12425
|
+
*/
|
|
12426
|
+
confirm_url: string;
|
|
12182
12427
|
confirmation_events: components["schemas"]["ConfirmationEvent"][];
|
|
12183
12428
|
/**
|
|
12184
12429
|
* Format: date-time
|
|
@@ -12191,8 +12436,18 @@ interface components {
|
|
|
12191
12436
|
*/
|
|
12192
12437
|
created_at: string;
|
|
12193
12438
|
end_at: components["schemas"]["ZonedDateTime"];
|
|
12439
|
+
/**
|
|
12440
|
+
* Format: uri
|
|
12441
|
+
* @description Canonical URL for the client to download an iCal file for this appointment. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.
|
|
12442
|
+
*/
|
|
12443
|
+
ics_url: string;
|
|
12194
12444
|
/** @description Unique identifier for the object. */
|
|
12195
12445
|
id: string;
|
|
12446
|
+
/**
|
|
12447
|
+
* Format: uri
|
|
12448
|
+
* @description Canonical URL for the client to join this appointment. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.
|
|
12449
|
+
*/
|
|
12450
|
+
join_url: string;
|
|
12196
12451
|
/** @description Conferencing meeting details. Null when no conferencing was configured for this appointment. */
|
|
12197
12452
|
meeting: components["schemas"]["AppointmentMeeting"] | null;
|
|
12198
12453
|
/**
|
|
@@ -12204,6 +12459,11 @@ interface components {
|
|
|
12204
12459
|
/** @description All providers on this appointment. The primary provider is always listed first. */
|
|
12205
12460
|
providers: components["schemas"]["AppointmentProvider"][];
|
|
12206
12461
|
reschedule_events: components["schemas"]["RescheduleEvent"][];
|
|
12462
|
+
/**
|
|
12463
|
+
* Format: uri
|
|
12464
|
+
* @description Canonical URL for the client to reschedule this appointment. Resolves to the account's active custom domain when configured, otherwise the canonical app host. The host portion may change if the account changes its custom-domain configuration.
|
|
12465
|
+
*/
|
|
12466
|
+
reschedule_url: string;
|
|
12207
12467
|
service: components["schemas"]["Service"];
|
|
12208
12468
|
start_at: components["schemas"]["ZonedDateTime"];
|
|
12209
12469
|
/**
|
|
@@ -12216,21 +12476,17 @@ interface components {
|
|
|
12216
12476
|
* @description Time at which the object was last updated.
|
|
12217
12477
|
*/
|
|
12218
12478
|
updated_at?: string;
|
|
12219
|
-
/**
|
|
12220
|
-
|
|
12221
|
-
|
|
12222
|
-
|
|
12223
|
-
|
|
12479
|
+
/**
|
|
12480
|
+
* @deprecated
|
|
12481
|
+
* @description Deprecated nested URL collections for this appointment. Use the flat *_url fields instead.
|
|
12482
|
+
*/
|
|
12483
|
+
urls: {
|
|
12484
|
+
add_to_calendar: string[];
|
|
12224
12485
|
add_to_google_calendar: string[];
|
|
12225
|
-
/** @description URLs for the client to use to cancel this appointment. */
|
|
12226
12486
|
cancel: string[];
|
|
12227
|
-
/** @description URLs for the client to use to confirm this appointment. */
|
|
12228
12487
|
confirm: string[];
|
|
12229
|
-
/** @description URLs for the client to use to download an iCal file for this appointment. */
|
|
12230
12488
|
ics: string[];
|
|
12231
|
-
/** @description URLs for the client to use to join this appointment. */
|
|
12232
12489
|
join: string[];
|
|
12233
|
-
/** @description URLs for the client to use to reschedule this appointment. */
|
|
12234
12490
|
reschedule: string[];
|
|
12235
12491
|
};
|
|
12236
12492
|
};
|
|
@@ -12323,6 +12579,8 @@ interface components {
|
|
|
12323
12579
|
* @description Response schema for a single appointment created via a public interface.
|
|
12324
12580
|
* @example {
|
|
12325
12581
|
* "data": {
|
|
12582
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
12583
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
12326
12584
|
* "cancellation": {
|
|
12327
12585
|
* "allowed": true,
|
|
12328
12586
|
* "disabled_message": null
|
|
@@ -12335,8 +12593,10 @@ interface components {
|
|
|
12335
12593
|
* "unix_ts": 1736464800,
|
|
12336
12594
|
* "utc": "2025-03-01T04:00:00Z"
|
|
12337
12595
|
* },
|
|
12596
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
12338
12597
|
* "id": "appt_a1b2c3d4e5f6",
|
|
12339
12598
|
* "object": "public_appointment",
|
|
12599
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
12340
12600
|
* "rescheduling": {
|
|
12341
12601
|
* "allowed": false,
|
|
12342
12602
|
* "disabled_message": "Rescheduling is not available within 24 hours of your appointment"
|
|
@@ -12351,19 +12611,19 @@ interface components {
|
|
|
12351
12611
|
* "status": "scheduled",
|
|
12352
12612
|
* "urls": {
|
|
12353
12613
|
* "add_to_calendar": [
|
|
12354
|
-
* "https://
|
|
12614
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
12355
12615
|
* ],
|
|
12356
12616
|
* "add_to_google_calendar": [
|
|
12357
|
-
* "https://
|
|
12617
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
12358
12618
|
* ],
|
|
12359
12619
|
* "cancel": [
|
|
12360
|
-
* "https://
|
|
12620
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
12361
12621
|
* ],
|
|
12362
12622
|
* "ics": [
|
|
12363
|
-
* "https://
|
|
12623
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
12364
12624
|
* ],
|
|
12365
12625
|
* "reschedule": [
|
|
12366
|
-
* "https://
|
|
12626
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
12367
12627
|
* ]
|
|
12368
12628
|
* }
|
|
12369
12629
|
* }
|
|
@@ -12668,6 +12928,9 @@ interface components {
|
|
|
12668
12928
|
* "client": null,
|
|
12669
12929
|
* "client_data": {
|
|
12670
12930
|
* "email": "jane@example.com",
|
|
12931
|
+
* "fields": {
|
|
12932
|
+
* "age": 30
|
|
12933
|
+
* },
|
|
12671
12934
|
* "first_name": "Jane",
|
|
12672
12935
|
* "last_name": "Doe",
|
|
12673
12936
|
* "locale": "en",
|
|
@@ -12839,9 +13102,13 @@ interface components {
|
|
|
12839
13102
|
booking_policy: components["schemas"]["BookingIntentBookingPolicy"];
|
|
12840
13103
|
/** @description The linked client */
|
|
12841
13104
|
client?: components["schemas"]["Client"] | null;
|
|
12842
|
-
/** @description Client data accumulated during the booking flow. Sensitive fields (first_name, last_name, email, phone) are redacted unless include_sensitive is true. */
|
|
13105
|
+
/** @description Client data accumulated during the booking flow. Sensitive fields (first_name, last_name, email, phone) are redacted unless include_sensitive is true. Values for `fields` entries flagged as sensitive are also redacted unless include_sensitive is true. */
|
|
12843
13106
|
client_data?: {
|
|
12844
13107
|
email?: string | null;
|
|
13108
|
+
/** @description A map of custom field values set on the client, keyed by field slug. Values for fields marked as sensitive will be `null` unless `include_sensitive` is `true`. */
|
|
13109
|
+
fields?: {
|
|
13110
|
+
[key: string]: unknown;
|
|
13111
|
+
};
|
|
12845
13112
|
first_name?: string | null;
|
|
12846
13113
|
last_name?: string | null;
|
|
12847
13114
|
locale?: string | null;
|
|
@@ -13018,7 +13285,9 @@ interface components {
|
|
|
13018
13285
|
* @description This is an object representing data for the appointment created event.
|
|
13019
13286
|
* @example {
|
|
13020
13287
|
* "object": {
|
|
13288
|
+
* "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
|
|
13021
13289
|
* "appointment_type": "in_person",
|
|
13290
|
+
* "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
|
|
13022
13291
|
* "cancellation_events": [
|
|
13023
13292
|
* {
|
|
13024
13293
|
* "actor": null,
|
|
@@ -13053,6 +13322,9 @@ interface components {
|
|
|
13053
13322
|
* },
|
|
13054
13323
|
* "client_data": {
|
|
13055
13324
|
* "email": "jane.smith@example.com",
|
|
13325
|
+
* "fields": {
|
|
13326
|
+
* "age": 30
|
|
13327
|
+
* },
|
|
13056
13328
|
* "first_name": "Jane",
|
|
13057
13329
|
* "last_name": "Smith",
|
|
13058
13330
|
* "locale": "en-US",
|
|
@@ -13060,6 +13332,7 @@ interface components {
|
|
|
13060
13332
|
* "reference_id": "ext_12345",
|
|
13061
13333
|
* "time_zone": "America/Chicago"
|
|
13062
13334
|
* },
|
|
13335
|
+
* "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
|
|
13063
13336
|
* "confirmation_events": [
|
|
13064
13337
|
* {
|
|
13065
13338
|
* "actor": null,
|
|
@@ -13092,11 +13365,14 @@ interface components {
|
|
|
13092
13365
|
* "unix_ts": 1736464800,
|
|
13093
13366
|
* "utc": "2025-03-01T04:00:00Z"
|
|
13094
13367
|
* },
|
|
13368
|
+
* "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
|
|
13095
13369
|
* "id": "appt_a1b2c3d4e5f6",
|
|
13370
|
+
* "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
|
|
13096
13371
|
* "meeting": {
|
|
13097
13372
|
* "conferencing_provider": "zoom_admin",
|
|
13098
13373
|
* "error_message": null,
|
|
13099
13374
|
* "external_meeting_id": "82912345678",
|
|
13375
|
+
* "host_url": "https://book.acme.com/p/appointments/appt_a1b2c3d4e5f6/host?token=An5thqO6Li9Dy9WXe3IsJQYDEXGjS70GjQIdNntKZgw",
|
|
13100
13376
|
* "id": "amtg_a1b2c3d4e5f6",
|
|
13101
13377
|
* "join_url": "https://zoom.us/j/82912345678",
|
|
13102
13378
|
* "object": "appointment_meeting",
|
|
@@ -13168,6 +13444,7 @@ interface components {
|
|
|
13168
13444
|
* "source": "client_ui"
|
|
13169
13445
|
* }
|
|
13170
13446
|
* ],
|
|
13447
|
+
* "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
|
|
13171
13448
|
* "service": {
|
|
13172
13449
|
* "appointment_type": "in_person",
|
|
13173
13450
|
* "booking_policy": {
|
|
@@ -13261,23 +13538,26 @@ interface components {
|
|
|
13261
13538
|
* "status": "scheduled",
|
|
13262
13539
|
* "updated_at": "2025-03-10T14:30:00Z",
|
|
13263
13540
|
* "urls": {
|
|
13541
|
+
* "add_to_calendar": [
|
|
13542
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
|
|
13543
|
+
* ],
|
|
13264
13544
|
* "add_to_google_calendar": [
|
|
13265
|
-
* "https://
|
|
13545
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
|
|
13266
13546
|
* ],
|
|
13267
13547
|
* "cancel": [
|
|
13268
|
-
* "https://
|
|
13548
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
|
|
13269
13549
|
* ],
|
|
13270
13550
|
* "confirm": [
|
|
13271
|
-
* "https://
|
|
13551
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
|
|
13272
13552
|
* ],
|
|
13273
13553
|
* "ics": [
|
|
13274
|
-
* "https://
|
|
13554
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
|
|
13275
13555
|
* ],
|
|
13276
13556
|
* "join": [
|
|
13277
|
-
* "https://
|
|
13557
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
|
|
13278
13558
|
* ],
|
|
13279
13559
|
* "reschedule": [
|
|
13280
|
-
* "https://
|
|
13560
|
+
* "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
|
|
13281
13561
|
* ]
|
|
13282
13562
|
* }
|
|
13283
13563
|
* },
|
|
@@ -18104,6 +18384,7 @@ type AdvanceNoticePolicy = Schemas["AdvanceNoticePolicy"];
|
|
|
18104
18384
|
type AggregatedSlot = Schemas["AggregatedSlot"];
|
|
18105
18385
|
type Appointment = Schemas["Appointment"];
|
|
18106
18386
|
type AppointmentCanceledEventData = Schemas["AppointmentCanceledEventData"];
|
|
18387
|
+
type AppointmentClientDataInput = Schemas["AppointmentClientDataInput"];
|
|
18107
18388
|
type AppointmentConfirmedEventData = Schemas["AppointmentConfirmedEventData"];
|
|
18108
18389
|
type AppointmentCreatedEventData = Schemas["AppointmentCreatedEventData"];
|
|
18109
18390
|
type AppointmentDeletedEventData = Schemas["AppointmentDeletedEventData"];
|
|
@@ -18147,6 +18428,7 @@ type CancellationReasonsResponse = Schemas["CancellationReasonsResponse"];
|
|
|
18147
18428
|
type CancelPublicAppointmentRequest = Schemas["CancelPublicAppointmentRequest"];
|
|
18148
18429
|
type Client = Schemas["Client"];
|
|
18149
18430
|
type ClientCreatedEventData = Schemas["ClientCreatedEventData"];
|
|
18431
|
+
type ClientDataInput = Schemas["ClientDataInput"];
|
|
18150
18432
|
type ClientDeletedEventData = Schemas["ClientDeletedEventData"];
|
|
18151
18433
|
type ClientField = Schemas["ClientField"];
|
|
18152
18434
|
type ClientFieldChoice = Schemas["ClientFieldChoice"];
|
|
@@ -18662,18 +18944,7 @@ declare function completeBookingIntent(client: FetchClient, path: PathParams<"/v
|
|
|
18662
18944
|
}, {
|
|
18663
18945
|
body: {
|
|
18664
18946
|
auto_assign_provider?: boolean | null;
|
|
18665
|
-
client_data?:
|
|
18666
|
-
email?: string | null;
|
|
18667
|
-
fields?: {
|
|
18668
|
-
[key: string]: unknown;
|
|
18669
|
-
} | null;
|
|
18670
|
-
first_name?: string | null;
|
|
18671
|
-
last_name?: string | null;
|
|
18672
|
-
locale?: string | null;
|
|
18673
|
-
phone?: string | null;
|
|
18674
|
-
reference_id?: string | null;
|
|
18675
|
-
time_zone?: string | null;
|
|
18676
|
-
} | null;
|
|
18947
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
18677
18948
|
client_id?: string | null;
|
|
18678
18949
|
end_at?: string | null;
|
|
18679
18950
|
metadata?: {
|
|
@@ -18734,18 +19005,7 @@ declare function completePublicBookingIntent(client: FetchClient, path: PathPara
|
|
|
18734
19005
|
}, {
|
|
18735
19006
|
body: {
|
|
18736
19007
|
auto_assign_provider?: boolean | null;
|
|
18737
|
-
client_data?:
|
|
18738
|
-
email?: string | null;
|
|
18739
|
-
fields?: {
|
|
18740
|
-
[key: string]: unknown;
|
|
18741
|
-
} | null;
|
|
18742
|
-
first_name?: string | null;
|
|
18743
|
-
last_name?: string | null;
|
|
18744
|
-
locale?: string | null;
|
|
18745
|
-
phone?: string | null;
|
|
18746
|
-
reference_id?: string | null;
|
|
18747
|
-
time_zone?: string | null;
|
|
18748
|
-
} | null;
|
|
19008
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
18749
19009
|
end_at?: string | null;
|
|
18750
19010
|
provider_id?: string | null;
|
|
18751
19011
|
service_id?: string | null;
|
|
@@ -18958,19 +19218,7 @@ declare function createAppointment(client: FetchClient, body: RequestBody<"/v1/a
|
|
|
18958
19218
|
};
|
|
18959
19219
|
}, {
|
|
18960
19220
|
body: {
|
|
18961
|
-
client_data:
|
|
18962
|
-
email?: string | null;
|
|
18963
|
-
fields?: {
|
|
18964
|
-
[key: string]: unknown;
|
|
18965
|
-
} | null;
|
|
18966
|
-
first_name?: string | null;
|
|
18967
|
-
id?: string | null;
|
|
18968
|
-
last_name?: string | null;
|
|
18969
|
-
locale?: string | null;
|
|
18970
|
-
phone?: string | null;
|
|
18971
|
-
reference_id?: string | null;
|
|
18972
|
-
time_zone: string;
|
|
18973
|
-
};
|
|
19221
|
+
client_data: components["schemas"]["AppointmentClientDataInput"];
|
|
18974
19222
|
end_at: string;
|
|
18975
19223
|
provider_id?: string | null;
|
|
18976
19224
|
service_id: string;
|
|
@@ -19092,18 +19340,7 @@ declare function createBookingIntent(client: FetchClient, body: RequestBody<"/v1
|
|
|
19092
19340
|
enabled?: boolean;
|
|
19093
19341
|
} | null;
|
|
19094
19342
|
} | null;
|
|
19095
|
-
client_data?:
|
|
19096
|
-
email?: string | null;
|
|
19097
|
-
fields?: {
|
|
19098
|
-
[key: string]: unknown;
|
|
19099
|
-
} | null;
|
|
19100
|
-
first_name?: string | null;
|
|
19101
|
-
last_name?: string | null;
|
|
19102
|
-
locale?: string | null;
|
|
19103
|
-
phone?: string | null;
|
|
19104
|
-
reference_id?: string | null;
|
|
19105
|
-
time_zone?: string | null;
|
|
19106
|
-
} | null;
|
|
19343
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
19107
19344
|
client_id?: string | null;
|
|
19108
19345
|
end_at?: string | null;
|
|
19109
19346
|
locked_fields?: ("service_id" | "provider_id" | "slot" | "client_data" | "submissions")[] | null;
|
|
@@ -19505,16 +19742,7 @@ declare function createPublicAppointment(client: FetchClient, body: RequestBody<
|
|
|
19505
19742
|
};
|
|
19506
19743
|
}, {
|
|
19507
19744
|
body: {
|
|
19508
|
-
client_data:
|
|
19509
|
-
email?: string | null;
|
|
19510
|
-
first_name?: string | null;
|
|
19511
|
-
id?: string | null;
|
|
19512
|
-
last_name?: string | null;
|
|
19513
|
-
locale?: string | null;
|
|
19514
|
-
phone?: string | null;
|
|
19515
|
-
reference_id?: string | null;
|
|
19516
|
-
time_zone: string;
|
|
19517
|
-
};
|
|
19745
|
+
client_data: components["schemas"]["AppointmentClientDataInput"];
|
|
19518
19746
|
end_at: string;
|
|
19519
19747
|
provider_id?: string | null;
|
|
19520
19748
|
service_id: string;
|
|
@@ -19564,18 +19792,7 @@ declare function createPublicBookingIntent(client: FetchClient, body: RequestBod
|
|
|
19564
19792
|
body: {
|
|
19565
19793
|
account_id: string;
|
|
19566
19794
|
auto_assign_provider?: boolean | null;
|
|
19567
|
-
client_data?:
|
|
19568
|
-
email?: string | null;
|
|
19569
|
-
fields?: {
|
|
19570
|
-
[key: string]: unknown;
|
|
19571
|
-
} | null;
|
|
19572
|
-
first_name?: string | null;
|
|
19573
|
-
last_name?: string | null;
|
|
19574
|
-
locale?: string | null;
|
|
19575
|
-
phone?: string | null;
|
|
19576
|
-
reference_id?: string | null;
|
|
19577
|
-
time_zone?: string | null;
|
|
19578
|
-
} | null;
|
|
19795
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
19579
19796
|
end_at?: string | null;
|
|
19580
19797
|
provider_id?: string | null;
|
|
19581
19798
|
service_id?: string | null;
|
|
@@ -22766,18 +22983,7 @@ declare function updateBookingIntent(client: FetchClient, path: PathParams<"/v1/
|
|
|
22766
22983
|
enabled?: boolean;
|
|
22767
22984
|
} | null;
|
|
22768
22985
|
} | null;
|
|
22769
|
-
client_data?:
|
|
22770
|
-
email?: string | null;
|
|
22771
|
-
fields?: {
|
|
22772
|
-
[key: string]: unknown;
|
|
22773
|
-
} | null;
|
|
22774
|
-
first_name?: string | null;
|
|
22775
|
-
last_name?: string | null;
|
|
22776
|
-
locale?: string | null;
|
|
22777
|
-
phone?: string | null;
|
|
22778
|
-
reference_id?: string | null;
|
|
22779
|
-
time_zone?: string | null;
|
|
22780
|
-
} | null;
|
|
22986
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
22781
22987
|
client_id?: string | null;
|
|
22782
22988
|
end_at?: string | null;
|
|
22783
22989
|
locked_fields?: ("service_id" | "provider_id" | "slot" | "client_data" | "submissions")[] | null;
|
|
@@ -23277,18 +23483,7 @@ declare function updatePublicBookingIntent(client: FetchClient, path: PathParams
|
|
|
23277
23483
|
}, {
|
|
23278
23484
|
body: {
|
|
23279
23485
|
auto_assign_provider?: boolean | null;
|
|
23280
|
-
client_data?:
|
|
23281
|
-
email?: string | null;
|
|
23282
|
-
fields?: {
|
|
23283
|
-
[key: string]: unknown;
|
|
23284
|
-
} | null;
|
|
23285
|
-
first_name?: string | null;
|
|
23286
|
-
last_name?: string | null;
|
|
23287
|
-
locale?: string | null;
|
|
23288
|
-
phone?: string | null;
|
|
23289
|
-
reference_id?: string | null;
|
|
23290
|
-
time_zone?: string | null;
|
|
23291
|
-
} | null;
|
|
23486
|
+
client_data?: components["schemas"]["ClientDataInput"] | null;
|
|
23292
23487
|
end_at?: string | null;
|
|
23293
23488
|
provider_id?: string | null;
|
|
23294
23489
|
service_id?: string | null;
|
|
@@ -23375,4 +23570,4 @@ declare function updateService(client: FetchClient, path: PathParams<"/v1/servic
|
|
|
23375
23570
|
};
|
|
23376
23571
|
}, `${string}/${string}`>>;
|
|
23377
23572
|
|
|
23378
|
-
export { type Account, type AccountEvent, type AccountResponse, type AccountUser, type AccountUserCreatedEventData, type AccountUserDeletedEventData, type AccountUserResponse, type AccountUserUpdatedEventData, type AccountUsersResponse, type AccountsResponse, type AdvanceNoticePolicy, type AggregatedSlot, type Appointment, type AppointmentCanceledEventData, type AppointmentConfirmedEventData, type AppointmentCreatedEventData, type AppointmentDeletedEventData, type AppointmentMeeting, type AppointmentMeetingCancelFailedEventData, type AppointmentMeetingCanceledEventData, type AppointmentMeetingCreateFailedEventData, type AppointmentMeetingCreatedEventData, type AppointmentMeetingReplaceFailedEventData, type AppointmentMeetingReplacedEventData, type AppointmentMeetingUpdateFailedEventData, type AppointmentMeetingUpdatedEventData, type AppointmentProvider, type AppointmentRescheduledEventData, type AppointmentResponse, type AppointmentsResponse, type AttachServiceFormRequest, type Block, type BlockCreatedEventData, type BlockDeletedEventData, type BlockResponse, type BlockUpdatedEventData, type BlocksResponse, type BookingIntent, type BookingIntentAbandonedEventData, type BookingIntentBookingPolicy, type BookingIntentCompletedEventData, type BookingIntentCreatedEventData, type BookingIntentRequirements, type BookingIntentResponse, type BookingIntentUpdatedEventData, type BookingIntentWorkflow, type BookingIntentsResponse, type BookingPolicy, type CancelAppointmentRequest, type CancelPublicAppointmentRequest, type CancellationEvent, type CancellationPolicy, type CancellationReason, type CancellationReasonResponse, type CancellationReasonsResponse, type Client, type ClientCreatedEventData, type ClientDeletedEventData, type ClientField, type ClientFieldChoice, type ClientFieldOptions, type ClientFieldResponse, type ClientFieldsResponse, type ClientResponse, type ClientUpdatedEventData, type ClientsResponse, type CompleteBookingIntentRequest, type CompletePublicBookingIntentRequest, type ConfirmAppointmentRequest, type ConfirmationEvent, type ConnectedAccount, type ConnectedAccountCreatedEventData, type ConnectedAccountDeletedEventData, type ConnectedAccountReconnectedEventData, type ConnectedAccountRefreshFailedEventData, type ConnectedAccountResponse, type ConnectedAccountsResponse, type CreateAccountRequest, type CreateAccountUserRequest, type CreateAppointmentRequest, type CreateBlockRequest, type CreateBookingIntentRequest, type CreateCancellationReasonRequest, type CreateClientFieldRequest, type CreateClientRequest, type CreateDashboardSessionRequest, type CreateFormRequest, type CreateProviderRequest, type CreateProviderScheduleRequest, type CreatePublicAppointmentRequest, type CreatePublicBookingIntentRequest, type CreateServiceProviderRequest, type CreateServiceRequest, type DashboardSession, type DashboardSessionResponse, type FetchClient, type FetchClientOptions, type FieldChoice, type FieldChoiceInput, type FieldOptions, type FieldOptionsInput, type ForbiddenResponse, type Form, type FormDetail, type FormField, type FormFieldInput, type FormResponse, type FormsResponse, type GenericErrorResponse, type HoldPolicy, type IntentSubmissionInput, type JsonError, type JsonErrorResponse, type MaximizeUtilizationPolicy, type NotFoundResponse, type PaginationMeta, type PathParams, type Platform, type PlatformResponse, type Provider, type ProviderCreatedEventData, type ProviderDeactivatedEventData, type ProviderNotificationConfig, type ProviderNotificationType, type ProviderReactivatedEventData, type ProviderResponse, type ProviderSchedule, type ProviderScheduleCreatedEventData, type ProviderScheduleDeletedEventData, type ProviderScheduleResponse, type ProviderScheduleUpdatedEventData, type ProviderSchedulesResponse, type ProviderUpdatedEventData, type ProvidersResponse, type PublicAppointment, type PublicAppointmentResponse, type PublicBookingIntent, type PublicBookingIntentResponse, type PublicCancellationReason, type PublicCancellationReasonsResponse, type PublicServiceEarliestSlotResponse, type QueryParams, type RecurrenceRule, type RequestBody, type RescheduleAppointmentRequest, type RescheduleEvent, type ReschedulePublicAppointmentRequest, type ReschedulingPolicy, type Role, type RolesResponse, type Service, type ServiceCreatedEventData, type ServiceDeletedEventData, type ServiceForm, type ServiceFormResponse, type ServiceFormsResponse, type ServiceProvider, type ServiceProviderCreatedEventData, type ServiceProviderDeletedEventData, type ServiceProviderResponse, type ServiceProvidersResponse, type ServiceResponse, type ServiceSlotResponse, type ServiceUpdatedEventData, type ServicesResponse, type Slot, type SlotListResponse, type SlotRule, type SortServiceFormsRequest, type SubmissionRequirement, type UnauthorizedResponse, type UpdateAccountRequest, type UpdateAccountUserRequest, type UpdateBlockRequest, type UpdateBookingIntentRequest, type UpdateCancellationReasonRequest, type UpdateClientFieldRequest, type UpdateClientRequest, type UpdateConnectedAccountRequest, type UpdateFormRequest, type UpdateProviderRequest, type UpdateProviderScheduleRequest, type UpdatePublicBookingIntentRequest, type UpdateServiceRequest, type User, type WeeklyRule, type ZonedDateTime, abandonBookingIntent, abandonPublicBookingIntent, attachServiceForm, cancelAppointment, cancelPublicAppointment, completeBookingIntent, completePublicBookingIntent, confirmAppointment, createAccount, createAccountUser, createAppointment, createBlock, createBookingIntent, createCancellationReason, createClient, createClientField, createDashboardSession, createFetchClient, createForm, createProvider, createProviderSchedule, createPublicAppointment, createPublicBookingIntent, createService, createServiceProvider, deactivateProvider, deleteBlock, deleteCancellationReason, deleteClient, deleteClientField, deleteConnectedAccount, deleteForm, deleteProviderSchedule, deleteService, deleteServiceProvider, detachServiceForm, getAccountById, getAppointment, getBlock, getBookingIntent, getCancellationReason, getClient, getClientField, getConnectedAccount, getCurrentAccount, getCurrentAccountUser, getCurrentPlatform, getEarliestPublicServiceSlot, getForm, getProvider, getProviderSchedule, getPublicAppointment, getPublicBookingIntent, getService, listAccountUsers, listAccounts, listAppointments, listBlocks, listBookingIntentSlots, listBookingIntents, listCancellationReasons, listClientFields, listClients, listConnectedAccounts, listForms, listProviderSchedules, listProviders, listPublicBookingIntentSlots, listPublicCancellationReasons, listPublicServiceSlots, listRoles, listServiceForms, listServiceProviders, listServiceSlots, listServices, type paths, rescheduleAppointment, reschedulePublicAppointment, sortServiceForms, updateAccount, updateAccountUser, updateBlock, updateBookingIntent, updateCancellationReason, updateClient, updateClientField, updateConnectedAccount, updateForm, updateProvider, updateProviderSchedule, updatePublicBookingIntent, updateService };
|
|
23573
|
+
export { type Account, type AccountEvent, type AccountResponse, type AccountUser, type AccountUserCreatedEventData, type AccountUserDeletedEventData, type AccountUserResponse, type AccountUserUpdatedEventData, type AccountUsersResponse, type AccountsResponse, type AdvanceNoticePolicy, type AggregatedSlot, type Appointment, type AppointmentCanceledEventData, type AppointmentClientDataInput, type AppointmentConfirmedEventData, type AppointmentCreatedEventData, type AppointmentDeletedEventData, type AppointmentMeeting, type AppointmentMeetingCancelFailedEventData, type AppointmentMeetingCanceledEventData, type AppointmentMeetingCreateFailedEventData, type AppointmentMeetingCreatedEventData, type AppointmentMeetingReplaceFailedEventData, type AppointmentMeetingReplacedEventData, type AppointmentMeetingUpdateFailedEventData, type AppointmentMeetingUpdatedEventData, type AppointmentProvider, type AppointmentRescheduledEventData, type AppointmentResponse, type AppointmentsResponse, type AttachServiceFormRequest, type Block, type BlockCreatedEventData, type BlockDeletedEventData, type BlockResponse, type BlockUpdatedEventData, type BlocksResponse, type BookingIntent, type BookingIntentAbandonedEventData, type BookingIntentBookingPolicy, type BookingIntentCompletedEventData, type BookingIntentCreatedEventData, type BookingIntentRequirements, type BookingIntentResponse, type BookingIntentUpdatedEventData, type BookingIntentWorkflow, type BookingIntentsResponse, type BookingPolicy, type CancelAppointmentRequest, type CancelPublicAppointmentRequest, type CancellationEvent, type CancellationPolicy, type CancellationReason, type CancellationReasonResponse, type CancellationReasonsResponse, type Client, type ClientCreatedEventData, type ClientDataInput, type ClientDeletedEventData, type ClientField, type ClientFieldChoice, type ClientFieldOptions, type ClientFieldResponse, type ClientFieldsResponse, type ClientResponse, type ClientUpdatedEventData, type ClientsResponse, type CompleteBookingIntentRequest, type CompletePublicBookingIntentRequest, type ConfirmAppointmentRequest, type ConfirmationEvent, type ConnectedAccount, type ConnectedAccountCreatedEventData, type ConnectedAccountDeletedEventData, type ConnectedAccountReconnectedEventData, type ConnectedAccountRefreshFailedEventData, type ConnectedAccountResponse, type ConnectedAccountsResponse, type CreateAccountRequest, type CreateAccountUserRequest, type CreateAppointmentRequest, type CreateBlockRequest, type CreateBookingIntentRequest, type CreateCancellationReasonRequest, type CreateClientFieldRequest, type CreateClientRequest, type CreateDashboardSessionRequest, type CreateFormRequest, type CreateProviderRequest, type CreateProviderScheduleRequest, type CreatePublicAppointmentRequest, type CreatePublicBookingIntentRequest, type CreateServiceProviderRequest, type CreateServiceRequest, type DashboardSession, type DashboardSessionResponse, type FetchClient, type FetchClientOptions, type FieldChoice, type FieldChoiceInput, type FieldOptions, type FieldOptionsInput, type ForbiddenResponse, type Form, type FormDetail, type FormField, type FormFieldInput, type FormResponse, type FormsResponse, type GenericErrorResponse, type HoldPolicy, type IntentSubmissionInput, type JsonError, type JsonErrorResponse, type MaximizeUtilizationPolicy, type NotFoundResponse, type PaginationMeta, type PathParams, type Platform, type PlatformResponse, type Provider, type ProviderCreatedEventData, type ProviderDeactivatedEventData, type ProviderNotificationConfig, type ProviderNotificationType, type ProviderReactivatedEventData, type ProviderResponse, type ProviderSchedule, type ProviderScheduleCreatedEventData, type ProviderScheduleDeletedEventData, type ProviderScheduleResponse, type ProviderScheduleUpdatedEventData, type ProviderSchedulesResponse, type ProviderUpdatedEventData, type ProvidersResponse, type PublicAppointment, type PublicAppointmentResponse, type PublicBookingIntent, type PublicBookingIntentResponse, type PublicCancellationReason, type PublicCancellationReasonsResponse, type PublicServiceEarliestSlotResponse, type QueryParams, type RecurrenceRule, type RequestBody, type RescheduleAppointmentRequest, type RescheduleEvent, type ReschedulePublicAppointmentRequest, type ReschedulingPolicy, type Role, type RolesResponse, type Service, type ServiceCreatedEventData, type ServiceDeletedEventData, type ServiceForm, type ServiceFormResponse, type ServiceFormsResponse, type ServiceProvider, type ServiceProviderCreatedEventData, type ServiceProviderDeletedEventData, type ServiceProviderResponse, type ServiceProvidersResponse, type ServiceResponse, type ServiceSlotResponse, type ServiceUpdatedEventData, type ServicesResponse, type Slot, type SlotListResponse, type SlotRule, type SortServiceFormsRequest, type SubmissionRequirement, type UnauthorizedResponse, type UpdateAccountRequest, type UpdateAccountUserRequest, type UpdateBlockRequest, type UpdateBookingIntentRequest, type UpdateCancellationReasonRequest, type UpdateClientFieldRequest, type UpdateClientRequest, type UpdateConnectedAccountRequest, type UpdateFormRequest, type UpdateProviderRequest, type UpdateProviderScheduleRequest, type UpdatePublicBookingIntentRequest, type UpdateServiceRequest, type User, type WeeklyRule, type ZonedDateTime, abandonBookingIntent, abandonPublicBookingIntent, attachServiceForm, cancelAppointment, cancelPublicAppointment, completeBookingIntent, completePublicBookingIntent, confirmAppointment, createAccount, createAccountUser, createAppointment, createBlock, createBookingIntent, createCancellationReason, createClient, createClientField, createDashboardSession, createFetchClient, createForm, createProvider, createProviderSchedule, createPublicAppointment, createPublicBookingIntent, createService, createServiceProvider, deactivateProvider, deleteBlock, deleteCancellationReason, deleteClient, deleteClientField, deleteConnectedAccount, deleteForm, deleteProviderSchedule, deleteService, deleteServiceProvider, detachServiceForm, getAccountById, getAppointment, getBlock, getBookingIntent, getCancellationReason, getClient, getClientField, getConnectedAccount, getCurrentAccount, getCurrentAccountUser, getCurrentPlatform, getEarliestPublicServiceSlot, getForm, getProvider, getProviderSchedule, getPublicAppointment, getPublicBookingIntent, getService, listAccountUsers, listAccounts, listAppointments, listBlocks, listBookingIntentSlots, listBookingIntents, listCancellationReasons, listClientFields, listClients, listConnectedAccounts, listForms, listProviderSchedules, listProviders, listPublicBookingIntentSlots, listPublicCancellationReasons, listPublicServiceSlots, listRoles, listServiceForms, listServiceProviders, listServiceSlots, listServices, type paths, rescheduleAppointment, reschedulePublicAppointment, sortServiceForms, updateAccount, updateAccountUser, updateBlock, updateBookingIntent, updateCancellationReason, updateClient, updateClientField, updateConnectedAccount, updateForm, updateProvider, updateProviderSchedule, updatePublicBookingIntent, updateService };
|