@seamapi/types 1.594.0 → 1.596.0

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

@@ -11494,6 +11494,17 @@ export default {
                         required: ['device_id', 'device_name'],
                         type: 'object',
                       },
+                      ultraloq_metadata: {
+                        description: 'Metadata for a Ultraloq device.',
+                        properties: {
+                          device_id: {
+                            description: 'Device ID for a Ultraloq device.',
+                            type: 'string',
+                          },
+                        },
+                        required: ['device_id'],
+                        type: 'object',
+                      },
                       visionline_metadata: {
                         description:
                           'Metadata for an ASSA ABLOY Visionline system.',
@@ -13147,6 +13158,7 @@ export default {
               'kwikset2',
               'keynest',
               'dormakaba_ambiance',
+              'ultraloq',
             ],
             type: 'string',
           },
@@ -30149,6 +30161,132 @@ export default {
         'x-title': 'List Unmanaged Access Grants',
       },
     },
+    '/access_grants/unmanaged/update': {
+      patch: {
+        description:
+          'Updates an unmanaged Access Grant to make it managed.\n\nThis endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.\n\nWhen converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.',
+        operationId: 'accessGrantsUnmanagedUpdatePatch',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  access_grant_id: {
+                    description: 'ID of the unmanaged Access Grant to update.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  access_grant_key: {
+                    description:
+                      'Unique key for the access grant. If not provided, the existing key will be preserved.',
+                    type: 'string',
+                  },
+                  is_managed: {
+                    description:
+                      'Must be set to true to convert the unmanaged access grant to managed.',
+                    enum: [true],
+                    type: 'boolean',
+                  },
+                },
+                required: ['access_grant_id', 'is_managed'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+          { client_session_with_customer: [] },
+        ],
+        summary: '/access_grants/unmanaged/update',
+        tags: [],
+        'x-draft': 'Early access.',
+        'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
+        'x-fern-sdk-method-name': 'update',
+        'x-response-key': null,
+        'x-title': 'Update an Unmanaged Access Grant',
+      },
+      post: {
+        description:
+          'Updates an unmanaged Access Grant to make it managed.\n\nThis endpoint can only be used to convert unmanaged access grants to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed access grants back to unmanaged.\n\nWhen converting an unmanaged access grant to managed, all associated access methods will also be converted to managed.',
+        operationId: 'accessGrantsUnmanagedUpdatePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  access_grant_id: {
+                    description: 'ID of the unmanaged Access Grant to update.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  access_grant_key: {
+                    description:
+                      'Unique key for the access grant. If not provided, the existing key will be preserved.',
+                    type: 'string',
+                  },
+                  is_managed: {
+                    description:
+                      'Must be set to true to convert the unmanaged access grant to managed.',
+                    enum: [true],
+                    type: 'boolean',
+                  },
+                },
+                required: ['access_grant_id', 'is_managed'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+          { api_key: [] },
+          { client_session_with_customer: [] },
+        ],
+        summary: '/access_grants/unmanaged/update',
+        tags: [],
+        'x-draft': 'Early access.',
+        'x-fern-sdk-group-name': ['access_grants', 'unmanaged'],
+        'x-fern-sdk-method-name': 'update',
+        'x-response-key': null,
+        'x-title': 'Update an Unmanaged Access Grant',
+      },
+    },
     '/access_grants/update': {
       patch: {
         description: "Updates an existing Access Grant's time window.",
@@ -39328,6 +39466,7 @@ export default {
                         'kwikset2',
                         'keynest',
                         'dormakaba_ambiance',
+                        'ultraloq',
                         'yale_access',
                         'hid_cm',
                         'google_nest',
@@ -42993,6 +43132,7 @@ export default {
                 'sensi',
                 'smartthings',
                 'keynest',
+                'ultraloq',
               ],
               type: 'string',
             },
@@ -43491,6 +43631,7 @@ export default {
                       'sensi',
                       'smartthings',
                       'keynest',
+                      'ultraloq',
                     ],
                     type: 'string',
                   },
@@ -44354,6 +44495,7 @@ export default {
                 'sensi',
                 'smartthings',
                 'keynest',
+                'ultraloq',
               ],
               type: 'string',
             },
@@ -44850,6 +44992,7 @@ export default {
                       'sensi',
                       'smartthings',
                       'keynest',
+                      'ultraloq',
                     ],
                     type: 'string',
                   },
@@ -46699,6 +46842,7 @@ export default {
                 'akiles',
                 'kwikset2',
                 'smartthings',
+                'ultraloq',
               ],
               type: 'string',
             },
@@ -47120,6 +47264,7 @@ export default {
                       'akiles',
                       'kwikset2',
                       'smartthings',
+                      'ultraloq',
                     ],
                     type: 'string',
                   },
@@ -61465,6 +61610,132 @@ export default {
         'x-title': 'List Unmanaged User Identities',
       },
     },
+    '/user_identities/unmanaged/update': {
+      patch: {
+        description:
+          'Updates an unmanaged [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.\n\nThis endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.',
+        operationId: 'userIdentitiesUnmanagedUpdatePatch',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  is_managed: {
+                    description:
+                      'Must be set to true to convert the unmanaged user identity to managed.',
+                    enum: [true],
+                    type: 'boolean',
+                  },
+                  user_identity_id: {
+                    description:
+                      'ID of the unmanaged user identity that you want to update.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  user_identity_key: {
+                    description:
+                      'Unique key for the user identity. If not provided, the existing key will be preserved.',
+                    type: 'string',
+                  },
+                },
+                required: ['user_identity_id', 'is_managed'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { api_key: [] },
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+        ],
+        summary: '/user_identities/unmanaged/update',
+        tags: ['/user_identities'],
+        'x-fern-sdk-group-name': ['user_identities', 'unmanaged'],
+        'x-fern-sdk-method-name': 'update',
+        'x-response-key': null,
+        'x-title': 'Update an Unmanaged User Identity',
+      },
+      post: {
+        description:
+          'Updates an unmanaged [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.\n\nThis endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.',
+        operationId: 'userIdentitiesUnmanagedUpdatePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  is_managed: {
+                    description:
+                      'Must be set to true to convert the unmanaged user identity to managed.',
+                    enum: [true],
+                    type: 'boolean',
+                  },
+                  user_identity_id: {
+                    description:
+                      'ID of the unmanaged user identity that you want to update.',
+                    format: 'uuid',
+                    type: 'string',
+                  },
+                  user_identity_key: {
+                    description:
+                      'Unique key for the user identity. If not provided, the existing key will be preserved.',
+                    type: 'string',
+                  },
+                },
+                required: ['user_identity_id', 'is_managed'],
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: {
+            content: {
+              'application/json': {
+                schema: {
+                  properties: { ok: { type: 'boolean' } },
+                  required: ['ok'],
+                  type: 'object',
+                },
+              },
+            },
+            description: 'OK',
+          },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { api_key: [] },
+          { client_session: [] },
+          { pat_with_workspace: [] },
+          { console_session_with_workspace: [] },
+        ],
+        summary: '/user_identities/unmanaged/update',
+        tags: ['/user_identities'],
+        'x-fern-sdk-group-name': ['user_identities', 'unmanaged'],
+        'x-fern-sdk-method-name': 'update',
+        'x-response-key': null,
+        'x-title': 'Update an Unmanaged User Identity',
+      },
+    },
     '/user_identities/update': {
       patch: {
         description:

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

@@ -12085,6 +12085,13 @@ export type Routes = {
                       has_photo?: boolean | undefined
                     }
                   | undefined
+                /** Metadata for a Ultraloq device. */
+                ultraloq_metadata?:
+                  | {
+                      /** Device ID for a Ultraloq device. */
+                      device_id: string
+                    }
+                  | undefined
               }) &
                 ({
                   /**  */
@@ -13752,6 +13759,22 @@ export type Routes = {
       }[]
     }
   }
+  '/access_grants/unmanaged/update': {
+    route: '/access_grants/unmanaged/update'
+    method: 'PATCH' | 'POST'
+    queryParams: {}
+    jsonBody: {
+      /** ID of the unmanaged Access Grant to update. */
+      access_grant_id: string
+      /** Must be set to true to convert the unmanaged access grant to managed. */
+      is_managed: true
+      /** Unique key for the access grant. If not provided, the existing key will be preserved. */
+      access_grant_key?: string | undefined
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {}
+  }
   '/access_grants/update': {
     route: '/access_grants/update'
     method: 'POST' | 'PATCH'
@@ -16151,6 +16174,13 @@ export type Routes = {
                       has_photo?: boolean | undefined
                     }
                   | undefined
+                /** Metadata for a Ultraloq device. */
+                ultraloq_metadata?:
+                  | {
+                      /** Device ID for a Ultraloq device. */
+                      device_id: string
+                    }
+                  | undefined
               }) &
                 ({
                   /**  */
@@ -35678,6 +35708,7 @@ export type Routes = {
             | 'kwikset2'
             | 'keynest'
             | 'dormakaba_ambiance'
+            | 'ultraloq'
             | 'yale_access'
             | 'hid_cm'
             | 'google_nest'
@@ -37984,6 +38015,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -38921,6 +38959,7 @@ export type Routes = {
             | 'sensi'
             | 'smartthings'
             | 'keynest'
+            | 'ultraloq'
           )
         | undefined
       /** Array of device IDs for which you want to list devices. */
@@ -39722,6 +39761,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -40591,6 +40637,7 @@ export type Routes = {
           | 'kwikset2'
           | 'keynest'
           | 'dormakaba_ambiance'
+          | 'ultraloq'
         display_name: string
         image_url: string
         provider_categories: (
@@ -41331,6 +41378,7 @@ export type Routes = {
             | 'sensi'
             | 'smartthings'
             | 'keynest'
+            | 'ultraloq'
           )
         | undefined
       /** Array of device IDs for which you want to list devices. */
@@ -47493,6 +47541,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -49007,6 +49062,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -49906,6 +49968,7 @@ export type Routes = {
             | 'akiles'
             | 'kwikset2'
             | 'smartthings'
+            | 'ultraloq'
           )
         | undefined
       /** Array of device IDs for which you want to list devices. */
@@ -50707,6 +50770,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -52220,6 +52290,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -59623,6 +59700,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -61136,6 +61220,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -71618,6 +71709,13 @@ export type Routes = {
                       has_photo?: boolean | undefined
                     }
                   | undefined
+                /** Metadata for a Ultraloq device. */
+                ultraloq_metadata?:
+                  | {
+                      /** Device ID for a Ultraloq device. */
+                      device_id: string
+                    }
+                  | undefined
               }) &
                 ({
                   /**  */
@@ -78232,6 +78330,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -82778,6 +82883,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -84291,6 +84403,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -92555,6 +92674,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -94070,6 +94196,13 @@ export type Routes = {
                 has_photo?: boolean | undefined
               }
             | undefined
+          /** Metadata for a Ultraloq device. */
+          ultraloq_metadata?:
+            | {
+                /** Device ID for a Ultraloq device. */
+                device_id: string
+              }
+            | undefined
         }) &
           ({
             /**  */
@@ -95445,6 +95578,22 @@ export type Routes = {
       }[]
     }
   }
+  '/user_identities/unmanaged/update': {
+    route: '/user_identities/unmanaged/update'
+    method: 'PATCH' | 'POST'
+    queryParams: {}
+    jsonBody: {
+      /** ID of the unmanaged user identity that you want to update. */
+      user_identity_id: string
+      /** Must be set to true to convert the unmanaged user identity to managed. */
+      is_managed: true
+      /** Unique key for the user identity. If not provided, the existing key will be preserved. */
+      user_identity_key?: string | undefined
+    }
+    commonParams: {}
+    formData: {}
+    jsonResponse: {}
+  }
   '/user_identities/update': {
     route: '/user_identities/update'
     method: 'PATCH' | 'POST'
@@ -96576,6 +96725,13 @@ export type Routes = {
                       has_photo?: boolean | undefined
                     }
                   | undefined
+                /** Metadata for a Ultraloq device. */
+                ultraloq_metadata?:
+                  | {
+                      /** Device ID for a Ultraloq device. */
+                      device_id: string
+                    }
+                  | undefined
               }) &
                 ({
                   /**  */