@savvycal/appointments-core 1.5.0 → 1.6.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.
Files changed (3) hide show
  1. package/dist/index.d.cts +333 -128
  2. package/dist/index.d.ts +333 -128
  3. package/package.json +1 -1
package/dist/index.d.ts 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://example.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
1514
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
1511
1515
  * ],
1512
1516
  * "add_to_google_calendar": [
1513
- * "https://example.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
1517
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
1514
1518
  * ],
1515
1519
  * "cancel": [
1516
- * "https://example.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
1520
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
1517
1521
  * ],
1518
1522
  * "ics": [
1519
- * "https://example.com/c/appointments/appt_a1b2c3d4e5f6/ics"
1523
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
1520
1524
  * ],
1521
1525
  * "reschedule": [
1522
- * "https://example.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
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
- /** @description URLs related to the appointment for client-facing actions. */
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,
@@ -1694,6 +1718,7 @@ interface components {
1694
1718
  * "reference_id": "ext_12345",
1695
1719
  * "time_zone": "America/Chicago"
1696
1720
  * },
1721
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
1697
1722
  * "confirmation_events": [
1698
1723
  * {
1699
1724
  * "actor": null,
@@ -1726,7 +1751,9 @@ interface components {
1726
1751
  * "unix_ts": 1736464800,
1727
1752
  * "utc": "2025-03-01T04:00:00Z"
1728
1753
  * },
1754
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
1729
1755
  * "id": "appt_a1b2c3d4e5f6",
1756
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
1730
1757
  * "meeting": {
1731
1758
  * "conferencing_provider": "zoom_admin",
1732
1759
  * "error_message": null,
@@ -1802,6 +1829,7 @@ interface components {
1802
1829
  * "source": "client_ui"
1803
1830
  * }
1804
1831
  * ],
1832
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
1805
1833
  * "service": {
1806
1834
  * "appointment_type": "in_person",
1807
1835
  * "booking_policy": {
@@ -1895,23 +1923,26 @@ interface components {
1895
1923
  * "status": "scheduled",
1896
1924
  * "updated_at": "2025-03-10T14:30:00Z",
1897
1925
  * "urls": {
1926
+ * "add_to_calendar": [
1927
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
1928
+ * ],
1898
1929
  * "add_to_google_calendar": [
1899
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
1930
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
1900
1931
  * ],
1901
1932
  * "cancel": [
1902
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
1933
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
1903
1934
  * ],
1904
1935
  * "confirm": [
1905
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
1936
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
1906
1937
  * ],
1907
1938
  * "ics": [
1908
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
1939
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
1909
1940
  * ],
1910
1941
  * "join": [
1911
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
1942
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
1912
1943
  * ],
1913
1944
  * "reschedule": [
1914
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
1945
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
1915
1946
  * ]
1916
1947
  * }
1917
1948
  * },
@@ -2439,7 +2470,9 @@ interface components {
2439
2470
  * @description Emitted when meeting cancellation with the conferencing provider terminally fails. The `object.meeting.error_message` field carries the failure reason.
2440
2471
  * @example {
2441
2472
  * "object": {
2473
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
2442
2474
  * "appointment_type": "in_person",
2475
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
2443
2476
  * "cancellation_events": [
2444
2477
  * {
2445
2478
  * "actor": null,
@@ -2481,6 +2514,7 @@ interface components {
2481
2514
  * "reference_id": "ext_12345",
2482
2515
  * "time_zone": "America/Chicago"
2483
2516
  * },
2517
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
2484
2518
  * "confirmation_events": [
2485
2519
  * {
2486
2520
  * "actor": null,
@@ -2513,7 +2547,9 @@ interface components {
2513
2547
  * "unix_ts": 1736464800,
2514
2548
  * "utc": "2025-03-01T04:00:00Z"
2515
2549
  * },
2550
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
2516
2551
  * "id": "appt_a1b2c3d4e5f6",
2552
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
2517
2553
  * "meeting": {
2518
2554
  * "conferencing_provider": "zoom_admin",
2519
2555
  * "error_message": null,
@@ -2589,6 +2625,7 @@ interface components {
2589
2625
  * "source": "client_ui"
2590
2626
  * }
2591
2627
  * ],
2628
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
2592
2629
  * "service": {
2593
2630
  * "appointment_type": "in_person",
2594
2631
  * "booking_policy": {
@@ -2682,23 +2719,26 @@ interface components {
2682
2719
  * "status": "scheduled",
2683
2720
  * "updated_at": "2025-03-10T14:30:00Z",
2684
2721
  * "urls": {
2722
+ * "add_to_calendar": [
2723
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
2724
+ * ],
2685
2725
  * "add_to_google_calendar": [
2686
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
2726
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
2687
2727
  * ],
2688
2728
  * "cancel": [
2689
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
2729
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
2690
2730
  * ],
2691
2731
  * "confirm": [
2692
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
2732
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
2693
2733
  * ],
2694
2734
  * "ics": [
2695
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
2735
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
2696
2736
  * ],
2697
2737
  * "join": [
2698
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
2738
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
2699
2739
  * ],
2700
2740
  * "reschedule": [
2701
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
2741
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
2702
2742
  * ]
2703
2743
  * }
2704
2744
  * },
@@ -5020,7 +5060,9 @@ interface components {
5020
5060
  * @description This is an object representing data for the appointment confirmed event.
5021
5061
  * @example {
5022
5062
  * "object": {
5063
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
5023
5064
  * "appointment_type": "in_person",
5065
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
5024
5066
  * "cancellation_events": [
5025
5067
  * {
5026
5068
  * "actor": null,
@@ -5062,6 +5104,7 @@ interface components {
5062
5104
  * "reference_id": "ext_12345",
5063
5105
  * "time_zone": "America/Chicago"
5064
5106
  * },
5107
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
5065
5108
  * "confirmation_events": [
5066
5109
  * {
5067
5110
  * "actor": null,
@@ -5094,7 +5137,9 @@ interface components {
5094
5137
  * "unix_ts": 1736464800,
5095
5138
  * "utc": "2025-03-01T04:00:00Z"
5096
5139
  * },
5140
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
5097
5141
  * "id": "appt_a1b2c3d4e5f6",
5142
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
5098
5143
  * "meeting": {
5099
5144
  * "conferencing_provider": "zoom_admin",
5100
5145
  * "error_message": null,
@@ -5170,6 +5215,7 @@ interface components {
5170
5215
  * "source": "client_ui"
5171
5216
  * }
5172
5217
  * ],
5218
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
5173
5219
  * "service": {
5174
5220
  * "appointment_type": "in_person",
5175
5221
  * "booking_policy": {
@@ -5263,23 +5309,26 @@ interface components {
5263
5309
  * "status": "scheduled",
5264
5310
  * "updated_at": "2025-03-10T14:30:00Z",
5265
5311
  * "urls": {
5312
+ * "add_to_calendar": [
5313
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
5314
+ * ],
5266
5315
  * "add_to_google_calendar": [
5267
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
5316
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
5268
5317
  * ],
5269
5318
  * "cancel": [
5270
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
5319
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
5271
5320
  * ],
5272
5321
  * "confirm": [
5273
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
5322
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
5274
5323
  * ],
5275
5324
  * "ics": [
5276
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
5325
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
5277
5326
  * ],
5278
5327
  * "join": [
5279
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
5328
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
5280
5329
  * ],
5281
5330
  * "reschedule": [
5282
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
5331
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
5283
5332
  * ]
5284
5333
  * }
5285
5334
  * },
@@ -5461,7 +5510,9 @@ interface components {
5461
5510
  * "created_at": "2025-03-12T12:34:55Z",
5462
5511
  * "data": {
5463
5512
  * "object": {
5513
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
5464
5514
  * "appointment_type": "in_person",
5515
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
5465
5516
  * "cancellation_events": [
5466
5517
  * {
5467
5518
  * "actor": null,
@@ -5503,6 +5554,7 @@ interface components {
5503
5554
  * "reference_id": "ext_12345",
5504
5555
  * "time_zone": "America/Chicago"
5505
5556
  * },
5557
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
5506
5558
  * "confirmation_events": [
5507
5559
  * {
5508
5560
  * "actor": null,
@@ -5535,7 +5587,9 @@ interface components {
5535
5587
  * "unix_ts": 1736464800,
5536
5588
  * "utc": "2025-03-01T04:00:00Z"
5537
5589
  * },
5590
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
5538
5591
  * "id": "appt_a1b2c3d4e5f6",
5592
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
5539
5593
  * "meeting": {
5540
5594
  * "conferencing_provider": "zoom_admin",
5541
5595
  * "error_message": null,
@@ -5611,6 +5665,7 @@ interface components {
5611
5665
  * "source": "client_ui"
5612
5666
  * }
5613
5667
  * ],
5668
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
5614
5669
  * "service": {
5615
5670
  * "appointment_type": "in_person",
5616
5671
  * "booking_policy": {
@@ -5704,23 +5759,26 @@ interface components {
5704
5759
  * "status": "scheduled",
5705
5760
  * "updated_at": "2025-03-10T14:30:00Z",
5706
5761
  * "urls": {
5762
+ * "add_to_calendar": [
5763
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
5764
+ * ],
5707
5765
  * "add_to_google_calendar": [
5708
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
5766
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
5709
5767
  * ],
5710
5768
  * "cancel": [
5711
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
5769
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
5712
5770
  * ],
5713
5771
  * "confirm": [
5714
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
5772
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
5715
5773
  * ],
5716
5774
  * "ics": [
5717
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
5775
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
5718
5776
  * ],
5719
5777
  * "join": [
5720
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
5778
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
5721
5779
  * ],
5722
5780
  * "reschedule": [
5723
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
5781
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
5724
5782
  * ]
5725
5783
  * }
5726
5784
  * },
@@ -5893,7 +5951,9 @@ interface components {
5893
5951
  * @example {
5894
5952
  * "data": [
5895
5953
  * {
5954
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
5896
5955
  * "appointment_type": "in_person",
5956
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
5897
5957
  * "cancellation_events": [
5898
5958
  * {
5899
5959
  * "actor": null,
@@ -5935,6 +5995,7 @@ interface components {
5935
5995
  * "reference_id": "ext_12345",
5936
5996
  * "time_zone": "America/Chicago"
5937
5997
  * },
5998
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
5938
5999
  * "confirmation_events": [
5939
6000
  * {
5940
6001
  * "actor": null,
@@ -5967,7 +6028,9 @@ interface components {
5967
6028
  * "unix_ts": 1736464800,
5968
6029
  * "utc": "2025-03-01T04:00:00Z"
5969
6030
  * },
6031
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
5970
6032
  * "id": "appt_a1b2c3d4e5f6",
6033
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
5971
6034
  * "meeting": {
5972
6035
  * "conferencing_provider": "zoom_admin",
5973
6036
  * "error_message": null,
@@ -6043,6 +6106,7 @@ interface components {
6043
6106
  * "source": "client_ui"
6044
6107
  * }
6045
6108
  * ],
6109
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
6046
6110
  * "service": {
6047
6111
  * "appointment_type": "in_person",
6048
6112
  * "booking_policy": {
@@ -6136,23 +6200,26 @@ interface components {
6136
6200
  * "status": "scheduled",
6137
6201
  * "updated_at": "2025-03-10T14:30:00Z",
6138
6202
  * "urls": {
6203
+ * "add_to_calendar": [
6204
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
6205
+ * ],
6139
6206
  * "add_to_google_calendar": [
6140
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
6207
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
6141
6208
  * ],
6142
6209
  * "cancel": [
6143
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
6210
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
6144
6211
  * ],
6145
6212
  * "confirm": [
6146
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
6213
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
6147
6214
  * ],
6148
6215
  * "ics": [
6149
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
6216
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
6150
6217
  * ],
6151
6218
  * "join": [
6152
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
6219
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
6153
6220
  * ],
6154
6221
  * "reschedule": [
6155
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
6222
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
6156
6223
  * ]
6157
6224
  * }
6158
6225
  * }
@@ -6436,7 +6503,9 @@ interface components {
6436
6503
  * @description Response schema for a single appointment
6437
6504
  * @example {
6438
6505
  * "data": {
6506
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
6439
6507
  * "appointment_type": "in_person",
6508
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
6440
6509
  * "cancellation_events": [
6441
6510
  * {
6442
6511
  * "actor": null,
@@ -6478,6 +6547,7 @@ interface components {
6478
6547
  * "reference_id": "ext_12345",
6479
6548
  * "time_zone": "America/Chicago"
6480
6549
  * },
6550
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
6481
6551
  * "confirmation_events": [
6482
6552
  * {
6483
6553
  * "actor": null,
@@ -6510,7 +6580,9 @@ interface components {
6510
6580
  * "unix_ts": 1736464800,
6511
6581
  * "utc": "2025-03-01T04:00:00Z"
6512
6582
  * },
6583
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
6513
6584
  * "id": "appt_a1b2c3d4e5f6",
6585
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
6514
6586
  * "meeting": {
6515
6587
  * "conferencing_provider": "zoom_admin",
6516
6588
  * "error_message": null,
@@ -6586,6 +6658,7 @@ interface components {
6586
6658
  * "source": "client_ui"
6587
6659
  * }
6588
6660
  * ],
6661
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
6589
6662
  * "service": {
6590
6663
  * "appointment_type": "in_person",
6591
6664
  * "booking_policy": {
@@ -6679,23 +6752,26 @@ interface components {
6679
6752
  * "status": "scheduled",
6680
6753
  * "updated_at": "2025-03-10T14:30:00Z",
6681
6754
  * "urls": {
6755
+ * "add_to_calendar": [
6756
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
6757
+ * ],
6682
6758
  * "add_to_google_calendar": [
6683
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
6759
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
6684
6760
  * ],
6685
6761
  * "cancel": [
6686
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
6762
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
6687
6763
  * ],
6688
6764
  * "confirm": [
6689
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
6765
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
6690
6766
  * ],
6691
6767
  * "ics": [
6692
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
6768
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
6693
6769
  * ],
6694
6770
  * "join": [
6695
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
6771
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
6696
6772
  * ],
6697
6773
  * "reschedule": [
6698
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
6774
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
6699
6775
  * ]
6700
6776
  * }
6701
6777
  * }
@@ -7146,7 +7222,9 @@ interface components {
7146
7222
  * @description Emitted when *initial* meeting creation with the conferencing provider terminally fails. The `object.meeting.error_message` field carries the failure reason.
7147
7223
  * @example {
7148
7224
  * "object": {
7225
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
7149
7226
  * "appointment_type": "in_person",
7227
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
7150
7228
  * "cancellation_events": [
7151
7229
  * {
7152
7230
  * "actor": null,
@@ -7188,6 +7266,7 @@ interface components {
7188
7266
  * "reference_id": "ext_12345",
7189
7267
  * "time_zone": "America/Chicago"
7190
7268
  * },
7269
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
7191
7270
  * "confirmation_events": [
7192
7271
  * {
7193
7272
  * "actor": null,
@@ -7220,7 +7299,9 @@ interface components {
7220
7299
  * "unix_ts": 1736464800,
7221
7300
  * "utc": "2025-03-01T04:00:00Z"
7222
7301
  * },
7302
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
7223
7303
  * "id": "appt_a1b2c3d4e5f6",
7304
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
7224
7305
  * "meeting": {
7225
7306
  * "conferencing_provider": "zoom_admin",
7226
7307
  * "error_message": null,
@@ -7296,6 +7377,7 @@ interface components {
7296
7377
  * "source": "client_ui"
7297
7378
  * }
7298
7379
  * ],
7380
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
7299
7381
  * "service": {
7300
7382
  * "appointment_type": "in_person",
7301
7383
  * "booking_policy": {
@@ -7389,23 +7471,26 @@ interface components {
7389
7471
  * "status": "scheduled",
7390
7472
  * "updated_at": "2025-03-10T14:30:00Z",
7391
7473
  * "urls": {
7474
+ * "add_to_calendar": [
7475
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
7476
+ * ],
7392
7477
  * "add_to_google_calendar": [
7393
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
7478
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
7394
7479
  * ],
7395
7480
  * "cancel": [
7396
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
7481
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
7397
7482
  * ],
7398
7483
  * "confirm": [
7399
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
7484
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
7400
7485
  * ],
7401
7486
  * "ics": [
7402
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
7487
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
7403
7488
  * ],
7404
7489
  * "join": [
7405
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
7490
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
7406
7491
  * ],
7407
7492
  * "reschedule": [
7408
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
7493
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
7409
7494
  * ]
7410
7495
  * }
7411
7496
  * },
@@ -7556,7 +7641,9 @@ interface components {
7556
7641
  * @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
7642
  * @example {
7558
7643
  * "object": {
7644
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
7559
7645
  * "appointment_type": "in_person",
7646
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
7560
7647
  * "cancellation_events": [
7561
7648
  * {
7562
7649
  * "actor": null,
@@ -7598,6 +7685,7 @@ interface components {
7598
7685
  * "reference_id": "ext_12345",
7599
7686
  * "time_zone": "America/Chicago"
7600
7687
  * },
7688
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
7601
7689
  * "confirmation_events": [
7602
7690
  * {
7603
7691
  * "actor": null,
@@ -7630,7 +7718,9 @@ interface components {
7630
7718
  * "unix_ts": 1736464800,
7631
7719
  * "utc": "2025-03-01T04:00:00Z"
7632
7720
  * },
7721
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
7633
7722
  * "id": "appt_a1b2c3d4e5f6",
7723
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
7634
7724
  * "meeting": {
7635
7725
  * "conferencing_provider": "zoom_admin",
7636
7726
  * "error_message": null,
@@ -7706,6 +7796,7 @@ interface components {
7706
7796
  * "source": "client_ui"
7707
7797
  * }
7708
7798
  * ],
7799
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
7709
7800
  * "service": {
7710
7801
  * "appointment_type": "in_person",
7711
7802
  * "booking_policy": {
@@ -7799,23 +7890,26 @@ interface components {
7799
7890
  * "status": "scheduled",
7800
7891
  * "updated_at": "2025-03-10T14:30:00Z",
7801
7892
  * "urls": {
7893
+ * "add_to_calendar": [
7894
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
7895
+ * ],
7802
7896
  * "add_to_google_calendar": [
7803
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
7897
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
7804
7898
  * ],
7805
7899
  * "cancel": [
7806
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
7900
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
7807
7901
  * ],
7808
7902
  * "confirm": [
7809
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
7903
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
7810
7904
  * ],
7811
7905
  * "ics": [
7812
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
7906
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
7813
7907
  * ],
7814
7908
  * "join": [
7815
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
7909
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
7816
7910
  * ],
7817
7911
  * "reschedule": [
7818
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
7912
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
7819
7913
  * ]
7820
7914
  * }
7821
7915
  * },
@@ -7976,7 +8070,9 @@ interface components {
7976
8070
  * @description Emitted asynchronously after a meeting was successfully created with the conferencing provider. The `object.meeting` field carries the populated meeting details.
7977
8071
  * @example {
7978
8072
  * "object": {
8073
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
7979
8074
  * "appointment_type": "in_person",
8075
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
7980
8076
  * "cancellation_events": [
7981
8077
  * {
7982
8078
  * "actor": null,
@@ -8018,6 +8114,7 @@ interface components {
8018
8114
  * "reference_id": "ext_12345",
8019
8115
  * "time_zone": "America/Chicago"
8020
8116
  * },
8117
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
8021
8118
  * "confirmation_events": [
8022
8119
  * {
8023
8120
  * "actor": null,
@@ -8050,7 +8147,9 @@ interface components {
8050
8147
  * "unix_ts": 1736464800,
8051
8148
  * "utc": "2025-03-01T04:00:00Z"
8052
8149
  * },
8150
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
8053
8151
  * "id": "appt_a1b2c3d4e5f6",
8152
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
8054
8153
  * "meeting": {
8055
8154
  * "conferencing_provider": "zoom_admin",
8056
8155
  * "error_message": null,
@@ -8126,6 +8225,7 @@ interface components {
8126
8225
  * "source": "client_ui"
8127
8226
  * }
8128
8227
  * ],
8228
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
8129
8229
  * "service": {
8130
8230
  * "appointment_type": "in_person",
8131
8231
  * "booking_policy": {
@@ -8219,23 +8319,26 @@ interface components {
8219
8319
  * "status": "scheduled",
8220
8320
  * "updated_at": "2025-03-10T14:30:00Z",
8221
8321
  * "urls": {
8322
+ * "add_to_calendar": [
8323
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
8324
+ * ],
8222
8325
  * "add_to_google_calendar": [
8223
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
8326
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
8224
8327
  * ],
8225
8328
  * "cancel": [
8226
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
8329
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
8227
8330
  * ],
8228
8331
  * "confirm": [
8229
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
8332
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
8230
8333
  * ],
8231
8334
  * "ics": [
8232
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
8335
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
8233
8336
  * ],
8234
8337
  * "join": [
8235
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
8338
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
8236
8339
  * ],
8237
8340
  * "reschedule": [
8238
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
8341
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
8239
8342
  * ]
8240
8343
  * }
8241
8344
  * },
@@ -8368,7 +8471,9 @@ interface components {
8368
8471
  * @description Emitted asynchronously after a meeting was successfully canceled with the conferencing provider, following an appointment cancellation.
8369
8472
  * @example {
8370
8473
  * "object": {
8474
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
8371
8475
  * "appointment_type": "in_person",
8476
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
8372
8477
  * "cancellation_events": [
8373
8478
  * {
8374
8479
  * "actor": null,
@@ -8410,6 +8515,7 @@ interface components {
8410
8515
  * "reference_id": "ext_12345",
8411
8516
  * "time_zone": "America/Chicago"
8412
8517
  * },
8518
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
8413
8519
  * "confirmation_events": [
8414
8520
  * {
8415
8521
  * "actor": null,
@@ -8442,7 +8548,9 @@ interface components {
8442
8548
  * "unix_ts": 1736464800,
8443
8549
  * "utc": "2025-03-01T04:00:00Z"
8444
8550
  * },
8551
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
8445
8552
  * "id": "appt_a1b2c3d4e5f6",
8553
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
8446
8554
  * "meeting": {
8447
8555
  * "conferencing_provider": "zoom_admin",
8448
8556
  * "error_message": null,
@@ -8518,6 +8626,7 @@ interface components {
8518
8626
  * "source": "client_ui"
8519
8627
  * }
8520
8628
  * ],
8629
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
8521
8630
  * "service": {
8522
8631
  * "appointment_type": "in_person",
8523
8632
  * "booking_policy": {
@@ -8611,23 +8720,26 @@ interface components {
8611
8720
  * "status": "scheduled",
8612
8721
  * "updated_at": "2025-03-10T14:30:00Z",
8613
8722
  * "urls": {
8723
+ * "add_to_calendar": [
8724
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
8725
+ * ],
8614
8726
  * "add_to_google_calendar": [
8615
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
8727
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
8616
8728
  * ],
8617
8729
  * "cancel": [
8618
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
8730
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
8619
8731
  * ],
8620
8732
  * "confirm": [
8621
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
8733
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
8622
8734
  * ],
8623
8735
  * "ics": [
8624
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
8736
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
8625
8737
  * ],
8626
8738
  * "join": [
8627
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
8739
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
8628
8740
  * ],
8629
8741
  * "reschedule": [
8630
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
8742
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
8631
8743
  * ]
8632
8744
  * }
8633
8745
  * },
@@ -8902,7 +9014,9 @@ interface components {
8902
9014
  * @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
9015
  * @example {
8904
9016
  * "object": {
9017
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
8905
9018
  * "appointment_type": "in_person",
9019
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
8906
9020
  * "cancellation_events": [
8907
9021
  * {
8908
9022
  * "actor": null,
@@ -8944,6 +9058,7 @@ interface components {
8944
9058
  * "reference_id": "ext_12345",
8945
9059
  * "time_zone": "America/Chicago"
8946
9060
  * },
9061
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
8947
9062
  * "confirmation_events": [
8948
9063
  * {
8949
9064
  * "actor": null,
@@ -8976,7 +9091,9 @@ interface components {
8976
9091
  * "unix_ts": 1736464800,
8977
9092
  * "utc": "2025-03-01T04:00:00Z"
8978
9093
  * },
9094
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
8979
9095
  * "id": "appt_a1b2c3d4e5f6",
9096
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
8980
9097
  * "meeting": {
8981
9098
  * "conferencing_provider": "zoom_admin",
8982
9099
  * "error_message": null,
@@ -9052,6 +9169,7 @@ interface components {
9052
9169
  * "source": "client_ui"
9053
9170
  * }
9054
9171
  * ],
9172
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
9055
9173
  * "service": {
9056
9174
  * "appointment_type": "in_person",
9057
9175
  * "booking_policy": {
@@ -9145,23 +9263,26 @@ interface components {
9145
9263
  * "status": "scheduled",
9146
9264
  * "updated_at": "2025-03-10T14:30:00Z",
9147
9265
  * "urls": {
9266
+ * "add_to_calendar": [
9267
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
9268
+ * ],
9148
9269
  * "add_to_google_calendar": [
9149
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
9270
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
9150
9271
  * ],
9151
9272
  * "cancel": [
9152
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
9273
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
9153
9274
  * ],
9154
9275
  * "confirm": [
9155
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
9276
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
9156
9277
  * ],
9157
9278
  * "ics": [
9158
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
9279
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
9159
9280
  * ],
9160
9281
  * "join": [
9161
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
9282
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
9162
9283
  * ],
9163
9284
  * "reschedule": [
9164
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
9285
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
9165
9286
  * ]
9166
9287
  * }
9167
9288
  * },
@@ -9419,7 +9540,9 @@ interface components {
9419
9540
  * @description This is an object representing data for the appointment canceled event.
9420
9541
  * @example {
9421
9542
  * "object": {
9543
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
9422
9544
  * "appointment_type": "in_person",
9545
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
9423
9546
  * "cancellation_events": [
9424
9547
  * {
9425
9548
  * "actor": null,
@@ -9461,6 +9584,7 @@ interface components {
9461
9584
  * "reference_id": "ext_12345",
9462
9585
  * "time_zone": "America/Chicago"
9463
9586
  * },
9587
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
9464
9588
  * "confirmation_events": [
9465
9589
  * {
9466
9590
  * "actor": null,
@@ -9493,7 +9617,9 @@ interface components {
9493
9617
  * "unix_ts": 1736464800,
9494
9618
  * "utc": "2025-03-01T04:00:00Z"
9495
9619
  * },
9620
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
9496
9621
  * "id": "appt_a1b2c3d4e5f6",
9622
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
9497
9623
  * "meeting": {
9498
9624
  * "conferencing_provider": "zoom_admin",
9499
9625
  * "error_message": null,
@@ -9569,6 +9695,7 @@ interface components {
9569
9695
  * "source": "client_ui"
9570
9696
  * }
9571
9697
  * ],
9698
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
9572
9699
  * "service": {
9573
9700
  * "appointment_type": "in_person",
9574
9701
  * "booking_policy": {
@@ -9662,23 +9789,26 @@ interface components {
9662
9789
  * "status": "scheduled",
9663
9790
  * "updated_at": "2025-03-10T14:30:00Z",
9664
9791
  * "urls": {
9792
+ * "add_to_calendar": [
9793
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
9794
+ * ],
9665
9795
  * "add_to_google_calendar": [
9666
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
9796
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
9667
9797
  * ],
9668
9798
  * "cancel": [
9669
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
9799
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
9670
9800
  * ],
9671
9801
  * "confirm": [
9672
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
9802
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
9673
9803
  * ],
9674
9804
  * "ics": [
9675
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
9805
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
9676
9806
  * ],
9677
9807
  * "join": [
9678
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
9808
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
9679
9809
  * ],
9680
9810
  * "reschedule": [
9681
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
9811
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
9682
9812
  * ]
9683
9813
  * }
9684
9814
  * },
@@ -10505,7 +10635,9 @@ interface components {
10505
10635
  * @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
10636
  * @example {
10507
10637
  * "object": {
10638
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
10508
10639
  * "appointment_type": "in_person",
10640
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
10509
10641
  * "cancellation_events": [
10510
10642
  * {
10511
10643
  * "actor": null,
@@ -10547,6 +10679,7 @@ interface components {
10547
10679
  * "reference_id": "ext_12345",
10548
10680
  * "time_zone": "America/Chicago"
10549
10681
  * },
10682
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
10550
10683
  * "confirmation_events": [
10551
10684
  * {
10552
10685
  * "actor": null,
@@ -10579,7 +10712,9 @@ interface components {
10579
10712
  * "unix_ts": 1736464800,
10580
10713
  * "utc": "2025-03-01T04:00:00Z"
10581
10714
  * },
10715
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
10582
10716
  * "id": "appt_a1b2c3d4e5f6",
10717
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
10583
10718
  * "meeting": {
10584
10719
  * "conferencing_provider": "zoom_admin",
10585
10720
  * "error_message": null,
@@ -10655,6 +10790,7 @@ interface components {
10655
10790
  * "source": "client_ui"
10656
10791
  * }
10657
10792
  * ],
10793
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
10658
10794
  * "service": {
10659
10795
  * "appointment_type": "in_person",
10660
10796
  * "booking_policy": {
@@ -10748,23 +10884,26 @@ interface components {
10748
10884
  * "status": "scheduled",
10749
10885
  * "updated_at": "2025-03-10T14:30:00Z",
10750
10886
  * "urls": {
10887
+ * "add_to_calendar": [
10888
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
10889
+ * ],
10751
10890
  * "add_to_google_calendar": [
10752
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
10891
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
10753
10892
  * ],
10754
10893
  * "cancel": [
10755
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
10894
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
10756
10895
  * ],
10757
10896
  * "confirm": [
10758
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
10897
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
10759
10898
  * ],
10760
10899
  * "ics": [
10761
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
10900
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
10762
10901
  * ],
10763
10902
  * "join": [
10764
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
10903
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
10765
10904
  * ],
10766
10905
  * "reschedule": [
10767
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
10906
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
10768
10907
  * ]
10769
10908
  * }
10770
10909
  * },
@@ -11039,7 +11178,9 @@ interface components {
11039
11178
  * @description This is an object representing data for the appointment deleted event.
11040
11179
  * @example {
11041
11180
  * "object": {
11181
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
11042
11182
  * "appointment_type": "in_person",
11183
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
11043
11184
  * "cancellation_events": [
11044
11185
  * {
11045
11186
  * "actor": null,
@@ -11081,6 +11222,7 @@ interface components {
11081
11222
  * "reference_id": "ext_12345",
11082
11223
  * "time_zone": "America/Chicago"
11083
11224
  * },
11225
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
11084
11226
  * "confirmation_events": [
11085
11227
  * {
11086
11228
  * "actor": null,
@@ -11113,7 +11255,9 @@ interface components {
11113
11255
  * "unix_ts": 1736464800,
11114
11256
  * "utc": "2025-03-01T04:00:00Z"
11115
11257
  * },
11258
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
11116
11259
  * "id": "appt_a1b2c3d4e5f6",
11260
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
11117
11261
  * "meeting": {
11118
11262
  * "conferencing_provider": "zoom_admin",
11119
11263
  * "error_message": null,
@@ -11189,6 +11333,7 @@ interface components {
11189
11333
  * "source": "client_ui"
11190
11334
  * }
11191
11335
  * ],
11336
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
11192
11337
  * "service": {
11193
11338
  * "appointment_type": "in_person",
11194
11339
  * "booking_policy": {
@@ -11282,23 +11427,26 @@ interface components {
11282
11427
  * "status": "scheduled",
11283
11428
  * "updated_at": "2025-03-10T14:30:00Z",
11284
11429
  * "urls": {
11430
+ * "add_to_calendar": [
11431
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
11432
+ * ],
11285
11433
  * "add_to_google_calendar": [
11286
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
11434
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
11287
11435
  * ],
11288
11436
  * "cancel": [
11289
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
11437
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
11290
11438
  * ],
11291
11439
  * "confirm": [
11292
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
11440
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
11293
11441
  * ],
11294
11442
  * "ics": [
11295
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
11443
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
11296
11444
  * ],
11297
11445
  * "join": [
11298
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
11446
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
11299
11447
  * ],
11300
11448
  * "reschedule": [
11301
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
11449
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
11302
11450
  * ]
11303
11451
  * }
11304
11452
  * },
@@ -11603,7 +11751,9 @@ interface components {
11603
11751
  * @description Emitted asynchronously after a meeting was successfully updated with the conferencing provider, typically following an appointment reschedule.
11604
11752
  * @example {
11605
11753
  * "object": {
11754
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
11606
11755
  * "appointment_type": "in_person",
11756
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
11607
11757
  * "cancellation_events": [
11608
11758
  * {
11609
11759
  * "actor": null,
@@ -11645,6 +11795,7 @@ interface components {
11645
11795
  * "reference_id": "ext_12345",
11646
11796
  * "time_zone": "America/Chicago"
11647
11797
  * },
11798
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
11648
11799
  * "confirmation_events": [
11649
11800
  * {
11650
11801
  * "actor": null,
@@ -11677,7 +11828,9 @@ interface components {
11677
11828
  * "unix_ts": 1736464800,
11678
11829
  * "utc": "2025-03-01T04:00:00Z"
11679
11830
  * },
11831
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
11680
11832
  * "id": "appt_a1b2c3d4e5f6",
11833
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
11681
11834
  * "meeting": {
11682
11835
  * "conferencing_provider": "zoom_admin",
11683
11836
  * "error_message": null,
@@ -11753,6 +11906,7 @@ interface components {
11753
11906
  * "source": "client_ui"
11754
11907
  * }
11755
11908
  * ],
11909
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
11756
11910
  * "service": {
11757
11911
  * "appointment_type": "in_person",
11758
11912
  * "booking_policy": {
@@ -11846,23 +12000,26 @@ interface components {
11846
12000
  * "status": "scheduled",
11847
12001
  * "updated_at": "2025-03-10T14:30:00Z",
11848
12002
  * "urls": {
12003
+ * "add_to_calendar": [
12004
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
12005
+ * ],
11849
12006
  * "add_to_google_calendar": [
11850
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
12007
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
11851
12008
  * ],
11852
12009
  * "cancel": [
11853
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
12010
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
11854
12011
  * ],
11855
12012
  * "confirm": [
11856
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
12013
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
11857
12014
  * ],
11858
12015
  * "ics": [
11859
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
12016
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
11860
12017
  * ],
11861
12018
  * "join": [
11862
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
12019
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
11863
12020
  * ],
11864
12021
  * "reschedule": [
11865
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
12022
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
11866
12023
  * ]
11867
12024
  * }
11868
12025
  * },
@@ -11881,7 +12038,9 @@ interface components {
11881
12038
  * Appointment
11882
12039
  * @description An appointment represents a booking that a client has made with a provider for a service.
11883
12040
  * @example {
12041
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
11884
12042
  * "appointment_type": "in_person",
12043
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
11885
12044
  * "cancellation_events": [
11886
12045
  * {
11887
12046
  * "actor": null,
@@ -11923,6 +12082,7 @@ interface components {
11923
12082
  * "reference_id": "ext_12345",
11924
12083
  * "time_zone": "America/Chicago"
11925
12084
  * },
12085
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
11926
12086
  * "confirmation_events": [
11927
12087
  * {
11928
12088
  * "actor": null,
@@ -11955,7 +12115,9 @@ interface components {
11955
12115
  * "unix_ts": 1736464800,
11956
12116
  * "utc": "2025-03-01T04:00:00Z"
11957
12117
  * },
12118
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
11958
12119
  * "id": "appt_a1b2c3d4e5f6",
12120
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
11959
12121
  * "meeting": {
11960
12122
  * "conferencing_provider": "zoom_admin",
11961
12123
  * "error_message": null,
@@ -12031,6 +12193,7 @@ interface components {
12031
12193
  * "source": "client_ui"
12032
12194
  * }
12033
12195
  * ],
12196
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
12034
12197
  * "service": {
12035
12198
  * "appointment_type": "in_person",
12036
12199
  * "booking_policy": {
@@ -12124,33 +12287,46 @@ interface components {
12124
12287
  * "status": "scheduled",
12125
12288
  * "updated_at": "2025-03-10T14:30:00Z",
12126
12289
  * "urls": {
12290
+ * "add_to_calendar": [
12291
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
12292
+ * ],
12127
12293
  * "add_to_google_calendar": [
12128
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
12294
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
12129
12295
  * ],
12130
12296
  * "cancel": [
12131
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
12297
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
12132
12298
  * ],
12133
12299
  * "confirm": [
12134
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
12300
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
12135
12301
  * ],
12136
12302
  * "ics": [
12137
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
12303
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
12138
12304
  * ],
12139
12305
  * "join": [
12140
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
12306
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
12141
12307
  * ],
12142
12308
  * "reschedule": [
12143
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
12309
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
12144
12310
  * ]
12145
12311
  * }
12146
12312
  * }
12147
12313
  */
12148
12314
  Appointment: {
12315
+ /**
12316
+ * Format: uri
12317
+ * @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.
12318
+ */
12319
+ add_to_calendar_url: string;
12149
12320
  /**
12150
12321
  * @description The type of appointment.
12151
12322
  * @enum {string}
12152
12323
  */
12153
12324
  appointment_type: "in_person" | "virtual";
12325
+ /**
12326
+ * Format: uri
12327
+ * @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.
12328
+ */
12329
+ cancel_url: string;
12154
12330
  cancellation_events: components["schemas"]["CancellationEvent"][];
12155
12331
  client: components["schemas"]["Client"];
12156
12332
  /** @description Client data provided while creating the appointment. Some fields will be `null` unless `include_sensitive` is `true`. */
@@ -12179,6 +12355,11 @@ interface components {
12179
12355
  */
12180
12356
  time_zone: string;
12181
12357
  };
12358
+ /**
12359
+ * Format: uri
12360
+ * @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.
12361
+ */
12362
+ confirm_url: string;
12182
12363
  confirmation_events: components["schemas"]["ConfirmationEvent"][];
12183
12364
  /**
12184
12365
  * Format: date-time
@@ -12191,8 +12372,18 @@ interface components {
12191
12372
  */
12192
12373
  created_at: string;
12193
12374
  end_at: components["schemas"]["ZonedDateTime"];
12375
+ /**
12376
+ * Format: uri
12377
+ * @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.
12378
+ */
12379
+ ics_url: string;
12194
12380
  /** @description Unique identifier for the object. */
12195
12381
  id: string;
12382
+ /**
12383
+ * Format: uri
12384
+ * @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.
12385
+ */
12386
+ join_url: string;
12196
12387
  /** @description Conferencing meeting details. Null when no conferencing was configured for this appointment. */
12197
12388
  meeting: components["schemas"]["AppointmentMeeting"] | null;
12198
12389
  /**
@@ -12204,6 +12395,11 @@ interface components {
12204
12395
  /** @description All providers on this appointment. The primary provider is always listed first. */
12205
12396
  providers: components["schemas"]["AppointmentProvider"][];
12206
12397
  reschedule_events: components["schemas"]["RescheduleEvent"][];
12398
+ /**
12399
+ * Format: uri
12400
+ * @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.
12401
+ */
12402
+ reschedule_url: string;
12207
12403
  service: components["schemas"]["Service"];
12208
12404
  start_at: components["schemas"]["ZonedDateTime"];
12209
12405
  /**
@@ -12216,21 +12412,17 @@ interface components {
12216
12412
  * @description Time at which the object was last updated.
12217
12413
  */
12218
12414
  updated_at?: string;
12219
- /** @description URLs for this appointment. */
12220
- urls?: {
12221
- /** @description URLs for the client to use to add this appointment to their calendar. */
12222
- add_to_calendar?: string[];
12223
- /** @description URLs for the client to use to add this appointment to Google Calendar. */
12415
+ /**
12416
+ * @deprecated
12417
+ * @description Deprecated nested URL collections for this appointment. Use the flat *_url fields instead.
12418
+ */
12419
+ urls: {
12420
+ add_to_calendar: string[];
12224
12421
  add_to_google_calendar: string[];
12225
- /** @description URLs for the client to use to cancel this appointment. */
12226
12422
  cancel: string[];
12227
- /** @description URLs for the client to use to confirm this appointment. */
12228
12423
  confirm: string[];
12229
- /** @description URLs for the client to use to download an iCal file for this appointment. */
12230
12424
  ics: string[];
12231
- /** @description URLs for the client to use to join this appointment. */
12232
12425
  join: string[];
12233
- /** @description URLs for the client to use to reschedule this appointment. */
12234
12426
  reschedule: string[];
12235
12427
  };
12236
12428
  };
@@ -12323,6 +12515,8 @@ interface components {
12323
12515
  * @description Response schema for a single appointment created via a public interface.
12324
12516
  * @example {
12325
12517
  * "data": {
12518
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
12519
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
12326
12520
  * "cancellation": {
12327
12521
  * "allowed": true,
12328
12522
  * "disabled_message": null
@@ -12335,8 +12529,10 @@ interface components {
12335
12529
  * "unix_ts": 1736464800,
12336
12530
  * "utc": "2025-03-01T04:00:00Z"
12337
12531
  * },
12532
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
12338
12533
  * "id": "appt_a1b2c3d4e5f6",
12339
12534
  * "object": "public_appointment",
12535
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
12340
12536
  * "rescheduling": {
12341
12537
  * "allowed": false,
12342
12538
  * "disabled_message": "Rescheduling is not available within 24 hours of your appointment"
@@ -12351,19 +12547,19 @@ interface components {
12351
12547
  * "status": "scheduled",
12352
12548
  * "urls": {
12353
12549
  * "add_to_calendar": [
12354
- * "https://example.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
12550
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
12355
12551
  * ],
12356
12552
  * "add_to_google_calendar": [
12357
- * "https://example.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
12553
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
12358
12554
  * ],
12359
12555
  * "cancel": [
12360
- * "https://example.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
12556
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
12361
12557
  * ],
12362
12558
  * "ics": [
12363
- * "https://example.com/c/appointments/appt_a1b2c3d4e5f6/ics"
12559
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
12364
12560
  * ],
12365
12561
  * "reschedule": [
12366
- * "https://example.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
12562
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
12367
12563
  * ]
12368
12564
  * }
12369
12565
  * }
@@ -13018,7 +13214,9 @@ interface components {
13018
13214
  * @description This is an object representing data for the appointment created event.
13019
13215
  * @example {
13020
13216
  * "object": {
13217
+ * "add_to_calendar_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar",
13021
13218
  * "appointment_type": "in_person",
13219
+ * "cancel_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel",
13022
13220
  * "cancellation_events": [
13023
13221
  * {
13024
13222
  * "actor": null,
@@ -13060,6 +13258,7 @@ interface components {
13060
13258
  * "reference_id": "ext_12345",
13061
13259
  * "time_zone": "America/Chicago"
13062
13260
  * },
13261
+ * "confirm_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm",
13063
13262
  * "confirmation_events": [
13064
13263
  * {
13065
13264
  * "actor": null,
@@ -13092,7 +13291,9 @@ interface components {
13092
13291
  * "unix_ts": 1736464800,
13093
13292
  * "utc": "2025-03-01T04:00:00Z"
13094
13293
  * },
13294
+ * "ics_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics",
13095
13295
  * "id": "appt_a1b2c3d4e5f6",
13296
+ * "join_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join",
13096
13297
  * "meeting": {
13097
13298
  * "conferencing_provider": "zoom_admin",
13098
13299
  * "error_message": null,
@@ -13168,6 +13369,7 @@ interface components {
13168
13369
  * "source": "client_ui"
13169
13370
  * }
13170
13371
  * ],
13372
+ * "reschedule_url": "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule",
13171
13373
  * "service": {
13172
13374
  * "appointment_type": "in_person",
13173
13375
  * "booking_policy": {
@@ -13261,23 +13463,26 @@ interface components {
13261
13463
  * "status": "scheduled",
13262
13464
  * "updated_at": "2025-03-10T14:30:00Z",
13263
13465
  * "urls": {
13466
+ * "add_to_calendar": [
13467
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_calendar"
13468
+ * ],
13264
13469
  * "add_to_google_calendar": [
13265
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
13470
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/add_to_google_calendar"
13266
13471
  * ],
13267
13472
  * "cancel": [
13268
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/cancel"
13473
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/cancel"
13269
13474
  * ],
13270
13475
  * "confirm": [
13271
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/confirm"
13476
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/confirm"
13272
13477
  * ],
13273
13478
  * "ics": [
13274
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/ics"
13479
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/ics"
13275
13480
  * ],
13276
13481
  * "join": [
13277
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/join"
13482
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/join"
13278
13483
  * ],
13279
13484
  * "reschedule": [
13280
- * "https://savvycal.app/c/appointments/appt_a1b2c3d4e5f6/reschedule"
13485
+ * "https://book.acme.com/c/appointments/appt_a1b2c3d4e5f6/reschedule"
13281
13486
  * ]
13282
13487
  * }
13283
13488
  * },