@seamapi/types 1.459.0 → 1.460.1

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 (41) hide show
  1. package/dist/connect.cjs +489 -127
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +2612 -713
  4. package/dist/index.cjs +489 -127
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-credential.d.ts +8 -8
  7. package/lib/seam/connect/models/acs/metadata/assa-abloy-vostio.d.ts +2 -2
  8. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +28 -28
  9. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +12 -12
  10. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +16 -16
  11. package/lib/seam/connect/models/batch.d.ts +3279 -237
  12. package/lib/seam/connect/models/batch.js +7 -0
  13. package/lib/seam/connect/models/batch.js.map +1 -1
  14. package/lib/seam/connect/models/customer/access-grant-resources.d.ts +18 -18
  15. package/lib/seam/connect/models/customer/access-grant-resources.js +2 -1
  16. package/lib/seam/connect/models/customer/access-grant-resources.js.map +1 -1
  17. package/lib/seam/connect/models/customer/customer-data.d.ts +15 -15
  18. package/lib/seam/connect/models/devices/device-metadata.d.ts +108 -0
  19. package/lib/seam/connect/models/devices/device-metadata.js +67 -0
  20. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  21. package/lib/seam/connect/models/devices/device-provider.d.ts +1 -0
  22. package/lib/seam/connect/models/devices/device-provider.js +1 -0
  23. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  24. package/lib/seam/connect/models/devices/device.d.ts +152 -0
  25. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +108 -0
  26. package/lib/seam/connect/models/phones/phone-session.d.ts +181 -14
  27. package/lib/seam/connect/models/phones/phone-session.js +3 -0
  28. package/lib/seam/connect/models/phones/phone-session.js.map +1 -1
  29. package/lib/seam/connect/openapi.d.ts +300 -33
  30. package/lib/seam/connect/openapi.js +447 -113
  31. package/lib/seam/connect/openapi.js.map +1 -1
  32. package/lib/seam/connect/route-types.d.ts +1354 -179
  33. package/package.json +1 -1
  34. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  35. package/src/lib/seam/connect/models/batch.ts +7 -0
  36. package/src/lib/seam/connect/models/customer/access-grant-resources.ts +2 -1
  37. package/src/lib/seam/connect/models/devices/device-metadata.ts +68 -0
  38. package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
  39. package/src/lib/seam/connect/models/phones/phone-session.ts +5 -0
  40. package/src/lib/seam/connect/openapi.ts +481 -113
  41. package/src/lib/seam/connect/route-types.ts +1558 -189
package/dist/connect.cjs CHANGED
@@ -1011,7 +1011,29 @@ var device_metadata = zod.z.object({
1011
1011
  device_id: zod.z.string().describe(`Device ID for a Sensi device.`),
1012
1012
  device_name: zod.z.string().describe(`Device name for a Sensi device.`),
1013
1013
  product_type: zod.z.string().describe(`Product type for a Sensi device.`)
1014
- }).describe(`Metadata for a Sensi device.`)
1014
+ }).describe(`Metadata for a Sensi device.`),
1015
+ keynest_metadata: zod.z.object({
1016
+ key_id: zod.z.string().describe(`Key ID for a KeyNest device.`),
1017
+ device_name: zod.z.string().describe(`Device name for a KeyNest device.`),
1018
+ property_id: zod.z.string().nullable().describe(`Property ID for a KeyNest device.`),
1019
+ property_postcode: zod.z.string().nullable().describe(`Property postcode for a KeyNest device.`),
1020
+ key_notes: zod.z.string().nullable().describe(`Key notes for a KeyNest device.`),
1021
+ subscription_plan: zod.z.string().describe(`Subscription plan for a KeyNest device.`),
1022
+ status_type: zod.z.string().describe(`Status type for a KeyNest device.`),
1023
+ current_or_last_store_id: zod.z.number().describe(`Current or last store ID for a KeyNest device.`),
1024
+ last_movement: zod.z.string().describe(`Last movement timestamp for a KeyNest device.`),
1025
+ address: zod.z.string().nullable().describe(`Address for a KeyNest device.`),
1026
+ current_status: zod.z.string().nullable().describe(`Current status for a KeyNest device.`),
1027
+ current_user_name: zod.z.string().nullable().describe(`Current user name for a KeyNest device.`),
1028
+ current_user_email: zod.z.string().nullable().describe(`Current user email for a KeyNest device.`),
1029
+ current_user_phone_number: zod.z.string().nullable().describe(`Current user phone number for a KeyNest device.`),
1030
+ current_user_company: zod.z.string().nullable().describe(`Current user company for a KeyNest device.`),
1031
+ handover_method: zod.z.string().nullable().describe(`Handover method for a KeyNest device.`),
1032
+ keynest_app_user: zod.z.string().nullable().describe(`KeyNest app user for a KeyNest device.`),
1033
+ default_office_id: zod.z.number().describe(`Default office ID for a KeyNest device.`),
1034
+ fob_id: zod.z.number().describe(`Fob ID for a KeyNest device.`),
1035
+ has_photo: zod.z.boolean().describe(`Whether the KeyNest device has a photo.`)
1036
+ }).describe(`Metadata for a KeyNest device.`)
1015
1037
  }).partial().describe(`
1016
1038
  ---
1017
1039
  property_group_key: provider_metadata
@@ -1739,7 +1761,8 @@ var DEVICE_PROVIDERS = {
1739
1761
  TADO: "tado",
1740
1762
  SALTO_SPACE: "salto_space",
1741
1763
  SENSI: "sensi",
1742
- KWIKSET2: "kwikset2"
1764
+ KWIKSET2: "kwikset2",
1765
+ KEYNEST: "keynest"
1743
1766
  };
1744
1767
  var ALL_DEVICE_PROVIDERS = Object.values(DEVICE_PROVIDERS);
1745
1768
  var PROVIDER_CATEGORY_MAP = {
@@ -3921,13 +3944,18 @@ zod.z.object({
3921
3944
  batch_type: zod.z.literal("spaces"),
3922
3945
  spaces: space.array().optional(),
3923
3946
  devices: device.array().optional(),
3924
- acs_entrances: acs_entrance.array().optional()
3947
+ acs_entrances: acs_entrance.array().optional(),
3948
+ connected_accounts: connected_account.array().optional(),
3949
+ acs_systems: acs_system.array().optional()
3925
3950
  }).describe("ID of the affected access system user.");
3926
3951
  zod.z.object({
3927
3952
  batch_type: zod.z.literal("access_grants"),
3928
3953
  spaces: space.array().optional(),
3929
3954
  devices: device.array().optional(),
3930
- acs_entrances: acs_entrance.array().optional()
3955
+ acs_entrances: acs_entrance.array().optional(),
3956
+ user_identities: user_identity.array().optional(),
3957
+ connected_accounts: connected_account.array().optional(),
3958
+ acs_systems: acs_system.array().optional()
3931
3959
  });
3932
3960
  zod.z.object({
3933
3961
  batch_type: zod.z.literal("access_methods"),
@@ -14780,6 +14808,128 @@ var openapi_default = {
14780
14808
  required: ["device_id", "device_name"],
14781
14809
  type: "object"
14782
14810
  },
14811
+ keynest_metadata: {
14812
+ description: "Metadata for a KeyNest device.",
14813
+ properties: {
14814
+ address: {
14815
+ description: "Address for a KeyNest device.",
14816
+ nullable: true,
14817
+ type: "string"
14818
+ },
14819
+ current_or_last_store_id: {
14820
+ description: "Current or last store ID for a KeyNest device.",
14821
+ format: "float",
14822
+ type: "number"
14823
+ },
14824
+ current_status: {
14825
+ description: "Current status for a KeyNest device.",
14826
+ nullable: true,
14827
+ type: "string"
14828
+ },
14829
+ current_user_company: {
14830
+ description: "Current user company for a KeyNest device.",
14831
+ nullable: true,
14832
+ type: "string"
14833
+ },
14834
+ current_user_email: {
14835
+ description: "Current user email for a KeyNest device.",
14836
+ nullable: true,
14837
+ type: "string"
14838
+ },
14839
+ current_user_name: {
14840
+ description: "Current user name for a KeyNest device.",
14841
+ nullable: true,
14842
+ type: "string"
14843
+ },
14844
+ current_user_phone_number: {
14845
+ description: "Current user phone number for a KeyNest device.",
14846
+ nullable: true,
14847
+ type: "string"
14848
+ },
14849
+ default_office_id: {
14850
+ description: "Default office ID for a KeyNest device.",
14851
+ format: "float",
14852
+ type: "number"
14853
+ },
14854
+ device_name: {
14855
+ description: "Device name for a KeyNest device.",
14856
+ type: "string"
14857
+ },
14858
+ fob_id: {
14859
+ description: "Fob ID for a KeyNest device.",
14860
+ format: "float",
14861
+ type: "number"
14862
+ },
14863
+ handover_method: {
14864
+ description: "Handover method for a KeyNest device.",
14865
+ nullable: true,
14866
+ type: "string"
14867
+ },
14868
+ has_photo: {
14869
+ description: "Whether the KeyNest device has a photo.",
14870
+ type: "boolean"
14871
+ },
14872
+ key_id: {
14873
+ description: "Key ID for a KeyNest device.",
14874
+ type: "string"
14875
+ },
14876
+ key_notes: {
14877
+ description: "Key notes for a KeyNest device.",
14878
+ nullable: true,
14879
+ type: "string"
14880
+ },
14881
+ keynest_app_user: {
14882
+ description: "KeyNest app user for a KeyNest device.",
14883
+ nullable: true,
14884
+ type: "string"
14885
+ },
14886
+ last_movement: {
14887
+ description: "Last movement timestamp for a KeyNest device.",
14888
+ type: "string"
14889
+ },
14890
+ property_id: {
14891
+ description: "Property ID for a KeyNest device.",
14892
+ nullable: true,
14893
+ type: "string"
14894
+ },
14895
+ property_postcode: {
14896
+ description: "Property postcode for a KeyNest device.",
14897
+ nullable: true,
14898
+ type: "string"
14899
+ },
14900
+ status_type: {
14901
+ description: "Status type for a KeyNest device.",
14902
+ type: "string"
14903
+ },
14904
+ subscription_plan: {
14905
+ description: "Subscription plan for a KeyNest device.",
14906
+ type: "string"
14907
+ }
14908
+ },
14909
+ required: [
14910
+ "key_id",
14911
+ "device_name",
14912
+ "property_id",
14913
+ "property_postcode",
14914
+ "key_notes",
14915
+ "subscription_plan",
14916
+ "status_type",
14917
+ "current_or_last_store_id",
14918
+ "last_movement",
14919
+ "address",
14920
+ "current_status",
14921
+ "current_user_name",
14922
+ "current_user_email",
14923
+ "current_user_phone_number",
14924
+ "current_user_company",
14925
+ "handover_method",
14926
+ "keynest_app_user",
14927
+ "default_office_id",
14928
+ "fob_id",
14929
+ "has_photo"
14930
+ ],
14931
+ type: "object"
14932
+ },
14783
14933
  kwikset_metadata: {
14784
14934
  description: "Metadata for a Kwikset device.",
14785
14935
  properties: {
@@ -16771,7 +16921,8 @@ var openapi_default = {
16771
16921
  "tado",
16772
16922
  "salto_space",
16773
16923
  "sensi",
16774
- "kwikset2"
16924
+ "kwikset2",
16925
+ "keynest"
16775
16926
  ],
16776
16927
  type: "string"
16777
16928
  },
@@ -23416,9 +23567,169 @@ var openapi_default = {
23416
23567
  type: "object"
23417
23568
  },
23418
23569
  type: "array"
23419
- }
23570
+ },
23571
+ user_identity: {
23572
+ description: "User identity.",
23573
+ properties: {
23574
+ acs_user_ids: {
23575
+ description: "Array of access system user IDs associated with the user identity.",
23576
+ items: { format: "uuid", type: "string" },
23577
+ type: "array"
23578
+ },
23579
+ created_at: {
23580
+ description: "Date and time at which the user identity was created.",
23581
+ format: "date-time",
23582
+ type: "string"
23583
+ },
23584
+ display_name: { minLength: 1, type: "string" },
23585
+ email_address: {
23586
+ description: "Unique email address for the user identity.",
23587
+ format: "email",
23588
+ nullable: true,
23589
+ type: "string"
23590
+ },
23591
+ errors: {
23592
+ description: 'Array of errors associated with the user identity. Each error object within the array contains fields like "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
23593
+ items: {
23594
+ description: "Errors associated with the user identity.",
23595
+ discriminator: { propertyName: "error_code" },
23596
+ oneOf: [
23597
+ {
23598
+ description: "Indicates that there is an issue with an access system user associated with this user identity.",
23599
+ properties: {
23600
+ acs_system_id: {
23601
+ description: "ID of the access system that the user identity is associated with.",
23602
+ format: "uuid",
23603
+ type: "string"
23604
+ },
23605
+ acs_user_id: {
23606
+ description: "ID of the access system user that has an issue.",
23607
+ format: "uuid",
23608
+ type: "string"
23609
+ },
23610
+ created_at: {
23611
+ description: "Date and time at which Seam created the error.",
23612
+ format: "date-time",
23613
+ type: "string"
23614
+ },
23615
+ error_code: {
23616
+ description: "Unique identifier of the type of error. Enables quick recognition and categorization of the issue.",
23617
+ enum: ["issue_with_acs_user"],
23618
+ type: "string"
23619
+ },
23620
+ message: {
23621
+ description: "Detailed description of the error. Provides insights into the issue and potentially how to rectify it.",
23622
+ type: "string"
23623
+ }
23624
+ },
23625
+ required: [
23626
+ "created_at",
23627
+ "message",
23628
+ "error_code",
23629
+ "acs_user_id",
23630
+ "acs_system_id"
23631
+ ],
23632
+ type: "object"
23633
+ }
23634
+ ]
23635
+ },
23636
+ type: "array"
23637
+ },
23638
+ full_name: { minLength: 1, nullable: true, type: "string" },
23639
+ phone_number: {
23640
+ description: "Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).",
23641
+ nullable: true,
23642
+ type: "string"
23643
+ },
23644
+ user_identity_id: {
23645
+ description: "ID of the user identity.",
23646
+ format: "uuid",
23647
+ type: "string"
23648
+ },
23649
+ user_identity_key: {
23650
+ description: "Unique key for the user identity.",
23651
+ minLength: 1,
23652
+ nullable: true,
23653
+ type: "string"
23654
+ },
23655
+ warnings: {
23656
+ description: 'Array of warnings associated with the user identity. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
23657
+ items: {
23658
+ description: "Warnings associated with the user identity.",
23659
+ discriminator: { propertyName: "warning_code" },
23660
+ oneOf: [
23661
+ {
23662
+ description: "Indicates that the user identity is currently being deleted.",
23663
+ properties: {
23664
+ created_at: {
23665
+ description: "Date and time at which Seam created the warning.",
23666
+ format: "date-time",
23667
+ type: "string"
23668
+ },
23669
+ message: {
23670
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
23671
+ type: "string"
23672
+ },
23673
+ warning_code: {
23674
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
23675
+ enum: ["being_deleted"],
23676
+ type: "string"
23677
+ }
23678
+ },
23679
+ required: ["created_at", "message", "warning_code"],
23680
+ type: "object"
23681
+ },
23682
+ {
23683
+ description: "Indicates that the ACS user's profile does not match the user identity's profile",
23684
+ properties: {
23685
+ created_at: {
23686
+ description: "Date and time at which Seam created the warning.",
23687
+ format: "date-time",
23688
+ type: "string"
23689
+ },
23690
+ message: {
23691
+ description: "Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.",
23692
+ type: "string"
23693
+ },
23694
+ warning_code: {
23695
+ description: "Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.",
23696
+ enum: [
23697
+ "acs_user_profile_does_not_match_user_identity"
23698
+ ],
23699
+ type: "string"
23700
+ }
23701
+ },
23702
+ required: ["created_at", "message", "warning_code"],
23703
+ type: "object"
23704
+ }
23705
+ ]
23706
+ },
23707
+ type: "array"
23708
+ },
23709
+ workspace_id: {
23710
+ description: "ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the user identity.",
23711
+ format: "uuid",
23712
+ type: "string"
23713
+ }
23714
+ },
23715
+ required: [
23716
+ "user_identity_id",
23717
+ "user_identity_key",
23718
+ "email_address",
23719
+ "phone_number",
23720
+ "display_name",
23721
+ "full_name",
23722
+ "created_at",
23723
+ "workspace_id",
23724
+ "errors",
23725
+ "warnings",
23726
+ "acs_user_ids"
23727
+ ],
23728
+ type: "object"
23729
+ },
23730
+ workspace_id: { description: "Workspace ID.", type: "string" }
23420
23731
  },
23421
- required: ["provider_sessions"],
23732
+ required: ["provider_sessions", "user_identity", "workspace_id"],
23422
23733
  type: "object",
23423
23734
  "x-route-path": "/seam/mobile_sdk/v1/phone_sessions",
23424
23735
  "x-undocumented": "Seam Mobile SDK only."
@@ -30540,7 +30851,14 @@ var openapi_default = {
30540
30851
  required: false,
30541
30852
  schema: {
30542
30853
  items: {
30543
- enum: ["spaces", "devices", "acs_entrances"],
30854
+ enum: [
30855
+ "spaces",
30856
+ "devices",
30857
+ "acs_entrances",
30858
+ "connected_accounts",
30859
+ "acs_systems",
30860
+ "user_identity"
30861
+ ],
30544
30862
  type: "string"
30545
30863
  },
30546
30864
  type: "array"
@@ -30552,7 +30870,14 @@ var openapi_default = {
30552
30870
  required: false,
30553
30871
  schema: {
30554
30872
  items: {
30555
- enum: ["spaces", "devices", "acs_entrances"],
30873
+ enum: [
30874
+ "spaces",
30875
+ "devices",
30876
+ "acs_entrances",
30877
+ "connected_accounts",
30878
+ "acs_systems",
30879
+ "user_identity"
30880
+ ],
30556
30881
  type: "string"
30557
30882
  },
30558
30883
  type: "array"
@@ -30566,20 +30891,21 @@ var openapi_default = {
30566
30891
  schema: {
30567
30892
  properties: {
30568
30893
  batch: {
30569
- description: "Represents a resource batch.",
30570
30894
  properties: {
30571
30895
  acs_entrances: {
30572
30896
  items: { $ref: "#/components/schemas/acs_entrance" },
30573
30897
  type: "array"
30574
30898
  },
30575
- batch_type: {
30576
- enum: [
30577
- "workspaces",
30578
- "access_grants",
30579
- "access_methods",
30580
- "spaces"
30581
- ],
30582
- type: "string"
30899
+ acs_systems: {
30900
+ items: { $ref: "#/components/schemas/acs_system" },
30901
+ type: "array"
30902
+ },
30903
+ batch_type: { enum: ["access_grants"], type: "string" },
30904
+ connected_accounts: {
30905
+ items: {
30906
+ $ref: "#/components/schemas/connected_account"
30907
+ },
30908
+ type: "array"
30583
30909
  },
30584
30910
  devices: {
30585
30911
  items: { $ref: "#/components/schemas/device" },
@@ -30592,15 +30918,10 @@ var openapi_default = {
30592
30918
  user_identities: {
30593
30919
  items: { $ref: "#/components/schemas/user_identity" },
30594
30920
  type: "array"
30595
- },
30596
- workspaces: {
30597
- items: { $ref: "#/components/schemas/workspace" },
30598
- type: "array"
30599
30921
  }
30600
30922
  },
30601
30923
  required: ["batch_type"],
30602
- type: "object",
30603
- "x-route-path": "/"
30924
+ type: "object"
30604
30925
  },
30605
30926
  ok: { type: "boolean" }
30606
30927
  },
@@ -30644,14 +30965,28 @@ var openapi_default = {
30644
30965
  },
30645
30966
  exclude: {
30646
30967
  items: {
30647
- enum: ["spaces", "devices", "acs_entrances"],
30968
+ enum: [
30969
+ "spaces",
30970
+ "devices",
30971
+ "acs_entrances",
30972
+ "connected_accounts",
30973
+ "acs_systems",
30974
+ "user_identity"
30975
+ ],
30648
30976
  type: "string"
30649
30977
  },
30650
30978
  type: "array"
30651
30979
  },
30652
30980
  include: {
30653
30981
  items: {
30654
- enum: ["spaces", "devices", "acs_entrances"],
30982
+ enum: [
30983
+ "spaces",
30984
+ "devices",
30985
+ "acs_entrances",
30986
+ "connected_accounts",
30987
+ "acs_systems",
30988
+ "user_identity"
30989
+ ],
30655
30990
  type: "string"
30656
30991
  },
30657
30992
  type: "array"
@@ -30670,20 +31005,21 @@ var openapi_default = {
30670
31005
  schema: {
30671
31006
  properties: {
30672
31007
  batch: {
30673
- description: "Represents a resource batch.",
30674
31008
  properties: {
30675
31009
  acs_entrances: {
30676
31010
  items: { $ref: "#/components/schemas/acs_entrance" },
30677
31011
  type: "array"
30678
31012
  },
30679
- batch_type: {
30680
- enum: [
30681
- "workspaces",
30682
- "access_grants",
30683
- "access_methods",
30684
- "spaces"
30685
- ],
30686
- type: "string"
31013
+ acs_systems: {
31014
+ items: { $ref: "#/components/schemas/acs_system" },
31015
+ type: "array"
31016
+ },
31017
+ batch_type: { enum: ["access_grants"], type: "string" },
31018
+ connected_accounts: {
31019
+ items: {
31020
+ $ref: "#/components/schemas/connected_account"
31021
+ },
31022
+ type: "array"
30687
31023
  },
30688
31024
  devices: {
30689
31025
  items: { $ref: "#/components/schemas/device" },
@@ -30696,15 +31032,10 @@ var openapi_default = {
30696
31032
  user_identities: {
30697
31033
  items: { $ref: "#/components/schemas/user_identity" },
30698
31034
  type: "array"
30699
- },
30700
- workspaces: {
30701
- items: { $ref: "#/components/schemas/workspace" },
30702
- type: "array"
30703
31035
  }
30704
31036
  },
30705
31037
  required: ["batch_type"],
30706
- type: "object",
30707
- "x-route-path": "/"
31038
+ type: "object"
30708
31039
  },
30709
31040
  ok: { type: "boolean" }
30710
31041
  },
@@ -38629,6 +38960,7 @@ var openapi_default = {
38629
38960
  "salto_space",
38630
38961
  "sensi",
38631
38962
  "kwikset2",
38963
+ "keynest",
38632
38964
  "yale_access",
38633
38965
  "hid_cm",
38634
38966
  "google_nest"
@@ -39744,7 +40076,7 @@ var openapi_default = {
39744
40076
  type: "array"
39745
40077
  },
39746
40078
  name: {
39747
- description: "Your display name for this access grant resource.",
40079
+ description: "Your name for this access grant resource.",
39748
40080
  type: "string"
39749
40081
  },
39750
40082
  property_keys: {
@@ -39788,7 +40120,7 @@ var openapi_default = {
39788
40120
  type: "string"
39789
40121
  }
39790
40122
  },
39791
- required: ["name", "access_grant_key"],
40123
+ required: ["access_grant_key"],
39792
40124
  type: "object"
39793
40125
  },
39794
40126
  type: "array"
@@ -39830,7 +40162,7 @@ var openapi_default = {
39830
40162
  type: "array"
39831
40163
  },
39832
40164
  name: {
39833
- description: "Your display name for this access grant resource.",
40165
+ description: "Your name for this access grant resource.",
39834
40166
  type: "string"
39835
40167
  },
39836
40168
  property_keys: {
@@ -39874,7 +40206,7 @@ var openapi_default = {
39874
40206
  type: "string"
39875
40207
  }
39876
40208
  },
39877
- required: ["name", "booking_key"],
40209
+ required: ["booking_key"],
39878
40210
  type: "object"
39879
40211
  },
39880
40212
  type: "array"
@@ -40050,7 +40382,7 @@ var openapi_default = {
40050
40382
  type: "array"
40051
40383
  },
40052
40384
  name: {
40053
- description: "Your display name for this access grant resource.",
40385
+ description: "Your name for this access grant resource.",
40054
40386
  type: "string"
40055
40387
  },
40056
40388
  property_keys: {
@@ -40098,7 +40430,7 @@ var openapi_default = {
40098
40430
  type: "string"
40099
40431
  }
40100
40432
  },
40101
- required: ["name", "reservation_key"],
40433
+ required: ["reservation_key"],
40102
40434
  type: "object"
40103
40435
  },
40104
40436
  type: "array"
@@ -40352,7 +40684,7 @@ var openapi_default = {
40352
40684
  type: "array"
40353
40685
  },
40354
40686
  name: {
40355
- description: "Your display name for this access grant resource.",
40687
+ description: "Your name for this access grant resource.",
40356
40688
  type: "string"
40357
40689
  },
40358
40690
  property_keys: {
@@ -40396,7 +40728,7 @@ var openapi_default = {
40396
40728
  type: "string"
40397
40729
  }
40398
40730
  },
40399
- required: ["name", "access_grant_key"],
40731
+ required: ["access_grant_key"],
40400
40732
  type: "object"
40401
40733
  },
40402
40734
  type: "array"
@@ -40438,7 +40770,7 @@ var openapi_default = {
40438
40770
  type: "array"
40439
40771
  },
40440
40772
  name: {
40441
- description: "Your display name for this access grant resource.",
40773
+ description: "Your name for this access grant resource.",
40442
40774
  type: "string"
40443
40775
  },
40444
40776
  property_keys: {
@@ -40482,7 +40814,7 @@ var openapi_default = {
40482
40814
  type: "string"
40483
40815
  }
40484
40816
  },
40485
- required: ["name", "booking_key"],
40817
+ required: ["booking_key"],
40486
40818
  type: "object"
40487
40819
  },
40488
40820
  type: "array"
@@ -40658,7 +40990,7 @@ var openapi_default = {
40658
40990
  type: "array"
40659
40991
  },
40660
40992
  name: {
40661
- description: "Your display name for this access grant resource.",
40993
+ description: "Your name for this access grant resource.",
40662
40994
  type: "string"
40663
40995
  },
40664
40996
  property_keys: {
@@ -40706,7 +41038,7 @@ var openapi_default = {
40706
41038
  type: "string"
40707
41039
  }
40708
41040
  },
40709
- required: ["name", "reservation_key"],
41041
+ required: ["reservation_key"],
40710
41042
  type: "object"
40711
41043
  },
40712
41044
  type: "array"
@@ -41332,7 +41664,8 @@ var openapi_default = {
41332
41664
  "noiseaware",
41333
41665
  "tado",
41334
41666
  "sensi",
41335
- "smartthings"
41667
+ "smartthings",
41668
+ "keynest"
41336
41669
  ],
41337
41670
  type: "string"
41338
41671
  }
@@ -41781,7 +42114,8 @@ var openapi_default = {
41781
42114
  "noiseaware",
41782
42115
  "tado",
41783
42116
  "sensi",
41784
- "smartthings"
42117
+ "smartthings",
42118
+ "keynest"
41785
42119
  ],
41786
42120
  type: "string"
41787
42121
  },
@@ -42130,7 +42464,7 @@ var openapi_default = {
42130
42464
  },
42131
42465
  "/devices/simulate/disconnect_from_hub": {
42132
42466
  post: {
42133
- description: "Simulates taking the Wi-Fi hub (bridge) offline for a device. \nOnly applicable for [sandbox workspaces](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) and August locks today, but designed so we can extend to other providers later. \nThis will set the `hub_disconnected` error on the device.",
42467
+ description: "Simulates taking the Wi\u2011Fi hub (bridge) offline for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will set the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device.",
42134
42468
  operationId: "devicesSimulateDisconnectFromHubPost",
42135
42469
  requestBody: {
42136
42470
  content: {
@@ -42558,7 +42892,8 @@ var openapi_default = {
42558
42892
  "noiseaware",
42559
42893
  "tado",
42560
42894
  "sensi",
42561
- "smartthings"
42895
+ "smartthings",
42896
+ "keynest"
42562
42897
  ],
42563
42898
  type: "string"
42564
42899
  }
@@ -43004,7 +43339,8 @@ var openapi_default = {
43004
43339
  "noiseaware",
43005
43340
  "tado",
43006
43341
  "sensi",
43007
- "smartthings"
43342
+ "smartthings",
43343
+ "keynest"
43008
43344
  ],
43009
43345
  type: "string"
43010
43346
  },
@@ -47177,10 +47513,10 @@ var openapi_default = {
47177
47513
  "x-undocumented": "Seam Bridge Client only."
47178
47514
  }
47179
47515
  },
47180
- "/seam/console/v1/get_resource_type": {
47516
+ "/seam/console/v1/get_resource_locator": {
47181
47517
  get: {
47182
- description: "Returns the type of a resource given its UUID.",
47183
- operationId: "seamConsoleV1GetResourceTypeGet",
47518
+ description: "Returns the type and system information of a resource given its UUID.",
47519
+ operationId: "seamConsoleV1GetResourceLocatorGet",
47184
47520
  parameters: [
47185
47521
  {
47186
47522
  in: "query",
@@ -47196,9 +47532,17 @@ var openapi_default = {
47196
47532
  schema: {
47197
47533
  properties: {
47198
47534
  ok: { type: "boolean" },
47199
- resource_type: { type: "string" }
47535
+ resource_locator: {
47536
+ properties: {
47537
+ acs_system_id: { format: "uuid", type: "string" },
47538
+ device_id: { format: "uuid", type: "string" },
47539
+ resource_type: { type: "string" }
47540
+ },
47541
+ required: ["resource_type"],
47542
+ type: "object"
47543
+ }
47200
47544
  },
47201
- required: ["resource_type", "ok"],
47545
+ required: ["resource_locator", "ok"],
47202
47546
  type: "object"
47203
47547
  }
47204
47548
  }
@@ -47214,18 +47558,18 @@ var openapi_default = {
47214
47558
  { console_session_with_workspace: [] },
47215
47559
  { api_key: [] }
47216
47560
  ],
47217
- summary: "/seam/console/v1/get_resource_type",
47561
+ summary: "/seam/console/v1/get_resource_locator",
47218
47562
  tags: [],
47219
47563
  "x-fern-sdk-group-name": ["seam", "console", "v1"],
47220
- "x-fern-sdk-method-name": "get_resource_type",
47221
- "x-fern-sdk-return-value": "resource_type",
47222
- "x-response-key": "resource_type",
47223
- "x-title": "Get Resource Type",
47564
+ "x-fern-sdk-method-name": "get_resource_locator",
47565
+ "x-fern-sdk-return-value": "resource_locator",
47566
+ "x-response-key": "resource_locator",
47567
+ "x-title": "Get Resource Locator",
47224
47568
  "x-undocumented": "Internal endpoint for Console"
47225
47569
  },
47226
47570
  post: {
47227
- description: "Returns the type of a resource given its UUID.",
47228
- operationId: "seamConsoleV1GetResourceTypePost",
47571
+ description: "Returns the type and system information of a resource given its UUID.",
47572
+ operationId: "seamConsoleV1GetResourceLocatorPost",
47229
47573
  parameters: [
47230
47574
  {
47231
47575
  in: "query",
@@ -47241,9 +47585,17 @@ var openapi_default = {
47241
47585
  schema: {
47242
47586
  properties: {
47243
47587
  ok: { type: "boolean" },
47244
- resource_type: { type: "string" }
47588
+ resource_locator: {
47589
+ properties: {
47590
+ acs_system_id: { format: "uuid", type: "string" },
47591
+ device_id: { format: "uuid", type: "string" },
47592
+ resource_type: { type: "string" }
47593
+ },
47594
+ required: ["resource_type"],
47595
+ type: "object"
47596
+ }
47245
47597
  },
47246
- required: ["resource_type", "ok"],
47598
+ required: ["resource_locator", "ok"],
47247
47599
  type: "object"
47248
47600
  }
47249
47601
  }
@@ -47259,13 +47611,13 @@ var openapi_default = {
47259
47611
  { console_session_with_workspace: [] },
47260
47612
  { api_key: [] }
47261
47613
  ],
47262
- summary: "/seam/console/v1/get_resource_type",
47614
+ summary: "/seam/console/v1/get_resource_locator",
47263
47615
  tags: [],
47264
47616
  "x-fern-sdk-group-name": ["seam", "console", "v1"],
47265
- "x-fern-sdk-method-name": "get_resource_type",
47266
- "x-fern-sdk-return-value": "resource_type",
47267
- "x-response-key": "resource_type",
47268
- "x-title": "Get Resource Type",
47617
+ "x-fern-sdk-method-name": "get_resource_locator",
47618
+ "x-fern-sdk-return-value": "resource_locator",
47619
+ "x-response-key": "resource_locator",
47620
+ "x-title": "Get Resource Locator",
47269
47621
  "x-undocumented": "Internal endpoint for Console"
47270
47622
  }
47271
47623
  },
@@ -47719,7 +48071,7 @@ var openapi_default = {
47719
48071
  type: "string"
47720
48072
  }
47721
48073
  },
47722
- required: ["rule", "config"],
48074
+ required: ["rule"],
47723
48075
  type: "object"
47724
48076
  },
47725
48077
  reservation_time_updated: {
@@ -47732,7 +48084,7 @@ var openapi_default = {
47732
48084
  type: "string"
47733
48085
  }
47734
48086
  },
47735
- required: ["rule", "config"],
48087
+ required: ["rule"],
47736
48088
  type: "object"
47737
48089
  }
47738
48090
  },
@@ -47819,7 +48171,7 @@ var openapi_default = {
47819
48171
  type: "string"
47820
48172
  }
47821
48173
  },
47822
- required: ["rule", "config"],
48174
+ required: ["rule"],
47823
48175
  type: "object"
47824
48176
  },
47825
48177
  reservation_time_updated: {
@@ -47832,7 +48184,7 @@ var openapi_default = {
47832
48184
  type: "string"
47833
48185
  }
47834
48186
  },
47835
- required: ["rule", "config"],
48187
+ required: ["rule"],
47836
48188
  type: "object"
47837
48189
  }
47838
48190
  },
@@ -47919,7 +48271,7 @@ var openapi_default = {
47919
48271
  type: "string"
47920
48272
  }
47921
48273
  },
47922
- required: ["rule", "config"],
48274
+ required: ["rule"],
47923
48275
  type: "object"
47924
48276
  },
47925
48277
  reservation_time_updated: {
@@ -47930,7 +48282,7 @@ var openapi_default = {
47930
48282
  type: "string"
47931
48283
  }
47932
48284
  },
47933
- required: ["rule", "config"],
48285
+ required: ["rule"],
47934
48286
  type: "object"
47935
48287
  }
47936
48288
  },
@@ -48025,7 +48377,7 @@ var openapi_default = {
48025
48377
  type: "string"
48026
48378
  }
48027
48379
  },
48028
- required: ["rule", "config"],
48380
+ required: ["rule"],
48029
48381
  type: "object"
48030
48382
  },
48031
48383
  reservation_time_updated: {
@@ -48036,7 +48388,7 @@ var openapi_default = {
48036
48388
  type: "string"
48037
48389
  }
48038
48390
  },
48039
- required: ["rule", "config"],
48391
+ required: ["rule"],
48040
48392
  type: "object"
48041
48393
  }
48042
48394
  },
@@ -49260,7 +49612,13 @@ var openapi_default = {
49260
49612
  required: false,
49261
49613
  schema: {
49262
49614
  items: {
49263
- enum: ["spaces", "devices", "acs_entrances"],
49615
+ enum: [
49616
+ "spaces",
49617
+ "devices",
49618
+ "acs_entrances",
49619
+ "connected_accounts",
49620
+ "acs_systems"
49621
+ ],
49264
49622
  type: "string"
49265
49623
  },
49266
49624
  type: "array"
@@ -49272,7 +49630,13 @@ var openapi_default = {
49272
49630
  required: false,
49273
49631
  schema: {
49274
49632
  items: {
49275
- enum: ["spaces", "devices", "acs_entrances"],
49633
+ enum: [
49634
+ "spaces",
49635
+ "devices",
49636
+ "acs_entrances",
49637
+ "connected_accounts",
49638
+ "acs_systems"
49639
+ ],
49276
49640
  type: "string"
49277
49641
  },
49278
49642
  type: "array"
@@ -49286,20 +49650,22 @@ var openapi_default = {
49286
49650
  schema: {
49287
49651
  properties: {
49288
49652
  batch: {
49289
- description: "Represents a resource batch.",
49653
+ description: "ID of the affected access system user.",
49290
49654
  properties: {
49291
49655
  acs_entrances: {
49292
49656
  items: { $ref: "#/components/schemas/acs_entrance" },
49293
49657
  type: "array"
49294
49658
  },
49295
- batch_type: {
49296
- enum: [
49297
- "workspaces",
49298
- "access_grants",
49299
- "access_methods",
49300
- "spaces"
49301
- ],
49302
- type: "string"
49659
+ acs_systems: {
49660
+ items: { $ref: "#/components/schemas/acs_system" },
49661
+ type: "array"
49662
+ },
49663
+ batch_type: { enum: ["spaces"], type: "string" },
49664
+ connected_accounts: {
49665
+ items: {
49666
+ $ref: "#/components/schemas/connected_account"
49667
+ },
49668
+ type: "array"
49303
49669
  },
49304
49670
  devices: {
49305
49671
  items: { $ref: "#/components/schemas/device" },
@@ -49308,19 +49674,10 @@ var openapi_default = {
49308
49674
  spaces: {
49309
49675
  items: { $ref: "#/components/schemas/space" },
49310
49676
  type: "array"
49311
- },
49312
- user_identities: {
49313
- items: { $ref: "#/components/schemas/user_identity" },
49314
- type: "array"
49315
- },
49316
- workspaces: {
49317
- items: { $ref: "#/components/schemas/workspace" },
49318
- type: "array"
49319
49677
  }
49320
49678
  },
49321
49679
  required: ["batch_type"],
49322
- type: "object",
49323
- "x-route-path": "/"
49680
+ type: "object"
49324
49681
  },
49325
49682
  ok: { type: "boolean" }
49326
49683
  },
@@ -49359,14 +49716,26 @@ var openapi_default = {
49359
49716
  properties: {
49360
49717
  exclude: {
49361
49718
  items: {
49362
- enum: ["spaces", "devices", "acs_entrances"],
49719
+ enum: [
49720
+ "spaces",
49721
+ "devices",
49722
+ "acs_entrances",
49723
+ "connected_accounts",
49724
+ "acs_systems"
49725
+ ],
49363
49726
  type: "string"
49364
49727
  },
49365
49728
  type: "array"
49366
49729
  },
49367
49730
  include: {
49368
49731
  items: {
49369
- enum: ["spaces", "devices", "acs_entrances"],
49732
+ enum: [
49733
+ "spaces",
49734
+ "devices",
49735
+ "acs_entrances",
49736
+ "connected_accounts",
49737
+ "acs_systems"
49738
+ ],
49370
49739
  type: "string"
49371
49740
  },
49372
49741
  type: "array"
@@ -49390,20 +49759,22 @@ var openapi_default = {
49390
49759
  schema: {
49391
49760
  properties: {
49392
49761
  batch: {
49393
- description: "Represents a resource batch.",
49762
+ description: "ID of the affected access system user.",
49394
49763
  properties: {
49395
49764
  acs_entrances: {
49396
49765
  items: { $ref: "#/components/schemas/acs_entrance" },
49397
49766
  type: "array"
49398
49767
  },
49399
- batch_type: {
49400
- enum: [
49401
- "workspaces",
49402
- "access_grants",
49403
- "access_methods",
49404
- "spaces"
49405
- ],
49406
- type: "string"
49768
+ acs_systems: {
49769
+ items: { $ref: "#/components/schemas/acs_system" },
49770
+ type: "array"
49771
+ },
49772
+ batch_type: { enum: ["spaces"], type: "string" },
49773
+ connected_accounts: {
49774
+ items: {
49775
+ $ref: "#/components/schemas/connected_account"
49776
+ },
49777
+ type: "array"
49407
49778
  },
49408
49779
  devices: {
49409
49780
  items: { $ref: "#/components/schemas/device" },
@@ -49412,19 +49783,10 @@ var openapi_default = {
49412
49783
  spaces: {
49413
49784
  items: { $ref: "#/components/schemas/space" },
49414
49785
  type: "array"
49415
- },
49416
- user_identities: {
49417
- items: { $ref: "#/components/schemas/user_identity" },
49418
- type: "array"
49419
- },
49420
- workspaces: {
49421
- items: { $ref: "#/components/schemas/workspace" },
49422
- type: "array"
49423
49786
  }
49424
49787
  },
49425
49788
  required: ["batch_type"],
49426
- type: "object",
49427
- "x-route-path": "/"
49789
+ type: "object"
49428
49790
  },
49429
49791
  ok: { type: "boolean" }
49430
49792
  },