@seamapi/types 1.1149.0 → 1.1151.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.
@@ -43923,7 +43923,7 @@ const openapi: OpenAPISpec = {
43923
43923
  '/access_codes/list': {
43924
43924
  get: {
43925
43925
  description:
43926
- 'Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).\n\nSpecify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43926
+ 'Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).\n\nWithout `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`, returns access codes across the workspace, or across the customer when `customer_key` is set. Use `limit` and `page_cursor` to page through them.',
43927
43927
  operationId: 'accessCodesListGet',
43928
43928
  parameters: [
43929
43929
  {
@@ -43941,7 +43941,7 @@ const openapi: OpenAPISpec = {
43941
43941
  name: 'device_id',
43942
43942
  schema: {
43943
43943
  description:
43944
- 'ID of the device for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43944
+ 'ID of the device for which you want to list access codes.',
43945
43945
  format: 'uuid',
43946
43946
  type: 'string',
43947
43947
  },
@@ -43950,8 +43950,7 @@ const openapi: OpenAPISpec = {
43950
43950
  in: 'query',
43951
43951
  name: 'access_code_ids',
43952
43952
  schema: {
43953
- description:
43954
- 'IDs of the access codes that you want to retrieve. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43953
+ description: 'IDs of the access codes that you want to retrieve.',
43955
43954
  items: { format: 'uuid', type: 'string' },
43956
43955
  type: 'array',
43957
43956
  },
@@ -43961,7 +43960,7 @@ const openapi: OpenAPISpec = {
43961
43960
  name: 'access_method_id',
43962
43961
  schema: {
43963
43962
  description:
43964
- 'ID of the access method for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43963
+ 'ID of the access method for which you want to list access codes.',
43965
43964
  format: 'uuid',
43966
43965
  type: 'string',
43967
43966
  },
@@ -43971,7 +43970,7 @@ const openapi: OpenAPISpec = {
43971
43970
  name: 'access_grant_id',
43972
43971
  schema: {
43973
43972
  description:
43974
- 'ID of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43973
+ 'ID of the access grant for which you want to list access codes.',
43975
43974
  format: 'uuid',
43976
43975
  type: 'string',
43977
43976
  },
@@ -43981,7 +43980,7 @@ const openapi: OpenAPISpec = {
43981
43980
  name: 'access_grant_key',
43982
43981
  schema: {
43983
43982
  description:
43984
- 'Key of the access grant for which you want to list access codes. Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.',
43983
+ 'Key of the access grant for which you want to list access codes.',
43985
43984
  minLength: 1,
43986
43985
  type: 'string',
43987
43986
  },
@@ -44065,7 +44064,6 @@ const openapi: OpenAPISpec = {
44065
44064
  'x-fern-sdk-group-name': ['access_codes'],
44066
44065
  'x-fern-sdk-method-name': 'list',
44067
44066
  'x-fern-sdk-return-value': 'access_codes',
44068
- 'x-has-required-parameters': true,
44069
44067
  'x-response-key': 'access_codes',
44070
44068
  'x-title': 'List Access Codes',
44071
44069
  },
@@ -45685,6 +45683,16 @@ const openapi: OpenAPISpec = {
45685
45683
  description: 'Gets unmanaged Access Grants (where is_managed = false).',
45686
45684
  operationId: 'accessGrantsUnmanagedListGet',
45687
45685
  parameters: [
45686
+ {
45687
+ in: 'query',
45688
+ name: 'customer_key',
45689
+ schema: {
45690
+ description:
45691
+ 'Customer key for which you want to list unmanaged Access Grants.',
45692
+ minLength: 1,
45693
+ type: 'string',
45694
+ },
45695
+ },
45688
45696
  {
45689
45697
  in: 'query',
45690
45698
  name: 'user_identity_id',
@@ -46328,6 +46336,16 @@ const openapi: OpenAPISpec = {
46328
46336
  'Lists all access methods, usually filtered by Access Grant.',
46329
46337
  operationId: 'accessMethodsListGet',
46330
46338
  parameters: [
46339
+ {
46340
+ in: 'query',
46341
+ name: 'customer_key',
46342
+ schema: {
46343
+ description:
46344
+ 'Customer key for which you want to list access methods.',
46345
+ minLength: 1,
46346
+ type: 'string',
46347
+ },
46348
+ },
46331
46349
  {
46332
46350
  in: 'query',
46333
46351
  name: 'access_grant_id',
@@ -63983,6 +64001,499 @@ const openapi: OpenAPISpec = {
63983
64001
  'x-undocumented': 'Internal endpoint for Console',
63984
64002
  },
63985
64003
  },
64004
+ '/seam/console/v1/workspace/list_access_codes_for_today': {
64005
+ get: {
64006
+ description:
64007
+ "Lists the managed time-bound access codes that start, and those that end,\nduring the viewer's day, in time order, with the total of each.",
64008
+ operationId: 'seamConsoleV1WorkspaceListAccessCodesForTodayGet',
64009
+ parameters: [
64010
+ {
64011
+ in: 'query',
64012
+ name: 'customer_key',
64013
+ schema: {
64014
+ description:
64015
+ 'Customer key for which you want to list access codes.',
64016
+ minLength: 1,
64017
+ type: 'string',
64018
+ },
64019
+ },
64020
+ {
64021
+ in: 'query',
64022
+ name: 'starts_at',
64023
+ schema: {
64024
+ description:
64025
+ "Start of the viewer's day, inclusive. Pass with `ends_at`; defaults to the start of the current UTC day.",
64026
+ format: 'date-time',
64027
+ type: 'string',
64028
+ },
64029
+ },
64030
+ {
64031
+ in: 'query',
64032
+ name: 'ends_at',
64033
+ schema: {
64034
+ description:
64035
+ "End of the viewer's day, exclusive. Pass with `starts_at`; defaults to the end of the current UTC day.",
64036
+ format: 'date-time',
64037
+ type: 'string',
64038
+ },
64039
+ },
64040
+ {
64041
+ in: 'query',
64042
+ name: 'limit',
64043
+ schema: {
64044
+ default: 50,
64045
+ description:
64046
+ 'Maximum number of starting, and of ending, access codes to return.',
64047
+ exclusiveMinimum: true,
64048
+ maximum: 200,
64049
+ minimum: 0,
64050
+ type: 'integer',
64051
+ },
64052
+ },
64053
+ ],
64054
+ responses: {
64055
+ '200': {
64056
+ content: {
64057
+ 'application/json': {
64058
+ schema: {
64059
+ properties: {
64060
+ access_codes_for_today: {
64061
+ properties: {
64062
+ ending: {
64063
+ items: {
64064
+ properties: {
64065
+ access_code_id: {
64066
+ format: 'uuid',
64067
+ type: 'string',
64068
+ },
64069
+ code: { nullable: true, type: 'string' },
64070
+ device_id: { format: 'uuid', type: 'string' },
64071
+ device_name: { type: 'string' },
64072
+ ends_at: {
64073
+ format: 'date-time',
64074
+ nullable: true,
64075
+ type: 'string',
64076
+ },
64077
+ name: { nullable: true, type: 'string' },
64078
+ starts_at: {
64079
+ format: 'date-time',
64080
+ nullable: true,
64081
+ type: 'string',
64082
+ },
64083
+ status: {
64084
+ enum: [
64085
+ 'setting',
64086
+ 'set',
64087
+ 'unset',
64088
+ 'removing',
64089
+ 'unknown',
64090
+ ],
64091
+ type: 'string',
64092
+ },
64093
+ },
64094
+ required: [
64095
+ 'access_code_id',
64096
+ 'code',
64097
+ 'name',
64098
+ 'device_id',
64099
+ 'device_name',
64100
+ 'starts_at',
64101
+ 'ends_at',
64102
+ 'status',
64103
+ ],
64104
+ type: 'object',
64105
+ },
64106
+ type: 'array',
64107
+ },
64108
+ ending_count: { type: 'integer' },
64109
+ starting: {
64110
+ items: {
64111
+ properties: {
64112
+ access_code_id: {
64113
+ format: 'uuid',
64114
+ type: 'string',
64115
+ },
64116
+ code: { nullable: true, type: 'string' },
64117
+ device_id: { format: 'uuid', type: 'string' },
64118
+ device_name: { type: 'string' },
64119
+ ends_at: {
64120
+ format: 'date-time',
64121
+ nullable: true,
64122
+ type: 'string',
64123
+ },
64124
+ name: { nullable: true, type: 'string' },
64125
+ starts_at: {
64126
+ format: 'date-time',
64127
+ nullable: true,
64128
+ type: 'string',
64129
+ },
64130
+ status: {
64131
+ enum: [
64132
+ 'setting',
64133
+ 'set',
64134
+ 'unset',
64135
+ 'removing',
64136
+ 'unknown',
64137
+ ],
64138
+ type: 'string',
64139
+ },
64140
+ },
64141
+ required: [
64142
+ 'access_code_id',
64143
+ 'code',
64144
+ 'name',
64145
+ 'device_id',
64146
+ 'device_name',
64147
+ 'starts_at',
64148
+ 'ends_at',
64149
+ 'status',
64150
+ ],
64151
+ type: 'object',
64152
+ },
64153
+ type: 'array',
64154
+ },
64155
+ starting_count: { type: 'integer' },
64156
+ },
64157
+ required: [
64158
+ 'starting_count',
64159
+ 'starting',
64160
+ 'ending_count',
64161
+ 'ending',
64162
+ ],
64163
+ type: 'object',
64164
+ },
64165
+ ok: { type: 'boolean' },
64166
+ },
64167
+ required: ['access_codes_for_today', 'ok'],
64168
+ type: 'object',
64169
+ },
64170
+ },
64171
+ },
64172
+ description: 'OK',
64173
+ },
64174
+ '400': { description: 'Bad Request' },
64175
+ '401': { description: 'Unauthorized' },
64176
+ },
64177
+ security: [{ console_session_with_workspace: [] }],
64178
+ summary: '/seam/console/v1/workspace/list_access_codes_for_today',
64179
+ tags: [],
64180
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
64181
+ 'x-fern-sdk-method-name': 'list_access_codes_for_today',
64182
+ 'x-fern-sdk-return-value': 'access_codes_for_today',
64183
+ 'x-response-key': 'access_codes_for_today',
64184
+ 'x-title': 'List Access Codes for Today',
64185
+ 'x-undocumented': 'Internal endpoint for Console',
64186
+ },
64187
+ },
64188
+ '/seam/console/v1/workspace/list_attention_items': {
64189
+ get: {
64190
+ description:
64191
+ 'Lists the devices with errors and the managed access codes that failed to\nreach their device in the last 7 days, newest first, with the total of each.',
64192
+ operationId: 'seamConsoleV1WorkspaceListAttentionItemsGet',
64193
+ parameters: [
64194
+ {
64195
+ in: 'query',
64196
+ name: 'customer_key',
64197
+ schema: {
64198
+ description:
64199
+ 'Customer key for which you want to list attention items.',
64200
+ minLength: 1,
64201
+ type: 'string',
64202
+ },
64203
+ },
64204
+ {
64205
+ in: 'query',
64206
+ name: 'limit',
64207
+ schema: {
64208
+ default: 5,
64209
+ description:
64210
+ 'Maximum number of devices, and of access codes, to return.',
64211
+ exclusiveMinimum: true,
64212
+ maximum: 50,
64213
+ minimum: 0,
64214
+ type: 'integer',
64215
+ },
64216
+ },
64217
+ ],
64218
+ responses: {
64219
+ '200': {
64220
+ content: {
64221
+ 'application/json': {
64222
+ schema: {
64223
+ properties: {
64224
+ attention_items: {
64225
+ properties: {
64226
+ access_code_count: { type: 'integer' },
64227
+ access_codes: {
64228
+ items: {
64229
+ properties: {
64230
+ access_code_id: {
64231
+ format: 'uuid',
64232
+ type: 'string',
64233
+ },
64234
+ code: { nullable: true, type: 'string' },
64235
+ device_id: { format: 'uuid', type: 'string' },
64236
+ device_name: { type: 'string' },
64237
+ error: {
64238
+ properties: {
64239
+ error_code: { type: 'string' },
64240
+ message: { type: 'string' },
64241
+ },
64242
+ required: ['error_code', 'message'],
64243
+ type: 'object',
64244
+ },
64245
+ name: { nullable: true, type: 'string' },
64246
+ },
64247
+ required: [
64248
+ 'access_code_id',
64249
+ 'code',
64250
+ 'name',
64251
+ 'device_id',
64252
+ 'device_name',
64253
+ 'error',
64254
+ ],
64255
+ type: 'object',
64256
+ },
64257
+ type: 'array',
64258
+ },
64259
+ device_count: { type: 'integer' },
64260
+ devices: {
64261
+ items: {
64262
+ properties: {
64263
+ device_id: { format: 'uuid', type: 'string' },
64264
+ display_name: { type: 'string' },
64265
+ error: {
64266
+ properties: {
64267
+ error_code: { type: 'string' },
64268
+ message: { type: 'string' },
64269
+ },
64270
+ required: ['error_code', 'message'],
64271
+ type: 'object',
64272
+ },
64273
+ },
64274
+ required: ['device_id', 'display_name', 'error'],
64275
+ type: 'object',
64276
+ },
64277
+ type: 'array',
64278
+ },
64279
+ },
64280
+ required: [
64281
+ 'device_count',
64282
+ 'devices',
64283
+ 'access_code_count',
64284
+ 'access_codes',
64285
+ ],
64286
+ type: 'object',
64287
+ },
64288
+ ok: { type: 'boolean' },
64289
+ },
64290
+ required: ['attention_items', 'ok'],
64291
+ type: 'object',
64292
+ },
64293
+ },
64294
+ },
64295
+ description: 'OK',
64296
+ },
64297
+ '400': { description: 'Bad Request' },
64298
+ '401': { description: 'Unauthorized' },
64299
+ },
64300
+ security: [{ console_session_with_workspace: [] }],
64301
+ summary: '/seam/console/v1/workspace/list_attention_items',
64302
+ tags: [],
64303
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
64304
+ 'x-fern-sdk-method-name': 'list_attention_items',
64305
+ 'x-fern-sdk-return-value': 'attention_items',
64306
+ 'x-response-key': 'attention_items',
64307
+ 'x-title': 'List Workspace Attention Items',
64308
+ 'x-undocumented': 'Internal endpoint for Console',
64309
+ },
64310
+ },
64311
+ '/seam/console/v1/workspace/list_reservations_for_today': {
64312
+ get: {
64313
+ description:
64314
+ "Lists the reservations that check in, and those that check out, during the\nviewer's day, in time order, with the total of each.",
64315
+ operationId: 'seamConsoleV1WorkspaceListReservationsForTodayGet',
64316
+ parameters: [
64317
+ {
64318
+ in: 'query',
64319
+ name: 'customer_key',
64320
+ schema: {
64321
+ description:
64322
+ 'Customer key for which you want to list reservations.',
64323
+ minLength: 1,
64324
+ type: 'string',
64325
+ },
64326
+ },
64327
+ {
64328
+ in: 'query',
64329
+ name: 'starts_at',
64330
+ schema: {
64331
+ description:
64332
+ "Start of the viewer's day, inclusive. Pass with `ends_at`; defaults to the start of the current UTC day.",
64333
+ format: 'date-time',
64334
+ type: 'string',
64335
+ },
64336
+ },
64337
+ {
64338
+ in: 'query',
64339
+ name: 'ends_at',
64340
+ schema: {
64341
+ description:
64342
+ "End of the viewer's day, exclusive. Pass with `starts_at`; defaults to the end of the current UTC day.",
64343
+ format: 'date-time',
64344
+ type: 'string',
64345
+ },
64346
+ },
64347
+ {
64348
+ in: 'query',
64349
+ name: 'limit',
64350
+ schema: {
64351
+ default: 50,
64352
+ description:
64353
+ 'Maximum number of check-ins, and of check-outs, to return.',
64354
+ exclusiveMinimum: true,
64355
+ maximum: 200,
64356
+ minimum: 0,
64357
+ type: 'integer',
64358
+ },
64359
+ },
64360
+ ],
64361
+ responses: {
64362
+ '200': {
64363
+ content: {
64364
+ 'application/json': {
64365
+ schema: {
64366
+ properties: {
64367
+ ok: { type: 'boolean' },
64368
+ reservations_for_today: {
64369
+ properties: {
64370
+ check_in_count: { type: 'integer' },
64371
+ check_ins: {
64372
+ items: {
64373
+ properties: {
64374
+ ends_at: {
64375
+ format: 'date-time',
64376
+ nullable: true,
64377
+ type: 'string',
64378
+ },
64379
+ guest_name: { nullable: true, type: 'string' },
64380
+ name: { nullable: true, type: 'string' },
64381
+ reservation_id: {
64382
+ format: 'uuid',
64383
+ type: 'string',
64384
+ },
64385
+ reservation_key: { type: 'string' },
64386
+ space: {
64387
+ nullable: true,
64388
+ properties: {
64389
+ name: { nullable: true, type: 'string' },
64390
+ space_id: {
64391
+ format: 'uuid',
64392
+ nullable: true,
64393
+ type: 'string',
64394
+ },
64395
+ },
64396
+ required: ['space_id', 'name'],
64397
+ type: 'object',
64398
+ },
64399
+ starts_at: {
64400
+ format: 'date-time',
64401
+ nullable: true,
64402
+ type: 'string',
64403
+ },
64404
+ },
64405
+ required: [
64406
+ 'reservation_id',
64407
+ 'reservation_key',
64408
+ 'guest_name',
64409
+ 'name',
64410
+ 'starts_at',
64411
+ 'ends_at',
64412
+ 'space',
64413
+ ],
64414
+ type: 'object',
64415
+ },
64416
+ type: 'array',
64417
+ },
64418
+ check_out_count: { type: 'integer' },
64419
+ check_outs: {
64420
+ items: {
64421
+ properties: {
64422
+ ends_at: {
64423
+ format: 'date-time',
64424
+ nullable: true,
64425
+ type: 'string',
64426
+ },
64427
+ guest_name: { nullable: true, type: 'string' },
64428
+ name: { nullable: true, type: 'string' },
64429
+ reservation_id: {
64430
+ format: 'uuid',
64431
+ type: 'string',
64432
+ },
64433
+ reservation_key: { type: 'string' },
64434
+ space: {
64435
+ nullable: true,
64436
+ properties: {
64437
+ name: { nullable: true, type: 'string' },
64438
+ space_id: {
64439
+ format: 'uuid',
64440
+ nullable: true,
64441
+ type: 'string',
64442
+ },
64443
+ },
64444
+ required: ['space_id', 'name'],
64445
+ type: 'object',
64446
+ },
64447
+ starts_at: {
64448
+ format: 'date-time',
64449
+ nullable: true,
64450
+ type: 'string',
64451
+ },
64452
+ },
64453
+ required: [
64454
+ 'reservation_id',
64455
+ 'reservation_key',
64456
+ 'guest_name',
64457
+ 'name',
64458
+ 'starts_at',
64459
+ 'ends_at',
64460
+ 'space',
64461
+ ],
64462
+ type: 'object',
64463
+ },
64464
+ type: 'array',
64465
+ },
64466
+ },
64467
+ required: [
64468
+ 'check_in_count',
64469
+ 'check_ins',
64470
+ 'check_out_count',
64471
+ 'check_outs',
64472
+ ],
64473
+ type: 'object',
64474
+ },
64475
+ },
64476
+ required: ['reservations_for_today', 'ok'],
64477
+ type: 'object',
64478
+ },
64479
+ },
64480
+ },
64481
+ description: 'OK',
64482
+ },
64483
+ '400': { description: 'Bad Request' },
64484
+ '401': { description: 'Unauthorized' },
64485
+ },
64486
+ security: [{ console_session_with_workspace: [] }],
64487
+ summary: '/seam/console/v1/workspace/list_reservations_for_today',
64488
+ tags: [],
64489
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
64490
+ 'x-fern-sdk-method-name': 'list_reservations_for_today',
64491
+ 'x-fern-sdk-return-value': 'reservations_for_today',
64492
+ 'x-response-key': 'reservations_for_today',
64493
+ 'x-title': 'List Reservations for Today',
64494
+ 'x-undocumented': 'Internal endpoint for Console',
64495
+ },
64496
+ },
63986
64497
  '/seam/customer/v1/access_grants/list': {
63987
64498
  get: {
63988
64499
  description: 'Gets an Access Grant.',
@@ -77194,6 +77705,16 @@ const openapi: OpenAPISpec = {
77194
77705
  'Returns a list of all [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).',
77195
77706
  operationId: 'userIdentitiesListGet',
77196
77707
  parameters: [
77708
+ {
77709
+ in: 'query',
77710
+ name: 'customer_key',
77711
+ schema: {
77712
+ description:
77713
+ 'Customer key for which you want to list user identities.',
77714
+ minLength: 1,
77715
+ type: 'string',
77716
+ },
77717
+ },
77197
77718
  {
77198
77719
  in: 'query',
77199
77720
  name: 'user_identity_ids',