@seamapi/types 1.511.0 → 1.513.0

package/lib/seam/connect/route-types.d.ts

@@ -38658,7 +38658,9 @@ export type Routes = {
         jsonBody: {};
         commonParams: {
             /** ID of the instant key to get. */
-            instant_key_id: string;
+            instant_key_id?: string | undefined;
+            /** URL of the instant key to get. */
+            instant_key_url?: string | undefined;
         };
         formData: {};
         jsonResponse: {
@@ -55383,6 +55385,82 @@ export type Routes = {
             };
         };
     };
+    '/seam/console/v1/timelines/get': {
+        route: '/seam/console/v1/timelines/get';
+        method: 'GET' | 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the resource to get timelines for. */
+            resource_id: string;
+            /** Maximum number of timeline entry groups to return per page. */
+            limit?: number;
+            /** Timestamp by which to limit returned timeline entries. Returns entries created before this timestamp. */
+            created_before?: Date | undefined;
+            /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
+            page_cursor?: string | undefined;
+        };
+        formData: {};
+        jsonResponse: {
+            timeline: {
+                context: {
+                    context_type: 'request';
+                    request_id: string;
+                    request_payload: {
+                        [x: string]: any;
+                    };
+                    response_payload: {
+                        [x: string]: any;
+                    };
+                } | {
+                    context_type: 'job';
+                    job_id: string;
+                };
+                entries: {
+                    resource_type: string;
+                    resource_id: string;
+                    entry_type: string;
+                    body: {
+                        entry_type: 'resource_created';
+                        description: string;
+                    } | {
+                        entry_type: 'resource_updated';
+                        description: string;
+                        properties_updated?: {
+                            [x: string]: any;
+                        } | undefined;
+                        errors?: string[] | undefined;
+                        warnings?: string[] | undefined;
+                    } | {
+                        entry_type: 'resource_deleted';
+                        description: string;
+                    } | {
+                        entry_type: 'event';
+                        event_type: string;
+                        event_id: string;
+                    } | {
+                        entry_type: 'provider_call';
+                        description: string;
+                        response_status_code: number;
+                        response_body?: {
+                            [x: string]: any;
+                        } | undefined;
+                    };
+                    created_at: string;
+                }[];
+                created_at: string;
+            }[];
+            /** Information about the current page of results. */
+            pagination: {
+                /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
+                next_page_cursor: string | null;
+                /** Indicates whether there is another page of results after this one. */
+                has_next_page: boolean;
+                /** URL to get the next page of results. */
+                next_page_url: string | null;
+            };
+        };
+    };
     '/seam/customer/v1/automation_runs/list': {
         route: '/seam/customer/v1/automation_runs/list';
         method: 'GET' | 'POST';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.511.0",
+  "version": "1.513.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",

package/src/lib/seam/connect/openapi.ts

@@ -43584,13 +43584,21 @@ export default {
           {
             in: 'query',
             name: 'instant_key_id',
-            required: true,
             schema: {
               description: 'ID of the instant key to get.',
               format: 'uuid',
               type: 'string',
             },
           },
+          {
+            in: 'query',
+            name: 'instant_key_url',
+            schema: {
+              description: 'URL of the instant key to get.',
+              format: 'uri',
+              type: 'string',
+            },
+          },
         ],
         responses: {
           200: {
@@ -43638,8 +43646,12 @@ export default {
                     format: 'uuid',
                     type: 'string',
                   },
+                  instant_key_url: {
+                    description: 'URL of the instant key to get.',
+                    format: 'uri',
+                    type: 'string',
+                  },
                 },
-                required: ['instant_key_id'],
                 type: 'object',
               },
             },
@@ -47104,6 +47116,494 @@ export default {
         'x-undocumented': 'Internal endpoint for Console',
       },
     },
+    '/seam/console/v1/timelines/get': {
+      get: {
+        description:
+          'Returns timeline entries for a resource and its child resources, grouped by entry groups.',
+        operationId: 'seamConsoleV1TimelinesGetGet',
+        parameters: [
+          {
+            in: 'query',
+            name: 'resource_id',
+            required: true,
+            schema: {
+              description: 'ID of the resource to get timelines for.',
+              format: 'uuid',
+              type: 'string',
+            },
+          },
+          {
+            in: 'query',
+            name: 'limit',
+            required: false,
+            schema: {
+              default: 50,
+              description:
+                'Maximum number of timeline entry groups to return per page.',
+              exclusiveMinimum: true,
+              minimum: 0,
+              type: 'integer',
+            },
+          },
+          {
+            in: 'query',
+            name: 'created_before',
+            required: false,
+            schema: {
+              description:
+                'Timestamp by which to limit returned timeline entries. Returns entries created before this timestamp.',
+              format: 'date-time',
+              type: 'string',
+            },
+          },
+          {
+            in: 'query',
+            name: 'page_cursor',
+            required: false,
+            schema: {
+              description:
+                "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+              type: 'string',
+            },
+          },
+        ],
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
+                    timeline: {
+                      items: {
+                        properties: {
+                          context: {
+                            oneOf: [
+                              {
+                                properties: {
+                                  context_type: {
+                                    enum: ['request'],
+                                    type: 'string',
+                                  },
+                                  request_id: { type: 'string' },
+                                  request_payload: {
+                                    additionalProperties: {
+                                      $ref: '#/components/schemas/access_code',
+                                    },
+                                    type: 'object',
+                                  },
+                                  response_payload: {
+                                    additionalProperties: {
+                                      $ref: '#/components/schemas/access_code',
+                                    },
+                                    type: 'object',
+                                  },
+                                },
+                                required: [
+                                  'context_type',
+                                  'request_id',
+                                  'request_payload',
+                                  'response_payload',
+                                ],
+                                type: 'object',
+                              },
+                              {
+                                properties: {
+                                  context_type: {
+                                    enum: ['job'],
+                                    type: 'string',
+                                  },
+                                  job_id: { type: 'string' },
+                                },
+                                required: ['context_type', 'job_id'],
+                                type: 'object',
+                              },
+                            ],
+                          },
+                          created_at: { type: 'string' },
+                          entries: {
+                            items: {
+                              properties: {
+                                body: {
+                                  oneOf: [
+                                    {
+                                      properties: {
+                                        description: { type: 'string' },
+                                        entry_type: {
+                                          enum: ['resource_created'],
+                                          type: 'string',
+                                        },
+                                      },
+                                      required: ['entry_type', 'description'],
+                                      type: 'object',
+                                    },
+                                    {
+                                      properties: {
+                                        description: { type: 'string' },
+                                        entry_type: {
+                                          enum: ['resource_updated'],
+                                          type: 'string',
+                                        },
+                                        errors: {
+                                          items: { type: 'string' },
+                                          type: 'array',
+                                        },
+                                        properties_updated: {
+                                          additionalProperties: {
+                                            $ref: '#/components/schemas/access_code',
+                                          },
+                                          type: 'object',
+                                        },
+                                        warnings: {
+                                          items: { type: 'string' },
+                                          type: 'array',
+                                        },
+                                      },
+                                      required: ['entry_type', 'description'],
+                                      type: 'object',
+                                    },
+                                    {
+                                      properties: {
+                                        description: { type: 'string' },
+                                        entry_type: {
+                                          enum: ['resource_deleted'],
+                                          type: 'string',
+                                        },
+                                      },
+                                      required: ['entry_type', 'description'],
+                                      type: 'object',
+                                    },
+                                    {
+                                      properties: {
+                                        entry_type: {
+                                          enum: ['event'],
+                                          type: 'string',
+                                        },
+                                        event_id: { type: 'string' },
+                                        event_type: { type: 'string' },
+                                      },
+                                      required: [
+                                        'entry_type',
+                                        'event_type',
+                                        'event_id',
+                                      ],
+                                      type: 'object',
+                                    },
+                                    {
+                                      properties: {
+                                        description: { type: 'string' },
+                                        entry_type: {
+                                          enum: ['provider_call'],
+                                          type: 'string',
+                                        },
+                                        response_body: {
+                                          additionalProperties: {
+                                            $ref: '#/components/schemas/access_code',
+                                          },
+                                          type: 'object',
+                                        },
+                                        response_status_code: {
+                                          format: 'float',
+                                          type: 'number',
+                                        },
+                                      },
+                                      required: [
+                                        'entry_type',
+                                        'description',
+                                        'response_status_code',
+                                      ],
+                                      type: 'object',
+                                    },
+                                  ],
+                                },
+                                created_at: { type: 'string' },
+                                entry_type: { type: 'string' },
+                                resource_id: { type: 'string' },
+                                resource_type: { type: 'string' },
+                              },
+                              required: [
+                                'resource_type',
+                                'resource_id',
+                                'entry_type',
+                                'body',
+                                'created_at',
+                              ],
+                              type: 'object',
+                            },
+                            type: 'array',
+                          },
+                        },
+                        required: ['context', 'entries', 'created_at'],
+                        type: 'object',
+                      },
+                      type: 'array',
+                    },
+                  },
+                  required: ['timeline', 'pagination', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/seam/console/v1/timelines/get',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'timelines'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'timeline',
+        'x-response-key': 'timeline',
+        'x-title': 'Get Timeline Entries',
+        'x-undocumented': 'Internal endpoint for Console',
+      },
+      post: {
+        description:
+          'Returns timeline entries for a resource and its child resources, grouped by entry groups.',
+        operationId: 'seamConsoleV1TimelinesGetPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  created_before: {
+                    description:
+                      'Timestamp by which to limit returned timeline entries. Returns entries created before this timestamp.',
+                    format: 'date-time',
+                    type: 'string',
+                  },
+                  limit: {
+                    default: 50,
+                    description:
+                      'Maximum number of timeline entry groups to return per page.',
+                    exclusiveMinimum: true,
+                    minimum: 0,
+                    type: 'integer',
+                  },
+                  page_cursor: {
+                    description:
+                      "Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.",
+                    type: 'string',
+                  },
+                  resource_id: {
+                    description: 'ID of the resource to get timelines for.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                },
+                required: ['resource_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    ok: { type: 'boolean' },
+                    pagination: { $ref: '#/components/schemas/pagination' },
+                    timeline: {
+                      items: {
+                        properties: {
+                          context: {
+                            oneOf: [
+                              {
+                                properties: {
+                                  context_type: {
+                                    enum: ['request'],
+                                    type: 'string',
+                                  },
+                                  request_id: { type: 'string' },
+                                  request_payload: {
+                                    additionalProperties: {
+                                      $ref: '#/components/schemas/access_code',
+                                    },
+                                    type: 'object',
+                                  },
+                                  response_payload: {
+                                    additionalProperties: {
+                                      $ref: '#/components/schemas/access_code',
+                                    },
+                                    type: 'object',
+                                  },
+                                },
+                                required: [
+                                  'context_type',
+                                  'request_id',
+                                  'request_payload',
+                                  'response_payload',
+                                ],
+                                type: 'object',
+                              },
+                              {
+                                properties: {
+                                  context_type: {
+                                    enum: ['job'],
+                                    type: 'string',
+                                  },
+                                  job_id: { type: 'string' },
+                                },
+                                required: ['context_type', 'job_id'],
+                                type: 'object',
+                              },
+                            ],
+                          },
+                          created_at: { type: 'string' },
+                          entries: {
+                            items: {
+                              properties: {
+                                body: {
+                                  oneOf: [
+                                    {
+                                      properties: {
+                                        description: { type: 'string' },
+                                        entry_type: {
+                                          enum: ['resource_created'],
+                                          type: 'string',
+                                        },
+                                      },
+                                      required: ['entry_type', 'description'],
+                                      type: 'object',
+                                    },
+                                    {
+                                      properties: {
+                                        description: { type: 'string' },
+                                        entry_type: {
+                                          enum: ['resource_updated'],
+                                          type: 'string',
+                                        },
+                                        errors: {
+                                          items: { type: 'string' },
+                                          type: 'array',
+                                        },
+                                        properties_updated: {
+                                          additionalProperties: {
+                                            $ref: '#/components/schemas/access_code',
+                                          },
+                                          type: 'object',
+                                        },
+                                        warnings: {
+                                          items: { type: 'string' },
+                                          type: 'array',
+                                        },
+                                      },
+                                      required: ['entry_type', 'description'],
+                                      type: 'object',
+                                    },
+                                    {
+                                      properties: {
+                                        description: { type: 'string' },
+                                        entry_type: {
+                                          enum: ['resource_deleted'],
+                                          type: 'string',
+                                        },
+                                      },
+                                      required: ['entry_type', 'description'],
+                                      type: 'object',
+                                    },
+                                    {
+                                      properties: {
+                                        entry_type: {
+                                          enum: ['event'],
+                                          type: 'string',
+                                        },
+                                        event_id: { type: 'string' },
+                                        event_type: { type: 'string' },
+                                      },
+                                      required: [
+                                        'entry_type',
+                                        'event_type',
+                                        'event_id',
+                                      ],
+                                      type: 'object',
+                                    },
+                                    {
+                                      properties: {
+                                        description: { type: 'string' },
+                                        entry_type: {
+                                          enum: ['provider_call'],
+                                          type: 'string',
+                                        },
+                                        response_body: {
+                                          additionalProperties: {
+                                            $ref: '#/components/schemas/access_code',
+                                          },
+                                          type: 'object',
+                                        },
+                                        response_status_code: {
+                                          format: 'float',
+                                          type: 'number',
+                                        },
+                                      },
+                                      required: [
+                                        'entry_type',
+                                        'description',
+                                        'response_status_code',
+                                      ],
+                                      type: 'object',
+                                    },
+                                  ],
+                                },
+                                created_at: { type: 'string' },
+                                entry_type: { type: 'string' },
+                                resource_id: { type: 'string' },
+                                resource_type: { type: 'string' },
+                              },
+                              required: [
+                                'resource_type',
+                                'resource_id',
+                                'entry_type',
+                                'body',
+                                'created_at',
+                              ],
+                              type: 'object',
+                            },
+                            type: 'array',
+                          },
+                        },
+                        required: ['context', 'entries', 'created_at'],
+                        type: 'object',
+                      },
+                      type: 'array',
+                    },
+                  },
+                  required: ['timeline', 'pagination', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary: '/seam/console/v1/timelines/get',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'console', 'v1', 'timelines'],
+        'x-fern-sdk-method-name': 'get',
+        'x-fern-sdk-return-value': 'timeline',
+        'x-response-key': 'timeline',
+        'x-title': 'Get Timeline Entries',
+        'x-undocumented': 'Internal endpoint for Console',
+      },
+    },
     '/seam/customer/v1/automation_runs/list': {
       get: {
         description: