@seamapi/types 1.428.0 → 1.429.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.
@@ -40247,6 +40247,678 @@ export default {
40247
40247
  'x-undocumented': 'Seam Bridge Client only.',
40248
40248
  },
40249
40249
  },
40250
+ '/seam/customer/v1/automation_runs/list': {
40251
+ get: {
40252
+ description: 'Returns a list of all automation runs for a workspace or customer.',
40253
+ operationId: 'seamCustomerV1AutomationRunsListGet',
40254
+ parameters: [
40255
+ {
40256
+ in: 'query',
40257
+ name: 'automation_id',
40258
+ schema: {
40259
+ description: 'ID of the automation for which you want to retrieve all automation runs.',
40260
+ format: 'uuid',
40261
+ type: 'string',
40262
+ },
40263
+ },
40264
+ {
40265
+ in: 'query',
40266
+ name: 'partner_resource_id',
40267
+ schema: {
40268
+ description: 'ID of the partner resource for which you want to retrieve all automation runs.',
40269
+ format: 'uuid',
40270
+ type: 'string',
40271
+ },
40272
+ },
40273
+ {
40274
+ in: 'query',
40275
+ name: 'rule',
40276
+ schema: {
40277
+ description: 'Filter automation runs by the specific rule that was executed.',
40278
+ enum: [
40279
+ 'reservation_created',
40280
+ 'reservation_time_updated',
40281
+ 'reservation_deleted',
40282
+ ],
40283
+ type: 'string',
40284
+ },
40285
+ },
40286
+ {
40287
+ in: 'query',
40288
+ name: 'success',
40289
+ schema: {
40290
+ description: 'Filter automation runs by success status.',
40291
+ type: 'boolean',
40292
+ },
40293
+ },
40294
+ {
40295
+ in: 'query',
40296
+ name: 'limit',
40297
+ schema: {
40298
+ default: 500,
40299
+ description: 'Maximum number of records to return per page.',
40300
+ exclusiveMinimum: true,
40301
+ minimum: 0,
40302
+ type: 'integer',
40303
+ },
40304
+ },
40305
+ {
40306
+ in: 'query',
40307
+ name: 'created_before',
40308
+ schema: {
40309
+ description: 'Timestamp by which to limit returned automation runs. Returns runs created before this timestamp.',
40310
+ format: 'date-time',
40311
+ type: 'string',
40312
+ },
40313
+ },
40314
+ {
40315
+ in: 'query',
40316
+ name: 'page_cursor',
40317
+ schema: {
40318
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
40319
+ nullable: true,
40320
+ type: 'string',
40321
+ },
40322
+ },
40323
+ ],
40324
+ responses: {
40325
+ 200: {
40326
+ content: {
40327
+ 'application/json': {
40328
+ schema: {
40329
+ properties: {
40330
+ automation_runs: {
40331
+ items: {
40332
+ properties: {
40333
+ automation_id: { format: 'uuid', type: 'string' },
40334
+ automation_result: {
40335
+ properties: {
40336
+ actions: {
40337
+ items: {
40338
+ properties: {
40339
+ access_grant_id: {
40340
+ format: 'uuid',
40341
+ type: 'string',
40342
+ },
40343
+ action_type: {
40344
+ enum: ['create', 'update', 'delete'],
40345
+ type: 'string',
40346
+ },
40347
+ resource_type: { type: 'string' },
40348
+ },
40349
+ required: [
40350
+ 'action_type',
40351
+ 'resource_type',
40352
+ 'access_grant_id',
40353
+ ],
40354
+ type: 'object',
40355
+ },
40356
+ type: 'array',
40357
+ },
40358
+ error: { type: 'string' },
40359
+ rule: {
40360
+ enum: [
40361
+ 'reservation_created',
40362
+ 'reservation_time_updated',
40363
+ 'reservation_deleted',
40364
+ ],
40365
+ type: 'string',
40366
+ },
40367
+ success: { type: 'boolean' },
40368
+ },
40369
+ required: ['success', 'rule', 'actions'],
40370
+ type: 'object',
40371
+ },
40372
+ automation_run_id: { format: 'uuid', type: 'string' },
40373
+ created_at: { type: 'string' },
40374
+ partner_resource_id: {
40375
+ format: 'uuid',
40376
+ type: 'string',
40377
+ },
40378
+ workspace_id: { format: 'uuid', type: 'string' },
40379
+ },
40380
+ required: [
40381
+ 'automation_run_id',
40382
+ 'workspace_id',
40383
+ 'automation_id',
40384
+ 'partner_resource_id',
40385
+ 'created_at',
40386
+ ],
40387
+ type: 'object',
40388
+ },
40389
+ type: 'array',
40390
+ },
40391
+ ok: { type: 'boolean' },
40392
+ pagination: { $ref: '#/components/schemas/pagination' },
40393
+ },
40394
+ required: ['automation_runs', 'pagination', 'ok'],
40395
+ type: 'object',
40396
+ },
40397
+ },
40398
+ },
40399
+ description: 'OK',
40400
+ },
40401
+ 400: { description: 'Bad Request' },
40402
+ 401: { description: 'Unauthorized' },
40403
+ },
40404
+ security: [
40405
+ { console_session_with_workspace: [] },
40406
+ { api_key: [] },
40407
+ { client_session_with_customer: [] },
40408
+ ],
40409
+ summary: '/seam/customer/v1/automation_runs/list',
40410
+ tags: [],
40411
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automation_runs'],
40412
+ 'x-fern-sdk-method-name': 'list',
40413
+ 'x-fern-sdk-return-value': 'automation_runs',
40414
+ 'x-response-key': 'automation_runs',
40415
+ 'x-title': 'List Automation Runs',
40416
+ 'x-undocumented': 'Internal endpoint for customer portals.',
40417
+ },
40418
+ post: {
40419
+ description: 'Returns a list of all automation runs for a workspace or customer.',
40420
+ operationId: 'seamCustomerV1AutomationRunsListPost',
40421
+ requestBody: {
40422
+ content: {
40423
+ 'application/json': {
40424
+ schema: {
40425
+ properties: {
40426
+ automation_id: {
40427
+ description: 'ID of the automation for which you want to retrieve all automation runs.',
40428
+ format: 'uuid',
40429
+ type: 'string',
40430
+ },
40431
+ created_before: {
40432
+ description: 'Timestamp by which to limit returned automation runs. Returns runs created before this timestamp.',
40433
+ format: 'date-time',
40434
+ type: 'string',
40435
+ },
40436
+ limit: {
40437
+ default: 500,
40438
+ description: 'Maximum number of records to return per page.',
40439
+ exclusiveMinimum: true,
40440
+ minimum: 0,
40441
+ type: 'integer',
40442
+ },
40443
+ page_cursor: {
40444
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
40445
+ nullable: true,
40446
+ type: 'string',
40447
+ },
40448
+ partner_resource_id: {
40449
+ description: 'ID of the partner resource for which you want to retrieve all automation runs.',
40450
+ format: 'uuid',
40451
+ type: 'string',
40452
+ },
40453
+ rule: {
40454
+ description: 'Filter automation runs by the specific rule that was executed.',
40455
+ enum: [
40456
+ 'reservation_created',
40457
+ 'reservation_time_updated',
40458
+ 'reservation_deleted',
40459
+ ],
40460
+ type: 'string',
40461
+ },
40462
+ success: {
40463
+ description: 'Filter automation runs by success status.',
40464
+ type: 'boolean',
40465
+ },
40466
+ },
40467
+ type: 'object',
40468
+ },
40469
+ },
40470
+ },
40471
+ },
40472
+ responses: {
40473
+ 200: {
40474
+ content: {
40475
+ 'application/json': {
40476
+ schema: {
40477
+ properties: {
40478
+ automation_runs: {
40479
+ items: {
40480
+ properties: {
40481
+ automation_id: { format: 'uuid', type: 'string' },
40482
+ automation_result: {
40483
+ properties: {
40484
+ actions: {
40485
+ items: {
40486
+ properties: {
40487
+ access_grant_id: {
40488
+ format: 'uuid',
40489
+ type: 'string',
40490
+ },
40491
+ action_type: {
40492
+ enum: ['create', 'update', 'delete'],
40493
+ type: 'string',
40494
+ },
40495
+ resource_type: { type: 'string' },
40496
+ },
40497
+ required: [
40498
+ 'action_type',
40499
+ 'resource_type',
40500
+ 'access_grant_id',
40501
+ ],
40502
+ type: 'object',
40503
+ },
40504
+ type: 'array',
40505
+ },
40506
+ error: { type: 'string' },
40507
+ rule: {
40508
+ enum: [
40509
+ 'reservation_created',
40510
+ 'reservation_time_updated',
40511
+ 'reservation_deleted',
40512
+ ],
40513
+ type: 'string',
40514
+ },
40515
+ success: { type: 'boolean' },
40516
+ },
40517
+ required: ['success', 'rule', 'actions'],
40518
+ type: 'object',
40519
+ },
40520
+ automation_run_id: { format: 'uuid', type: 'string' },
40521
+ created_at: { type: 'string' },
40522
+ partner_resource_id: {
40523
+ format: 'uuid',
40524
+ type: 'string',
40525
+ },
40526
+ workspace_id: { format: 'uuid', type: 'string' },
40527
+ },
40528
+ required: [
40529
+ 'automation_run_id',
40530
+ 'workspace_id',
40531
+ 'automation_id',
40532
+ 'partner_resource_id',
40533
+ 'created_at',
40534
+ ],
40535
+ type: 'object',
40536
+ },
40537
+ type: 'array',
40538
+ },
40539
+ ok: { type: 'boolean' },
40540
+ pagination: { $ref: '#/components/schemas/pagination' },
40541
+ },
40542
+ required: ['automation_runs', 'pagination', 'ok'],
40543
+ type: 'object',
40544
+ },
40545
+ },
40546
+ },
40547
+ description: 'OK',
40548
+ },
40549
+ 400: { description: 'Bad Request' },
40550
+ 401: { description: 'Unauthorized' },
40551
+ },
40552
+ security: [
40553
+ { console_session_with_workspace: [] },
40554
+ { api_key: [] },
40555
+ { client_session_with_customer: [] },
40556
+ ],
40557
+ summary: '/seam/customer/v1/automation_runs/list',
40558
+ tags: [],
40559
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automation_runs'],
40560
+ 'x-fern-sdk-method-name': 'list',
40561
+ 'x-fern-sdk-return-value': 'automation_runs',
40562
+ 'x-response-key': 'automation_runs',
40563
+ 'x-title': 'List Automation Runs',
40564
+ 'x-undocumented': 'Internal endpoint for customer portals.',
40565
+ },
40566
+ },
40567
+ '/seam/customer/v1/automations/delete': {
40568
+ delete: {
40569
+ description: 'Deletes the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
40570
+ operationId: 'seamCustomerV1AutomationsDeleteDelete',
40571
+ requestBody: {
40572
+ content: {
40573
+ 'application/json': { schema: { properties: {}, type: 'object' } },
40574
+ },
40575
+ },
40576
+ responses: {
40577
+ 200: {
40578
+ content: {
40579
+ 'application/json': {
40580
+ schema: {
40581
+ properties: { ok: { type: 'boolean' } },
40582
+ required: ['ok'],
40583
+ type: 'object',
40584
+ },
40585
+ },
40586
+ },
40587
+ description: 'OK',
40588
+ },
40589
+ 400: { description: 'Bad Request' },
40590
+ 401: { description: 'Unauthorized' },
40591
+ },
40592
+ security: [
40593
+ { console_session_with_workspace: [] },
40594
+ { api_key: [] },
40595
+ { client_session_with_customer: [] },
40596
+ ],
40597
+ summary: '/seam/customer/v1/automations/delete',
40598
+ tags: [],
40599
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
40600
+ 'x-fern-sdk-method-name': 'delete',
40601
+ 'x-response-key': null,
40602
+ 'x-title': 'Delete Customer Portal Automation Configuration',
40603
+ 'x-undocumented': 'Internal endpoint for customer portals.',
40604
+ },
40605
+ },
40606
+ '/seam/customer/v1/automations/get': {
40607
+ get: {
40608
+ description: 'Gets the current automation configuration for a customer portal workspace.\nFor customer client sessions, returns customer-specific config if available,\notherwise falls back to workspace-level config.',
40609
+ operationId: 'seamCustomerV1AutomationsGetGet',
40610
+ responses: {
40611
+ 200: {
40612
+ content: {
40613
+ 'application/json': {
40614
+ schema: {
40615
+ properties: {
40616
+ access_rules: {
40617
+ properties: {
40618
+ reservation_created: {
40619
+ properties: {
40620
+ config: {
40621
+ properties: {
40622
+ access_methods: {
40623
+ items: {
40624
+ enum: ['card', 'mobile_key', 'code'],
40625
+ type: 'string',
40626
+ },
40627
+ minItems: 1,
40628
+ type: 'array',
40629
+ },
40630
+ method_issuance_strategy: {
40631
+ enum: [
40632
+ 'first_available',
40633
+ 'first_two_available',
40634
+ 'all_available',
40635
+ ],
40636
+ type: 'string',
40637
+ },
40638
+ },
40639
+ required: [
40640
+ 'access_methods',
40641
+ 'method_issuance_strategy',
40642
+ ],
40643
+ type: 'object',
40644
+ },
40645
+ rule: {
40646
+ enum: ['reservation_created'],
40647
+ type: 'string',
40648
+ },
40649
+ },
40650
+ required: ['rule', 'config'],
40651
+ type: 'object',
40652
+ },
40653
+ reservation_deleted: {
40654
+ properties: {
40655
+ config: {
40656
+ $ref: '#/components/schemas/access_code',
40657
+ },
40658
+ rule: {
40659
+ enum: ['reservation_deleted'],
40660
+ type: 'string',
40661
+ },
40662
+ },
40663
+ required: ['rule', 'config'],
40664
+ type: 'object',
40665
+ },
40666
+ reservation_time_updated: {
40667
+ properties: {
40668
+ config: {
40669
+ $ref: '#/components/schemas/access_code',
40670
+ },
40671
+ rule: {
40672
+ enum: ['reservation_time_updated'],
40673
+ type: 'string',
40674
+ },
40675
+ },
40676
+ required: ['rule', 'config'],
40677
+ type: 'object',
40678
+ },
40679
+ },
40680
+ type: 'object',
40681
+ },
40682
+ ok: { type: 'boolean' },
40683
+ },
40684
+ required: ['ok'],
40685
+ type: 'object',
40686
+ },
40687
+ },
40688
+ },
40689
+ description: 'OK',
40690
+ },
40691
+ 400: { description: 'Bad Request' },
40692
+ 401: { description: 'Unauthorized' },
40693
+ },
40694
+ security: [
40695
+ { console_session_with_workspace: [] },
40696
+ { api_key: [] },
40697
+ { client_session_with_customer: [] },
40698
+ ],
40699
+ summary: '/seam/customer/v1/automations/get',
40700
+ tags: [],
40701
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
40702
+ 'x-fern-sdk-method-name': 'get',
40703
+ 'x-response-key': null,
40704
+ 'x-title': 'Get Customer Portal Automation Configuration',
40705
+ 'x-undocumented': 'Internal endpoint for customer portals.',
40706
+ },
40707
+ },
40708
+ '/seam/customer/v1/automations/update': {
40709
+ patch: {
40710
+ description: 'Updates the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
40711
+ operationId: 'seamCustomerV1AutomationsUpdatePatch',
40712
+ requestBody: {
40713
+ content: {
40714
+ 'application/json': {
40715
+ schema: {
40716
+ properties: {
40717
+ access_rules: {
40718
+ description: 'Access automation rules configuration.',
40719
+ properties: {
40720
+ reservation_created: {
40721
+ properties: {
40722
+ config: {
40723
+ properties: {
40724
+ access_methods: {
40725
+ items: {
40726
+ enum: ['card', 'mobile_key', 'code'],
40727
+ type: 'string',
40728
+ },
40729
+ minItems: 1,
40730
+ type: 'array',
40731
+ },
40732
+ method_issuance_strategy: {
40733
+ enum: [
40734
+ 'first_available',
40735
+ 'first_two_available',
40736
+ 'all_available',
40737
+ ],
40738
+ type: 'string',
40739
+ },
40740
+ },
40741
+ required: [
40742
+ 'access_methods',
40743
+ 'method_issuance_strategy',
40744
+ ],
40745
+ type: 'object',
40746
+ },
40747
+ rule: {
40748
+ enum: ['reservation_created'],
40749
+ type: 'string',
40750
+ },
40751
+ },
40752
+ required: ['rule', 'config'],
40753
+ type: 'object',
40754
+ },
40755
+ reservation_deleted: {
40756
+ properties: {
40757
+ config: { properties: {}, type: 'object' },
40758
+ rule: {
40759
+ enum: ['reservation_deleted'],
40760
+ type: 'string',
40761
+ },
40762
+ },
40763
+ required: ['rule', 'config'],
40764
+ type: 'object',
40765
+ },
40766
+ reservation_time_updated: {
40767
+ properties: {
40768
+ config: { properties: {}, type: 'object' },
40769
+ rule: {
40770
+ enum: ['reservation_time_updated'],
40771
+ type: 'string',
40772
+ },
40773
+ },
40774
+ required: ['rule', 'config'],
40775
+ type: 'object',
40776
+ },
40777
+ },
40778
+ type: 'object',
40779
+ },
40780
+ },
40781
+ type: 'object',
40782
+ },
40783
+ },
40784
+ },
40785
+ },
40786
+ responses: {
40787
+ 200: {
40788
+ content: {
40789
+ 'application/json': {
40790
+ schema: {
40791
+ properties: { ok: { type: 'boolean' } },
40792
+ required: ['ok'],
40793
+ type: 'object',
40794
+ },
40795
+ },
40796
+ },
40797
+ description: 'OK',
40798
+ },
40799
+ 400: { description: 'Bad Request' },
40800
+ 401: { description: 'Unauthorized' },
40801
+ },
40802
+ security: [
40803
+ { console_session_with_workspace: [] },
40804
+ { api_key: [] },
40805
+ { client_session_with_customer: [] },
40806
+ ],
40807
+ summary: '/seam/customer/v1/automations/update',
40808
+ tags: [],
40809
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
40810
+ 'x-fern-sdk-method-name': 'update',
40811
+ 'x-response-key': null,
40812
+ 'x-title': 'Update Customer Portal Automation Configuration',
40813
+ 'x-undocumented': 'Internal endpoint for customer portals.',
40814
+ },
40815
+ post: {
40816
+ description: 'Updates the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
40817
+ operationId: 'seamCustomerV1AutomationsUpdatePost',
40818
+ requestBody: {
40819
+ content: {
40820
+ 'application/json': {
40821
+ schema: {
40822
+ properties: {
40823
+ access_rules: {
40824
+ description: 'Access automation rules configuration.',
40825
+ properties: {
40826
+ reservation_created: {
40827
+ properties: {
40828
+ config: {
40829
+ properties: {
40830
+ access_methods: {
40831
+ items: {
40832
+ enum: ['card', 'mobile_key', 'code'],
40833
+ type: 'string',
40834
+ },
40835
+ minItems: 1,
40836
+ type: 'array',
40837
+ },
40838
+ method_issuance_strategy: {
40839
+ enum: [
40840
+ 'first_available',
40841
+ 'first_two_available',
40842
+ 'all_available',
40843
+ ],
40844
+ type: 'string',
40845
+ },
40846
+ },
40847
+ required: [
40848
+ 'access_methods',
40849
+ 'method_issuance_strategy',
40850
+ ],
40851
+ type: 'object',
40852
+ },
40853
+ rule: {
40854
+ enum: ['reservation_created'],
40855
+ type: 'string',
40856
+ },
40857
+ },
40858
+ required: ['rule', 'config'],
40859
+ type: 'object',
40860
+ },
40861
+ reservation_deleted: {
40862
+ properties: {
40863
+ config: { properties: {}, type: 'object' },
40864
+ rule: {
40865
+ enum: ['reservation_deleted'],
40866
+ type: 'string',
40867
+ },
40868
+ },
40869
+ required: ['rule', 'config'],
40870
+ type: 'object',
40871
+ },
40872
+ reservation_time_updated: {
40873
+ properties: {
40874
+ config: { properties: {}, type: 'object' },
40875
+ rule: {
40876
+ enum: ['reservation_time_updated'],
40877
+ type: 'string',
40878
+ },
40879
+ },
40880
+ required: ['rule', 'config'],
40881
+ type: 'object',
40882
+ },
40883
+ },
40884
+ type: 'object',
40885
+ },
40886
+ },
40887
+ type: 'object',
40888
+ },
40889
+ },
40890
+ },
40891
+ },
40892
+ responses: {
40893
+ 200: {
40894
+ content: {
40895
+ 'application/json': {
40896
+ schema: {
40897
+ properties: { ok: { type: 'boolean' } },
40898
+ required: ['ok'],
40899
+ type: 'object',
40900
+ },
40901
+ },
40902
+ },
40903
+ description: 'OK',
40904
+ },
40905
+ 400: { description: 'Bad Request' },
40906
+ 401: { description: 'Unauthorized' },
40907
+ },
40908
+ security: [
40909
+ { console_session_with_workspace: [] },
40910
+ { api_key: [] },
40911
+ { client_session_with_customer: [] },
40912
+ ],
40913
+ summary: '/seam/customer/v1/automations/update',
40914
+ tags: [],
40915
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
40916
+ 'x-fern-sdk-method-name': 'update',
40917
+ 'x-response-key': null,
40918
+ 'x-title': 'Update Customer Portal Automation Configuration',
40919
+ 'x-undocumented': 'Internal endpoint for customer portals.',
40920
+ },
40921
+ },
40250
40922
  '/seam/customer/v1/portals/get': {
40251
40923
  get: {
40252
40924
  description: 'Retrieves the configuration for a customer portal identified by customer_portal_id.',