@seamapi/types 1.512.0 → 1.514.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.
@@ -55385,6 +55385,82 @@ export type Routes = {
55385
55385
  };
55386
55386
  };
55387
55387
  };
55388
+ '/seam/console/v1/timelines/get': {
55389
+ route: '/seam/console/v1/timelines/get';
55390
+ method: 'GET' | 'POST';
55391
+ queryParams: {};
55392
+ jsonBody: {};
55393
+ commonParams: {
55394
+ /** ID of the resource to get timelines for. */
55395
+ resource_id: string;
55396
+ /** Maximum number of timeline entry groups to return per page. */
55397
+ limit?: number;
55398
+ /** Timestamp by which to limit returned timeline entries. Returns entries created before this timestamp. */
55399
+ created_before?: Date | undefined;
55400
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
55401
+ page_cursor?: string | undefined;
55402
+ };
55403
+ formData: {};
55404
+ jsonResponse: {
55405
+ timeline: {
55406
+ context: {
55407
+ context_type: 'request';
55408
+ request_id: string;
55409
+ request_payload: {
55410
+ [x: string]: any;
55411
+ };
55412
+ response_payload: {
55413
+ [x: string]: any;
55414
+ };
55415
+ } | {
55416
+ context_type: 'job';
55417
+ job_id: string;
55418
+ };
55419
+ entries: {
55420
+ resource_type: string;
55421
+ resource_id: string;
55422
+ entry_type: string;
55423
+ body: {
55424
+ entry_type: 'resource_created';
55425
+ description: string;
55426
+ } | {
55427
+ entry_type: 'resource_updated';
55428
+ description: string;
55429
+ properties_updated?: {
55430
+ [x: string]: any;
55431
+ } | undefined;
55432
+ errors?: string[] | undefined;
55433
+ warnings?: string[] | undefined;
55434
+ } | {
55435
+ entry_type: 'resource_deleted';
55436
+ description: string;
55437
+ } | {
55438
+ entry_type: 'event';
55439
+ event_type: string;
55440
+ event_id: string;
55441
+ } | {
55442
+ entry_type: 'provider_call';
55443
+ description: string;
55444
+ response_status_code: number;
55445
+ response_body?: {
55446
+ [x: string]: any;
55447
+ } | undefined;
55448
+ };
55449
+ created_at: string;
55450
+ }[];
55451
+ created_at: string;
55452
+ }[];
55453
+ /** Information about the current page of results. */
55454
+ pagination: {
55455
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
55456
+ next_page_cursor: string | null;
55457
+ /** Indicates whether there is another page of results after this one. */
55458
+ has_next_page: boolean;
55459
+ /** URL to get the next page of results. */
55460
+ next_page_url: string | null;
55461
+ };
55462
+ };
55463
+ };
55388
55464
  '/seam/customer/v1/automation_runs/list': {
55389
55465
  route: '/seam/customer/v1/automation_runs/list';
55390
55466
  method: 'GET' | 'POST';
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.512.0",
3
+ "version": "1.514.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -33782,6 +33782,7 @@ export default {
33782
33782
  { client_session: [] },
33783
33783
  { pat_with_workspace: [] },
33784
33784
  { console_session_with_workspace: [] },
33785
+ { client_session_with_customer: [] },
33785
33786
  { api_key: [] },
33786
33787
  ],
33787
33788
  summary: '/acs/systems/list',
@@ -33844,6 +33845,7 @@ export default {
33844
33845
  { client_session: [] },
33845
33846
  { pat_with_workspace: [] },
33846
33847
  { console_session_with_workspace: [] },
33848
+ { client_session_with_customer: [] },
33847
33849
  { api_key: [] },
33848
33850
  ],
33849
33851
  summary: '/acs/systems/list',
@@ -47116,6 +47118,494 @@ export default {
47116
47118
  'x-undocumented': 'Internal endpoint for Console',
47117
47119
  },
47118
47120
  },
47121
+ '/seam/console/v1/timelines/get': {
47122
+ get: {
47123
+ description:
47124
+ 'Returns timeline entries for a resource and its child resources, grouped by entry groups.',
47125
+ operationId: 'seamConsoleV1TimelinesGetGet',
47126
+ parameters: [
47127
+ {
47128
+ in: 'query',
47129
+ name: 'resource_id',
47130
+ required: true,
47131
+ schema: {
47132
+ description: 'ID of the resource to get timelines for.',
47133
+ format: 'uuid',
47134
+ type: 'string',
47135
+ },
47136
+ },
47137
+ {
47138
+ in: 'query',
47139
+ name: 'limit',
47140
+ required: false,
47141
+ schema: {
47142
+ default: 50,
47143
+ description:
47144
+ 'Maximum number of timeline entry groups to return per page.',
47145
+ exclusiveMinimum: true,
47146
+ minimum: 0,
47147
+ type: 'integer',
47148
+ },
47149
+ },
47150
+ {
47151
+ in: 'query',
47152
+ name: 'created_before',
47153
+ required: false,
47154
+ schema: {
47155
+ description:
47156
+ 'Timestamp by which to limit returned timeline entries. Returns entries created before this timestamp.',
47157
+ format: 'date-time',
47158
+ type: 'string',
47159
+ },
47160
+ },
47161
+ {
47162
+ in: 'query',
47163
+ name: 'page_cursor',
47164
+ required: false,
47165
+ schema: {
47166
+ description:
47167
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
47168
+ type: 'string',
47169
+ },
47170
+ },
47171
+ ],
47172
+ responses: {
47173
+ 200: {
47174
+ content: {
47175
+ 'application/json': {
47176
+ schema: {
47177
+ properties: {
47178
+ ok: { type: 'boolean' },
47179
+ pagination: { $ref: '#/components/schemas/pagination' },
47180
+ timeline: {
47181
+ items: {
47182
+ properties: {
47183
+ context: {
47184
+ oneOf: [
47185
+ {
47186
+ properties: {
47187
+ context_type: {
47188
+ enum: ['request'],
47189
+ type: 'string',
47190
+ },
47191
+ request_id: { type: 'string' },
47192
+ request_payload: {
47193
+ additionalProperties: {
47194
+ $ref: '#/components/schemas/access_code',
47195
+ },
47196
+ type: 'object',
47197
+ },
47198
+ response_payload: {
47199
+ additionalProperties: {
47200
+ $ref: '#/components/schemas/access_code',
47201
+ },
47202
+ type: 'object',
47203
+ },
47204
+ },
47205
+ required: [
47206
+ 'context_type',
47207
+ 'request_id',
47208
+ 'request_payload',
47209
+ 'response_payload',
47210
+ ],
47211
+ type: 'object',
47212
+ },
47213
+ {
47214
+ properties: {
47215
+ context_type: {
47216
+ enum: ['job'],
47217
+ type: 'string',
47218
+ },
47219
+ job_id: { type: 'string' },
47220
+ },
47221
+ required: ['context_type', 'job_id'],
47222
+ type: 'object',
47223
+ },
47224
+ ],
47225
+ },
47226
+ created_at: { type: 'string' },
47227
+ entries: {
47228
+ items: {
47229
+ properties: {
47230
+ body: {
47231
+ oneOf: [
47232
+ {
47233
+ properties: {
47234
+ description: { type: 'string' },
47235
+ entry_type: {
47236
+ enum: ['resource_created'],
47237
+ type: 'string',
47238
+ },
47239
+ },
47240
+ required: ['entry_type', 'description'],
47241
+ type: 'object',
47242
+ },
47243
+ {
47244
+ properties: {
47245
+ description: { type: 'string' },
47246
+ entry_type: {
47247
+ enum: ['resource_updated'],
47248
+ type: 'string',
47249
+ },
47250
+ errors: {
47251
+ items: { type: 'string' },
47252
+ type: 'array',
47253
+ },
47254
+ properties_updated: {
47255
+ additionalProperties: {
47256
+ $ref: '#/components/schemas/access_code',
47257
+ },
47258
+ type: 'object',
47259
+ },
47260
+ warnings: {
47261
+ items: { type: 'string' },
47262
+ type: 'array',
47263
+ },
47264
+ },
47265
+ required: ['entry_type', 'description'],
47266
+ type: 'object',
47267
+ },
47268
+ {
47269
+ properties: {
47270
+ description: { type: 'string' },
47271
+ entry_type: {
47272
+ enum: ['resource_deleted'],
47273
+ type: 'string',
47274
+ },
47275
+ },
47276
+ required: ['entry_type', 'description'],
47277
+ type: 'object',
47278
+ },
47279
+ {
47280
+ properties: {
47281
+ entry_type: {
47282
+ enum: ['event'],
47283
+ type: 'string',
47284
+ },
47285
+ event_id: { type: 'string' },
47286
+ event_type: { type: 'string' },
47287
+ },
47288
+ required: [
47289
+ 'entry_type',
47290
+ 'event_type',
47291
+ 'event_id',
47292
+ ],
47293
+ type: 'object',
47294
+ },
47295
+ {
47296
+ properties: {
47297
+ description: { type: 'string' },
47298
+ entry_type: {
47299
+ enum: ['provider_call'],
47300
+ type: 'string',
47301
+ },
47302
+ response_body: {
47303
+ additionalProperties: {
47304
+ $ref: '#/components/schemas/access_code',
47305
+ },
47306
+ type: 'object',
47307
+ },
47308
+ response_status_code: {
47309
+ format: 'float',
47310
+ type: 'number',
47311
+ },
47312
+ },
47313
+ required: [
47314
+ 'entry_type',
47315
+ 'description',
47316
+ 'response_status_code',
47317
+ ],
47318
+ type: 'object',
47319
+ },
47320
+ ],
47321
+ },
47322
+ created_at: { type: 'string' },
47323
+ entry_type: { type: 'string' },
47324
+ resource_id: { type: 'string' },
47325
+ resource_type: { type: 'string' },
47326
+ },
47327
+ required: [
47328
+ 'resource_type',
47329
+ 'resource_id',
47330
+ 'entry_type',
47331
+ 'body',
47332
+ 'created_at',
47333
+ ],
47334
+ type: 'object',
47335
+ },
47336
+ type: 'array',
47337
+ },
47338
+ },
47339
+ required: ['context', 'entries', 'created_at'],
47340
+ type: 'object',
47341
+ },
47342
+ type: 'array',
47343
+ },
47344
+ },
47345
+ required: ['timeline', 'pagination', 'ok'],
47346
+ type: 'object',
47347
+ },
47348
+ },
47349
+ },
47350
+ description: 'OK',
47351
+ },
47352
+ 400: { description: 'Bad Request' },
47353
+ 401: { description: 'Unauthorized' },
47354
+ },
47355
+ security: [
47356
+ { client_session: [] },
47357
+ { pat_with_workspace: [] },
47358
+ { console_session_with_workspace: [] },
47359
+ { api_key: [] },
47360
+ ],
47361
+ summary: '/seam/console/v1/timelines/get',
47362
+ tags: [],
47363
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'timelines'],
47364
+ 'x-fern-sdk-method-name': 'get',
47365
+ 'x-fern-sdk-return-value': 'timeline',
47366
+ 'x-response-key': 'timeline',
47367
+ 'x-title': 'Get Timeline Entries',
47368
+ 'x-undocumented': 'Internal endpoint for Console',
47369
+ },
47370
+ post: {
47371
+ description:
47372
+ 'Returns timeline entries for a resource and its child resources, grouped by entry groups.',
47373
+ operationId: 'seamConsoleV1TimelinesGetPost',
47374
+ requestBody: {
47375
+ content: {
47376
+ 'application/json': {
47377
+ schema: {
47378
+ properties: {
47379
+ created_before: {
47380
+ description:
47381
+ 'Timestamp by which to limit returned timeline entries. Returns entries created before this timestamp.',
47382
+ format: 'date-time',
47383
+ type: 'string',
47384
+ },
47385
+ limit: {
47386
+ default: 50,
47387
+ description:
47388
+ 'Maximum number of timeline entry groups to return per page.',
47389
+ exclusiveMinimum: true,
47390
+ minimum: 0,
47391
+ type: 'integer',
47392
+ },
47393
+ page_cursor: {
47394
+ description:
47395
+ "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
47396
+ type: 'string',
47397
+ },
47398
+ resource_id: {
47399
+ description: 'ID of the resource to get timelines for.',
47400
+ format: 'uuid',
47401
+ type: 'string',
47402
+ },
47403
+ },
47404
+ required: ['resource_id'],
47405
+ type: 'object',
47406
+ },
47407
+ },
47408
+ },
47409
+ },
47410
+ responses: {
47411
+ 200: {
47412
+ content: {
47413
+ 'application/json': {
47414
+ schema: {
47415
+ properties: {
47416
+ ok: { type: 'boolean' },
47417
+ pagination: { $ref: '#/components/schemas/pagination' },
47418
+ timeline: {
47419
+ items: {
47420
+ properties: {
47421
+ context: {
47422
+ oneOf: [
47423
+ {
47424
+ properties: {
47425
+ context_type: {
47426
+ enum: ['request'],
47427
+ type: 'string',
47428
+ },
47429
+ request_id: { type: 'string' },
47430
+ request_payload: {
47431
+ additionalProperties: {
47432
+ $ref: '#/components/schemas/access_code',
47433
+ },
47434
+ type: 'object',
47435
+ },
47436
+ response_payload: {
47437
+ additionalProperties: {
47438
+ $ref: '#/components/schemas/access_code',
47439
+ },
47440
+ type: 'object',
47441
+ },
47442
+ },
47443
+ required: [
47444
+ 'context_type',
47445
+ 'request_id',
47446
+ 'request_payload',
47447
+ 'response_payload',
47448
+ ],
47449
+ type: 'object',
47450
+ },
47451
+ {
47452
+ properties: {
47453
+ context_type: {
47454
+ enum: ['job'],
47455
+ type: 'string',
47456
+ },
47457
+ job_id: { type: 'string' },
47458
+ },
47459
+ required: ['context_type', 'job_id'],
47460
+ type: 'object',
47461
+ },
47462
+ ],
47463
+ },
47464
+ created_at: { type: 'string' },
47465
+ entries: {
47466
+ items: {
47467
+ properties: {
47468
+ body: {
47469
+ oneOf: [
47470
+ {
47471
+ properties: {
47472
+ description: { type: 'string' },
47473
+ entry_type: {
47474
+ enum: ['resource_created'],
47475
+ type: 'string',
47476
+ },
47477
+ },
47478
+ required: ['entry_type', 'description'],
47479
+ type: 'object',
47480
+ },
47481
+ {
47482
+ properties: {
47483
+ description: { type: 'string' },
47484
+ entry_type: {
47485
+ enum: ['resource_updated'],
47486
+ type: 'string',
47487
+ },
47488
+ errors: {
47489
+ items: { type: 'string' },
47490
+ type: 'array',
47491
+ },
47492
+ properties_updated: {
47493
+ additionalProperties: {
47494
+ $ref: '#/components/schemas/access_code',
47495
+ },
47496
+ type: 'object',
47497
+ },
47498
+ warnings: {
47499
+ items: { type: 'string' },
47500
+ type: 'array',
47501
+ },
47502
+ },
47503
+ required: ['entry_type', 'description'],
47504
+ type: 'object',
47505
+ },
47506
+ {
47507
+ properties: {
47508
+ description: { type: 'string' },
47509
+ entry_type: {
47510
+ enum: ['resource_deleted'],
47511
+ type: 'string',
47512
+ },
47513
+ },
47514
+ required: ['entry_type', 'description'],
47515
+ type: 'object',
47516
+ },
47517
+ {
47518
+ properties: {
47519
+ entry_type: {
47520
+ enum: ['event'],
47521
+ type: 'string',
47522
+ },
47523
+ event_id: { type: 'string' },
47524
+ event_type: { type: 'string' },
47525
+ },
47526
+ required: [
47527
+ 'entry_type',
47528
+ 'event_type',
47529
+ 'event_id',
47530
+ ],
47531
+ type: 'object',
47532
+ },
47533
+ {
47534
+ properties: {
47535
+ description: { type: 'string' },
47536
+ entry_type: {
47537
+ enum: ['provider_call'],
47538
+ type: 'string',
47539
+ },
47540
+ response_body: {
47541
+ additionalProperties: {
47542
+ $ref: '#/components/schemas/access_code',
47543
+ },
47544
+ type: 'object',
47545
+ },
47546
+ response_status_code: {
47547
+ format: 'float',
47548
+ type: 'number',
47549
+ },
47550
+ },
47551
+ required: [
47552
+ 'entry_type',
47553
+ 'description',
47554
+ 'response_status_code',
47555
+ ],
47556
+ type: 'object',
47557
+ },
47558
+ ],
47559
+ },
47560
+ created_at: { type: 'string' },
47561
+ entry_type: { type: 'string' },
47562
+ resource_id: { type: 'string' },
47563
+ resource_type: { type: 'string' },
47564
+ },
47565
+ required: [
47566
+ 'resource_type',
47567
+ 'resource_id',
47568
+ 'entry_type',
47569
+ 'body',
47570
+ 'created_at',
47571
+ ],
47572
+ type: 'object',
47573
+ },
47574
+ type: 'array',
47575
+ },
47576
+ },
47577
+ required: ['context', 'entries', 'created_at'],
47578
+ type: 'object',
47579
+ },
47580
+ type: 'array',
47581
+ },
47582
+ },
47583
+ required: ['timeline', 'pagination', 'ok'],
47584
+ type: 'object',
47585
+ },
47586
+ },
47587
+ },
47588
+ description: 'OK',
47589
+ },
47590
+ 400: { description: 'Bad Request' },
47591
+ 401: { description: 'Unauthorized' },
47592
+ },
47593
+ security: [
47594
+ { client_session: [] },
47595
+ { pat_with_workspace: [] },
47596
+ { console_session_with_workspace: [] },
47597
+ { api_key: [] },
47598
+ ],
47599
+ summary: '/seam/console/v1/timelines/get',
47600
+ tags: [],
47601
+ 'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'timelines'],
47602
+ 'x-fern-sdk-method-name': 'get',
47603
+ 'x-fern-sdk-return-value': 'timeline',
47604
+ 'x-response-key': 'timeline',
47605
+ 'x-title': 'Get Timeline Entries',
47606
+ 'x-undocumented': 'Internal endpoint for Console',
47607
+ },
47608
+ },
47119
47609
  '/seam/customer/v1/automation_runs/list': {
47120
47610
  get: {
47121
47611
  description: