@seamapi/types 1.476.0 → 1.478.0

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

@@ -16903,6 +16903,48 @@ export type Routes = {
                     /** The actual PIN code for code access methods. */
                     code?: string | undefined;
                 }[] | undefined;
+                access_grants?: {
+                    /** ID of the Seam workspace associated with the Access Grant. */
+                    workspace_id: string;
+                    /** ID of the Access Grant. */
+                    access_grant_id: string;
+                    /** Unique key for the access grant within the workspace. */
+                    access_grant_key?: string | undefined;
+                    /** ID of user identity to which the Access Grant gives access. */
+                    user_identity_id: string;
+                    /**
+                     * @deprecated Use `space_ids`.*/
+                    location_ids: string[];
+                    /** IDs of the spaces to which the Access Grant gives access. */
+                    space_ids: string[];
+                    /** Access methods that the user requested for the Access Grant. */
+                    requested_access_methods: {
+                        /** Display name of the access method. */
+                        display_name: string;
+                        /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                        mode: 'code' | 'card' | 'mobile_key';
+                        /** Date and time at which the requested access method was added to the Access Grant. */
+                        created_at: string;
+                        /** IDs of the access methods created for the requested access method. */
+                        created_access_method_ids: string[];
+                    }[];
+                    /** IDs of the access methods created for the Access Grant. */
+                    access_method_ids: string[];
+                    /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+                    client_session_token?: string | undefined;
+                    /** Name of the Access Grant. If not provided, the display name will be computed. */
+                    name: string | null;
+                    /** Display name of the Access Grant. */
+                    display_name: string;
+                    /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+                    instant_key_url?: string | undefined;
+                    /** Date and time at which the Access Grant was created. */
+                    created_at: string;
+                    /** Date and time at which the Access Grant starts. */
+                    starts_at: string;
+                    /** Date and time at which the Access Grant ends. */
+                    ends_at: string | null;
+                }[] | undefined;
             };
         };
     };
@@ -75716,9 +75758,11 @@ export type Routes = {
         commonParams: {};
         formData: {};
         jsonResponse: {
+            /** A customization profile. */
             customization_profile: {
-                workspace_id: string;
                 customization_profile_id: string;
+                workspace_id: string;
+                created_at: string;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
                 secondary_color?: string | undefined;
@@ -75735,9 +75779,11 @@ export type Routes = {
         };
         formData: {};
         jsonResponse: {
+            /** A customization profile. */
             customization_profile: {
-                workspace_id: string;
                 customization_profile_id: string;
+                workspace_id: string;
+                created_at: string;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
                 secondary_color?: string | undefined;
@@ -75753,8 +75799,9 @@ export type Routes = {
         formData: {};
         jsonResponse: {
             customization_profiles: {
-                workspace_id: string;
                 customization_profile_id: string;
+                workspace_id: string;
+                created_at: string;
                 logo_url?: string | undefined;
                 primary_color?: string | undefined;
                 secondary_color?: string | undefined;
@@ -79546,6 +79593,48 @@ export type Routes = {
                     /** The actual PIN code for code access methods. */
                     code?: string | undefined;
                 }[] | undefined;
+                access_grants?: {
+                    /** ID of the Seam workspace associated with the Access Grant. */
+                    workspace_id: string;
+                    /** ID of the Access Grant. */
+                    access_grant_id: string;
+                    /** Unique key for the access grant within the workspace. */
+                    access_grant_key?: string | undefined;
+                    /** ID of user identity to which the Access Grant gives access. */
+                    user_identity_id: string;
+                    /**
+                     * @deprecated Use `space_ids`.*/
+                    location_ids: string[];
+                    /** IDs of the spaces to which the Access Grant gives access. */
+                    space_ids: string[];
+                    /** Access methods that the user requested for the Access Grant. */
+                    requested_access_methods: {
+                        /** Display name of the access method. */
+                        display_name: string;
+                        /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                        mode: 'code' | 'card' | 'mobile_key';
+                        /** Date and time at which the requested access method was added to the Access Grant. */
+                        created_at: string;
+                        /** IDs of the access methods created for the requested access method. */
+                        created_access_method_ids: string[];
+                    }[];
+                    /** IDs of the access methods created for the Access Grant. */
+                    access_method_ids: string[];
+                    /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+                    client_session_token?: string | undefined;
+                    /** Name of the Access Grant. If not provided, the display name will be computed. */
+                    name: string | null;
+                    /** Display name of the Access Grant. */
+                    display_name: string;
+                    /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+                    instant_key_url?: string | undefined;
+                    /** Date and time at which the Access Grant was created. */
+                    created_at: string;
+                    /** Date and time at which the Access Grant starts. */
+                    starts_at: string;
+                    /** Date and time at which the Access Grant ends. */
+                    ends_at: string | null;
+                }[] | undefined;
             };
         };
     };

package/package.json

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

package/src/lib/seam/connect/models/batch.ts

@@ -1,5 +1,6 @@
 import { z } from 'zod'
 
+import { access_grant } from './access-grants/access-grant.js'
 import { access_method } from './access-grants/access-method.js'
 import {
   acs_access_group,
@@ -65,6 +66,7 @@ export const workspaces_batch = z
     unmanaged_devices: unmanaged_device.array().optional(),
     connect_webviews: connect_webview.array().optional(),
     access_methods: access_method.array().optional(),
+    access_grants: access_grant.array().optional(),
   })
   .describe('A batch of workspace resources.')
 
@@ -92,6 +94,7 @@ export const batch = z
     unmanaged_devices: unmanaged_device.array().optional(),
     connect_webviews: connect_webview.array().optional(),
     access_methods: access_method.array().optional(),
+    access_grants: access_grant.array().optional(),
   })
   .describe('A batch of workspace resources.')
 

package/src/lib/seam/connect/models/customization_profiles/customization_profile.ts

@@ -1,11 +1,19 @@
 import { z } from 'zod'
 
 export const customization_profile = z.object({
-  workspace_id: z.string().uuid(),
   customization_profile_id: z.string().uuid(),
-  logo_url: z.string().optional(),
+  workspace_id: z.string().uuid(),
+  created_at: z.string().datetime(),
+  logo_url: z.string().url().optional(),
   primary_color: z.string().optional(),
   secondary_color: z.string().optional(),
-})
+}).describe(`
+  ---
+  title: Customization Profile
+  undocumented: Unreleased.
+  route_path: /workspaces/customization_profiles
+  ---
+  A customization profile.
+`)
 
 export type CustomizationProfile = z.infer<typeof customization_profile>

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

@@ -29150,6 +29150,10 @@ export default {
                     batch: {
                       description: 'A batch of workspace resources.',
                       properties: {
+                        access_grants: {
+                          items: { $ref: '#/components/schemas/access_grant' },
+                          type: 'array',
+                        },
                         access_methods: {
                           items: { $ref: '#/components/schemas/access_method' },
                           type: 'array',
@@ -29313,6 +29317,10 @@ export default {
                     batch: {
                       description: 'A batch of workspace resources.',
                       properties: {
+                        access_grants: {
+                          items: { $ref: '#/components/schemas/access_grant' },
+                          type: 'array',
+                        },
                         access_methods: {
                           items: { $ref: '#/components/schemas/access_method' },
                           type: 'array',
@@ -56082,18 +56090,27 @@ export default {
                 schema: {
                   properties: {
                     customization_profile: {
+                      description: 'A customization profile.',
                       properties: {
+                        created_at: { format: 'date-time', type: 'string' },
                         customization_profile_id: {
                           format: 'uuid',
                           type: 'string',
                         },
-                        logo_url: { type: 'string' },
+                        logo_url: { format: 'uri', type: 'string' },
                         primary_color: { type: 'string' },
                         secondary_color: { type: 'string' },
                         workspace_id: { format: 'uuid', type: 'string' },
                       },
-                      required: ['workspace_id', 'customization_profile_id'],
+                      required: [
+                        'customization_profile_id',
+                        'workspace_id',
+                        'created_at',
+                      ],
                       type: 'object',
+                      'x-route-path': '/workspaces/customization_profiles',
+                      'x-title': 'Customization Profile',
+                      'x-undocumented': 'Unreleased.',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -56115,6 +56132,7 @@ export default {
         'x-fern-sdk-return-value': 'customization_profile',
         'x-response-key': 'customization_profile',
         'x-title': 'Update Customization Profile',
+        'x-undocumented': 'Unreleased.',
       },
     },
     '/workspaces/customization_profiles/get': {
@@ -56136,18 +56154,27 @@ export default {
                 schema: {
                   properties: {
                     customization_profile: {
+                      description: 'A customization profile.',
                       properties: {
+                        created_at: { format: 'date-time', type: 'string' },
                         customization_profile_id: {
                           format: 'uuid',
                           type: 'string',
                         },
-                        logo_url: { type: 'string' },
+                        logo_url: { format: 'uri', type: 'string' },
                         primary_color: { type: 'string' },
                         secondary_color: { type: 'string' },
                         workspace_id: { format: 'uuid', type: 'string' },
                       },
-                      required: ['workspace_id', 'customization_profile_id'],
+                      required: [
+                        'customization_profile_id',
+                        'workspace_id',
+                        'created_at',
+                      ],
                       type: 'object',
+                      'x-route-path': '/workspaces/customization_profiles',
+                      'x-title': 'Customization Profile',
+                      'x-undocumented': 'Unreleased.',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -56169,6 +56196,7 @@ export default {
         'x-fern-sdk-return-value': 'customization_profile',
         'x-response-key': 'customization_profile',
         'x-title': 'Get Customization Profile',
+        'x-undocumented': 'Unreleased.',
       },
       post: {
         description: 'Retrieves the customization profile for the workspace.',
@@ -56193,18 +56221,27 @@ export default {
                 schema: {
                   properties: {
                     customization_profile: {
+                      description: 'A customization profile.',
                       properties: {
+                        created_at: { format: 'date-time', type: 'string' },
                         customization_profile_id: {
                           format: 'uuid',
                           type: 'string',
                         },
-                        logo_url: { type: 'string' },
+                        logo_url: { format: 'uri', type: 'string' },
                         primary_color: { type: 'string' },
                         secondary_color: { type: 'string' },
                         workspace_id: { format: 'uuid', type: 'string' },
                       },
-                      required: ['workspace_id', 'customization_profile_id'],
+                      required: [
+                        'customization_profile_id',
+                        'workspace_id',
+                        'created_at',
+                      ],
                       type: 'object',
+                      'x-route-path': '/workspaces/customization_profiles',
+                      'x-title': 'Customization Profile',
+                      'x-undocumented': 'Unreleased.',
                     },
                     ok: { type: 'boolean' },
                   },
@@ -56226,6 +56263,7 @@ export default {
         'x-fern-sdk-return-value': 'customization_profile',
         'x-response-key': 'customization_profile',
         'x-title': 'Get Customization Profile',
+        'x-undocumented': 'Unreleased.',
       },
     },
     '/workspaces/customization_profiles/list': {
@@ -56240,18 +56278,27 @@ export default {
                   properties: {
                     customization_profiles: {
                       items: {
+                        description: 'A customization profile.',
                         properties: {
+                          created_at: { format: 'date-time', type: 'string' },
                           customization_profile_id: {
                             format: 'uuid',
                             type: 'string',
                           },
-                          logo_url: { type: 'string' },
+                          logo_url: { format: 'uri', type: 'string' },
                           primary_color: { type: 'string' },
                           secondary_color: { type: 'string' },
                           workspace_id: { format: 'uuid', type: 'string' },
                         },
-                        required: ['workspace_id', 'customization_profile_id'],
+                        required: [
+                          'customization_profile_id',
+                          'workspace_id',
+                          'created_at',
+                        ],
                         type: 'object',
+                        'x-route-path': '/workspaces/customization_profiles',
+                        'x-title': 'Customization Profile',
+                        'x-undocumented': 'Unreleased.',
                       },
                       type: 'array',
                     },
@@ -56275,6 +56322,7 @@ export default {
         'x-fern-sdk-return-value': 'customization_profiles',
         'x-response-key': 'customization_profiles',
         'x-title': 'Get Customization Profile',
+        'x-undocumented': 'Unreleased.',
       },
       post: {
         description: 'Retrieves the customization profile for the workspace.',
@@ -56287,18 +56335,27 @@ export default {
                   properties: {
                     customization_profiles: {
                       items: {
+                        description: 'A customization profile.',
                         properties: {
+                          created_at: { format: 'date-time', type: 'string' },
                           customization_profile_id: {
                             format: 'uuid',
                             type: 'string',
                           },
-                          logo_url: { type: 'string' },
+                          logo_url: { format: 'uri', type: 'string' },
                           primary_color: { type: 'string' },
                           secondary_color: { type: 'string' },
                           workspace_id: { format: 'uuid', type: 'string' },
                         },
-                        required: ['workspace_id', 'customization_profile_id'],
+                        required: [
+                          'customization_profile_id',
+                          'workspace_id',
+                          'created_at',
+                        ],
                         type: 'object',
+                        'x-route-path': '/workspaces/customization_profiles',
+                        'x-title': 'Customization Profile',
+                        'x-undocumented': 'Unreleased.',
                       },
                       type: 'array',
                     },
@@ -56322,6 +56379,7 @@ export default {
         'x-fern-sdk-return-value': 'customization_profiles',
         'x-response-key': 'customization_profiles',
         'x-title': 'Get Customization Profile',
+        'x-undocumented': 'Unreleased.',
       },
     },
     '/workspaces/customization_profiles/update': {
@@ -56366,6 +56424,7 @@ export default {
         'x-fern-sdk-method-name': 'update',
         'x-response-key': null,
         'x-title': 'Update Customization Profile',
+        'x-undocumented': 'Unreleased.',
       },
       post: {
         description: 'Updates the customization profile for the workspace.',
@@ -56408,6 +56467,7 @@ export default {
         'x-fern-sdk-method-name': 'update',
         'x-response-key': null,
         'x-title': 'Update Customization Profile',
+        'x-undocumented': 'Unreleased.',
       },
     },
     '/workspaces/customization_profiles/upload_images': {
@@ -56437,7 +56497,8 @@ export default {
         'x-fern-sdk-method-name': 'upload_images',
         'x-response-key': null,
         'x-title': 'Upload Customization Profile Logo',
-        'x-undocumented': 'Internal endpoint for customer portals.',
+        'x-undocumented':
+          'Internal form-data endpoint for Console and Customer Portal.',
       },
     },
     '/workspaces/find_resources': {
@@ -56461,6 +56522,10 @@ export default {
                     batch: {
                       description: 'A batch of workspace resources.',
                       properties: {
+                        access_grants: {
+                          items: { $ref: '#/components/schemas/access_grant' },
+                          type: 'array',
+                        },
                         access_methods: {
                           items: { $ref: '#/components/schemas/access_method' },
                           type: 'array',
@@ -56599,6 +56664,10 @@ export default {
                     batch: {
                       description: 'A batch of workspace resources.',
                       properties: {
+                        access_grants: {
+                          items: { $ref: '#/components/schemas/access_grant' },
+                          type: 'array',
+                        },
                         access_methods: {
                           items: { $ref: '#/components/schemas/access_method' },
                           type: 'array',

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

@@ -19578,6 +19578,50 @@ export type Routes = {
               code?: string | undefined
             }[]
           | undefined
+        access_grants?:
+          | {
+              /** ID of the Seam workspace associated with the Access Grant. */
+              workspace_id: string
+              /** ID of the Access Grant. */
+              access_grant_id: string
+              /** Unique key for the access grant within the workspace. */
+              access_grant_key?: string | undefined
+              /** ID of user identity to which the Access Grant gives access. */
+              user_identity_id: string
+              /**
+               * @deprecated Use `space_ids`.*/
+              location_ids: string[]
+              /** IDs of the spaces to which the Access Grant gives access. */
+              space_ids: string[]
+              /** Access methods that the user requested for the Access Grant. */
+              requested_access_methods: {
+                /** Display name of the access method. */
+                display_name: string
+                /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                mode: 'code' | 'card' | 'mobile_key'
+                /** Date and time at which the requested access method was added to the Access Grant. */
+                created_at: string
+                /** IDs of the access methods created for the requested access method. */
+                created_access_method_ids: string[]
+              }[]
+              /** IDs of the access methods created for the Access Grant. */
+              access_method_ids: string[]
+              /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+              client_session_token?: string | undefined
+              /** Name of the Access Grant. If not provided, the display name will be computed. */
+              name: string | null
+              /** Display name of the Access Grant. */
+              display_name: string
+              /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+              instant_key_url?: string | undefined
+              /** Date and time at which the Access Grant was created. */
+              created_at: string
+              /** Date and time at which the Access Grant starts. */
+              starts_at: string
+              /** Date and time at which the Access Grant ends. */
+              ends_at: string | null
+            }[]
+          | undefined
       }
     }
   }
@@ -89861,9 +89905,11 @@ export type Routes = {
     commonParams: {}
     formData: {}
     jsonResponse: {
+      /** A customization profile. */
       customization_profile: {
-        workspace_id: string
         customization_profile_id: string
+        workspace_id: string
+        created_at: string
         logo_url?: string | undefined
         primary_color?: string | undefined
         secondary_color?: string | undefined
@@ -89880,9 +89926,11 @@ export type Routes = {
     }
     formData: {}
     jsonResponse: {
+      /** A customization profile. */
       customization_profile: {
-        workspace_id: string
         customization_profile_id: string
+        workspace_id: string
+        created_at: string
         logo_url?: string | undefined
         primary_color?: string | undefined
         secondary_color?: string | undefined
@@ -89898,8 +89946,9 @@ export type Routes = {
     formData: {}
     jsonResponse: {
       customization_profiles: {
-        workspace_id: string
         customization_profile_id: string
+        workspace_id: string
+        created_at: string
         logo_url?: string | undefined
         primary_color?: string | undefined
         secondary_color?: string | undefined
@@ -94514,6 +94563,50 @@ export type Routes = {
               code?: string | undefined
             }[]
           | undefined
+        access_grants?:
+          | {
+              /** ID of the Seam workspace associated with the Access Grant. */
+              workspace_id: string
+              /** ID of the Access Grant. */
+              access_grant_id: string
+              /** Unique key for the access grant within the workspace. */
+              access_grant_key?: string | undefined
+              /** ID of user identity to which the Access Grant gives access. */
+              user_identity_id: string
+              /**
+               * @deprecated Use `space_ids`.*/
+              location_ids: string[]
+              /** IDs of the spaces to which the Access Grant gives access. */
+              space_ids: string[]
+              /** Access methods that the user requested for the Access Grant. */
+              requested_access_methods: {
+                /** Display name of the access method. */
+                display_name: string
+                /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
+                mode: 'code' | 'card' | 'mobile_key'
+                /** Date and time at which the requested access method was added to the Access Grant. */
+                created_at: string
+                /** IDs of the access methods created for the requested access method. */
+                created_access_method_ids: string[]
+              }[]
+              /** IDs of the access methods created for the Access Grant. */
+              access_method_ids: string[]
+              /** Client Session Token. Only returned if the Access Grant has a mobile_key access method. */
+              client_session_token?: string | undefined
+              /** Name of the Access Grant. If not provided, the display name will be computed. */
+              name: string | null
+              /** Display name of the Access Grant. */
+              display_name: string
+              /** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method.  */
+              instant_key_url?: string | undefined
+              /** Date and time at which the Access Grant was created. */
+              created_at: string
+              /** Date and time at which the Access Grant starts. */
+              starts_at: string
+              /** Date and time at which the Access Grant ends. */
+              ends_at: string | null
+            }[]
+          | undefined
       }
     }
   }