@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.
@@ -39240,7 +39240,7 @@ const openapi = {
39240
39240
  },
39241
39241
  '/access_codes/list': {
39242
39242
  get: {
39243
- description: '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`.',
39243
+ description: '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.',
39244
39244
  operationId: 'accessCodesListGet',
39245
39245
  parameters: [
39246
39246
  {
@@ -39256,7 +39256,7 @@ const openapi = {
39256
39256
  in: 'query',
39257
39257
  name: 'device_id',
39258
39258
  schema: {
39259
- description: '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`.',
39259
+ description: 'ID of the device for which you want to list access codes.',
39260
39260
  format: 'uuid',
39261
39261
  type: 'string',
39262
39262
  },
@@ -39265,7 +39265,7 @@ const openapi = {
39265
39265
  in: 'query',
39266
39266
  name: 'access_code_ids',
39267
39267
  schema: {
39268
- description: '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`.',
39268
+ description: 'IDs of the access codes that you want to retrieve.',
39269
39269
  items: { format: 'uuid', type: 'string' },
39270
39270
  type: 'array',
39271
39271
  },
@@ -39274,7 +39274,7 @@ const openapi = {
39274
39274
  in: 'query',
39275
39275
  name: 'access_method_id',
39276
39276
  schema: {
39277
- description: '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`.',
39277
+ description: 'ID of the access method for which you want to list access codes.',
39278
39278
  format: 'uuid',
39279
39279
  type: 'string',
39280
39280
  },
@@ -39283,7 +39283,7 @@ const openapi = {
39283
39283
  in: 'query',
39284
39284
  name: 'access_grant_id',
39285
39285
  schema: {
39286
- description: '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`.',
39286
+ description: 'ID of the access grant for which you want to list access codes.',
39287
39287
  format: 'uuid',
39288
39288
  type: 'string',
39289
39289
  },
@@ -39292,7 +39292,7 @@ const openapi = {
39292
39292
  in: 'query',
39293
39293
  name: 'access_grant_key',
39294
39294
  schema: {
39295
- description: '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`.',
39295
+ description: 'Key of the access grant for which you want to list access codes.',
39296
39296
  minLength: 1,
39297
39297
  type: 'string',
39298
39298
  },
@@ -39372,7 +39372,6 @@ const openapi = {
39372
39372
  'x-fern-sdk-group-name': ['access_codes'],
39373
39373
  'x-fern-sdk-method-name': 'list',
39374
39374
  'x-fern-sdk-return-value': 'access_codes',
39375
- 'x-has-required-parameters': true,
39376
39375
  'x-response-key': 'access_codes',
39377
39376
  'x-title': 'List Access Codes',
39378
39377
  },
@@ -40904,6 +40903,15 @@ const openapi = {
40904
40903
  description: 'Gets unmanaged Access Grants (where is_managed = false).',
40905
40904
  operationId: 'accessGrantsUnmanagedListGet',
40906
40905
  parameters: [
40906
+ {
40907
+ in: 'query',
40908
+ name: 'customer_key',
40909
+ schema: {
40910
+ description: 'Customer key for which you want to list unmanaged Access Grants.',
40911
+ minLength: 1,
40912
+ type: 'string',
40913
+ },
40914
+ },
40907
40915
  {
40908
40916
  in: 'query',
40909
40917
  name: 'user_identity_id',
@@ -41525,6 +41533,15 @@ const openapi = {
41525
41533
  description: 'Lists all access methods, usually filtered by Access Grant.',
41526
41534
  operationId: 'accessMethodsListGet',
41527
41535
  parameters: [
41536
+ {
41537
+ in: 'query',
41538
+ name: 'customer_key',
41539
+ schema: {
41540
+ description: 'Customer key for which you want to list access methods.',
41541
+ minLength: 1,
41542
+ type: 'string',
41543
+ },
41544
+ },
41528
41545
  {
41529
41546
  in: 'query',
41530
41547
  name: 'access_grant_id',
@@ -58311,6 +58328,486 @@ const openapi = {
58311
58328
  'x-undocumented': 'Internal endpoint for Console',
58312
58329
  },
58313
58330
  },
58331
+ '/seam/console/v1/workspace/list_access_codes_for_today': {
58332
+ get: {
58333
+ description: "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.",
58334
+ operationId: 'seamConsoleV1WorkspaceListAccessCodesForTodayGet',
58335
+ parameters: [
58336
+ {
58337
+ in: 'query',
58338
+ name: 'customer_key',
58339
+ schema: {
58340
+ description: 'Customer key for which you want to list access codes.',
58341
+ minLength: 1,
58342
+ type: 'string',
58343
+ },
58344
+ },
58345
+ {
58346
+ in: 'query',
58347
+ name: 'starts_at',
58348
+ schema: {
58349
+ description: "Start of the viewer's day, inclusive. Pass with `ends_at`; defaults to the start of the current UTC day.",
58350
+ format: 'date-time',
58351
+ type: 'string',
58352
+ },
58353
+ },
58354
+ {
58355
+ in: 'query',
58356
+ name: 'ends_at',
58357
+ schema: {
58358
+ description: "End of the viewer's day, exclusive. Pass with `starts_at`; defaults to the end of the current UTC day.",
58359
+ format: 'date-time',
58360
+ type: 'string',
58361
+ },
58362
+ },
58363
+ {
58364
+ in: 'query',
58365
+ name: 'limit',
58366
+ schema: {
58367
+ default: 50,
58368
+ description: 'Maximum number of starting, and of ending, access codes to return.',
58369
+ exclusiveMinimum: true,
58370
+ maximum: 200,
58371
+ minimum: 0,
58372
+ type: 'integer',
58373
+ },
58374
+ },
58375
+ ],
58376
+ responses: {
58377
+ '200': {
58378
+ content: {
58379
+ 'application/json': {
58380
+ schema: {
58381
+ properties: {
58382
+ access_codes_for_today: {
58383
+ properties: {
58384
+ ending: {
58385
+ items: {
58386
+ properties: {
58387
+ access_code_id: {
58388
+ format: 'uuid',
58389
+ type: 'string',
58390
+ },
58391
+ code: { nullable: true, type: 'string' },
58392
+ device_id: { format: 'uuid', type: 'string' },
58393
+ device_name: { type: 'string' },
58394
+ ends_at: {
58395
+ format: 'date-time',
58396
+ nullable: true,
58397
+ type: 'string',
58398
+ },
58399
+ name: { nullable: true, type: 'string' },
58400
+ starts_at: {
58401
+ format: 'date-time',
58402
+ nullable: true,
58403
+ type: 'string',
58404
+ },
58405
+ status: {
58406
+ enum: [
58407
+ 'setting',
58408
+ 'set',
58409
+ 'unset',
58410
+ 'removing',
58411
+ 'unknown',
58412
+ ],
58413
+ type: 'string',
58414
+ },
58415
+ },
58416
+ required: [
58417
+ 'access_code_id',
58418
+ 'code',
58419
+ 'name',
58420
+ 'device_id',
58421
+ 'device_name',
58422
+ 'starts_at',
58423
+ 'ends_at',
58424
+ 'status',
58425
+ ],
58426
+ type: 'object',
58427
+ },
58428
+ type: 'array',
58429
+ },
58430
+ ending_count: { type: 'integer' },
58431
+ starting: {
58432
+ items: {
58433
+ properties: {
58434
+ access_code_id: {
58435
+ format: 'uuid',
58436
+ type: 'string',
58437
+ },
58438
+ code: { nullable: true, type: 'string' },
58439
+ device_id: { format: 'uuid', type: 'string' },
58440
+ device_name: { type: 'string' },
58441
+ ends_at: {
58442
+ format: 'date-time',
58443
+ nullable: true,
58444
+ type: 'string',
58445
+ },
58446
+ name: { nullable: true, type: 'string' },
58447
+ starts_at: {
58448
+ format: 'date-time',
58449
+ nullable: true,
58450
+ type: 'string',
58451
+ },
58452
+ status: {
58453
+ enum: [
58454
+ 'setting',
58455
+ 'set',
58456
+ 'unset',
58457
+ 'removing',
58458
+ 'unknown',
58459
+ ],
58460
+ type: 'string',
58461
+ },
58462
+ },
58463
+ required: [
58464
+ 'access_code_id',
58465
+ 'code',
58466
+ 'name',
58467
+ 'device_id',
58468
+ 'device_name',
58469
+ 'starts_at',
58470
+ 'ends_at',
58471
+ 'status',
58472
+ ],
58473
+ type: 'object',
58474
+ },
58475
+ type: 'array',
58476
+ },
58477
+ starting_count: { type: 'integer' },
58478
+ },
58479
+ required: [
58480
+ 'starting_count',
58481
+ 'starting',
58482
+ 'ending_count',
58483
+ 'ending',
58484
+ ],
58485
+ type: 'object',
58486
+ },
58487
+ ok: { type: 'boolean' },
58488
+ },
58489
+ required: ['access_codes_for_today', 'ok'],
58490
+ type: 'object',
58491
+ },
58492
+ },
58493
+ },
58494
+ description: 'OK',
58495
+ },
58496
+ '400': { description: 'Bad Request' },
58497
+ '401': { description: 'Unauthorized' },
58498
+ },
58499
+ security: [{ console_session_with_workspace: [] }],
58500
+ summary: '/seam/console/v1/workspace/list_access_codes_for_today',
58501
+ tags: [],
58502
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
58503
+ 'x-fern-sdk-method-name': 'list_access_codes_for_today',
58504
+ 'x-fern-sdk-return-value': 'access_codes_for_today',
58505
+ 'x-response-key': 'access_codes_for_today',
58506
+ 'x-title': 'List Access Codes for Today',
58507
+ 'x-undocumented': 'Internal endpoint for Console',
58508
+ },
58509
+ },
58510
+ '/seam/console/v1/workspace/list_attention_items': {
58511
+ get: {
58512
+ description: '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.',
58513
+ operationId: 'seamConsoleV1WorkspaceListAttentionItemsGet',
58514
+ parameters: [
58515
+ {
58516
+ in: 'query',
58517
+ name: 'customer_key',
58518
+ schema: {
58519
+ description: 'Customer key for which you want to list attention items.',
58520
+ minLength: 1,
58521
+ type: 'string',
58522
+ },
58523
+ },
58524
+ {
58525
+ in: 'query',
58526
+ name: 'limit',
58527
+ schema: {
58528
+ default: 5,
58529
+ description: 'Maximum number of devices, and of access codes, to return.',
58530
+ exclusiveMinimum: true,
58531
+ maximum: 50,
58532
+ minimum: 0,
58533
+ type: 'integer',
58534
+ },
58535
+ },
58536
+ ],
58537
+ responses: {
58538
+ '200': {
58539
+ content: {
58540
+ 'application/json': {
58541
+ schema: {
58542
+ properties: {
58543
+ attention_items: {
58544
+ properties: {
58545
+ access_code_count: { type: 'integer' },
58546
+ access_codes: {
58547
+ items: {
58548
+ properties: {
58549
+ access_code_id: {
58550
+ format: 'uuid',
58551
+ type: 'string',
58552
+ },
58553
+ code: { nullable: true, type: 'string' },
58554
+ device_id: { format: 'uuid', type: 'string' },
58555
+ device_name: { type: 'string' },
58556
+ error: {
58557
+ properties: {
58558
+ error_code: { type: 'string' },
58559
+ message: { type: 'string' },
58560
+ },
58561
+ required: ['error_code', 'message'],
58562
+ type: 'object',
58563
+ },
58564
+ name: { nullable: true, type: 'string' },
58565
+ },
58566
+ required: [
58567
+ 'access_code_id',
58568
+ 'code',
58569
+ 'name',
58570
+ 'device_id',
58571
+ 'device_name',
58572
+ 'error',
58573
+ ],
58574
+ type: 'object',
58575
+ },
58576
+ type: 'array',
58577
+ },
58578
+ device_count: { type: 'integer' },
58579
+ devices: {
58580
+ items: {
58581
+ properties: {
58582
+ device_id: { format: 'uuid', type: 'string' },
58583
+ display_name: { type: 'string' },
58584
+ error: {
58585
+ properties: {
58586
+ error_code: { type: 'string' },
58587
+ message: { type: 'string' },
58588
+ },
58589
+ required: ['error_code', 'message'],
58590
+ type: 'object',
58591
+ },
58592
+ },
58593
+ required: ['device_id', 'display_name', 'error'],
58594
+ type: 'object',
58595
+ },
58596
+ type: 'array',
58597
+ },
58598
+ },
58599
+ required: [
58600
+ 'device_count',
58601
+ 'devices',
58602
+ 'access_code_count',
58603
+ 'access_codes',
58604
+ ],
58605
+ type: 'object',
58606
+ },
58607
+ ok: { type: 'boolean' },
58608
+ },
58609
+ required: ['attention_items', 'ok'],
58610
+ type: 'object',
58611
+ },
58612
+ },
58613
+ },
58614
+ description: 'OK',
58615
+ },
58616
+ '400': { description: 'Bad Request' },
58617
+ '401': { description: 'Unauthorized' },
58618
+ },
58619
+ security: [{ console_session_with_workspace: [] }],
58620
+ summary: '/seam/console/v1/workspace/list_attention_items',
58621
+ tags: [],
58622
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
58623
+ 'x-fern-sdk-method-name': 'list_attention_items',
58624
+ 'x-fern-sdk-return-value': 'attention_items',
58625
+ 'x-response-key': 'attention_items',
58626
+ 'x-title': 'List Workspace Attention Items',
58627
+ 'x-undocumented': 'Internal endpoint for Console',
58628
+ },
58629
+ },
58630
+ '/seam/console/v1/workspace/list_reservations_for_today': {
58631
+ get: {
58632
+ description: "Lists the reservations that check in, and those that check out, during the\nviewer's day, in time order, with the total of each.",
58633
+ operationId: 'seamConsoleV1WorkspaceListReservationsForTodayGet',
58634
+ parameters: [
58635
+ {
58636
+ in: 'query',
58637
+ name: 'customer_key',
58638
+ schema: {
58639
+ description: 'Customer key for which you want to list reservations.',
58640
+ minLength: 1,
58641
+ type: 'string',
58642
+ },
58643
+ },
58644
+ {
58645
+ in: 'query',
58646
+ name: 'starts_at',
58647
+ schema: {
58648
+ description: "Start of the viewer's day, inclusive. Pass with `ends_at`; defaults to the start of the current UTC day.",
58649
+ format: 'date-time',
58650
+ type: 'string',
58651
+ },
58652
+ },
58653
+ {
58654
+ in: 'query',
58655
+ name: 'ends_at',
58656
+ schema: {
58657
+ description: "End of the viewer's day, exclusive. Pass with `starts_at`; defaults to the end of the current UTC day.",
58658
+ format: 'date-time',
58659
+ type: 'string',
58660
+ },
58661
+ },
58662
+ {
58663
+ in: 'query',
58664
+ name: 'limit',
58665
+ schema: {
58666
+ default: 50,
58667
+ description: 'Maximum number of check-ins, and of check-outs, to return.',
58668
+ exclusiveMinimum: true,
58669
+ maximum: 200,
58670
+ minimum: 0,
58671
+ type: 'integer',
58672
+ },
58673
+ },
58674
+ ],
58675
+ responses: {
58676
+ '200': {
58677
+ content: {
58678
+ 'application/json': {
58679
+ schema: {
58680
+ properties: {
58681
+ ok: { type: 'boolean' },
58682
+ reservations_for_today: {
58683
+ properties: {
58684
+ check_in_count: { type: 'integer' },
58685
+ check_ins: {
58686
+ items: {
58687
+ properties: {
58688
+ ends_at: {
58689
+ format: 'date-time',
58690
+ nullable: true,
58691
+ type: 'string',
58692
+ },
58693
+ guest_name: { nullable: true, type: 'string' },
58694
+ name: { nullable: true, type: 'string' },
58695
+ reservation_id: {
58696
+ format: 'uuid',
58697
+ type: 'string',
58698
+ },
58699
+ reservation_key: { type: 'string' },
58700
+ space: {
58701
+ nullable: true,
58702
+ properties: {
58703
+ name: { nullable: true, type: 'string' },
58704
+ space_id: {
58705
+ format: 'uuid',
58706
+ nullable: true,
58707
+ type: 'string',
58708
+ },
58709
+ },
58710
+ required: ['space_id', 'name'],
58711
+ type: 'object',
58712
+ },
58713
+ starts_at: {
58714
+ format: 'date-time',
58715
+ nullable: true,
58716
+ type: 'string',
58717
+ },
58718
+ },
58719
+ required: [
58720
+ 'reservation_id',
58721
+ 'reservation_key',
58722
+ 'guest_name',
58723
+ 'name',
58724
+ 'starts_at',
58725
+ 'ends_at',
58726
+ 'space',
58727
+ ],
58728
+ type: 'object',
58729
+ },
58730
+ type: 'array',
58731
+ },
58732
+ check_out_count: { type: 'integer' },
58733
+ check_outs: {
58734
+ items: {
58735
+ properties: {
58736
+ ends_at: {
58737
+ format: 'date-time',
58738
+ nullable: true,
58739
+ type: 'string',
58740
+ },
58741
+ guest_name: { nullable: true, type: 'string' },
58742
+ name: { nullable: true, type: 'string' },
58743
+ reservation_id: {
58744
+ format: 'uuid',
58745
+ type: 'string',
58746
+ },
58747
+ reservation_key: { type: 'string' },
58748
+ space: {
58749
+ nullable: true,
58750
+ properties: {
58751
+ name: { nullable: true, type: 'string' },
58752
+ space_id: {
58753
+ format: 'uuid',
58754
+ nullable: true,
58755
+ type: 'string',
58756
+ },
58757
+ },
58758
+ required: ['space_id', 'name'],
58759
+ type: 'object',
58760
+ },
58761
+ starts_at: {
58762
+ format: 'date-time',
58763
+ nullable: true,
58764
+ type: 'string',
58765
+ },
58766
+ },
58767
+ required: [
58768
+ 'reservation_id',
58769
+ 'reservation_key',
58770
+ 'guest_name',
58771
+ 'name',
58772
+ 'starts_at',
58773
+ 'ends_at',
58774
+ 'space',
58775
+ ],
58776
+ type: 'object',
58777
+ },
58778
+ type: 'array',
58779
+ },
58780
+ },
58781
+ required: [
58782
+ 'check_in_count',
58783
+ 'check_ins',
58784
+ 'check_out_count',
58785
+ 'check_outs',
58786
+ ],
58787
+ type: 'object',
58788
+ },
58789
+ },
58790
+ required: ['reservations_for_today', 'ok'],
58791
+ type: 'object',
58792
+ },
58793
+ },
58794
+ },
58795
+ description: 'OK',
58796
+ },
58797
+ '400': { description: 'Bad Request' },
58798
+ '401': { description: 'Unauthorized' },
58799
+ },
58800
+ security: [{ console_session_with_workspace: [] }],
58801
+ summary: '/seam/console/v1/workspace/list_reservations_for_today',
58802
+ tags: [],
58803
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
58804
+ 'x-fern-sdk-method-name': 'list_reservations_for_today',
58805
+ 'x-fern-sdk-return-value': 'reservations_for_today',
58806
+ 'x-response-key': 'reservations_for_today',
58807
+ 'x-title': 'List Reservations for Today',
58808
+ 'x-undocumented': 'Internal endpoint for Console',
58809
+ },
58810
+ },
58314
58811
  '/seam/customer/v1/access_grants/list': {
58315
58812
  get: {
58316
58813
  description: 'Gets an Access Grant.',
@@ -70938,6 +71435,15 @@ const openapi = {
70938
71435
  description: '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).',
70939
71436
  operationId: 'userIdentitiesListGet',
70940
71437
  parameters: [
71438
+ {
71439
+ in: 'query',
71440
+ name: 'customer_key',
71441
+ schema: {
71442
+ description: 'Customer key for which you want to list user identities.',
71443
+ minLength: 1,
71444
+ type: 'string',
71445
+ },
71446
+ },
70941
71447
  {
70942
71448
  in: 'query',
70943
71449
  name: 'user_identity_ids',