@savvycal/appointments-core 0.13.0 → 0.14.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 +220 -1
- package/dist/index.d.ts +220 -1
- package/package.json +1 -1
package/dist/index.d.cts
CHANGED
|
@@ -1435,6 +1435,9 @@ interface components {
|
|
|
1435
1435
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
1436
1436
|
* "last_name": "Smith",
|
|
1437
1437
|
* "locale": "en-US",
|
|
1438
|
+
* "metadata": {
|
|
1439
|
+
* "external_id": "123"
|
|
1440
|
+
* },
|
|
1438
1441
|
* "object": "client",
|
|
1439
1442
|
* "phone": "+15551234567",
|
|
1440
1443
|
* "reference_id": "ext_12345",
|
|
@@ -1572,6 +1575,9 @@ interface components {
|
|
|
1572
1575
|
* "duration": "PT1H30M",
|
|
1573
1576
|
* "id": "srv_d025a96ac0c6",
|
|
1574
1577
|
* "internal_name": null,
|
|
1578
|
+
* "metadata": {
|
|
1579
|
+
* "external_id": "123"
|
|
1580
|
+
* },
|
|
1575
1581
|
* "name": "Initial Consult",
|
|
1576
1582
|
* "object": "service",
|
|
1577
1583
|
* "provider_notifications": {
|
|
@@ -1672,6 +1678,28 @@ interface components {
|
|
|
1672
1678
|
*/
|
|
1673
1679
|
type: "appointment.rescheduled";
|
|
1674
1680
|
};
|
|
1681
|
+
/**
|
|
1682
|
+
* ForbiddenResponse
|
|
1683
|
+
* @description Response schema for forbidden requests
|
|
1684
|
+
* @example {
|
|
1685
|
+
* "errors": [
|
|
1686
|
+
* {
|
|
1687
|
+
* "detail": "Forbidden",
|
|
1688
|
+
* "status": "403"
|
|
1689
|
+
* }
|
|
1690
|
+
* ]
|
|
1691
|
+
* }
|
|
1692
|
+
*/
|
|
1693
|
+
ForbiddenResponse: {
|
|
1694
|
+
errors: {
|
|
1695
|
+
/** @description Error message */
|
|
1696
|
+
detail: string;
|
|
1697
|
+
/** @description HTTP status code */
|
|
1698
|
+
status?: string;
|
|
1699
|
+
/** @description Error title */
|
|
1700
|
+
title?: string;
|
|
1701
|
+
}[];
|
|
1702
|
+
};
|
|
1675
1703
|
/**
|
|
1676
1704
|
* ServiceSlotResponse
|
|
1677
1705
|
* @description Response schema for service slots
|
|
@@ -1947,6 +1975,9 @@ interface components {
|
|
|
1947
1975
|
* "duration": "PT1H30M",
|
|
1948
1976
|
* "id": "srv_d025a96ac0c6",
|
|
1949
1977
|
* "internal_name": null,
|
|
1978
|
+
* "metadata": {
|
|
1979
|
+
* "external_id": "123"
|
|
1980
|
+
* },
|
|
1950
1981
|
* "name": "Initial Consult",
|
|
1951
1982
|
* "object": "service",
|
|
1952
1983
|
* "provider_notifications": {
|
|
@@ -2189,6 +2220,9 @@ interface components {
|
|
|
2189
2220
|
* "duration": "PT1H30M",
|
|
2190
2221
|
* "id": "srv_d025a96ac0c6",
|
|
2191
2222
|
* "internal_name": null,
|
|
2223
|
+
* "metadata": {
|
|
2224
|
+
* "external_id": "123"
|
|
2225
|
+
* },
|
|
2192
2226
|
* "name": "Initial Consult",
|
|
2193
2227
|
* "object": "service",
|
|
2194
2228
|
* "provider_notifications": {
|
|
@@ -2478,6 +2512,9 @@ interface components {
|
|
|
2478
2512
|
* "duration": "PT1H30M",
|
|
2479
2513
|
* "id": "srv_d025a96ac0c6",
|
|
2480
2514
|
* "internal_name": null,
|
|
2515
|
+
* "metadata": {
|
|
2516
|
+
* "external_id": "123"
|
|
2517
|
+
* },
|
|
2481
2518
|
* "name": "Initial Consult",
|
|
2482
2519
|
* "object": "service",
|
|
2483
2520
|
* "provider_notifications": {
|
|
@@ -2604,6 +2641,9 @@ interface components {
|
|
|
2604
2641
|
* "duration": "PT1H30M",
|
|
2605
2642
|
* "id": "srv_d025a96ac0c6",
|
|
2606
2643
|
* "internal_name": null,
|
|
2644
|
+
* "metadata": {
|
|
2645
|
+
* "external_id": "123"
|
|
2646
|
+
* },
|
|
2607
2647
|
* "name": "Initial Consult",
|
|
2608
2648
|
* "object": "service",
|
|
2609
2649
|
* "provider_notifications": {
|
|
@@ -2944,6 +2984,9 @@ interface components {
|
|
|
2944
2984
|
* "duration": "PT1H30M",
|
|
2945
2985
|
* "id": "srv_d025a96ac0c6",
|
|
2946
2986
|
* "internal_name": null,
|
|
2987
|
+
* "metadata": {
|
|
2988
|
+
* "external_id": "123"
|
|
2989
|
+
* },
|
|
2947
2990
|
* "name": "Initial Consult",
|
|
2948
2991
|
* "object": "service",
|
|
2949
2992
|
* "provider_notifications": {
|
|
@@ -3102,6 +3145,9 @@ interface components {
|
|
|
3102
3145
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
3103
3146
|
* "last_name": "Smith",
|
|
3104
3147
|
* "locale": "en-US",
|
|
3148
|
+
* "metadata": {
|
|
3149
|
+
* "external_id": "123"
|
|
3150
|
+
* },
|
|
3105
3151
|
* "object": "client",
|
|
3106
3152
|
* "phone": "+15551234567",
|
|
3107
3153
|
* "reference_id": "ext_12345",
|
|
@@ -3234,6 +3280,9 @@ interface components {
|
|
|
3234
3280
|
* "duration": "PT1H30M",
|
|
3235
3281
|
* "id": "srv_d025a96ac0c6",
|
|
3236
3282
|
* "internal_name": null,
|
|
3283
|
+
* "metadata": {
|
|
3284
|
+
* "external_id": "123"
|
|
3285
|
+
* },
|
|
3237
3286
|
* "name": "Initial Consult",
|
|
3238
3287
|
* "object": "service",
|
|
3239
3288
|
* "provider_notifications": {
|
|
@@ -3552,6 +3601,9 @@ interface components {
|
|
|
3552
3601
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
3553
3602
|
* "last_name": "Smith",
|
|
3554
3603
|
* "locale": "en-US",
|
|
3604
|
+
* "metadata": {
|
|
3605
|
+
* "external_id": "123"
|
|
3606
|
+
* },
|
|
3555
3607
|
* "object": "client",
|
|
3556
3608
|
* "phone": "+15551234567",
|
|
3557
3609
|
* "reference_id": "ext_12345",
|
|
@@ -3581,6 +3633,10 @@ interface components {
|
|
|
3581
3633
|
* @example en-US
|
|
3582
3634
|
*/
|
|
3583
3635
|
locale: string;
|
|
3636
|
+
/** @description Set of key-value pairs attached to this client. Maximum size is 16 KB. */
|
|
3637
|
+
metadata?: {
|
|
3638
|
+
[key: string]: unknown;
|
|
3639
|
+
};
|
|
3584
3640
|
/**
|
|
3585
3641
|
* @description String representing the object's type.
|
|
3586
3642
|
* @enum {string}
|
|
@@ -3690,6 +3746,9 @@ interface components {
|
|
|
3690
3746
|
* "duration": "PT1H30M",
|
|
3691
3747
|
* "id": "srv_d025a96ac0c6",
|
|
3692
3748
|
* "internal_name": null,
|
|
3749
|
+
* "metadata": {
|
|
3750
|
+
* "external_id": "123"
|
|
3751
|
+
* },
|
|
3693
3752
|
* "name": "Initial Consult",
|
|
3694
3753
|
* "object": "service",
|
|
3695
3754
|
* "provider_notifications": {
|
|
@@ -3849,6 +3908,9 @@ interface components {
|
|
|
3849
3908
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
3850
3909
|
* "last_name": "Smith",
|
|
3851
3910
|
* "locale": "en-US",
|
|
3911
|
+
* "metadata": {
|
|
3912
|
+
* "external_id": "123"
|
|
3913
|
+
* },
|
|
3852
3914
|
* "object": "client",
|
|
3853
3915
|
* "phone": "+15551234567",
|
|
3854
3916
|
* "reference_id": "ext_12345",
|
|
@@ -3986,6 +4048,9 @@ interface components {
|
|
|
3986
4048
|
* "duration": "PT1H30M",
|
|
3987
4049
|
* "id": "srv_d025a96ac0c6",
|
|
3988
4050
|
* "internal_name": null,
|
|
4051
|
+
* "metadata": {
|
|
4052
|
+
* "external_id": "123"
|
|
4053
|
+
* },
|
|
3989
4054
|
* "name": "Initial Consult",
|
|
3990
4055
|
* "object": "service",
|
|
3991
4056
|
* "provider_notifications": {
|
|
@@ -4094,6 +4159,9 @@ interface components {
|
|
|
4094
4159
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
4095
4160
|
* "last_name": "Smith",
|
|
4096
4161
|
* "locale": "en-US",
|
|
4162
|
+
* "metadata": {
|
|
4163
|
+
* "external_id": "123"
|
|
4164
|
+
* },
|
|
4097
4165
|
* "object": "client",
|
|
4098
4166
|
* "phone": "+15551234567",
|
|
4099
4167
|
* "reference_id": "ext_12345",
|
|
@@ -4203,6 +4271,9 @@ interface components {
|
|
|
4203
4271
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
4204
4272
|
* "last_name": "Smith",
|
|
4205
4273
|
* "locale": "en-US",
|
|
4274
|
+
* "metadata": {
|
|
4275
|
+
* "external_id": "123"
|
|
4276
|
+
* },
|
|
4206
4277
|
* "object": "client",
|
|
4207
4278
|
* "phone": "+15551234567",
|
|
4208
4279
|
* "reference_id": "ext_12345",
|
|
@@ -4340,6 +4411,9 @@ interface components {
|
|
|
4340
4411
|
* "duration": "PT1H30M",
|
|
4341
4412
|
* "id": "srv_d025a96ac0c6",
|
|
4342
4413
|
* "internal_name": null,
|
|
4414
|
+
* "metadata": {
|
|
4415
|
+
* "external_id": "123"
|
|
4416
|
+
* },
|
|
4343
4417
|
* "name": "Initial Consult",
|
|
4344
4418
|
* "object": "service",
|
|
4345
4419
|
* "provider_notifications": {
|
|
@@ -4585,6 +4659,9 @@ interface components {
|
|
|
4585
4659
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
4586
4660
|
* "last_name": "Smith",
|
|
4587
4661
|
* "locale": "en-US",
|
|
4662
|
+
* "metadata": {
|
|
4663
|
+
* "external_id": "123"
|
|
4664
|
+
* },
|
|
4588
4665
|
* "object": "client",
|
|
4589
4666
|
* "phone": "+15551234567",
|
|
4590
4667
|
* "reference_id": "ext_12345",
|
|
@@ -4722,6 +4799,9 @@ interface components {
|
|
|
4722
4799
|
* "duration": "PT1H30M",
|
|
4723
4800
|
* "id": "srv_d025a96ac0c6",
|
|
4724
4801
|
* "internal_name": null,
|
|
4802
|
+
* "metadata": {
|
|
4803
|
+
* "external_id": "123"
|
|
4804
|
+
* },
|
|
4725
4805
|
* "name": "Initial Consult",
|
|
4726
4806
|
* "object": "service",
|
|
4727
4807
|
* "provider_notifications": {
|
|
@@ -4836,6 +4916,9 @@ interface components {
|
|
|
4836
4916
|
* "change_policy_text": "Appointments within 48 hours cannot be canceled or rescheduled online. Please call our office.",
|
|
4837
4917
|
* "duration": "PT1H30M",
|
|
4838
4918
|
* "internal_name": "IC - New Patient",
|
|
4919
|
+
* "metadata": {
|
|
4920
|
+
* "external_id": "123"
|
|
4921
|
+
* },
|
|
4839
4922
|
* "name": "Initial Consultation",
|
|
4840
4923
|
* "provider_notifications": {
|
|
4841
4924
|
* "additional_recipients": [
|
|
@@ -4894,6 +4977,10 @@ interface components {
|
|
|
4894
4977
|
duration?: string;
|
|
4895
4978
|
/** @description An optional internal label for admin use. When set, this is displayed in the admin UI instead of the public name. */
|
|
4896
4979
|
internal_name?: string | null;
|
|
4980
|
+
/** @description Set of key-value pairs to attach to this service. Maximum size is 16 KB. */
|
|
4981
|
+
metadata?: {
|
|
4982
|
+
[key: string]: unknown;
|
|
4983
|
+
};
|
|
4897
4984
|
/** @description The service name. */
|
|
4898
4985
|
name?: string;
|
|
4899
4986
|
provider_notifications?: components["schemas"]["ProviderNotificationConfig"];
|
|
@@ -4909,6 +4996,9 @@ interface components {
|
|
|
4909
4996
|
* "first_name": "John",
|
|
4910
4997
|
* "last_name": "Smith",
|
|
4911
4998
|
* "locale": "en",
|
|
4999
|
+
* "metadata": {
|
|
5000
|
+
* "external_id": "123"
|
|
5001
|
+
* },
|
|
4912
5002
|
* "phone": "+15551234567",
|
|
4913
5003
|
* "reference_id": "your-reference-id",
|
|
4914
5004
|
* "time_zone": "America/New_York"
|
|
@@ -4923,6 +5013,10 @@ interface components {
|
|
|
4923
5013
|
last_name?: string;
|
|
4924
5014
|
/** @description The client's locale. */
|
|
4925
5015
|
locale?: string;
|
|
5016
|
+
/** @description Set of key-value pairs to attach to this client. Maximum size is 16 KB. */
|
|
5017
|
+
metadata?: {
|
|
5018
|
+
[key: string]: unknown;
|
|
5019
|
+
};
|
|
4926
5020
|
/** @description The client's phone number (E.164 format). */
|
|
4927
5021
|
phone?: string;
|
|
4928
5022
|
/** @description The client's external reference identifier. */
|
|
@@ -5074,6 +5168,9 @@ interface components {
|
|
|
5074
5168
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
5075
5169
|
* "last_name": "Smith",
|
|
5076
5170
|
* "locale": "en-US",
|
|
5171
|
+
* "metadata": {
|
|
5172
|
+
* "external_id": "123"
|
|
5173
|
+
* },
|
|
5077
5174
|
* "object": "client",
|
|
5078
5175
|
* "phone": "+15551234567",
|
|
5079
5176
|
* "reference_id": "ext_12345",
|
|
@@ -5211,6 +5308,9 @@ interface components {
|
|
|
5211
5308
|
* "duration": "PT1H30M",
|
|
5212
5309
|
* "id": "srv_d025a96ac0c6",
|
|
5213
5310
|
* "internal_name": null,
|
|
5311
|
+
* "metadata": {
|
|
5312
|
+
* "external_id": "123"
|
|
5313
|
+
* },
|
|
5214
5314
|
* "name": "Initial Consult",
|
|
5215
5315
|
* "object": "service",
|
|
5216
5316
|
* "provider_notifications": {
|
|
@@ -5296,6 +5396,9 @@ interface components {
|
|
|
5296
5396
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
5297
5397
|
* "last_name": "Smith",
|
|
5298
5398
|
* "locale": "en-US",
|
|
5399
|
+
* "metadata": {
|
|
5400
|
+
* "external_id": "123"
|
|
5401
|
+
* },
|
|
5299
5402
|
* "object": "client",
|
|
5300
5403
|
* "phone": "+15551234567",
|
|
5301
5404
|
* "reference_id": "ext_12345",
|
|
@@ -5363,6 +5466,9 @@ interface components {
|
|
|
5363
5466
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
5364
5467
|
* "last_name": "Smith",
|
|
5365
5468
|
* "locale": "en-US",
|
|
5469
|
+
* "metadata": {
|
|
5470
|
+
* "external_id": "123"
|
|
5471
|
+
* },
|
|
5366
5472
|
* "object": "client",
|
|
5367
5473
|
* "phone": "+15551234567",
|
|
5368
5474
|
* "reference_id": "ext_12345",
|
|
@@ -5516,6 +5622,9 @@ interface components {
|
|
|
5516
5622
|
* "duration": "PT1H30M",
|
|
5517
5623
|
* "id": "srv_d025a96ac0c6",
|
|
5518
5624
|
* "internal_name": null,
|
|
5625
|
+
* "metadata": {
|
|
5626
|
+
* "external_id": "123"
|
|
5627
|
+
* },
|
|
5519
5628
|
* "name": "Initial Consult",
|
|
5520
5629
|
* "object": "service",
|
|
5521
5630
|
* "provider_notifications": {
|
|
@@ -5583,6 +5692,10 @@ interface components {
|
|
|
5583
5692
|
id: string;
|
|
5584
5693
|
/** @description An optional internal label for admin use. When set, this is displayed in the admin UI instead of the public name. */
|
|
5585
5694
|
internal_name?: string | null;
|
|
5695
|
+
/** @description Set of key-value pairs attached to this service. Maximum size is 16 KB. */
|
|
5696
|
+
metadata: {
|
|
5697
|
+
[key: string]: unknown;
|
|
5698
|
+
};
|
|
5586
5699
|
/** @description The name of the service. */
|
|
5587
5700
|
name: string;
|
|
5588
5701
|
/**
|
|
@@ -5865,6 +5978,9 @@ interface components {
|
|
|
5865
5978
|
* "duration": "PT1H30M",
|
|
5866
5979
|
* "id": "srv_d025a96ac0c6",
|
|
5867
5980
|
* "internal_name": null,
|
|
5981
|
+
* "metadata": {
|
|
5982
|
+
* "external_id": "123"
|
|
5983
|
+
* },
|
|
5868
5984
|
* "name": "Initial Consult",
|
|
5869
5985
|
* "object": "service",
|
|
5870
5986
|
* "provider_notifications": {
|
|
@@ -6158,6 +6274,9 @@ interface components {
|
|
|
6158
6274
|
* "duration": "PT1H30M",
|
|
6159
6275
|
* "id": "srv_d025a96ac0c6",
|
|
6160
6276
|
* "internal_name": null,
|
|
6277
|
+
* "metadata": {
|
|
6278
|
+
* "external_id": "123"
|
|
6279
|
+
* },
|
|
6161
6280
|
* "name": "Initial Consult",
|
|
6162
6281
|
* "object": "service",
|
|
6163
6282
|
* "provider_notifications": {
|
|
@@ -6409,6 +6528,9 @@ interface components {
|
|
|
6409
6528
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
6410
6529
|
* "last_name": "Smith",
|
|
6411
6530
|
* "locale": "en-US",
|
|
6531
|
+
* "metadata": {
|
|
6532
|
+
* "external_id": "123"
|
|
6533
|
+
* },
|
|
6412
6534
|
* "object": "client",
|
|
6413
6535
|
* "phone": "+15551234567",
|
|
6414
6536
|
* "reference_id": "ext_12345",
|
|
@@ -6546,6 +6668,9 @@ interface components {
|
|
|
6546
6668
|
* "duration": "PT1H30M",
|
|
6547
6669
|
* "id": "srv_d025a96ac0c6",
|
|
6548
6670
|
* "internal_name": null,
|
|
6671
|
+
* "metadata": {
|
|
6672
|
+
* "external_id": "123"
|
|
6673
|
+
* },
|
|
6549
6674
|
* "name": "Initial Consult",
|
|
6550
6675
|
* "object": "service",
|
|
6551
6676
|
* "provider_notifications": {
|
|
@@ -7380,6 +7505,9 @@ interface components {
|
|
|
7380
7505
|
* "duration": "PT1H30M",
|
|
7381
7506
|
* "id": "srv_d025a96ac0c6",
|
|
7382
7507
|
* "internal_name": null,
|
|
7508
|
+
* "metadata": {
|
|
7509
|
+
* "external_id": "123"
|
|
7510
|
+
* },
|
|
7383
7511
|
* "name": "Initial Consult",
|
|
7384
7512
|
* "object": "service",
|
|
7385
7513
|
* "provider_notifications": {
|
|
@@ -7489,6 +7617,9 @@ interface components {
|
|
|
7489
7617
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
7490
7618
|
* "last_name": "Smith",
|
|
7491
7619
|
* "locale": "en-US",
|
|
7620
|
+
* "metadata": {
|
|
7621
|
+
* "external_id": "123"
|
|
7622
|
+
* },
|
|
7492
7623
|
* "object": "client",
|
|
7493
7624
|
* "phone": "+15551234567",
|
|
7494
7625
|
* "reference_id": "ext_12345",
|
|
@@ -7626,6 +7757,9 @@ interface components {
|
|
|
7626
7757
|
* "duration": "PT1H30M",
|
|
7627
7758
|
* "id": "srv_d025a96ac0c6",
|
|
7628
7759
|
* "internal_name": null,
|
|
7760
|
+
* "metadata": {
|
|
7761
|
+
* "external_id": "123"
|
|
7762
|
+
* },
|
|
7629
7763
|
* "name": "Initial Consult",
|
|
7630
7764
|
* "object": "service",
|
|
7631
7765
|
* "provider_notifications": {
|
|
@@ -7717,6 +7851,9 @@ interface components {
|
|
|
7717
7851
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
7718
7852
|
* "last_name": "Smith",
|
|
7719
7853
|
* "locale": "en-US",
|
|
7854
|
+
* "metadata": {
|
|
7855
|
+
* "external_id": "123"
|
|
7856
|
+
* },
|
|
7720
7857
|
* "object": "client",
|
|
7721
7858
|
* "phone": "+15551234567",
|
|
7722
7859
|
* "reference_id": "ext_12345",
|
|
@@ -7934,6 +8071,9 @@ interface components {
|
|
|
7934
8071
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
7935
8072
|
* "last_name": "Smith",
|
|
7936
8073
|
* "locale": "en-US",
|
|
8074
|
+
* "metadata": {
|
|
8075
|
+
* "external_id": "123"
|
|
8076
|
+
* },
|
|
7937
8077
|
* "object": "client",
|
|
7938
8078
|
* "phone": "+15551234567",
|
|
7939
8079
|
* "reference_id": "ext_12345",
|
|
@@ -8071,6 +8211,9 @@ interface components {
|
|
|
8071
8211
|
* "duration": "PT1H30M",
|
|
8072
8212
|
* "id": "srv_d025a96ac0c6",
|
|
8073
8213
|
* "internal_name": null,
|
|
8214
|
+
* "metadata": {
|
|
8215
|
+
* "external_id": "123"
|
|
8216
|
+
* },
|
|
8074
8217
|
* "name": "Initial Consult",
|
|
8075
8218
|
* "object": "service",
|
|
8076
8219
|
* "provider_notifications": {
|
|
@@ -8473,6 +8616,9 @@ interface components {
|
|
|
8473
8616
|
* "duration": "PT1H30M",
|
|
8474
8617
|
* "id": "srv_d025a96ac0c6",
|
|
8475
8618
|
* "internal_name": null,
|
|
8619
|
+
* "metadata": {
|
|
8620
|
+
* "external_id": "123"
|
|
8621
|
+
* },
|
|
8476
8622
|
* "name": "Initial Consult",
|
|
8477
8623
|
* "object": "service",
|
|
8478
8624
|
* "provider_notifications": {
|
|
@@ -8666,6 +8812,9 @@ interface components {
|
|
|
8666
8812
|
* "duration": "PT1H30M",
|
|
8667
8813
|
* "id": "srv_d025a96ac0c6",
|
|
8668
8814
|
* "internal_name": null,
|
|
8815
|
+
* "metadata": {
|
|
8816
|
+
* "external_id": "123"
|
|
8817
|
+
* },
|
|
8669
8818
|
* "name": "Initial Consult",
|
|
8670
8819
|
* "object": "service",
|
|
8671
8820
|
* "provider_notifications": {
|
|
@@ -8820,6 +8969,9 @@ interface components {
|
|
|
8820
8969
|
* "change_policy_text": "Appointments within 48 hours cannot be canceled or rescheduled online. Please call our office.",
|
|
8821
8970
|
* "duration": "PT1H30M",
|
|
8822
8971
|
* "internal_name": "IC - New Patient",
|
|
8972
|
+
* "metadata": {
|
|
8973
|
+
* "external_id": "123"
|
|
8974
|
+
* },
|
|
8823
8975
|
* "name": "Initial Consult",
|
|
8824
8976
|
* "provider_notifications": {
|
|
8825
8977
|
* "additional_recipients": [
|
|
@@ -8878,6 +9030,10 @@ interface components {
|
|
|
8878
9030
|
duration?: string;
|
|
8879
9031
|
/** @description An optional internal label for admin use. When set, this is displayed in the admin UI instead of the public name. */
|
|
8880
9032
|
internal_name?: string | null;
|
|
9033
|
+
/** @description Set of key-value pairs to attach to this service. Maximum size is 16 KB. */
|
|
9034
|
+
metadata?: {
|
|
9035
|
+
[key: string]: unknown;
|
|
9036
|
+
};
|
|
8881
9037
|
/** @description The service name. */
|
|
8882
9038
|
name: string;
|
|
8883
9039
|
provider_notifications?: components["schemas"]["ProviderNotificationConfig"];
|
|
@@ -8914,6 +9070,9 @@ interface components {
|
|
|
8914
9070
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
8915
9071
|
* "last_name": "Smith",
|
|
8916
9072
|
* "locale": "en-US",
|
|
9073
|
+
* "metadata": {
|
|
9074
|
+
* "external_id": "123"
|
|
9075
|
+
* },
|
|
8917
9076
|
* "object": "client",
|
|
8918
9077
|
* "phone": "+15551234567",
|
|
8919
9078
|
* "reference_id": "ext_12345",
|
|
@@ -9051,6 +9210,9 @@ interface components {
|
|
|
9051
9210
|
* "duration": "PT1H30M",
|
|
9052
9211
|
* "id": "srv_d025a96ac0c6",
|
|
9053
9212
|
* "internal_name": null,
|
|
9213
|
+
* "metadata": {
|
|
9214
|
+
* "external_id": "123"
|
|
9215
|
+
* },
|
|
9054
9216
|
* "name": "Initial Consult",
|
|
9055
9217
|
* "object": "service",
|
|
9056
9218
|
* "provider_notifications": {
|
|
@@ -9177,6 +9339,9 @@ interface components {
|
|
|
9177
9339
|
* "first_name": "John",
|
|
9178
9340
|
* "last_name": "Smith",
|
|
9179
9341
|
* "locale": "en",
|
|
9342
|
+
* "metadata": {
|
|
9343
|
+
* "external_id": "123"
|
|
9344
|
+
* },
|
|
9180
9345
|
* "phone": "+15551234567",
|
|
9181
9346
|
* "reference_id": "your-reference-id",
|
|
9182
9347
|
* "time_zone": "America/New_York"
|
|
@@ -9191,6 +9356,10 @@ interface components {
|
|
|
9191
9356
|
last_name: string;
|
|
9192
9357
|
/** @description The client's locale. */
|
|
9193
9358
|
locale?: string;
|
|
9359
|
+
/** @description Set of key-value pairs to attach to this client. Maximum size is 16 KB. */
|
|
9360
|
+
metadata?: {
|
|
9361
|
+
[key: string]: unknown;
|
|
9362
|
+
};
|
|
9194
9363
|
/** @description The client's phone number (E.164 format). */
|
|
9195
9364
|
phone?: string;
|
|
9196
9365
|
/** @description The client's external reference identifier. */
|
|
@@ -10601,6 +10770,10 @@ interface operations {
|
|
|
10601
10770
|
page?: number;
|
|
10602
10771
|
/** @description Number of items per page */
|
|
10603
10772
|
page_size?: number;
|
|
10773
|
+
/** @description Filter services by metadata using bracket notation. See [Metadata Filtering](https://developers.savvycal.app/metadata-filtering) for more details. */
|
|
10774
|
+
metadata?: {
|
|
10775
|
+
[key: string]: unknown;
|
|
10776
|
+
};
|
|
10604
10777
|
};
|
|
10605
10778
|
header?: {
|
|
10606
10779
|
/**
|
|
@@ -11418,6 +11591,10 @@ interface operations {
|
|
|
11418
11591
|
page_size?: number;
|
|
11419
11592
|
/** @description Only return clients that match the search query (name or email). */
|
|
11420
11593
|
search?: string;
|
|
11594
|
+
/** @description Filter clients by metadata using bracket notation. See [Metadata Filtering](https://developers.savvycal.app/metadata-filtering) for more details. */
|
|
11595
|
+
metadata?: {
|
|
11596
|
+
[key: string]: unknown;
|
|
11597
|
+
};
|
|
11421
11598
|
};
|
|
11422
11599
|
header?: {
|
|
11423
11600
|
/**
|
|
@@ -12361,6 +12538,15 @@ interface operations {
|
|
|
12361
12538
|
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
12362
12539
|
};
|
|
12363
12540
|
};
|
|
12541
|
+
/** @description Forbidden */
|
|
12542
|
+
403: {
|
|
12543
|
+
headers: {
|
|
12544
|
+
[name: string]: unknown;
|
|
12545
|
+
};
|
|
12546
|
+
content: {
|
|
12547
|
+
"application/json": components["schemas"]["ForbiddenResponse"];
|
|
12548
|
+
};
|
|
12549
|
+
};
|
|
12364
12550
|
/** @description Unprocessable Entity */
|
|
12365
12551
|
422: {
|
|
12366
12552
|
headers: {
|
|
@@ -13136,6 +13322,7 @@ type CreateServiceProviderRequest = Schemas["CreateServiceProviderRequest"];
|
|
|
13136
13322
|
type CreateServiceRequest = Schemas["CreateServiceRequest"];
|
|
13137
13323
|
type DashboardSession = Schemas["DashboardSession"];
|
|
13138
13324
|
type DashboardSessionResponse = Schemas["DashboardSessionResponse"];
|
|
13325
|
+
type ForbiddenResponse = Schemas["ForbiddenResponse"];
|
|
13139
13326
|
type GenericErrorResponse = Schemas["GenericErrorResponse"];
|
|
13140
13327
|
type HoldPolicy = Schemas["HoldPolicy"];
|
|
13141
13328
|
type JsonErrorResponse = Schemas["JsonErrorResponse"];
|
|
@@ -14061,6 +14248,9 @@ declare function createClient(client: FetchClient, body: RequestBody<"/v1/client
|
|
|
14061
14248
|
first_name: string;
|
|
14062
14249
|
last_name: string;
|
|
14063
14250
|
locale?: string;
|
|
14251
|
+
metadata?: {
|
|
14252
|
+
[key: string]: unknown;
|
|
14253
|
+
};
|
|
14064
14254
|
phone?: string;
|
|
14065
14255
|
reference_id?: string;
|
|
14066
14256
|
time_zone: string;
|
|
@@ -14374,6 +14564,9 @@ declare function createService(client: FetchClient, body: RequestBody<"/v1/servi
|
|
|
14374
14564
|
change_policy_text?: string;
|
|
14375
14565
|
duration?: string;
|
|
14376
14566
|
internal_name?: string | null;
|
|
14567
|
+
metadata?: {
|
|
14568
|
+
[key: string]: unknown;
|
|
14569
|
+
};
|
|
14377
14570
|
name: string;
|
|
14378
14571
|
provider_notifications?: components["schemas"]["ProviderNotificationConfig"];
|
|
14379
14572
|
rescheduling_policy?: components["schemas"]["ReschedulingPolicy"];
|
|
@@ -15769,6 +15962,14 @@ declare function listAppointments(client: FetchClient, query?: QueryParams<"/v1/
|
|
|
15769
15962
|
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
15770
15963
|
};
|
|
15771
15964
|
};
|
|
15965
|
+
403: {
|
|
15966
|
+
headers: {
|
|
15967
|
+
[name: string]: unknown;
|
|
15968
|
+
};
|
|
15969
|
+
content: {
|
|
15970
|
+
"application/json": components["schemas"]["ForbiddenResponse"];
|
|
15971
|
+
};
|
|
15972
|
+
};
|
|
15772
15973
|
422: {
|
|
15773
15974
|
headers: {
|
|
15774
15975
|
[name: string]: unknown;
|
|
@@ -16015,6 +16216,9 @@ declare function listClients(client: FetchClient, query?: QueryParams<"/v1/clien
|
|
|
16015
16216
|
page?: number;
|
|
16016
16217
|
page_size?: number;
|
|
16017
16218
|
search?: string;
|
|
16219
|
+
metadata?: {
|
|
16220
|
+
[key: string]: unknown;
|
|
16221
|
+
};
|
|
16018
16222
|
};
|
|
16019
16223
|
header?: {
|
|
16020
16224
|
"X-SavvyCal-Account"?: string;
|
|
@@ -16055,6 +16259,9 @@ declare function listClients(client: FetchClient, query?: QueryParams<"/v1/clien
|
|
|
16055
16259
|
page?: number;
|
|
16056
16260
|
page_size?: number;
|
|
16057
16261
|
search?: string;
|
|
16262
|
+
metadata?: {
|
|
16263
|
+
[key: string]: unknown;
|
|
16264
|
+
};
|
|
16058
16265
|
} | undefined;
|
|
16059
16266
|
};
|
|
16060
16267
|
}, `${string}/${string}`>>;
|
|
@@ -16441,6 +16648,9 @@ declare function listServices(client: FetchClient, query?: QueryParams<"/v1/serv
|
|
|
16441
16648
|
query?: {
|
|
16442
16649
|
page?: number;
|
|
16443
16650
|
page_size?: number;
|
|
16651
|
+
metadata?: {
|
|
16652
|
+
[key: string]: unknown;
|
|
16653
|
+
};
|
|
16444
16654
|
};
|
|
16445
16655
|
header?: {
|
|
16446
16656
|
"X-SavvyCal-Account"?: string;
|
|
@@ -16480,6 +16690,9 @@ declare function listServices(client: FetchClient, query?: QueryParams<"/v1/serv
|
|
|
16480
16690
|
query: {
|
|
16481
16691
|
page?: number;
|
|
16482
16692
|
page_size?: number;
|
|
16693
|
+
metadata?: {
|
|
16694
|
+
[key: string]: unknown;
|
|
16695
|
+
};
|
|
16483
16696
|
} | undefined;
|
|
16484
16697
|
};
|
|
16485
16698
|
}, `${string}/${string}`>>;
|
|
@@ -17046,6 +17259,9 @@ declare function updateClient(client: FetchClient, path: PathParams<"/v1/clients
|
|
|
17046
17259
|
first_name?: string;
|
|
17047
17260
|
last_name?: string;
|
|
17048
17261
|
locale?: string;
|
|
17262
|
+
metadata?: {
|
|
17263
|
+
[key: string]: unknown;
|
|
17264
|
+
};
|
|
17049
17265
|
phone?: string;
|
|
17050
17266
|
reference_id?: string;
|
|
17051
17267
|
time_zone?: string;
|
|
@@ -17356,6 +17572,9 @@ declare function updateService(client: FetchClient, path: PathParams<"/v1/servic
|
|
|
17356
17572
|
change_policy_text?: string;
|
|
17357
17573
|
duration?: string;
|
|
17358
17574
|
internal_name?: string | null;
|
|
17575
|
+
metadata?: {
|
|
17576
|
+
[key: string]: unknown;
|
|
17577
|
+
};
|
|
17359
17578
|
name?: string;
|
|
17360
17579
|
provider_notifications?: components["schemas"]["ProviderNotificationConfig"];
|
|
17361
17580
|
rescheduling_policy?: components["schemas"]["ReschedulingPolicy"];
|
|
@@ -17368,4 +17587,4 @@ declare function updateService(client: FetchClient, path: PathParams<"/v1/servic
|
|
|
17368
17587
|
};
|
|
17369
17588
|
}, `${string}/${string}`>>;
|
|
17370
17589
|
|
|
17371
|
-
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 AppointmentRescheduledEventData, type AppointmentResponse, type AppointmentsResponse, type Block, type BlockCreatedEventData, type BlockDeletedEventData, type BlockResponse, type BlockUpdatedEventData, type BlocksResponse, type BookingIntent, type BookingIntentAbandonedEventData, type BookingIntentCompletedEventData, type BookingIntentCreatedEventData, type BookingIntentResponse, type BookingIntentUpdatedEventData, 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 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 CreateClientRequest, type CreateDashboardSessionRequest, type CreateProviderRequest, type CreateProviderScheduleRequest, type CreatePublicAppointmentRequest, type CreatePublicBookingIntentRequest, type CreateServiceProviderRequest, type CreateServiceRequest, type DashboardSession, type DashboardSessionResponse, type FetchClient, type FetchClientOptions, type GenericErrorResponse, type HoldPolicy, 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 PublicServiceSlotsResponse, 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 ServiceProvider, type ServiceProviderCreatedEventData, type ServiceProviderDeletedEventData, type ServiceProviderResponse, type ServiceProvidersResponse, type ServiceResponse, type ServiceSlotResponse, type ServiceUpdatedEventData, type ServicesResponse, type Slot, type SlotRule, type UnauthorizedResponse, type UpdateAccountRequest, type UpdateAccountUserRequest, type UpdateBlockRequest, type UpdateBookingIntentRequest, type UpdateCancellationReasonRequest, type UpdateClientRequest, type UpdateConnectedAccountRequest, type UpdateProviderRequest, type UpdateProviderScheduleRequest, type UpdatePublicBookingIntentRequest, type UpdateServiceRequest, type User, type WeeklyRule, type ZonedDateTime, abandonBookingIntent, abandonPublicBookingIntent, cancelAppointment, cancelPublicAppointment, completeBookingIntent, completePublicBookingIntent, confirmAppointment, createAccount, createAccountUser, createAppointment, createBlock, createBookingIntent, createCancellationReason, createClient, createDashboardSession, createFetchClient, createProvider, createProviderSchedule, createPublicAppointment, createPublicBookingIntent, createService, createServiceProvider, deactivateProvider, deleteBlock, deleteCancellationReason, deleteClient, deleteConnectedAccount, deleteProviderSchedule, deleteService, deleteServiceProvider, getAccountById, getAppointment, getBlock, getBookingIntent, getCancellationReason, getClient, getConnectedAccount, getCurrentAccount, getCurrentAccountUser, getCurrentPlatform, getEarliestPublicServiceSlot, getProvider, getProviderSchedule, getPublicAppointment, getPublicBookingIntent, getService, listAccountUsers, listAccounts, listAppointments, listBlocks, listBookingIntents, listCancellationReasons, listClients, listConnectedAccounts, listProviderSchedules, listProviders, listPublicCancellationReasons, listPublicServiceSlots, listRoles, listServiceProviders, listServiceSlots, listServices, type paths, rescheduleAppointment, reschedulePublicAppointment, updateAccount, updateAccountUser, updateBlock, updateBookingIntent, updateCancellationReason, updateClient, updateConnectedAccount, updateProvider, updateProviderSchedule, updatePublicBookingIntent, updateService };
|
|
17590
|
+
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 AppointmentRescheduledEventData, type AppointmentResponse, type AppointmentsResponse, type Block, type BlockCreatedEventData, type BlockDeletedEventData, type BlockResponse, type BlockUpdatedEventData, type BlocksResponse, type BookingIntent, type BookingIntentAbandonedEventData, type BookingIntentCompletedEventData, type BookingIntentCreatedEventData, type BookingIntentResponse, type BookingIntentUpdatedEventData, 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 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 CreateClientRequest, type CreateDashboardSessionRequest, type CreateProviderRequest, type CreateProviderScheduleRequest, type CreatePublicAppointmentRequest, type CreatePublicBookingIntentRequest, type CreateServiceProviderRequest, type CreateServiceRequest, type DashboardSession, type DashboardSessionResponse, type FetchClient, type FetchClientOptions, type ForbiddenResponse, type GenericErrorResponse, type HoldPolicy, 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 PublicServiceSlotsResponse, 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 ServiceProvider, type ServiceProviderCreatedEventData, type ServiceProviderDeletedEventData, type ServiceProviderResponse, type ServiceProvidersResponse, type ServiceResponse, type ServiceSlotResponse, type ServiceUpdatedEventData, type ServicesResponse, type Slot, type SlotRule, type UnauthorizedResponse, type UpdateAccountRequest, type UpdateAccountUserRequest, type UpdateBlockRequest, type UpdateBookingIntentRequest, type UpdateCancellationReasonRequest, type UpdateClientRequest, type UpdateConnectedAccountRequest, type UpdateProviderRequest, type UpdateProviderScheduleRequest, type UpdatePublicBookingIntentRequest, type UpdateServiceRequest, type User, type WeeklyRule, type ZonedDateTime, abandonBookingIntent, abandonPublicBookingIntent, cancelAppointment, cancelPublicAppointment, completeBookingIntent, completePublicBookingIntent, confirmAppointment, createAccount, createAccountUser, createAppointment, createBlock, createBookingIntent, createCancellationReason, createClient, createDashboardSession, createFetchClient, createProvider, createProviderSchedule, createPublicAppointment, createPublicBookingIntent, createService, createServiceProvider, deactivateProvider, deleteBlock, deleteCancellationReason, deleteClient, deleteConnectedAccount, deleteProviderSchedule, deleteService, deleteServiceProvider, getAccountById, getAppointment, getBlock, getBookingIntent, getCancellationReason, getClient, getConnectedAccount, getCurrentAccount, getCurrentAccountUser, getCurrentPlatform, getEarliestPublicServiceSlot, getProvider, getProviderSchedule, getPublicAppointment, getPublicBookingIntent, getService, listAccountUsers, listAccounts, listAppointments, listBlocks, listBookingIntents, listCancellationReasons, listClients, listConnectedAccounts, listProviderSchedules, listProviders, listPublicCancellationReasons, listPublicServiceSlots, listRoles, listServiceProviders, listServiceSlots, listServices, type paths, rescheduleAppointment, reschedulePublicAppointment, updateAccount, updateAccountUser, updateBlock, updateBookingIntent, updateCancellationReason, updateClient, updateConnectedAccount, updateProvider, updateProviderSchedule, updatePublicBookingIntent, updateService };
|
package/dist/index.d.ts
CHANGED
|
@@ -1435,6 +1435,9 @@ interface components {
|
|
|
1435
1435
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
1436
1436
|
* "last_name": "Smith",
|
|
1437
1437
|
* "locale": "en-US",
|
|
1438
|
+
* "metadata": {
|
|
1439
|
+
* "external_id": "123"
|
|
1440
|
+
* },
|
|
1438
1441
|
* "object": "client",
|
|
1439
1442
|
* "phone": "+15551234567",
|
|
1440
1443
|
* "reference_id": "ext_12345",
|
|
@@ -1572,6 +1575,9 @@ interface components {
|
|
|
1572
1575
|
* "duration": "PT1H30M",
|
|
1573
1576
|
* "id": "srv_d025a96ac0c6",
|
|
1574
1577
|
* "internal_name": null,
|
|
1578
|
+
* "metadata": {
|
|
1579
|
+
* "external_id": "123"
|
|
1580
|
+
* },
|
|
1575
1581
|
* "name": "Initial Consult",
|
|
1576
1582
|
* "object": "service",
|
|
1577
1583
|
* "provider_notifications": {
|
|
@@ -1672,6 +1678,28 @@ interface components {
|
|
|
1672
1678
|
*/
|
|
1673
1679
|
type: "appointment.rescheduled";
|
|
1674
1680
|
};
|
|
1681
|
+
/**
|
|
1682
|
+
* ForbiddenResponse
|
|
1683
|
+
* @description Response schema for forbidden requests
|
|
1684
|
+
* @example {
|
|
1685
|
+
* "errors": [
|
|
1686
|
+
* {
|
|
1687
|
+
* "detail": "Forbidden",
|
|
1688
|
+
* "status": "403"
|
|
1689
|
+
* }
|
|
1690
|
+
* ]
|
|
1691
|
+
* }
|
|
1692
|
+
*/
|
|
1693
|
+
ForbiddenResponse: {
|
|
1694
|
+
errors: {
|
|
1695
|
+
/** @description Error message */
|
|
1696
|
+
detail: string;
|
|
1697
|
+
/** @description HTTP status code */
|
|
1698
|
+
status?: string;
|
|
1699
|
+
/** @description Error title */
|
|
1700
|
+
title?: string;
|
|
1701
|
+
}[];
|
|
1702
|
+
};
|
|
1675
1703
|
/**
|
|
1676
1704
|
* ServiceSlotResponse
|
|
1677
1705
|
* @description Response schema for service slots
|
|
@@ -1947,6 +1975,9 @@ interface components {
|
|
|
1947
1975
|
* "duration": "PT1H30M",
|
|
1948
1976
|
* "id": "srv_d025a96ac0c6",
|
|
1949
1977
|
* "internal_name": null,
|
|
1978
|
+
* "metadata": {
|
|
1979
|
+
* "external_id": "123"
|
|
1980
|
+
* },
|
|
1950
1981
|
* "name": "Initial Consult",
|
|
1951
1982
|
* "object": "service",
|
|
1952
1983
|
* "provider_notifications": {
|
|
@@ -2189,6 +2220,9 @@ interface components {
|
|
|
2189
2220
|
* "duration": "PT1H30M",
|
|
2190
2221
|
* "id": "srv_d025a96ac0c6",
|
|
2191
2222
|
* "internal_name": null,
|
|
2223
|
+
* "metadata": {
|
|
2224
|
+
* "external_id": "123"
|
|
2225
|
+
* },
|
|
2192
2226
|
* "name": "Initial Consult",
|
|
2193
2227
|
* "object": "service",
|
|
2194
2228
|
* "provider_notifications": {
|
|
@@ -2478,6 +2512,9 @@ interface components {
|
|
|
2478
2512
|
* "duration": "PT1H30M",
|
|
2479
2513
|
* "id": "srv_d025a96ac0c6",
|
|
2480
2514
|
* "internal_name": null,
|
|
2515
|
+
* "metadata": {
|
|
2516
|
+
* "external_id": "123"
|
|
2517
|
+
* },
|
|
2481
2518
|
* "name": "Initial Consult",
|
|
2482
2519
|
* "object": "service",
|
|
2483
2520
|
* "provider_notifications": {
|
|
@@ -2604,6 +2641,9 @@ interface components {
|
|
|
2604
2641
|
* "duration": "PT1H30M",
|
|
2605
2642
|
* "id": "srv_d025a96ac0c6",
|
|
2606
2643
|
* "internal_name": null,
|
|
2644
|
+
* "metadata": {
|
|
2645
|
+
* "external_id": "123"
|
|
2646
|
+
* },
|
|
2607
2647
|
* "name": "Initial Consult",
|
|
2608
2648
|
* "object": "service",
|
|
2609
2649
|
* "provider_notifications": {
|
|
@@ -2944,6 +2984,9 @@ interface components {
|
|
|
2944
2984
|
* "duration": "PT1H30M",
|
|
2945
2985
|
* "id": "srv_d025a96ac0c6",
|
|
2946
2986
|
* "internal_name": null,
|
|
2987
|
+
* "metadata": {
|
|
2988
|
+
* "external_id": "123"
|
|
2989
|
+
* },
|
|
2947
2990
|
* "name": "Initial Consult",
|
|
2948
2991
|
* "object": "service",
|
|
2949
2992
|
* "provider_notifications": {
|
|
@@ -3102,6 +3145,9 @@ interface components {
|
|
|
3102
3145
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
3103
3146
|
* "last_name": "Smith",
|
|
3104
3147
|
* "locale": "en-US",
|
|
3148
|
+
* "metadata": {
|
|
3149
|
+
* "external_id": "123"
|
|
3150
|
+
* },
|
|
3105
3151
|
* "object": "client",
|
|
3106
3152
|
* "phone": "+15551234567",
|
|
3107
3153
|
* "reference_id": "ext_12345",
|
|
@@ -3234,6 +3280,9 @@ interface components {
|
|
|
3234
3280
|
* "duration": "PT1H30M",
|
|
3235
3281
|
* "id": "srv_d025a96ac0c6",
|
|
3236
3282
|
* "internal_name": null,
|
|
3283
|
+
* "metadata": {
|
|
3284
|
+
* "external_id": "123"
|
|
3285
|
+
* },
|
|
3237
3286
|
* "name": "Initial Consult",
|
|
3238
3287
|
* "object": "service",
|
|
3239
3288
|
* "provider_notifications": {
|
|
@@ -3552,6 +3601,9 @@ interface components {
|
|
|
3552
3601
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
3553
3602
|
* "last_name": "Smith",
|
|
3554
3603
|
* "locale": "en-US",
|
|
3604
|
+
* "metadata": {
|
|
3605
|
+
* "external_id": "123"
|
|
3606
|
+
* },
|
|
3555
3607
|
* "object": "client",
|
|
3556
3608
|
* "phone": "+15551234567",
|
|
3557
3609
|
* "reference_id": "ext_12345",
|
|
@@ -3581,6 +3633,10 @@ interface components {
|
|
|
3581
3633
|
* @example en-US
|
|
3582
3634
|
*/
|
|
3583
3635
|
locale: string;
|
|
3636
|
+
/** @description Set of key-value pairs attached to this client. Maximum size is 16 KB. */
|
|
3637
|
+
metadata?: {
|
|
3638
|
+
[key: string]: unknown;
|
|
3639
|
+
};
|
|
3584
3640
|
/**
|
|
3585
3641
|
* @description String representing the object's type.
|
|
3586
3642
|
* @enum {string}
|
|
@@ -3690,6 +3746,9 @@ interface components {
|
|
|
3690
3746
|
* "duration": "PT1H30M",
|
|
3691
3747
|
* "id": "srv_d025a96ac0c6",
|
|
3692
3748
|
* "internal_name": null,
|
|
3749
|
+
* "metadata": {
|
|
3750
|
+
* "external_id": "123"
|
|
3751
|
+
* },
|
|
3693
3752
|
* "name": "Initial Consult",
|
|
3694
3753
|
* "object": "service",
|
|
3695
3754
|
* "provider_notifications": {
|
|
@@ -3849,6 +3908,9 @@ interface components {
|
|
|
3849
3908
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
3850
3909
|
* "last_name": "Smith",
|
|
3851
3910
|
* "locale": "en-US",
|
|
3911
|
+
* "metadata": {
|
|
3912
|
+
* "external_id": "123"
|
|
3913
|
+
* },
|
|
3852
3914
|
* "object": "client",
|
|
3853
3915
|
* "phone": "+15551234567",
|
|
3854
3916
|
* "reference_id": "ext_12345",
|
|
@@ -3986,6 +4048,9 @@ interface components {
|
|
|
3986
4048
|
* "duration": "PT1H30M",
|
|
3987
4049
|
* "id": "srv_d025a96ac0c6",
|
|
3988
4050
|
* "internal_name": null,
|
|
4051
|
+
* "metadata": {
|
|
4052
|
+
* "external_id": "123"
|
|
4053
|
+
* },
|
|
3989
4054
|
* "name": "Initial Consult",
|
|
3990
4055
|
* "object": "service",
|
|
3991
4056
|
* "provider_notifications": {
|
|
@@ -4094,6 +4159,9 @@ interface components {
|
|
|
4094
4159
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
4095
4160
|
* "last_name": "Smith",
|
|
4096
4161
|
* "locale": "en-US",
|
|
4162
|
+
* "metadata": {
|
|
4163
|
+
* "external_id": "123"
|
|
4164
|
+
* },
|
|
4097
4165
|
* "object": "client",
|
|
4098
4166
|
* "phone": "+15551234567",
|
|
4099
4167
|
* "reference_id": "ext_12345",
|
|
@@ -4203,6 +4271,9 @@ interface components {
|
|
|
4203
4271
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
4204
4272
|
* "last_name": "Smith",
|
|
4205
4273
|
* "locale": "en-US",
|
|
4274
|
+
* "metadata": {
|
|
4275
|
+
* "external_id": "123"
|
|
4276
|
+
* },
|
|
4206
4277
|
* "object": "client",
|
|
4207
4278
|
* "phone": "+15551234567",
|
|
4208
4279
|
* "reference_id": "ext_12345",
|
|
@@ -4340,6 +4411,9 @@ interface components {
|
|
|
4340
4411
|
* "duration": "PT1H30M",
|
|
4341
4412
|
* "id": "srv_d025a96ac0c6",
|
|
4342
4413
|
* "internal_name": null,
|
|
4414
|
+
* "metadata": {
|
|
4415
|
+
* "external_id": "123"
|
|
4416
|
+
* },
|
|
4343
4417
|
* "name": "Initial Consult",
|
|
4344
4418
|
* "object": "service",
|
|
4345
4419
|
* "provider_notifications": {
|
|
@@ -4585,6 +4659,9 @@ interface components {
|
|
|
4585
4659
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
4586
4660
|
* "last_name": "Smith",
|
|
4587
4661
|
* "locale": "en-US",
|
|
4662
|
+
* "metadata": {
|
|
4663
|
+
* "external_id": "123"
|
|
4664
|
+
* },
|
|
4588
4665
|
* "object": "client",
|
|
4589
4666
|
* "phone": "+15551234567",
|
|
4590
4667
|
* "reference_id": "ext_12345",
|
|
@@ -4722,6 +4799,9 @@ interface components {
|
|
|
4722
4799
|
* "duration": "PT1H30M",
|
|
4723
4800
|
* "id": "srv_d025a96ac0c6",
|
|
4724
4801
|
* "internal_name": null,
|
|
4802
|
+
* "metadata": {
|
|
4803
|
+
* "external_id": "123"
|
|
4804
|
+
* },
|
|
4725
4805
|
* "name": "Initial Consult",
|
|
4726
4806
|
* "object": "service",
|
|
4727
4807
|
* "provider_notifications": {
|
|
@@ -4836,6 +4916,9 @@ interface components {
|
|
|
4836
4916
|
* "change_policy_text": "Appointments within 48 hours cannot be canceled or rescheduled online. Please call our office.",
|
|
4837
4917
|
* "duration": "PT1H30M",
|
|
4838
4918
|
* "internal_name": "IC - New Patient",
|
|
4919
|
+
* "metadata": {
|
|
4920
|
+
* "external_id": "123"
|
|
4921
|
+
* },
|
|
4839
4922
|
* "name": "Initial Consultation",
|
|
4840
4923
|
* "provider_notifications": {
|
|
4841
4924
|
* "additional_recipients": [
|
|
@@ -4894,6 +4977,10 @@ interface components {
|
|
|
4894
4977
|
duration?: string;
|
|
4895
4978
|
/** @description An optional internal label for admin use. When set, this is displayed in the admin UI instead of the public name. */
|
|
4896
4979
|
internal_name?: string | null;
|
|
4980
|
+
/** @description Set of key-value pairs to attach to this service. Maximum size is 16 KB. */
|
|
4981
|
+
metadata?: {
|
|
4982
|
+
[key: string]: unknown;
|
|
4983
|
+
};
|
|
4897
4984
|
/** @description The service name. */
|
|
4898
4985
|
name?: string;
|
|
4899
4986
|
provider_notifications?: components["schemas"]["ProviderNotificationConfig"];
|
|
@@ -4909,6 +4996,9 @@ interface components {
|
|
|
4909
4996
|
* "first_name": "John",
|
|
4910
4997
|
* "last_name": "Smith",
|
|
4911
4998
|
* "locale": "en",
|
|
4999
|
+
* "metadata": {
|
|
5000
|
+
* "external_id": "123"
|
|
5001
|
+
* },
|
|
4912
5002
|
* "phone": "+15551234567",
|
|
4913
5003
|
* "reference_id": "your-reference-id",
|
|
4914
5004
|
* "time_zone": "America/New_York"
|
|
@@ -4923,6 +5013,10 @@ interface components {
|
|
|
4923
5013
|
last_name?: string;
|
|
4924
5014
|
/** @description The client's locale. */
|
|
4925
5015
|
locale?: string;
|
|
5016
|
+
/** @description Set of key-value pairs to attach to this client. Maximum size is 16 KB. */
|
|
5017
|
+
metadata?: {
|
|
5018
|
+
[key: string]: unknown;
|
|
5019
|
+
};
|
|
4926
5020
|
/** @description The client's phone number (E.164 format). */
|
|
4927
5021
|
phone?: string;
|
|
4928
5022
|
/** @description The client's external reference identifier. */
|
|
@@ -5074,6 +5168,9 @@ interface components {
|
|
|
5074
5168
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
5075
5169
|
* "last_name": "Smith",
|
|
5076
5170
|
* "locale": "en-US",
|
|
5171
|
+
* "metadata": {
|
|
5172
|
+
* "external_id": "123"
|
|
5173
|
+
* },
|
|
5077
5174
|
* "object": "client",
|
|
5078
5175
|
* "phone": "+15551234567",
|
|
5079
5176
|
* "reference_id": "ext_12345",
|
|
@@ -5211,6 +5308,9 @@ interface components {
|
|
|
5211
5308
|
* "duration": "PT1H30M",
|
|
5212
5309
|
* "id": "srv_d025a96ac0c6",
|
|
5213
5310
|
* "internal_name": null,
|
|
5311
|
+
* "metadata": {
|
|
5312
|
+
* "external_id": "123"
|
|
5313
|
+
* },
|
|
5214
5314
|
* "name": "Initial Consult",
|
|
5215
5315
|
* "object": "service",
|
|
5216
5316
|
* "provider_notifications": {
|
|
@@ -5296,6 +5396,9 @@ interface components {
|
|
|
5296
5396
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
5297
5397
|
* "last_name": "Smith",
|
|
5298
5398
|
* "locale": "en-US",
|
|
5399
|
+
* "metadata": {
|
|
5400
|
+
* "external_id": "123"
|
|
5401
|
+
* },
|
|
5299
5402
|
* "object": "client",
|
|
5300
5403
|
* "phone": "+15551234567",
|
|
5301
5404
|
* "reference_id": "ext_12345",
|
|
@@ -5363,6 +5466,9 @@ interface components {
|
|
|
5363
5466
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
5364
5467
|
* "last_name": "Smith",
|
|
5365
5468
|
* "locale": "en-US",
|
|
5469
|
+
* "metadata": {
|
|
5470
|
+
* "external_id": "123"
|
|
5471
|
+
* },
|
|
5366
5472
|
* "object": "client",
|
|
5367
5473
|
* "phone": "+15551234567",
|
|
5368
5474
|
* "reference_id": "ext_12345",
|
|
@@ -5516,6 +5622,9 @@ interface components {
|
|
|
5516
5622
|
* "duration": "PT1H30M",
|
|
5517
5623
|
* "id": "srv_d025a96ac0c6",
|
|
5518
5624
|
* "internal_name": null,
|
|
5625
|
+
* "metadata": {
|
|
5626
|
+
* "external_id": "123"
|
|
5627
|
+
* },
|
|
5519
5628
|
* "name": "Initial Consult",
|
|
5520
5629
|
* "object": "service",
|
|
5521
5630
|
* "provider_notifications": {
|
|
@@ -5583,6 +5692,10 @@ interface components {
|
|
|
5583
5692
|
id: string;
|
|
5584
5693
|
/** @description An optional internal label for admin use. When set, this is displayed in the admin UI instead of the public name. */
|
|
5585
5694
|
internal_name?: string | null;
|
|
5695
|
+
/** @description Set of key-value pairs attached to this service. Maximum size is 16 KB. */
|
|
5696
|
+
metadata: {
|
|
5697
|
+
[key: string]: unknown;
|
|
5698
|
+
};
|
|
5586
5699
|
/** @description The name of the service. */
|
|
5587
5700
|
name: string;
|
|
5588
5701
|
/**
|
|
@@ -5865,6 +5978,9 @@ interface components {
|
|
|
5865
5978
|
* "duration": "PT1H30M",
|
|
5866
5979
|
* "id": "srv_d025a96ac0c6",
|
|
5867
5980
|
* "internal_name": null,
|
|
5981
|
+
* "metadata": {
|
|
5982
|
+
* "external_id": "123"
|
|
5983
|
+
* },
|
|
5868
5984
|
* "name": "Initial Consult",
|
|
5869
5985
|
* "object": "service",
|
|
5870
5986
|
* "provider_notifications": {
|
|
@@ -6158,6 +6274,9 @@ interface components {
|
|
|
6158
6274
|
* "duration": "PT1H30M",
|
|
6159
6275
|
* "id": "srv_d025a96ac0c6",
|
|
6160
6276
|
* "internal_name": null,
|
|
6277
|
+
* "metadata": {
|
|
6278
|
+
* "external_id": "123"
|
|
6279
|
+
* },
|
|
6161
6280
|
* "name": "Initial Consult",
|
|
6162
6281
|
* "object": "service",
|
|
6163
6282
|
* "provider_notifications": {
|
|
@@ -6409,6 +6528,9 @@ interface components {
|
|
|
6409
6528
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
6410
6529
|
* "last_name": "Smith",
|
|
6411
6530
|
* "locale": "en-US",
|
|
6531
|
+
* "metadata": {
|
|
6532
|
+
* "external_id": "123"
|
|
6533
|
+
* },
|
|
6412
6534
|
* "object": "client",
|
|
6413
6535
|
* "phone": "+15551234567",
|
|
6414
6536
|
* "reference_id": "ext_12345",
|
|
@@ -6546,6 +6668,9 @@ interface components {
|
|
|
6546
6668
|
* "duration": "PT1H30M",
|
|
6547
6669
|
* "id": "srv_d025a96ac0c6",
|
|
6548
6670
|
* "internal_name": null,
|
|
6671
|
+
* "metadata": {
|
|
6672
|
+
* "external_id": "123"
|
|
6673
|
+
* },
|
|
6549
6674
|
* "name": "Initial Consult",
|
|
6550
6675
|
* "object": "service",
|
|
6551
6676
|
* "provider_notifications": {
|
|
@@ -7380,6 +7505,9 @@ interface components {
|
|
|
7380
7505
|
* "duration": "PT1H30M",
|
|
7381
7506
|
* "id": "srv_d025a96ac0c6",
|
|
7382
7507
|
* "internal_name": null,
|
|
7508
|
+
* "metadata": {
|
|
7509
|
+
* "external_id": "123"
|
|
7510
|
+
* },
|
|
7383
7511
|
* "name": "Initial Consult",
|
|
7384
7512
|
* "object": "service",
|
|
7385
7513
|
* "provider_notifications": {
|
|
@@ -7489,6 +7617,9 @@ interface components {
|
|
|
7489
7617
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
7490
7618
|
* "last_name": "Smith",
|
|
7491
7619
|
* "locale": "en-US",
|
|
7620
|
+
* "metadata": {
|
|
7621
|
+
* "external_id": "123"
|
|
7622
|
+
* },
|
|
7492
7623
|
* "object": "client",
|
|
7493
7624
|
* "phone": "+15551234567",
|
|
7494
7625
|
* "reference_id": "ext_12345",
|
|
@@ -7626,6 +7757,9 @@ interface components {
|
|
|
7626
7757
|
* "duration": "PT1H30M",
|
|
7627
7758
|
* "id": "srv_d025a96ac0c6",
|
|
7628
7759
|
* "internal_name": null,
|
|
7760
|
+
* "metadata": {
|
|
7761
|
+
* "external_id": "123"
|
|
7762
|
+
* },
|
|
7629
7763
|
* "name": "Initial Consult",
|
|
7630
7764
|
* "object": "service",
|
|
7631
7765
|
* "provider_notifications": {
|
|
@@ -7717,6 +7851,9 @@ interface components {
|
|
|
7717
7851
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
7718
7852
|
* "last_name": "Smith",
|
|
7719
7853
|
* "locale": "en-US",
|
|
7854
|
+
* "metadata": {
|
|
7855
|
+
* "external_id": "123"
|
|
7856
|
+
* },
|
|
7720
7857
|
* "object": "client",
|
|
7721
7858
|
* "phone": "+15551234567",
|
|
7722
7859
|
* "reference_id": "ext_12345",
|
|
@@ -7934,6 +8071,9 @@ interface components {
|
|
|
7934
8071
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
7935
8072
|
* "last_name": "Smith",
|
|
7936
8073
|
* "locale": "en-US",
|
|
8074
|
+
* "metadata": {
|
|
8075
|
+
* "external_id": "123"
|
|
8076
|
+
* },
|
|
7937
8077
|
* "object": "client",
|
|
7938
8078
|
* "phone": "+15551234567",
|
|
7939
8079
|
* "reference_id": "ext_12345",
|
|
@@ -8071,6 +8211,9 @@ interface components {
|
|
|
8071
8211
|
* "duration": "PT1H30M",
|
|
8072
8212
|
* "id": "srv_d025a96ac0c6",
|
|
8073
8213
|
* "internal_name": null,
|
|
8214
|
+
* "metadata": {
|
|
8215
|
+
* "external_id": "123"
|
|
8216
|
+
* },
|
|
8074
8217
|
* "name": "Initial Consult",
|
|
8075
8218
|
* "object": "service",
|
|
8076
8219
|
* "provider_notifications": {
|
|
@@ -8473,6 +8616,9 @@ interface components {
|
|
|
8473
8616
|
* "duration": "PT1H30M",
|
|
8474
8617
|
* "id": "srv_d025a96ac0c6",
|
|
8475
8618
|
* "internal_name": null,
|
|
8619
|
+
* "metadata": {
|
|
8620
|
+
* "external_id": "123"
|
|
8621
|
+
* },
|
|
8476
8622
|
* "name": "Initial Consult",
|
|
8477
8623
|
* "object": "service",
|
|
8478
8624
|
* "provider_notifications": {
|
|
@@ -8666,6 +8812,9 @@ interface components {
|
|
|
8666
8812
|
* "duration": "PT1H30M",
|
|
8667
8813
|
* "id": "srv_d025a96ac0c6",
|
|
8668
8814
|
* "internal_name": null,
|
|
8815
|
+
* "metadata": {
|
|
8816
|
+
* "external_id": "123"
|
|
8817
|
+
* },
|
|
8669
8818
|
* "name": "Initial Consult",
|
|
8670
8819
|
* "object": "service",
|
|
8671
8820
|
* "provider_notifications": {
|
|
@@ -8820,6 +8969,9 @@ interface components {
|
|
|
8820
8969
|
* "change_policy_text": "Appointments within 48 hours cannot be canceled or rescheduled online. Please call our office.",
|
|
8821
8970
|
* "duration": "PT1H30M",
|
|
8822
8971
|
* "internal_name": "IC - New Patient",
|
|
8972
|
+
* "metadata": {
|
|
8973
|
+
* "external_id": "123"
|
|
8974
|
+
* },
|
|
8823
8975
|
* "name": "Initial Consult",
|
|
8824
8976
|
* "provider_notifications": {
|
|
8825
8977
|
* "additional_recipients": [
|
|
@@ -8878,6 +9030,10 @@ interface components {
|
|
|
8878
9030
|
duration?: string;
|
|
8879
9031
|
/** @description An optional internal label for admin use. When set, this is displayed in the admin UI instead of the public name. */
|
|
8880
9032
|
internal_name?: string | null;
|
|
9033
|
+
/** @description Set of key-value pairs to attach to this service. Maximum size is 16 KB. */
|
|
9034
|
+
metadata?: {
|
|
9035
|
+
[key: string]: unknown;
|
|
9036
|
+
};
|
|
8881
9037
|
/** @description The service name. */
|
|
8882
9038
|
name: string;
|
|
8883
9039
|
provider_notifications?: components["schemas"]["ProviderNotificationConfig"];
|
|
@@ -8914,6 +9070,9 @@ interface components {
|
|
|
8914
9070
|
* "id": "clnt_a1b2c3d4e5f6",
|
|
8915
9071
|
* "last_name": "Smith",
|
|
8916
9072
|
* "locale": "en-US",
|
|
9073
|
+
* "metadata": {
|
|
9074
|
+
* "external_id": "123"
|
|
9075
|
+
* },
|
|
8917
9076
|
* "object": "client",
|
|
8918
9077
|
* "phone": "+15551234567",
|
|
8919
9078
|
* "reference_id": "ext_12345",
|
|
@@ -9051,6 +9210,9 @@ interface components {
|
|
|
9051
9210
|
* "duration": "PT1H30M",
|
|
9052
9211
|
* "id": "srv_d025a96ac0c6",
|
|
9053
9212
|
* "internal_name": null,
|
|
9213
|
+
* "metadata": {
|
|
9214
|
+
* "external_id": "123"
|
|
9215
|
+
* },
|
|
9054
9216
|
* "name": "Initial Consult",
|
|
9055
9217
|
* "object": "service",
|
|
9056
9218
|
* "provider_notifications": {
|
|
@@ -9177,6 +9339,9 @@ interface components {
|
|
|
9177
9339
|
* "first_name": "John",
|
|
9178
9340
|
* "last_name": "Smith",
|
|
9179
9341
|
* "locale": "en",
|
|
9342
|
+
* "metadata": {
|
|
9343
|
+
* "external_id": "123"
|
|
9344
|
+
* },
|
|
9180
9345
|
* "phone": "+15551234567",
|
|
9181
9346
|
* "reference_id": "your-reference-id",
|
|
9182
9347
|
* "time_zone": "America/New_York"
|
|
@@ -9191,6 +9356,10 @@ interface components {
|
|
|
9191
9356
|
last_name: string;
|
|
9192
9357
|
/** @description The client's locale. */
|
|
9193
9358
|
locale?: string;
|
|
9359
|
+
/** @description Set of key-value pairs to attach to this client. Maximum size is 16 KB. */
|
|
9360
|
+
metadata?: {
|
|
9361
|
+
[key: string]: unknown;
|
|
9362
|
+
};
|
|
9194
9363
|
/** @description The client's phone number (E.164 format). */
|
|
9195
9364
|
phone?: string;
|
|
9196
9365
|
/** @description The client's external reference identifier. */
|
|
@@ -10601,6 +10770,10 @@ interface operations {
|
|
|
10601
10770
|
page?: number;
|
|
10602
10771
|
/** @description Number of items per page */
|
|
10603
10772
|
page_size?: number;
|
|
10773
|
+
/** @description Filter services by metadata using bracket notation. See [Metadata Filtering](https://developers.savvycal.app/metadata-filtering) for more details. */
|
|
10774
|
+
metadata?: {
|
|
10775
|
+
[key: string]: unknown;
|
|
10776
|
+
};
|
|
10604
10777
|
};
|
|
10605
10778
|
header?: {
|
|
10606
10779
|
/**
|
|
@@ -11418,6 +11591,10 @@ interface operations {
|
|
|
11418
11591
|
page_size?: number;
|
|
11419
11592
|
/** @description Only return clients that match the search query (name or email). */
|
|
11420
11593
|
search?: string;
|
|
11594
|
+
/** @description Filter clients by metadata using bracket notation. See [Metadata Filtering](https://developers.savvycal.app/metadata-filtering) for more details. */
|
|
11595
|
+
metadata?: {
|
|
11596
|
+
[key: string]: unknown;
|
|
11597
|
+
};
|
|
11421
11598
|
};
|
|
11422
11599
|
header?: {
|
|
11423
11600
|
/**
|
|
@@ -12361,6 +12538,15 @@ interface operations {
|
|
|
12361
12538
|
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
12362
12539
|
};
|
|
12363
12540
|
};
|
|
12541
|
+
/** @description Forbidden */
|
|
12542
|
+
403: {
|
|
12543
|
+
headers: {
|
|
12544
|
+
[name: string]: unknown;
|
|
12545
|
+
};
|
|
12546
|
+
content: {
|
|
12547
|
+
"application/json": components["schemas"]["ForbiddenResponse"];
|
|
12548
|
+
};
|
|
12549
|
+
};
|
|
12364
12550
|
/** @description Unprocessable Entity */
|
|
12365
12551
|
422: {
|
|
12366
12552
|
headers: {
|
|
@@ -13136,6 +13322,7 @@ type CreateServiceProviderRequest = Schemas["CreateServiceProviderRequest"];
|
|
|
13136
13322
|
type CreateServiceRequest = Schemas["CreateServiceRequest"];
|
|
13137
13323
|
type DashboardSession = Schemas["DashboardSession"];
|
|
13138
13324
|
type DashboardSessionResponse = Schemas["DashboardSessionResponse"];
|
|
13325
|
+
type ForbiddenResponse = Schemas["ForbiddenResponse"];
|
|
13139
13326
|
type GenericErrorResponse = Schemas["GenericErrorResponse"];
|
|
13140
13327
|
type HoldPolicy = Schemas["HoldPolicy"];
|
|
13141
13328
|
type JsonErrorResponse = Schemas["JsonErrorResponse"];
|
|
@@ -14061,6 +14248,9 @@ declare function createClient(client: FetchClient, body: RequestBody<"/v1/client
|
|
|
14061
14248
|
first_name: string;
|
|
14062
14249
|
last_name: string;
|
|
14063
14250
|
locale?: string;
|
|
14251
|
+
metadata?: {
|
|
14252
|
+
[key: string]: unknown;
|
|
14253
|
+
};
|
|
14064
14254
|
phone?: string;
|
|
14065
14255
|
reference_id?: string;
|
|
14066
14256
|
time_zone: string;
|
|
@@ -14374,6 +14564,9 @@ declare function createService(client: FetchClient, body: RequestBody<"/v1/servi
|
|
|
14374
14564
|
change_policy_text?: string;
|
|
14375
14565
|
duration?: string;
|
|
14376
14566
|
internal_name?: string | null;
|
|
14567
|
+
metadata?: {
|
|
14568
|
+
[key: string]: unknown;
|
|
14569
|
+
};
|
|
14377
14570
|
name: string;
|
|
14378
14571
|
provider_notifications?: components["schemas"]["ProviderNotificationConfig"];
|
|
14379
14572
|
rescheduling_policy?: components["schemas"]["ReschedulingPolicy"];
|
|
@@ -15769,6 +15962,14 @@ declare function listAppointments(client: FetchClient, query?: QueryParams<"/v1/
|
|
|
15769
15962
|
"application/json": components["schemas"]["UnauthorizedResponse"];
|
|
15770
15963
|
};
|
|
15771
15964
|
};
|
|
15965
|
+
403: {
|
|
15966
|
+
headers: {
|
|
15967
|
+
[name: string]: unknown;
|
|
15968
|
+
};
|
|
15969
|
+
content: {
|
|
15970
|
+
"application/json": components["schemas"]["ForbiddenResponse"];
|
|
15971
|
+
};
|
|
15972
|
+
};
|
|
15772
15973
|
422: {
|
|
15773
15974
|
headers: {
|
|
15774
15975
|
[name: string]: unknown;
|
|
@@ -16015,6 +16216,9 @@ declare function listClients(client: FetchClient, query?: QueryParams<"/v1/clien
|
|
|
16015
16216
|
page?: number;
|
|
16016
16217
|
page_size?: number;
|
|
16017
16218
|
search?: string;
|
|
16219
|
+
metadata?: {
|
|
16220
|
+
[key: string]: unknown;
|
|
16221
|
+
};
|
|
16018
16222
|
};
|
|
16019
16223
|
header?: {
|
|
16020
16224
|
"X-SavvyCal-Account"?: string;
|
|
@@ -16055,6 +16259,9 @@ declare function listClients(client: FetchClient, query?: QueryParams<"/v1/clien
|
|
|
16055
16259
|
page?: number;
|
|
16056
16260
|
page_size?: number;
|
|
16057
16261
|
search?: string;
|
|
16262
|
+
metadata?: {
|
|
16263
|
+
[key: string]: unknown;
|
|
16264
|
+
};
|
|
16058
16265
|
} | undefined;
|
|
16059
16266
|
};
|
|
16060
16267
|
}, `${string}/${string}`>>;
|
|
@@ -16441,6 +16648,9 @@ declare function listServices(client: FetchClient, query?: QueryParams<"/v1/serv
|
|
|
16441
16648
|
query?: {
|
|
16442
16649
|
page?: number;
|
|
16443
16650
|
page_size?: number;
|
|
16651
|
+
metadata?: {
|
|
16652
|
+
[key: string]: unknown;
|
|
16653
|
+
};
|
|
16444
16654
|
};
|
|
16445
16655
|
header?: {
|
|
16446
16656
|
"X-SavvyCal-Account"?: string;
|
|
@@ -16480,6 +16690,9 @@ declare function listServices(client: FetchClient, query?: QueryParams<"/v1/serv
|
|
|
16480
16690
|
query: {
|
|
16481
16691
|
page?: number;
|
|
16482
16692
|
page_size?: number;
|
|
16693
|
+
metadata?: {
|
|
16694
|
+
[key: string]: unknown;
|
|
16695
|
+
};
|
|
16483
16696
|
} | undefined;
|
|
16484
16697
|
};
|
|
16485
16698
|
}, `${string}/${string}`>>;
|
|
@@ -17046,6 +17259,9 @@ declare function updateClient(client: FetchClient, path: PathParams<"/v1/clients
|
|
|
17046
17259
|
first_name?: string;
|
|
17047
17260
|
last_name?: string;
|
|
17048
17261
|
locale?: string;
|
|
17262
|
+
metadata?: {
|
|
17263
|
+
[key: string]: unknown;
|
|
17264
|
+
};
|
|
17049
17265
|
phone?: string;
|
|
17050
17266
|
reference_id?: string;
|
|
17051
17267
|
time_zone?: string;
|
|
@@ -17356,6 +17572,9 @@ declare function updateService(client: FetchClient, path: PathParams<"/v1/servic
|
|
|
17356
17572
|
change_policy_text?: string;
|
|
17357
17573
|
duration?: string;
|
|
17358
17574
|
internal_name?: string | null;
|
|
17575
|
+
metadata?: {
|
|
17576
|
+
[key: string]: unknown;
|
|
17577
|
+
};
|
|
17359
17578
|
name?: string;
|
|
17360
17579
|
provider_notifications?: components["schemas"]["ProviderNotificationConfig"];
|
|
17361
17580
|
rescheduling_policy?: components["schemas"]["ReschedulingPolicy"];
|
|
@@ -17368,4 +17587,4 @@ declare function updateService(client: FetchClient, path: PathParams<"/v1/servic
|
|
|
17368
17587
|
};
|
|
17369
17588
|
}, `${string}/${string}`>>;
|
|
17370
17589
|
|
|
17371
|
-
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 AppointmentRescheduledEventData, type AppointmentResponse, type AppointmentsResponse, type Block, type BlockCreatedEventData, type BlockDeletedEventData, type BlockResponse, type BlockUpdatedEventData, type BlocksResponse, type BookingIntent, type BookingIntentAbandonedEventData, type BookingIntentCompletedEventData, type BookingIntentCreatedEventData, type BookingIntentResponse, type BookingIntentUpdatedEventData, 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 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 CreateClientRequest, type CreateDashboardSessionRequest, type CreateProviderRequest, type CreateProviderScheduleRequest, type CreatePublicAppointmentRequest, type CreatePublicBookingIntentRequest, type CreateServiceProviderRequest, type CreateServiceRequest, type DashboardSession, type DashboardSessionResponse, type FetchClient, type FetchClientOptions, type GenericErrorResponse, type HoldPolicy, 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 PublicServiceSlotsResponse, 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 ServiceProvider, type ServiceProviderCreatedEventData, type ServiceProviderDeletedEventData, type ServiceProviderResponse, type ServiceProvidersResponse, type ServiceResponse, type ServiceSlotResponse, type ServiceUpdatedEventData, type ServicesResponse, type Slot, type SlotRule, type UnauthorizedResponse, type UpdateAccountRequest, type UpdateAccountUserRequest, type UpdateBlockRequest, type UpdateBookingIntentRequest, type UpdateCancellationReasonRequest, type UpdateClientRequest, type UpdateConnectedAccountRequest, type UpdateProviderRequest, type UpdateProviderScheduleRequest, type UpdatePublicBookingIntentRequest, type UpdateServiceRequest, type User, type WeeklyRule, type ZonedDateTime, abandonBookingIntent, abandonPublicBookingIntent, cancelAppointment, cancelPublicAppointment, completeBookingIntent, completePublicBookingIntent, confirmAppointment, createAccount, createAccountUser, createAppointment, createBlock, createBookingIntent, createCancellationReason, createClient, createDashboardSession, createFetchClient, createProvider, createProviderSchedule, createPublicAppointment, createPublicBookingIntent, createService, createServiceProvider, deactivateProvider, deleteBlock, deleteCancellationReason, deleteClient, deleteConnectedAccount, deleteProviderSchedule, deleteService, deleteServiceProvider, getAccountById, getAppointment, getBlock, getBookingIntent, getCancellationReason, getClient, getConnectedAccount, getCurrentAccount, getCurrentAccountUser, getCurrentPlatform, getEarliestPublicServiceSlot, getProvider, getProviderSchedule, getPublicAppointment, getPublicBookingIntent, getService, listAccountUsers, listAccounts, listAppointments, listBlocks, listBookingIntents, listCancellationReasons, listClients, listConnectedAccounts, listProviderSchedules, listProviders, listPublicCancellationReasons, listPublicServiceSlots, listRoles, listServiceProviders, listServiceSlots, listServices, type paths, rescheduleAppointment, reschedulePublicAppointment, updateAccount, updateAccountUser, updateBlock, updateBookingIntent, updateCancellationReason, updateClient, updateConnectedAccount, updateProvider, updateProviderSchedule, updatePublicBookingIntent, updateService };
|
|
17590
|
+
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 AppointmentRescheduledEventData, type AppointmentResponse, type AppointmentsResponse, type Block, type BlockCreatedEventData, type BlockDeletedEventData, type BlockResponse, type BlockUpdatedEventData, type BlocksResponse, type BookingIntent, type BookingIntentAbandonedEventData, type BookingIntentCompletedEventData, type BookingIntentCreatedEventData, type BookingIntentResponse, type BookingIntentUpdatedEventData, 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 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 CreateClientRequest, type CreateDashboardSessionRequest, type CreateProviderRequest, type CreateProviderScheduleRequest, type CreatePublicAppointmentRequest, type CreatePublicBookingIntentRequest, type CreateServiceProviderRequest, type CreateServiceRequest, type DashboardSession, type DashboardSessionResponse, type FetchClient, type FetchClientOptions, type ForbiddenResponse, type GenericErrorResponse, type HoldPolicy, 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 PublicServiceSlotsResponse, 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 ServiceProvider, type ServiceProviderCreatedEventData, type ServiceProviderDeletedEventData, type ServiceProviderResponse, type ServiceProvidersResponse, type ServiceResponse, type ServiceSlotResponse, type ServiceUpdatedEventData, type ServicesResponse, type Slot, type SlotRule, type UnauthorizedResponse, type UpdateAccountRequest, type UpdateAccountUserRequest, type UpdateBlockRequest, type UpdateBookingIntentRequest, type UpdateCancellationReasonRequest, type UpdateClientRequest, type UpdateConnectedAccountRequest, type UpdateProviderRequest, type UpdateProviderScheduleRequest, type UpdatePublicBookingIntentRequest, type UpdateServiceRequest, type User, type WeeklyRule, type ZonedDateTime, abandonBookingIntent, abandonPublicBookingIntent, cancelAppointment, cancelPublicAppointment, completeBookingIntent, completePublicBookingIntent, confirmAppointment, createAccount, createAccountUser, createAppointment, createBlock, createBookingIntent, createCancellationReason, createClient, createDashboardSession, createFetchClient, createProvider, createProviderSchedule, createPublicAppointment, createPublicBookingIntent, createService, createServiceProvider, deactivateProvider, deleteBlock, deleteCancellationReason, deleteClient, deleteConnectedAccount, deleteProviderSchedule, deleteService, deleteServiceProvider, getAccountById, getAppointment, getBlock, getBookingIntent, getCancellationReason, getClient, getConnectedAccount, getCurrentAccount, getCurrentAccountUser, getCurrentPlatform, getEarliestPublicServiceSlot, getProvider, getProviderSchedule, getPublicAppointment, getPublicBookingIntent, getService, listAccountUsers, listAccounts, listAppointments, listBlocks, listBookingIntents, listCancellationReasons, listClients, listConnectedAccounts, listProviderSchedules, listProviders, listPublicCancellationReasons, listPublicServiceSlots, listRoles, listServiceProviders, listServiceSlots, listServices, type paths, rescheduleAppointment, reschedulePublicAppointment, updateAccount, updateAccountUser, updateBlock, updateBookingIntent, updateCancellationReason, updateClient, updateConnectedAccount, updateProvider, updateProviderSchedule, updatePublicBookingIntent, updateService };
|