@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.
@@ -7365,6 +7365,13 @@ export interface Routes {
7365
7365
  message: string;
7366
7366
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7367
7367
  error_code: 'account_disconnected';
7368
+ } | {
7369
+ /** Date and time at which Seam created the error. */
7370
+ created_at: string;
7371
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
7372
+ message: string;
7373
+ /** Indicates that the access system has lost its Salto KS certification. Please contact support to regain access. */
7374
+ error_code: 'salto_ks_certification_expired';
7368
7375
  }>;
7369
7376
  /** Warnings associated with the `acs_system`. */
7370
7377
  warnings: Array<{
@@ -7474,6 +7481,13 @@ export interface Routes {
7474
7481
  message: string;
7475
7482
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7476
7483
  error_code: 'account_disconnected';
7484
+ } | {
7485
+ /** Date and time at which Seam created the error. */
7486
+ created_at: string;
7487
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
7488
+ message: string;
7489
+ /** Indicates that the access system has lost its Salto KS certification. Please contact support to regain access. */
7490
+ error_code: 'salto_ks_certification_expired';
7477
7491
  }>;
7478
7492
  /** Warnings associated with the `acs_system`. */
7479
7493
  warnings: Array<{
@@ -7583,6 +7597,13 @@ export interface Routes {
7583
7597
  message: string;
7584
7598
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
7585
7599
  error_code: 'account_disconnected';
7600
+ } | {
7601
+ /** Date and time at which Seam created the error. */
7602
+ created_at: string;
7603
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
7604
+ message: string;
7605
+ /** Indicates that the access system has lost its Salto KS certification. Please contact support to regain access. */
7606
+ error_code: 'salto_ks_certification_expired';
7586
7607
  }>;
7587
7608
  /** Warnings associated with the `acs_system`. */
7588
7609
  warnings: Array<{
@@ -26450,241 +26471,1111 @@ export interface Routes {
26450
26471
  };
26451
26472
  };
26452
26473
  };
26453
- '/thermostats/set_temperature_threshold': {
26454
- route: '/thermostats/set_temperature_threshold';
26455
- method: 'POST' | 'PATCH';
26474
+ '/thermostats/set_hvac_mode': {
26475
+ route: '/thermostats/set_hvac_mode';
26476
+ method: 'POST';
26456
26477
  queryParams: {};
26457
26478
  jsonBody: {
26479
+ hvac_mode_setting: 'off';
26458
26480
  /** ID of the desired thermostat device. */
26459
26481
  device_id: string;
26460
- /** Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. */
26461
- lower_limit_celsius?: (number | undefined) | null;
26462
- /** Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. */
26463
- lower_limit_fahrenheit?: (number | undefined) | null;
26464
- /** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. */
26465
- upper_limit_celsius?: (number | undefined) | null;
26466
- /** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. */
26467
- upper_limit_fahrenheit?: (number | undefined) | null;
26468
- };
26469
- commonParams: {};
26470
- formData: {};
26471
- jsonResponse: {};
26472
- };
26473
- '/thermostats/update_climate_preset': {
26474
- route: '/thermostats/update_climate_preset';
26475
- method: 'POST' | 'PATCH';
26476
- queryParams: {};
26477
- jsonBody: {
26482
+ } | {
26483
+ hvac_mode_setting: 'cool';
26478
26484
  /** ID of the desired thermostat device. */
26479
26485
  device_id: string;
26480
- /** Unique key to identify the climate preset. */
26481
- climate_preset_key: string;
26482
- /** User-friendly name to identify the climate preset. */
26483
- name?: (string | null) | undefined;
26484
- /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
26485
- fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
26486
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
26487
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
26488
- /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
26486
+ /** 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. */
26489
26487
  cooling_set_point_celsius?: number | undefined;
26490
- /** Temperature to which the thermostat should heat (in °C). */
26488
+ /** 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. */
26489
+ cooling_set_point_fahrenheit?: number | undefined;
26490
+ } | {
26491
+ hvac_mode_setting: 'heat';
26492
+ /** ID of the desired thermostat device. */
26493
+ device_id: string;
26494
+ /** 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. */
26491
26495
  heating_set_point_celsius?: number | undefined;
26492
- /** Temperature to which the thermostat should cool (in °F). */
26496
+ /** 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. */
26497
+ heating_set_point_fahrenheit?: number | undefined;
26498
+ } | {
26499
+ hvac_mode_setting: 'heat_cool';
26500
+ /** ID of the desired thermostat device. */
26501
+ device_id: string;
26502
+ /** 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. */
26503
+ cooling_set_point_celsius?: number | undefined;
26504
+ /** 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. */
26493
26505
  cooling_set_point_fahrenheit?: number | undefined;
26494
- /** Temperature to which the thermostat should heat (in °F). */
26506
+ /** 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. */
26507
+ heating_set_point_celsius?: number | undefined;
26508
+ /** 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. */
26495
26509
  heating_set_point_fahrenheit?: number | undefined;
26496
- /** Indicates whether a person at the thermostat can change the thermostat's settings.
26497
- * @deprecated Use 'thermostat_schedule.is_override_allowed' */
26498
- manual_override_allowed: boolean;
26499
26510
  };
26500
26511
  commonParams: {};
26501
26512
  formData: {};
26502
- jsonResponse: {};
26503
- };
26504
- '/user_identities/add_acs_user': {
26505
- route: '/user_identities/add_acs_user';
26506
- method: 'POST' | 'PUT';
26507
- queryParams: {};
26508
- jsonBody: {};
26509
- commonParams: {
26510
- /** ID of the desired user identity. */
26511
- user_identity_id: string;
26512
- /** ID of the desired ACS user. */
26513
- acs_user_id: string;
26514
- };
26515
- formData: {};
26516
- jsonResponse: {};
26517
- };
26518
- '/user_identities/create': {
26519
- route: '/user_identities/create';
26520
- method: 'POST';
26521
- queryParams: {};
26522
- jsonBody: {};
26523
- commonParams: {
26524
- /** Unique key for the user identity. */
26525
- user_identity_key?: (string | null) | undefined;
26526
- /** Unique email address for the user identity. */
26527
- email_address?: (string | null) | undefined;
26528
- /** Unique phone number for the user identity in E.164 format (for example, +15555550100). */
26529
- phone_number?: (string | null) | undefined;
26530
- /** Full name of the user associated with the user identity. */
26531
- full_name?: (string | null) | undefined;
26532
- };
26533
- formData: {};
26534
- jsonResponse: {
26535
- /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
26536
- user_identity: {
26537
- /** ID of the user identity. */
26538
- user_identity_id: string;
26539
- /** Unique key for the user identity. */
26540
- user_identity_key: string | null;
26541
- /** Unique email address for the user identity. */
26542
- email_address: string | null;
26543
- /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
26544
- phone_number: string | null;
26545
- display_name: string;
26546
- full_name: string | null;
26547
- /** Date and time at which the user identity was created. */
26548
- created_at: string;
26549
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
26550
- workspace_id: string;
26551
- };
26552
- };
26553
- };
26554
- '/user_identities/delete': {
26555
- route: '/user_identities/delete';
26556
- method: 'DELETE' | 'POST';
26557
- queryParams: {};
26558
- jsonBody: {};
26559
- commonParams: {
26560
- /** ID of the desired user identity. */
26561
- user_identity_id: string;
26562
- };
26563
- formData: {};
26564
- jsonResponse: {};
26565
- };
26566
- '/user_identities/enrollment_automations/delete': {
26567
- route: '/user_identities/enrollment_automations/delete';
26568
- method: 'DELETE' | 'POST';
26569
- queryParams: {};
26570
- jsonBody: {};
26571
- commonParams: {
26572
- /** ID of the desired enrollment automation. */
26573
- enrollment_automation_id: string;
26574
- };
26575
- formData: {};
26576
- jsonResponse: {};
26577
- };
26578
- '/user_identities/enrollment_automations/get': {
26579
- route: '/user_identities/enrollment_automations/get';
26580
- method: 'GET' | 'POST';
26581
- queryParams: {};
26582
- jsonBody: {};
26583
- commonParams: {
26584
- /** ID of the desired enrollment automation. */
26585
- enrollment_automation_id: string;
26586
- };
26587
- formData: {};
26588
- jsonResponse: {
26589
- /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). */
26590
- enrollment_automation: {
26591
- /** ID of the enrollment automation. */
26592
- enrollment_automation_id: string;
26593
- /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
26594
- credential_manager_acs_system_id: string;
26595
- /** ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */
26596
- user_identity_id: string;
26597
- /** Date and time at which the enrollment automation was created. */
26598
- created_at: string;
26599
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
26600
- workspace_id: string;
26601
- };
26602
- };
26603
- };
26604
- '/user_identities/enrollment_automations/launch': {
26605
- route: '/user_identities/enrollment_automations/launch';
26606
- method: 'POST';
26607
- queryParams: {};
26608
- jsonBody: {};
26609
- commonParams: {
26610
- /** ID of the desired user identity. */
26611
- user_identity_id: string;
26612
- /** ID of the desired ACS system that serves as the credential manager. */
26613
- credential_manager_acs_system_id: string;
26614
- /** ID of the ACS credential pool from which to obtain credentials for the user identity. */
26615
- acs_credential_pool_id?: string | undefined;
26616
- /** Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. */
26617
- create_credential_manager_user?: boolean | undefined;
26618
- /** ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
26619
- credential_manager_acs_user_id?: string | undefined;
26620
- };
26621
- formData: {};
26622
- jsonResponse: {
26623
- enrollment_automation: {
26624
- acs_credential_provisioning_automation_id: string;
26625
- credential_manager_acs_system_id: string;
26626
- user_identity_id: string;
26627
- created_at: string;
26628
- workspace_id: string;
26629
- enrollment_automation_id: string;
26630
- };
26631
- };
26632
- };
26633
- '/user_identities/enrollment_automations/list': {
26634
- route: '/user_identities/enrollment_automations/list';
26635
- method: 'GET' | 'POST';
26636
- queryParams: {};
26637
- jsonBody: {};
26638
- commonParams: {
26639
- /** ID of the user identity for which you want to retrieve all enrollment automations. */
26640
- user_identity_id: string;
26641
- };
26642
- formData: {};
26643
- jsonResponse: {
26644
- enrollment_automations: Array<{
26645
- /** ID of the enrollment automation. */
26646
- enrollment_automation_id: string;
26647
- /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
26648
- credential_manager_acs_system_id: string;
26649
- /** ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */
26650
- user_identity_id: string;
26651
- /** Date and time at which the enrollment automation was created. */
26652
- created_at: string;
26653
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
26654
- workspace_id: string;
26655
- }>;
26656
- };
26657
- };
26658
- '/user_identities/get': {
26659
- route: '/user_identities/get';
26660
- method: 'GET' | 'POST';
26661
- queryParams: {};
26662
- jsonBody: {};
26663
- commonParams: {
26664
- /** ID of the desired user identity. */
26665
- user_identity_id: string;
26666
- } | {
26667
- user_identity_key: string;
26668
- };
26669
- formData: {};
26670
26513
  jsonResponse: {
26671
- /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
26672
- user_identity: {
26673
- /** ID of the user identity. */
26674
- user_identity_id: string;
26675
- /** Unique key for the user identity. */
26676
- user_identity_key: string | null;
26677
- /** Unique email address for the user identity. */
26678
- email_address: string | null;
26679
- /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
26680
- phone_number: string | null;
26681
- display_name: string;
26682
- full_name: string | null;
26683
- /** Date and time at which the user identity was created. */
26684
- created_at: string;
26685
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
26686
- workspace_id: string;
26687
- };
26514
+ action_attempt: {
26515
+ /** The ID of the action attempt. */
26516
+ action_attempt_id: string;
26517
+ status: 'pending';
26518
+ result: null;
26519
+ error: null;
26520
+ action_type: 'LOCK_DOOR';
26521
+ } | {
26522
+ /** The ID of the action attempt. */
26523
+ action_attempt_id: string;
26524
+ status: 'success';
26525
+ error: null;
26526
+ action_type: 'LOCK_DOOR';
26527
+ result: {};
26528
+ } | {
26529
+ /** The ID of the action attempt. */
26530
+ action_attempt_id: string;
26531
+ status: 'error';
26532
+ result: null;
26533
+ action_type: 'LOCK_DOOR';
26534
+ error: {
26535
+ type: string;
26536
+ message: string;
26537
+ };
26538
+ } | {
26539
+ /** The ID of the action attempt. */
26540
+ action_attempt_id: string;
26541
+ status: 'pending';
26542
+ result: null;
26543
+ error: null;
26544
+ action_type: 'UNLOCK_DOOR';
26545
+ } | {
26546
+ /** The ID of the action attempt. */
26547
+ action_attempt_id: string;
26548
+ status: 'success';
26549
+ error: null;
26550
+ action_type: 'UNLOCK_DOOR';
26551
+ result: {};
26552
+ } | {
26553
+ /** The ID of the action attempt. */
26554
+ action_attempt_id: string;
26555
+ status: 'error';
26556
+ result: null;
26557
+ action_type: 'UNLOCK_DOOR';
26558
+ error: {
26559
+ type: string;
26560
+ message: string;
26561
+ };
26562
+ } | {
26563
+ /** The ID of the action attempt. */
26564
+ action_attempt_id: string;
26565
+ status: 'pending';
26566
+ result: null;
26567
+ error: null;
26568
+ action_type: 'SCAN_CREDENTIAL';
26569
+ } | {
26570
+ /** The ID of the action attempt. */
26571
+ action_attempt_id: string;
26572
+ status: 'success';
26573
+ error: null;
26574
+ action_type: 'SCAN_CREDENTIAL';
26575
+ result: {
26576
+ /** Snapshot of credential data read from physical encoder. */
26577
+ acs_credential_on_encoder: {
26578
+ /** Date and time the credential was created. */
26579
+ created_at: string | null;
26580
+ is_issued: boolean | null;
26581
+ /** Date and time the credential will become useable. */
26582
+ starts_at: string | null;
26583
+ /** Date and time the credential will stop being useable. */
26584
+ ends_at: string | null;
26585
+ /** A number or string that physically identifies this card. */
26586
+ card_number: string | null;
26587
+ /** Visionline-specific metadata for the credential. */
26588
+ visionline_metadata?: {
26589
+ card_id: string;
26590
+ cancelled: boolean;
26591
+ discarded: boolean;
26592
+ expired: boolean;
26593
+ overwritten: boolean;
26594
+ overridden?: boolean | undefined;
26595
+ pending_auto_update: boolean;
26596
+ card_format: 'TLCode' | 'rfid48';
26597
+ card_holder?: string | undefined;
26598
+ number_of_issued_cards: number;
26599
+ guest_acs_entrance_ids?: string[] | undefined;
26600
+ common_acs_entrance_ids?: string[] | undefined;
26601
+ } | undefined;
26602
+ };
26603
+ /** Matching acs_credential currently encoded on this card. */
26604
+ acs_credential_on_seam: ({
26605
+ /** ID of the credential. */
26606
+ acs_credential_id: string;
26607
+ /** ID of the ACS user to whom the credential belongs. */
26608
+ acs_user_id?: string | undefined;
26609
+ acs_credential_pool_id?: string | undefined;
26610
+ /** ID of the access control system that contains the credential. */
26611
+ acs_system_id: string;
26612
+ /** ID of the parent credential. */
26613
+ parent_acs_credential_id?: string | undefined;
26614
+ /** Display name that corresponds to the credential type. */
26615
+ display_name: string;
26616
+ /** Access (PIN) code for the credential. */
26617
+ code?: (string | undefined) | null;
26618
+ card_number?: (string | undefined) | null;
26619
+ is_issued?: boolean | undefined;
26620
+ issued_at?: (string | undefined) | null;
26621
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
26622
+ access_method: 'code' | 'card' | 'mobile_key';
26623
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
26624
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
26625
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
26626
+ external_type_display_name?: string | undefined;
26627
+ /** Date and time at which the credential was created. */
26628
+ created_at: string;
26629
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
26630
+ workspace_id: string;
26631
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
26632
+ starts_at?: string | undefined;
26633
+ /** 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`. */
26634
+ ends_at?: string | undefined;
26635
+ /** Errors associated with the `acs_credential`. */
26636
+ errors: Array<{
26637
+ error_code: string;
26638
+ message: string;
26639
+ }>;
26640
+ /** Warnings associated with the `acs_credential`. */
26641
+ warnings: Array<{
26642
+ /** Date and time at which Seam created the warning. */
26643
+ created_at: string;
26644
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26645
+ message: string;
26646
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26647
+ warning_code: 'waiting_to_be_issued';
26648
+ } | {
26649
+ /** Date and time at which Seam created the warning. */
26650
+ created_at: string;
26651
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26652
+ message: string;
26653
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26654
+ warning_code: 'schedule_externally_modified';
26655
+ } | {
26656
+ /** Date and time at which Seam created the warning. */
26657
+ created_at: string;
26658
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26659
+ message: string;
26660
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26661
+ warning_code: 'schedule_modified';
26662
+ } | {
26663
+ /** Date and time at which Seam created the warning. */
26664
+ created_at: string;
26665
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26666
+ message: string;
26667
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26668
+ warning_code: 'being_deleted';
26669
+ }>;
26670
+ /** 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). */
26671
+ is_multi_phone_sync_credential?: boolean | undefined;
26672
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
26673
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
26674
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
26675
+ latest_desired_state_synced_with_provider_at?: string | undefined;
26676
+ /** Visionline-specific metadata for the credential. */
26677
+ visionline_metadata?: {
26678
+ card_function_type: 'guest' | 'staff';
26679
+ joiner_acs_credential_ids?: string[] | undefined;
26680
+ guest_acs_entrance_ids?: string[] | undefined;
26681
+ common_acs_entrance_ids?: string[] | undefined;
26682
+ is_valid?: boolean | undefined;
26683
+ auto_join?: boolean | undefined;
26684
+ card_id?: string | undefined;
26685
+ credential_id?: string | undefined;
26686
+ } | undefined;
26687
+ is_managed: true;
26688
+ } | {
26689
+ /** ID of the credential. */
26690
+ acs_credential_id: string;
26691
+ /** ID of the ACS user to whom the credential belongs. */
26692
+ acs_user_id?: string | undefined;
26693
+ acs_credential_pool_id?: string | undefined;
26694
+ /** ID of the access control system that contains the credential. */
26695
+ acs_system_id: string;
26696
+ /** ID of the parent credential. */
26697
+ parent_acs_credential_id?: string | undefined;
26698
+ /** Display name that corresponds to the credential type. */
26699
+ display_name: string;
26700
+ /** Access (PIN) code for the credential. */
26701
+ code?: (string | undefined) | null;
26702
+ card_number?: (string | undefined) | null;
26703
+ is_issued?: boolean | undefined;
26704
+ issued_at?: (string | undefined) | null;
26705
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
26706
+ access_method: 'code' | 'card' | 'mobile_key';
26707
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
26708
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
26709
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
26710
+ external_type_display_name?: string | undefined;
26711
+ /** Date and time at which the credential was created. */
26712
+ created_at: string;
26713
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
26714
+ workspace_id: string;
26715
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
26716
+ starts_at?: string | undefined;
26717
+ /** 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`. */
26718
+ ends_at?: string | undefined;
26719
+ /** Errors associated with the `acs_credential`. */
26720
+ errors: Array<{
26721
+ error_code: string;
26722
+ message: string;
26723
+ }>;
26724
+ /** Warnings associated with the `acs_credential`. */
26725
+ warnings: Array<{
26726
+ /** Date and time at which Seam created the warning. */
26727
+ created_at: string;
26728
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26729
+ message: string;
26730
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26731
+ warning_code: 'waiting_to_be_issued';
26732
+ } | {
26733
+ /** Date and time at which Seam created the warning. */
26734
+ created_at: string;
26735
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26736
+ message: string;
26737
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26738
+ warning_code: 'schedule_externally_modified';
26739
+ } | {
26740
+ /** Date and time at which Seam created the warning. */
26741
+ created_at: string;
26742
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26743
+ message: string;
26744
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26745
+ warning_code: 'schedule_modified';
26746
+ } | {
26747
+ /** Date and time at which Seam created the warning. */
26748
+ created_at: string;
26749
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26750
+ message: string;
26751
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26752
+ warning_code: 'being_deleted';
26753
+ }>;
26754
+ /** 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). */
26755
+ is_multi_phone_sync_credential?: boolean | undefined;
26756
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
26757
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
26758
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
26759
+ latest_desired_state_synced_with_provider_at?: string | undefined;
26760
+ /** Visionline-specific metadata for the credential. */
26761
+ visionline_metadata?: {
26762
+ card_function_type: 'guest' | 'staff';
26763
+ joiner_acs_credential_ids?: string[] | undefined;
26764
+ guest_acs_entrance_ids?: string[] | undefined;
26765
+ common_acs_entrance_ids?: string[] | undefined;
26766
+ is_valid?: boolean | undefined;
26767
+ auto_join?: boolean | undefined;
26768
+ card_id?: string | undefined;
26769
+ credential_id?: string | undefined;
26770
+ } | undefined;
26771
+ is_managed: false;
26772
+ }) | null;
26773
+ warnings: Array<{
26774
+ warning_code: 'acs_credential_on_encoder_out_of_sync';
26775
+ warning_message: string;
26776
+ }>;
26777
+ };
26778
+ } | {
26779
+ /** The ID of the action attempt. */
26780
+ action_attempt_id: string;
26781
+ status: 'error';
26782
+ result: null;
26783
+ action_type: 'SCAN_CREDENTIAL';
26784
+ error: {
26785
+ type: 'uncategorized_error';
26786
+ message: string;
26787
+ } | {
26788
+ type: 'action_attempt_expired';
26789
+ message: string;
26790
+ } | {
26791
+ type: 'no_card_on_encoder';
26792
+ message: string;
26793
+ };
26794
+ } | {
26795
+ /** The ID of the action attempt. */
26796
+ action_attempt_id: string;
26797
+ status: 'pending';
26798
+ result: null;
26799
+ error: null;
26800
+ action_type: 'ENCODE_CREDENTIAL';
26801
+ } | {
26802
+ /** The ID of the action attempt. */
26803
+ action_attempt_id: string;
26804
+ status: 'success';
26805
+ error: null;
26806
+ action_type: 'ENCODE_CREDENTIAL';
26807
+ /** Means by which a user gains access at an entrance.
26808
+ 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. */
26809
+ result: {
26810
+ /** ID of the credential. */
26811
+ acs_credential_id: string;
26812
+ /** ID of the ACS user to whom the credential belongs. */
26813
+ acs_user_id?: string | undefined;
26814
+ acs_credential_pool_id?: string | undefined;
26815
+ /** ID of the access control system that contains the credential. */
26816
+ acs_system_id: string;
26817
+ /** ID of the parent credential. */
26818
+ parent_acs_credential_id?: string | undefined;
26819
+ /** Display name that corresponds to the credential type. */
26820
+ display_name: string;
26821
+ /** Access (PIN) code for the credential. */
26822
+ code?: (string | undefined) | null;
26823
+ card_number?: (string | undefined) | null;
26824
+ is_issued?: boolean | undefined;
26825
+ issued_at?: (string | undefined) | null;
26826
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
26827
+ access_method: 'code' | 'card' | 'mobile_key';
26828
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
26829
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
26830
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
26831
+ external_type_display_name?: string | undefined;
26832
+ /** Date and time at which the credential was created. */
26833
+ created_at: string;
26834
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
26835
+ workspace_id: string;
26836
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
26837
+ starts_at?: string | undefined;
26838
+ /** 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`. */
26839
+ ends_at?: string | undefined;
26840
+ /** Errors associated with the `acs_credential`. */
26841
+ errors: Array<{
26842
+ error_code: string;
26843
+ message: string;
26844
+ }>;
26845
+ /** Warnings associated with the `acs_credential`. */
26846
+ warnings: Array<{
26847
+ /** Date and time at which Seam created the warning. */
26848
+ created_at: string;
26849
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26850
+ message: string;
26851
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26852
+ warning_code: 'waiting_to_be_issued';
26853
+ } | {
26854
+ /** Date and time at which Seam created the warning. */
26855
+ created_at: string;
26856
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26857
+ message: string;
26858
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26859
+ warning_code: 'schedule_externally_modified';
26860
+ } | {
26861
+ /** Date and time at which Seam created the warning. */
26862
+ created_at: string;
26863
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26864
+ message: string;
26865
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26866
+ warning_code: 'schedule_modified';
26867
+ } | {
26868
+ /** Date and time at which Seam created the warning. */
26869
+ created_at: string;
26870
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26871
+ message: string;
26872
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26873
+ warning_code: 'being_deleted';
26874
+ }>;
26875
+ /** 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). */
26876
+ is_multi_phone_sync_credential?: boolean | undefined;
26877
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
26878
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
26879
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
26880
+ latest_desired_state_synced_with_provider_at?: string | undefined;
26881
+ /** Visionline-specific metadata for the credential. */
26882
+ visionline_metadata?: {
26883
+ card_function_type: 'guest' | 'staff';
26884
+ joiner_acs_credential_ids?: string[] | undefined;
26885
+ guest_acs_entrance_ids?: string[] | undefined;
26886
+ common_acs_entrance_ids?: string[] | undefined;
26887
+ is_valid?: boolean | undefined;
26888
+ auto_join?: boolean | undefined;
26889
+ card_id?: string | undefined;
26890
+ credential_id?: string | undefined;
26891
+ } | undefined;
26892
+ is_managed: true;
26893
+ } | {
26894
+ /** ID of the credential. */
26895
+ acs_credential_id: string;
26896
+ /** ID of the ACS user to whom the credential belongs. */
26897
+ acs_user_id?: string | undefined;
26898
+ acs_credential_pool_id?: string | undefined;
26899
+ /** ID of the access control system that contains the credential. */
26900
+ acs_system_id: string;
26901
+ /** ID of the parent credential. */
26902
+ parent_acs_credential_id?: string | undefined;
26903
+ /** Display name that corresponds to the credential type. */
26904
+ display_name: string;
26905
+ /** Access (PIN) code for the credential. */
26906
+ code?: (string | undefined) | null;
26907
+ card_number?: (string | undefined) | null;
26908
+ is_issued?: boolean | undefined;
26909
+ issued_at?: (string | undefined) | null;
26910
+ /** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
26911
+ access_method: 'code' | 'card' | 'mobile_key';
26912
+ /** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
26913
+ external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
26914
+ /** Display name that corresponds to the brand-specific terminology for the credential type. */
26915
+ external_type_display_name?: string | undefined;
26916
+ /** Date and time at which the credential was created. */
26917
+ created_at: string;
26918
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
26919
+ workspace_id: string;
26920
+ /** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
26921
+ starts_at?: string | undefined;
26922
+ /** 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`. */
26923
+ ends_at?: string | undefined;
26924
+ /** Errors associated with the `acs_credential`. */
26925
+ errors: Array<{
26926
+ error_code: string;
26927
+ message: string;
26928
+ }>;
26929
+ /** Warnings associated with the `acs_credential`. */
26930
+ warnings: Array<{
26931
+ /** Date and time at which Seam created the warning. */
26932
+ created_at: string;
26933
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26934
+ message: string;
26935
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26936
+ warning_code: 'waiting_to_be_issued';
26937
+ } | {
26938
+ /** Date and time at which Seam created the warning. */
26939
+ created_at: string;
26940
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26941
+ message: string;
26942
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26943
+ warning_code: 'schedule_externally_modified';
26944
+ } | {
26945
+ /** Date and time at which Seam created the warning. */
26946
+ created_at: string;
26947
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26948
+ message: string;
26949
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26950
+ warning_code: 'schedule_modified';
26951
+ } | {
26952
+ /** Date and time at which Seam created the warning. */
26953
+ created_at: string;
26954
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
26955
+ message: string;
26956
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
26957
+ warning_code: 'being_deleted';
26958
+ }>;
26959
+ /** 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). */
26960
+ is_multi_phone_sync_credential?: boolean | undefined;
26961
+ /** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
26962
+ is_latest_desired_state_synced_with_provider?: boolean | undefined;
26963
+ /** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
26964
+ latest_desired_state_synced_with_provider_at?: string | undefined;
26965
+ /** Visionline-specific metadata for the credential. */
26966
+ visionline_metadata?: {
26967
+ card_function_type: 'guest' | 'staff';
26968
+ joiner_acs_credential_ids?: string[] | undefined;
26969
+ guest_acs_entrance_ids?: string[] | undefined;
26970
+ common_acs_entrance_ids?: string[] | undefined;
26971
+ is_valid?: boolean | undefined;
26972
+ auto_join?: boolean | undefined;
26973
+ card_id?: string | undefined;
26974
+ credential_id?: string | undefined;
26975
+ } | undefined;
26976
+ is_managed: false;
26977
+ };
26978
+ } | {
26979
+ /** The ID of the action attempt. */
26980
+ action_attempt_id: string;
26981
+ status: 'error';
26982
+ result: null;
26983
+ action_type: 'ENCODE_CREDENTIAL';
26984
+ error: {
26985
+ type: 'uncategorized_error';
26986
+ message: string;
26987
+ } | {
26988
+ type: 'action_attempt_expired';
26989
+ message: string;
26990
+ } | {
26991
+ type: 'no_card_on_encoder';
26992
+ message: string;
26993
+ } | {
26994
+ type: 'incompatible_card_format';
26995
+ message: string;
26996
+ };
26997
+ } | {
26998
+ /** The ID of the action attempt. */
26999
+ action_attempt_id: string;
27000
+ status: 'pending';
27001
+ result: null;
27002
+ error: null;
27003
+ action_type: 'RESET_SANDBOX_WORKSPACE';
27004
+ } | {
27005
+ /** The ID of the action attempt. */
27006
+ action_attempt_id: string;
27007
+ status: 'success';
27008
+ error: null;
27009
+ action_type: 'RESET_SANDBOX_WORKSPACE';
27010
+ result: {};
27011
+ } | {
27012
+ /** The ID of the action attempt. */
27013
+ action_attempt_id: string;
27014
+ status: 'error';
27015
+ result: null;
27016
+ action_type: 'RESET_SANDBOX_WORKSPACE';
27017
+ error: {
27018
+ type: string;
27019
+ message: string;
27020
+ };
27021
+ } | {
27022
+ /** The ID of the action attempt. */
27023
+ action_attempt_id: string;
27024
+ status: 'pending';
27025
+ result: null;
27026
+ error: null;
27027
+ action_type: 'SET_COOL';
27028
+ } | {
27029
+ /** The ID of the action attempt. */
27030
+ action_attempt_id: string;
27031
+ status: 'success';
27032
+ error: null;
27033
+ action_type: 'SET_COOL';
27034
+ result: {};
27035
+ } | {
27036
+ /** The ID of the action attempt. */
27037
+ action_attempt_id: string;
27038
+ status: 'error';
27039
+ result: null;
27040
+ action_type: 'SET_COOL';
27041
+ error: {
27042
+ type: string;
27043
+ message: string;
27044
+ };
27045
+ } | {
27046
+ /** The ID of the action attempt. */
27047
+ action_attempt_id: string;
27048
+ status: 'pending';
27049
+ result: null;
27050
+ error: null;
27051
+ action_type: 'SET_HEAT';
27052
+ } | {
27053
+ /** The ID of the action attempt. */
27054
+ action_attempt_id: string;
27055
+ status: 'success';
27056
+ error: null;
27057
+ action_type: 'SET_HEAT';
27058
+ result: {};
27059
+ } | {
27060
+ /** The ID of the action attempt. */
27061
+ action_attempt_id: string;
27062
+ status: 'error';
27063
+ result: null;
27064
+ action_type: 'SET_HEAT';
27065
+ error: {
27066
+ type: string;
27067
+ message: string;
27068
+ };
27069
+ } | {
27070
+ /** The ID of the action attempt. */
27071
+ action_attempt_id: string;
27072
+ status: 'pending';
27073
+ result: null;
27074
+ error: null;
27075
+ action_type: 'SET_HEAT_COOL';
27076
+ } | {
27077
+ /** The ID of the action attempt. */
27078
+ action_attempt_id: string;
27079
+ status: 'success';
27080
+ error: null;
27081
+ action_type: 'SET_HEAT_COOL';
27082
+ result: {};
27083
+ } | {
27084
+ /** The ID of the action attempt. */
27085
+ action_attempt_id: string;
27086
+ status: 'error';
27087
+ result: null;
27088
+ action_type: 'SET_HEAT_COOL';
27089
+ error: {
27090
+ type: string;
27091
+ message: string;
27092
+ };
27093
+ } | {
27094
+ /** The ID of the action attempt. */
27095
+ action_attempt_id: string;
27096
+ status: 'pending';
27097
+ result: null;
27098
+ error: null;
27099
+ action_type: 'SET_FAN_MODE';
27100
+ } | {
27101
+ /** The ID of the action attempt. */
27102
+ action_attempt_id: string;
27103
+ status: 'success';
27104
+ error: null;
27105
+ action_type: 'SET_FAN_MODE';
27106
+ result: {};
27107
+ } | {
27108
+ /** The ID of the action attempt. */
27109
+ action_attempt_id: string;
27110
+ status: 'error';
27111
+ result: null;
27112
+ action_type: 'SET_FAN_MODE';
27113
+ error: {
27114
+ type: string;
27115
+ message: string;
27116
+ };
27117
+ } | {
27118
+ /** The ID of the action attempt. */
27119
+ action_attempt_id: string;
27120
+ status: 'pending';
27121
+ result: null;
27122
+ error: null;
27123
+ action_type: 'SET_THERMOSTAT_OFF';
27124
+ } | {
27125
+ /** The ID of the action attempt. */
27126
+ action_attempt_id: string;
27127
+ status: 'success';
27128
+ error: null;
27129
+ action_type: 'SET_THERMOSTAT_OFF';
27130
+ result: {};
27131
+ } | {
27132
+ /** The ID of the action attempt. */
27133
+ action_attempt_id: string;
27134
+ status: 'error';
27135
+ result: null;
27136
+ action_type: 'SET_THERMOSTAT_OFF';
27137
+ error: {
27138
+ type: string;
27139
+ message: string;
27140
+ };
27141
+ } | {
27142
+ /** The ID of the action attempt. */
27143
+ action_attempt_id: string;
27144
+ status: 'pending';
27145
+ result: null;
27146
+ error: null;
27147
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
27148
+ } | {
27149
+ /** The ID of the action attempt. */
27150
+ action_attempt_id: string;
27151
+ status: 'success';
27152
+ error: null;
27153
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
27154
+ result: {};
27155
+ } | {
27156
+ /** The ID of the action attempt. */
27157
+ action_attempt_id: string;
27158
+ status: 'error';
27159
+ result: null;
27160
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
27161
+ error: {
27162
+ type: string;
27163
+ message: string;
27164
+ };
27165
+ } | {
27166
+ /** The ID of the action attempt. */
27167
+ action_attempt_id: string;
27168
+ status: 'pending';
27169
+ result: null;
27170
+ error: null;
27171
+ action_type: 'SYNC_ACCESS_CODES';
27172
+ } | {
27173
+ /** The ID of the action attempt. */
27174
+ action_attempt_id: string;
27175
+ status: 'success';
27176
+ error: null;
27177
+ action_type: 'SYNC_ACCESS_CODES';
27178
+ result: {};
27179
+ } | {
27180
+ /** The ID of the action attempt. */
27181
+ action_attempt_id: string;
27182
+ status: 'error';
27183
+ result: null;
27184
+ action_type: 'SYNC_ACCESS_CODES';
27185
+ error: {
27186
+ type: string;
27187
+ message: string;
27188
+ };
27189
+ } | {
27190
+ /** The ID of the action attempt. */
27191
+ action_attempt_id: string;
27192
+ status: 'pending';
27193
+ result: null;
27194
+ error: null;
27195
+ action_type: 'CREATE_ACCESS_CODE';
27196
+ } | {
27197
+ /** The ID of the action attempt. */
27198
+ action_attempt_id: string;
27199
+ status: 'success';
27200
+ error: null;
27201
+ action_type: 'CREATE_ACCESS_CODE';
27202
+ result: {
27203
+ access_code?: any;
27204
+ };
27205
+ } | {
27206
+ /** The ID of the action attempt. */
27207
+ action_attempt_id: string;
27208
+ status: 'error';
27209
+ result: null;
27210
+ action_type: 'CREATE_ACCESS_CODE';
27211
+ error: {
27212
+ type: string;
27213
+ message: string;
27214
+ };
27215
+ } | {
27216
+ /** The ID of the action attempt. */
27217
+ action_attempt_id: string;
27218
+ status: 'pending';
27219
+ result: null;
27220
+ error: null;
27221
+ action_type: 'DELETE_ACCESS_CODE';
27222
+ } | {
27223
+ /** The ID of the action attempt. */
27224
+ action_attempt_id: string;
27225
+ status: 'success';
27226
+ error: null;
27227
+ action_type: 'DELETE_ACCESS_CODE';
27228
+ result: {};
27229
+ } | {
27230
+ /** The ID of the action attempt. */
27231
+ action_attempt_id: string;
27232
+ status: 'error';
27233
+ result: null;
27234
+ action_type: 'DELETE_ACCESS_CODE';
27235
+ error: {
27236
+ type: string;
27237
+ message: string;
27238
+ };
27239
+ } | {
27240
+ /** The ID of the action attempt. */
27241
+ action_attempt_id: string;
27242
+ status: 'pending';
27243
+ result: null;
27244
+ error: null;
27245
+ action_type: 'UPDATE_ACCESS_CODE';
27246
+ } | {
27247
+ /** The ID of the action attempt. */
27248
+ action_attempt_id: string;
27249
+ status: 'success';
27250
+ error: null;
27251
+ action_type: 'UPDATE_ACCESS_CODE';
27252
+ result: {
27253
+ access_code?: any;
27254
+ };
27255
+ } | {
27256
+ /** The ID of the action attempt. */
27257
+ action_attempt_id: string;
27258
+ status: 'error';
27259
+ result: null;
27260
+ action_type: 'UPDATE_ACCESS_CODE';
27261
+ error: {
27262
+ type: string;
27263
+ message: string;
27264
+ };
27265
+ } | {
27266
+ /** The ID of the action attempt. */
27267
+ action_attempt_id: string;
27268
+ status: 'pending';
27269
+ result: null;
27270
+ error: null;
27271
+ action_type: 'CREATE_NOISE_THRESHOLD';
27272
+ } | {
27273
+ /** The ID of the action attempt. */
27274
+ action_attempt_id: string;
27275
+ status: 'success';
27276
+ error: null;
27277
+ action_type: 'CREATE_NOISE_THRESHOLD';
27278
+ result: {
27279
+ noise_threshold?: any;
27280
+ };
27281
+ } | {
27282
+ /** The ID of the action attempt. */
27283
+ action_attempt_id: string;
27284
+ status: 'error';
27285
+ result: null;
27286
+ action_type: 'CREATE_NOISE_THRESHOLD';
27287
+ error: {
27288
+ type: string;
27289
+ message: string;
27290
+ };
27291
+ } | {
27292
+ /** The ID of the action attempt. */
27293
+ action_attempt_id: string;
27294
+ status: 'pending';
27295
+ result: null;
27296
+ error: null;
27297
+ action_type: 'DELETE_NOISE_THRESHOLD';
27298
+ } | {
27299
+ /** The ID of the action attempt. */
27300
+ action_attempt_id: string;
27301
+ status: 'success';
27302
+ error: null;
27303
+ action_type: 'DELETE_NOISE_THRESHOLD';
27304
+ result: {};
27305
+ } | {
27306
+ /** The ID of the action attempt. */
27307
+ action_attempt_id: string;
27308
+ status: 'error';
27309
+ result: null;
27310
+ action_type: 'DELETE_NOISE_THRESHOLD';
27311
+ error: {
27312
+ type: string;
27313
+ message: string;
27314
+ };
27315
+ } | {
27316
+ /** The ID of the action attempt. */
27317
+ action_attempt_id: string;
27318
+ status: 'pending';
27319
+ result: null;
27320
+ error: null;
27321
+ action_type: 'UPDATE_NOISE_THRESHOLD';
27322
+ } | {
27323
+ /** The ID of the action attempt. */
27324
+ action_attempt_id: string;
27325
+ status: 'success';
27326
+ error: null;
27327
+ action_type: 'UPDATE_NOISE_THRESHOLD';
27328
+ result: {
27329
+ noise_threshold?: any;
27330
+ };
27331
+ } | {
27332
+ /** The ID of the action attempt. */
27333
+ action_attempt_id: string;
27334
+ status: 'error';
27335
+ result: null;
27336
+ action_type: 'UPDATE_NOISE_THRESHOLD';
27337
+ error: {
27338
+ type: string;
27339
+ message: string;
27340
+ };
27341
+ };
27342
+ };
27343
+ };
27344
+ '/thermostats/set_temperature_threshold': {
27345
+ route: '/thermostats/set_temperature_threshold';
27346
+ method: 'POST' | 'PATCH';
27347
+ queryParams: {};
27348
+ jsonBody: {
27349
+ /** ID of the desired thermostat device. */
27350
+ device_id: string;
27351
+ /** Lower temperature limit in in °C. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. */
27352
+ lower_limit_celsius?: (number | undefined) | null;
27353
+ /** Lower temperature limit in in °F. Seam alerts you if the reported temperature is lower than this value. You can specify either `lower_limit` but not both. */
27354
+ lower_limit_fahrenheit?: (number | undefined) | null;
27355
+ /** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. */
27356
+ upper_limit_celsius?: (number | undefined) | null;
27357
+ /** Upper temperature limit in in °C. Seam alerts you if the reported temperature is higher than this value. You can specify either `upper_limit` but not both. */
27358
+ upper_limit_fahrenheit?: (number | undefined) | null;
27359
+ };
27360
+ commonParams: {};
27361
+ formData: {};
27362
+ jsonResponse: {};
27363
+ };
27364
+ '/thermostats/update_climate_preset': {
27365
+ route: '/thermostats/update_climate_preset';
27366
+ method: 'POST' | 'PATCH';
27367
+ queryParams: {};
27368
+ jsonBody: {
27369
+ /** ID of the desired thermostat device. */
27370
+ device_id: string;
27371
+ /** Unique key to identify the climate preset. */
27372
+ climate_preset_key: string;
27373
+ /** User-friendly name to identify the climate preset. */
27374
+ name?: (string | null) | undefined;
27375
+ /** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
27376
+ fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
27377
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
27378
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
27379
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
27380
+ cooling_set_point_celsius?: number | undefined;
27381
+ /** Temperature to which the thermostat should heat (in °C). */
27382
+ heating_set_point_celsius?: number | undefined;
27383
+ /** Temperature to which the thermostat should cool (in °F). */
27384
+ cooling_set_point_fahrenheit?: number | undefined;
27385
+ /** Temperature to which the thermostat should heat (in °F). */
27386
+ heating_set_point_fahrenheit?: number | undefined;
27387
+ /** Indicates whether a person at the thermostat can change the thermostat's settings.
27388
+ * @deprecated Use 'thermostat_schedule.is_override_allowed' */
27389
+ manual_override_allowed: boolean;
27390
+ };
27391
+ commonParams: {};
27392
+ formData: {};
27393
+ jsonResponse: {};
27394
+ };
27395
+ '/user_identities/add_acs_user': {
27396
+ route: '/user_identities/add_acs_user';
27397
+ method: 'POST' | 'PUT';
27398
+ queryParams: {};
27399
+ jsonBody: {};
27400
+ commonParams: {
27401
+ /** ID of the desired user identity. */
27402
+ user_identity_id: string;
27403
+ /** ID of the desired ACS user. */
27404
+ acs_user_id: string;
27405
+ };
27406
+ formData: {};
27407
+ jsonResponse: {};
27408
+ };
27409
+ '/user_identities/create': {
27410
+ route: '/user_identities/create';
27411
+ method: 'POST';
27412
+ queryParams: {};
27413
+ jsonBody: {};
27414
+ commonParams: {
27415
+ /** Unique key for the user identity. */
27416
+ user_identity_key?: (string | null) | undefined;
27417
+ /** Unique email address for the user identity. */
27418
+ email_address?: (string | null) | undefined;
27419
+ /** Unique phone number for the user identity in E.164 format (for example, +15555550100). */
27420
+ phone_number?: (string | null) | undefined;
27421
+ /** Full name of the user associated with the user identity. */
27422
+ full_name?: (string | null) | undefined;
27423
+ };
27424
+ formData: {};
27425
+ jsonResponse: {
27426
+ /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
27427
+ user_identity: {
27428
+ /** ID of the user identity. */
27429
+ user_identity_id: string;
27430
+ /** Unique key for the user identity. */
27431
+ user_identity_key: string | null;
27432
+ /** Unique email address for the user identity. */
27433
+ email_address: string | null;
27434
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
27435
+ phone_number: string | null;
27436
+ display_name: string;
27437
+ full_name: string | null;
27438
+ /** Date and time at which the user identity was created. */
27439
+ created_at: string;
27440
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
27441
+ workspace_id: string;
27442
+ };
27443
+ };
27444
+ };
27445
+ '/user_identities/delete': {
27446
+ route: '/user_identities/delete';
27447
+ method: 'DELETE' | 'POST';
27448
+ queryParams: {};
27449
+ jsonBody: {};
27450
+ commonParams: {
27451
+ /** ID of the desired user identity. */
27452
+ user_identity_id: string;
27453
+ };
27454
+ formData: {};
27455
+ jsonResponse: {};
27456
+ };
27457
+ '/user_identities/enrollment_automations/delete': {
27458
+ route: '/user_identities/enrollment_automations/delete';
27459
+ method: 'DELETE' | 'POST';
27460
+ queryParams: {};
27461
+ jsonBody: {};
27462
+ commonParams: {
27463
+ /** ID of the desired enrollment automation. */
27464
+ enrollment_automation_id: string;
27465
+ };
27466
+ formData: {};
27467
+ jsonResponse: {};
27468
+ };
27469
+ '/user_identities/enrollment_automations/get': {
27470
+ route: '/user_identities/enrollment_automations/get';
27471
+ method: 'GET' | 'POST';
27472
+ queryParams: {};
27473
+ jsonBody: {};
27474
+ commonParams: {
27475
+ /** ID of the desired enrollment automation. */
27476
+ enrollment_automation_id: string;
27477
+ };
27478
+ formData: {};
27479
+ jsonResponse: {
27480
+ /** Represents an [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system) within the [Seam mobile access solution](https://docs.seam.co/latest/capability-guides/mobile-access-in-development). */
27481
+ enrollment_automation: {
27482
+ /** ID of the enrollment automation. */
27483
+ enrollment_automation_id: string;
27484
+ /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
27485
+ credential_manager_acs_system_id: string;
27486
+ /** ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */
27487
+ user_identity_id: string;
27488
+ /** Date and time at which the enrollment automation was created. */
27489
+ created_at: string;
27490
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
27491
+ workspace_id: string;
27492
+ };
27493
+ };
27494
+ };
27495
+ '/user_identities/enrollment_automations/launch': {
27496
+ route: '/user_identities/enrollment_automations/launch';
27497
+ method: 'POST';
27498
+ queryParams: {};
27499
+ jsonBody: {};
27500
+ commonParams: {
27501
+ /** ID of the desired user identity. */
27502
+ user_identity_id: string;
27503
+ /** ID of the desired ACS system that serves as the credential manager. */
27504
+ credential_manager_acs_system_id: string;
27505
+ /** ID of the ACS credential pool from which to obtain credentials for the user identity. */
27506
+ acs_credential_pool_id?: string | undefined;
27507
+ /** Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. */
27508
+ create_credential_manager_user?: boolean | undefined;
27509
+ /** ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
27510
+ credential_manager_acs_user_id?: string | undefined;
27511
+ };
27512
+ formData: {};
27513
+ jsonResponse: {
27514
+ enrollment_automation: {
27515
+ acs_credential_provisioning_automation_id: string;
27516
+ credential_manager_acs_system_id: string;
27517
+ user_identity_id: string;
27518
+ created_at: string;
27519
+ workspace_id: string;
27520
+ enrollment_automation_id: string;
27521
+ };
27522
+ };
27523
+ };
27524
+ '/user_identities/enrollment_automations/list': {
27525
+ route: '/user_identities/enrollment_automations/list';
27526
+ method: 'GET' | 'POST';
27527
+ queryParams: {};
27528
+ jsonBody: {};
27529
+ commonParams: {
27530
+ /** ID of the user identity for which you want to retrieve all enrollment automations. */
27531
+ user_identity_id: string;
27532
+ };
27533
+ formData: {};
27534
+ jsonResponse: {
27535
+ enrollment_automations: Array<{
27536
+ /** ID of the enrollment automation. */
27537
+ enrollment_automation_id: string;
27538
+ /** ID of the associated [ACS system](https://docs.seam.co/latest/capability-guides/access-systems) that serves as the credential manager. */
27539
+ credential_manager_acs_system_id: string;
27540
+ /** ID of the associated [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). */
27541
+ user_identity_id: string;
27542
+ /** Date and time at which the enrollment automation was created. */
27543
+ created_at: string;
27544
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the enrollment automation. */
27545
+ workspace_id: string;
27546
+ }>;
27547
+ };
27548
+ };
27549
+ '/user_identities/get': {
27550
+ route: '/user_identities/get';
27551
+ method: 'GET' | 'POST';
27552
+ queryParams: {};
27553
+ jsonBody: {};
27554
+ commonParams: {
27555
+ /** ID of the desired user identity. */
27556
+ user_identity_id: string;
27557
+ } | {
27558
+ user_identity_key: string;
27559
+ };
27560
+ formData: {};
27561
+ jsonResponse: {
27562
+ /** Represents a [user identity](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with an application user account. */
27563
+ user_identity: {
27564
+ /** ID of the user identity. */
27565
+ user_identity_id: string;
27566
+ /** Unique key for the user identity. */
27567
+ user_identity_key: string | null;
27568
+ /** Unique email address for the user identity. */
27569
+ email_address: string | null;
27570
+ /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
27571
+ phone_number: string | null;
27572
+ display_name: string;
27573
+ full_name: string | null;
27574
+ /** Date and time at which the user identity was created. */
27575
+ created_at: string;
27576
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity. */
27577
+ workspace_id: string;
27578
+ };
26688
27579
  };
26689
27580
  };
26690
27581
  '/user_identities/grant_access_to_device': {
@@ -27858,6 +28749,13 @@ export interface Routes {
27858
28749
  message: string;
27859
28750
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
27860
28751
  error_code: 'account_disconnected';
28752
+ } | {
28753
+ /** Date and time at which Seam created the error. */
28754
+ created_at: string;
28755
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
28756
+ message: string;
28757
+ /** Indicates that the access system has lost its Salto KS certification. Please contact support to regain access. */
28758
+ error_code: 'salto_ks_certification_expired';
27861
28759
  }>;
27862
28760
  /** Warnings associated with the `acs_system`. */
27863
28761
  warnings: Array<{