@seamapi/types 1.297.1 → 1.299.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.
@@ -1181,6 +1181,19 @@ declare const acs_system: z.ZodObject<z.objectUtil.extendShape<{
1181
1181
  message: string;
1182
1182
  error_code: "account_disconnected";
1183
1183
  created_at: string;
1184
+ }>, z.ZodObject<z.objectUtil.extendShape<{
1185
+ created_at: z.ZodString;
1186
+ message: z.ZodString;
1187
+ }, {
1188
+ error_code: z.ZodLiteral<"salto_ks_certification_expired">;
1189
+ }>, "strip", z.ZodTypeAny, {
1190
+ message: string;
1191
+ error_code: "salto_ks_certification_expired";
1192
+ created_at: string;
1193
+ }, {
1194
+ message: string;
1195
+ error_code: "salto_ks_certification_expired";
1196
+ created_at: string;
1184
1197
  }>]>, "many">;
1185
1198
  warnings: z.ZodArray<z.ZodObject<z.objectUtil.extendShape<{
1186
1199
  created_at: z.ZodString;
@@ -1223,6 +1236,10 @@ declare const acs_system: z.ZodObject<z.objectUtil.extendShape<{
1223
1236
  message: string;
1224
1237
  error_code: "account_disconnected";
1225
1238
  created_at: string;
1239
+ } | {
1240
+ message: string;
1241
+ error_code: "salto_ks_certification_expired";
1242
+ created_at: string;
1226
1243
  })[];
1227
1244
  warnings: {
1228
1245
  message: string;
@@ -1275,6 +1292,10 @@ declare const acs_system: z.ZodObject<z.objectUtil.extendShape<{
1275
1292
  message: string;
1276
1293
  error_code: "account_disconnected";
1277
1294
  created_at: string;
1295
+ } | {
1296
+ message: string;
1297
+ error_code: "salto_ks_certification_expired";
1298
+ created_at: string;
1278
1299
  })[];
1279
1300
  warnings: {
1280
1301
  message: string;
@@ -13112,7 +13133,7 @@ declare const _default: {
13112
13133
  description: string;
13113
13134
  items: {
13114
13135
  description: string;
13115
- oneOf: {
13136
+ oneOf: ({
13116
13137
  description: string;
13117
13138
  properties: {
13118
13139
  created_at: {
@@ -13132,7 +13153,27 @@ declare const _default: {
13132
13153
  };
13133
13154
  required: string[];
13134
13155
  type: string;
13135
- }[];
13156
+ } | {
13157
+ properties: {
13158
+ created_at: {
13159
+ description: string;
13160
+ format: string;
13161
+ type: string;
13162
+ };
13163
+ error_code: {
13164
+ description: string;
13165
+ enum: string[];
13166
+ type: string;
13167
+ };
13168
+ message: {
13169
+ description: string;
13170
+ type: string;
13171
+ };
13172
+ };
13173
+ required: string[];
13174
+ type: string;
13175
+ description?: never;
13176
+ })[];
13136
13177
  };
13137
13178
  type: string;
13138
13179
  };
@@ -30128,6 +30169,183 @@ declare const _default: {
30128
30169
  'x-title': string;
30129
30170
  };
30130
30171
  };
30172
+ '/thermostats/set_hvac_mode': {
30173
+ post: {
30174
+ description: string;
30175
+ operationId: string;
30176
+ requestBody: {
30177
+ content: {
30178
+ 'application/json': {
30179
+ schema: {
30180
+ discriminator: {
30181
+ propertyName: string;
30182
+ };
30183
+ oneOf: ({
30184
+ properties: {
30185
+ device_id: {
30186
+ description: string;
30187
+ format: string;
30188
+ type: string;
30189
+ };
30190
+ hvac_mode_setting: {
30191
+ enum: string[];
30192
+ type: string;
30193
+ };
30194
+ cooling_set_point_celsius?: never;
30195
+ cooling_set_point_fahrenheit?: never;
30196
+ heating_set_point_celsius?: never;
30197
+ heating_set_point_fahrenheit?: never;
30198
+ };
30199
+ required: string[];
30200
+ type: string;
30201
+ } | {
30202
+ properties: {
30203
+ cooling_set_point_celsius: {
30204
+ description: string;
30205
+ format: string;
30206
+ type: string;
30207
+ };
30208
+ cooling_set_point_fahrenheit: {
30209
+ description: string;
30210
+ format: string;
30211
+ type: string;
30212
+ };
30213
+ device_id: {
30214
+ description: string;
30215
+ format: string;
30216
+ type: string;
30217
+ };
30218
+ hvac_mode_setting: {
30219
+ enum: string[];
30220
+ type: string;
30221
+ };
30222
+ heating_set_point_celsius?: never;
30223
+ heating_set_point_fahrenheit?: never;
30224
+ };
30225
+ required: string[];
30226
+ type: string;
30227
+ } | {
30228
+ properties: {
30229
+ device_id: {
30230
+ description: string;
30231
+ format: string;
30232
+ type: string;
30233
+ };
30234
+ heating_set_point_celsius: {
30235
+ description: string;
30236
+ format: string;
30237
+ type: string;
30238
+ };
30239
+ heating_set_point_fahrenheit: {
30240
+ description: string;
30241
+ format: string;
30242
+ type: string;
30243
+ };
30244
+ hvac_mode_setting: {
30245
+ enum: string[];
30246
+ type: string;
30247
+ };
30248
+ cooling_set_point_celsius?: never;
30249
+ cooling_set_point_fahrenheit?: never;
30250
+ };
30251
+ required: string[];
30252
+ type: string;
30253
+ } | {
30254
+ properties: {
30255
+ cooling_set_point_celsius: {
30256
+ description: string;
30257
+ format: string;
30258
+ type: string;
30259
+ };
30260
+ cooling_set_point_fahrenheit: {
30261
+ description: string;
30262
+ format: string;
30263
+ type: string;
30264
+ };
30265
+ device_id: {
30266
+ description: string;
30267
+ format: string;
30268
+ type: string;
30269
+ };
30270
+ heating_set_point_celsius: {
30271
+ description: string;
30272
+ format: string;
30273
+ type: string;
30274
+ };
30275
+ heating_set_point_fahrenheit: {
30276
+ description: string;
30277
+ format: string;
30278
+ type: string;
30279
+ };
30280
+ hvac_mode_setting: {
30281
+ enum: string[];
30282
+ type: string;
30283
+ };
30284
+ };
30285
+ required: string[];
30286
+ type: string;
30287
+ })[];
30288
+ };
30289
+ };
30290
+ };
30291
+ };
30292
+ responses: {
30293
+ 200: {
30294
+ content: {
30295
+ 'application/json': {
30296
+ schema: {
30297
+ properties: {
30298
+ action_attempt: {
30299
+ $ref: string;
30300
+ };
30301
+ ok: {
30302
+ type: string;
30303
+ };
30304
+ };
30305
+ required: string[];
30306
+ type: string;
30307
+ };
30308
+ };
30309
+ };
30310
+ description: string;
30311
+ };
30312
+ 400: {
30313
+ description: string;
30314
+ };
30315
+ 401: {
30316
+ description: string;
30317
+ };
30318
+ };
30319
+ security: ({
30320
+ client_session: never[];
30321
+ pat_with_workspace?: never;
30322
+ console_session?: never;
30323
+ api_key?: never;
30324
+ } | {
30325
+ pat_with_workspace: never[];
30326
+ client_session?: never;
30327
+ console_session?: never;
30328
+ api_key?: never;
30329
+ } | {
30330
+ console_session: never[];
30331
+ client_session?: never;
30332
+ pat_with_workspace?: never;
30333
+ api_key?: never;
30334
+ } | {
30335
+ api_key: never[];
30336
+ client_session?: never;
30337
+ pat_with_workspace?: never;
30338
+ console_session?: never;
30339
+ })[];
30340
+ summary: string;
30341
+ tags: string[];
30342
+ 'x-fern-sdk-group-name': string[];
30343
+ 'x-fern-sdk-method-name': string;
30344
+ 'x-fern-sdk-return-value': string;
30345
+ 'x-response-key': string;
30346
+ 'x-title': string;
30347
+ };
30348
+ };
30131
30349
  '/thermostats/set_temperature_threshold': {
30132
30350
  patch: {
30133
30351
  description: string;
@@ -40237,6 +40455,13 @@ interface Routes {
40237
40455
  message: string;
40238
40456
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40239
40457
  error_code: 'account_disconnected';
40458
+ } | {
40459
+ /** Date and time at which Seam created the error. */
40460
+ created_at: string;
40461
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40462
+ message: string;
40463
+ /** Indicates that the access system has lost its Salto KS certification. Please contact support to regain access. */
40464
+ error_code: 'salto_ks_certification_expired';
40240
40465
  }>;
40241
40466
  /** Warnings associated with the `acs_system`. */
40242
40467
  warnings: Array<{
@@ -40346,115 +40571,129 @@ interface Routes {
40346
40571
  message: string;
40347
40572
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40348
40573
  error_code: 'account_disconnected';
40349
- }>;
40350
- /** Warnings associated with the `acs_system`. */
40351
- warnings: Array<{
40352
- /** Date and time at which Seam created the warning. */
40353
- created_at: string;
40354
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
40355
- message: string;
40356
- /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
40357
- warning_code: 'salto_ks_subscription_limit_almost_reached';
40358
- }>;
40359
- /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
40360
- can_automate_enrollment?: boolean | undefined;
40361
- /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
40362
- can_create_acs_access_groups?: boolean | undefined;
40363
- /** Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
40364
- can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
40365
- /** Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
40366
- can_add_acs_users_to_acs_access_groups?: boolean | undefined;
40367
- }>;
40368
- };
40369
- };
40370
- '/acs/systems/list_compatible_credential_manager_acs_systems': {
40371
- route: '/acs/systems/list_compatible_credential_manager_acs_systems';
40372
- method: 'GET' | 'POST';
40373
- queryParams: {};
40374
- jsonBody: {};
40375
- commonParams: {
40376
- /** ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. */
40377
- acs_system_id: string;
40378
- };
40379
- formData: {};
40380
- jsonResponse: {
40381
- acs_systems: Array<{
40382
- /** ID of the default credential manager acs_system for this access control system. */
40383
- default_credential_manager_acs_system_id?: (string | null) | undefined;
40384
- /** ID of the `acs_system`. */
40385
- acs_system_id: string;
40386
- /** Brand-specific terminology for the `acs_system` type. */
40387
- external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
40388
- /** Display name that corresponds to the brand-specific terminology for the `acs_system` type. */
40389
- external_type_display_name?: string | undefined;
40390
- /** Indicates if the `acs_system` is a credential manager. */
40391
- is_credential_manager: boolean;
40392
- visionline_metadata?: {
40393
- /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
40394
- mobile_access_uuid: string;
40395
- /** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
40396
- system_id: string;
40397
- /** IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network. */
40398
- lan_address: string;
40399
- } | undefined;
40400
- /**
40401
- * @deprecated Use `external_type`. */
40402
- system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
40403
- /**
40404
- * @deprecated Use `external_type_display_name`. */
40405
- system_type_display_name?: string | undefined;
40406
- location: {
40407
- /** Time zone in which the `acs_system` is located. */
40408
- time_zone: string | null;
40409
- };
40410
- /** Name of the `acs_system`. */
40411
- name: string;
40412
- /** Date and time at which the `acs_system` was created. */
40413
- created_at: string;
40414
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
40415
- workspace_id: string;
40416
- /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`. */
40417
- connected_account_ids: string[];
40418
- /** URL for the image that represents the `acs_system`. */
40419
- image_url: string;
40420
- /** Alternative text for the `acs_system` image. */
40421
- image_alt_text: string;
40422
- /** Errors associated with the `acs_system`. */
40423
- errors: Array<{
40424
- /** Date and time at which Seam created the error. */
40425
- created_at: string;
40426
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40427
- message: string;
40428
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40429
- error_code: 'seam_bridge_disconnected';
40430
40574
  } | {
40431
40575
  /** Date and time at which Seam created the error. */
40432
40576
  created_at: string;
40433
40577
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40434
40578
  message: string;
40435
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40436
- error_code: 'visionline_instance_unreachable';
40437
- } | {
40438
- /** Date and time at which Seam created the error. */
40439
- created_at: string;
40440
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40441
- message: string;
40442
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40443
- error_code: 'salto_ks_subscription_limit_exceeded';
40444
- } | {
40445
- /** Date and time at which Seam created the error. */
40446
- created_at: string;
40447
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40448
- message: string;
40449
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40450
- error_code: 'acs_system_disconnected';
40451
- } | {
40452
- /** Date and time at which Seam created the error. */
40453
- created_at: string;
40454
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40455
- message: string;
40456
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40457
- error_code: 'account_disconnected';
40579
+ /** Indicates that the access system has lost its Salto KS certification. Please contact support to regain access. */
40580
+ error_code: 'salto_ks_certification_expired';
40581
+ }>;
40582
+ /** Warnings associated with the `acs_system`. */
40583
+ warnings: Array<{
40584
+ /** Date and time at which Seam created the warning. */
40585
+ created_at: string;
40586
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
40587
+ message: string;
40588
+ /** Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Please increase your subscription limit, or delete some users from your site to rectify this. */
40589
+ warning_code: 'salto_ks_subscription_limit_almost_reached';
40590
+ }>;
40591
+ /** Indicates whether it is possible to [launch enrollment automations](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) for the `acs_system`. */
40592
+ can_automate_enrollment?: boolean | undefined;
40593
+ /** Indicates whether the `acs_system` supports creating [access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
40594
+ can_create_acs_access_groups?: boolean | undefined;
40595
+ /** Indicates whether the `acs_system` supports [removing users from access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#remove-an-acs-user-from-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
40596
+ can_remove_acs_users_from_acs_access_groups?: boolean | undefined;
40597
+ /** Indicates whether the `acs_system` supports [adding users to access groups](https://docs.seam.co/latest/capability-guides/access-systems/assigning-users-to-access-groups#add-an-acs-user-to-an-access-group). See also [Access Group-based Access Control Systems](https://docs.seam.co/latest/capability-guides/access-systems/understanding-access-control-system-differences#access-group-based-access-control-systems). */
40598
+ can_add_acs_users_to_acs_access_groups?: boolean | undefined;
40599
+ }>;
40600
+ };
40601
+ };
40602
+ '/acs/systems/list_compatible_credential_manager_acs_systems': {
40603
+ route: '/acs/systems/list_compatible_credential_manager_acs_systems';
40604
+ method: 'GET' | 'POST';
40605
+ queryParams: {};
40606
+ jsonBody: {};
40607
+ commonParams: {
40608
+ /** ID of the ACS system for which you want to retrieve all compatible credential manager ACS systems. */
40609
+ acs_system_id: string;
40610
+ };
40611
+ formData: {};
40612
+ jsonResponse: {
40613
+ acs_systems: Array<{
40614
+ /** ID of the default credential manager acs_system for this access control system. */
40615
+ default_credential_manager_acs_system_id?: (string | null) | undefined;
40616
+ /** ID of the `acs_system`. */
40617
+ acs_system_id: string;
40618
+ /** Brand-specific terminology for the `acs_system` type. */
40619
+ external_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
40620
+ /** Display name that corresponds to the brand-specific terminology for the `acs_system` type. */
40621
+ external_type_display_name?: string | undefined;
40622
+ /** Indicates if the `acs_system` is a credential manager. */
40623
+ is_credential_manager: boolean;
40624
+ visionline_metadata?: {
40625
+ /** Keyset loaded into a reader. Mobile keys and reader administration tools securely authenticate only with readers programmed with a matching keyset. */
40626
+ mobile_access_uuid: string;
40627
+ /** Unique ID assigned by the ASSA ABLOY licensing team that identifies each hotel in your credential manager. */
40628
+ system_id: string;
40629
+ /** IP address or hostname of the main Visionline server relative to the Seam Bridge on the local network. */
40630
+ lan_address: string;
40631
+ } | undefined;
40632
+ /**
40633
+ * @deprecated Use `external_type`. */
40634
+ system_type?: ('pti_site' | 'alta_org' | 'salto_ks_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service' | 'latch_building' | 'dormakaba_community' | 'legic_connect' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service') | undefined;
40635
+ /**
40636
+ * @deprecated Use `external_type_display_name`. */
40637
+ system_type_display_name?: string | undefined;
40638
+ location: {
40639
+ /** Time zone in which the `acs_system` is located. */
40640
+ time_zone: string | null;
40641
+ };
40642
+ /** Name of the `acs_system`. */
40643
+ name: string;
40644
+ /** Date and time at which the `acs_system` was created. */
40645
+ created_at: string;
40646
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
40647
+ workspace_id: string;
40648
+ /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the `acs_system`. */
40649
+ connected_account_ids: string[];
40650
+ /** URL for the image that represents the `acs_system`. */
40651
+ image_url: string;
40652
+ /** Alternative text for the `acs_system` image. */
40653
+ image_alt_text: string;
40654
+ /** Errors associated with the `acs_system`. */
40655
+ errors: Array<{
40656
+ /** Date and time at which Seam created the error. */
40657
+ created_at: string;
40658
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40659
+ message: string;
40660
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40661
+ error_code: 'seam_bridge_disconnected';
40662
+ } | {
40663
+ /** Date and time at which Seam created the error. */
40664
+ created_at: string;
40665
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40666
+ message: string;
40667
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40668
+ error_code: 'visionline_instance_unreachable';
40669
+ } | {
40670
+ /** Date and time at which Seam created the error. */
40671
+ created_at: string;
40672
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40673
+ message: string;
40674
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40675
+ error_code: 'salto_ks_subscription_limit_exceeded';
40676
+ } | {
40677
+ /** Date and time at which Seam created the error. */
40678
+ created_at: string;
40679
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40680
+ message: string;
40681
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40682
+ error_code: 'acs_system_disconnected';
40683
+ } | {
40684
+ /** Date and time at which Seam created the error. */
40685
+ created_at: string;
40686
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40687
+ message: string;
40688
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
40689
+ error_code: 'account_disconnected';
40690
+ } | {
40691
+ /** Date and time at which Seam created the error. */
40692
+ created_at: string;
40693
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40694
+ message: string;
40695
+ /** Indicates that the access system has lost its Salto KS certification. Please contact support to regain access. */
40696
+ error_code: 'salto_ks_certification_expired';
40458
40697
  }>;
40459
40698
  /** Warnings associated with the `acs_system`. */
40460
40699
  warnings: Array<{
@@ -59322,6 +59561,876 @@ interface Routes {
59322
59561
  };
59323
59562
  };
59324
59563
  };
59564
+ '/thermostats/set_hvac_mode': {
59565
+ route: '/thermostats/set_hvac_mode';
59566
+ method: 'POST';
59567
+ queryParams: {};
59568
+ jsonBody: {
59569
+ hvac_mode_setting: 'off';
59570
+ /** ID of the desired thermostat device. */
59571
+ device_id: string;
59572
+ } | {
59573
+ hvac_mode_setting: 'cool';
59574
+ /** ID of the desired thermostat device. */
59575
+ device_id: string;
59576
+ /** 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. */
59577
+ cooling_set_point_celsius?: number | undefined;
59578
+ /** 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. */
59579
+ cooling_set_point_fahrenheit?: number | undefined;
59580
+ } | {
59581
+ hvac_mode_setting: 'heat';
59582
+ /** ID of the desired thermostat device. */
59583
+ device_id: string;
59584
+ /** 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. */
59585
+ heating_set_point_celsius?: number | undefined;
59586
+ /** 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. */
59587
+ heating_set_point_fahrenheit?: number | undefined;
59588
+ } | {
59589
+ hvac_mode_setting: 'heat_cool';
59590
+ /** ID of the desired thermostat device. */
59591
+ device_id: string;
59592
+ /** 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. */
59593
+ cooling_set_point_celsius?: number | undefined;
59594
+ /** 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. */
59595
+ cooling_set_point_fahrenheit?: number | undefined;
59596
+ /** 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. */
59597
+ heating_set_point_celsius?: number | undefined;
59598
+ /** 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. */
59599
+ heating_set_point_fahrenheit?: number | undefined;
59600
+ };
59601
+ commonParams: {};
59602
+ formData: {};
59603
+ jsonResponse: {
59604
+ action_attempt: {
59605
+ /** The ID of the action attempt. */
59606
+ action_attempt_id: string;
59607
+ status: 'pending';
59608
+ result: null;
59609
+ error: null;
59610
+ action_type: 'LOCK_DOOR';
59611
+ } | {
59612
+ /** The ID of the action attempt. */
59613
+ action_attempt_id: string;
59614
+ status: 'success';
59615
+ error: null;
59616
+ action_type: 'LOCK_DOOR';
59617
+ result: {};
59618
+ } | {
59619
+ /** The ID of the action attempt. */
59620
+ action_attempt_id: string;
59621
+ status: 'error';
59622
+ result: null;
59623
+ action_type: 'LOCK_DOOR';
59624
+ error: {
59625
+ type: string;
59626
+ message: string;
59627
+ };
59628
+ } | {
59629
+ /** The ID of the action attempt. */
59630
+ action_attempt_id: string;
59631
+ status: 'pending';
59632
+ result: null;
59633
+ error: null;
59634
+ action_type: 'UNLOCK_DOOR';
59635
+ } | {
59636
+ /** The ID of the action attempt. */
59637
+ action_attempt_id: string;
59638
+ status: 'success';
59639
+ error: null;
59640
+ action_type: 'UNLOCK_DOOR';
59641
+ result: {};
59642
+ } | {
59643
+ /** The ID of the action attempt. */
59644
+ action_attempt_id: string;
59645
+ status: 'error';
59646
+ result: null;
59647
+ action_type: 'UNLOCK_DOOR';
59648
+ error: {
59649
+ type: string;
59650
+ message: string;
59651
+ };
59652
+ } | {
59653
+ /** The ID of the action attempt. */
59654
+ action_attempt_id: string;
59655
+ status: 'pending';
59656
+ result: null;
59657
+ error: null;
59658
+ action_type: 'SCAN_CREDENTIAL';
59659
+ } | {
59660
+ /** The ID of the action attempt. */
59661
+ action_attempt_id: string;
59662
+ status: 'success';
59663
+ error: null;
59664
+ action_type: 'SCAN_CREDENTIAL';
59665
+ result: {
59666
+ /** Snapshot of credential data read from physical encoder. */
59667
+ acs_credential_on_encoder: {
59668
+ /** Date and time the credential was created. */
59669
+ created_at: string | null;
59670
+ is_issued: boolean | null;
59671
+ /** Date and time the credential will become useable. */
59672
+ starts_at: string | null;
59673
+ /** Date and time the credential will stop being useable. */
59674
+ ends_at: string | null;
59675
+ /** A number or string that physically identifies this card. */
59676
+ card_number: string | null;
59677
+ /** Visionline-specific metadata for the credential. */
59678
+ visionline_metadata?: {
59679
+ card_id: string;
59680
+ cancelled: boolean;
59681
+ discarded: boolean;
59682
+ expired: boolean;
59683
+ overwritten: boolean;
59684
+ overridden?: boolean | undefined;
59685
+ pending_auto_update: boolean;
59686
+ card_format: 'TLCode' | 'rfid48';
59687
+ card_holder?: string | undefined;
59688
+ number_of_issued_cards: number;
59689
+ guest_acs_entrance_ids?: string[] | undefined;
59690
+ common_acs_entrance_ids?: string[] | undefined;
59691
+ } | undefined;
59692
+ };
59693
+ /** Matching acs_credential currently encoded on this card. */
59694
+ acs_credential_on_seam: ({
59695
+ /** ID of the credential. */
59696
+ acs_credential_id: string;
59697
+ /** ID of the ACS user to whom the credential belongs. */
59698
+ acs_user_id?: string | undefined;
59699
+ acs_credential_pool_id?: string | undefined;
59700
+ /** ID of the access control system that contains the credential. */
59701
+ acs_system_id: string;
59702
+ /** ID of the parent credential. */
59703
+ parent_acs_credential_id?: string | undefined;
59704
+ /** Display name that corresponds to the credential type. */
59705
+ display_name: string;
59706
+ /** Access (PIN) code for the credential. */
59707
+ code?: (string | undefined) | null;
59708
+ card_number?: (string | undefined) | null;
59709
+ is_issued?: boolean | undefined;
59710
+ issued_at?: (string | undefined) | null;
59711
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
59712
+ access_method: 'code' | 'card' | 'mobile_key';
59713
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
59714
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
59715
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
59716
+ external_type_display_name?: string | undefined;
59717
+ /** Date and time at which the credential was created. */
59718
+ created_at: string;
59719
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
59720
+ workspace_id: string;
59721
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
59722
+ starts_at?: string | undefined;
59723
+ /** 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`. */
59724
+ ends_at?: string | undefined;
59725
+ /** Errors associated with the `acs_credential`. */
59726
+ errors: Array<{
59727
+ error_code: string;
59728
+ message: string;
59729
+ }>;
59730
+ /** Warnings associated with the `acs_credential`. */
59731
+ warnings: Array<{
59732
+ /** Date and time at which Seam created the warning. */
59733
+ created_at: string;
59734
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59735
+ message: string;
59736
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59737
+ warning_code: 'waiting_to_be_issued';
59738
+ } | {
59739
+ /** Date and time at which Seam created the warning. */
59740
+ created_at: string;
59741
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59742
+ message: string;
59743
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59744
+ warning_code: 'schedule_externally_modified';
59745
+ } | {
59746
+ /** Date and time at which Seam created the warning. */
59747
+ created_at: string;
59748
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59749
+ message: string;
59750
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59751
+ warning_code: 'schedule_modified';
59752
+ } | {
59753
+ /** Date and time at which Seam created the warning. */
59754
+ created_at: string;
59755
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59756
+ message: string;
59757
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59758
+ warning_code: 'being_deleted';
59759
+ }>;
59760
+ /** 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). */
59761
+ is_multi_phone_sync_credential?: boolean | undefined;
59762
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
59763
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
59764
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
59765
+ latest_desired_state_synced_with_provider_at?: string | undefined;
59766
+ /** Visionline-specific metadata for the credential. */
59767
+ visionline_metadata?: {
59768
+ card_function_type: 'guest' | 'staff';
59769
+ joiner_acs_credential_ids?: string[] | undefined;
59770
+ guest_acs_entrance_ids?: string[] | undefined;
59771
+ common_acs_entrance_ids?: string[] | undefined;
59772
+ is_valid?: boolean | undefined;
59773
+ auto_join?: boolean | undefined;
59774
+ card_id?: string | undefined;
59775
+ credential_id?: string | undefined;
59776
+ } | undefined;
59777
+ is_managed: true;
59778
+ } | {
59779
+ /** ID of the credential. */
59780
+ acs_credential_id: string;
59781
+ /** ID of the ACS user to whom the credential belongs. */
59782
+ acs_user_id?: string | undefined;
59783
+ acs_credential_pool_id?: string | undefined;
59784
+ /** ID of the access control system that contains the credential. */
59785
+ acs_system_id: string;
59786
+ /** ID of the parent credential. */
59787
+ parent_acs_credential_id?: string | undefined;
59788
+ /** Display name that corresponds to the credential type. */
59789
+ display_name: string;
59790
+ /** Access (PIN) code for the credential. */
59791
+ code?: (string | undefined) | null;
59792
+ card_number?: (string | undefined) | null;
59793
+ is_issued?: boolean | undefined;
59794
+ issued_at?: (string | undefined) | null;
59795
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
59796
+ access_method: 'code' | 'card' | 'mobile_key';
59797
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
59798
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
59799
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
59800
+ external_type_display_name?: string | undefined;
59801
+ /** Date and time at which the credential was created. */
59802
+ created_at: string;
59803
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
59804
+ workspace_id: string;
59805
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
59806
+ starts_at?: string | undefined;
59807
+ /** 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`. */
59808
+ ends_at?: string | undefined;
59809
+ /** Errors associated with the `acs_credential`. */
59810
+ errors: Array<{
59811
+ error_code: string;
59812
+ message: string;
59813
+ }>;
59814
+ /** Warnings associated with the `acs_credential`. */
59815
+ warnings: Array<{
59816
+ /** Date and time at which Seam created the warning. */
59817
+ created_at: string;
59818
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59819
+ message: string;
59820
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59821
+ warning_code: 'waiting_to_be_issued';
59822
+ } | {
59823
+ /** Date and time at which Seam created the warning. */
59824
+ created_at: string;
59825
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59826
+ message: string;
59827
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59828
+ warning_code: 'schedule_externally_modified';
59829
+ } | {
59830
+ /** Date and time at which Seam created the warning. */
59831
+ created_at: string;
59832
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59833
+ message: string;
59834
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59835
+ warning_code: 'schedule_modified';
59836
+ } | {
59837
+ /** Date and time at which Seam created the warning. */
59838
+ created_at: string;
59839
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59840
+ message: string;
59841
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59842
+ warning_code: 'being_deleted';
59843
+ }>;
59844
+ /** 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). */
59845
+ is_multi_phone_sync_credential?: boolean | undefined;
59846
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
59847
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
59848
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
59849
+ latest_desired_state_synced_with_provider_at?: string | undefined;
59850
+ /** Visionline-specific metadata for the credential. */
59851
+ visionline_metadata?: {
59852
+ card_function_type: 'guest' | 'staff';
59853
+ joiner_acs_credential_ids?: string[] | undefined;
59854
+ guest_acs_entrance_ids?: string[] | undefined;
59855
+ common_acs_entrance_ids?: string[] | undefined;
59856
+ is_valid?: boolean | undefined;
59857
+ auto_join?: boolean | undefined;
59858
+ card_id?: string | undefined;
59859
+ credential_id?: string | undefined;
59860
+ } | undefined;
59861
+ is_managed: false;
59862
+ }) | null;
59863
+ warnings: Array<{
59864
+ warning_code: 'acs_credential_on_encoder_out_of_sync';
59865
+ warning_message: string;
59866
+ }>;
59867
+ };
59868
+ } | {
59869
+ /** The ID of the action attempt. */
59870
+ action_attempt_id: string;
59871
+ status: 'error';
59872
+ result: null;
59873
+ action_type: 'SCAN_CREDENTIAL';
59874
+ error: {
59875
+ type: 'uncategorized_error';
59876
+ message: string;
59877
+ } | {
59878
+ type: 'action_attempt_expired';
59879
+ message: string;
59880
+ } | {
59881
+ type: 'no_card_on_encoder';
59882
+ message: string;
59883
+ };
59884
+ } | {
59885
+ /** The ID of the action attempt. */
59886
+ action_attempt_id: string;
59887
+ status: 'pending';
59888
+ result: null;
59889
+ error: null;
59890
+ action_type: 'ENCODE_CREDENTIAL';
59891
+ } | {
59892
+ /** The ID of the action attempt. */
59893
+ action_attempt_id: string;
59894
+ status: 'success';
59895
+ error: null;
59896
+ action_type: 'ENCODE_CREDENTIAL';
59897
+ /** Means by which a user gains access at an entrance.
59898
+ 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. */
59899
+ result: {
59900
+ /** ID of the credential. */
59901
+ acs_credential_id: string;
59902
+ /** ID of the ACS user to whom the credential belongs. */
59903
+ acs_user_id?: string | undefined;
59904
+ acs_credential_pool_id?: string | undefined;
59905
+ /** ID of the access control system that contains the credential. */
59906
+ acs_system_id: string;
59907
+ /** ID of the parent credential. */
59908
+ parent_acs_credential_id?: string | undefined;
59909
+ /** Display name that corresponds to the credential type. */
59910
+ display_name: string;
59911
+ /** Access (PIN) code for the credential. */
59912
+ code?: (string | undefined) | null;
59913
+ card_number?: (string | undefined) | null;
59914
+ is_issued?: boolean | undefined;
59915
+ issued_at?: (string | undefined) | null;
59916
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
59917
+ access_method: 'code' | 'card' | 'mobile_key';
59918
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
59919
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
59920
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
59921
+ external_type_display_name?: string | undefined;
59922
+ /** Date and time at which the credential was created. */
59923
+ created_at: string;
59924
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
59925
+ workspace_id: string;
59926
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
59927
+ starts_at?: string | undefined;
59928
+ /** 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`. */
59929
+ ends_at?: string | undefined;
59930
+ /** Errors associated with the `acs_credential`. */
59931
+ errors: Array<{
59932
+ error_code: string;
59933
+ message: string;
59934
+ }>;
59935
+ /** Warnings associated with the `acs_credential`. */
59936
+ warnings: Array<{
59937
+ /** Date and time at which Seam created the warning. */
59938
+ created_at: string;
59939
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59940
+ message: string;
59941
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59942
+ warning_code: 'waiting_to_be_issued';
59943
+ } | {
59944
+ /** Date and time at which Seam created the warning. */
59945
+ created_at: string;
59946
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59947
+ message: string;
59948
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59949
+ warning_code: 'schedule_externally_modified';
59950
+ } | {
59951
+ /** Date and time at which Seam created the warning. */
59952
+ created_at: string;
59953
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59954
+ message: string;
59955
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59956
+ warning_code: 'schedule_modified';
59957
+ } | {
59958
+ /** Date and time at which Seam created the warning. */
59959
+ created_at: string;
59960
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
59961
+ message: string;
59962
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
59963
+ warning_code: 'being_deleted';
59964
+ }>;
59965
+ /** 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). */
59966
+ is_multi_phone_sync_credential?: boolean | undefined;
59967
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
59968
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
59969
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
59970
+ latest_desired_state_synced_with_provider_at?: string | undefined;
59971
+ /** Visionline-specific metadata for the credential. */
59972
+ visionline_metadata?: {
59973
+ card_function_type: 'guest' | 'staff';
59974
+ joiner_acs_credential_ids?: string[] | undefined;
59975
+ guest_acs_entrance_ids?: string[] | undefined;
59976
+ common_acs_entrance_ids?: string[] | undefined;
59977
+ is_valid?: boolean | undefined;
59978
+ auto_join?: boolean | undefined;
59979
+ card_id?: string | undefined;
59980
+ credential_id?: string | undefined;
59981
+ } | undefined;
59982
+ is_managed: true;
59983
+ } | {
59984
+ /** ID of the credential. */
59985
+ acs_credential_id: string;
59986
+ /** ID of the ACS user to whom the credential belongs. */
59987
+ acs_user_id?: string | undefined;
59988
+ acs_credential_pool_id?: string | undefined;
59989
+ /** ID of the access control system that contains the credential. */
59990
+ acs_system_id: string;
59991
+ /** ID of the parent credential. */
59992
+ parent_acs_credential_id?: string | undefined;
59993
+ /** Display name that corresponds to the credential type. */
59994
+ display_name: string;
59995
+ /** Access (PIN) code for the credential. */
59996
+ code?: (string | undefined) | null;
59997
+ card_number?: (string | undefined) | null;
59998
+ is_issued?: boolean | undefined;
59999
+ issued_at?: (string | undefined) | null;
60000
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
60001
+ access_method: 'code' | 'card' | 'mobile_key';
60002
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
60003
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
60004
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
60005
+ external_type_display_name?: string | undefined;
60006
+ /** Date and time at which the credential was created. */
60007
+ created_at: string;
60008
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
60009
+ workspace_id: string;
60010
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
60011
+ starts_at?: string | undefined;
60012
+ /** 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`. */
60013
+ ends_at?: string | undefined;
60014
+ /** Errors associated with the `acs_credential`. */
60015
+ errors: Array<{
60016
+ error_code: string;
60017
+ message: string;
60018
+ }>;
60019
+ /** Warnings associated with the `acs_credential`. */
60020
+ warnings: Array<{
60021
+ /** Date and time at which Seam created the warning. */
60022
+ created_at: string;
60023
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
60024
+ message: string;
60025
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
60026
+ warning_code: 'waiting_to_be_issued';
60027
+ } | {
60028
+ /** Date and time at which Seam created the warning. */
60029
+ created_at: string;
60030
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
60031
+ message: string;
60032
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
60033
+ warning_code: 'schedule_externally_modified';
60034
+ } | {
60035
+ /** Date and time at which Seam created the warning. */
60036
+ created_at: string;
60037
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
60038
+ message: string;
60039
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
60040
+ warning_code: 'schedule_modified';
60041
+ } | {
60042
+ /** Date and time at which Seam created the warning. */
60043
+ created_at: string;
60044
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
60045
+ message: string;
60046
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
60047
+ warning_code: 'being_deleted';
60048
+ }>;
60049
+ /** 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). */
60050
+ is_multi_phone_sync_credential?: boolean | undefined;
60051
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
60052
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
60053
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
60054
+ latest_desired_state_synced_with_provider_at?: string | undefined;
60055
+ /** Visionline-specific metadata for the credential. */
60056
+ visionline_metadata?: {
60057
+ card_function_type: 'guest' | 'staff';
60058
+ joiner_acs_credential_ids?: string[] | undefined;
60059
+ guest_acs_entrance_ids?: string[] | undefined;
60060
+ common_acs_entrance_ids?: string[] | undefined;
60061
+ is_valid?: boolean | undefined;
60062
+ auto_join?: boolean | undefined;
60063
+ card_id?: string | undefined;
60064
+ credential_id?: string | undefined;
60065
+ } | undefined;
60066
+ is_managed: false;
60067
+ };
60068
+ } | {
60069
+ /** The ID of the action attempt. */
60070
+ action_attempt_id: string;
60071
+ status: 'error';
60072
+ result: null;
60073
+ action_type: 'ENCODE_CREDENTIAL';
60074
+ error: {
60075
+ type: 'uncategorized_error';
60076
+ message: string;
60077
+ } | {
60078
+ type: 'action_attempt_expired';
60079
+ message: string;
60080
+ } | {
60081
+ type: 'no_card_on_encoder';
60082
+ message: string;
60083
+ } | {
60084
+ type: 'incompatible_card_format';
60085
+ message: string;
60086
+ };
60087
+ } | {
60088
+ /** The ID of the action attempt. */
60089
+ action_attempt_id: string;
60090
+ status: 'pending';
60091
+ result: null;
60092
+ error: null;
60093
+ action_type: 'RESET_SANDBOX_WORKSPACE';
60094
+ } | {
60095
+ /** The ID of the action attempt. */
60096
+ action_attempt_id: string;
60097
+ status: 'success';
60098
+ error: null;
60099
+ action_type: 'RESET_SANDBOX_WORKSPACE';
60100
+ result: {};
60101
+ } | {
60102
+ /** The ID of the action attempt. */
60103
+ action_attempt_id: string;
60104
+ status: 'error';
60105
+ result: null;
60106
+ action_type: 'RESET_SANDBOX_WORKSPACE';
60107
+ error: {
60108
+ type: string;
60109
+ message: string;
60110
+ };
60111
+ } | {
60112
+ /** The ID of the action attempt. */
60113
+ action_attempt_id: string;
60114
+ status: 'pending';
60115
+ result: null;
60116
+ error: null;
60117
+ action_type: 'SET_COOL';
60118
+ } | {
60119
+ /** The ID of the action attempt. */
60120
+ action_attempt_id: string;
60121
+ status: 'success';
60122
+ error: null;
60123
+ action_type: 'SET_COOL';
60124
+ result: {};
60125
+ } | {
60126
+ /** The ID of the action attempt. */
60127
+ action_attempt_id: string;
60128
+ status: 'error';
60129
+ result: null;
60130
+ action_type: 'SET_COOL';
60131
+ error: {
60132
+ type: string;
60133
+ message: string;
60134
+ };
60135
+ } | {
60136
+ /** The ID of the action attempt. */
60137
+ action_attempt_id: string;
60138
+ status: 'pending';
60139
+ result: null;
60140
+ error: null;
60141
+ action_type: 'SET_HEAT';
60142
+ } | {
60143
+ /** The ID of the action attempt. */
60144
+ action_attempt_id: string;
60145
+ status: 'success';
60146
+ error: null;
60147
+ action_type: 'SET_HEAT';
60148
+ result: {};
60149
+ } | {
60150
+ /** The ID of the action attempt. */
60151
+ action_attempt_id: string;
60152
+ status: 'error';
60153
+ result: null;
60154
+ action_type: 'SET_HEAT';
60155
+ error: {
60156
+ type: string;
60157
+ message: string;
60158
+ };
60159
+ } | {
60160
+ /** The ID of the action attempt. */
60161
+ action_attempt_id: string;
60162
+ status: 'pending';
60163
+ result: null;
60164
+ error: null;
60165
+ action_type: 'SET_HEAT_COOL';
60166
+ } | {
60167
+ /** The ID of the action attempt. */
60168
+ action_attempt_id: string;
60169
+ status: 'success';
60170
+ error: null;
60171
+ action_type: 'SET_HEAT_COOL';
60172
+ result: {};
60173
+ } | {
60174
+ /** The ID of the action attempt. */
60175
+ action_attempt_id: string;
60176
+ status: 'error';
60177
+ result: null;
60178
+ action_type: 'SET_HEAT_COOL';
60179
+ error: {
60180
+ type: string;
60181
+ message: string;
60182
+ };
60183
+ } | {
60184
+ /** The ID of the action attempt. */
60185
+ action_attempt_id: string;
60186
+ status: 'pending';
60187
+ result: null;
60188
+ error: null;
60189
+ action_type: 'SET_FAN_MODE';
60190
+ } | {
60191
+ /** The ID of the action attempt. */
60192
+ action_attempt_id: string;
60193
+ status: 'success';
60194
+ error: null;
60195
+ action_type: 'SET_FAN_MODE';
60196
+ result: {};
60197
+ } | {
60198
+ /** The ID of the action attempt. */
60199
+ action_attempt_id: string;
60200
+ status: 'error';
60201
+ result: null;
60202
+ action_type: 'SET_FAN_MODE';
60203
+ error: {
60204
+ type: string;
60205
+ message: string;
60206
+ };
60207
+ } | {
60208
+ /** The ID of the action attempt. */
60209
+ action_attempt_id: string;
60210
+ status: 'pending';
60211
+ result: null;
60212
+ error: null;
60213
+ action_type: 'SET_THERMOSTAT_OFF';
60214
+ } | {
60215
+ /** The ID of the action attempt. */
60216
+ action_attempt_id: string;
60217
+ status: 'success';
60218
+ error: null;
60219
+ action_type: 'SET_THERMOSTAT_OFF';
60220
+ result: {};
60221
+ } | {
60222
+ /** The ID of the action attempt. */
60223
+ action_attempt_id: string;
60224
+ status: 'error';
60225
+ result: null;
60226
+ action_type: 'SET_THERMOSTAT_OFF';
60227
+ error: {
60228
+ type: string;
60229
+ message: string;
60230
+ };
60231
+ } | {
60232
+ /** The ID of the action attempt. */
60233
+ action_attempt_id: string;
60234
+ status: 'pending';
60235
+ result: null;
60236
+ error: null;
60237
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
60238
+ } | {
60239
+ /** The ID of the action attempt. */
60240
+ action_attempt_id: string;
60241
+ status: 'success';
60242
+ error: null;
60243
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
60244
+ result: {};
60245
+ } | {
60246
+ /** The ID of the action attempt. */
60247
+ action_attempt_id: string;
60248
+ status: 'error';
60249
+ result: null;
60250
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
60251
+ error: {
60252
+ type: string;
60253
+ message: string;
60254
+ };
60255
+ } | {
60256
+ /** The ID of the action attempt. */
60257
+ action_attempt_id: string;
60258
+ status: 'pending';
60259
+ result: null;
60260
+ error: null;
60261
+ action_type: 'SYNC_ACCESS_CODES';
60262
+ } | {
60263
+ /** The ID of the action attempt. */
60264
+ action_attempt_id: string;
60265
+ status: 'success';
60266
+ error: null;
60267
+ action_type: 'SYNC_ACCESS_CODES';
60268
+ result: {};
60269
+ } | {
60270
+ /** The ID of the action attempt. */
60271
+ action_attempt_id: string;
60272
+ status: 'error';
60273
+ result: null;
60274
+ action_type: 'SYNC_ACCESS_CODES';
60275
+ error: {
60276
+ type: string;
60277
+ message: string;
60278
+ };
60279
+ } | {
60280
+ /** The ID of the action attempt. */
60281
+ action_attempt_id: string;
60282
+ status: 'pending';
60283
+ result: null;
60284
+ error: null;
60285
+ action_type: 'CREATE_ACCESS_CODE';
60286
+ } | {
60287
+ /** The ID of the action attempt. */
60288
+ action_attempt_id: string;
60289
+ status: 'success';
60290
+ error: null;
60291
+ action_type: 'CREATE_ACCESS_CODE';
60292
+ result: {
60293
+ access_code?: any;
60294
+ };
60295
+ } | {
60296
+ /** The ID of the action attempt. */
60297
+ action_attempt_id: string;
60298
+ status: 'error';
60299
+ result: null;
60300
+ action_type: 'CREATE_ACCESS_CODE';
60301
+ error: {
60302
+ type: string;
60303
+ message: string;
60304
+ };
60305
+ } | {
60306
+ /** The ID of the action attempt. */
60307
+ action_attempt_id: string;
60308
+ status: 'pending';
60309
+ result: null;
60310
+ error: null;
60311
+ action_type: 'DELETE_ACCESS_CODE';
60312
+ } | {
60313
+ /** The ID of the action attempt. */
60314
+ action_attempt_id: string;
60315
+ status: 'success';
60316
+ error: null;
60317
+ action_type: 'DELETE_ACCESS_CODE';
60318
+ result: {};
60319
+ } | {
60320
+ /** The ID of the action attempt. */
60321
+ action_attempt_id: string;
60322
+ status: 'error';
60323
+ result: null;
60324
+ action_type: 'DELETE_ACCESS_CODE';
60325
+ error: {
60326
+ type: string;
60327
+ message: string;
60328
+ };
60329
+ } | {
60330
+ /** The ID of the action attempt. */
60331
+ action_attempt_id: string;
60332
+ status: 'pending';
60333
+ result: null;
60334
+ error: null;
60335
+ action_type: 'UPDATE_ACCESS_CODE';
60336
+ } | {
60337
+ /** The ID of the action attempt. */
60338
+ action_attempt_id: string;
60339
+ status: 'success';
60340
+ error: null;
60341
+ action_type: 'UPDATE_ACCESS_CODE';
60342
+ result: {
60343
+ access_code?: any;
60344
+ };
60345
+ } | {
60346
+ /** The ID of the action attempt. */
60347
+ action_attempt_id: string;
60348
+ status: 'error';
60349
+ result: null;
60350
+ action_type: 'UPDATE_ACCESS_CODE';
60351
+ error: {
60352
+ type: string;
60353
+ message: string;
60354
+ };
60355
+ } | {
60356
+ /** The ID of the action attempt. */
60357
+ action_attempt_id: string;
60358
+ status: 'pending';
60359
+ result: null;
60360
+ error: null;
60361
+ action_type: 'CREATE_NOISE_THRESHOLD';
60362
+ } | {
60363
+ /** The ID of the action attempt. */
60364
+ action_attempt_id: string;
60365
+ status: 'success';
60366
+ error: null;
60367
+ action_type: 'CREATE_NOISE_THRESHOLD';
60368
+ result: {
60369
+ noise_threshold?: any;
60370
+ };
60371
+ } | {
60372
+ /** The ID of the action attempt. */
60373
+ action_attempt_id: string;
60374
+ status: 'error';
60375
+ result: null;
60376
+ action_type: 'CREATE_NOISE_THRESHOLD';
60377
+ error: {
60378
+ type: string;
60379
+ message: string;
60380
+ };
60381
+ } | {
60382
+ /** The ID of the action attempt. */
60383
+ action_attempt_id: string;
60384
+ status: 'pending';
60385
+ result: null;
60386
+ error: null;
60387
+ action_type: 'DELETE_NOISE_THRESHOLD';
60388
+ } | {
60389
+ /** The ID of the action attempt. */
60390
+ action_attempt_id: string;
60391
+ status: 'success';
60392
+ error: null;
60393
+ action_type: 'DELETE_NOISE_THRESHOLD';
60394
+ result: {};
60395
+ } | {
60396
+ /** The ID of the action attempt. */
60397
+ action_attempt_id: string;
60398
+ status: 'error';
60399
+ result: null;
60400
+ action_type: 'DELETE_NOISE_THRESHOLD';
60401
+ error: {
60402
+ type: string;
60403
+ message: string;
60404
+ };
60405
+ } | {
60406
+ /** The ID of the action attempt. */
60407
+ action_attempt_id: string;
60408
+ status: 'pending';
60409
+ result: null;
60410
+ error: null;
60411
+ action_type: 'UPDATE_NOISE_THRESHOLD';
60412
+ } | {
60413
+ /** The ID of the action attempt. */
60414
+ action_attempt_id: string;
60415
+ status: 'success';
60416
+ error: null;
60417
+ action_type: 'UPDATE_NOISE_THRESHOLD';
60418
+ result: {
60419
+ noise_threshold?: any;
60420
+ };
60421
+ } | {
60422
+ /** The ID of the action attempt. */
60423
+ action_attempt_id: string;
60424
+ status: 'error';
60425
+ result: null;
60426
+ action_type: 'UPDATE_NOISE_THRESHOLD';
60427
+ error: {
60428
+ type: string;
60429
+ message: string;
60430
+ };
60431
+ };
60432
+ };
60433
+ };
59325
60434
  '/thermostats/set_temperature_threshold': {
59326
60435
  route: '/thermostats/set_temperature_threshold';
59327
60436
  method: 'POST' | 'PATCH';
@@ -60730,6 +61839,13 @@ interface Routes {
60730
61839
  message: string;
60731
61840
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
60732
61841
  error_code: 'account_disconnected';
61842
+ } | {
61843
+ /** Date and time at which Seam created the error. */
61844
+ created_at: string;
61845
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61846
+ message: string;
61847
+ /** Indicates that the access system has lost its Salto KS certification. Please contact support to regain access. */
61848
+ error_code: 'salto_ks_certification_expired';
60733
61849
  }>;
60734
61850
  /** Warnings associated with the `acs_system`. */
60735
61851
  warnings: Array<{