@seamapi/types 1.598.0 → 1.600.0

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

@@ -31453,24 +31453,20 @@ export type Routes = {
                     /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
                     excluded_providers?: string[] | undefined;
                 };
-                /** Configuration for the manage reservations feature. */
-                manage_reservations?: {
+                /** Configuration for the manage feature. */
+                manage?: {
                     /** Whether to exclude this feature from the portal. */
                     exclude?: boolean;
-                    /** Configuration for the reservations feature. */
-                    reservations?: {
-                        /** Indicates whether the customer can view reservations for their properties. */
-                        exclude?: boolean;
-                    };
+                    /** Indicates whether the customer can manage reservations for their properties. */
+                    exclude_reservation_management?: boolean;
                 };
-                /** Configuration for the manage devices feature. */
+                /** Configuration for the manage devices feature.
+                ---
+                deprecated: Use `manage` instead.
+                --- */
                 manage_devices?: {
                     /** Whether to exclude this feature from the portal. */
                     exclude?: boolean;
-                    /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
-                    accepted_providers?: string[] | undefined;
-                    /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
-                    excluded_providers?: string[] | undefined;
                 };
                 /** Configuration for the organize feature. */
                 organize?: {
@@ -56664,6 +56660,58 @@ export type Routes = {
         formData: {};
         jsonResponse: {};
     };
+    '/seam/customer/v1/connectors/create': {
+        route: '/seam/customer/v1/connectors/create';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {
+            /** Type of connector to create */
+            connector_type: 'mews' | 'mock';
+            /** Key identifying the customer */
+            customer_key: string;
+            /** Instance-specific configuration for the connector */
+            config: {
+                client_token: string;
+                access_token: string;
+                client: string;
+                enterprise_ids?: string[] | undefined;
+            } | {};
+        };
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            connector: {
+                connector_id: string;
+                connector_type: string;
+                status: 'active' | 'inactive' | 'error';
+                webhook_subscription?: {
+                    subscription_id: string;
+                    webhook_url: string;
+                    events: string[];
+                    status: 'active' | 'inactive' | 'error';
+                } | undefined;
+                error?: string | undefined;
+            };
+        };
+    };
+    '/seam/customer/v1/connectors/sync': {
+        route: '/seam/customer/v1/connectors/sync';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {
+            /** ID of the connector to sync */
+            connector_id: string;
+        };
+        formData: {};
+        jsonResponse: {
+            connector_sync: {
+                connector_id: string;
+                status: string;
+                message: string;
+            };
+        };
+    };
     '/seam/customer/v1/events/list': {
         route: '/seam/customer/v1/events/list';
         method: 'GET' | 'POST';
@@ -58605,24 +58653,20 @@ export type Routes = {
                         /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
                         excluded_providers?: string[] | undefined;
                     };
-                    /** Configuration for the manage reservations feature. */
-                    manage_reservations?: {
+                    /** Configuration for the manage feature. */
+                    manage?: {
                         /** Whether to exclude this feature from the portal. */
                         exclude?: boolean;
-                        /** Configuration for the reservations feature. */
-                        reservations?: {
-                            /** Indicates whether the customer can view reservations for their properties. */
-                            exclude?: boolean;
-                        };
+                        /** Indicates whether the customer can manage reservations for their properties. */
+                        exclude_reservation_management?: boolean;
                     };
-                    /** Configuration for the manage devices feature. */
+                    /** Configuration for the manage devices feature.
+                      ---
+                      deprecated: Use `manage` instead.
+                      --- */
                     manage_devices?: {
                         /** Whether to exclude this feature from the portal. */
                         exclude?: boolean;
-                        /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
-                        accepted_providers?: string[] | undefined;
-                        /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
-                        excluded_providers?: string[] | undefined;
                     };
                     /** Configuration for the organize feature. */
                     organize?: {
@@ -58870,6 +58914,19 @@ export type Routes = {
             }[];
         };
     };
+    '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
+        route: '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]';
+        method: 'POST';
+        queryParams: {};
+        jsonBody: {};
+        commonParams: {};
+        formData: {};
+        jsonResponse: {
+            success: boolean;
+            processed_events: number;
+            error?: string | undefined;
+        };
+    };
     '/seam/instant_key/v1/client_sessions/exchange_short_code': {
         route: '/seam/instant_key/v1/client_sessions/exchange_short_code';
         method: 'POST';

package/package.json

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

package/src/lib/seam/connect/models/customer/customer-portal.ts

@@ -24,19 +24,17 @@ const base_connect_feature = base_feature.extend({
       'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
     ),
 })
-const base_manage_devices_feature = base_feature.extend({
-  reservations: z
-    .object({
-      exclude: z
-        .boolean()
-        .default(false)
-        .describe(
-          'Indicates whether the customer can view reservations for their properties.',
-        ),
-    })
-    .default({ exclude: false })
-    .describe('Configuration for the reservations feature.'),
+const base_manage_devices_feature = base_feature
+
+const base_manage_feature = base_feature.extend({
+  exclude_reservation_management: z
+    .boolean()
+    .default(false)
+    .describe(
+      'Indicates whether the customer can manage reservations for their properties.',
+    ),
 })
+
 const base_organize_feature = base_feature
 
 const base_configure_feature = base_feature.extend({
@@ -58,12 +56,15 @@ const base_features = z.object({
   connect: base_connect_feature
     .default({})
     .describe('Configuration for the connect accounts feature.'),
-  manage_reservations: base_manage_devices_feature
-    .default({})
-    .describe('Configuration for the manage reservations feature.'),
-  manage_devices: base_connect_feature
+  manage: base_manage_feature
     .default({})
-    .describe('Configuration for the manage devices feature.'),
+    .describe('Configuration for the manage feature.'),
+  manage_devices: base_manage_devices_feature.default({}).describe(`
+      Configuration for the manage devices feature.
+      ---
+      deprecated: Use \`manage\` instead.
+      ---
+    `),
   organize: base_organize_feature
     .default({})
     .describe('Configuration for the organize feature.'),
@@ -93,7 +94,7 @@ export const portal_configuration = portal_configuration_base
     features: {
       connect: { exclude: false },
       organize: { exclude: false },
-      manage_reservations: { exclude: false },
+      manage: { exclude: false, exclude_reservation_management: false },
       manage_devices: {
         exclude: false,
       },

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

@@ -40662,8 +40662,11 @@ export default {
                           exclude: false,
                         },
                         connect: { exclude: false },
+                        manage: {
+                          exclude: false,
+                          exclude_reservation_management: false,
+                        },
                         manage_devices: { exclude: false },
-                        manage_reservations: { exclude: false },
                         organize: { exclude: false },
                       },
                       is_embedded: false,
@@ -40725,36 +40728,30 @@ export default {
                             },
                             type: 'object',
                           },
-                          manage_devices: {
+                          manage: {
                             default: {},
                             description:
-                              'Configuration for the manage devices feature.',
+                              'Configuration for the manage feature.',
                             properties: {
-                              accepted_providers: {
-                                description:
-                                  'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
-                                items: { type: 'string' },
-                                type: 'array',
-                              },
                               exclude: {
                                 default: false,
                                 description:
                                   'Whether to exclude this feature from the portal.',
                                 type: 'boolean',
                               },
-                              excluded_providers: {
+                              exclude_reservation_management: {
+                                default: false,
                                 description:
-                                  'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
-                                items: { type: 'string' },
-                                type: 'array',
+                                  'Indicates whether the customer can manage reservations for their properties.',
+                                type: 'boolean',
                               },
                             },
                             type: 'object',
                           },
-                          manage_reservations: {
+                          manage_devices: {
                             default: {},
                             description:
-                              'Configuration for the manage reservations feature.',
+                              'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
                             properties: {
                               exclude: {
                                 default: false,
@@ -40762,20 +40759,6 @@ export default {
                                   'Whether to exclude this feature from the portal.',
                                 type: 'boolean',
                               },
-                              reservations: {
-                                default: { exclude: false },
-                                description:
-                                  'Configuration for the reservations feature.',
-                                properties: {
-                                  exclude: {
-                                    default: false,
-                                    description:
-                                      'Indicates whether the customer can view reservations for their properties.',
-                                    type: 'boolean',
-                                  },
-                                },
-                                type: 'object',
-                              },
                             },
                             type: 'object',
                           },
@@ -51379,6 +51362,174 @@ export default {
         'x-undocumented': 'Internal endpoint for customer portals.',
       },
     },
+    '/seam/customer/v1/connectors/create': {
+      post: {
+        description:
+          'Creates a new connector for a customer in a workspace. The connector will be activated and start syncing data from the external API.',
+        operationId: 'seamCustomerV1ConnectorsCreatePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  config: {
+                    description:
+                      'Instance-specific configuration for the connector',
+                    oneOf: [
+                      {
+                        properties: {
+                          access_token: { minLength: 1, type: 'string' },
+                          client: { minLength: 1, type: 'string' },
+                          client_token: { minLength: 1, type: 'string' },
+                          enterprise_ids: {
+                            items: { format: 'uuid', type: 'string' },
+                            type: 'array',
+                          },
+                        },
+                        required: ['client_token', 'access_token', 'client'],
+                        type: 'object',
+                      },
+                      { properties: {}, type: 'object' },
+                    ],
+                  },
+                  connector_type: {
+                    description: 'Type of connector to create',
+                    enum: ['mews', 'mock'],
+                    type: 'string',
+                  },
+                  customer_key: {
+                    description: 'Key identifying the customer',
+                    minLength: 1,
+                    type: 'string',
+                  },
+                },
+                required: ['connector_type', 'customer_key', 'config'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    connector: {
+                      properties: {
+                        connector_id: { type: 'string' },
+                        connector_type: { type: 'string' },
+                        error: { type: 'string' },
+                        status: {
+                          enum: ['active', 'inactive', 'error'],
+                          type: 'string',
+                        },
+                        webhook_subscription: {
+                          properties: {
+                            events: {
+                              items: { type: 'string' },
+                              type: 'array',
+                            },
+                            status: {
+                              enum: ['active', 'inactive', 'error'],
+                              type: 'string',
+                            },
+                            subscription_id: { type: 'string' },
+                            webhook_url: { type: 'string' },
+                          },
+                          required: [
+                            'subscription_id',
+                            'webhook_url',
+                            'events',
+                            'status',
+                          ],
+                          type: 'object',
+                        },
+                      },
+                      required: ['connector_id', 'connector_type', 'status'],
+                      type: 'object',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['connector', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ api_key: [] }],
+        summary: '/seam/customer/v1/connectors/create',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
+        'x-fern-sdk-method-name': 'create',
+        'x-fern-sdk-return-value': 'connector',
+        'x-response-key': 'connector',
+        'x-title': 'Create Connector',
+      },
+    },
+    '/seam/customer/v1/connectors/sync': {
+      post: {
+        description:
+          'Triggers an immediate data sync for a connector by scheduling a polling task.',
+        operationId: 'seamCustomerV1ConnectorsSyncPost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  connector_id: {
+                    description: 'ID of the connector to sync',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                },
+                required: ['connector_id'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    connector_sync: {
+                      properties: {
+                        connector_id: { type: 'string' },
+                        message: { type: 'string' },
+                        status: { type: 'string' },
+                      },
+                      required: ['connector_id', 'status', 'message'],
+                      type: 'object',
+                    },
+                    ok: { type: 'boolean' },
+                  },
+                  required: ['connector_sync', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [{ api_key: [] }],
+        summary: '/seam/customer/v1/connectors/sync',
+        tags: [],
+        'x-fern-sdk-group-name': ['seam', 'customer', 'v1', 'connectors'],
+        'x-fern-sdk-method-name': 'sync',
+        'x-fern-sdk-return-value': 'connector_sync',
+        'x-response-key': 'connector_sync',
+        'x-title': 'Sync Connector Data',
+      },
+    },
     '/seam/customer/v1/events/list': {
       get: {
         description:
@@ -52051,40 +52202,34 @@ export default {
                               },
                               type: 'object',
                             },
-                            manage_devices: {
+                            manage: {
                               default: {
                                 $ref: '#/components/schemas/access_code',
                               },
                               description:
-                                'Configuration for the manage devices feature.',
+                                'Configuration for the manage feature.',
                               properties: {
-                                accepted_providers: {
-                                  description:
-                                    'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
-                                  items: { type: 'string' },
-                                  type: 'array',
-                                },
                                 exclude: {
                                   default: false,
                                   description:
                                     'Whether to exclude this feature from the portal.',
                                   type: 'boolean',
                                 },
-                                excluded_providers: {
+                                exclude_reservation_management: {
+                                  default: false,
                                   description:
-                                    'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
-                                  items: { type: 'string' },
-                                  type: 'array',
+                                    'Indicates whether the customer can manage reservations for their properties.',
+                                  type: 'boolean',
                                 },
                               },
                               type: 'object',
                             },
-                            manage_reservations: {
+                            manage_devices: {
                               default: {
                                 $ref: '#/components/schemas/access_code',
                               },
                               description:
-                                'Configuration for the manage reservations feature.',
+                                'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
                               properties: {
                                 exclude: {
                                   default: false,
@@ -52092,20 +52237,6 @@ export default {
                                     'Whether to exclude this feature from the portal.',
                                   type: 'boolean',
                                 },
-                                reservations: {
-                                  default: { exclude: false },
-                                  description:
-                                    'Configuration for the reservations feature.',
-                                  properties: {
-                                    exclude: {
-                                      default: false,
-                                      description:
-                                        'Indicates whether the customer can view reservations for their properties.',
-                                      type: 'boolean',
-                                    },
-                                  },
-                                  type: 'object',
-                                },
                               },
                               type: 'object',
                             },
@@ -52371,40 +52502,34 @@ export default {
                               },
                               type: 'object',
                             },
-                            manage_devices: {
+                            manage: {
                               default: {
                                 $ref: '#/components/schemas/access_code',
                               },
                               description:
-                                'Configuration for the manage devices feature.',
+                                'Configuration for the manage feature.',
                               properties: {
-                                accepted_providers: {
-                                  description:
-                                    'List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account.',
-                                  items: { type: 'string' },
-                                  type: 'array',
-                                },
                                 exclude: {
                                   default: false,
                                   description:
                                     'Whether to exclude this feature from the portal.',
                                   type: 'boolean',
                                 },
-                                excluded_providers: {
+                                exclude_reservation_management: {
+                                  default: false,
                                   description:
-                                    'List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account.',
-                                  items: { type: 'string' },
-                                  type: 'array',
+                                    'Indicates whether the customer can manage reservations for their properties.',
+                                  type: 'boolean',
                                 },
                               },
                               type: 'object',
                             },
-                            manage_reservations: {
+                            manage_devices: {
                               default: {
                                 $ref: '#/components/schemas/access_code',
                               },
                               description:
-                                'Configuration for the manage reservations feature.',
+                                'Configuration for the manage devices feature.\n---\ndeprecated: Use `manage` instead.\n---',
                               properties: {
                                 exclude: {
                                   default: false,
@@ -52412,20 +52537,6 @@ export default {
                                     'Whether to exclude this feature from the portal.',
                                   type: 'boolean',
                                 },
-                                reservations: {
-                                  default: { exclude: false },
-                                  description:
-                                    'Configuration for the reservations feature.',
-                                  properties: {
-                                    exclude: {
-                                      default: false,
-                                      description:
-                                        'Indicates whether the customer can view reservations for their properties.',
-                                      type: 'boolean',
-                                    },
-                                  },
-                                  type: 'object',
-                                },
                               },
                               type: 'object',
                             },
@@ -53484,6 +53595,59 @@ export default {
         'x-title': 'List Spaces',
       },
     },
+    '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]': {
+      post: {
+        description:
+          'Receives webhook events from external connector APIs and processes them into partner resources.',
+        operationId:
+          'seamCustomerV1WebhooksConnectorsByWorkspaceIdByConnectorIdPost',
+        requestBody: {
+          content: {
+            'application/json': { schema: { properties: {}, type: 'object' } },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: {
+                    error: { type: 'string' },
+                    ok: { type: 'boolean' },
+                    processed_events: { format: 'float', type: 'number' },
+                    success: { type: 'boolean' },
+                  },
+                  required: ['success', 'processed_events', 'ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+        ],
+        summary:
+          '/seam/customer/v1/webhooks/connectors/[workspace_id]/[connector_id]',
+        tags: ['/webhooks'],
+        'x-fern-sdk-group-name': [
+          'seam',
+          'customer',
+          'v1',
+          'webhooks',
+          'connectors',
+          '[workspace_id]',
+        ],
+        'x-fern-sdk-method-name': 'by_connector_id',
+        'x-response-key': null,
+        'x-title': 'Connector Webhook Endpoint',
+      },
+    },
     '/seam/instant_key/v1/client_sessions/exchange_short_code': {
       post: {
         description: