@seamapi/types 1.379.1 → 1.380.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 (28) hide show
  1. package/dist/connect.cjs +401 -32
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +533 -51
  4. package/lib/seam/connect/models/access-grants/access-grant.d.ts +8 -13
  5. package/lib/seam/connect/models/access-grants/access-grant.js +4 -4
  6. package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
  7. package/lib/seam/connect/models/access-grants/access-method.d.ts +6 -3
  8. package/lib/seam/connect/models/access-grants/access-method.js +4 -2
  9. package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
  10. package/lib/seam/connect/models/access-grants/requested-access-method.d.ts +18 -0
  11. package/lib/seam/connect/models/access-grants/requested-access-method.js +19 -0
  12. package/lib/seam/connect/models/access-grants/requested-access-method.js.map +1 -0
  13. package/lib/seam/connect/models/devices/device-metadata.d.ts +0 -5
  14. package/lib/seam/connect/models/devices/device-metadata.js +0 -1
  15. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.d.ts +0 -7
  17. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +0 -5
  18. package/lib/seam/connect/openapi.d.ts +415 -16
  19. package/lib/seam/connect/openapi.js +400 -30
  20. package/lib/seam/connect/openapi.js.map +1 -1
  21. package/lib/seam/connect/route-types.d.ts +118 -23
  22. package/package.json +1 -1
  23. package/src/lib/seam/connect/models/access-grants/access-grant.ts +4 -4
  24. package/src/lib/seam/connect/models/access-grants/access-method.ts +6 -2
  25. package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +25 -0
  26. package/src/lib/seam/connect/models/devices/device-metadata.ts +0 -1
  27. package/src/lib/seam/connect/openapi.ts +428 -32
  28. package/src/lib/seam/connect/route-types.ts +123 -30
package/dist/connect.cjs CHANGED
@@ -618,7 +618,6 @@ var device_metadata = zod.z.object({
618
618
  schlage_metadata: zod.z.object({
619
619
  device_id: zod.z.string(),
620
620
  device_name: zod.z.string(),
621
- access_code_length: zod.z.number().nullable(),
622
621
  model: zod.z.string().optional()
623
622
  }),
624
623
  smartthings_metadata: zod.z.object({
@@ -11431,20 +11430,11 @@ var openapi_default = {
11431
11430
  },
11432
11431
  schlage_metadata: {
11433
11432
  properties: {
11434
- access_code_length: {
11435
- format: "float",
11436
- nullable: true,
11437
- type: "number"
11438
- },
11439
11433
  device_id: { type: "string" },
11440
11434
  device_name: { type: "string" },
11441
11435
  model: { type: "string" }
11442
11436
  },
11443
- required: [
11444
- "device_id",
11445
- "device_name",
11446
- "access_code_length"
11447
- ],
11437
+ required: ["device_id", "device_name"],
11448
11438
  type: "object"
11449
11439
  },
11450
11440
  seam_bridge_metadata: {
@@ -32294,6 +32284,7 @@ var openapi_default = {
32294
32284
  type: "string"
32295
32285
  }
32296
32286
  },
32287
+ required: ["user_identity_id"],
32297
32288
  type: "object"
32298
32289
  },
32299
32290
  {
@@ -32318,10 +32309,10 @@ var openapi_default = {
32318
32309
  type: "string"
32319
32310
  }
32320
32311
  },
32321
- type: "object",
32322
- "x-route-path": "/user_identities"
32312
+ type: "object"
32323
32313
  }
32324
32314
  },
32315
+ required: ["user_identity"],
32325
32316
  type: "object"
32326
32317
  }
32327
32318
  ]
@@ -32397,16 +32388,26 @@ var openapi_default = {
32397
32388
  format: "uuid",
32398
32389
  type: "string"
32399
32390
  },
32400
- access_methods: {
32401
- description: "Access methods associated with this access grant.",
32391
+ created_at: {
32392
+ description: "Date and time at which the access grant was created.",
32393
+ format: "date-time",
32394
+ type: "string"
32395
+ },
32396
+ display_name: {
32397
+ description: "Display name of the access grant.",
32398
+ type: "string"
32399
+ },
32400
+ location_ids: {
32401
+ description: "IDs of the locations to which access is being given.",
32402
+ items: { format: "uuid", type: "string" },
32403
+ type: "array"
32404
+ },
32405
+ requested_access_methods: {
32406
+ description: "Access methods that the user requested for this access grant.",
32402
32407
  items: {
32403
32408
  properties: {
32404
- access_method_key: {
32405
- description: "Key for the access method - unique within an access grant.",
32406
- type: "string"
32407
- },
32408
32409
  created_at: {
32409
- description: "Date and time at which the access method was created.",
32410
+ description: "Date and time at which the requested access method was added to this access grant.",
32410
32411
  format: "date-time",
32411
32412
  type: "string"
32412
32413
  },
@@ -32414,30 +32415,112 @@ var openapi_default = {
32414
32415
  description: "Display name of the access method.",
32415
32416
  type: "string"
32416
32417
  },
32417
- issued_at: {
32418
- description: "Date and time at which the access method was issued.",
32419
- format: "date-time",
32420
- nullable: true,
32421
- type: "string"
32422
- },
32423
32418
  mode: {
32424
32419
  description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
32425
32420
  enum: ["code", "card", "mobile_key"],
32426
32421
  type: "string"
32422
+ },
32423
+ provisioned_access_method_ids: {
32424
+ description: "IDs of the locations to which access is being given.",
32425
+ items: { format: "uuid", type: "string" },
32426
+ type: "array"
32427
32427
  }
32428
32428
  },
32429
32429
  required: [
32430
- "access_method_key",
32431
32430
  "display_name",
32432
32431
  "mode",
32433
32432
  "created_at",
32434
- "issued_at"
32433
+ "provisioned_access_method_ids"
32435
32434
  ],
32436
32435
  type: "object",
32437
32436
  "x-undocumented": "Unreleased."
32438
32437
  },
32439
32438
  type: "array"
32440
32439
  },
32440
+ user_identity_id: {
32441
+ description: "ID of user identity to which access is being granted.",
32442
+ format: "uuid",
32443
+ type: "string"
32444
+ },
32445
+ workspace_id: {
32446
+ description: "Unique identifier for the Seam workspace associated with the access grant.",
32447
+ format: "uuid",
32448
+ type: "string"
32449
+ }
32450
+ },
32451
+ required: [
32452
+ "workspace_id",
32453
+ "access_grant_id",
32454
+ "user_identity_id",
32455
+ "location_ids",
32456
+ "requested_access_methods",
32457
+ "display_name",
32458
+ "created_at"
32459
+ ],
32460
+ type: "object",
32461
+ "x-undocumented": "Unreleased."
32462
+ },
32463
+ ok: { type: "boolean" }
32464
+ },
32465
+ required: ["access_grant", "ok"],
32466
+ type: "object"
32467
+ }
32468
+ }
32469
+ },
32470
+ description: "OK"
32471
+ },
32472
+ 400: { description: "Bad Request" },
32473
+ 401: { description: "Unauthorized" }
32474
+ },
32475
+ security: [
32476
+ { pat_with_workspace: [] },
32477
+ { console_session_with_workspace: [] },
32478
+ { api_key: [] }
32479
+ ],
32480
+ summary: "/unstable_access_grants/create",
32481
+ tags: [],
32482
+ "x-fern-sdk-group-name": ["unstable_access_grants"],
32483
+ "x-fern-sdk-method-name": "create",
32484
+ "x-fern-sdk-return-value": "access_grant",
32485
+ "x-response-key": "access_grant",
32486
+ "x-title": "Create an Access Grant",
32487
+ "x-undocumented": "Unreleased."
32488
+ }
32489
+ },
32490
+ "/unstable_access_grants/get": {
32491
+ post: {
32492
+ description: "Get an access grant.",
32493
+ operationId: "unstableAccessGrantsGetPost",
32494
+ requestBody: {
32495
+ content: {
32496
+ "application/json": {
32497
+ schema: {
32498
+ properties: {
32499
+ access_grant_id: {
32500
+ description: "ID of access grant to get.",
32501
+ format: "uuid",
32502
+ type: "string"
32503
+ }
32504
+ },
32505
+ required: ["access_grant_id"],
32506
+ type: "object"
32507
+ }
32508
+ }
32509
+ }
32510
+ },
32511
+ responses: {
32512
+ 200: {
32513
+ content: {
32514
+ "application/json": {
32515
+ schema: {
32516
+ properties: {
32517
+ access_grant: {
32518
+ properties: {
32519
+ access_grant_id: {
32520
+ description: "ID of the access grant.",
32521
+ format: "uuid",
32522
+ type: "string"
32523
+ },
32441
32524
  created_at: {
32442
32525
  description: "Date and time at which the access grant was created.",
32443
32526
  format: "date-time",
@@ -32452,6 +32535,41 @@ var openapi_default = {
32452
32535
  items: { format: "uuid", type: "string" },
32453
32536
  type: "array"
32454
32537
  },
32538
+ requested_access_methods: {
32539
+ description: "Access methods that the user requested for this access grant.",
32540
+ items: {
32541
+ properties: {
32542
+ created_at: {
32543
+ description: "Date and time at which the requested access method was added to this access grant.",
32544
+ format: "date-time",
32545
+ type: "string"
32546
+ },
32547
+ display_name: {
32548
+ description: "Display name of the access method.",
32549
+ type: "string"
32550
+ },
32551
+ mode: {
32552
+ description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
32553
+ enum: ["code", "card", "mobile_key"],
32554
+ type: "string"
32555
+ },
32556
+ provisioned_access_method_ids: {
32557
+ description: "IDs of the locations to which access is being given.",
32558
+ items: { format: "uuid", type: "string" },
32559
+ type: "array"
32560
+ }
32561
+ },
32562
+ required: [
32563
+ "display_name",
32564
+ "mode",
32565
+ "created_at",
32566
+ "provisioned_access_method_ids"
32567
+ ],
32568
+ type: "object",
32569
+ "x-undocumented": "Unreleased."
32570
+ },
32571
+ type: "array"
32572
+ },
32455
32573
  user_identity_id: {
32456
32574
  description: "ID of user identity to which access is being granted.",
32457
32575
  format: "uuid",
@@ -32468,7 +32586,7 @@ var openapi_default = {
32468
32586
  "access_grant_id",
32469
32587
  "user_identity_id",
32470
32588
  "location_ids",
32471
- "access_methods",
32589
+ "requested_access_methods",
32472
32590
  "display_name",
32473
32591
  "created_at"
32474
32592
  ],
@@ -32492,13 +32610,264 @@ var openapi_default = {
32492
32610
  { console_session_with_workspace: [] },
32493
32611
  { api_key: [] }
32494
32612
  ],
32495
- summary: "/unstable_access_grants/create",
32613
+ summary: "/unstable_access_grants/get",
32496
32614
  tags: [],
32497
32615
  "x-fern-sdk-group-name": ["unstable_access_grants"],
32498
- "x-fern-sdk-method-name": "create",
32616
+ "x-fern-sdk-method-name": "get",
32499
32617
  "x-fern-sdk-return-value": "access_grant",
32500
32618
  "x-response-key": "access_grant",
32501
- "x-title": "Create an Access Grant",
32619
+ "x-title": "Get an Access Grant",
32620
+ "x-undocumented": "Unreleased."
32621
+ }
32622
+ },
32623
+ "/unstable_access_grants/list": {
32624
+ post: {
32625
+ description: "Get an access grant.",
32626
+ operationId: "unstableAccessGrantsListPost",
32627
+ requestBody: {
32628
+ content: {
32629
+ "application/json": {
32630
+ schema: {
32631
+ properties: {
32632
+ acs_entrance_id: {
32633
+ description: "ID of entrance to filter list of access grants by.",
32634
+ format: "uuid",
32635
+ type: "string"
32636
+ },
32637
+ acs_system_id: {
32638
+ description: "ID of system to filter list of access grants by.",
32639
+ format: "uuid",
32640
+ type: "string"
32641
+ },
32642
+ location_id: {
32643
+ description: "ID of location to filter list of access grants by.",
32644
+ format: "uuid",
32645
+ type: "string"
32646
+ },
32647
+ user_identity_id: {
32648
+ description: "ID of user identity to filter list of access grants by.",
32649
+ format: "uuid",
32650
+ type: "string"
32651
+ }
32652
+ },
32653
+ type: "object"
32654
+ }
32655
+ }
32656
+ }
32657
+ },
32658
+ responses: {
32659
+ 200: {
32660
+ content: {
32661
+ "application/json": {
32662
+ schema: {
32663
+ properties: {
32664
+ access_grants: {
32665
+ items: {
32666
+ properties: {
32667
+ access_grant_id: {
32668
+ description: "ID of the access grant.",
32669
+ format: "uuid",
32670
+ type: "string"
32671
+ },
32672
+ created_at: {
32673
+ description: "Date and time at which the access grant was created.",
32674
+ format: "date-time",
32675
+ type: "string"
32676
+ },
32677
+ display_name: {
32678
+ description: "Display name of the access grant.",
32679
+ type: "string"
32680
+ },
32681
+ location_ids: {
32682
+ description: "IDs of the locations to which access is being given.",
32683
+ items: { format: "uuid", type: "string" },
32684
+ type: "array"
32685
+ },
32686
+ requested_access_methods: {
32687
+ description: "Access methods that the user requested for this access grant.",
32688
+ items: {
32689
+ properties: {
32690
+ created_at: {
32691
+ description: "Date and time at which the requested access method was added to this access grant.",
32692
+ format: "date-time",
32693
+ type: "string"
32694
+ },
32695
+ display_name: {
32696
+ description: "Display name of the access method.",
32697
+ type: "string"
32698
+ },
32699
+ mode: {
32700
+ description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
32701
+ enum: ["code", "card", "mobile_key"],
32702
+ type: "string"
32703
+ },
32704
+ provisioned_access_method_ids: {
32705
+ description: "IDs of the locations to which access is being given.",
32706
+ items: { format: "uuid", type: "string" },
32707
+ type: "array"
32708
+ }
32709
+ },
32710
+ required: [
32711
+ "display_name",
32712
+ "mode",
32713
+ "created_at",
32714
+ "provisioned_access_method_ids"
32715
+ ],
32716
+ type: "object",
32717
+ "x-undocumented": "Unreleased."
32718
+ },
32719
+ type: "array"
32720
+ },
32721
+ user_identity_id: {
32722
+ description: "ID of user identity to which access is being granted.",
32723
+ format: "uuid",
32724
+ type: "string"
32725
+ },
32726
+ workspace_id: {
32727
+ description: "Unique identifier for the Seam workspace associated with the access grant.",
32728
+ format: "uuid",
32729
+ type: "string"
32730
+ }
32731
+ },
32732
+ required: [
32733
+ "workspace_id",
32734
+ "access_grant_id",
32735
+ "user_identity_id",
32736
+ "location_ids",
32737
+ "requested_access_methods",
32738
+ "display_name",
32739
+ "created_at"
32740
+ ],
32741
+ type: "object",
32742
+ "x-undocumented": "Unreleased."
32743
+ },
32744
+ type: "array"
32745
+ },
32746
+ ok: { type: "boolean" }
32747
+ },
32748
+ required: ["access_grants", "ok"],
32749
+ type: "object"
32750
+ }
32751
+ }
32752
+ },
32753
+ description: "OK"
32754
+ },
32755
+ 400: { description: "Bad Request" },
32756
+ 401: { description: "Unauthorized" }
32757
+ },
32758
+ security: [
32759
+ { pat_with_workspace: [] },
32760
+ { console_session_with_workspace: [] },
32761
+ { api_key: [] }
32762
+ ],
32763
+ summary: "/unstable_access_grants/list",
32764
+ tags: [],
32765
+ "x-fern-sdk-group-name": ["unstable_access_grants"],
32766
+ "x-fern-sdk-method-name": "list",
32767
+ "x-fern-sdk-return-value": "access_grants",
32768
+ "x-response-key": "access_grants",
32769
+ "x-title": "List Access Grants",
32770
+ "x-undocumented": "Unreleased."
32771
+ }
32772
+ },
32773
+ "/unstable_access_grants/list_access_methods": {
32774
+ post: {
32775
+ description: "List all access methods for an access grant.",
32776
+ operationId: "unstableAccessGrantsListAccessMethodsPost",
32777
+ requestBody: {
32778
+ content: {
32779
+ "application/json": {
32780
+ schema: {
32781
+ properties: {
32782
+ access_grant_id: {
32783
+ description: "ID of access grant to list access methods for.",
32784
+ format: "uuid",
32785
+ type: "string"
32786
+ }
32787
+ },
32788
+ required: ["access_grant_id"],
32789
+ type: "object"
32790
+ }
32791
+ }
32792
+ }
32793
+ },
32794
+ responses: {
32795
+ 200: {
32796
+ content: {
32797
+ "application/json": {
32798
+ schema: {
32799
+ properties: {
32800
+ access_methods: {
32801
+ items: {
32802
+ properties: {
32803
+ access_method_id: {
32804
+ description: "ID of the access method.",
32805
+ format: "uuid",
32806
+ type: "string"
32807
+ },
32808
+ created_at: {
32809
+ description: "Date and time at which the access method was created.",
32810
+ format: "date-time",
32811
+ type: "string"
32812
+ },
32813
+ display_name: {
32814
+ description: "Display name of the access method.",
32815
+ type: "string"
32816
+ },
32817
+ issued_at: {
32818
+ description: "Date and time at which the access method was issued.",
32819
+ format: "date-time",
32820
+ nullable: true,
32821
+ type: "string"
32822
+ },
32823
+ mode: {
32824
+ description: "Access method mode. Supported values: `code`, `card`, `mobile_key`.",
32825
+ enum: ["code", "card", "mobile_key"],
32826
+ type: "string"
32827
+ },
32828
+ workspace_id: {
32829
+ description: "Unique identifier for the Seam workspace associated with the access grant.",
32830
+ format: "uuid",
32831
+ type: "string"
32832
+ }
32833
+ },
32834
+ required: [
32835
+ "workspace_id",
32836
+ "access_method_id",
32837
+ "display_name",
32838
+ "mode",
32839
+ "created_at",
32840
+ "issued_at"
32841
+ ],
32842
+ type: "object",
32843
+ "x-undocumented": "Unreleased."
32844
+ },
32845
+ type: "array"
32846
+ },
32847
+ ok: { type: "boolean" }
32848
+ },
32849
+ required: ["access_methods", "ok"],
32850
+ type: "object"
32851
+ }
32852
+ }
32853
+ },
32854
+ description: "OK"
32855
+ },
32856
+ 400: { description: "Bad Request" },
32857
+ 401: { description: "Unauthorized" }
32858
+ },
32859
+ security: [
32860
+ { pat_with_workspace: [] },
32861
+ { console_session_with_workspace: [] },
32862
+ { api_key: [] }
32863
+ ],
32864
+ summary: "/unstable_access_grants/list_access_methods",
32865
+ tags: [],
32866
+ "x-fern-sdk-group-name": ["unstable_access_grants"],
32867
+ "x-fern-sdk-method-name": "list_access_methods",
32868
+ "x-fern-sdk-return-value": "access_methods",
32869
+ "x-response-key": "access_methods",
32870
+ "x-title": "Get the Access Methods for an Access Grant",
32502
32871
  "x-undocumented": "Unreleased."
32503
32872
  }
32504
32873
  },