@seamapi/types 1.428.0 → 1.429.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.
@@ -23862,9 +23862,9 @@ export default {
23862
23862
  },
23863
23863
  },
23864
23864
  '/access_grants/delete': {
23865
- get: {
23865
+ delete: {
23866
23866
  description: 'Delete an access grant.',
23867
- operationId: 'accessGrantsDeleteGet',
23867
+ operationId: 'accessGrantsDeleteDelete',
23868
23868
  parameters: [
23869
23869
  {
23870
23870
  in: 'query',
@@ -24357,9 +24357,9 @@ export default {
24357
24357
  },
24358
24358
  },
24359
24359
  '/access_methods/delete': {
24360
- get: {
24360
+ delete: {
24361
24361
  description: 'Delete an access method.',
24362
- operationId: 'accessMethodsDeleteGet',
24362
+ operationId: 'accessMethodsDeleteDelete',
24363
24363
  parameters: [
24364
24364
  {
24365
24365
  in: 'query',
@@ -40247,16 +40247,78 @@ export default {
40247
40247
  'x-undocumented': 'Seam Bridge Client only.',
40248
40248
  },
40249
40249
  },
40250
- '/seam/customer/v1/portals/get': {
40250
+ '/seam/customer/v1/automation_runs/list': {
40251
40251
  get: {
40252
- description: 'Retrieves the configuration for a customer portal identified by customer_portal_id.',
40253
- operationId: 'seamCustomerV1PortalsGetGet',
40252
+ description: 'Returns a list of all automation runs for a workspace or customer.',
40253
+ operationId: 'seamCustomerV1AutomationRunsListGet',
40254
40254
  parameters: [
40255
40255
  {
40256
40256
  in: 'query',
40257
- name: 'customer_portal_id',
40258
- required: true,
40259
- schema: { description: 'Customer portal ID.', type: 'string' },
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
+ },
40260
40322
  },
40261
40323
  ],
40262
40324
  responses: {
@@ -40265,43 +40327,71 @@ export default {
40265
40327
  'application/json': {
40266
40328
  schema: {
40267
40329
  properties: {
40268
- customer_portal: {
40269
- properties: {
40270
- business_vertical: {
40271
- description: 'Business vertical of the customer portal.',
40272
- enum: [
40273
- 'short_term_rental',
40274
- 'hospitality',
40275
- 'multi_family',
40276
- 'gym_management',
40277
- 'property_tours',
40278
- ],
40279
- type: 'string',
40280
- },
40281
- features: {
40282
- properties: {
40283
- connect: {
40284
- properties: { exclude: { type: 'boolean' } },
40285
- type: 'object',
40286
- },
40287
- manage_devices: {
40288
- properties: { exclude: { type: 'boolean' } },
40289
- type: 'object',
40290
- },
40291
- organize: {
40292
- properties: { exclude: { type: 'boolean' } },
40293
- type: 'object',
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' },
40294
40368
  },
40369
+ required: ['success', 'rule', 'actions'],
40370
+ type: 'object',
40295
40371
  },
40296
- type: 'object',
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' },
40297
40379
  },
40298
- is_embedded: { type: 'boolean' },
40380
+ required: [
40381
+ 'automation_run_id',
40382
+ 'workspace_id',
40383
+ 'automation_id',
40384
+ 'partner_resource_id',
40385
+ 'created_at',
40386
+ ],
40387
+ type: 'object',
40299
40388
  },
40300
- type: 'object',
40389
+ type: 'array',
40301
40390
  },
40302
40391
  ok: { type: 'boolean' },
40392
+ pagination: { $ref: '#/components/schemas/pagination' },
40303
40393
  },
40304
- required: ['customer_portal', 'ok'],
40394
+ required: ['automation_runs', 'pagination', 'ok'],
40305
40395
  type: 'object',
40306
40396
  },
40307
40397
  },
@@ -40311,30 +40401,69 @@ export default {
40311
40401
  400: { description: 'Bad Request' },
40312
40402
  401: { description: 'Unauthorized' },
40313
40403
  },
40314
- security: [{ client_session_with_customer: [] }],
40315
- summary: '/seam/customer/v1/portals/get',
40404
+ security: [
40405
+ { console_session_with_workspace: [] },
40406
+ { api_key: [] },
40407
+ { client_session_with_customer: [] },
40408
+ ],
40409
+ summary: '/seam/customer/v1/automation_runs/list',
40316
40410
  tags: [],
40317
- 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
40318
- 'x-fern-sdk-method-name': 'get',
40319
- 'x-fern-sdk-return-value': 'customer_portal',
40320
- 'x-response-key': 'customer_portal',
40321
- 'x-title': 'Get Customer Portal Configuration',
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',
40322
40416
  'x-undocumented': 'Internal endpoint for customer portals.',
40323
40417
  },
40324
40418
  post: {
40325
- description: 'Retrieves the configuration for a customer portal identified by customer_portal_id.',
40326
- operationId: 'seamCustomerV1PortalsGetPost',
40419
+ description: 'Returns a list of all automation runs for a workspace or customer.',
40420
+ operationId: 'seamCustomerV1AutomationRunsListPost',
40327
40421
  requestBody: {
40328
40422
  content: {
40329
40423
  'application/json': {
40330
40424
  schema: {
40331
40425
  properties: {
40332
- customer_portal_id: {
40333
- description: 'Customer portal ID.',
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
+ ],
40334
40460
  type: 'string',
40335
40461
  },
40462
+ success: {
40463
+ description: 'Filter automation runs by success status.',
40464
+ type: 'boolean',
40465
+ },
40336
40466
  },
40337
- required: ['customer_portal_id'],
40338
40467
  type: 'object',
40339
40468
  },
40340
40469
  },
@@ -40346,43 +40475,71 @@ export default {
40346
40475
  'application/json': {
40347
40476
  schema: {
40348
40477
  properties: {
40349
- customer_portal: {
40350
- properties: {
40351
- business_vertical: {
40352
- description: 'Business vertical of the customer portal.',
40353
- enum: [
40354
- 'short_term_rental',
40355
- 'hospitality',
40356
- 'multi_family',
40357
- 'gym_management',
40358
- 'property_tours',
40359
- ],
40360
- type: 'string',
40361
- },
40362
- features: {
40363
- properties: {
40364
- connect: {
40365
- properties: { exclude: { type: 'boolean' } },
40366
- type: 'object',
40367
- },
40368
- manage_devices: {
40369
- properties: { exclude: { type: 'boolean' } },
40370
- type: 'object',
40371
- },
40372
- organize: {
40373
- properties: { exclude: { type: 'boolean' } },
40374
- type: 'object',
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' },
40375
40516
  },
40517
+ required: ['success', 'rule', 'actions'],
40518
+ type: 'object',
40376
40519
  },
40377
- type: 'object',
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' },
40378
40527
  },
40379
- is_embedded: { type: 'boolean' },
40528
+ required: [
40529
+ 'automation_run_id',
40530
+ 'workspace_id',
40531
+ 'automation_id',
40532
+ 'partner_resource_id',
40533
+ 'created_at',
40534
+ ],
40535
+ type: 'object',
40380
40536
  },
40381
- type: 'object',
40537
+ type: 'array',
40382
40538
  },
40383
40539
  ok: { type: 'boolean' },
40540
+ pagination: { $ref: '#/components/schemas/pagination' },
40384
40541
  },
40385
- required: ['customer_portal', 'ok'],
40542
+ required: ['automation_runs', 'pagination', 'ok'],
40386
40543
  type: 'object',
40387
40544
  },
40388
40545
  },
@@ -40392,32 +40549,684 @@ export default {
40392
40549
  400: { description: 'Bad Request' },
40393
40550
  401: { description: 'Unauthorized' },
40394
40551
  },
40395
- security: [{ client_session_with_customer: [] }],
40396
- summary: '/seam/customer/v1/portals/get',
40552
+ security: [
40553
+ { console_session_with_workspace: [] },
40554
+ { api_key: [] },
40555
+ { client_session_with_customer: [] },
40556
+ ],
40557
+ summary: '/seam/customer/v1/automation_runs/list',
40397
40558
  tags: [],
40398
- 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
40399
- 'x-fern-sdk-method-name': 'get',
40400
- 'x-fern-sdk-return-value': 'customer_portal',
40401
- 'x-response-key': 'customer_portal',
40402
- 'x-title': 'Get Customer Portal Configuration',
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',
40403
40564
  'x-undocumented': 'Internal endpoint for customer portals.',
40404
40565
  },
40405
40566
  },
40406
- '/seam/customer/v1/settings/update': {
40407
- patch: {
40408
- description: 'Updates the settings for a customer portal workspace.',
40409
- operationId: 'seamCustomerV1SettingsUpdatePatch',
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',
40410
40571
  requestBody: {
40411
40572
  content: {
40412
- 'application/json': {
40413
- schema: {
40414
- properties: {
40415
- business_vertical: {
40416
- description: 'Business vertical to set on the workspace.',
40417
- enum: [
40418
- 'short_term_rental',
40419
- 'hospitality',
40420
- 'multi_family',
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
+ post: {
40606
+ description: 'Deletes the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
40607
+ operationId: 'seamCustomerV1AutomationsDeletePost',
40608
+ requestBody: {
40609
+ content: {
40610
+ 'application/json': { schema: { properties: {}, type: 'object' } },
40611
+ },
40612
+ },
40613
+ responses: {
40614
+ 200: {
40615
+ content: {
40616
+ 'application/json': {
40617
+ schema: {
40618
+ properties: { ok: { type: 'boolean' } },
40619
+ required: ['ok'],
40620
+ type: 'object',
40621
+ },
40622
+ },
40623
+ },
40624
+ description: 'OK',
40625
+ },
40626
+ 400: { description: 'Bad Request' },
40627
+ 401: { description: 'Unauthorized' },
40628
+ },
40629
+ security: [
40630
+ { console_session_with_workspace: [] },
40631
+ { api_key: [] },
40632
+ { client_session_with_customer: [] },
40633
+ ],
40634
+ summary: '/seam/customer/v1/automations/delete',
40635
+ tags: [],
40636
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
40637
+ 'x-fern-sdk-method-name': 'delete',
40638
+ 'x-response-key': null,
40639
+ 'x-title': 'Delete Customer Portal Automation Configuration',
40640
+ 'x-undocumented': 'Internal endpoint for customer portals.',
40641
+ },
40642
+ },
40643
+ '/seam/customer/v1/automations/get': {
40644
+ get: {
40645
+ 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.',
40646
+ operationId: 'seamCustomerV1AutomationsGetGet',
40647
+ responses: {
40648
+ 200: {
40649
+ content: {
40650
+ 'application/json': {
40651
+ schema: {
40652
+ properties: {
40653
+ access_rules: {
40654
+ properties: {
40655
+ reservation_created: {
40656
+ properties: {
40657
+ config: {
40658
+ properties: {
40659
+ access_methods: {
40660
+ items: {
40661
+ enum: ['card', 'mobile_key', 'code'],
40662
+ type: 'string',
40663
+ },
40664
+ minItems: 1,
40665
+ type: 'array',
40666
+ },
40667
+ method_issuance_strategy: {
40668
+ enum: [
40669
+ 'first_available',
40670
+ 'first_two_available',
40671
+ 'all_available',
40672
+ ],
40673
+ type: 'string',
40674
+ },
40675
+ },
40676
+ required: [
40677
+ 'access_methods',
40678
+ 'method_issuance_strategy',
40679
+ ],
40680
+ type: 'object',
40681
+ },
40682
+ rule: {
40683
+ enum: ['reservation_created'],
40684
+ type: 'string',
40685
+ },
40686
+ },
40687
+ required: ['rule', 'config'],
40688
+ type: 'object',
40689
+ },
40690
+ reservation_deleted: {
40691
+ properties: {
40692
+ config: {
40693
+ $ref: '#/components/schemas/access_code',
40694
+ },
40695
+ rule: {
40696
+ enum: ['reservation_deleted'],
40697
+ type: 'string',
40698
+ },
40699
+ },
40700
+ required: ['rule', 'config'],
40701
+ type: 'object',
40702
+ },
40703
+ reservation_time_updated: {
40704
+ properties: {
40705
+ config: {
40706
+ $ref: '#/components/schemas/access_code',
40707
+ },
40708
+ rule: {
40709
+ enum: ['reservation_time_updated'],
40710
+ type: 'string',
40711
+ },
40712
+ },
40713
+ required: ['rule', 'config'],
40714
+ type: 'object',
40715
+ },
40716
+ },
40717
+ type: 'object',
40718
+ },
40719
+ ok: { type: 'boolean' },
40720
+ },
40721
+ required: ['ok'],
40722
+ type: 'object',
40723
+ },
40724
+ },
40725
+ },
40726
+ description: 'OK',
40727
+ },
40728
+ 400: { description: 'Bad Request' },
40729
+ 401: { description: 'Unauthorized' },
40730
+ },
40731
+ security: [
40732
+ { console_session_with_workspace: [] },
40733
+ { api_key: [] },
40734
+ { client_session_with_customer: [] },
40735
+ ],
40736
+ summary: '/seam/customer/v1/automations/get',
40737
+ tags: [],
40738
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
40739
+ 'x-fern-sdk-method-name': 'get',
40740
+ 'x-response-key': null,
40741
+ 'x-title': 'Get Customer Portal Automation Configuration',
40742
+ 'x-undocumented': 'Internal endpoint for customer portals.',
40743
+ },
40744
+ post: {
40745
+ 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.',
40746
+ operationId: 'seamCustomerV1AutomationsGetPost',
40747
+ responses: {
40748
+ 200: {
40749
+ content: {
40750
+ 'application/json': {
40751
+ schema: {
40752
+ properties: {
40753
+ access_rules: {
40754
+ properties: {
40755
+ reservation_created: {
40756
+ properties: {
40757
+ config: {
40758
+ properties: {
40759
+ access_methods: {
40760
+ items: {
40761
+ enum: ['card', 'mobile_key', 'code'],
40762
+ type: 'string',
40763
+ },
40764
+ minItems: 1,
40765
+ type: 'array',
40766
+ },
40767
+ method_issuance_strategy: {
40768
+ enum: [
40769
+ 'first_available',
40770
+ 'first_two_available',
40771
+ 'all_available',
40772
+ ],
40773
+ type: 'string',
40774
+ },
40775
+ },
40776
+ required: [
40777
+ 'access_methods',
40778
+ 'method_issuance_strategy',
40779
+ ],
40780
+ type: 'object',
40781
+ },
40782
+ rule: {
40783
+ enum: ['reservation_created'],
40784
+ type: 'string',
40785
+ },
40786
+ },
40787
+ required: ['rule', 'config'],
40788
+ type: 'object',
40789
+ },
40790
+ reservation_deleted: {
40791
+ properties: {
40792
+ config: {
40793
+ $ref: '#/components/schemas/access_code',
40794
+ },
40795
+ rule: {
40796
+ enum: ['reservation_deleted'],
40797
+ type: 'string',
40798
+ },
40799
+ },
40800
+ required: ['rule', 'config'],
40801
+ type: 'object',
40802
+ },
40803
+ reservation_time_updated: {
40804
+ properties: {
40805
+ config: {
40806
+ $ref: '#/components/schemas/access_code',
40807
+ },
40808
+ rule: {
40809
+ enum: ['reservation_time_updated'],
40810
+ type: 'string',
40811
+ },
40812
+ },
40813
+ required: ['rule', 'config'],
40814
+ type: 'object',
40815
+ },
40816
+ },
40817
+ type: 'object',
40818
+ },
40819
+ ok: { type: 'boolean' },
40820
+ },
40821
+ required: ['ok'],
40822
+ type: 'object',
40823
+ },
40824
+ },
40825
+ },
40826
+ description: 'OK',
40827
+ },
40828
+ 400: { description: 'Bad Request' },
40829
+ 401: { description: 'Unauthorized' },
40830
+ },
40831
+ security: [
40832
+ { console_session_with_workspace: [] },
40833
+ { api_key: [] },
40834
+ { client_session_with_customer: [] },
40835
+ ],
40836
+ summary: '/seam/customer/v1/automations/get',
40837
+ tags: [],
40838
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
40839
+ 'x-fern-sdk-method-name': 'get',
40840
+ 'x-response-key': null,
40841
+ 'x-title': 'Get Customer Portal Automation Configuration',
40842
+ 'x-undocumented': 'Internal endpoint for customer portals.',
40843
+ },
40844
+ },
40845
+ '/seam/customer/v1/automations/update': {
40846
+ patch: {
40847
+ description: 'Updates the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
40848
+ operationId: 'seamCustomerV1AutomationsUpdatePatch',
40849
+ requestBody: {
40850
+ content: {
40851
+ 'application/json': {
40852
+ schema: {
40853
+ properties: {
40854
+ access_rules: {
40855
+ description: 'Access automation rules configuration.',
40856
+ properties: {
40857
+ reservation_created: {
40858
+ properties: {
40859
+ config: {
40860
+ properties: {
40861
+ access_methods: {
40862
+ items: {
40863
+ enum: ['card', 'mobile_key', 'code'],
40864
+ type: 'string',
40865
+ },
40866
+ minItems: 1,
40867
+ type: 'array',
40868
+ },
40869
+ method_issuance_strategy: {
40870
+ enum: [
40871
+ 'first_available',
40872
+ 'first_two_available',
40873
+ 'all_available',
40874
+ ],
40875
+ type: 'string',
40876
+ },
40877
+ },
40878
+ required: [
40879
+ 'access_methods',
40880
+ 'method_issuance_strategy',
40881
+ ],
40882
+ type: 'object',
40883
+ },
40884
+ rule: {
40885
+ enum: ['reservation_created'],
40886
+ type: 'string',
40887
+ },
40888
+ },
40889
+ required: ['rule', 'config'],
40890
+ type: 'object',
40891
+ },
40892
+ reservation_deleted: {
40893
+ properties: {
40894
+ config: { properties: {}, type: 'object' },
40895
+ rule: {
40896
+ enum: ['reservation_deleted'],
40897
+ type: 'string',
40898
+ },
40899
+ },
40900
+ required: ['rule', 'config'],
40901
+ type: 'object',
40902
+ },
40903
+ reservation_time_updated: {
40904
+ properties: {
40905
+ config: { properties: {}, type: 'object' },
40906
+ rule: {
40907
+ enum: ['reservation_time_updated'],
40908
+ type: 'string',
40909
+ },
40910
+ },
40911
+ required: ['rule', 'config'],
40912
+ type: 'object',
40913
+ },
40914
+ },
40915
+ type: 'object',
40916
+ },
40917
+ },
40918
+ type: 'object',
40919
+ },
40920
+ },
40921
+ },
40922
+ },
40923
+ responses: {
40924
+ 200: {
40925
+ content: {
40926
+ 'application/json': {
40927
+ schema: {
40928
+ properties: { ok: { type: 'boolean' } },
40929
+ required: ['ok'],
40930
+ type: 'object',
40931
+ },
40932
+ },
40933
+ },
40934
+ description: 'OK',
40935
+ },
40936
+ 400: { description: 'Bad Request' },
40937
+ 401: { description: 'Unauthorized' },
40938
+ },
40939
+ security: [
40940
+ { console_session_with_workspace: [] },
40941
+ { api_key: [] },
40942
+ { client_session_with_customer: [] },
40943
+ ],
40944
+ summary: '/seam/customer/v1/automations/update',
40945
+ tags: [],
40946
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
40947
+ 'x-fern-sdk-method-name': 'update',
40948
+ 'x-response-key': null,
40949
+ 'x-title': 'Update Customer Portal Automation Configuration',
40950
+ 'x-undocumented': 'Internal endpoint for customer portals.',
40951
+ },
40952
+ post: {
40953
+ description: 'Updates the automation configuration for a customer portal workspace.\nSupports both console session and customer client session authentication.',
40954
+ operationId: 'seamCustomerV1AutomationsUpdatePost',
40955
+ requestBody: {
40956
+ content: {
40957
+ 'application/json': {
40958
+ schema: {
40959
+ properties: {
40960
+ access_rules: {
40961
+ description: 'Access automation rules configuration.',
40962
+ properties: {
40963
+ reservation_created: {
40964
+ properties: {
40965
+ config: {
40966
+ properties: {
40967
+ access_methods: {
40968
+ items: {
40969
+ enum: ['card', 'mobile_key', 'code'],
40970
+ type: 'string',
40971
+ },
40972
+ minItems: 1,
40973
+ type: 'array',
40974
+ },
40975
+ method_issuance_strategy: {
40976
+ enum: [
40977
+ 'first_available',
40978
+ 'first_two_available',
40979
+ 'all_available',
40980
+ ],
40981
+ type: 'string',
40982
+ },
40983
+ },
40984
+ required: [
40985
+ 'access_methods',
40986
+ 'method_issuance_strategy',
40987
+ ],
40988
+ type: 'object',
40989
+ },
40990
+ rule: {
40991
+ enum: ['reservation_created'],
40992
+ type: 'string',
40993
+ },
40994
+ },
40995
+ required: ['rule', 'config'],
40996
+ type: 'object',
40997
+ },
40998
+ reservation_deleted: {
40999
+ properties: {
41000
+ config: { properties: {}, type: 'object' },
41001
+ rule: {
41002
+ enum: ['reservation_deleted'],
41003
+ type: 'string',
41004
+ },
41005
+ },
41006
+ required: ['rule', 'config'],
41007
+ type: 'object',
41008
+ },
41009
+ reservation_time_updated: {
41010
+ properties: {
41011
+ config: { properties: {}, type: 'object' },
41012
+ rule: {
41013
+ enum: ['reservation_time_updated'],
41014
+ type: 'string',
41015
+ },
41016
+ },
41017
+ required: ['rule', 'config'],
41018
+ type: 'object',
41019
+ },
41020
+ },
41021
+ type: 'object',
41022
+ },
41023
+ },
41024
+ type: 'object',
41025
+ },
41026
+ },
41027
+ },
41028
+ },
41029
+ responses: {
41030
+ 200: {
41031
+ content: {
41032
+ 'application/json': {
41033
+ schema: {
41034
+ properties: { ok: { type: 'boolean' } },
41035
+ required: ['ok'],
41036
+ type: 'object',
41037
+ },
41038
+ },
41039
+ },
41040
+ description: 'OK',
41041
+ },
41042
+ 400: { description: 'Bad Request' },
41043
+ 401: { description: 'Unauthorized' },
41044
+ },
41045
+ security: [
41046
+ { console_session_with_workspace: [] },
41047
+ { api_key: [] },
41048
+ { client_session_with_customer: [] },
41049
+ ],
41050
+ summary: '/seam/customer/v1/automations/update',
41051
+ tags: [],
41052
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'automations'],
41053
+ 'x-fern-sdk-method-name': 'update',
41054
+ 'x-response-key': null,
41055
+ 'x-title': 'Update Customer Portal Automation Configuration',
41056
+ 'x-undocumented': 'Internal endpoint for customer portals.',
41057
+ },
41058
+ },
41059
+ '/seam/customer/v1/portals/get': {
41060
+ get: {
41061
+ description: 'Retrieves the configuration for a customer portal identified by customer_portal_id.',
41062
+ operationId: 'seamCustomerV1PortalsGetGet',
41063
+ parameters: [
41064
+ {
41065
+ in: 'query',
41066
+ name: 'customer_portal_id',
41067
+ required: true,
41068
+ schema: { description: 'Customer portal ID.', type: 'string' },
41069
+ },
41070
+ ],
41071
+ responses: {
41072
+ 200: {
41073
+ content: {
41074
+ 'application/json': {
41075
+ schema: {
41076
+ properties: {
41077
+ customer_portal: {
41078
+ properties: {
41079
+ business_vertical: {
41080
+ description: 'Business vertical of the customer portal.',
41081
+ enum: [
41082
+ 'short_term_rental',
41083
+ 'hospitality',
41084
+ 'multi_family',
41085
+ 'gym_management',
41086
+ 'property_tours',
41087
+ ],
41088
+ type: 'string',
41089
+ },
41090
+ features: {
41091
+ properties: {
41092
+ connect: {
41093
+ properties: { exclude: { type: 'boolean' } },
41094
+ type: 'object',
41095
+ },
41096
+ manage_devices: {
41097
+ properties: { exclude: { type: 'boolean' } },
41098
+ type: 'object',
41099
+ },
41100
+ organize: {
41101
+ properties: { exclude: { type: 'boolean' } },
41102
+ type: 'object',
41103
+ },
41104
+ },
41105
+ type: 'object',
41106
+ },
41107
+ is_embedded: { type: 'boolean' },
41108
+ },
41109
+ type: 'object',
41110
+ },
41111
+ ok: { type: 'boolean' },
41112
+ },
41113
+ required: ['customer_portal', 'ok'],
41114
+ type: 'object',
41115
+ },
41116
+ },
41117
+ },
41118
+ description: 'OK',
41119
+ },
41120
+ 400: { description: 'Bad Request' },
41121
+ 401: { description: 'Unauthorized' },
41122
+ },
41123
+ security: [{ client_session_with_customer: [] }],
41124
+ summary: '/seam/customer/v1/portals/get',
41125
+ tags: [],
41126
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
41127
+ 'x-fern-sdk-method-name': 'get',
41128
+ 'x-fern-sdk-return-value': 'customer_portal',
41129
+ 'x-response-key': 'customer_portal',
41130
+ 'x-title': 'Get Customer Portal Configuration',
41131
+ 'x-undocumented': 'Internal endpoint for customer portals.',
41132
+ },
41133
+ post: {
41134
+ description: 'Retrieves the configuration for a customer portal identified by customer_portal_id.',
41135
+ operationId: 'seamCustomerV1PortalsGetPost',
41136
+ requestBody: {
41137
+ content: {
41138
+ 'application/json': {
41139
+ schema: {
41140
+ properties: {
41141
+ customer_portal_id: {
41142
+ description: 'Customer portal ID.',
41143
+ type: 'string',
41144
+ },
41145
+ },
41146
+ required: ['customer_portal_id'],
41147
+ type: 'object',
41148
+ },
41149
+ },
41150
+ },
41151
+ },
41152
+ responses: {
41153
+ 200: {
41154
+ content: {
41155
+ 'application/json': {
41156
+ schema: {
41157
+ properties: {
41158
+ customer_portal: {
41159
+ properties: {
41160
+ business_vertical: {
41161
+ description: 'Business vertical of the customer portal.',
41162
+ enum: [
41163
+ 'short_term_rental',
41164
+ 'hospitality',
41165
+ 'multi_family',
41166
+ 'gym_management',
41167
+ 'property_tours',
41168
+ ],
41169
+ type: 'string',
41170
+ },
41171
+ features: {
41172
+ properties: {
41173
+ connect: {
41174
+ properties: { exclude: { type: 'boolean' } },
41175
+ type: 'object',
41176
+ },
41177
+ manage_devices: {
41178
+ properties: { exclude: { type: 'boolean' } },
41179
+ type: 'object',
41180
+ },
41181
+ organize: {
41182
+ properties: { exclude: { type: 'boolean' } },
41183
+ type: 'object',
41184
+ },
41185
+ },
41186
+ type: 'object',
41187
+ },
41188
+ is_embedded: { type: 'boolean' },
41189
+ },
41190
+ type: 'object',
41191
+ },
41192
+ ok: { type: 'boolean' },
41193
+ },
41194
+ required: ['customer_portal', 'ok'],
41195
+ type: 'object',
41196
+ },
41197
+ },
41198
+ },
41199
+ description: 'OK',
41200
+ },
41201
+ 400: { description: 'Bad Request' },
41202
+ 401: { description: 'Unauthorized' },
41203
+ },
41204
+ security: [{ client_session_with_customer: [] }],
41205
+ summary: '/seam/customer/v1/portals/get',
41206
+ tags: [],
41207
+ 'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'portals'],
41208
+ 'x-fern-sdk-method-name': 'get',
41209
+ 'x-fern-sdk-return-value': 'customer_portal',
41210
+ 'x-response-key': 'customer_portal',
41211
+ 'x-title': 'Get Customer Portal Configuration',
41212
+ 'x-undocumented': 'Internal endpoint for customer portals.',
41213
+ },
41214
+ },
41215
+ '/seam/customer/v1/settings/update': {
41216
+ patch: {
41217
+ description: 'Updates the settings for a customer portal workspace.',
41218
+ operationId: 'seamCustomerV1SettingsUpdatePatch',
41219
+ requestBody: {
41220
+ content: {
41221
+ 'application/json': {
41222
+ schema: {
41223
+ properties: {
41224
+ business_vertical: {
41225
+ description: 'Business vertical to set on the workspace.',
41226
+ enum: [
41227
+ 'short_term_rental',
41228
+ 'hospitality',
41229
+ 'multi_family',
40421
41230
  'gym_management',
40422
41231
  'property_tours',
40423
41232
  ],
@@ -44955,9 +45764,9 @@ export default {
44955
45764
  },
44956
45765
  },
44957
45766
  '/unstable_access_grants/delete': {
44958
- get: {
45767
+ delete: {
44959
45768
  description: 'Deletes an access grant.',
44960
- operationId: 'unstableAccessGrantsDeleteGet',
45769
+ operationId: 'unstableAccessGrantsDeleteDelete',
44961
45770
  parameters: [
44962
45771
  {
44963
45772
  in: 'query',
@@ -45324,9 +46133,9 @@ export default {
45324
46133
  },
45325
46134
  },
45326
46135
  '/unstable_access_methods/delete': {
45327
- get: {
46136
+ delete: {
45328
46137
  description: 'Deletes an access method.',
45329
- operationId: 'unstableAccessMethodsDeleteGet',
46138
+ operationId: 'unstableAccessMethodsDeleteDelete',
45330
46139
  parameters: [
45331
46140
  {
45332
46141
  in: 'query',