@seamapi/types 1.416.1 → 1.417.0

package/src/lib/seam/connect/models/partner/resources.ts

@@ -1,59 +1,112 @@
 import { z } from 'zod'
 
 export const partner_resource = z.object({
-  partner_resource_type: z.string(),
-  partner_resource_key: z.string(),
-  customer_key: z.string(),
+  partner_resource_type: z.string().describe('Type of the partner resource.'),
+  partner_resource_key: z.string().describe('Key of the partner resource.'),
+  customer_key: z
+    .string()
+    .describe('Customer key associated with the partner resource.'),
 
   // For user identity partner resources
-  email_address: z.string().optional(),
-  phone_number: z.string().optional(),
+  email_address: z
+    .string()
+    .optional()
+    .describe(
+      'Email address associated with the user identity partner resource.',
+    ),
+  phone_number: z
+    .string()
+    .optional()
+    .describe(
+      'Phone number associated with the user identity partner resource.',
+    ),
 
   // For access grant partner resources
-  starts_at: z.string().optional(),
-  ends_at: z.string().optional(),
-  user_identity_key: z.string().optional(),
-  location_keys: z.array(z.string()).optional(),
+  starts_at: z
+    .string()
+    .optional()
+    .describe(
+      'Starting date and time associated with the access grant partner resource.',
+    ),
+  ends_at: z
+    .string()
+    .optional()
+    .describe(
+      'Ending date and time associated with the access grant partner resource.',
+    ),
+  user_identity_key: z
+    .string()
+    .optional()
+    .describe(
+      'User identity key associated with the access grant partner resource.',
+    ),
+  location_keys: z
+    .array(z.string())
+    .optional()
+    .describe(
+      'Location keys associated with the access grant partner resource.',
+    ),
 
   // Common
-  name: z.string().optional(),
-  description: z.string().optional(),
-  custom_metadata: z.record(z.string(), z.string()).optional(),
+  name: z.string().optional().describe('Name of the partner resource.'),
+  description: z
+    .string()
+    .optional()
+    .describe('Description of the partner resource.'),
+  custom_metadata: z
+    .record(z.string(), z.string())
+    .optional()
+    .describe('Custom metadata associated with the partner resource.'),
 }).describe(`
   ---
   undocumented: Unreleased.
   route_path: /unstable_partner/resources
   ---
+  Represents a partner resource that enables you to send your user identity and access grant resources to Seam.
   `)
 
 export type PartnerResource = z.infer<typeof partner_resource>
 
 export const typed_partner_resource = z.object({
-  partner_resource_key: z.string(),
+  partner_resource_key: z.string().describe('Key of the partner resource.'),
 
-  name: z.string(),
-  description: z.string().optional(),
-  custom_metadata: z.record(z.string(), z.string()).optional(),
+  name: z.string().describe('Name of the partner resource.'),
+  description: z
+    .string()
+    .optional()
+    .describe('Description of the partner resource.'),
+  custom_metadata: z
+    .record(z.string(), z.string())
+    .optional()
+    .describe('Custom metadata associated with the partner resource.'),
 }).describe(`
   ---
   undocumented: Unreleased.
   route_path: /unstable_partner/resources
   ---
+  Represents a typed partner resource that enables you to send your user identity and access grant resources to Seam.
   `)
 
 export type TypedPartnerResource = z.infer<typeof typed_partner_resource>
 
 export const space_resource = z.object({
-  space_key: z.string(),
+  space_key: z.string().describe('Key of the space for the resource.'),
 
-  name: z.string(),
-  description: z.string().optional(),
-  custom_metadata: z.record(z.string(), z.string()).optional(),
+  name: z.string().describe('Name of the space resource.'),
+  description: z
+    .string()
+    .optional()
+    .describe('Description of the space resource.'),
+  custom_metadata: z
+    .record(z.string(), z.string())
+    .optional()
+    .describe('Custom metadata associated with the space resource.'),
 }).describe(`
   ---
   undocumented: Unreleased.
   route_path: /unstable_partner/resources
   ---
+  Represents a partner resource that enables you to send your space resources to Seam.
   `)
 
 export type SpaceResource = z.infer<typeof space_resource>

package/src/lib/seam/connect/models/phones/phone-registration.ts

@@ -1,15 +1,18 @@
 import { z } from 'zod'
 
 export const phone_registration = z.object({
-  phone_registration_id: z.string(),
-  provider_state: z.any(),
-  provider_name: z.string().nullable(),
-  is_being_activated: z.boolean(),
+  phone_registration_id: z.string().describe('Registration ID for the phone.'),
+  provider_state: z.any().describe('Provider state for the phone.'),
+  provider_name: z.string().nullable().describe('Provider name for the phone.'),
+  is_being_activated: z
+    .boolean()
+    .describe('Indicates whether the phone is being activated.'),
 }).describe(`
   ---
   route_path: /seam/mobile_sdk/v1/phone_sessions
   undocumented: Seam Mobile SDK only.
   ---
+  Represents a mobile phone registration.
 `)
 
 export type PhoneRegistration = z.infer<typeof phone_registration>

package/src/lib/seam/connect/models/phones/phone-session.ts

@@ -4,26 +4,34 @@ import { acs_credential } from '../acs/acs-credential.js'
 import { acs_entrance } from '../acs/acs-entrance.js'
 import { phone_registration } from './phone-registration.js'
 
-const phone_provider_session = z.object({
-  phone_registration,
-  acs_credentials: acs_credential
-    .omit({
-      acs_credential_id: true,
-    })
-    .extend({
-      acs_credential_id: z.string().nullable(),
-      acs_entrances: acs_entrance.array(),
-    })
-    .array(),
-})
+const phone_provider_session = z
+  .object({
+    phone_registration,
+    acs_credentials: acs_credential
+      .omit({
+        acs_credential_id: true,
+      })
+      .extend({
+        acs_credential_id: z.string().nullable(),
+        acs_entrances: acs_entrance.array(),
+      })
+      .array()
+      .describe(
+        'Access system credentials associated with the phone provider session.',
+      ),
+  })
+  .describe('Phone provider session.')
 
 export const phone_session = z.object({
-  provider_sessions: phone_provider_session.array(),
+  provider_sessions: phone_provider_session
+    .array()
+    .describe('Phone provider sessions.'),
 }).describe(`
   ---
   route_path: /seam/mobile_sdk/v1/phone_sessions
   undocumented: Seam Mobile SDK only.
   ---
+  Represents a mobile phone session.
 `)
 
 export type PhoneProviderSession = z.infer<typeof phone_provider_session>

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

@@ -1,20 +1,24 @@
 import { z } from 'zod'
 
-export const start_end_schedule = z.object({
-  starts_at: z
-    .string()
-    .datetime()
-    .describe(
-      "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
-    ),
-  ends_at: z
-    .string()
-    .datetime()
-    .describe(
-      "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
-    )
-    .nullable(),
-})
+export const start_end_schedule = z
+  .object({
+    starts_at: z
+      .string()
+      .datetime()
+      .describe(
+        "Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+      ),
+    ends_at: z
+      .string()
+      .datetime()
+      .describe(
+        "Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.",
+      )
+      .nullable(),
+  })
+  .describe(
+    'Schedule with starting and ending dates and times, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
+  )
 
 // export const schedule = z.union([
 //   start_end_schedule,

package/src/lib/seam/connect/models/spaces/space.ts

@@ -1,24 +1,25 @@
 import { z } from 'zod'
 
 export const space = z.object({
-  space_id: z.string().uuid().describe('Unique identifier for the space.'),
+  space_id: z.string().uuid().describe('ID of the space.'),
   workspace_id: z
     .string()
     .uuid()
     .describe(
-      'Unique identifier for the Seam workspace associated with the space.',
+      'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space.',
     ),
   name: z.string().describe('Name of the space.'),
-  display_name: z.string().describe('Display name of the space.'),
+  display_name: z.string().describe('Display name for the space.'),
   created_at: z
     .string()
     .datetime()
-    .describe('Date and time at which the space object was created.'),
+    .describe('Date and time at which the space was created.'),
 }).describe(`
   ---
   draft: Early access.
   route_path: /spaces
   ---
+  Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient.
   `)
 
 export type Space = z.infer<typeof space>

package/src/lib/seam/connect/models/webhooks/webhook.ts

@@ -1,14 +1,33 @@
 import { z } from 'zod'
 
 export const webhook = z.object({
-  webhook_id: z.string(),
-  url: z.string(),
-  event_types: z.array(z.string()).optional(),
-  secret: z.string().optional(),
+  webhook_id: z
+    .string()
+    .describe(
+      'ID of the [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
+    ),
+  url: z
+    .string()
+    .describe(
+      'URL for the [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
+    ),
+  event_types: z
+    .array(z.string())
+    .optional()
+    .describe(
+      'Types of events that the [webhook](https://docs.seam.co/latest/developer-tools/webhooks) should receive.',
+    ),
+  secret: z
+    .string()
+    .optional()
+    .describe(
+      'Secret associated with the [webhook](https://docs.seam.co/latest/developer-tools/webhooks).',
+    ),
 }).describe(`
   ---
   route_path: /webhooks
   ---
-`)
+  Represents a [webhook](https://docs.seam.co/latest/developer-tools/webhooks) that enables you to receive notifications of events. When you create a webhook, specify the endpoint URL at which you want to receive events and the set of event types that you want to receive.
+  `)
 
 export type Webhook = z.infer<typeof webhook>

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

@@ -3,27 +3,69 @@ 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(),
+  workspace_id: z
+    .string()
+    .uuid()
+    .describe(
+      'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
+    ),
+  name: z
+    .string()
+    .describe(
+      'Name of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
+    ),
+  company_name: z
+    .string()
+    .describe(
+      'Company name associated with the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
+    ),
+  is_sandbox: z
+    .boolean()
+    .describe(
+      'Indicates whether the workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces).',
+    ),
   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(),
+    primary_button_color: hex_color_code
+      .optional()
+      .describe(
+        'Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).',
+      ),
+    primary_button_text_color: hex_color_code
+      .optional()
+      .describe(
+        'Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).',
+      ),
+    success_message: z
+      .string()
+      .optional()
+      .describe(
+        'Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).',
+      ),
+    logo_shape: z
+      .enum(['circle', 'square'])
+      .optional()
+      .describe(
+        'Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).',
+      ),
+    inviter_logo_url: z
+      .string()
+      .optional()
+      .describe(
+        'URL of the inviter logo for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).',
+      ),
   }),
   is_suspended: z
     .boolean()
-    .describe('True if a sandbox workspace has not been accessed in 14 days'),
+    .describe(
+      'Indicates whether the [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces) is suspended. Seam suspends sandbox workspaces that have not been accessed in 14 days.',
+    ),
   connect_partner_name: z
     .string()
     .nullable()
     .describe(
       `
     ---
-    deprecated: use company_name
+    deprecated: Use \`company_name\` instead.
     ---
   `,
     )