@seamapi/types 1.401.0 → 1.403.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (34) hide show
  1. package/dist/connect.cjs +652 -12
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +839 -69
  4. package/lib/seam/connect/internal/schemas.d.ts +1 -1
  5. package/lib/seam/connect/internal/schemas.js +1 -1
  6. package/lib/seam/connect/internal/schemas.js.map +1 -1
  7. package/lib/seam/connect/models/devices/device-provider.d.ts +2 -2
  8. package/lib/seam/connect/models/devices/device-provider.js +2 -1
  9. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  10. package/lib/seam/connect/models/index.d.ts +1 -0
  11. package/lib/seam/connect/models/index.js +1 -0
  12. package/lib/seam/connect/models/index.js.map +1 -1
  13. package/lib/seam/connect/models/phones/index.d.ts +2 -0
  14. package/lib/seam/connect/models/phones/index.js +3 -0
  15. package/lib/seam/connect/models/phones/index.js.map +1 -0
  16. package/lib/seam/connect/models/phones/phone-registration.d.ts +18 -0
  17. package/lib/seam/connect/models/phones/phone-registration.js +13 -0
  18. package/lib/seam/connect/models/phones/phone-registration.js.map +1 -0
  19. package/lib/seam/connect/models/phones/phone-session.d.ts +2060 -0
  20. package/lib/seam/connect/models/phones/phone-session.js +21 -0
  21. package/lib/seam/connect/models/phones/phone-session.js.map +1 -0
  22. package/lib/seam/connect/openapi.d.ts +561 -0
  23. package/lib/seam/connect/openapi.js +648 -9
  24. package/lib/seam/connect/openapi.js.map +1 -1
  25. package/lib/seam/connect/route-types.d.ts +215 -6
  26. package/package.json +2 -2
  27. package/src/lib/seam/connect/internal/schemas.ts +2 -0
  28. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -1
  29. package/src/lib/seam/connect/models/index.ts +1 -0
  30. package/src/lib/seam/connect/models/phones/index.ts +2 -0
  31. package/src/lib/seam/connect/models/phones/phone-registration.ts +15 -0
  32. package/src/lib/seam/connect/models/phones/phone-session.ts +27 -0
  33. package/src/lib/seam/connect/openapi.ts +715 -9
  34. package/src/lib/seam/connect/route-types.ts +269 -6
package/dist/connect.cjs CHANGED
@@ -1349,6 +1349,7 @@ var PROVIDER_CATEGORY_MAP = {
1349
1349
  "yale",
1350
1350
  "nuki",
1351
1351
  "salto",
1352
+ "salto_space",
1352
1353
  "controlbyweb",
1353
1354
  "minut",
1354
1355
  "my_2n",
@@ -1368,7 +1369,8 @@ var PROVIDER_CATEGORY_MAP = {
1368
1369
  "assa_abloy_credential_service",
1369
1370
  "latch",
1370
1371
  "akiles",
1371
- "sensi"
1372
+ "sensi",
1373
+ "assa_abloy_vostio"
1372
1374
  ],
1373
1375
  consumer_smartlocks: [
1374
1376
  "akiles",
@@ -1393,8 +1395,7 @@ var PROVIDER_CATEGORY_MAP = {
1393
1395
  "latch",
1394
1396
  "salto_ks",
1395
1397
  "assa_abloy_vostio",
1396
- "salto_space",
1397
- "assa_abloy_vostio"
1398
+ "salto_space"
1398
1399
  ],
1399
1400
  internal_beta: ALL_DEVICE_PROVIDERS
1400
1401
  };
@@ -18452,6 +18453,572 @@ var openapi_default = {
18452
18453
  type: "object",
18453
18454
  "x-route-path": "/phones"
18454
18455
  },
18456
+ phone_registration: {
18457
+ properties: {
18458
+ is_being_activated: { type: "boolean" },
18459
+ phone_registration_id: { type: "string" },
18460
+ provider_name: { nullable: true, type: "string" },
18461
+ provider_state: {}
18462
+ },
18463
+ required: [
18464
+ "phone_registration_id",
18465
+ "provider_name",
18466
+ "is_being_activated"
18467
+ ],
18468
+ type: "object",
18469
+ "x-route-path": "/seam/mobile_sdk/v1/phone_sessions",
18470
+ "x-undocumented": "Seam Mobile SDK only."
18471
+ },
18472
+ phone_session: {
18473
+ properties: {
18474
+ provider_sessions: {
18475
+ items: {
18476
+ properties: {
18477
+ acs_credentials: {
18478
+ items: {
18479
+ description: "Means by which an [access control system user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) gains access at an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). The `acs_credential` object represents a [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) that provides an ACS user access within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nAn access control system generally uses digital means of access to authorize a user trying to get through a specific entrance. Examples of credentials include plastic key cards, mobile keys, biometric identifiers, and PIN codes. The electronic nature of these credentials, as well as the fact that access is centralized, enables both the rapid provisioning and rescinding of access and the ability to compile access audit logs.\n\nFor each `acs_credential`, you define the access method. You can also specify additional properties, such as a PIN code, depending on the credential type.",
18480
+ properties: {
18481
+ access_method: {
18482
+ description: "Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`.",
18483
+ enum: ["code", "card", "mobile_key"],
18484
+ type: "string"
18485
+ },
18486
+ acs_credential_id: {
18487
+ description: "ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
18488
+ format: "uuid",
18489
+ type: "string"
18490
+ },
18491
+ acs_credential_pool_id: {
18492
+ format: "uuid",
18493
+ type: "string"
18494
+ },
18495
+ acs_entrances: {
18496
+ items: {
18497
+ description: "Represents an [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) within an [access control system](https://docs.seam.co/latest/capability-guides/access-systems).\n\nIn an access control system, an entrance is a secured door, gate, zone, or other method of entry. You can list details for all the `acs_entrance` resources in your workspace or get these details for a specific `acs_entrance`. You can also list all entrances associated with a specific credential, and you can list all credentials associated with a specific entrance.",
18498
+ properties: {
18499
+ acs_entrance_id: {
18500
+ description: "ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
18501
+ format: "uuid",
18502
+ type: "string"
18503
+ },
18504
+ acs_system_id: {
18505
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
18506
+ format: "uuid",
18507
+ type: "string"
18508
+ },
18509
+ assa_abloy_vostio_metadata: {
18510
+ description: "ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
18511
+ properties: {
18512
+ door_name: { type: "string" },
18513
+ door_number: {
18514
+ format: "float",
18515
+ type: "number"
18516
+ },
18517
+ door_type: {
18518
+ enum: [
18519
+ "CommonDoor",
18520
+ "EntranceDoor",
18521
+ "GuestDoor",
18522
+ "Elevator"
18523
+ ],
18524
+ type: "string"
18525
+ },
18526
+ pms_id: { type: "string" },
18527
+ stand_open: { type: "boolean" }
18528
+ },
18529
+ required: ["door_type", "door_name"],
18530
+ type: "object"
18531
+ },
18532
+ created_at: {
18533
+ description: "Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.",
18534
+ format: "date-time",
18535
+ type: "string"
18536
+ },
18537
+ display_name: {
18538
+ description: "Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
18539
+ type: "string"
18540
+ },
18541
+ dormakaba_community_metadata: {
18542
+ description: "dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
18543
+ properties: {
18544
+ access_point_name: { type: "string" }
18545
+ },
18546
+ required: ["access_point_name"],
18547
+ type: "object"
18548
+ },
18549
+ errors: {
18550
+ description: "Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
18551
+ items: {
18552
+ properties: {
18553
+ error_code: {
18554
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
18555
+ type: "string"
18556
+ },
18557
+ message: {
18558
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
18559
+ type: "string"
18560
+ }
18561
+ },
18562
+ required: ["error_code", "message"],
18563
+ type: "object"
18564
+ },
18565
+ type: "array"
18566
+ },
18567
+ latch_metadata: {
18568
+ description: "Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
18569
+ properties: {
18570
+ accessibility_type: { type: "string" },
18571
+ door_name: { type: "string" },
18572
+ door_type: { type: "string" },
18573
+ is_connected: { type: "boolean" }
18574
+ },
18575
+ required: [
18576
+ "accessibility_type",
18577
+ "door_name",
18578
+ "door_type",
18579
+ "is_connected"
18580
+ ],
18581
+ type: "object"
18582
+ },
18583
+ salto_ks_metadata: {
18584
+ description: "Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
18585
+ properties: {
18586
+ battery_level: { type: "string" },
18587
+ door_name: { type: "string" },
18588
+ intrusion_alarm: { type: "boolean" },
18589
+ left_open_alarm: { type: "boolean" },
18590
+ lock_type: { type: "string" },
18591
+ locked_state: { type: "string" },
18592
+ online: { type: "boolean" },
18593
+ privacy_mode: { type: "boolean" }
18594
+ },
18595
+ required: [
18596
+ "door_name",
18597
+ "locked_state",
18598
+ "lock_type",
18599
+ "battery_level"
18600
+ ],
18601
+ type: "object"
18602
+ },
18603
+ salto_space_metadata: {
18604
+ description: "Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
18605
+ properties: {
18606
+ door_description: { type: "string" },
18607
+ door_name: { type: "string" },
18608
+ ext_door_id: { type: "string" }
18609
+ },
18610
+ required: ["door_name", "ext_door_id"],
18611
+ type: "object"
18612
+ },
18613
+ visionline_metadata: {
18614
+ description: "Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
18615
+ properties: {
18616
+ door_category: {
18617
+ enum: [
18618
+ "entrance",
18619
+ "guest",
18620
+ "elevator reader",
18621
+ "common",
18622
+ "common (PMS)"
18623
+ ],
18624
+ type: "string"
18625
+ },
18626
+ door_name: { type: "string" },
18627
+ profiles: {
18628
+ items: {
18629
+ properties: {
18630
+ visionline_door_profile_id: {
18631
+ type: "string"
18632
+ },
18633
+ visionline_door_profile_type: {
18634
+ enum: ["BLE", "commonDoor", "touch"],
18635
+ type: "string"
18636
+ }
18637
+ },
18638
+ required: [
18639
+ "visionline_door_profile_id",
18640
+ "visionline_door_profile_type"
18641
+ ],
18642
+ type: "object"
18643
+ },
18644
+ type: "array"
18645
+ }
18646
+ },
18647
+ required: ["door_name", "door_category"],
18648
+ type: "object"
18649
+ }
18650
+ },
18651
+ required: [
18652
+ "acs_system_id",
18653
+ "acs_entrance_id",
18654
+ "created_at",
18655
+ "display_name",
18656
+ "errors"
18657
+ ],
18658
+ type: "object",
18659
+ "x-route-path": "/acs/entrances"
18660
+ },
18661
+ type: "array"
18662
+ },
18663
+ acs_system_id: {
18664
+ description: "ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
18665
+ format: "uuid",
18666
+ type: "string"
18667
+ },
18668
+ acs_user_id: {
18669
+ description: "ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs.",
18670
+ format: "uuid",
18671
+ type: "string"
18672
+ },
18673
+ assa_abloy_vostio_metadata: {
18674
+ description: "Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
18675
+ properties: {
18676
+ auto_join: { type: "boolean" },
18677
+ door_names: {
18678
+ items: { type: "string" },
18679
+ type: "array"
18680
+ },
18681
+ endpoint_id: { type: "string" },
18682
+ key_id: { type: "string" },
18683
+ key_issuing_request_id: { type: "string" },
18684
+ override_guest_acs_entrance_ids: {
18685
+ items: { type: "string" },
18686
+ type: "array"
18687
+ }
18688
+ },
18689
+ type: "object"
18690
+ },
18691
+ card_number: {
18692
+ description: "Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
18693
+ nullable: true,
18694
+ type: "string"
18695
+ },
18696
+ code: {
18697
+ description: "Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
18698
+ nullable: true,
18699
+ type: "string"
18700
+ },
18701
+ created_at: {
18702
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created.",
18703
+ format: "date-time",
18704
+ type: "string"
18705
+ },
18706
+ display_name: {
18707
+ description: "Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
18708
+ minLength: 1,
18709
+ type: "string"
18710
+ },
18711
+ ends_at: {
18712
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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`.",
18713
+ type: "string"
18714
+ },
18715
+ errors: {
18716
+ description: "Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
18717
+ items: {
18718
+ properties: {
18719
+ error_code: { type: "string" },
18720
+ message: { type: "string" }
18721
+ },
18722
+ required: ["error_code", "message"],
18723
+ type: "object"
18724
+ },
18725
+ type: "array"
18726
+ },
18727
+ external_type: {
18728
+ description: "Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`.",
18729
+ enum: [
18730
+ "pti_card",
18731
+ "brivo_credential",
18732
+ "hid_credential",
18733
+ "visionline_card",
18734
+ "salto_ks_credential",
18735
+ "assa_abloy_vostio_key",
18736
+ "salto_space_key",
18737
+ "latch_access"
18738
+ ],
18739
+ type: "string"
18740
+ },
18741
+ external_type_display_name: {
18742
+ description: "Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type.",
18743
+ type: "string"
18744
+ },
18745
+ is_issued: {
18746
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card.",
18747
+ type: "boolean"
18748
+ },
18749
+ is_latest_desired_state_synced_with_provider: {
18750
+ description: "Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider.",
18751
+ nullable: true,
18752
+ type: "boolean"
18753
+ },
18754
+ is_managed: { enum: [true], type: "boolean" },
18755
+ is_multi_phone_sync_credential: {
18756
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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).",
18757
+ type: "boolean"
18758
+ },
18759
+ is_one_time_use: {
18760
+ description: "Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use.",
18761
+ type: "boolean"
18762
+ },
18763
+ issued_at: {
18764
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card.",
18765
+ format: "date-time",
18766
+ nullable: true,
18767
+ type: "string"
18768
+ },
18769
+ latest_desired_state_synced_with_provider_at: {
18770
+ description: "Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider.",
18771
+ format: "date-time",
18772
+ nullable: true,
18773
+ type: "string"
18774
+ },
18775
+ parent_acs_credential_id: {
18776
+ description: "ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
18777
+ format: "uuid",
18778
+ type: "string"
18779
+ },
18780
+ starts_at: {
18781
+ description: "Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
18782
+ type: "string"
18783
+ },
18784
+ visionline_metadata: {
18785
+ description: "Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
18786
+ properties: {
18787
+ auto_join: { type: "boolean" },
18788
+ card_function_type: {
18789
+ enum: ["guest", "staff"],
18790
+ type: "string"
18791
+ },
18792
+ card_id: { type: "string" },
18793
+ common_acs_entrance_ids: {
18794
+ items: { format: "uuid", type: "string" },
18795
+ type: "array"
18796
+ },
18797
+ credential_id: { type: "string" },
18798
+ guest_acs_entrance_ids: {
18799
+ items: { format: "uuid", type: "string" },
18800
+ type: "array"
18801
+ },
18802
+ is_valid: { type: "boolean" },
18803
+ joiner_acs_credential_ids: {
18804
+ items: { format: "uuid", type: "string" },
18805
+ type: "array"
18806
+ }
18807
+ },
18808
+ required: ["card_function_type"],
18809
+ type: "object"
18810
+ },
18811
+ warnings: {
18812
+ description: "Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
18813
+ items: {
18814
+ description: "Warning associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
18815
+ discriminator: { propertyName: "warning_code" },
18816
+ oneOf: [
18817
+ {
18818
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is waiting to be issued.",
18819
+ properties: {
18820
+ created_at: {
18821
+ description: "Date and time at which Seam created the warning.",
18822
+ format: "date-time",
18823
+ type: "string"
18824
+ },
18825
+ message: {
18826
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18827
+ type: "string"
18828
+ },
18829
+ warning_code: {
18830
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
18831
+ enum: ["waiting_to_be_issued"],
18832
+ type: "string"
18833
+ }
18834
+ },
18835
+ required: [
18836
+ "created_at",
18837
+ "message",
18838
+ "warning_code"
18839
+ ],
18840
+ type: "object"
18841
+ },
18842
+ {
18843
+ description: "Indicates that the schedule of one of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials)'s children was modified externally.",
18844
+ properties: {
18845
+ created_at: {
18846
+ description: "Date and time at which Seam created the warning.",
18847
+ format: "date-time",
18848
+ type: "string"
18849
+ },
18850
+ message: {
18851
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18852
+ type: "string"
18853
+ },
18854
+ warning_code: {
18855
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
18856
+ enum: ["schedule_externally_modified"],
18857
+ type: "string"
18858
+ }
18859
+ },
18860
+ required: [
18861
+ "created_at",
18862
+ "message",
18863
+ "warning_code"
18864
+ ],
18865
+ type: "object"
18866
+ },
18867
+ {
18868
+ description: "Indicates that the schedule of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was modified to avoid creating a credential with a start date in the past.",
18869
+ properties: {
18870
+ created_at: {
18871
+ description: "Date and time at which Seam created the warning.",
18872
+ format: "date-time",
18873
+ type: "string"
18874
+ },
18875
+ message: {
18876
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18877
+ type: "string"
18878
+ },
18879
+ warning_code: {
18880
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
18881
+ enum: ["schedule_modified"],
18882
+ type: "string"
18883
+ }
18884
+ },
18885
+ required: [
18886
+ "created_at",
18887
+ "message",
18888
+ "warning_code"
18889
+ ],
18890
+ type: "object"
18891
+ },
18892
+ {
18893
+ description: "Indicates that the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is being deleted.",
18894
+ properties: {
18895
+ created_at: {
18896
+ description: "Date and time at which Seam created the warning.",
18897
+ format: "date-time",
18898
+ type: "string"
18899
+ },
18900
+ message: {
18901
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18902
+ type: "string"
18903
+ },
18904
+ warning_code: {
18905
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
18906
+ enum: ["being_deleted"],
18907
+ type: "string"
18908
+ }
18909
+ },
18910
+ required: [
18911
+ "created_at",
18912
+ "message",
18913
+ "warning_code"
18914
+ ],
18915
+ type: "object"
18916
+ },
18917
+ {
18918
+ description: "An unknown issue occurred while syncing the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) with the provider. This issue may affect the proper functioning of the credential.",
18919
+ properties: {
18920
+ created_at: {
18921
+ description: "Date and time at which Seam created the warning.",
18922
+ format: "date-time",
18923
+ type: "string"
18924
+ },
18925
+ message: {
18926
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18927
+ type: "string"
18928
+ },
18929
+ warning_code: {
18930
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
18931
+ enum: ["unknown_issue_with_acs_credential"],
18932
+ type: "string"
18933
+ }
18934
+ },
18935
+ required: [
18936
+ "created_at",
18937
+ "message",
18938
+ "warning_code"
18939
+ ],
18940
+ type: "object"
18941
+ },
18942
+ {
18943
+ description: "Access permissions for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) have changed. [Reissue](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners/creating-and-encoding-card-based-credentials) (re-encode) the credential. This issue may affect the proper functioning of the credential.",
18944
+ properties: {
18945
+ created_at: {
18946
+ description: "Date and time at which Seam created the warning.",
18947
+ format: "date-time",
18948
+ type: "string"
18949
+ },
18950
+ message: {
18951
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
18952
+ type: "string"
18953
+ },
18954
+ warning_code: {
18955
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
18956
+ enum: ["needs_to_be_reissued"],
18957
+ type: "string"
18958
+ }
18959
+ },
18960
+ required: [
18961
+ "created_at",
18962
+ "message",
18963
+ "warning_code"
18964
+ ],
18965
+ type: "object"
18966
+ }
18967
+ ]
18968
+ },
18969
+ type: "array"
18970
+ },
18971
+ workspace_id: {
18972
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials).",
18973
+ format: "uuid",
18974
+ type: "string"
18975
+ }
18976
+ },
18977
+ required: [
18978
+ "acs_credential_id",
18979
+ "acs_system_id",
18980
+ "display_name",
18981
+ "access_method",
18982
+ "created_at",
18983
+ "workspace_id",
18984
+ "errors",
18985
+ "warnings",
18986
+ "is_managed",
18987
+ "acs_entrances"
18988
+ ],
18989
+ type: "object",
18990
+ "x-route-path": "/acs/credentials"
18991
+ },
18992
+ type: "array"
18993
+ },
18994
+ phone_registration: {
18995
+ properties: {
18996
+ is_being_activated: { type: "boolean" },
18997
+ phone_registration_id: { type: "string" },
18998
+ provider_name: { nullable: true, type: "string" },
18999
+ provider_state: {}
19000
+ },
19001
+ required: [
19002
+ "phone_registration_id",
19003
+ "provider_name",
19004
+ "is_being_activated"
19005
+ ],
19006
+ type: "object",
19007
+ "x-route-path": "/seam/mobile_sdk/v1/phone_sessions",
19008
+ "x-undocumented": "Seam Mobile SDK only."
19009
+ }
19010
+ },
19011
+ required: ["phone_registration", "acs_credentials"],
19012
+ type: "object"
19013
+ },
19014
+ type: "array"
19015
+ }
19016
+ },
19017
+ required: ["provider_sessions"],
19018
+ type: "object",
19019
+ "x-route-path": "/seam/mobile_sdk/v1/phone_sessions",
19020
+ "x-undocumented": "Seam Mobile SDK only."
19021
+ },
18455
19022
  thermostat_schedule: {
18456
19023
  description: "Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.",
18457
19024
  properties: {
@@ -24978,12 +25545,17 @@ var openapi_default = {
24978
25545
  type: "string"
24979
25546
  },
24980
25547
  acs_user_id: {
24981
- description: "ID of the access system user from which you want to unassign a credential.",
25548
+ description: "ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.",
25549
+ format: "uuid",
25550
+ type: "string"
25551
+ },
25552
+ user_identity_id: {
25553
+ description: "ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.",
24982
25554
  format: "uuid",
24983
25555
  type: "string"
24984
25556
  }
24985
25557
  },
24986
- required: ["acs_user_id", "acs_credential_id"],
25558
+ required: ["acs_credential_id"],
24987
25559
  type: "object"
24988
25560
  }
24989
25561
  }
@@ -25035,12 +25607,17 @@ var openapi_default = {
25035
25607
  type: "string"
25036
25608
  },
25037
25609
  acs_user_id: {
25038
- description: "ID of the access system user from which you want to unassign a credential.",
25610
+ description: "ID of the access system user from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.",
25611
+ format: "uuid",
25612
+ type: "string"
25613
+ },
25614
+ user_identity_id: {
25615
+ description: "ID of the user identity from which you want to unassign a credential. You can only provide one of acs_user_id or user_identity_id.",
25039
25616
  format: "uuid",
25040
25617
  type: "string"
25041
25618
  }
25042
25619
  },
25043
- required: ["acs_user_id", "acs_credential_id"],
25620
+ required: ["acs_credential_id"],
25044
25621
  type: "object"
25045
25622
  }
25046
25623
  }
@@ -26097,12 +26674,17 @@ var openapi_default = {
26097
26674
  type: "string"
26098
26675
  },
26099
26676
  acs_user_id: {
26100
- description: "ID of the access system user to whom you want to grant access to an entrance.",
26677
+ description: "ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id.",
26678
+ format: "uuid",
26679
+ type: "string"
26680
+ },
26681
+ user_identity_id: {
26682
+ description: "ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created.",
26101
26683
  format: "uuid",
26102
26684
  type: "string"
26103
26685
  }
26104
26686
  },
26105
- required: ["acs_entrance_id", "acs_user_id"],
26687
+ required: ["acs_entrance_id"],
26106
26688
  type: "object"
26107
26689
  }
26108
26690
  }
@@ -33104,6 +33686,64 @@ var openapi_default = {
33104
33686
  "x-undocumented": "Mobile SDK only."
33105
33687
  }
33106
33688
  },
33689
+ "/seam/mobile_sdk/v1/phone_sessions/get_or_create": {
33690
+ post: {
33691
+ description: "Get or create a session for a mobile SDK phone.",
33692
+ operationId: "seamMobileSdkV1PhoneSessionsGetOrCreatePost",
33693
+ requestBody: {
33694
+ content: {
33695
+ "application/json": {
33696
+ schema: {
33697
+ properties: {
33698
+ custom_sdk_installation_id: { type: "string" },
33699
+ phone_device_metadata: {
33700
+ properties: {
33701
+ manufacturer: { type: "string" },
33702
+ model: { type: "string" },
33703
+ os_version: { type: "string" }
33704
+ },
33705
+ type: "object"
33706
+ },
33707
+ phone_os: { enum: ["ios", "android"], type: "string" }
33708
+ },
33709
+ required: ["custom_sdk_installation_id", "phone_os"],
33710
+ type: "object"
33711
+ }
33712
+ }
33713
+ }
33714
+ },
33715
+ responses: {
33716
+ 200: {
33717
+ content: {
33718
+ "application/json": {
33719
+ schema: {
33720
+ properties: {
33721
+ ok: { type: "boolean" },
33722
+ phone_session: {
33723
+ $ref: "#/components/schemas/phone_session"
33724
+ }
33725
+ },
33726
+ required: ["phone_session", "ok"],
33727
+ type: "object"
33728
+ }
33729
+ }
33730
+ },
33731
+ description: "OK"
33732
+ },
33733
+ 400: { description: "Bad Request" },
33734
+ 401: { description: "Unauthorized" }
33735
+ },
33736
+ security: [{ client_session: [] }],
33737
+ summary: "/seam/mobile_sdk/v1/phone_sessions/get_or_create",
33738
+ tags: [],
33739
+ "x-fern-sdk-group-name": ["seam", "mobile_sdk", "v1", "phone_sessions"],
33740
+ "x-fern-sdk-method-name": "get_or_create",
33741
+ "x-fern-sdk-return-value": "phone_session",
33742
+ "x-response-key": "phone_session",
33743
+ "x-title": "Get or Create a Phone Session",
33744
+ "x-undocumented": "Mobile SDK only."
33745
+ }
33746
+ },
33107
33747
  "/thermostats/activate_climate_preset": {
33108
33748
  post: {
33109
33749
  description: "Activates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).",
@@ -33375,7 +34015,7 @@ var openapi_default = {
33375
34015
  type: "array"
33376
34016
  }
33377
34017
  },
33378
- required: ["device_id", "periods"],
34018
+ required: ["device_id", "name", "periods"],
33379
34019
  type: "object"
33380
34020
  }
33381
34021
  }
@@ -33564,7 +34204,7 @@ var openapi_default = {
33564
34204
  type: "string"
33565
34205
  }
33566
34206
  },
33567
- required: ["thermostat_daily_program_id", "periods"],
34207
+ required: ["thermostat_daily_program_id", "name", "periods"],
33568
34208
  type: "object"
33569
34209
  }
33570
34210
  }
@@ -33642,7 +34282,7 @@ var openapi_default = {
33642
34282
  type: "string"
33643
34283
  }
33644
34284
  },
33645
- required: ["thermostat_daily_program_id", "periods"],
34285
+ required: ["thermostat_daily_program_id", "name", "periods"],
33646
34286
  type: "object"
33647
34287
  }
33648
34288
  }