@seamapi/types 1.298.0 → 1.300.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.
@@ -1341,13 +1341,13 @@ declare const acs_user: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extend
1341
1341
  is_suspended: z.ZodBoolean;
1342
1342
  access_schedule: z.ZodOptional<z.ZodObject<{
1343
1343
  starts_at: z.ZodString;
1344
- ends_at: z.ZodString;
1344
+ ends_at: z.ZodNullable<z.ZodString>;
1345
1345
  }, "strip", z.ZodTypeAny, {
1346
1346
  starts_at: string;
1347
- ends_at: string;
1347
+ ends_at: string | null;
1348
1348
  }, {
1349
1349
  starts_at: string;
1350
- ends_at: string;
1350
+ ends_at: string | null;
1351
1351
  }>>;
1352
1352
  user_identity_id: z.ZodOptional<z.ZodString>;
1353
1353
  user_identity_full_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1505,7 +1505,7 @@ declare const acs_user: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extend
1505
1505
  hid_acs_system_id?: string | undefined;
1506
1506
  access_schedule?: {
1507
1507
  starts_at: string;
1508
- ends_at: string;
1508
+ ends_at: string | null;
1509
1509
  } | undefined;
1510
1510
  user_identity_full_name?: string | null | undefined;
1511
1511
  user_identity_email_address?: string | null | undefined;
@@ -1560,7 +1560,7 @@ declare const acs_user: z.ZodObject<z.objectUtil.extendShape<z.objectUtil.extend
1560
1560
  hid_acs_system_id?: string | undefined;
1561
1561
  access_schedule?: {
1562
1562
  starts_at: string;
1563
- ends_at: string;
1563
+ ends_at: string | null;
1564
1564
  } | undefined;
1565
1565
  user_identity_full_name?: string | null | undefined;
1566
1566
  user_identity_email_address?: string | null | undefined;
@@ -1578,13 +1578,13 @@ declare const unmanaged_acs_user: z.ZodObject<z.objectUtil.extendShape<z.objectU
1578
1578
  is_suspended: z.ZodBoolean;
1579
1579
  access_schedule: z.ZodOptional<z.ZodObject<{
1580
1580
  starts_at: z.ZodString;
1581
- ends_at: z.ZodString;
1581
+ ends_at: z.ZodNullable<z.ZodString>;
1582
1582
  }, "strip", z.ZodTypeAny, {
1583
1583
  starts_at: string;
1584
- ends_at: string;
1584
+ ends_at: string | null;
1585
1585
  }, {
1586
1586
  starts_at: string;
1587
- ends_at: string;
1587
+ ends_at: string | null;
1588
1588
  }>>;
1589
1589
  user_identity_id: z.ZodOptional<z.ZodString>;
1590
1590
  user_identity_full_name: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -1742,7 +1742,7 @@ declare const unmanaged_acs_user: z.ZodObject<z.objectUtil.extendShape<z.objectU
1742
1742
  hid_acs_system_id?: string | undefined;
1743
1743
  access_schedule?: {
1744
1744
  starts_at: string;
1745
- ends_at: string;
1745
+ ends_at: string | null;
1746
1746
  } | undefined;
1747
1747
  user_identity_full_name?: string | null | undefined;
1748
1748
  user_identity_email_address?: string | null | undefined;
@@ -1797,7 +1797,7 @@ declare const unmanaged_acs_user: z.ZodObject<z.objectUtil.extendShape<z.objectU
1797
1797
  hid_acs_system_id?: string | undefined;
1798
1798
  access_schedule?: {
1799
1799
  starts_at: string;
1800
- ends_at: string;
1800
+ ends_at: string | null;
1801
1801
  } | undefined;
1802
1802
  user_identity_full_name?: string | null | undefined;
1803
1803
  user_identity_email_address?: string | null | undefined;
@@ -13284,6 +13284,7 @@ declare const _default: {
13284
13284
  ends_at: {
13285
13285
  description: string;
13286
13286
  format: string;
13287
+ nullable: boolean;
13287
13288
  type: string;
13288
13289
  };
13289
13290
  starts_at: {
@@ -22706,6 +22707,7 @@ declare const _default: {
22706
22707
  properties: {
22707
22708
  ends_at: {
22708
22709
  format: string;
22710
+ nullable: boolean;
22709
22711
  type: string;
22710
22712
  };
22711
22713
  starts_at: {
@@ -22713,7 +22715,6 @@ declare const _default: {
22713
22715
  type: string;
22714
22716
  };
22715
22717
  };
22716
- required: string[];
22717
22718
  type: string;
22718
22719
  };
22719
22720
  acs_access_group_ids: {
@@ -23365,6 +23366,7 @@ declare const _default: {
23365
23366
  ends_at: {
23366
23367
  description: string;
23367
23368
  format: string;
23369
+ nullable: boolean;
23368
23370
  type: string;
23369
23371
  };
23370
23372
  starts_at: {
@@ -23612,6 +23614,7 @@ declare const _default: {
23612
23614
  ends_at: {
23613
23615
  description: string;
23614
23616
  format: string;
23617
+ nullable: boolean;
23615
23618
  type: string;
23616
23619
  };
23617
23620
  starts_at: {
@@ -30169,51 +30172,122 @@ declare const _default: {
30169
30172
  'x-title': string;
30170
30173
  };
30171
30174
  };
30172
- '/thermostats/set_temperature_threshold': {
30173
- patch: {
30175
+ '/thermostats/set_hvac_mode': {
30176
+ post: {
30174
30177
  description: string;
30175
30178
  operationId: string;
30176
30179
  requestBody: {
30177
30180
  content: {
30178
30181
  'application/json': {
30179
30182
  schema: {
30180
- properties: {
30181
- device_id: {
30182
- description: string;
30183
- format: string;
30184
- type: string;
30185
- };
30186
- lower_limit_celsius: {
30187
- default: null;
30188
- description: string;
30189
- format: string;
30190
- nullable: boolean;
30191
- type: string;
30183
+ discriminator: {
30184
+ propertyName: string;
30185
+ };
30186
+ oneOf: ({
30187
+ properties: {
30188
+ device_id: {
30189
+ description: string;
30190
+ format: string;
30191
+ type: string;
30192
+ };
30193
+ hvac_mode_setting: {
30194
+ enum: string[];
30195
+ type: string;
30196
+ };
30197
+ cooling_set_point_celsius?: never;
30198
+ cooling_set_point_fahrenheit?: never;
30199
+ heating_set_point_celsius?: never;
30200
+ heating_set_point_fahrenheit?: never;
30192
30201
  };
30193
- lower_limit_fahrenheit: {
30194
- default: null;
30195
- description: string;
30196
- format: string;
30197
- nullable: boolean;
30198
- type: string;
30202
+ required: string[];
30203
+ type: string;
30204
+ } | {
30205
+ properties: {
30206
+ cooling_set_point_celsius: {
30207
+ description: string;
30208
+ format: string;
30209
+ type: string;
30210
+ };
30211
+ cooling_set_point_fahrenheit: {
30212
+ description: string;
30213
+ format: string;
30214
+ type: string;
30215
+ };
30216
+ device_id: {
30217
+ description: string;
30218
+ format: string;
30219
+ type: string;
30220
+ };
30221
+ hvac_mode_setting: {
30222
+ enum: string[];
30223
+ type: string;
30224
+ };
30225
+ heating_set_point_celsius?: never;
30226
+ heating_set_point_fahrenheit?: never;
30199
30227
  };
30200
- upper_limit_celsius: {
30201
- default: null;
30202
- description: string;
30203
- format: string;
30204
- nullable: boolean;
30205
- type: string;
30228
+ required: string[];
30229
+ type: string;
30230
+ } | {
30231
+ properties: {
30232
+ device_id: {
30233
+ description: string;
30234
+ format: string;
30235
+ type: string;
30236
+ };
30237
+ heating_set_point_celsius: {
30238
+ description: string;
30239
+ format: string;
30240
+ type: string;
30241
+ };
30242
+ heating_set_point_fahrenheit: {
30243
+ description: string;
30244
+ format: string;
30245
+ type: string;
30246
+ };
30247
+ hvac_mode_setting: {
30248
+ enum: string[];
30249
+ type: string;
30250
+ };
30251
+ cooling_set_point_celsius?: never;
30252
+ cooling_set_point_fahrenheit?: never;
30206
30253
  };
30207
- upper_limit_fahrenheit: {
30208
- default: null;
30209
- description: string;
30210
- format: string;
30211
- nullable: boolean;
30212
- type: string;
30254
+ required: string[];
30255
+ type: string;
30256
+ } | {
30257
+ properties: {
30258
+ cooling_set_point_celsius: {
30259
+ description: string;
30260
+ format: string;
30261
+ type: string;
30262
+ };
30263
+ cooling_set_point_fahrenheit: {
30264
+ description: string;
30265
+ format: string;
30266
+ type: string;
30267
+ };
30268
+ device_id: {
30269
+ description: string;
30270
+ format: string;
30271
+ type: string;
30272
+ };
30273
+ heating_set_point_celsius: {
30274
+ description: string;
30275
+ format: string;
30276
+ type: string;
30277
+ };
30278
+ heating_set_point_fahrenheit: {
30279
+ description: string;
30280
+ format: string;
30281
+ type: string;
30282
+ };
30283
+ hvac_mode_setting: {
30284
+ enum: string[];
30285
+ type: string;
30286
+ };
30213
30287
  };
30214
- };
30215
- required: string[];
30216
- type: string;
30288
+ required: string[];
30289
+ type: string;
30290
+ })[];
30217
30291
  };
30218
30292
  };
30219
30293
  };
@@ -30224,6 +30298,9 @@ declare const _default: {
30224
30298
  'application/json': {
30225
30299
  schema: {
30226
30300
  properties: {
30301
+ action_attempt: {
30302
+ $ref: string;
30303
+ };
30227
30304
  ok: {
30228
30305
  type: string;
30229
30306
  };
@@ -30243,25 +30320,37 @@ declare const _default: {
30243
30320
  };
30244
30321
  };
30245
30322
  security: ({
30246
- api_key: never[];
30323
+ client_session: never[];
30247
30324
  pat_with_workspace?: never;
30248
30325
  console_session?: never;
30326
+ api_key?: never;
30249
30327
  } | {
30250
30328
  pat_with_workspace: never[];
30251
- api_key?: never;
30329
+ client_session?: never;
30252
30330
  console_session?: never;
30331
+ api_key?: never;
30253
30332
  } | {
30254
30333
  console_session: never[];
30334
+ client_session?: never;
30335
+ pat_with_workspace?: never;
30255
30336
  api_key?: never;
30337
+ } | {
30338
+ api_key: never[];
30339
+ client_session?: never;
30256
30340
  pat_with_workspace?: never;
30341
+ console_session?: never;
30257
30342
  })[];
30258
30343
  summary: string;
30259
30344
  tags: string[];
30260
- 'x-fern-ignore': boolean;
30261
- 'x-response-key': null;
30345
+ 'x-fern-sdk-group-name': string[];
30346
+ 'x-fern-sdk-method-name': string;
30347
+ 'x-fern-sdk-return-value': string;
30348
+ 'x-response-key': string;
30262
30349
  'x-title': string;
30263
30350
  };
30264
- post: {
30351
+ };
30352
+ '/thermostats/set_temperature_threshold': {
30353
+ patch: {
30265
30354
  description: string;
30266
30355
  operationId: string;
30267
30356
  requestBody: {
@@ -30348,118 +30437,6 @@ declare const _default: {
30348
30437
  })[];
30349
30438
  summary: string;
30350
30439
  tags: string[];
30351
- 'x-fern-sdk-group-name': string[];
30352
- 'x-fern-sdk-method-name': string;
30353
- 'x-response-key': null;
30354
- 'x-title': string;
30355
- };
30356
- };
30357
- '/thermostats/update_climate_preset': {
30358
- patch: {
30359
- description: string;
30360
- operationId: string;
30361
- requestBody: {
30362
- content: {
30363
- 'application/json': {
30364
- schema: {
30365
- properties: {
30366
- climate_preset_key: {
30367
- description: string;
30368
- type: string;
30369
- };
30370
- cooling_set_point_celsius: {
30371
- description: string;
30372
- format: string;
30373
- type: string;
30374
- };
30375
- cooling_set_point_fahrenheit: {
30376
- description: string;
30377
- format: string;
30378
- type: string;
30379
- };
30380
- device_id: {
30381
- description: string;
30382
- format: string;
30383
- type: string;
30384
- };
30385
- fan_mode_setting: {
30386
- description: string;
30387
- enum: string[];
30388
- type: string;
30389
- };
30390
- heating_set_point_celsius: {
30391
- description: string;
30392
- format: string;
30393
- type: string;
30394
- };
30395
- heating_set_point_fahrenheit: {
30396
- description: string;
30397
- format: string;
30398
- type: string;
30399
- };
30400
- hvac_mode_setting: {
30401
- description: string;
30402
- enum: string[];
30403
- type: string;
30404
- };
30405
- manual_override_allowed: {
30406
- deprecated: boolean;
30407
- description: string;
30408
- type: string;
30409
- 'x-deprecated': string;
30410
- };
30411
- name: {
30412
- default: null;
30413
- description: string;
30414
- nullable: boolean;
30415
- type: string;
30416
- };
30417
- };
30418
- required: string[];
30419
- type: string;
30420
- };
30421
- };
30422
- };
30423
- };
30424
- responses: {
30425
- 200: {
30426
- content: {
30427
- 'application/json': {
30428
- schema: {
30429
- properties: {
30430
- ok: {
30431
- type: string;
30432
- };
30433
- };
30434
- required: string[];
30435
- type: string;
30436
- };
30437
- };
30438
- };
30439
- description: string;
30440
- };
30441
- 400: {
30442
- description: string;
30443
- };
30444
- 401: {
30445
- description: string;
30446
- };
30447
- };
30448
- security: ({
30449
- pat_with_workspace: never[];
30450
- console_session?: never;
30451
- api_key?: never;
30452
- } | {
30453
- console_session: never[];
30454
- pat_with_workspace?: never;
30455
- api_key?: never;
30456
- } | {
30457
- api_key: never[];
30458
- pat_with_workspace?: never;
30459
- console_session?: never;
30460
- })[];
30461
- summary: string;
30462
- tags: string[];
30463
30440
  'x-fern-ignore': boolean;
30464
30441
  'x-response-key': null;
30465
30442
  'x-title': string;
@@ -30472,54 +30449,36 @@ declare const _default: {
30472
30449
  'application/json': {
30473
30450
  schema: {
30474
30451
  properties: {
30475
- climate_preset_key: {
30476
- description: string;
30477
- type: string;
30478
- };
30479
- cooling_set_point_celsius: {
30480
- description: string;
30481
- format: string;
30482
- type: string;
30483
- };
30484
- cooling_set_point_fahrenheit: {
30485
- description: string;
30486
- format: string;
30487
- type: string;
30488
- };
30489
30452
  device_id: {
30490
30453
  description: string;
30491
30454
  format: string;
30492
30455
  type: string;
30493
30456
  };
30494
- fan_mode_setting: {
30495
- description: string;
30496
- enum: string[];
30497
- type: string;
30498
- };
30499
- heating_set_point_celsius: {
30457
+ lower_limit_celsius: {
30458
+ default: null;
30500
30459
  description: string;
30501
30460
  format: string;
30461
+ nullable: boolean;
30502
30462
  type: string;
30503
30463
  };
30504
- heating_set_point_fahrenheit: {
30464
+ lower_limit_fahrenheit: {
30465
+ default: null;
30505
30466
  description: string;
30506
30467
  format: string;
30468
+ nullable: boolean;
30507
30469
  type: string;
30508
30470
  };
30509
- hvac_mode_setting: {
30510
- description: string;
30511
- enum: string[];
30512
- type: string;
30513
- };
30514
- manual_override_allowed: {
30515
- deprecated: boolean;
30471
+ upper_limit_celsius: {
30472
+ default: null;
30516
30473
  description: string;
30474
+ format: string;
30475
+ nullable: boolean;
30517
30476
  type: string;
30518
- 'x-deprecated': string;
30519
30477
  };
30520
- name: {
30478
+ upper_limit_fahrenheit: {
30521
30479
  default: null;
30522
30480
  description: string;
30481
+ format: string;
30523
30482
  nullable: boolean;
30524
30483
  type: string;
30525
30484
  };
@@ -30555,17 +30514,17 @@ declare const _default: {
30555
30514
  };
30556
30515
  };
30557
30516
  security: ({
30558
- pat_with_workspace: never[];
30517
+ api_key: never[];
30518
+ pat_with_workspace?: never;
30559
30519
  console_session?: never;
30520
+ } | {
30521
+ pat_with_workspace: never[];
30560
30522
  api_key?: never;
30523
+ console_session?: never;
30561
30524
  } | {
30562
30525
  console_session: never[];
30563
- pat_with_workspace?: never;
30564
30526
  api_key?: never;
30565
- } | {
30566
- api_key: never[];
30567
30527
  pat_with_workspace?: never;
30568
- console_session?: never;
30569
30528
  })[];
30570
30529
  summary: string;
30571
30530
  tags: string[];
@@ -30575,8 +30534,8 @@ declare const _default: {
30575
30534
  'x-title': string;
30576
30535
  };
30577
30536
  };
30578
- '/user_identities/add_acs_user': {
30579
- post: {
30537
+ '/thermostats/update_climate_preset': {
30538
+ patch: {
30580
30539
  description: string;
30581
30540
  operationId: string;
30582
30541
  requestBody: {
@@ -30584,16 +30543,57 @@ declare const _default: {
30584
30543
  'application/json': {
30585
30544
  schema: {
30586
30545
  properties: {
30587
- acs_user_id: {
30546
+ climate_preset_key: {
30547
+ description: string;
30548
+ type: string;
30549
+ };
30550
+ cooling_set_point_celsius: {
30588
30551
  description: string;
30589
30552
  format: string;
30590
30553
  type: string;
30591
30554
  };
30592
- user_identity_id: {
30555
+ cooling_set_point_fahrenheit: {
30556
+ description: string;
30557
+ format: string;
30558
+ type: string;
30559
+ };
30560
+ device_id: {
30593
30561
  description: string;
30594
30562
  format: string;
30595
30563
  type: string;
30596
30564
  };
30565
+ fan_mode_setting: {
30566
+ description: string;
30567
+ enum: string[];
30568
+ type: string;
30569
+ };
30570
+ heating_set_point_celsius: {
30571
+ description: string;
30572
+ format: string;
30573
+ type: string;
30574
+ };
30575
+ heating_set_point_fahrenheit: {
30576
+ description: string;
30577
+ format: string;
30578
+ type: string;
30579
+ };
30580
+ hvac_mode_setting: {
30581
+ description: string;
30582
+ enum: string[];
30583
+ type: string;
30584
+ };
30585
+ manual_override_allowed: {
30586
+ deprecated: boolean;
30587
+ description: string;
30588
+ type: string;
30589
+ 'x-deprecated': string;
30590
+ };
30591
+ name: {
30592
+ default: null;
30593
+ description: string;
30594
+ nullable: boolean;
30595
+ type: string;
30596
+ };
30597
30597
  };
30598
30598
  required: string[];
30599
30599
  type: string;
@@ -30626,26 +30626,25 @@ declare const _default: {
30626
30626
  };
30627
30627
  };
30628
30628
  security: ({
30629
- api_key: never[];
30630
- pat_with_workspace?: never;
30631
- console_session?: never;
30632
- } | {
30633
30629
  pat_with_workspace: never[];
30634
- api_key?: never;
30635
30630
  console_session?: never;
30631
+ api_key?: never;
30636
30632
  } | {
30637
30633
  console_session: never[];
30634
+ pat_with_workspace?: never;
30638
30635
  api_key?: never;
30636
+ } | {
30637
+ api_key: never[];
30639
30638
  pat_with_workspace?: never;
30639
+ console_session?: never;
30640
30640
  })[];
30641
30641
  summary: string;
30642
30642
  tags: string[];
30643
- 'x-fern-sdk-group-name': string[];
30644
- 'x-fern-sdk-method-name': string;
30643
+ 'x-fern-ignore': boolean;
30645
30644
  'x-response-key': null;
30646
30645
  'x-title': string;
30647
30646
  };
30648
- put: {
30647
+ post: {
30649
30648
  description: string;
30650
30649
  operationId: string;
30651
30650
  requestBody: {
@@ -30653,16 +30652,57 @@ declare const _default: {
30653
30652
  'application/json': {
30654
30653
  schema: {
30655
30654
  properties: {
30656
- acs_user_id: {
30655
+ climate_preset_key: {
30656
+ description: string;
30657
+ type: string;
30658
+ };
30659
+ cooling_set_point_celsius: {
30657
30660
  description: string;
30658
30661
  format: string;
30659
30662
  type: string;
30660
30663
  };
30661
- user_identity_id: {
30664
+ cooling_set_point_fahrenheit: {
30665
+ description: string;
30666
+ format: string;
30667
+ type: string;
30668
+ };
30669
+ device_id: {
30670
+ description: string;
30671
+ format: string;
30672
+ type: string;
30673
+ };
30674
+ fan_mode_setting: {
30675
+ description: string;
30676
+ enum: string[];
30677
+ type: string;
30678
+ };
30679
+ heating_set_point_celsius: {
30680
+ description: string;
30681
+ format: string;
30682
+ type: string;
30683
+ };
30684
+ heating_set_point_fahrenheit: {
30662
30685
  description: string;
30663
30686
  format: string;
30664
30687
  type: string;
30665
30688
  };
30689
+ hvac_mode_setting: {
30690
+ description: string;
30691
+ enum: string[];
30692
+ type: string;
30693
+ };
30694
+ manual_override_allowed: {
30695
+ deprecated: boolean;
30696
+ description: string;
30697
+ type: string;
30698
+ 'x-deprecated': string;
30699
+ };
30700
+ name: {
30701
+ default: null;
30702
+ description: string;
30703
+ nullable: boolean;
30704
+ type: string;
30705
+ };
30666
30706
  };
30667
30707
  required: string[];
30668
30708
  type: string;
@@ -30695,26 +30735,27 @@ declare const _default: {
30695
30735
  };
30696
30736
  };
30697
30737
  security: ({
30698
- api_key: never[];
30699
- pat_with_workspace?: never;
30700
- console_session?: never;
30701
- } | {
30702
30738
  pat_with_workspace: never[];
30703
- api_key?: never;
30704
30739
  console_session?: never;
30740
+ api_key?: never;
30705
30741
  } | {
30706
30742
  console_session: never[];
30743
+ pat_with_workspace?: never;
30707
30744
  api_key?: never;
30745
+ } | {
30746
+ api_key: never[];
30708
30747
  pat_with_workspace?: never;
30748
+ console_session?: never;
30709
30749
  })[];
30710
30750
  summary: string;
30711
30751
  tags: string[];
30712
- 'x-fern-ignore': boolean;
30752
+ 'x-fern-sdk-group-name': string[];
30753
+ 'x-fern-sdk-method-name': string;
30713
30754
  'x-response-key': null;
30714
30755
  'x-title': string;
30715
30756
  };
30716
30757
  };
30717
- '/user_identities/create': {
30758
+ '/user_identities/add_acs_user': {
30718
30759
  post: {
30719
30760
  description: string;
30720
30761
  operationId: string;
@@ -30723,30 +30764,18 @@ declare const _default: {
30723
30764
  'application/json': {
30724
30765
  schema: {
30725
30766
  properties: {
30726
- email_address: {
30767
+ acs_user_id: {
30727
30768
  description: string;
30728
30769
  format: string;
30729
- nullable: boolean;
30730
- type: string;
30731
- };
30732
- full_name: {
30733
- description: string;
30734
- minLength: number;
30735
- nullable: boolean;
30736
30770
  type: string;
30737
30771
  };
30738
- phone_number: {
30739
- description: string;
30740
- nullable: boolean;
30741
- type: string;
30742
- };
30743
- user_identity_key: {
30772
+ user_identity_id: {
30744
30773
  description: string;
30745
- minLength: number;
30746
- nullable: boolean;
30774
+ format: string;
30747
30775
  type: string;
30748
30776
  };
30749
30777
  };
30778
+ required: string[];
30750
30779
  type: string;
30751
30780
  };
30752
30781
  };
@@ -30761,9 +30790,6 @@ declare const _default: {
30761
30790
  ok: {
30762
30791
  type: string;
30763
30792
  };
30764
- user_identity: {
30765
- $ref: string;
30766
- };
30767
30793
  };
30768
30794
  required: string[];
30769
30795
  type: string;
@@ -30796,13 +30822,10 @@ declare const _default: {
30796
30822
  tags: string[];
30797
30823
  'x-fern-sdk-group-name': string[];
30798
30824
  'x-fern-sdk-method-name': string;
30799
- 'x-fern-sdk-return-value': string;
30800
- 'x-response-key': string;
30825
+ 'x-response-key': null;
30801
30826
  'x-title': string;
30802
30827
  };
30803
- };
30804
- '/user_identities/delete': {
30805
- post: {
30828
+ put: {
30806
30829
  description: string;
30807
30830
  operationId: string;
30808
30831
  requestBody: {
@@ -30810,6 +30833,11 @@ declare const _default: {
30810
30833
  'application/json': {
30811
30834
  schema: {
30812
30835
  properties: {
30836
+ acs_user_id: {
30837
+ description: string;
30838
+ format: string;
30839
+ type: string;
30840
+ };
30813
30841
  user_identity_id: {
30814
30842
  description: string;
30815
30843
  format: string;
@@ -30861,13 +30889,12 @@ declare const _default: {
30861
30889
  })[];
30862
30890
  summary: string;
30863
30891
  tags: string[];
30864
- 'x-fern-sdk-group-name': string[];
30865
- 'x-fern-sdk-method-name': string;
30892
+ 'x-fern-ignore': boolean;
30866
30893
  'x-response-key': null;
30867
30894
  'x-title': string;
30868
30895
  };
30869
30896
  };
30870
- '/user_identities/enrollment_automations/delete': {
30897
+ '/user_identities/create': {
30871
30898
  post: {
30872
30899
  description: string;
30873
30900
  operationId: string;
@@ -30876,13 +30903,30 @@ declare const _default: {
30876
30903
  'application/json': {
30877
30904
  schema: {
30878
30905
  properties: {
30879
- enrollment_automation_id: {
30906
+ email_address: {
30880
30907
  description: string;
30881
30908
  format: string;
30909
+ nullable: boolean;
30910
+ type: string;
30911
+ };
30912
+ full_name: {
30913
+ description: string;
30914
+ minLength: number;
30915
+ nullable: boolean;
30916
+ type: string;
30917
+ };
30918
+ phone_number: {
30919
+ description: string;
30920
+ nullable: boolean;
30921
+ type: string;
30922
+ };
30923
+ user_identity_key: {
30924
+ description: string;
30925
+ minLength: number;
30926
+ nullable: boolean;
30882
30927
  type: string;
30883
30928
  };
30884
30929
  };
30885
- required: string[];
30886
30930
  type: string;
30887
30931
  };
30888
30932
  };
@@ -30897,6 +30941,9 @@ declare const _default: {
30897
30941
  ok: {
30898
30942
  type: string;
30899
30943
  };
30944
+ user_identity: {
30945
+ $ref: string;
30946
+ };
30900
30947
  };
30901
30948
  required: string[];
30902
30949
  type: string;
@@ -30913,27 +30960,28 @@ declare const _default: {
30913
30960
  };
30914
30961
  };
30915
30962
  security: ({
30916
- pat_with_workspace: never[];
30963
+ api_key: never[];
30964
+ pat_with_workspace?: never;
30917
30965
  console_session?: never;
30966
+ } | {
30967
+ pat_with_workspace: never[];
30918
30968
  api_key?: never;
30969
+ console_session?: never;
30919
30970
  } | {
30920
30971
  console_session: never[];
30921
- pat_with_workspace?: never;
30922
30972
  api_key?: never;
30923
- } | {
30924
- api_key: never[];
30925
30973
  pat_with_workspace?: never;
30926
- console_session?: never;
30927
30974
  })[];
30928
30975
  summary: string;
30929
30976
  tags: string[];
30930
30977
  'x-fern-sdk-group-name': string[];
30931
30978
  'x-fern-sdk-method-name': string;
30932
- 'x-response-key': null;
30979
+ 'x-fern-sdk-return-value': string;
30980
+ 'x-response-key': string;
30933
30981
  'x-title': string;
30934
30982
  };
30935
30983
  };
30936
- '/user_identities/enrollment_automations/get': {
30984
+ '/user_identities/delete': {
30937
30985
  post: {
30938
30986
  description: string;
30939
30987
  operationId: string;
@@ -30942,7 +30990,7 @@ declare const _default: {
30942
30990
  'application/json': {
30943
30991
  schema: {
30944
30992
  properties: {
30945
- enrollment_automation_id: {
30993
+ user_identity_id: {
30946
30994
  description: string;
30947
30995
  format: string;
30948
30996
  type: string;
@@ -30960,9 +31008,6 @@ declare const _default: {
30960
31008
  'application/json': {
30961
31009
  schema: {
30962
31010
  properties: {
30963
- enrollment_automation: {
30964
- $ref: string;
30965
- };
30966
31011
  ok: {
30967
31012
  type: string;
30968
31013
  };
@@ -30982,36 +31027,27 @@ declare const _default: {
30982
31027
  };
30983
31028
  };
30984
31029
  security: ({
30985
- client_session: never[];
31030
+ api_key: never[];
30986
31031
  pat_with_workspace?: never;
30987
31032
  console_session?: never;
30988
- api_key?: never;
30989
31033
  } | {
30990
31034
  pat_with_workspace: never[];
30991
- client_session?: never;
30992
- console_session?: never;
30993
31035
  api_key?: never;
31036
+ console_session?: never;
30994
31037
  } | {
30995
31038
  console_session: never[];
30996
- client_session?: never;
30997
- pat_with_workspace?: never;
30998
31039
  api_key?: never;
30999
- } | {
31000
- api_key: never[];
31001
- client_session?: never;
31002
31040
  pat_with_workspace?: never;
31003
- console_session?: never;
31004
31041
  })[];
31005
31042
  summary: string;
31006
31043
  tags: string[];
31007
31044
  'x-fern-sdk-group-name': string[];
31008
31045
  'x-fern-sdk-method-name': string;
31009
- 'x-fern-sdk-return-value': string;
31010
- 'x-response-key': string;
31046
+ 'x-response-key': null;
31011
31047
  'x-title': string;
31012
31048
  };
31013
31049
  };
31014
- '/user_identities/enrollment_automations/launch': {
31050
+ '/user_identities/enrollment_automations/delete': {
31015
31051
  post: {
31016
31052
  description: string;
31017
31053
  operationId: string;
@@ -31020,26 +31056,7 @@ declare const _default: {
31020
31056
  'application/json': {
31021
31057
  schema: {
31022
31058
  properties: {
31023
- acs_credential_pool_id: {
31024
- description: string;
31025
- format: string;
31026
- type: string;
31027
- };
31028
- create_credential_manager_user: {
31029
- description: string;
31030
- type: string;
31031
- };
31032
- credential_manager_acs_system_id: {
31033
- description: string;
31034
- format: string;
31035
- type: string;
31036
- };
31037
- credential_manager_acs_user_id: {
31038
- description: string;
31039
- format: string;
31040
- type: string;
31041
- };
31042
- user_identity_id: {
31059
+ enrollment_automation_id: {
31043
31060
  description: string;
31044
31061
  format: string;
31045
31062
  type: string;
@@ -31057,36 +31074,6 @@ declare const _default: {
31057
31074
  'application/json': {
31058
31075
  schema: {
31059
31076
  properties: {
31060
- enrollment_automation: {
31061
- properties: {
31062
- acs_credential_provisioning_automation_id: {
31063
- format: string;
31064
- type: string;
31065
- };
31066
- created_at: {
31067
- format: string;
31068
- type: string;
31069
- };
31070
- credential_manager_acs_system_id: {
31071
- format: string;
31072
- type: string;
31073
- };
31074
- enrollment_automation_id: {
31075
- format: string;
31076
- type: string;
31077
- };
31078
- user_identity_id: {
31079
- format: string;
31080
- type: string;
31081
- };
31082
- workspace_id: {
31083
- format: string;
31084
- type: string;
31085
- };
31086
- };
31087
- required: string[];
31088
- type: string;
31089
- };
31090
31077
  ok: {
31091
31078
  type: string;
31092
31079
  };
@@ -31122,12 +31109,11 @@ declare const _default: {
31122
31109
  tags: string[];
31123
31110
  'x-fern-sdk-group-name': string[];
31124
31111
  'x-fern-sdk-method-name': string;
31125
- 'x-fern-sdk-return-value': string;
31126
- 'x-response-key': string;
31112
+ 'x-response-key': null;
31127
31113
  'x-title': string;
31128
31114
  };
31129
31115
  };
31130
- '/user_identities/enrollment_automations/list': {
31116
+ '/user_identities/enrollment_automations/get': {
31131
31117
  post: {
31132
31118
  description: string;
31133
31119
  operationId: string;
@@ -31136,7 +31122,7 @@ declare const _default: {
31136
31122
  'application/json': {
31137
31123
  schema: {
31138
31124
  properties: {
31139
- user_identity_id: {
31125
+ enrollment_automation_id: {
31140
31126
  description: string;
31141
31127
  format: string;
31142
31128
  type: string;
@@ -31154,11 +31140,8 @@ declare const _default: {
31154
31140
  'application/json': {
31155
31141
  schema: {
31156
31142
  properties: {
31157
- enrollment_automations: {
31158
- items: {
31159
- $ref: string;
31160
- };
31161
- type: string;
31143
+ enrollment_automation: {
31144
+ $ref: string;
31162
31145
  };
31163
31146
  ok: {
31164
31147
  type: string;
@@ -31208,7 +31191,7 @@ declare const _default: {
31208
31191
  'x-title': string;
31209
31192
  };
31210
31193
  };
31211
- '/user_identities/get': {
31194
+ '/user_identities/enrollment_automations/launch': {
31212
31195
  post: {
31213
31196
  description: string;
31214
31197
  operationId: string;
@@ -31216,27 +31199,34 @@ declare const _default: {
31216
31199
  content: {
31217
31200
  'application/json': {
31218
31201
  schema: {
31219
- oneOf: ({
31220
- properties: {
31221
- user_identity_id: {
31222
- description: string;
31223
- format: string;
31224
- type: string;
31225
- };
31226
- user_identity_key?: never;
31202
+ properties: {
31203
+ acs_credential_pool_id: {
31204
+ description: string;
31205
+ format: string;
31206
+ type: string;
31227
31207
  };
31228
- required: string[];
31229
- type: string;
31230
- } | {
31231
- properties: {
31232
- user_identity_key: {
31233
- type: string;
31234
- };
31235
- user_identity_id?: never;
31208
+ create_credential_manager_user: {
31209
+ description: string;
31210
+ type: string;
31236
31211
  };
31237
- required: string[];
31238
- type: string;
31239
- })[];
31212
+ credential_manager_acs_system_id: {
31213
+ description: string;
31214
+ format: string;
31215
+ type: string;
31216
+ };
31217
+ credential_manager_acs_user_id: {
31218
+ description: string;
31219
+ format: string;
31220
+ type: string;
31221
+ };
31222
+ user_identity_id: {
31223
+ description: string;
31224
+ format: string;
31225
+ type: string;
31226
+ };
31227
+ };
31228
+ required: string[];
31229
+ type: string;
31240
31230
  };
31241
31231
  };
31242
31232
  };
@@ -31247,11 +31237,38 @@ declare const _default: {
31247
31237
  'application/json': {
31248
31238
  schema: {
31249
31239
  properties: {
31250
- ok: {
31240
+ enrollment_automation: {
31241
+ properties: {
31242
+ acs_credential_provisioning_automation_id: {
31243
+ format: string;
31244
+ type: string;
31245
+ };
31246
+ created_at: {
31247
+ format: string;
31248
+ type: string;
31249
+ };
31250
+ credential_manager_acs_system_id: {
31251
+ format: string;
31252
+ type: string;
31253
+ };
31254
+ enrollment_automation_id: {
31255
+ format: string;
31256
+ type: string;
31257
+ };
31258
+ user_identity_id: {
31259
+ format: string;
31260
+ type: string;
31261
+ };
31262
+ workspace_id: {
31263
+ format: string;
31264
+ type: string;
31265
+ };
31266
+ };
31267
+ required: string[];
31251
31268
  type: string;
31252
31269
  };
31253
- user_identity: {
31254
- $ref: string;
31270
+ ok: {
31271
+ type: string;
31255
31272
  };
31256
31273
  };
31257
31274
  required: string[];
@@ -31269,17 +31286,17 @@ declare const _default: {
31269
31286
  };
31270
31287
  };
31271
31288
  security: ({
31272
- api_key: never[];
31273
- pat_with_workspace?: never;
31274
- console_session?: never;
31275
- } | {
31276
31289
  pat_with_workspace: never[];
31277
- api_key?: never;
31278
31290
  console_session?: never;
31291
+ api_key?: never;
31279
31292
  } | {
31280
31293
  console_session: never[];
31294
+ pat_with_workspace?: never;
31281
31295
  api_key?: never;
31296
+ } | {
31297
+ api_key: never[];
31282
31298
  pat_with_workspace?: never;
31299
+ console_session?: never;
31283
31300
  })[];
31284
31301
  summary: string;
31285
31302
  tags: string[];
@@ -31290,7 +31307,7 @@ declare const _default: {
31290
31307
  'x-title': string;
31291
31308
  };
31292
31309
  };
31293
- '/user_identities/grant_access_to_device': {
31310
+ '/user_identities/enrollment_automations/list': {
31294
31311
  post: {
31295
31312
  description: string;
31296
31313
  operationId: string;
@@ -31299,11 +31316,6 @@ declare const _default: {
31299
31316
  'application/json': {
31300
31317
  schema: {
31301
31318
  properties: {
31302
- device_id: {
31303
- description: string;
31304
- format: string;
31305
- type: string;
31306
- };
31307
31319
  user_identity_id: {
31308
31320
  description: string;
31309
31321
  format: string;
@@ -31322,6 +31334,12 @@ declare const _default: {
31322
31334
  'application/json': {
31323
31335
  schema: {
31324
31336
  properties: {
31337
+ enrollment_automations: {
31338
+ items: {
31339
+ $ref: string;
31340
+ };
31341
+ type: string;
31342
+ };
31325
31343
  ok: {
31326
31344
  type: string;
31327
31345
  };
@@ -31341,46 +31359,64 @@ declare const _default: {
31341
31359
  };
31342
31360
  };
31343
31361
  security: ({
31344
- api_key: never[];
31362
+ client_session: never[];
31345
31363
  pat_with_workspace?: never;
31346
31364
  console_session?: never;
31365
+ api_key?: never;
31347
31366
  } | {
31348
31367
  pat_with_workspace: never[];
31349
- api_key?: never;
31368
+ client_session?: never;
31350
31369
  console_session?: never;
31370
+ api_key?: never;
31351
31371
  } | {
31352
31372
  console_session: never[];
31373
+ client_session?: never;
31374
+ pat_with_workspace?: never;
31353
31375
  api_key?: never;
31376
+ } | {
31377
+ api_key: never[];
31378
+ client_session?: never;
31354
31379
  pat_with_workspace?: never;
31380
+ console_session?: never;
31355
31381
  })[];
31356
31382
  summary: string;
31357
31383
  tags: string[];
31358
31384
  'x-fern-sdk-group-name': string[];
31359
31385
  'x-fern-sdk-method-name': string;
31360
- 'x-response-key': null;
31386
+ 'x-fern-sdk-return-value': string;
31387
+ 'x-response-key': string;
31361
31388
  'x-title': string;
31362
31389
  };
31363
- put: {
31390
+ };
31391
+ '/user_identities/get': {
31392
+ post: {
31364
31393
  description: string;
31365
31394
  operationId: string;
31366
31395
  requestBody: {
31367
31396
  content: {
31368
31397
  'application/json': {
31369
31398
  schema: {
31370
- properties: {
31371
- device_id: {
31372
- description: string;
31373
- format: string;
31374
- type: string;
31399
+ oneOf: ({
31400
+ properties: {
31401
+ user_identity_id: {
31402
+ description: string;
31403
+ format: string;
31404
+ type: string;
31405
+ };
31406
+ user_identity_key?: never;
31375
31407
  };
31376
- user_identity_id: {
31377
- description: string;
31378
- format: string;
31379
- type: string;
31408
+ required: string[];
31409
+ type: string;
31410
+ } | {
31411
+ properties: {
31412
+ user_identity_key: {
31413
+ type: string;
31414
+ };
31415
+ user_identity_id?: never;
31380
31416
  };
31381
- };
31382
- required: string[];
31383
- type: string;
31417
+ required: string[];
31418
+ type: string;
31419
+ })[];
31384
31420
  };
31385
31421
  };
31386
31422
  };
@@ -31394,6 +31430,9 @@ declare const _default: {
31394
31430
  ok: {
31395
31431
  type: string;
31396
31432
  };
31433
+ user_identity: {
31434
+ $ref: string;
31435
+ };
31397
31436
  };
31398
31437
  required: string[];
31399
31438
  type: string;
@@ -31424,12 +31463,14 @@ declare const _default: {
31424
31463
  })[];
31425
31464
  summary: string;
31426
31465
  tags: string[];
31427
- 'x-fern-ignore': boolean;
31428
- 'x-response-key': null;
31466
+ 'x-fern-sdk-group-name': string[];
31467
+ 'x-fern-sdk-method-name': string;
31468
+ 'x-fern-sdk-return-value': string;
31469
+ 'x-response-key': string;
31429
31470
  'x-title': string;
31430
31471
  };
31431
31472
  };
31432
- '/user_identities/list': {
31473
+ '/user_identities/grant_access_to_device': {
31433
31474
  post: {
31434
31475
  description: string;
31435
31476
  operationId: string;
@@ -31438,11 +31479,18 @@ declare const _default: {
31438
31479
  'application/json': {
31439
31480
  schema: {
31440
31481
  properties: {
31441
- credential_manager_acs_system_id: {
31482
+ device_id: {
31483
+ description: string;
31484
+ format: string;
31485
+ type: string;
31486
+ };
31487
+ user_identity_id: {
31488
+ description: string;
31442
31489
  format: string;
31443
31490
  type: string;
31444
31491
  };
31445
31492
  };
31493
+ required: string[];
31446
31494
  type: string;
31447
31495
  };
31448
31496
  };
@@ -31457,12 +31505,6 @@ declare const _default: {
31457
31505
  ok: {
31458
31506
  type: string;
31459
31507
  };
31460
- user_identities: {
31461
- items: {
31462
- $ref: string;
31463
- };
31464
- type: string;
31465
- };
31466
31508
  };
31467
31509
  required: string[];
31468
31510
  type: string;
@@ -31480,36 +31522,25 @@ declare const _default: {
31480
31522
  };
31481
31523
  security: ({
31482
31524
  api_key: never[];
31483
- client_session?: never;
31484
- pat_with_workspace?: never;
31485
- console_session?: never;
31486
- } | {
31487
- client_session: never[];
31488
- api_key?: never;
31489
31525
  pat_with_workspace?: never;
31490
31526
  console_session?: never;
31491
31527
  } | {
31492
31528
  pat_with_workspace: never[];
31493
31529
  api_key?: never;
31494
- client_session?: never;
31495
31530
  console_session?: never;
31496
31531
  } | {
31497
31532
  console_session: never[];
31498
31533
  api_key?: never;
31499
- client_session?: never;
31500
31534
  pat_with_workspace?: never;
31501
31535
  })[];
31502
31536
  summary: string;
31503
31537
  tags: string[];
31504
31538
  'x-fern-sdk-group-name': string[];
31505
31539
  'x-fern-sdk-method-name': string;
31506
- 'x-fern-sdk-return-value': string;
31507
- 'x-response-key': string;
31540
+ 'x-response-key': null;
31508
31541
  'x-title': string;
31509
31542
  };
31510
- };
31511
- '/user_identities/list_accessible_devices': {
31512
- post: {
31543
+ put: {
31513
31544
  description: string;
31514
31545
  operationId: string;
31515
31546
  requestBody: {
@@ -31517,6 +31548,11 @@ declare const _default: {
31517
31548
  'application/json': {
31518
31549
  schema: {
31519
31550
  properties: {
31551
+ device_id: {
31552
+ description: string;
31553
+ format: string;
31554
+ type: string;
31555
+ };
31520
31556
  user_identity_id: {
31521
31557
  description: string;
31522
31558
  format: string;
@@ -31535,20 +31571,6 @@ declare const _default: {
31535
31571
  'application/json': {
31536
31572
  schema: {
31537
31573
  properties: {
31538
- accessible_devices: {
31539
- deprecated: boolean;
31540
- items: {
31541
- $ref: string;
31542
- };
31543
- type: string;
31544
- 'x-deprecated': string;
31545
- };
31546
- devices: {
31547
- items: {
31548
- $ref: string;
31549
- };
31550
- type: string;
31551
- };
31552
31574
  ok: {
31553
31575
  type: string;
31554
31576
  };
@@ -31582,14 +31604,12 @@ declare const _default: {
31582
31604
  })[];
31583
31605
  summary: string;
31584
31606
  tags: string[];
31585
- 'x-fern-sdk-group-name': string[];
31586
- 'x-fern-sdk-method-name': string;
31587
- 'x-fern-sdk-return-value': string;
31588
- 'x-response-key': string;
31607
+ 'x-fern-ignore': boolean;
31608
+ 'x-response-key': null;
31589
31609
  'x-title': string;
31590
31610
  };
31591
31611
  };
31592
- '/user_identities/list_acs_systems': {
31612
+ '/user_identities/list': {
31593
31613
  post: {
31594
31614
  description: string;
31595
31615
  operationId: string;
@@ -31598,13 +31618,11 @@ declare const _default: {
31598
31618
  'application/json': {
31599
31619
  schema: {
31600
31620
  properties: {
31601
- user_identity_id: {
31602
- description: string;
31621
+ credential_manager_acs_system_id: {
31603
31622
  format: string;
31604
31623
  type: string;
31605
31624
  };
31606
31625
  };
31607
- required: string[];
31608
31626
  type: string;
31609
31627
  };
31610
31628
  };
@@ -31616,15 +31634,15 @@ declare const _default: {
31616
31634
  'application/json': {
31617
31635
  schema: {
31618
31636
  properties: {
31619
- acs_systems: {
31637
+ ok: {
31638
+ type: string;
31639
+ };
31640
+ user_identities: {
31620
31641
  items: {
31621
31642
  $ref: string;
31622
31643
  };
31623
31644
  type: string;
31624
31645
  };
31625
- ok: {
31626
- type: string;
31627
- };
31628
31646
  };
31629
31647
  required: string[];
31630
31648
  type: string;
@@ -31641,25 +31659,25 @@ declare const _default: {
31641
31659
  };
31642
31660
  };
31643
31661
  security: ({
31644
- client_session: never[];
31662
+ api_key: never[];
31663
+ client_session?: never;
31645
31664
  pat_with_workspace?: never;
31646
31665
  console_session?: never;
31666
+ } | {
31667
+ client_session: never[];
31647
31668
  api_key?: never;
31669
+ pat_with_workspace?: never;
31670
+ console_session?: never;
31648
31671
  } | {
31649
31672
  pat_with_workspace: never[];
31673
+ api_key?: never;
31650
31674
  client_session?: never;
31651
31675
  console_session?: never;
31652
- api_key?: never;
31653
31676
  } | {
31654
31677
  console_session: never[];
31655
- client_session?: never;
31656
- pat_with_workspace?: never;
31657
31678
  api_key?: never;
31658
- } | {
31659
- api_key: never[];
31660
31679
  client_session?: never;
31661
31680
  pat_with_workspace?: never;
31662
- console_session?: never;
31663
31681
  })[];
31664
31682
  summary: string;
31665
31683
  tags: string[];
@@ -31670,7 +31688,7 @@ declare const _default: {
31670
31688
  'x-title': string;
31671
31689
  };
31672
31690
  };
31673
- '/user_identities/list_acs_users': {
31691
+ '/user_identities/list_accessible_devices': {
31674
31692
  post: {
31675
31693
  description: string;
31676
31694
  operationId: string;
@@ -31697,7 +31715,15 @@ declare const _default: {
31697
31715
  'application/json': {
31698
31716
  schema: {
31699
31717
  properties: {
31700
- acs_users: {
31718
+ accessible_devices: {
31719
+ deprecated: boolean;
31720
+ items: {
31721
+ $ref: string;
31722
+ };
31723
+ type: string;
31724
+ 'x-deprecated': string;
31725
+ };
31726
+ devices: {
31701
31727
  items: {
31702
31728
  $ref: string;
31703
31729
  };
@@ -31743,7 +31769,7 @@ declare const _default: {
31743
31769
  'x-title': string;
31744
31770
  };
31745
31771
  };
31746
- '/user_identities/remove_acs_user': {
31772
+ '/user_identities/list_acs_systems': {
31747
31773
  post: {
31748
31774
  description: string;
31749
31775
  operationId: string;
@@ -31752,11 +31778,6 @@ declare const _default: {
31752
31778
  'application/json': {
31753
31779
  schema: {
31754
31780
  properties: {
31755
- acs_user_id: {
31756
- description: string;
31757
- format: string;
31758
- type: string;
31759
- };
31760
31781
  user_identity_id: {
31761
31782
  description: string;
31762
31783
  format: string;
@@ -31775,6 +31796,12 @@ declare const _default: {
31775
31796
  'application/json': {
31776
31797
  schema: {
31777
31798
  properties: {
31799
+ acs_systems: {
31800
+ items: {
31801
+ $ref: string;
31802
+ };
31803
+ type: string;
31804
+ };
31778
31805
  ok: {
31779
31806
  type: string;
31780
31807
  };
@@ -31794,27 +31821,36 @@ declare const _default: {
31794
31821
  };
31795
31822
  };
31796
31823
  security: ({
31797
- api_key: never[];
31824
+ client_session: never[];
31798
31825
  pat_with_workspace?: never;
31799
31826
  console_session?: never;
31827
+ api_key?: never;
31800
31828
  } | {
31801
31829
  pat_with_workspace: never[];
31802
- api_key?: never;
31830
+ client_session?: never;
31803
31831
  console_session?: never;
31832
+ api_key?: never;
31804
31833
  } | {
31805
31834
  console_session: never[];
31835
+ client_session?: never;
31836
+ pat_with_workspace?: never;
31806
31837
  api_key?: never;
31838
+ } | {
31839
+ api_key: never[];
31840
+ client_session?: never;
31807
31841
  pat_with_workspace?: never;
31842
+ console_session?: never;
31808
31843
  })[];
31809
31844
  summary: string;
31810
31845
  tags: string[];
31811
31846
  'x-fern-sdk-group-name': string[];
31812
31847
  'x-fern-sdk-method-name': string;
31813
- 'x-response-key': null;
31848
+ 'x-fern-sdk-return-value': string;
31849
+ 'x-response-key': string;
31814
31850
  'x-title': string;
31815
31851
  };
31816
31852
  };
31817
- '/user_identities/revoke_access_to_device': {
31853
+ '/user_identities/list_acs_users': {
31818
31854
  post: {
31819
31855
  description: string;
31820
31856
  operationId: string;
@@ -31823,11 +31859,6 @@ declare const _default: {
31823
31859
  'application/json': {
31824
31860
  schema: {
31825
31861
  properties: {
31826
- device_id: {
31827
- description: string;
31828
- format: string;
31829
- type: string;
31830
- };
31831
31862
  user_identity_id: {
31832
31863
  description: string;
31833
31864
  format: string;
@@ -31846,6 +31877,12 @@ declare const _default: {
31846
31877
  'application/json': {
31847
31878
  schema: {
31848
31879
  properties: {
31880
+ acs_users: {
31881
+ items: {
31882
+ $ref: string;
31883
+ };
31884
+ type: string;
31885
+ };
31849
31886
  ok: {
31850
31887
  type: string;
31851
31888
  };
@@ -31881,32 +31918,23 @@ declare const _default: {
31881
31918
  tags: string[];
31882
31919
  'x-fern-sdk-group-name': string[];
31883
31920
  'x-fern-sdk-method-name': string;
31884
- 'x-response-key': null;
31921
+ 'x-fern-sdk-return-value': string;
31922
+ 'x-response-key': string;
31885
31923
  'x-title': string;
31886
31924
  };
31887
31925
  };
31888
- '/user_identities/update': {
31889
- patch: {
31926
+ '/user_identities/remove_acs_user': {
31927
+ post: {
31928
+ description: string;
31890
31929
  operationId: string;
31891
31930
  requestBody: {
31892
31931
  content: {
31893
31932
  'application/json': {
31894
31933
  schema: {
31895
31934
  properties: {
31896
- email_address: {
31935
+ acs_user_id: {
31897
31936
  description: string;
31898
31937
  format: string;
31899
- nullable: boolean;
31900
- type: string;
31901
- };
31902
- full_name: {
31903
- minLength: number;
31904
- nullable: boolean;
31905
- type: string;
31906
- };
31907
- phone_number: {
31908
- description: string;
31909
- nullable: boolean;
31910
31938
  type: string;
31911
31939
  };
31912
31940
  user_identity_id: {
@@ -31914,12 +31942,6 @@ declare const _default: {
31914
31942
  format: string;
31915
31943
  type: string;
31916
31944
  };
31917
- user_identity_key: {
31918
- description: string;
31919
- minLength: number;
31920
- nullable: boolean;
31921
- type: string;
31922
- };
31923
31945
  };
31924
31946
  required: string[];
31925
31947
  type: string;
@@ -31952,44 +31974,38 @@ declare const _default: {
31952
31974
  };
31953
31975
  };
31954
31976
  security: ({
31955
- pat_with_workspace: never[];
31977
+ api_key: never[];
31978
+ pat_with_workspace?: never;
31956
31979
  console_session?: never;
31980
+ } | {
31981
+ pat_with_workspace: never[];
31957
31982
  api_key?: never;
31983
+ console_session?: never;
31958
31984
  } | {
31959
31985
  console_session: never[];
31960
- pat_with_workspace?: never;
31961
31986
  api_key?: never;
31962
- } | {
31963
- api_key: never[];
31964
31987
  pat_with_workspace?: never;
31965
- console_session?: never;
31966
31988
  })[];
31967
31989
  summary: string;
31968
31990
  tags: string[];
31969
- 'x-fern-ignore': boolean;
31991
+ 'x-fern-sdk-group-name': string[];
31992
+ 'x-fern-sdk-method-name': string;
31970
31993
  'x-response-key': null;
31994
+ 'x-title': string;
31971
31995
  };
31996
+ };
31997
+ '/user_identities/revoke_access_to_device': {
31972
31998
  post: {
31999
+ description: string;
31973
32000
  operationId: string;
31974
32001
  requestBody: {
31975
32002
  content: {
31976
32003
  'application/json': {
31977
32004
  schema: {
31978
32005
  properties: {
31979
- email_address: {
32006
+ device_id: {
31980
32007
  description: string;
31981
32008
  format: string;
31982
- nullable: boolean;
31983
- type: string;
31984
- };
31985
- full_name: {
31986
- minLength: number;
31987
- nullable: boolean;
31988
- type: string;
31989
- };
31990
- phone_number: {
31991
- description: string;
31992
- nullable: boolean;
31993
32009
  type: string;
31994
32010
  };
31995
32011
  user_identity_id: {
@@ -31997,12 +32013,6 @@ declare const _default: {
31997
32013
  format: string;
31998
32014
  type: string;
31999
32015
  };
32000
- user_identity_key: {
32001
- description: string;
32002
- minLength: number;
32003
- nullable: boolean;
32004
- type: string;
32005
- };
32006
32016
  };
32007
32017
  required: string[];
32008
32018
  type: string;
@@ -32035,44 +32045,61 @@ declare const _default: {
32035
32045
  };
32036
32046
  };
32037
32047
  security: ({
32038
- pat_with_workspace: never[];
32048
+ api_key: never[];
32049
+ pat_with_workspace?: never;
32039
32050
  console_session?: never;
32051
+ } | {
32052
+ pat_with_workspace: never[];
32040
32053
  api_key?: never;
32054
+ console_session?: never;
32041
32055
  } | {
32042
32056
  console_session: never[];
32043
- pat_with_workspace?: never;
32044
32057
  api_key?: never;
32045
- } | {
32046
- api_key: never[];
32047
32058
  pat_with_workspace?: never;
32048
- console_session?: never;
32049
32059
  })[];
32050
32060
  summary: string;
32051
32061
  tags: string[];
32052
32062
  'x-fern-sdk-group-name': string[];
32053
32063
  'x-fern-sdk-method-name': string;
32054
32064
  'x-response-key': null;
32065
+ 'x-title': string;
32055
32066
  };
32056
32067
  };
32057
- '/webhooks/create': {
32058
- post: {
32068
+ '/user_identities/update': {
32069
+ patch: {
32059
32070
  operationId: string;
32060
32071
  requestBody: {
32061
32072
  content: {
32062
32073
  'application/json': {
32063
32074
  schema: {
32064
32075
  properties: {
32065
- event_types: {
32066
- default: string[];
32067
- items: {
32068
- type: string;
32069
- };
32076
+ email_address: {
32077
+ description: string;
32078
+ format: string;
32079
+ nullable: boolean;
32070
32080
  type: string;
32071
32081
  };
32072
- url: {
32082
+ full_name: {
32083
+ minLength: number;
32084
+ nullable: boolean;
32085
+ type: string;
32086
+ };
32087
+ phone_number: {
32088
+ description: string;
32089
+ nullable: boolean;
32090
+ type: string;
32091
+ };
32092
+ user_identity_id: {
32093
+ description: string;
32073
32094
  format: string;
32074
32095
  type: string;
32075
32096
  };
32097
+ user_identity_key: {
32098
+ description: string;
32099
+ minLength: number;
32100
+ nullable: boolean;
32101
+ type: string;
32102
+ };
32076
32103
  };
32077
32104
  required: string[];
32078
32105
  type: string;
@@ -32089,9 +32116,6 @@ declare const _default: {
32089
32116
  ok: {
32090
32117
  type: string;
32091
32118
  };
32092
- webhook: {
32093
- $ref: string;
32094
- };
32095
32119
  };
32096
32120
  required: string[];
32097
32121
  type: string;
@@ -32108,27 +32132,23 @@ declare const _default: {
32108
32132
  };
32109
32133
  };
32110
32134
  security: ({
32111
- api_key: never[];
32112
- pat_with_workspace?: never;
32113
- console_session?: never;
32114
- } | {
32115
32135
  pat_with_workspace: never[];
32116
- api_key?: never;
32117
32136
  console_session?: never;
32137
+ api_key?: never;
32118
32138
  } | {
32119
32139
  console_session: never[];
32140
+ pat_with_workspace?: never;
32120
32141
  api_key?: never;
32142
+ } | {
32143
+ api_key: never[];
32121
32144
  pat_with_workspace?: never;
32145
+ console_session?: never;
32122
32146
  })[];
32123
32147
  summary: string;
32124
32148
  tags: string[];
32125
- 'x-fern-sdk-group-name': string[];
32126
- 'x-fern-sdk-method-name': string;
32127
- 'x-fern-sdk-return-value': string;
32128
- 'x-response-key': string;
32149
+ 'x-fern-ignore': boolean;
32150
+ 'x-response-key': null;
32129
32151
  };
32130
- };
32131
- '/webhooks/delete': {
32132
32152
  post: {
32133
32153
  operationId: string;
32134
32154
  requestBody: {
@@ -32136,7 +32156,31 @@ declare const _default: {
32136
32156
  'application/json': {
32137
32157
  schema: {
32138
32158
  properties: {
32139
- webhook_id: {
32159
+ email_address: {
32160
+ description: string;
32161
+ format: string;
32162
+ nullable: boolean;
32163
+ type: string;
32164
+ };
32165
+ full_name: {
32166
+ minLength: number;
32167
+ nullable: boolean;
32168
+ type: string;
32169
+ };
32170
+ phone_number: {
32171
+ description: string;
32172
+ nullable: boolean;
32173
+ type: string;
32174
+ };
32175
+ user_identity_id: {
32176
+ description: string;
32177
+ format: string;
32178
+ type: string;
32179
+ };
32180
+ user_identity_key: {
32181
+ description: string;
32182
+ minLength: number;
32183
+ nullable: boolean;
32140
32184
  type: string;
32141
32185
  };
32142
32186
  };
@@ -32171,17 +32215,17 @@ declare const _default: {
32171
32215
  };
32172
32216
  };
32173
32217
  security: ({
32174
- api_key: never[];
32175
- pat_with_workspace?: never;
32176
- console_session?: never;
32177
- } | {
32178
32218
  pat_with_workspace: never[];
32179
- api_key?: never;
32180
32219
  console_session?: never;
32220
+ api_key?: never;
32181
32221
  } | {
32182
32222
  console_session: never[];
32223
+ pat_with_workspace?: never;
32183
32224
  api_key?: never;
32225
+ } | {
32226
+ api_key: never[];
32184
32227
  pat_with_workspace?: never;
32228
+ console_session?: never;
32185
32229
  })[];
32186
32230
  summary: string;
32187
32231
  tags: string[];
@@ -32190,7 +32234,7 @@ declare const _default: {
32190
32234
  'x-response-key': null;
32191
32235
  };
32192
32236
  };
32193
- '/webhooks/get': {
32237
+ '/webhooks/create': {
32194
32238
  post: {
32195
32239
  operationId: string;
32196
32240
  requestBody: {
@@ -32198,7 +32242,15 @@ declare const _default: {
32198
32242
  'application/json': {
32199
32243
  schema: {
32200
32244
  properties: {
32201
- webhook_id: {
32245
+ event_types: {
32246
+ default: string[];
32247
+ items: {
32248
+ type: string;
32249
+ };
32250
+ type: string;
32251
+ };
32252
+ url: {
32253
+ format: string;
32202
32254
  type: string;
32203
32255
  };
32204
32256
  };
@@ -32256,59 +32308,24 @@ declare const _default: {
32256
32308
  'x-response-key': string;
32257
32309
  };
32258
32310
  };
32259
- '/webhooks/list': {
32260
- get: {
32311
+ '/webhooks/delete': {
32312
+ post: {
32261
32313
  operationId: string;
32262
- responses: {
32263
- 200: {
32264
- content: {
32265
- 'application/json': {
32266
- schema: {
32267
- properties: {
32268
- ok: {
32269
- type: string;
32270
- };
32271
- webhooks: {
32272
- items: {
32273
- $ref: string;
32274
- };
32275
- type: string;
32276
- };
32314
+ requestBody: {
32315
+ content: {
32316
+ 'application/json': {
32317
+ schema: {
32318
+ properties: {
32319
+ webhook_id: {
32320
+ type: string;
32277
32321
  };
32278
- required: string[];
32279
- type: string;
32280
32322
  };
32323
+ required: string[];
32324
+ type: string;
32281
32325
  };
32282
32326
  };
32283
- description: string;
32284
- };
32285
- 400: {
32286
- description: string;
32287
- };
32288
- 401: {
32289
- description: string;
32290
32327
  };
32291
32328
  };
32292
- security: ({
32293
- api_key: never[];
32294
- pat_with_workspace?: never;
32295
- console_session?: never;
32296
- } | {
32297
- pat_with_workspace: never[];
32298
- api_key?: never;
32299
- console_session?: never;
32300
- } | {
32301
- console_session: never[];
32302
- api_key?: never;
32303
- pat_with_workspace?: never;
32304
- })[];
32305
- summary: string;
32306
- tags: string[];
32307
- 'x-fern-ignore': boolean;
32308
- 'x-response-key': string;
32309
- };
32310
- post: {
32311
- operationId: string;
32312
32329
  responses: {
32313
32330
  200: {
32314
32331
  content: {
@@ -32318,12 +32335,175 @@ declare const _default: {
32318
32335
  ok: {
32319
32336
  type: string;
32320
32337
  };
32321
- webhooks: {
32322
- items: {
32323
- $ref: string;
32324
- };
32325
- type: string;
32326
- };
32338
+ };
32339
+ required: string[];
32340
+ type: string;
32341
+ };
32342
+ };
32343
+ };
32344
+ description: string;
32345
+ };
32346
+ 400: {
32347
+ description: string;
32348
+ };
32349
+ 401: {
32350
+ description: string;
32351
+ };
32352
+ };
32353
+ security: ({
32354
+ api_key: never[];
32355
+ pat_with_workspace?: never;
32356
+ console_session?: never;
32357
+ } | {
32358
+ pat_with_workspace: never[];
32359
+ api_key?: never;
32360
+ console_session?: never;
32361
+ } | {
32362
+ console_session: never[];
32363
+ api_key?: never;
32364
+ pat_with_workspace?: never;
32365
+ })[];
32366
+ summary: string;
32367
+ tags: string[];
32368
+ 'x-fern-sdk-group-name': string[];
32369
+ 'x-fern-sdk-method-name': string;
32370
+ 'x-response-key': null;
32371
+ };
32372
+ };
32373
+ '/webhooks/get': {
32374
+ post: {
32375
+ operationId: string;
32376
+ requestBody: {
32377
+ content: {
32378
+ 'application/json': {
32379
+ schema: {
32380
+ properties: {
32381
+ webhook_id: {
32382
+ type: string;
32383
+ };
32384
+ };
32385
+ required: string[];
32386
+ type: string;
32387
+ };
32388
+ };
32389
+ };
32390
+ };
32391
+ responses: {
32392
+ 200: {
32393
+ content: {
32394
+ 'application/json': {
32395
+ schema: {
32396
+ properties: {
32397
+ ok: {
32398
+ type: string;
32399
+ };
32400
+ webhook: {
32401
+ $ref: string;
32402
+ };
32403
+ };
32404
+ required: string[];
32405
+ type: string;
32406
+ };
32407
+ };
32408
+ };
32409
+ description: string;
32410
+ };
32411
+ 400: {
32412
+ description: string;
32413
+ };
32414
+ 401: {
32415
+ description: string;
32416
+ };
32417
+ };
32418
+ security: ({
32419
+ api_key: never[];
32420
+ pat_with_workspace?: never;
32421
+ console_session?: never;
32422
+ } | {
32423
+ pat_with_workspace: never[];
32424
+ api_key?: never;
32425
+ console_session?: never;
32426
+ } | {
32427
+ console_session: never[];
32428
+ api_key?: never;
32429
+ pat_with_workspace?: never;
32430
+ })[];
32431
+ summary: string;
32432
+ tags: string[];
32433
+ 'x-fern-sdk-group-name': string[];
32434
+ 'x-fern-sdk-method-name': string;
32435
+ 'x-fern-sdk-return-value': string;
32436
+ 'x-response-key': string;
32437
+ };
32438
+ };
32439
+ '/webhooks/list': {
32440
+ get: {
32441
+ operationId: string;
32442
+ responses: {
32443
+ 200: {
32444
+ content: {
32445
+ 'application/json': {
32446
+ schema: {
32447
+ properties: {
32448
+ ok: {
32449
+ type: string;
32450
+ };
32451
+ webhooks: {
32452
+ items: {
32453
+ $ref: string;
32454
+ };
32455
+ type: string;
32456
+ };
32457
+ };
32458
+ required: string[];
32459
+ type: string;
32460
+ };
32461
+ };
32462
+ };
32463
+ description: string;
32464
+ };
32465
+ 400: {
32466
+ description: string;
32467
+ };
32468
+ 401: {
32469
+ description: string;
32470
+ };
32471
+ };
32472
+ security: ({
32473
+ api_key: never[];
32474
+ pat_with_workspace?: never;
32475
+ console_session?: never;
32476
+ } | {
32477
+ pat_with_workspace: never[];
32478
+ api_key?: never;
32479
+ console_session?: never;
32480
+ } | {
32481
+ console_session: never[];
32482
+ api_key?: never;
32483
+ pat_with_workspace?: never;
32484
+ })[];
32485
+ summary: string;
32486
+ tags: string[];
32487
+ 'x-fern-ignore': boolean;
32488
+ 'x-response-key': string;
32489
+ };
32490
+ post: {
32491
+ operationId: string;
32492
+ responses: {
32493
+ 200: {
32494
+ content: {
32495
+ 'application/json': {
32496
+ schema: {
32497
+ properties: {
32498
+ ok: {
32499
+ type: string;
32500
+ };
32501
+ webhooks: {
32502
+ items: {
32503
+ $ref: string;
32504
+ };
32505
+ type: string;
32506
+ };
32327
32507
  };
32328
32508
  required: string[];
32329
32509
  type: string;
@@ -37086,7 +37266,7 @@ interface Routes {
37086
37266
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
37087
37267
  starts_at: string;
37088
37268
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
37089
- ends_at: string;
37269
+ ends_at: string | null;
37090
37270
  } | undefined;
37091
37271
  /** ID of the user identity associated with the `acs_user`. */
37092
37272
  user_identity_id?: string | undefined;
@@ -40563,10 +40743,10 @@ interface Routes {
40563
40743
  acs_access_group_ids?: string[];
40564
40744
  /** ID of the user identity with which to associate the new `acs_user`. */
40565
40745
  user_identity_id?: string | undefined;
40566
- /** `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems. */
40746
+ /** `starts_at` and `ends_at` timestamps for the new `acs_user`'s access. If you specify an `access_schedule`, you may include both `starts_at` and `ends_at`. `starts_at` defaults to the current time if not provided. `ends_at` is optional and must be a time in the future and after `starts_at`. */
40567
40747
  access_schedule?: {
40568
- starts_at: string;
40569
- ends_at: string;
40748
+ starts_at?: string | undefined;
40749
+ ends_at?: (string | undefined) | null;
40570
40750
  } | undefined;
40571
40751
  /** Full name of the `acs_user`. */
40572
40752
  full_name?: string | undefined;
@@ -40604,7 +40784,7 @@ interface Routes {
40604
40784
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
40605
40785
  starts_at: string;
40606
40786
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
40607
- ends_at: string;
40787
+ ends_at: string | null;
40608
40788
  } | undefined;
40609
40789
  /** ID of the user identity associated with the `acs_user`. */
40610
40790
  user_identity_id?: string | undefined;
@@ -40719,7 +40899,7 @@ interface Routes {
40719
40899
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
40720
40900
  starts_at: string;
40721
40901
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
40722
- ends_at: string;
40902
+ ends_at: string | null;
40723
40903
  } | undefined;
40724
40904
  /** ID of the user identity associated with the `acs_user`. */
40725
40905
  user_identity_id?: string | undefined;
@@ -40830,7 +41010,7 @@ interface Routes {
40830
41010
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
40831
41011
  starts_at: string;
40832
41012
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
40833
- ends_at: string;
41013
+ ends_at: string | null;
40834
41014
  } | undefined;
40835
41015
  /** ID of the user identity associated with the `acs_user`. */
40836
41016
  user_identity_id?: string | undefined;
@@ -41031,7 +41211,7 @@ interface Routes {
41031
41211
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41032
41212
  starts_at: string;
41033
41213
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41034
- ends_at: string;
41214
+ ends_at: string | null;
41035
41215
  } | undefined;
41036
41216
  /** ID of the user identity associated with the `acs_user`. */
41037
41217
  user_identity_id?: string | undefined;
@@ -41137,7 +41317,7 @@ interface Routes {
41137
41317
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41138
41318
  starts_at: string;
41139
41319
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41140
- ends_at: string;
41320
+ ends_at: string | null;
41141
41321
  } | undefined;
41142
41322
  /** ID of the user identity associated with the `acs_user`. */
41143
41323
  user_identity_id?: string | undefined;
@@ -41223,7 +41403,7 @@ interface Routes {
41223
41403
  method: 'PATCH' | 'POST';
41224
41404
  queryParams: {};
41225
41405
  jsonBody: {
41226
- /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. Only applicable to Salto KS access control systems. */
41406
+ /** `starts_at` and `ends_at` timestamps for the `acs_user`'s access. If you specify an `access_schedule`, you must include both `starts_at` and `ends_at`. `ends_at` must be a time in the future and after `starts_at`. */
41227
41407
  access_schedule?: ({
41228
41408
  starts_at: string;
41229
41409
  ends_at: string;
@@ -59384,6 +59564,876 @@ interface Routes {
59384
59564
  };
59385
59565
  };
59386
59566
  };
59567
+ '/thermostats/set_hvac_mode': {
59568
+ route: '/thermostats/set_hvac_mode';
59569
+ method: 'POST';
59570
+ queryParams: {};
59571
+ jsonBody: {
59572
+ hvac_mode_setting: 'off';
59573
+ /** ID of the desired thermostat device. */
59574
+ device_id: string;
59575
+ } | {
59576
+ hvac_mode_setting: 'cool';
59577
+ /** ID of the desired thermostat device. */
59578
+ device_id: string;
59579
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
59580
+ cooling_set_point_celsius?: number | undefined;
59581
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
59582
+ cooling_set_point_fahrenheit?: number | undefined;
59583
+ } | {
59584
+ hvac_mode_setting: 'heat';
59585
+ /** ID of the desired thermostat device. */
59586
+ device_id: string;
59587
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
59588
+ heating_set_point_celsius?: number | undefined;
59589
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
59590
+ heating_set_point_fahrenheit?: number | undefined;
59591
+ } | {
59592
+ hvac_mode_setting: 'heat_cool';
59593
+ /** ID of the desired thermostat device. */
59594
+ device_id: string;
59595
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
59596
+ cooling_set_point_celsius?: number | undefined;
59597
+ /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
59598
+ cooling_set_point_fahrenheit?: number | undefined;
59599
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
59600
+ heating_set_point_celsius?: number | undefined;
59601
+ /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
59602
+ heating_set_point_fahrenheit?: number | undefined;
59603
+ };
59604
+ commonParams: {};
59605
+ formData: {};
59606
+ jsonResponse: {
59607
+ action_attempt: {
59608
+ /** The ID of the action attempt. */
59609
+ action_attempt_id: string;
59610
+ status: 'pending';
59611
+ result: null;
59612
+ error: null;
59613
+ action_type: 'LOCK_DOOR';
59614
+ } | {
59615
+ /** The ID of the action attempt. */
59616
+ action_attempt_id: string;
59617
+ status: 'success';
59618
+ error: null;
59619
+ action_type: 'LOCK_DOOR';
59620
+ result: {};
59621
+ } | {
59622
+ /** The ID of the action attempt. */
59623
+ action_attempt_id: string;
59624
+ status: 'error';
59625
+ result: null;
59626
+ action_type: 'LOCK_DOOR';
59627
+ error: {
59628
+ type: string;
59629
+ message: string;
59630
+ };
59631
+ } | {
59632
+ /** The ID of the action attempt. */
59633
+ action_attempt_id: string;
59634
+ status: 'pending';
59635
+ result: null;
59636
+ error: null;
59637
+ action_type: 'UNLOCK_DOOR';
59638
+ } | {
59639
+ /** The ID of the action attempt. */
59640
+ action_attempt_id: string;
59641
+ status: 'success';
59642
+ error: null;
59643
+ action_type: 'UNLOCK_DOOR';
59644
+ result: {};
59645
+ } | {
59646
+ /** The ID of the action attempt. */
59647
+ action_attempt_id: string;
59648
+ status: 'error';
59649
+ result: null;
59650
+ action_type: 'UNLOCK_DOOR';
59651
+ error: {
59652
+ type: string;
59653
+ message: string;
59654
+ };
59655
+ } | {
59656
+ /** The ID of the action attempt. */
59657
+ action_attempt_id: string;
59658
+ status: 'pending';
59659
+ result: null;
59660
+ error: null;
59661
+ action_type: 'SCAN_CREDENTIAL';
59662
+ } | {
59663
+ /** The ID of the action attempt. */
59664
+ action_attempt_id: string;
59665
+ status: 'success';
59666
+ error: null;
59667
+ action_type: 'SCAN_CREDENTIAL';
59668
+ result: {
59669
+ /** Snapshot of credential data read from physical encoder. */
59670
+ acs_credential_on_encoder: {
59671
+ /** Date and time the credential was created. */
59672
+ created_at: string | null;
59673
+ is_issued: boolean | null;
59674
+ /** Date and time the credential will become useable. */
59675
+ starts_at: string | null;
59676
+ /** Date and time the credential will stop being useable. */
59677
+ ends_at: string | null;
59678
+ /** A number or string that physically identifies this card. */
59679
+ card_number: string | null;
59680
+ /** Visionline-specific metadata for the credential. */
59681
+ visionline_metadata?: {
59682
+ card_id: string;
59683
+ cancelled: boolean;
59684
+ discarded: boolean;
59685
+ expired: boolean;
59686
+ overwritten: boolean;
59687
+ overridden?: boolean | undefined;
59688
+ pending_auto_update: boolean;
59689
+ card_format: 'TLCode' | 'rfid48';
59690
+ card_holder?: string | undefined;
59691
+ number_of_issued_cards: number;
59692
+ guest_acs_entrance_ids?: string[] | undefined;
59693
+ common_acs_entrance_ids?: string[] | undefined;
59694
+ } | undefined;
59695
+ };
59696
+ /** Matching acs_credential currently encoded on this card. */
59697
+ acs_credential_on_seam: ({
59698
+ /** ID of the credential. */
59699
+ acs_credential_id: string;
59700
+ /** ID of the ACS user to whom the credential belongs. */
59701
+ acs_user_id?: string | undefined;
59702
+ acs_credential_pool_id?: string | undefined;
59703
+ /** ID of the access control system that contains the credential. */
59704
+ acs_system_id: string;
59705
+ /** ID of the parent credential. */
59706
+ parent_acs_credential_id?: string | undefined;
59707
+ /** Display name that corresponds to the credential type. */
59708
+ display_name: string;
59709
+ /** Access (PIN) code for the credential. */
59710
+ code?: (string | undefined) | null;
59711
+ card_number?: (string | undefined) | null;
59712
+ is_issued?: boolean | undefined;
59713
+ issued_at?: (string | undefined) | null;
59714
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
59715
+ access_method: 'code' | 'card' | 'mobile_key';
59716
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
59717
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
59718
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
59719
+ external_type_display_name?: string | undefined;
59720
+ /** Date and time at which the credential was created. */
59721
+ created_at: string;
59722
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
59723
+ workspace_id: string;
59724
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
59725
+ starts_at?: string | undefined;
59726
+ /** Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
59727
+ ends_at?: string | undefined;
59728
+ /** Errors associated with the `acs_credential`. */
59729
+ errors: Array<{
59730
+ error_code: string;
59731
+ message: string;
59732
+ }>;
59733
+ /** Warnings associated with the `acs_credential`. */
59734
+ warnings: Array<{
59735
+ /** Date and time at which Seam created the warning. */
59736
+ created_at: string;
59737
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59738
+ message: string;
59739
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59740
+ warning_code: 'waiting_to_be_issued';
59741
+ } | {
59742
+ /** Date and time at which Seam created the warning. */
59743
+ created_at: string;
59744
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59745
+ message: string;
59746
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59747
+ warning_code: 'schedule_externally_modified';
59748
+ } | {
59749
+ /** Date and time at which Seam created the warning. */
59750
+ created_at: string;
59751
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59752
+ message: string;
59753
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59754
+ warning_code: 'schedule_modified';
59755
+ } | {
59756
+ /** Date and time at which Seam created the warning. */
59757
+ created_at: string;
59758
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59759
+ message: string;
59760
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59761
+ warning_code: 'being_deleted';
59762
+ }>;
59763
+ /** Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
59764
+ is_multi_phone_sync_credential?: boolean | undefined;
59765
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
59766
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
59767
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
59768
+ latest_desired_state_synced_with_provider_at?: string | undefined;
59769
+ /** Visionline-specific metadata for the credential. */
59770
+ visionline_metadata?: {
59771
+ card_function_type: 'guest' | 'staff';
59772
+ joiner_acs_credential_ids?: string[] | undefined;
59773
+ guest_acs_entrance_ids?: string[] | undefined;
59774
+ common_acs_entrance_ids?: string[] | undefined;
59775
+ is_valid?: boolean | undefined;
59776
+ auto_join?: boolean | undefined;
59777
+ card_id?: string | undefined;
59778
+ credential_id?: string | undefined;
59779
+ } | undefined;
59780
+ is_managed: true;
59781
+ } | {
59782
+ /** ID of the credential. */
59783
+ acs_credential_id: string;
59784
+ /** ID of the ACS user to whom the credential belongs. */
59785
+ acs_user_id?: string | undefined;
59786
+ acs_credential_pool_id?: string | undefined;
59787
+ /** ID of the access control system that contains the credential. */
59788
+ acs_system_id: string;
59789
+ /** ID of the parent credential. */
59790
+ parent_acs_credential_id?: string | undefined;
59791
+ /** Display name that corresponds to the credential type. */
59792
+ display_name: string;
59793
+ /** Access (PIN) code for the credential. */
59794
+ code?: (string | undefined) | null;
59795
+ card_number?: (string | undefined) | null;
59796
+ is_issued?: boolean | undefined;
59797
+ issued_at?: (string | undefined) | null;
59798
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
59799
+ access_method: 'code' | 'card' | 'mobile_key';
59800
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
59801
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
59802
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
59803
+ external_type_display_name?: string | undefined;
59804
+ /** Date and time at which the credential was created. */
59805
+ created_at: string;
59806
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
59807
+ workspace_id: string;
59808
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
59809
+ starts_at?: string | undefined;
59810
+ /** Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
59811
+ ends_at?: string | undefined;
59812
+ /** Errors associated with the `acs_credential`. */
59813
+ errors: Array<{
59814
+ error_code: string;
59815
+ message: string;
59816
+ }>;
59817
+ /** Warnings associated with the `acs_credential`. */
59818
+ warnings: Array<{
59819
+ /** Date and time at which Seam created the warning. */
59820
+ created_at: string;
59821
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59822
+ message: string;
59823
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59824
+ warning_code: 'waiting_to_be_issued';
59825
+ } | {
59826
+ /** Date and time at which Seam created the warning. */
59827
+ created_at: string;
59828
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59829
+ message: string;
59830
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59831
+ warning_code: 'schedule_externally_modified';
59832
+ } | {
59833
+ /** Date and time at which Seam created the warning. */
59834
+ created_at: string;
59835
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59836
+ message: string;
59837
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59838
+ warning_code: 'schedule_modified';
59839
+ } | {
59840
+ /** Date and time at which Seam created the warning. */
59841
+ created_at: string;
59842
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59843
+ message: string;
59844
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59845
+ warning_code: 'being_deleted';
59846
+ }>;
59847
+ /** Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
59848
+ is_multi_phone_sync_credential?: boolean | undefined;
59849
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
59850
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
59851
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
59852
+ latest_desired_state_synced_with_provider_at?: string | undefined;
59853
+ /** Visionline-specific metadata for the credential. */
59854
+ visionline_metadata?: {
59855
+ card_function_type: 'guest' | 'staff';
59856
+ joiner_acs_credential_ids?: string[] | undefined;
59857
+ guest_acs_entrance_ids?: string[] | undefined;
59858
+ common_acs_entrance_ids?: string[] | undefined;
59859
+ is_valid?: boolean | undefined;
59860
+ auto_join?: boolean | undefined;
59861
+ card_id?: string | undefined;
59862
+ credential_id?: string | undefined;
59863
+ } | undefined;
59864
+ is_managed: false;
59865
+ }) | null;
59866
+ warnings: Array<{
59867
+ warning_code: 'acs_credential_on_encoder_out_of_sync';
59868
+ warning_message: string;
59869
+ }>;
59870
+ };
59871
+ } | {
59872
+ /** The ID of the action attempt. */
59873
+ action_attempt_id: string;
59874
+ status: 'error';
59875
+ result: null;
59876
+ action_type: 'SCAN_CREDENTIAL';
59877
+ error: {
59878
+ type: 'uncategorized_error';
59879
+ message: string;
59880
+ } | {
59881
+ type: 'action_attempt_expired';
59882
+ message: string;
59883
+ } | {
59884
+ type: 'no_card_on_encoder';
59885
+ message: string;
59886
+ };
59887
+ } | {
59888
+ /** The ID of the action attempt. */
59889
+ action_attempt_id: string;
59890
+ status: 'pending';
59891
+ result: null;
59892
+ error: null;
59893
+ action_type: 'ENCODE_CREDENTIAL';
59894
+ } | {
59895
+ /** The ID of the action attempt. */
59896
+ action_attempt_id: string;
59897
+ status: 'success';
59898
+ error: null;
59899
+ action_type: 'ENCODE_CREDENTIAL';
59900
+ /** Means by which a user gains access at an entrance.
59901
+ The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
59902
+ result: {
59903
+ /** ID of the credential. */
59904
+ acs_credential_id: string;
59905
+ /** ID of the ACS user to whom the credential belongs. */
59906
+ acs_user_id?: string | undefined;
59907
+ acs_credential_pool_id?: string | undefined;
59908
+ /** ID of the access control system that contains the credential. */
59909
+ acs_system_id: string;
59910
+ /** ID of the parent credential. */
59911
+ parent_acs_credential_id?: string | undefined;
59912
+ /** Display name that corresponds to the credential type. */
59913
+ display_name: string;
59914
+ /** Access (PIN) code for the credential. */
59915
+ code?: (string | undefined) | null;
59916
+ card_number?: (string | undefined) | null;
59917
+ is_issued?: boolean | undefined;
59918
+ issued_at?: (string | undefined) | null;
59919
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
59920
+ access_method: 'code' | 'card' | 'mobile_key';
59921
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
59922
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
59923
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
59924
+ external_type_display_name?: string | undefined;
59925
+ /** Date and time at which the credential was created. */
59926
+ created_at: string;
59927
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
59928
+ workspace_id: string;
59929
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
59930
+ starts_at?: string | undefined;
59931
+ /** Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
59932
+ ends_at?: string | undefined;
59933
+ /** Errors associated with the `acs_credential`. */
59934
+ errors: Array<{
59935
+ error_code: string;
59936
+ message: string;
59937
+ }>;
59938
+ /** Warnings associated with the `acs_credential`. */
59939
+ warnings: Array<{
59940
+ /** Date and time at which Seam created the warning. */
59941
+ created_at: string;
59942
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59943
+ message: string;
59944
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59945
+ warning_code: 'waiting_to_be_issued';
59946
+ } | {
59947
+ /** Date and time at which Seam created the warning. */
59948
+ created_at: string;
59949
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59950
+ message: string;
59951
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59952
+ warning_code: 'schedule_externally_modified';
59953
+ } | {
59954
+ /** Date and time at which Seam created the warning. */
59955
+ created_at: string;
59956
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59957
+ message: string;
59958
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59959
+ warning_code: 'schedule_modified';
59960
+ } | {
59961
+ /** Date and time at which Seam created the warning. */
59962
+ created_at: string;
59963
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59964
+ message: string;
59965
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59966
+ warning_code: 'being_deleted';
59967
+ }>;
59968
+ /** Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
59969
+ is_multi_phone_sync_credential?: boolean | undefined;
59970
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
59971
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
59972
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
59973
+ latest_desired_state_synced_with_provider_at?: string | undefined;
59974
+ /** Visionline-specific metadata for the credential. */
59975
+ visionline_metadata?: {
59976
+ card_function_type: 'guest' | 'staff';
59977
+ joiner_acs_credential_ids?: string[] | undefined;
59978
+ guest_acs_entrance_ids?: string[] | undefined;
59979
+ common_acs_entrance_ids?: string[] | undefined;
59980
+ is_valid?: boolean | undefined;
59981
+ auto_join?: boolean | undefined;
59982
+ card_id?: string | undefined;
59983
+ credential_id?: string | undefined;
59984
+ } | undefined;
59985
+ is_managed: true;
59986
+ } | {
59987
+ /** ID of the credential. */
59988
+ acs_credential_id: string;
59989
+ /** ID of the ACS user to whom the credential belongs. */
59990
+ acs_user_id?: string | undefined;
59991
+ acs_credential_pool_id?: string | undefined;
59992
+ /** ID of the access control system that contains the credential. */
59993
+ acs_system_id: string;
59994
+ /** ID of the parent credential. */
59995
+ parent_acs_credential_id?: string | undefined;
59996
+ /** Display name that corresponds to the credential type. */
59997
+ display_name: string;
59998
+ /** Access (PIN) code for the credential. */
59999
+ code?: (string | undefined) | null;
60000
+ card_number?: (string | undefined) | null;
60001
+ is_issued?: boolean | undefined;
60002
+ issued_at?: (string | undefined) | null;
60003
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
60004
+ access_method: 'code' | 'card' | 'mobile_key';
60005
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
60006
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
60007
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
60008
+ external_type_display_name?: string | undefined;
60009
+ /** Date and time at which the credential was created. */
60010
+ created_at: string;
60011
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
60012
+ workspace_id: string;
60013
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
60014
+ starts_at?: string | undefined;
60015
+ /** Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
60016
+ ends_at?: string | undefined;
60017
+ /** Errors associated with the `acs_credential`. */
60018
+ errors: Array<{
60019
+ error_code: string;
60020
+ message: string;
60021
+ }>;
60022
+ /** Warnings associated with the `acs_credential`. */
60023
+ warnings: Array<{
60024
+ /** Date and time at which Seam created the warning. */
60025
+ created_at: string;
60026
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
60027
+ message: string;
60028
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
60029
+ warning_code: 'waiting_to_be_issued';
60030
+ } | {
60031
+ /** Date and time at which Seam created the warning. */
60032
+ created_at: string;
60033
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
60034
+ message: string;
60035
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
60036
+ warning_code: 'schedule_externally_modified';
60037
+ } | {
60038
+ /** Date and time at which Seam created the warning. */
60039
+ created_at: string;
60040
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
60041
+ message: string;
60042
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
60043
+ warning_code: 'schedule_modified';
60044
+ } | {
60045
+ /** Date and time at which Seam created the warning. */
60046
+ created_at: string;
60047
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
60048
+ message: string;
60049
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
60050
+ warning_code: 'being_deleted';
60051
+ }>;
60052
+ /** Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
60053
+ is_multi_phone_sync_credential?: boolean | undefined;
60054
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
60055
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
60056
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
60057
+ latest_desired_state_synced_with_provider_at?: string | undefined;
60058
+ /** Visionline-specific metadata for the credential. */
60059
+ visionline_metadata?: {
60060
+ card_function_type: 'guest' | 'staff';
60061
+ joiner_acs_credential_ids?: string[] | undefined;
60062
+ guest_acs_entrance_ids?: string[] | undefined;
60063
+ common_acs_entrance_ids?: string[] | undefined;
60064
+ is_valid?: boolean | undefined;
60065
+ auto_join?: boolean | undefined;
60066
+ card_id?: string | undefined;
60067
+ credential_id?: string | undefined;
60068
+ } | undefined;
60069
+ is_managed: false;
60070
+ };
60071
+ } | {
60072
+ /** The ID of the action attempt. */
60073
+ action_attempt_id: string;
60074
+ status: 'error';
60075
+ result: null;
60076
+ action_type: 'ENCODE_CREDENTIAL';
60077
+ error: {
60078
+ type: 'uncategorized_error';
60079
+ message: string;
60080
+ } | {
60081
+ type: 'action_attempt_expired';
60082
+ message: string;
60083
+ } | {
60084
+ type: 'no_card_on_encoder';
60085
+ message: string;
60086
+ } | {
60087
+ type: 'incompatible_card_format';
60088
+ message: string;
60089
+ };
60090
+ } | {
60091
+ /** The ID of the action attempt. */
60092
+ action_attempt_id: string;
60093
+ status: 'pending';
60094
+ result: null;
60095
+ error: null;
60096
+ action_type: 'RESET_SANDBOX_WORKSPACE';
60097
+ } | {
60098
+ /** The ID of the action attempt. */
60099
+ action_attempt_id: string;
60100
+ status: 'success';
60101
+ error: null;
60102
+ action_type: 'RESET_SANDBOX_WORKSPACE';
60103
+ result: {};
60104
+ } | {
60105
+ /** The ID of the action attempt. */
60106
+ action_attempt_id: string;
60107
+ status: 'error';
60108
+ result: null;
60109
+ action_type: 'RESET_SANDBOX_WORKSPACE';
60110
+ error: {
60111
+ type: string;
60112
+ message: string;
60113
+ };
60114
+ } | {
60115
+ /** The ID of the action attempt. */
60116
+ action_attempt_id: string;
60117
+ status: 'pending';
60118
+ result: null;
60119
+ error: null;
60120
+ action_type: 'SET_COOL';
60121
+ } | {
60122
+ /** The ID of the action attempt. */
60123
+ action_attempt_id: string;
60124
+ status: 'success';
60125
+ error: null;
60126
+ action_type: 'SET_COOL';
60127
+ result: {};
60128
+ } | {
60129
+ /** The ID of the action attempt. */
60130
+ action_attempt_id: string;
60131
+ status: 'error';
60132
+ result: null;
60133
+ action_type: 'SET_COOL';
60134
+ error: {
60135
+ type: string;
60136
+ message: string;
60137
+ };
60138
+ } | {
60139
+ /** The ID of the action attempt. */
60140
+ action_attempt_id: string;
60141
+ status: 'pending';
60142
+ result: null;
60143
+ error: null;
60144
+ action_type: 'SET_HEAT';
60145
+ } | {
60146
+ /** The ID of the action attempt. */
60147
+ action_attempt_id: string;
60148
+ status: 'success';
60149
+ error: null;
60150
+ action_type: 'SET_HEAT';
60151
+ result: {};
60152
+ } | {
60153
+ /** The ID of the action attempt. */
60154
+ action_attempt_id: string;
60155
+ status: 'error';
60156
+ result: null;
60157
+ action_type: 'SET_HEAT';
60158
+ error: {
60159
+ type: string;
60160
+ message: string;
60161
+ };
60162
+ } | {
60163
+ /** The ID of the action attempt. */
60164
+ action_attempt_id: string;
60165
+ status: 'pending';
60166
+ result: null;
60167
+ error: null;
60168
+ action_type: 'SET_HEAT_COOL';
60169
+ } | {
60170
+ /** The ID of the action attempt. */
60171
+ action_attempt_id: string;
60172
+ status: 'success';
60173
+ error: null;
60174
+ action_type: 'SET_HEAT_COOL';
60175
+ result: {};
60176
+ } | {
60177
+ /** The ID of the action attempt. */
60178
+ action_attempt_id: string;
60179
+ status: 'error';
60180
+ result: null;
60181
+ action_type: 'SET_HEAT_COOL';
60182
+ error: {
60183
+ type: string;
60184
+ message: string;
60185
+ };
60186
+ } | {
60187
+ /** The ID of the action attempt. */
60188
+ action_attempt_id: string;
60189
+ status: 'pending';
60190
+ result: null;
60191
+ error: null;
60192
+ action_type: 'SET_FAN_MODE';
60193
+ } | {
60194
+ /** The ID of the action attempt. */
60195
+ action_attempt_id: string;
60196
+ status: 'success';
60197
+ error: null;
60198
+ action_type: 'SET_FAN_MODE';
60199
+ result: {};
60200
+ } | {
60201
+ /** The ID of the action attempt. */
60202
+ action_attempt_id: string;
60203
+ status: 'error';
60204
+ result: null;
60205
+ action_type: 'SET_FAN_MODE';
60206
+ error: {
60207
+ type: string;
60208
+ message: string;
60209
+ };
60210
+ } | {
60211
+ /** The ID of the action attempt. */
60212
+ action_attempt_id: string;
60213
+ status: 'pending';
60214
+ result: null;
60215
+ error: null;
60216
+ action_type: 'SET_THERMOSTAT_OFF';
60217
+ } | {
60218
+ /** The ID of the action attempt. */
60219
+ action_attempt_id: string;
60220
+ status: 'success';
60221
+ error: null;
60222
+ action_type: 'SET_THERMOSTAT_OFF';
60223
+ result: {};
60224
+ } | {
60225
+ /** The ID of the action attempt. */
60226
+ action_attempt_id: string;
60227
+ status: 'error';
60228
+ result: null;
60229
+ action_type: 'SET_THERMOSTAT_OFF';
60230
+ error: {
60231
+ type: string;
60232
+ message: string;
60233
+ };
60234
+ } | {
60235
+ /** The ID of the action attempt. */
60236
+ action_attempt_id: string;
60237
+ status: 'pending';
60238
+ result: null;
60239
+ error: null;
60240
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
60241
+ } | {
60242
+ /** The ID of the action attempt. */
60243
+ action_attempt_id: string;
60244
+ status: 'success';
60245
+ error: null;
60246
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
60247
+ result: {};
60248
+ } | {
60249
+ /** The ID of the action attempt. */
60250
+ action_attempt_id: string;
60251
+ status: 'error';
60252
+ result: null;
60253
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
60254
+ error: {
60255
+ type: string;
60256
+ message: string;
60257
+ };
60258
+ } | {
60259
+ /** The ID of the action attempt. */
60260
+ action_attempt_id: string;
60261
+ status: 'pending';
60262
+ result: null;
60263
+ error: null;
60264
+ action_type: 'SYNC_ACCESS_CODES';
60265
+ } | {
60266
+ /** The ID of the action attempt. */
60267
+ action_attempt_id: string;
60268
+ status: 'success';
60269
+ error: null;
60270
+ action_type: 'SYNC_ACCESS_CODES';
60271
+ result: {};
60272
+ } | {
60273
+ /** The ID of the action attempt. */
60274
+ action_attempt_id: string;
60275
+ status: 'error';
60276
+ result: null;
60277
+ action_type: 'SYNC_ACCESS_CODES';
60278
+ error: {
60279
+ type: string;
60280
+ message: string;
60281
+ };
60282
+ } | {
60283
+ /** The ID of the action attempt. */
60284
+ action_attempt_id: string;
60285
+ status: 'pending';
60286
+ result: null;
60287
+ error: null;
60288
+ action_type: 'CREATE_ACCESS_CODE';
60289
+ } | {
60290
+ /** The ID of the action attempt. */
60291
+ action_attempt_id: string;
60292
+ status: 'success';
60293
+ error: null;
60294
+ action_type: 'CREATE_ACCESS_CODE';
60295
+ result: {
60296
+ access_code?: any;
60297
+ };
60298
+ } | {
60299
+ /** The ID of the action attempt. */
60300
+ action_attempt_id: string;
60301
+ status: 'error';
60302
+ result: null;
60303
+ action_type: 'CREATE_ACCESS_CODE';
60304
+ error: {
60305
+ type: string;
60306
+ message: string;
60307
+ };
60308
+ } | {
60309
+ /** The ID of the action attempt. */
60310
+ action_attempt_id: string;
60311
+ status: 'pending';
60312
+ result: null;
60313
+ error: null;
60314
+ action_type: 'DELETE_ACCESS_CODE';
60315
+ } | {
60316
+ /** The ID of the action attempt. */
60317
+ action_attempt_id: string;
60318
+ status: 'success';
60319
+ error: null;
60320
+ action_type: 'DELETE_ACCESS_CODE';
60321
+ result: {};
60322
+ } | {
60323
+ /** The ID of the action attempt. */
60324
+ action_attempt_id: string;
60325
+ status: 'error';
60326
+ result: null;
60327
+ action_type: 'DELETE_ACCESS_CODE';
60328
+ error: {
60329
+ type: string;
60330
+ message: string;
60331
+ };
60332
+ } | {
60333
+ /** The ID of the action attempt. */
60334
+ action_attempt_id: string;
60335
+ status: 'pending';
60336
+ result: null;
60337
+ error: null;
60338
+ action_type: 'UPDATE_ACCESS_CODE';
60339
+ } | {
60340
+ /** The ID of the action attempt. */
60341
+ action_attempt_id: string;
60342
+ status: 'success';
60343
+ error: null;
60344
+ action_type: 'UPDATE_ACCESS_CODE';
60345
+ result: {
60346
+ access_code?: any;
60347
+ };
60348
+ } | {
60349
+ /** The ID of the action attempt. */
60350
+ action_attempt_id: string;
60351
+ status: 'error';
60352
+ result: null;
60353
+ action_type: 'UPDATE_ACCESS_CODE';
60354
+ error: {
60355
+ type: string;
60356
+ message: string;
60357
+ };
60358
+ } | {
60359
+ /** The ID of the action attempt. */
60360
+ action_attempt_id: string;
60361
+ status: 'pending';
60362
+ result: null;
60363
+ error: null;
60364
+ action_type: 'CREATE_NOISE_THRESHOLD';
60365
+ } | {
60366
+ /** The ID of the action attempt. */
60367
+ action_attempt_id: string;
60368
+ status: 'success';
60369
+ error: null;
60370
+ action_type: 'CREATE_NOISE_THRESHOLD';
60371
+ result: {
60372
+ noise_threshold?: any;
60373
+ };
60374
+ } | {
60375
+ /** The ID of the action attempt. */
60376
+ action_attempt_id: string;
60377
+ status: 'error';
60378
+ result: null;
60379
+ action_type: 'CREATE_NOISE_THRESHOLD';
60380
+ error: {
60381
+ type: string;
60382
+ message: string;
60383
+ };
60384
+ } | {
60385
+ /** The ID of the action attempt. */
60386
+ action_attempt_id: string;
60387
+ status: 'pending';
60388
+ result: null;
60389
+ error: null;
60390
+ action_type: 'DELETE_NOISE_THRESHOLD';
60391
+ } | {
60392
+ /** The ID of the action attempt. */
60393
+ action_attempt_id: string;
60394
+ status: 'success';
60395
+ error: null;
60396
+ action_type: 'DELETE_NOISE_THRESHOLD';
60397
+ result: {};
60398
+ } | {
60399
+ /** The ID of the action attempt. */
60400
+ action_attempt_id: string;
60401
+ status: 'error';
60402
+ result: null;
60403
+ action_type: 'DELETE_NOISE_THRESHOLD';
60404
+ error: {
60405
+ type: string;
60406
+ message: string;
60407
+ };
60408
+ } | {
60409
+ /** The ID of the action attempt. */
60410
+ action_attempt_id: string;
60411
+ status: 'pending';
60412
+ result: null;
60413
+ error: null;
60414
+ action_type: 'UPDATE_NOISE_THRESHOLD';
60415
+ } | {
60416
+ /** The ID of the action attempt. */
60417
+ action_attempt_id: string;
60418
+ status: 'success';
60419
+ error: null;
60420
+ action_type: 'UPDATE_NOISE_THRESHOLD';
60421
+ result: {
60422
+ noise_threshold?: any;
60423
+ };
60424
+ } | {
60425
+ /** The ID of the action attempt. */
60426
+ action_attempt_id: string;
60427
+ status: 'error';
60428
+ result: null;
60429
+ action_type: 'UPDATE_NOISE_THRESHOLD';
60430
+ error: {
60431
+ type: string;
60432
+ message: string;
60433
+ };
60434
+ };
60435
+ };
60436
+ };
59387
60437
  '/thermostats/set_temperature_threshold': {
59388
60438
  route: '/thermostats/set_temperature_threshold';
59389
60439
  method: 'POST' | 'PATCH';
@@ -60854,7 +61904,7 @@ interface Routes {
60854
61904
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
60855
61905
  starts_at: string;
60856
61906
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
60857
- ends_at: string;
61907
+ ends_at: string | null;
60858
61908
  } | undefined;
60859
61909
  /** ID of the user identity associated with the `acs_user`. */
60860
61910
  user_identity_id?: string | undefined;