@seamapi/types 1.385.0 → 1.386.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/types",
-  "version": "1.385.0",
+  "version": "1.386.0",
   "description": "TypeScript types for the Seam API.",
   "type": "module",
   "main": "index.js",
@@ -92,7 +92,7 @@
     "zod": "^3.24.0"
   },
   "devDependencies": {
-    "@seamapi/blueprint": "^0.39.0",
+    "@seamapi/blueprint": "^0.40.0",
     "@types/node": "^20.8.10",
     "concurrently": "^8.2.0",
     "del-cli": "^5.0.0",

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

@@ -0,0 +1,9 @@
+import { z } from 'zod'
+
+export const hex_color_code = z.string().refine((value) => {
+  if (value != null) {
+    return /^#[\da-fa-z]{3,6}$/i.test(value)
+  }
+
+  return true
+}, 'Must be a hex color')

package/src/lib/seam/connect/models/events/access-grants.ts

@@ -0,0 +1,92 @@
+import { z } from 'zod'
+
+import { common_event } from './common.js'
+
+const access_grant_event = common_event.extend({
+  access_grant_id: z.string().uuid().describe('ID of the access grant.'),
+})
+
+export const access_grant_created_event = access_grant_event.extend({
+  event_type: z.literal('access_grant.created'),
+}).describe(`
+    ---
+    route_path: /access_grants
+    ---
+    An access grant was created.
+  `)
+
+export type AccessGrantCreatedEvent = z.infer<typeof access_grant_created_event>
+
+export const access_grant_deleted_event = access_grant_event.extend({
+  event_type: z.literal('access_grant.deleted'),
+}).describe(`
+    ---
+    route_path: /access_grants
+    ---
+    An access grant was deleted.
+  `)
+
+export type AccessGrantDeleteddEvent = z.infer<
+  typeof access_grant_deleted_event
+>
+
+export const access_grant_access_granted_to_all_doors_event =
+  access_grant_event.extend({
+    event_type: z.literal('access_grant.access_granted_to_all_doors'),
+  }).describe(`
+    ---
+    route_path: /access_grants
+    ---
+    All access requested for an access grant was successfully granted.
+  `)
+
+export type AccessGrantAccessGrantedToAllDoorsEvent = z.infer<
+  typeof access_grant_access_granted_to_all_doors_event
+>
+
+const acs_entrance_id = z
+  .string()
+  .uuid()
+  .describe(
+    'ID of the door, an [ACS entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details).',
+  )
+
+export const access_grant_access_granted_to_door_event =
+  access_grant_event.extend({
+    event_type: z.literal('access_grant.access_granted_to_door'),
+    acs_entrance_id,
+  }).describe(`
+    ---
+    route_path: /access_grants
+    ---
+    Access requested as part of an access grant to a particular door was successfully granted.
+  `)
+
+export type AccessGrantAccessGrantedToDoorEvent = z.infer<
+  typeof access_grant_access_granted_to_door_event
+>
+
+export const access_grant_access_to_door_lost_event = access_grant_event.extend(
+  {
+    event_type: z.literal('access_grant.access_to_door_lost'),
+    acs_entrance_id,
+  },
+).describe(`
+    ---
+    route_path: /access_grants
+    ---
+    Access to a particular door that was requested as part of an access grant was lost.
+  `)
+
+export type AccessGrantAccessToDoorLostEvent = z.infer<
+  typeof access_grant_access_to_door_lost_event
+>
+
+export const access_code_events = [
+  access_grant_created_event,
+  access_grant_deleted_event,
+  access_grant_access_granted_to_all_doors_event,
+  access_grant_access_granted_to_door_event,
+  access_grant_access_to_door_lost_event,
+  access_grant_deleted_event,
+] as const

package/src/lib/seam/connect/models/events/access-methods.ts

@@ -0,0 +1,51 @@
+import { z } from 'zod'
+
+import { common_event } from './common.js'
+
+const access_method_event = common_event.extend({
+  access_method_id: z.string().uuid().describe('ID of the access method.'),
+})
+
+export const access_method_issued_event = access_method_event.extend({
+  event_type: z.literal('access_method.issued'),
+}).describe(`
+    ---
+    route_path: /access_methods
+    ---
+    An access method was issued.
+  `)
+
+export type AccessMethodIssuedEvent = z.infer<typeof access_method_issued_event>
+
+export const access_method_card_encoding_required_event =
+  access_method_event.extend({
+    event_type: z.literal('access_method.card_encoding_required'),
+  }).describe(`
+    ---
+    route_path: /access_methods
+    ---
+    An access method representing a physical card requires encoding.
+  `)
+
+export type AccessMethodCardEncodingRequiredEvent = z.infer<
+  typeof access_method_card_encoding_required_event
+>
+
+export const access_method_revoked_event = access_method_event.extend({
+  event_type: z.literal('access_method.revoked'),
+}).describe(`
+    ---
+    route_path: /access_methods
+    ---
+    An access method was revoked.
+  `)
+
+export type AccessMethodRevokedEvent = z.infer<
+  typeof access_method_revoked_event
+>
+
+export const access_code_events = [
+  access_method_issued_event,
+  access_method_revoked_event,
+  access_method_card_encoding_required_event,
+] as const

package/src/lib/seam/connect/models/workspaces/workspace.ts

@@ -1,10 +1,19 @@
 import { z } from 'zod'
 
+import { hex_color_code } from '../colors.js'
+
 export const workspace = z.object({
   workspace_id: z.string().uuid(),
   name: z.string(),
   company_name: z.string(),
   is_sandbox: z.boolean(),
+  connect_webview_customization: z.object({
+    primary_button_color: hex_color_code.optional(),
+    primary_button_text_color: hex_color_code.optional(),
+    success_message: z.string().optional(),
+    logo_shape: z.enum(['circle', 'square']).optional(),
+    inviter_logo_url: z.string().optional(),
+  }),
   is_suspended: z
     .boolean()
     .describe('True if a sandbox workspace has not been accessed in 14 days'),

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

@@ -17563,6 +17563,16 @@ export default {
             type: 'string',
             'x-deprecated': 'use company_name',
           },
+          connect_webview_customization: {
+            properties: {
+              inviter_logo_url: { type: 'string' },
+              logo_shape: { enum: ['circle', 'square'], type: 'string' },
+              primary_button_color: { type: 'string' },
+              primary_button_text_color: { type: 'string' },
+              success_message: { type: 'string' },
+            },
+            type: 'object',
+          },
           is_sandbox: { type: 'boolean' },
           is_suspended: {
             description:
@@ -17577,6 +17587,7 @@ export default {
           'name',
           'company_name',
           'is_sandbox',
+          'connect_webview_customization',
           'is_suspended',
           'connect_partner_name',
         ],
@@ -26277,11 +26288,11 @@ export default {
                 schema: {
                   properties: {
                     action_attempt: {
-                      $ref: '#/components/schemas/access_code',
+                      $ref: '#/components/schemas/action_attempt',
                     },
                     ok: { type: 'boolean' },
                   },
-                  required: ['ok'],
+                  required: ['action_attempt', 'ok'],
                   type: 'object',
                 },
               },
@@ -26327,11 +26338,11 @@ export default {
                 schema: {
                   properties: {
                     action_attempt: {
-                      $ref: '#/components/schemas/access_code',
+                      $ref: '#/components/schemas/action_attempt',
                     },
                     ok: { type: 'boolean' },
                   },
-                  required: ['ok'],
+                  required: ['action_attempt', 'ok'],
                   type: 'object',
                 },
               },
@@ -26351,7 +26362,8 @@ export default {
         'x-action-attempt-type': 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD',
         'x-fern-sdk-group-name': ['locks', 'simulate'],
         'x-fern-sdk-method-name': 'manual_lock_via_keypad',
-        'x-response-key': null,
+        'x-fern-sdk-return-value': 'action_attempt',
+        'x-response-key': 'action_attempt',
         'x-undocumented': 'Unreleased.',
       },
     },
@@ -32680,6 +32692,13 @@ export default {
             'application/json': {
               schema: {
                 properties: {
+                  max_use_count: {
+                    default: 1,
+                    description:
+                      'The maximum number of times the instant key can be used. Defaults to 1.',
+                    format: 'float',
+                    type: 'number',
+                  },
                   user_identity_id: {
                     description:
                       'ID of the user identity for which you want to generate an instant key.',
@@ -33702,15 +33721,49 @@ export default {
                     type: 'string',
                     'x-deprecated': 'use company_name',
                   },
+                  connect_webview_customization: {
+                    properties: {
+                      logo_shape: {
+                        enum: ['circle', 'square'],
+                        nullable: true,
+                        type: 'string',
+                      },
+                      primary_button_color: { nullable: true, type: 'string' },
+                      primary_button_text_color: {
+                        nullable: true,
+                        type: 'string',
+                      },
+                      success_message: { nullable: true, type: 'string' },
+                    },
+                    type: 'object',
+                  },
                   is_sandbox: { default: false, type: 'boolean' },
                   name: { type: 'string' },
                   webview_logo_shape: {
+                    deprecated: true,
                     enum: ['circle', 'square'],
                     type: 'string',
+                    'x-deprecated':
+                      'Use `connect_webview_customization.webview_logo_shape` instead.',
+                  },
+                  webview_primary_button_color: {
+                    deprecated: true,
+                    type: 'string',
+                    'x-deprecated':
+                      'Use `connect_webview_customization.webview_primary_button_color` instead.',
+                  },
+                  webview_primary_button_text_color: {
+                    deprecated: true,
+                    type: 'string',
+                    'x-deprecated':
+                      'Use `connect_webview_customization.webview_primary_button_text_color` instead.',
+                  },
+                  webview_success_message: {
+                    deprecated: true,
+                    type: 'string',
+                    'x-deprecated':
+                      'Use `connect_webview_customization.webview_success_message` instead.',
                   },
-                  webview_primary_button_color: { type: 'string' },
-                  webview_primary_button_text_color: { type: 'string' },
-                  webview_success_message: { type: 'string' },
                 },
                 required: ['name'],
                 type: 'object',
@@ -33934,6 +33987,103 @@ export default {
         'x-response-key': 'action_attempt',
       },
     },
+    '/workspaces/update': {
+      patch: {
+        operationId: 'workspacesUpdatePatch',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  connect_partner_name: { type: 'string' },
+                  connect_webview_customization: {
+                    properties: {
+                      logo_shape: {
+                        enum: ['circle', 'square'],
+                        nullable: true,
+                        type: 'string',
+                      },
+                      primary_button_color: { nullable: true, type: 'string' },
+                      primary_button_text_color: {
+                        nullable: true,
+                        type: 'string',
+                      },
+                      success_message: { nullable: true, type: 'string' },
+                    },
+                    type: 'object',
+                  },
+                  is_suspended: { type: 'boolean' },
+                  name: { type: 'string' },
+                },
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: { description: 'OK' },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { api_key: [] },
+          { console_session_with_workspace: [] },
+          { pat_with_workspace: [] },
+        ],
+        summary: '/workspaces/update',
+        tags: ['/workspaces'],
+        'x-fern-ignore': true,
+        'x-response-key': null,
+      },
+      post: {
+        operationId: 'workspacesUpdatePost',
+        requestBody: {
+          content: {
+            'application/json': {
+              schema: {
+                properties: {
+                  connect_partner_name: { type: 'string' },
+                  connect_webview_customization: {
+                    properties: {
+                      logo_shape: {
+                        enum: ['circle', 'square'],
+                        nullable: true,
+                        type: 'string',
+                      },
+                      primary_button_color: { nullable: true, type: 'string' },
+                      primary_button_text_color: {
+                        nullable: true,
+                        type: 'string',
+                      },
+                      success_message: { nullable: true, type: 'string' },
+                    },
+                    type: 'object',
+                  },
+                  is_suspended: { type: 'boolean' },
+                  name: { type: 'string' },
+                },
+                type: 'object',
+              },
+            },
+          },
+        },
+        responses: {
+          200: { description: 'OK' },
+          400: { description: 'Bad Request' },
+          401: { description: 'Unauthorized' },
+        },
+        security: [
+          { api_key: [] },
+          { console_session_with_workspace: [] },
+          { pat_with_workspace: [] },
+        ],
+        summary: '/workspaces/update',
+        tags: ['/workspaces'],
+        'x-fern-sdk-group-name': ['workspaces'],
+        'x-fern-sdk-method-name': 'update',
+        'x-response-key': null,
+      },
+    },
   },
   servers: [{ url: 'https://connect.getseam.com' }],
   tags: [