@seamapi/types 1.456.0 → 1.457.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 (36) hide show
  1. package/dist/connect.cjs +418 -225
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +15440 -3086
  4. package/dist/devicedb.d.cts +56 -56
  5. package/dist/index.cjs +418 -225
  6. package/dist/index.cjs.map +1 -1
  7. package/lib/seam/connect/models/batches/access_grants.d.ts +48 -49
  8. package/lib/seam/connect/models/batches/access_methods.d.ts +5681 -0
  9. package/lib/seam/connect/models/batches/access_methods.js +11 -0
  10. package/lib/seam/connect/models/batches/access_methods.js.map +1 -0
  11. package/lib/seam/connect/models/batches/batch.d.ts +5774 -98
  12. package/lib/seam/connect/models/batches/batch.js +6 -1
  13. package/lib/seam/connect/models/batches/batch.js.map +1 -1
  14. package/lib/seam/connect/models/batches/index.d.ts +1 -0
  15. package/lib/seam/connect/models/batches/index.js +1 -0
  16. package/lib/seam/connect/models/batches/index.js.map +1 -1
  17. package/lib/seam/connect/models/batches/spaces.d.ts +48 -49
  18. package/lib/seam/connect/models/devices/device-metadata.d.ts +22 -22
  19. package/lib/seam/connect/models/devices/device-provider.d.ts +0 -1
  20. package/lib/seam/connect/models/devices/device.d.ts +49 -51
  21. package/lib/seam/connect/models/devices/device.js +16 -7
  22. package/lib/seam/connect/models/devices/device.js.map +1 -1
  23. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +29 -31
  24. package/lib/seam/connect/openapi.d.ts +285 -0
  25. package/lib/seam/connect/openapi.js +390 -1
  26. package/lib/seam/connect/openapi.js.map +1 -1
  27. package/lib/seam/connect/route-types.d.ts +9300 -2903
  28. package/lib/seam/devicedb/models/device-model.d.ts +20 -20
  29. package/lib/seam/devicedb/route-specs.d.ts +41 -41
  30. package/package.json +1 -1
  31. package/src/lib/seam/connect/models/batches/access_methods.ts +14 -0
  32. package/src/lib/seam/connect/models/batches/batch.ts +6 -1
  33. package/src/lib/seam/connect/models/batches/index.ts +1 -0
  34. package/src/lib/seam/connect/models/devices/device.ts +15 -8
  35. package/src/lib/seam/connect/openapi.ts +394 -1
  36. package/src/lib/seam/connect/route-types.ts +9271 -1024
@@ -28063,6 +28063,30 @@ export default {
28063
28063
  required: ['batch_type'],
28064
28064
  type: 'object',
28065
28065
  },
28066
+ {
28067
+ properties: {
28068
+ acs_entrances: {
28069
+ items: {
28070
+ $ref: '#/components/schemas/acs_entrance',
28071
+ },
28072
+ type: 'array',
28073
+ },
28074
+ batch_type: {
28075
+ enum: ['access_methods'],
28076
+ type: 'string',
28077
+ },
28078
+ devices: {
28079
+ items: { $ref: '#/components/schemas/device' },
28080
+ type: 'array',
28081
+ },
28082
+ spaces: {
28083
+ items: { $ref: '#/components/schemas/space' },
28084
+ type: 'array',
28085
+ },
28086
+ },
28087
+ required: ['batch_type'],
28088
+ type: 'object',
28089
+ },
28066
28090
  ],
28067
28091
  'x-route-path': '/',
28068
28092
  },
@@ -28184,6 +28208,30 @@ export default {
28184
28208
  required: ['batch_type'],
28185
28209
  type: 'object',
28186
28210
  },
28211
+ {
28212
+ properties: {
28213
+ acs_entrances: {
28214
+ items: {
28215
+ $ref: '#/components/schemas/acs_entrance',
28216
+ },
28217
+ type: 'array',
28218
+ },
28219
+ batch_type: {
28220
+ enum: ['access_methods'],
28221
+ type: 'string',
28222
+ },
28223
+ devices: {
28224
+ items: { $ref: '#/components/schemas/device' },
28225
+ type: 'array',
28226
+ },
28227
+ spaces: {
28228
+ items: { $ref: '#/components/schemas/space' },
28229
+ type: 'array',
28230
+ },
28231
+ },
28232
+ required: ['batch_type'],
28233
+ type: 'object',
28234
+ },
28187
28235
  ],
28188
28236
  'x-route-path': '/',
28189
28237
  },
@@ -28809,6 +28857,303 @@ export default {
28809
28857
  'x-title': 'Get an Access Method',
28810
28858
  },
28811
28859
  },
28860
+ '/access_methods/get_related': {
28861
+ get: {
28862
+ description:
28863
+ 'Gets all related resources for one or more Access Methods.',
28864
+ operationId: 'accessMethodsGetRelatedGet',
28865
+ parameters: [
28866
+ {
28867
+ in: 'query',
28868
+ name: 'access_method_ids',
28869
+ required: true,
28870
+ schema: {
28871
+ description:
28872
+ 'IDs of the access methods that you want to get along with their related resources.',
28873
+ items: { format: 'uuid', type: 'string' },
28874
+ type: 'array',
28875
+ },
28876
+ },
28877
+ {
28878
+ in: 'query',
28879
+ name: 'include',
28880
+ required: false,
28881
+ schema: {
28882
+ items: {
28883
+ enum: ['spaces', 'devices', 'acs_entrances'],
28884
+ type: 'string',
28885
+ },
28886
+ type: 'array',
28887
+ },
28888
+ },
28889
+ {
28890
+ in: 'query',
28891
+ name: 'exclude',
28892
+ required: false,
28893
+ schema: {
28894
+ items: {
28895
+ enum: ['spaces', 'devices', 'acs_entrances'],
28896
+ type: 'string',
28897
+ },
28898
+ type: 'array',
28899
+ },
28900
+ },
28901
+ ],
28902
+ responses: {
28903
+ 200: {
28904
+ content: {
28905
+ 'application/json': {
28906
+ schema: {
28907
+ properties: {
28908
+ batch: {
28909
+ description: 'Represents a resource batch.',
28910
+ oneOf: [
28911
+ {
28912
+ description: 'ID of the affected access system user.',
28913
+ properties: {
28914
+ acs_entrances: {
28915
+ items: {
28916
+ $ref: '#/components/schemas/acs_entrance',
28917
+ },
28918
+ type: 'array',
28919
+ },
28920
+ batch_type: { enum: ['spaces'], type: 'string' },
28921
+ devices: {
28922
+ items: { $ref: '#/components/schemas/device' },
28923
+ type: 'array',
28924
+ },
28925
+ spaces: {
28926
+ items: { $ref: '#/components/schemas/space' },
28927
+ type: 'array',
28928
+ },
28929
+ },
28930
+ required: ['batch_type'],
28931
+ type: 'object',
28932
+ },
28933
+ {
28934
+ properties: {
28935
+ acs_entrances: {
28936
+ items: {
28937
+ $ref: '#/components/schemas/acs_entrance',
28938
+ },
28939
+ type: 'array',
28940
+ },
28941
+ batch_type: {
28942
+ enum: ['access_grants'],
28943
+ type: 'string',
28944
+ },
28945
+ devices: {
28946
+ items: { $ref: '#/components/schemas/device' },
28947
+ type: 'array',
28948
+ },
28949
+ spaces: {
28950
+ items: { $ref: '#/components/schemas/space' },
28951
+ type: 'array',
28952
+ },
28953
+ },
28954
+ required: ['batch_type'],
28955
+ type: 'object',
28956
+ },
28957
+ {
28958
+ properties: {
28959
+ acs_entrances: {
28960
+ items: {
28961
+ $ref: '#/components/schemas/acs_entrance',
28962
+ },
28963
+ type: 'array',
28964
+ },
28965
+ batch_type: {
28966
+ enum: ['access_methods'],
28967
+ type: 'string',
28968
+ },
28969
+ devices: {
28970
+ items: { $ref: '#/components/schemas/device' },
28971
+ type: 'array',
28972
+ },
28973
+ spaces: {
28974
+ items: { $ref: '#/components/schemas/space' },
28975
+ type: 'array',
28976
+ },
28977
+ },
28978
+ required: ['batch_type'],
28979
+ type: 'object',
28980
+ },
28981
+ ],
28982
+ 'x-route-path': '/',
28983
+ },
28984
+ ok: { type: 'boolean' },
28985
+ },
28986
+ required: ['batch', 'ok'],
28987
+ type: 'object',
28988
+ },
28989
+ },
28990
+ },
28991
+ description: 'OK',
28992
+ },
28993
+ 400: { description: 'Bad Request' },
28994
+ 401: { description: 'Unauthorized' },
28995
+ },
28996
+ security: [
28997
+ { pat_with_workspace: [] },
28998
+ { console_session_with_workspace: [] },
28999
+ { api_key: [] },
29000
+ ],
29001
+ summary: '/access_methods/get_related',
29002
+ tags: [],
29003
+ 'x-batch-type': 'access_methods',
29004
+ 'x-draft': 'Early access.',
29005
+ 'x-fern-sdk-group-name': ['access_methods'],
29006
+ 'x-fern-sdk-method-name': 'get_related',
29007
+ 'x-fern-sdk-return-value': 'batch',
29008
+ 'x-response-key': 'batch',
29009
+ 'x-title': 'Get related Access Method resources',
29010
+ },
29011
+ post: {
29012
+ description:
29013
+ 'Gets all related resources for one or more Access Methods.',
29014
+ operationId: 'accessMethodsGetRelatedPost',
29015
+ requestBody: {
29016
+ content: {
29017
+ 'application/json': {
29018
+ schema: {
29019
+ properties: {
29020
+ access_method_ids: {
29021
+ description:
29022
+ 'IDs of the access methods that you want to get along with their related resources.',
29023
+ items: { format: 'uuid', type: 'string' },
29024
+ type: 'array',
29025
+ },
29026
+ exclude: {
29027
+ items: {
29028
+ enum: ['spaces', 'devices', 'acs_entrances'],
29029
+ type: 'string',
29030
+ },
29031
+ type: 'array',
29032
+ },
29033
+ include: {
29034
+ items: {
29035
+ enum: ['spaces', 'devices', 'acs_entrances'],
29036
+ type: 'string',
29037
+ },
29038
+ type: 'array',
29039
+ },
29040
+ },
29041
+ required: ['access_method_ids'],
29042
+ type: 'object',
29043
+ },
29044
+ },
29045
+ },
29046
+ },
29047
+ responses: {
29048
+ 200: {
29049
+ content: {
29050
+ 'application/json': {
29051
+ schema: {
29052
+ properties: {
29053
+ batch: {
29054
+ description: 'Represents a resource batch.',
29055
+ oneOf: [
29056
+ {
29057
+ description: 'ID of the affected access system user.',
29058
+ properties: {
29059
+ acs_entrances: {
29060
+ items: {
29061
+ $ref: '#/components/schemas/acs_entrance',
29062
+ },
29063
+ type: 'array',
29064
+ },
29065
+ batch_type: { enum: ['spaces'], type: 'string' },
29066
+ devices: {
29067
+ items: { $ref: '#/components/schemas/device' },
29068
+ type: 'array',
29069
+ },
29070
+ spaces: {
29071
+ items: { $ref: '#/components/schemas/space' },
29072
+ type: 'array',
29073
+ },
29074
+ },
29075
+ required: ['batch_type'],
29076
+ type: 'object',
29077
+ },
29078
+ {
29079
+ properties: {
29080
+ acs_entrances: {
29081
+ items: {
29082
+ $ref: '#/components/schemas/acs_entrance',
29083
+ },
29084
+ type: 'array',
29085
+ },
29086
+ batch_type: {
29087
+ enum: ['access_grants'],
29088
+ type: 'string',
29089
+ },
29090
+ devices: {
29091
+ items: { $ref: '#/components/schemas/device' },
29092
+ type: 'array',
29093
+ },
29094
+ spaces: {
29095
+ items: { $ref: '#/components/schemas/space' },
29096
+ type: 'array',
29097
+ },
29098
+ },
29099
+ required: ['batch_type'],
29100
+ type: 'object',
29101
+ },
29102
+ {
29103
+ properties: {
29104
+ acs_entrances: {
29105
+ items: {
29106
+ $ref: '#/components/schemas/acs_entrance',
29107
+ },
29108
+ type: 'array',
29109
+ },
29110
+ batch_type: {
29111
+ enum: ['access_methods'],
29112
+ type: 'string',
29113
+ },
29114
+ devices: {
29115
+ items: { $ref: '#/components/schemas/device' },
29116
+ type: 'array',
29117
+ },
29118
+ spaces: {
29119
+ items: { $ref: '#/components/schemas/space' },
29120
+ type: 'array',
29121
+ },
29122
+ },
29123
+ required: ['batch_type'],
29124
+ type: 'object',
29125
+ },
29126
+ ],
29127
+ 'x-route-path': '/',
29128
+ },
29129
+ ok: { type: 'boolean' },
29130
+ },
29131
+ required: ['batch', 'ok'],
29132
+ type: 'object',
29133
+ },
29134
+ },
29135
+ },
29136
+ description: 'OK',
29137
+ },
29138
+ 400: { description: 'Bad Request' },
29139
+ 401: { description: 'Unauthorized' },
29140
+ },
29141
+ security: [
29142
+ { pat_with_workspace: [] },
29143
+ { console_session_with_workspace: [] },
29144
+ { api_key: [] },
29145
+ ],
29146
+ summary: '/access_methods/get_related',
29147
+ tags: [],
29148
+ 'x-batch-type': 'access_methods',
29149
+ 'x-draft': 'Early access.',
29150
+ 'x-fern-sdk-group-name': ['access_methods'],
29151
+ 'x-fern-sdk-method-name': 'get_related',
29152
+ 'x-fern-sdk-return-value': 'batch',
29153
+ 'x-response-key': 'batch',
29154
+ 'x-title': 'Get related Access Method resources',
29155
+ },
29156
+ },
28812
29157
  '/access_methods/list': {
28813
29158
  get: {
28814
29159
  description:
@@ -40010,7 +40355,7 @@ export default {
40010
40355
  '/devices/simulate/connect_to_hub': {
40011
40356
  post: {
40012
40357
  description:
40013
- 'Simulates bringing the Wi-Fi hub (bridge) back online 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 clear the `hub_disconnected` error on the device.',
40358
+ 'Simulates bringing the WiFi hub (bridge) back online for a device.\nOnly applicable for sandbox workspaces and currently\nimplemented for August and TTLock locks.\nThis will clear the corresponding `hub_disconnected` or\n`ttlock_lock_not_paired_to_gateway` error on the device.',
40014
40359
  operationId: 'devicesSimulateConnectToHubPost',
40015
40360
  requestBody: {
40016
40361
  content: {
@@ -47754,6 +48099,30 @@ export default {
47754
48099
  required: ['batch_type'],
47755
48100
  type: 'object',
47756
48101
  },
48102
+ {
48103
+ properties: {
48104
+ acs_entrances: {
48105
+ items: {
48106
+ $ref: '#/components/schemas/acs_entrance',
48107
+ },
48108
+ type: 'array',
48109
+ },
48110
+ batch_type: {
48111
+ enum: ['access_methods'],
48112
+ type: 'string',
48113
+ },
48114
+ devices: {
48115
+ items: { $ref: '#/components/schemas/device' },
48116
+ type: 'array',
48117
+ },
48118
+ spaces: {
48119
+ items: { $ref: '#/components/schemas/space' },
48120
+ type: 'array',
48121
+ },
48122
+ },
48123
+ required: ['batch_type'],
48124
+ type: 'object',
48125
+ },
47757
48126
  ],
47758
48127
  'x-route-path': '/',
47759
48128
  },
@@ -47874,6 +48243,30 @@ export default {
47874
48243
  required: ['batch_type'],
47875
48244
  type: 'object',
47876
48245
  },
48246
+ {
48247
+ properties: {
48248
+ acs_entrances: {
48249
+ items: {
48250
+ $ref: '#/components/schemas/acs_entrance',
48251
+ },
48252
+ type: 'array',
48253
+ },
48254
+ batch_type: {
48255
+ enum: ['access_methods'],
48256
+ type: 'string',
48257
+ },
48258
+ devices: {
48259
+ items: { $ref: '#/components/schemas/device' },
48260
+ type: 'array',
48261
+ },
48262
+ spaces: {
48263
+ items: { $ref: '#/components/schemas/space' },
48264
+ type: 'array',
48265
+ },
48266
+ },
48267
+ required: ['batch_type'],
48268
+ type: 'object',
48269
+ },
47877
48270
  ],
47878
48271
  'x-route-path': '/',
47879
48272
  },