@seamapi/types 1.444.1 → 1.445.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 (26) hide show
  1. package/dist/connect.cjs +75 -73
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +114 -125
  4. package/dist/index.cjs +75 -73
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-grants/access-grant.js +12 -12
  7. package/lib/seam/connect/models/access-grants/access-method.js +1 -1
  8. package/lib/seam/connect/models/access-grants/requested-access-method.js +1 -1
  9. package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +3 -0
  10. package/lib/seam/connect/models/connect-webviews/connect-webview.js +4 -0
  11. package/lib/seam/connect/models/connect-webviews/connect-webview.js.map +1 -1
  12. package/lib/seam/connect/models/events/access-grants.js +6 -6
  13. package/lib/seam/connect/models/events/access-methods.js +1 -1
  14. package/lib/seam/connect/openapi.d.ts +6 -26
  15. package/lib/seam/connect/openapi.js +66 -65
  16. package/lib/seam/connect/openapi.js.map +1 -1
  17. package/lib/seam/connect/route-types.d.ts +105 -99
  18. package/package.json +1 -1
  19. package/src/lib/seam/connect/models/access-grants/access-grant.ts +12 -12
  20. package/src/lib/seam/connect/models/access-grants/access-method.ts +1 -1
  21. package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +1 -1
  22. package/src/lib/seam/connect/models/connect-webviews/connect-webview.ts +4 -0
  23. package/src/lib/seam/connect/models/events/access-grants.ts +6 -6
  24. package/src/lib/seam/connect/models/events/access-methods.ts +1 -1
  25. package/src/lib/seam/connect/openapi.ts +71 -65
  26. package/src/lib/seam/connect/route-types.ts +105 -99
package/lib/seam/connect/openapi.js CHANGED
@@ -1569,34 +1569,34 @@ export default {
1569
1569
  'x-route-path': '/access_codes',
1570
1570
  },
1571
1571
  access_grant: {
1572
- description: 'Represents an access grant. Access grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an access grant for an existing user identity, or you can create a new user identity *while* creating the new access grant.',
1572
+ description: 'Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant.',
1573
1573
  properties: {
1574
1574
  access_grant_id: {
1575
- description: 'ID of the access grant.',
1575
+ description: 'ID of the Access Grant.',
1576
1576
  format: 'uuid',
1577
1577
  type: 'string',
1578
1578
  },
1579
1579
  access_method_ids: {
1580
- description: 'IDs of the access methods created for the access grant.',
1580
+ description: 'IDs of the access methods created for the Access Grant.',
1581
1581
  items: { format: 'uuid', type: 'string' },
1582
1582
  type: 'array',
1583
1583
  },
1584
1584
  created_at: {
1585
- description: 'Date and time at which the access grant was created.',
1585
+ description: 'Date and time at which the Access Grant was created.',
1586
1586
  format: 'date-time',
1587
1587
  type: 'string',
1588
1588
  },
1589
1589
  display_name: {
1590
- description: 'Display name of the access grant.',
1590
+ description: 'Display name of the Access Grant.',
1591
1591
  type: 'string',
1592
1592
  },
1593
1593
  ends_at: {
1594
- description: 'Date and time at which the access grant ends.',
1594
+ description: 'Date and time at which the Access Grant ends.',
1595
1595
  format: 'date-time',
1596
1596
  type: 'string',
1597
1597
  },
1598
1598
  instant_key_url: {
1599
- description: 'Instant Key URL. Only returned if the access grant has a single mobile_key access_method. ',
1599
+ description: 'Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. ',
1600
1600
  format: 'uri',
1601
1601
  type: 'string',
1602
1602
  },
@@ -1607,7 +1607,7 @@ export default {
1607
1607
  'x-deprecated': 'Use `space_ids`.',
1608
1608
  },
1609
1609
  requested_access_methods: {
1610
- description: 'Access methods that the user requested for the access grant.',
1610
+ description: 'Access methods that the user requested for the Access Grant.',
1611
1611
  items: {
1612
1612
  properties: {
1613
1613
  created_access_method_ids: {
@@ -1616,7 +1616,7 @@ export default {
1616
1616
  type: 'array',
1617
1617
  },
1618
1618
  created_at: {
1619
- description: 'Date and time at which the requested access method was added to the access grant.',
1619
+ description: 'Date and time at which the requested access method was added to the Access Grant.',
1620
1620
  format: 'date-time',
1621
1621
  type: 'string',
1622
1622
  },
@@ -1641,22 +1641,22 @@ export default {
1641
1641
  type: 'array',
1642
1642
  },
1643
1643
  space_ids: {
1644
- description: 'IDs of the spaces to which the access grant gives access.',
1644
+ description: 'IDs of the spaces to which the Access Grant gives access.',
1645
1645
  items: { format: 'uuid', type: 'string' },
1646
1646
  type: 'array',
1647
1647
  },
1648
1648
  starts_at: {
1649
- description: 'Date and time at which the access grant starts.',
1649
+ description: 'Date and time at which the Access Grant starts.',
1650
1650
  format: 'date-time',
1651
1651
  type: 'string',
1652
1652
  },
1653
1653
  user_identity_id: {
1654
- description: 'ID of user identity to which the access grant gives access.',
1654
+ description: 'ID of user identity to which the Access Grant gives access.',
1655
1655
  format: 'uuid',
1656
1656
  type: 'string',
1657
1657
  },
1658
1658
  workspace_id: {
1659
- description: 'ID of the Seam workspace associated with the access grant.',
1659
+ description: 'ID of the Seam workspace associated with the Access Grant.',
1660
1660
  format: 'uuid',
1661
1661
  type: 'string',
1662
1662
  },
@@ -1677,7 +1677,7 @@ export default {
1677
1677
  'x-route-path': '/access_grants',
1678
1678
  },
1679
1679
  access_method: {
1680
- description: 'Represents an access method for an access grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.',
1680
+ description: 'Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key.',
1681
1681
  properties: {
1682
1682
  access_method_id: {
1683
1683
  description: 'ID of the access method.',
@@ -7633,6 +7633,10 @@ export default {
7633
7633
  nullable: true,
7634
7634
  type: 'string',
7635
7635
  },
7636
+ customer_key: {
7637
+ description: 'The customer key associated with this webview, if any.',
7638
+ type: 'string',
7639
+ },
7636
7640
  device_selection_mode: {
7637
7641
  enum: ['none', 'single', 'multiple'],
7638
7642
  type: 'string',
@@ -12644,10 +12648,10 @@ export default {
12644
12648
  'x-route-path': '/access_codes/unmanaged',
12645
12649
  },
12646
12650
  {
12647
- description: 'An access grant was created.',
12651
+ description: 'An Access Grant was created.',
12648
12652
  properties: {
12649
12653
  access_grant_id: {
12650
- description: 'ID of the affected access grant.',
12654
+ description: 'ID of the affected Access Grant.',
12651
12655
  format: 'uuid',
12652
12656
  type: 'string',
12653
12657
  },
@@ -12685,10 +12689,10 @@ export default {
12685
12689
  'x-route-path': '/access_grants',
12686
12690
  },
12687
12691
  {
12688
- description: 'An access grant was deleted.',
12692
+ description: 'An Access Grant was deleted.',
12689
12693
  properties: {
12690
12694
  access_grant_id: {
12691
- description: 'ID of the affected access grant.',
12695
+ description: 'ID of the affected Access Grant.',
12692
12696
  format: 'uuid',
12693
12697
  type: 'string',
12694
12698
  },
@@ -12726,10 +12730,10 @@ export default {
12726
12730
  'x-route-path': '/access_grants',
12727
12731
  },
12728
12732
  {
12729
- description: 'All access requested for an access grant was successfully granted.',
12733
+ description: 'All access requested for an Access Grant was successfully granted.',
12730
12734
  properties: {
12731
12735
  access_grant_id: {
12732
- description: 'ID of the affected access grant.',
12736
+ description: 'ID of the affected Access Grant.',
12733
12737
  format: 'uuid',
12734
12738
  type: 'string',
12735
12739
  },
@@ -12770,10 +12774,10 @@ export default {
12770
12774
  'x-route-path': '/access_grants',
12771
12775
  },
12772
12776
  {
12773
- description: 'Access requested as part of an access grant to a particular door was successfully granted.',
12777
+ description: 'Access requested as part of an Access Grant to a particular door was successfully granted.',
12774
12778
  properties: {
12775
12779
  access_grant_id: {
12776
- description: 'ID of the affected access grant.',
12780
+ description: 'ID of the affected Access Grant.',
12777
12781
  format: 'uuid',
12778
12782
  type: 'string',
12779
12783
  },
@@ -12820,10 +12824,10 @@ export default {
12820
12824
  'x-route-path': '/access_grants',
12821
12825
  },
12822
12826
  {
12823
- description: 'Access to a particular door that was requested as part of an access grant was lost.',
12827
+ description: 'Access to a particular door that was requested as part of an Access Grant was lost.',
12824
12828
  properties: {
12825
12829
  access_grant_id: {
12826
- description: 'ID of the affected access grant.',
12830
+ description: 'ID of the affected Access Grant.',
12827
12831
  format: 'uuid',
12828
12832
  type: 'string',
12829
12833
  },
@@ -13037,7 +13041,7 @@ export default {
13037
13041
  'x-route-path': '/access_methods',
13038
13042
  },
13039
13043
  {
13040
- description: 'An access method was reissued due to an access grant update.',
13044
+ description: 'An access method was reissued due to an Access Grant update.',
13041
13045
  properties: {
13042
13046
  access_method_id: {
13043
13047
  description: 'ID of the affected access method.',
@@ -24690,7 +24694,7 @@ export default {
24690
24694
  },
24691
24695
  '/access_grants/create': {
24692
24696
  post: {
24693
- description: 'Creates a new access grant.',
24697
+ description: 'Creates a new Access Grant.',
24694
24698
  operationId: 'accessGrantsCreatePost',
24695
24699
  requestBody: {
24696
24700
  content: {
@@ -24857,7 +24861,7 @@ export default {
24857
24861
  },
24858
24862
  '/access_grants/delete': {
24859
24863
  delete: {
24860
- description: 'Delete an access grant.',
24864
+ description: 'Delete an Access Grant.',
24861
24865
  operationId: 'accessGrantsDeleteDelete',
24862
24866
  parameters: [
24863
24867
  {
@@ -24865,7 +24869,7 @@ export default {
24865
24869
  name: 'access_grant_id',
24866
24870
  required: true,
24867
24871
  schema: {
24868
- description: 'ID of access grant to delete.',
24872
+ description: 'ID of Access Grant to delete.',
24869
24873
  format: 'uuid',
24870
24874
  type: 'string',
24871
24875
  },
@@ -24902,7 +24906,7 @@ export default {
24902
24906
  'x-title': 'Delete an Access Grant',
24903
24907
  },
24904
24908
  post: {
24905
- description: 'Delete an access grant.',
24909
+ description: 'Delete an Access Grant.',
24906
24910
  operationId: 'accessGrantsDeletePost',
24907
24911
  requestBody: {
24908
24912
  content: {
@@ -24910,7 +24914,7 @@ export default {
24910
24914
  schema: {
24911
24915
  properties: {
24912
24916
  access_grant_id: {
24913
- description: 'ID of access grant to delete.',
24917
+ description: 'ID of Access Grant to delete.',
24914
24918
  format: 'uuid',
24915
24919
  type: 'string',
24916
24920
  },
@@ -24954,7 +24958,7 @@ export default {
24954
24958
  },
24955
24959
  '/access_grants/get': {
24956
24960
  get: {
24957
- description: 'Get an access grant.',
24961
+ description: 'Get an Access Grant.',
24958
24962
  operationId: 'accessGrantsGetGet',
24959
24963
  parameters: [
24960
24964
  {
@@ -24962,7 +24966,7 @@ export default {
24962
24966
  name: 'access_grant_id',
24963
24967
  required: true,
24964
24968
  schema: {
24965
- description: 'ID of access grant to get.',
24969
+ description: 'ID of Access Grant to get.',
24966
24970
  format: 'uuid',
24967
24971
  type: 'string',
24968
24972
  },
@@ -25003,7 +25007,7 @@ export default {
25003
25007
  'x-title': 'Get an Access Grant',
25004
25008
  },
25005
25009
  post: {
25006
- description: 'Get an access grant.',
25010
+ description: 'Get an Access Grant.',
25007
25011
  operationId: 'accessGrantsGetPost',
25008
25012
  requestBody: {
25009
25013
  content: {
@@ -25011,7 +25015,7 @@ export default {
25011
25015
  schema: {
25012
25016
  properties: {
25013
25017
  access_grant_id: {
25014
- description: 'ID of access grant to get.',
25018
+ description: 'ID of Access Grant to get.',
25015
25019
  format: 'uuid',
25016
25020
  type: 'string',
25017
25021
  },
@@ -25059,14 +25063,14 @@ export default {
25059
25063
  },
25060
25064
  '/access_grants/list': {
25061
25065
  get: {
25062
- description: 'Get an access grant.',
25066
+ description: 'Gets an Access Grant.',
25063
25067
  operationId: 'accessGrantsListGet',
25064
25068
  parameters: [
25065
25069
  {
25066
25070
  in: 'query',
25067
25071
  name: 'user_identity_id',
25068
25072
  schema: {
25069
- description: 'ID of user identity to filter list of access grants by.',
25073
+ description: 'ID of user identity by which you want to filter the list of Access Grants.',
25070
25074
  format: 'uuid',
25071
25075
  type: 'string',
25072
25076
  },
@@ -25075,7 +25079,7 @@ export default {
25075
25079
  in: 'query',
25076
25080
  name: 'acs_system_id',
25077
25081
  schema: {
25078
- description: 'ID of system to filter list of access grants by.',
25082
+ description: 'ID of the access system by which you want to filter the list of Access Grants.',
25079
25083
  format: 'uuid',
25080
25084
  type: 'string',
25081
25085
  },
@@ -25084,7 +25088,7 @@ export default {
25084
25088
  in: 'query',
25085
25089
  name: 'acs_entrance_id',
25086
25090
  schema: {
25087
- description: 'ID of entrance to filter list of access grants by.',
25091
+ description: 'ID of the entrance by which you want to filter the list of Access Grants.',
25088
25092
  format: 'uuid',
25089
25093
  type: 'string',
25090
25094
  },
@@ -25103,7 +25107,7 @@ export default {
25103
25107
  in: 'query',
25104
25108
  name: 'space_id',
25105
25109
  schema: {
25106
- description: 'ID of space to filter list of access grants by.',
25110
+ description: 'ID of the space by which you want to filter the list of Access Grants.',
25107
25111
  format: 'uuid',
25108
25112
  type: 'string',
25109
25113
  },
@@ -25147,7 +25151,7 @@ export default {
25147
25151
  'x-title': 'List Access Grants',
25148
25152
  },
25149
25153
  post: {
25150
- description: 'Get an access grant.',
25154
+ description: 'Gets an Access Grant.',
25151
25155
  operationId: 'accessGrantsListPost',
25152
25156
  requestBody: {
25153
25157
  content: {
@@ -25155,12 +25159,12 @@ export default {
25155
25159
  schema: {
25156
25160
  properties: {
25157
25161
  acs_entrance_id: {
25158
- description: 'ID of entrance to filter list of access grants by.',
25162
+ description: 'ID of the entrance by which you want to filter the list of Access Grants.',
25159
25163
  format: 'uuid',
25160
25164
  type: 'string',
25161
25165
  },
25162
25166
  acs_system_id: {
25163
- description: 'ID of system to filter list of access grants by.',
25167
+ description: 'ID of the access system by which you want to filter the list of Access Grants.',
25164
25168
  format: 'uuid',
25165
25169
  type: 'string',
25166
25170
  },
@@ -25171,12 +25175,12 @@ export default {
25171
25175
  'x-deprecated': 'Use `space_id`.',
25172
25176
  },
25173
25177
  space_id: {
25174
- description: 'ID of space to filter list of access grants by.',
25178
+ description: 'ID of the space by which you want to filter the list of Access Grants.',
25175
25179
  format: 'uuid',
25176
25180
  type: 'string',
25177
25181
  },
25178
25182
  user_identity_id: {
25179
- description: 'ID of user identity to filter list of access grants by.',
25183
+ description: 'ID of user identity by which you want to filter the list of Access Grants.',
25180
25184
  format: 'uuid',
25181
25185
  type: 'string',
25182
25186
  },
@@ -25226,7 +25230,7 @@ export default {
25226
25230
  },
25227
25231
  '/access_grants/update': {
25228
25232
  patch: {
25229
- description: "Updates an existing access grant's time window.",
25233
+ description: "Updates an existing Access Grant's time window.",
25230
25234
  operationId: 'accessGrantsUpdatePatch',
25231
25235
  requestBody: {
25232
25236
  content: {
@@ -25234,7 +25238,7 @@ export default {
25234
25238
  schema: {
25235
25239
  properties: {
25236
25240
  access_grant_id: {
25237
- description: 'ID of the access grant to update.',
25241
+ description: 'ID of the Access Grant to update.',
25238
25242
  format: 'uuid',
25239
25243
  type: 'string',
25240
25244
  },
@@ -25288,7 +25292,7 @@ export default {
25288
25292
  'x-title': 'Update an Access Grant',
25289
25293
  },
25290
25294
  post: {
25291
- description: "Updates an existing access grant's time window.",
25295
+ description: "Updates an existing Access Grant's time window.",
25292
25296
  operationId: 'accessGrantsUpdatePost',
25293
25297
  requestBody: {
25294
25298
  content: {
@@ -25296,7 +25300,7 @@ export default {
25296
25300
  schema: {
25297
25301
  properties: {
25298
25302
  access_grant_id: {
25299
- description: 'ID of the access grant to update.',
25303
+ description: 'ID of the Access Grant to update.',
25300
25304
  format: 'uuid',
25301
25305
  type: 'string',
25302
25306
  },
@@ -25352,7 +25356,7 @@ export default {
25352
25356
  },
25353
25357
  '/access_methods/delete': {
25354
25358
  delete: {
25355
- description: 'Delete an access method.',
25359
+ description: 'Deletes an access method.',
25356
25360
  operationId: 'accessMethodsDeleteDelete',
25357
25361
  parameters: [
25358
25362
  {
@@ -25396,7 +25400,7 @@ export default {
25396
25400
  'x-title': 'Delete an Access Method',
25397
25401
  },
25398
25402
  post: {
25399
- description: 'Delete an access method.',
25403
+ description: 'Deletes an access method.',
25400
25404
  operationId: 'accessMethodsDeletePost',
25401
25405
  requestBody: {
25402
25406
  content: {
@@ -25447,7 +25451,7 @@ export default {
25447
25451
  },
25448
25452
  '/access_methods/encode': {
25449
25453
  post: {
25450
- description: 'Encodes an existing [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
25454
+ description: 'Encodes an existing access method onto a plastic card placed on the specified [encoder](https://docs.seam.co/latest/capability-guides/access-systems/working-with-card-encoders-and-scanners).',
25451
25455
  operationId: 'accessMethodsEncodePost',
25452
25456
  requestBody: {
25453
25457
  content: {
@@ -25460,7 +25464,7 @@ export default {
25460
25464
  type: 'string',
25461
25465
  },
25462
25466
  acs_encoder_id: {
25463
- description: 'ID of the `acs_encoder` to use to encode the `acs_credential`.',
25467
+ description: 'ID of the `acs_encoder` to use to encode the `access_method`.',
25464
25468
  format: 'uuid',
25465
25469
  type: 'string',
25466
25470
  },
@@ -25509,7 +25513,7 @@ export default {
25509
25513
  },
25510
25514
  '/access_methods/get': {
25511
25515
  get: {
25512
- description: 'Get an access method.',
25516
+ description: 'Gets an access method.',
25513
25517
  operationId: 'accessMethodsGetGet',
25514
25518
  parameters: [
25515
25519
  {
@@ -25559,7 +25563,7 @@ export default {
25559
25563
  'x-title': 'Get an Access Method',
25560
25564
  },
25561
25565
  post: {
25562
- description: 'Get an access method.',
25566
+ description: 'Gets an access method.',
25563
25567
  operationId: 'accessMethodsGetPost',
25564
25568
  requestBody: {
25565
25569
  content: {
@@ -25616,7 +25620,7 @@ export default {
25616
25620
  },
25617
25621
  '/access_methods/list': {
25618
25622
  get: {
25619
- description: 'List all access methods, usually filtered by access grant.',
25623
+ description: 'Lists all access methods, usually filtered by Access Grant.',
25620
25624
  operationId: 'accessMethodsListGet',
25621
25625
  parameters: [
25622
25626
  {
@@ -25624,7 +25628,7 @@ export default {
25624
25628
  name: 'access_grant_id',
25625
25629
  required: true,
25626
25630
  schema: {
25627
- description: 'ID of access grant to list access methods for.',
25631
+ description: 'ID of Access Grant to list access methods for.',
25628
25632
  format: 'uuid',
25629
25633
  type: 'string',
25630
25634
  },
@@ -25697,7 +25701,7 @@ export default {
25697
25701
  'x-title': 'List Access Methods',
25698
25702
  },
25699
25703
  post: {
25700
- description: 'List all access methods, usually filtered by access grant.',
25704
+ description: 'Lists all access methods, usually filtered by Access Grant.',
25701
25705
  operationId: 'accessMethodsListPost',
25702
25706
  requestBody: {
25703
25707
  content: {
@@ -25705,7 +25709,7 @@ export default {
25705
25709
  schema: {
25706
25710
  properties: {
25707
25711
  access_grant_id: {
25708
- description: 'ID of access grant to list access methods for.',
25712
+ description: 'ID of Access Grant to list access methods for.',
25709
25713
  format: 'uuid',
25710
25714
  type: 'string',
25711
25715
  },
@@ -32746,7 +32750,10 @@ export default {
32746
32750
  description: 'URL that you want to redirect the user to after the provider login is complete.',
32747
32751
  type: 'string',
32748
32752
  },
32749
- customer_id: { format: 'uuid', type: 'string' },
32753
+ customer_key: {
32754
+ description: 'Optional unique string key that can be used to identify the customer. If provided, the customer will be created or retrieved based on this key.',
32755
+ type: 'string',
32756
+ },
32750
32757
  device_selection_mode: {
32751
32758
  enum: ['none', 'single', 'multiple'],
32752
32759
  type: 'string',
@@ -33024,11 +33031,6 @@ export default {
33024
33031
  description: 'Returns a list of all [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews).',
33025
33032
  operationId: 'connectWebviewsListGet',
33026
33033
  parameters: [
33027
- {
33028
- in: 'query',
33029
- name: 'customer_ids',
33030
- schema: { items: { type: 'string' }, type: 'array' },
33031
- },
33032
33034
  {
33033
33035
  in: 'query',
33034
33036
  name: 'user_identifier_key',
@@ -33121,7 +33123,6 @@ export default {
33121
33123
  description: 'Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.',
33122
33124
  type: 'object',
33123
33125
  },
33124
- customer_ids: { items: { type: 'string' }, type: 'array' },
33125
33126
  limit: {
33126
33127
  default: 500,
33127
33128
  description: 'Maximum number of records to return per page.',