@seamapi/types 1.511.0 → 1.513.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.
@@ -39893,13 +39893,21 @@ export default {
39893
39893
  {
39894
39894
  in: 'query',
39895
39895
  name: 'instant_key_id',
39896
- required: true,
39897
39896
  schema: {
39898
39897
  description: 'ID of the instant key to get.',
39899
39898
  format: 'uuid',
39900
39899
  type: 'string',
39901
39900
  },
39902
39901
  },
39902
+ {
39903
+ in: 'query',
39904
+ name: 'instant_key_url',
39905
+ schema: {
39906
+ description: 'URL of the instant key to get.',
39907
+ format: 'uri',
39908
+ type: 'string',
39909
+ },
39910
+ },
39903
39911
  ],
39904
39912
  responses: {
39905
39913
  200: {
@@ -39946,8 +39954,12 @@ export default {
39946
39954
  format: 'uuid',
39947
39955
  type: 'string',
39948
39956
  },
39957
+ instant_key_url: {
39958
+ description: 'URL of the instant key to get.',
39959
+ format: 'uri',
39960
+ type: 'string',
39961
+ },
39949
39962
  },
39950
- required: ['instant_key_id'],
39951
39963
  type: 'object',
39952
39964
  },
39953
39965
  },
@@ -43242,6 +43254,486 @@ export default {
43242
43254
  'x-undocumented': 'Internal endpoint for Console',
43243
43255
  },
43244
43256
  },
43257
+ '/seam/console/v1/timelines/get': {
43258
+ get: {
43259
+ description: 'Returns timeline entries for a resource and its child resources, grouped by entry groups.',
43260
+ operationId: 'seamConsoleV1TimelinesGetGet',
43261
+ parameters: [
43262
+ {
43263
+ in: 'query',
43264
+ name: 'resource_id',
43265
+ required: true,
43266
+ schema: {
43267
+ description: 'ID of the resource to get timelines for.',
43268
+ format: 'uuid',
43269
+ type: 'string',
43270
+ },
43271
+ },
43272
+ {
43273
+ in: 'query',
43274
+ name: 'limit',
43275
+ required: false,
43276
+ schema: {
43277
+ default: 50,
43278
+ description: 'Maximum number of timeline entry groups to return per page.',
43279
+ exclusiveMinimum: true,
43280
+ minimum: 0,
43281
+ type: 'integer',
43282
+ },
43283
+ },
43284
+ {
43285
+ in: 'query',
43286
+ name: 'created_before',
43287
+ required: false,
43288
+ schema: {
43289
+ description: 'Timestamp by which to limit returned timeline entries. Returns entries created before this timestamp.',
43290
+ format: 'date-time',
43291
+ type: 'string',
43292
+ },
43293
+ },
43294
+ {
43295
+ in: 'query',
43296
+ name: 'page_cursor',
43297
+ required: false,
43298
+ schema: {
43299
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
43300
+ type: 'string',
43301
+ },
43302
+ },
43303
+ ],
43304
+ responses: {
43305
+ 200: {
43306
+ content: {
43307
+ 'application/json': {
43308
+ schema: {
43309
+ properties: {
43310
+ ok: { type: 'boolean' },
43311
+ pagination: { $ref: '#/components/schemas/pagination' },
43312
+ timeline: {
43313
+ items: {
43314
+ properties: {
43315
+ context: {
43316
+ oneOf: [
43317
+ {
43318
+ properties: {
43319
+ context_type: {
43320
+ enum: ['request'],
43321
+ type: 'string',
43322
+ },
43323
+ request_id: { type: 'string' },
43324
+ request_payload: {
43325
+ additionalProperties: {
43326
+ $ref: '#/components/schemas/access_code',
43327
+ },
43328
+ type: 'object',
43329
+ },
43330
+ response_payload: {
43331
+ additionalProperties: {
43332
+ $ref: '#/components/schemas/access_code',
43333
+ },
43334
+ type: 'object',
43335
+ },
43336
+ },
43337
+ required: [
43338
+ 'context_type',
43339
+ 'request_id',
43340
+ 'request_payload',
43341
+ 'response_payload',
43342
+ ],
43343
+ type: 'object',
43344
+ },
43345
+ {
43346
+ properties: {
43347
+ context_type: {
43348
+ enum: ['job'],
43349
+ type: 'string',
43350
+ },
43351
+ job_id: { type: 'string' },
43352
+ },
43353
+ required: ['context_type', 'job_id'],
43354
+ type: 'object',
43355
+ },
43356
+ ],
43357
+ },
43358
+ created_at: { type: 'string' },
43359
+ entries: {
43360
+ items: {
43361
+ properties: {
43362
+ body: {
43363
+ oneOf: [
43364
+ {
43365
+ properties: {
43366
+ description: { type: 'string' },
43367
+ entry_type: {
43368
+ enum: ['resource_created'],
43369
+ type: 'string',
43370
+ },
43371
+ },
43372
+ required: ['entry_type', 'description'],
43373
+ type: 'object',
43374
+ },
43375
+ {
43376
+ properties: {
43377
+ description: { type: 'string' },
43378
+ entry_type: {
43379
+ enum: ['resource_updated'],
43380
+ type: 'string',
43381
+ },
43382
+ errors: {
43383
+ items: { type: 'string' },
43384
+ type: 'array',
43385
+ },
43386
+ properties_updated: {
43387
+ additionalProperties: {
43388
+ $ref: '#/components/schemas/access_code',
43389
+ },
43390
+ type: 'object',
43391
+ },
43392
+ warnings: {
43393
+ items: { type: 'string' },
43394
+ type: 'array',
43395
+ },
43396
+ },
43397
+ required: ['entry_type', 'description'],
43398
+ type: 'object',
43399
+ },
43400
+ {
43401
+ properties: {
43402
+ description: { type: 'string' },
43403
+ entry_type: {
43404
+ enum: ['resource_deleted'],
43405
+ type: 'string',
43406
+ },
43407
+ },
43408
+ required: ['entry_type', 'description'],
43409
+ type: 'object',
43410
+ },
43411
+ {
43412
+ properties: {
43413
+ entry_type: {
43414
+ enum: ['event'],
43415
+ type: 'string',
43416
+ },
43417
+ event_id: { type: 'string' },
43418
+ event_type: { type: 'string' },
43419
+ },
43420
+ required: [
43421
+ 'entry_type',
43422
+ 'event_type',
43423
+ 'event_id',
43424
+ ],
43425
+ type: 'object',
43426
+ },
43427
+ {
43428
+ properties: {
43429
+ description: { type: 'string' },
43430
+ entry_type: {
43431
+ enum: ['provider_call'],
43432
+ type: 'string',
43433
+ },
43434
+ response_body: {
43435
+ additionalProperties: {
43436
+ $ref: '#/components/schemas/access_code',
43437
+ },
43438
+ type: 'object',
43439
+ },
43440
+ response_status_code: {
43441
+ format: 'float',
43442
+ type: 'number',
43443
+ },
43444
+ },
43445
+ required: [
43446
+ 'entry_type',
43447
+ 'description',
43448
+ 'response_status_code',
43449
+ ],
43450
+ type: 'object',
43451
+ },
43452
+ ],
43453
+ },
43454
+ created_at: { type: 'string' },
43455
+ entry_type: { type: 'string' },
43456
+ resource_id: { type: 'string' },
43457
+ resource_type: { type: 'string' },
43458
+ },
43459
+ required: [
43460
+ 'resource_type',
43461
+ 'resource_id',
43462
+ 'entry_type',
43463
+ 'body',
43464
+ 'created_at',
43465
+ ],
43466
+ type: 'object',
43467
+ },
43468
+ type: 'array',
43469
+ },
43470
+ },
43471
+ required: ['context', 'entries', 'created_at'],
43472
+ type: 'object',
43473
+ },
43474
+ type: 'array',
43475
+ },
43476
+ },
43477
+ required: ['timeline', 'pagination', 'ok'],
43478
+ type: 'object',
43479
+ },
43480
+ },
43481
+ },
43482
+ description: 'OK',
43483
+ },
43484
+ 400: { description: 'Bad Request' },
43485
+ 401: { description: 'Unauthorized' },
43486
+ },
43487
+ security: [
43488
+ { client_session: [] },
43489
+ { pat_with_workspace: [] },
43490
+ { console_session_with_workspace: [] },
43491
+ { api_key: [] },
43492
+ ],
43493
+ summary: '/seam/console/v1/timelines/get',
43494
+ tags: [],
43495
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'timelines'],
43496
+ 'x-fern-sdk-method-name': 'get',
43497
+ 'x-fern-sdk-return-value': 'timeline',
43498
+ 'x-response-key': 'timeline',
43499
+ 'x-title': 'Get Timeline Entries',
43500
+ 'x-undocumented': 'Internal endpoint for Console',
43501
+ },
43502
+ post: {
43503
+ description: 'Returns timeline entries for a resource and its child resources, grouped by entry groups.',
43504
+ operationId: 'seamConsoleV1TimelinesGetPost',
43505
+ requestBody: {
43506
+ content: {
43507
+ 'application/json': {
43508
+ schema: {
43509
+ properties: {
43510
+ created_before: {
43511
+ description: 'Timestamp by which to limit returned timeline entries. Returns entries created before this timestamp.',
43512
+ format: 'date-time',
43513
+ type: 'string',
43514
+ },
43515
+ limit: {
43516
+ default: 50,
43517
+ description: 'Maximum number of timeline entry groups to return per page.',
43518
+ exclusiveMinimum: true,
43519
+ minimum: 0,
43520
+ type: 'integer',
43521
+ },
43522
+ page_cursor: {
43523
+ description: "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
43524
+ type: 'string',
43525
+ },
43526
+ resource_id: {
43527
+ description: 'ID of the resource to get timelines for.',
43528
+ format: 'uuid',
43529
+ type: 'string',
43530
+ },
43531
+ },
43532
+ required: ['resource_id'],
43533
+ type: 'object',
43534
+ },
43535
+ },
43536
+ },
43537
+ },
43538
+ responses: {
43539
+ 200: {
43540
+ content: {
43541
+ 'application/json': {
43542
+ schema: {
43543
+ properties: {
43544
+ ok: { type: 'boolean' },
43545
+ pagination: { $ref: '#/components/schemas/pagination' },
43546
+ timeline: {
43547
+ items: {
43548
+ properties: {
43549
+ context: {
43550
+ oneOf: [
43551
+ {
43552
+ properties: {
43553
+ context_type: {
43554
+ enum: ['request'],
43555
+ type: 'string',
43556
+ },
43557
+ request_id: { type: 'string' },
43558
+ request_payload: {
43559
+ additionalProperties: {
43560
+ $ref: '#/components/schemas/access_code',
43561
+ },
43562
+ type: 'object',
43563
+ },
43564
+ response_payload: {
43565
+ additionalProperties: {
43566
+ $ref: '#/components/schemas/access_code',
43567
+ },
43568
+ type: 'object',
43569
+ },
43570
+ },
43571
+ required: [
43572
+ 'context_type',
43573
+ 'request_id',
43574
+ 'request_payload',
43575
+ 'response_payload',
43576
+ ],
43577
+ type: 'object',
43578
+ },
43579
+ {
43580
+ properties: {
43581
+ context_type: {
43582
+ enum: ['job'],
43583
+ type: 'string',
43584
+ },
43585
+ job_id: { type: 'string' },
43586
+ },
43587
+ required: ['context_type', 'job_id'],
43588
+ type: 'object',
43589
+ },
43590
+ ],
43591
+ },
43592
+ created_at: { type: 'string' },
43593
+ entries: {
43594
+ items: {
43595
+ properties: {
43596
+ body: {
43597
+ oneOf: [
43598
+ {
43599
+ properties: {
43600
+ description: { type: 'string' },
43601
+ entry_type: {
43602
+ enum: ['resource_created'],
43603
+ type: 'string',
43604
+ },
43605
+ },
43606
+ required: ['entry_type', 'description'],
43607
+ type: 'object',
43608
+ },
43609
+ {
43610
+ properties: {
43611
+ description: { type: 'string' },
43612
+ entry_type: {
43613
+ enum: ['resource_updated'],
43614
+ type: 'string',
43615
+ },
43616
+ errors: {
43617
+ items: { type: 'string' },
43618
+ type: 'array',
43619
+ },
43620
+ properties_updated: {
43621
+ additionalProperties: {
43622
+ $ref: '#/components/schemas/access_code',
43623
+ },
43624
+ type: 'object',
43625
+ },
43626
+ warnings: {
43627
+ items: { type: 'string' },
43628
+ type: 'array',
43629
+ },
43630
+ },
43631
+ required: ['entry_type', 'description'],
43632
+ type: 'object',
43633
+ },
43634
+ {
43635
+ properties: {
43636
+ description: { type: 'string' },
43637
+ entry_type: {
43638
+ enum: ['resource_deleted'],
43639
+ type: 'string',
43640
+ },
43641
+ },
43642
+ required: ['entry_type', 'description'],
43643
+ type: 'object',
43644
+ },
43645
+ {
43646
+ properties: {
43647
+ entry_type: {
43648
+ enum: ['event'],
43649
+ type: 'string',
43650
+ },
43651
+ event_id: { type: 'string' },
43652
+ event_type: { type: 'string' },
43653
+ },
43654
+ required: [
43655
+ 'entry_type',
43656
+ 'event_type',
43657
+ 'event_id',
43658
+ ],
43659
+ type: 'object',
43660
+ },
43661
+ {
43662
+ properties: {
43663
+ description: { type: 'string' },
43664
+ entry_type: {
43665
+ enum: ['provider_call'],
43666
+ type: 'string',
43667
+ },
43668
+ response_body: {
43669
+ additionalProperties: {
43670
+ $ref: '#/components/schemas/access_code',
43671
+ },
43672
+ type: 'object',
43673
+ },
43674
+ response_status_code: {
43675
+ format: 'float',
43676
+ type: 'number',
43677
+ },
43678
+ },
43679
+ required: [
43680
+ 'entry_type',
43681
+ 'description',
43682
+ 'response_status_code',
43683
+ ],
43684
+ type: 'object',
43685
+ },
43686
+ ],
43687
+ },
43688
+ created_at: { type: 'string' },
43689
+ entry_type: { type: 'string' },
43690
+ resource_id: { type: 'string' },
43691
+ resource_type: { type: 'string' },
43692
+ },
43693
+ required: [
43694
+ 'resource_type',
43695
+ 'resource_id',
43696
+ 'entry_type',
43697
+ 'body',
43698
+ 'created_at',
43699
+ ],
43700
+ type: 'object',
43701
+ },
43702
+ type: 'array',
43703
+ },
43704
+ },
43705
+ required: ['context', 'entries', 'created_at'],
43706
+ type: 'object',
43707
+ },
43708
+ type: 'array',
43709
+ },
43710
+ },
43711
+ required: ['timeline', 'pagination', 'ok'],
43712
+ type: 'object',
43713
+ },
43714
+ },
43715
+ },
43716
+ description: 'OK',
43717
+ },
43718
+ 400: { description: 'Bad Request' },
43719
+ 401: { description: 'Unauthorized' },
43720
+ },
43721
+ security: [
43722
+ { client_session: [] },
43723
+ { pat_with_workspace: [] },
43724
+ { console_session_with_workspace: [] },
43725
+ { api_key: [] },
43726
+ ],
43727
+ summary: '/seam/console/v1/timelines/get',
43728
+ tags: [],
43729
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'timelines'],
43730
+ 'x-fern-sdk-method-name': 'get',
43731
+ 'x-fern-sdk-return-value': 'timeline',
43732
+ 'x-response-key': 'timeline',
43733
+ 'x-title': 'Get Timeline Entries',
43734
+ 'x-undocumented': 'Internal endpoint for Console',
43735
+ },
43736
+ },
43245
43737
  '/seam/customer/v1/automation_runs/list': {
43246
43738
  get: {
43247
43739
  description: 'Returns a list of all automation runs for a workspace or customer.',