@seamapi/types 1.1149.0 → 1.1150.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.
@@ -58311,6 +58311,486 @@ const openapi = {
58311
58311
  'x-undocumented': 'Internal endpoint for Console',
58312
58312
  },
58313
58313
  },
58314
+ '/seam/console/v1/workspace/list_access_codes_for_today': {
58315
+ get: {
58316
+ 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.",
58317
+ operationId: 'seamConsoleV1WorkspaceListAccessCodesForTodayGet',
58318
+ parameters: [
58319
+ {
58320
+ in: 'query',
58321
+ name: 'customer_key',
58322
+ schema: {
58323
+ description: 'Customer key for which you want to list access codes.',
58324
+ minLength: 1,
58325
+ type: 'string',
58326
+ },
58327
+ },
58328
+ {
58329
+ in: 'query',
58330
+ name: 'starts_at',
58331
+ schema: {
58332
+ description: "Start of the viewer's day, inclusive. Pass with `ends_at`; defaults to the start of the current UTC day.",
58333
+ format: 'date-time',
58334
+ type: 'string',
58335
+ },
58336
+ },
58337
+ {
58338
+ in: 'query',
58339
+ name: 'ends_at',
58340
+ schema: {
58341
+ description: "End of the viewer's day, exclusive. Pass with `starts_at`; defaults to the end of the current UTC day.",
58342
+ format: 'date-time',
58343
+ type: 'string',
58344
+ },
58345
+ },
58346
+ {
58347
+ in: 'query',
58348
+ name: 'limit',
58349
+ schema: {
58350
+ default: 50,
58351
+ description: 'Maximum number of starting, and of ending, access codes to return.',
58352
+ exclusiveMinimum: true,
58353
+ maximum: 200,
58354
+ minimum: 0,
58355
+ type: 'integer',
58356
+ },
58357
+ },
58358
+ ],
58359
+ responses: {
58360
+ '200': {
58361
+ content: {
58362
+ 'application/json': {
58363
+ schema: {
58364
+ properties: {
58365
+ access_codes_for_today: {
58366
+ properties: {
58367
+ ending: {
58368
+ items: {
58369
+ properties: {
58370
+ access_code_id: {
58371
+ format: 'uuid',
58372
+ type: 'string',
58373
+ },
58374
+ code: { nullable: true, type: 'string' },
58375
+ device_id: { format: 'uuid', type: 'string' },
58376
+ device_name: { type: 'string' },
58377
+ ends_at: {
58378
+ format: 'date-time',
58379
+ nullable: true,
58380
+ type: 'string',
58381
+ },
58382
+ name: { nullable: true, type: 'string' },
58383
+ starts_at: {
58384
+ format: 'date-time',
58385
+ nullable: true,
58386
+ type: 'string',
58387
+ },
58388
+ status: {
58389
+ enum: [
58390
+ 'setting',
58391
+ 'set',
58392
+ 'unset',
58393
+ 'removing',
58394
+ 'unknown',
58395
+ ],
58396
+ type: 'string',
58397
+ },
58398
+ },
58399
+ required: [
58400
+ 'access_code_id',
58401
+ 'code',
58402
+ 'name',
58403
+ 'device_id',
58404
+ 'device_name',
58405
+ 'starts_at',
58406
+ 'ends_at',
58407
+ 'status',
58408
+ ],
58409
+ type: 'object',
58410
+ },
58411
+ type: 'array',
58412
+ },
58413
+ ending_count: { type: 'integer' },
58414
+ starting: {
58415
+ items: {
58416
+ properties: {
58417
+ access_code_id: {
58418
+ format: 'uuid',
58419
+ type: 'string',
58420
+ },
58421
+ code: { nullable: true, type: 'string' },
58422
+ device_id: { format: 'uuid', type: 'string' },
58423
+ device_name: { type: 'string' },
58424
+ ends_at: {
58425
+ format: 'date-time',
58426
+ nullable: true,
58427
+ type: 'string',
58428
+ },
58429
+ name: { nullable: true, type: 'string' },
58430
+ starts_at: {
58431
+ format: 'date-time',
58432
+ nullable: true,
58433
+ type: 'string',
58434
+ },
58435
+ status: {
58436
+ enum: [
58437
+ 'setting',
58438
+ 'set',
58439
+ 'unset',
58440
+ 'removing',
58441
+ 'unknown',
58442
+ ],
58443
+ type: 'string',
58444
+ },
58445
+ },
58446
+ required: [
58447
+ 'access_code_id',
58448
+ 'code',
58449
+ 'name',
58450
+ 'device_id',
58451
+ 'device_name',
58452
+ 'starts_at',
58453
+ 'ends_at',
58454
+ 'status',
58455
+ ],
58456
+ type: 'object',
58457
+ },
58458
+ type: 'array',
58459
+ },
58460
+ starting_count: { type: 'integer' },
58461
+ },
58462
+ required: [
58463
+ 'starting_count',
58464
+ 'starting',
58465
+ 'ending_count',
58466
+ 'ending',
58467
+ ],
58468
+ type: 'object',
58469
+ },
58470
+ ok: { type: 'boolean' },
58471
+ },
58472
+ required: ['access_codes_for_today', 'ok'],
58473
+ type: 'object',
58474
+ },
58475
+ },
58476
+ },
58477
+ description: 'OK',
58478
+ },
58479
+ '400': { description: 'Bad Request' },
58480
+ '401': { description: 'Unauthorized' },
58481
+ },
58482
+ security: [{ console_session_with_workspace: [] }],
58483
+ summary: '/seam/console/v1/workspace/list_access_codes_for_today',
58484
+ tags: [],
58485
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
58486
+ 'x-fern-sdk-method-name': 'list_access_codes_for_today',
58487
+ 'x-fern-sdk-return-value': 'access_codes_for_today',
58488
+ 'x-response-key': 'access_codes_for_today',
58489
+ 'x-title': 'List Access Codes for Today',
58490
+ 'x-undocumented': 'Internal endpoint for Console',
58491
+ },
58492
+ },
58493
+ '/seam/console/v1/workspace/list_attention_items': {
58494
+ get: {
58495
+ 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.',
58496
+ operationId: 'seamConsoleV1WorkspaceListAttentionItemsGet',
58497
+ parameters: [
58498
+ {
58499
+ in: 'query',
58500
+ name: 'customer_key',
58501
+ schema: {
58502
+ description: 'Customer key for which you want to list attention items.',
58503
+ minLength: 1,
58504
+ type: 'string',
58505
+ },
58506
+ },
58507
+ {
58508
+ in: 'query',
58509
+ name: 'limit',
58510
+ schema: {
58511
+ default: 5,
58512
+ description: 'Maximum number of devices, and of access codes, to return.',
58513
+ exclusiveMinimum: true,
58514
+ maximum: 50,
58515
+ minimum: 0,
58516
+ type: 'integer',
58517
+ },
58518
+ },
58519
+ ],
58520
+ responses: {
58521
+ '200': {
58522
+ content: {
58523
+ 'application/json': {
58524
+ schema: {
58525
+ properties: {
58526
+ attention_items: {
58527
+ properties: {
58528
+ access_code_count: { type: 'integer' },
58529
+ access_codes: {
58530
+ items: {
58531
+ properties: {
58532
+ access_code_id: {
58533
+ format: 'uuid',
58534
+ type: 'string',
58535
+ },
58536
+ code: { nullable: true, type: 'string' },
58537
+ device_id: { format: 'uuid', type: 'string' },
58538
+ device_name: { type: 'string' },
58539
+ error: {
58540
+ properties: {
58541
+ error_code: { type: 'string' },
58542
+ message: { type: 'string' },
58543
+ },
58544
+ required: ['error_code', 'message'],
58545
+ type: 'object',
58546
+ },
58547
+ name: { nullable: true, type: 'string' },
58548
+ },
58549
+ required: [
58550
+ 'access_code_id',
58551
+ 'code',
58552
+ 'name',
58553
+ 'device_id',
58554
+ 'device_name',
58555
+ 'error',
58556
+ ],
58557
+ type: 'object',
58558
+ },
58559
+ type: 'array',
58560
+ },
58561
+ device_count: { type: 'integer' },
58562
+ devices: {
58563
+ items: {
58564
+ properties: {
58565
+ device_id: { format: 'uuid', type: 'string' },
58566
+ display_name: { type: 'string' },
58567
+ error: {
58568
+ properties: {
58569
+ error_code: { type: 'string' },
58570
+ message: { type: 'string' },
58571
+ },
58572
+ required: ['error_code', 'message'],
58573
+ type: 'object',
58574
+ },
58575
+ },
58576
+ required: ['device_id', 'display_name', 'error'],
58577
+ type: 'object',
58578
+ },
58579
+ type: 'array',
58580
+ },
58581
+ },
58582
+ required: [
58583
+ 'device_count',
58584
+ 'devices',
58585
+ 'access_code_count',
58586
+ 'access_codes',
58587
+ ],
58588
+ type: 'object',
58589
+ },
58590
+ ok: { type: 'boolean' },
58591
+ },
58592
+ required: ['attention_items', 'ok'],
58593
+ type: 'object',
58594
+ },
58595
+ },
58596
+ },
58597
+ description: 'OK',
58598
+ },
58599
+ '400': { description: 'Bad Request' },
58600
+ '401': { description: 'Unauthorized' },
58601
+ },
58602
+ security: [{ console_session_with_workspace: [] }],
58603
+ summary: '/seam/console/v1/workspace/list_attention_items',
58604
+ tags: [],
58605
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
58606
+ 'x-fern-sdk-method-name': 'list_attention_items',
58607
+ 'x-fern-sdk-return-value': 'attention_items',
58608
+ 'x-response-key': 'attention_items',
58609
+ 'x-title': 'List Workspace Attention Items',
58610
+ 'x-undocumented': 'Internal endpoint for Console',
58611
+ },
58612
+ },
58613
+ '/seam/console/v1/workspace/list_reservations_for_today': {
58614
+ get: {
58615
+ 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.",
58616
+ operationId: 'seamConsoleV1WorkspaceListReservationsForTodayGet',
58617
+ parameters: [
58618
+ {
58619
+ in: 'query',
58620
+ name: 'customer_key',
58621
+ schema: {
58622
+ description: 'Customer key for which you want to list reservations.',
58623
+ minLength: 1,
58624
+ type: 'string',
58625
+ },
58626
+ },
58627
+ {
58628
+ in: 'query',
58629
+ name: 'starts_at',
58630
+ schema: {
58631
+ description: "Start of the viewer's day, inclusive. Pass with `ends_at`; defaults to the start of the current UTC day.",
58632
+ format: 'date-time',
58633
+ type: 'string',
58634
+ },
58635
+ },
58636
+ {
58637
+ in: 'query',
58638
+ name: 'ends_at',
58639
+ schema: {
58640
+ description: "End of the viewer's day, exclusive. Pass with `starts_at`; defaults to the end of the current UTC day.",
58641
+ format: 'date-time',
58642
+ type: 'string',
58643
+ },
58644
+ },
58645
+ {
58646
+ in: 'query',
58647
+ name: 'limit',
58648
+ schema: {
58649
+ default: 50,
58650
+ description: 'Maximum number of check-ins, and of check-outs, to return.',
58651
+ exclusiveMinimum: true,
58652
+ maximum: 200,
58653
+ minimum: 0,
58654
+ type: 'integer',
58655
+ },
58656
+ },
58657
+ ],
58658
+ responses: {
58659
+ '200': {
58660
+ content: {
58661
+ 'application/json': {
58662
+ schema: {
58663
+ properties: {
58664
+ ok: { type: 'boolean' },
58665
+ reservations_for_today: {
58666
+ properties: {
58667
+ check_in_count: { type: 'integer' },
58668
+ check_ins: {
58669
+ items: {
58670
+ properties: {
58671
+ ends_at: {
58672
+ format: 'date-time',
58673
+ nullable: true,
58674
+ type: 'string',
58675
+ },
58676
+ guest_name: { nullable: true, type: 'string' },
58677
+ name: { nullable: true, type: 'string' },
58678
+ reservation_id: {
58679
+ format: 'uuid',
58680
+ type: 'string',
58681
+ },
58682
+ reservation_key: { type: 'string' },
58683
+ space: {
58684
+ nullable: true,
58685
+ properties: {
58686
+ name: { nullable: true, type: 'string' },
58687
+ space_id: {
58688
+ format: 'uuid',
58689
+ nullable: true,
58690
+ type: 'string',
58691
+ },
58692
+ },
58693
+ required: ['space_id', 'name'],
58694
+ type: 'object',
58695
+ },
58696
+ starts_at: {
58697
+ format: 'date-time',
58698
+ nullable: true,
58699
+ type: 'string',
58700
+ },
58701
+ },
58702
+ required: [
58703
+ 'reservation_id',
58704
+ 'reservation_key',
58705
+ 'guest_name',
58706
+ 'name',
58707
+ 'starts_at',
58708
+ 'ends_at',
58709
+ 'space',
58710
+ ],
58711
+ type: 'object',
58712
+ },
58713
+ type: 'array',
58714
+ },
58715
+ check_out_count: { type: 'integer' },
58716
+ check_outs: {
58717
+ items: {
58718
+ properties: {
58719
+ ends_at: {
58720
+ format: 'date-time',
58721
+ nullable: true,
58722
+ type: 'string',
58723
+ },
58724
+ guest_name: { nullable: true, type: 'string' },
58725
+ name: { nullable: true, type: 'string' },
58726
+ reservation_id: {
58727
+ format: 'uuid',
58728
+ type: 'string',
58729
+ },
58730
+ reservation_key: { type: 'string' },
58731
+ space: {
58732
+ nullable: true,
58733
+ properties: {
58734
+ name: { nullable: true, type: 'string' },
58735
+ space_id: {
58736
+ format: 'uuid',
58737
+ nullable: true,
58738
+ type: 'string',
58739
+ },
58740
+ },
58741
+ required: ['space_id', 'name'],
58742
+ type: 'object',
58743
+ },
58744
+ starts_at: {
58745
+ format: 'date-time',
58746
+ nullable: true,
58747
+ type: 'string',
58748
+ },
58749
+ },
58750
+ required: [
58751
+ 'reservation_id',
58752
+ 'reservation_key',
58753
+ 'guest_name',
58754
+ 'name',
58755
+ 'starts_at',
58756
+ 'ends_at',
58757
+ 'space',
58758
+ ],
58759
+ type: 'object',
58760
+ },
58761
+ type: 'array',
58762
+ },
58763
+ },
58764
+ required: [
58765
+ 'check_in_count',
58766
+ 'check_ins',
58767
+ 'check_out_count',
58768
+ 'check_outs',
58769
+ ],
58770
+ type: 'object',
58771
+ },
58772
+ },
58773
+ required: ['reservations_for_today', 'ok'],
58774
+ type: 'object',
58775
+ },
58776
+ },
58777
+ },
58778
+ description: 'OK',
58779
+ },
58780
+ '400': { description: 'Bad Request' },
58781
+ '401': { description: 'Unauthorized' },
58782
+ },
58783
+ security: [{ console_session_with_workspace: [] }],
58784
+ summary: '/seam/console/v1/workspace/list_reservations_for_today',
58785
+ tags: [],
58786
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'workspace'],
58787
+ 'x-fern-sdk-method-name': 'list_reservations_for_today',
58788
+ 'x-fern-sdk-return-value': 'reservations_for_today',
58789
+ 'x-response-key': 'reservations_for_today',
58790
+ 'x-title': 'List Reservations for Today',
58791
+ 'x-undocumented': 'Internal endpoint for Console',
58792
+ },
58793
+ },
58314
58794
  '/seam/customer/v1/access_grants/list': {
58315
58795
  get: {
58316
58796
  description: 'Gets an Access Grant.',