@seamapi/types 1.803.0 → 1.805.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -31863,6 +31863,23 @@ export type Routes = {
31863
31863
 
31864
31864
  With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.
31865
31865
 
31866
+ Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
31867
+ customer_portal: {
31868
+ /** URL for the customer portal. */
31869
+ url: string;
31870
+ /** Customer key for the customer portal. */
31871
+ customer_key: string;
31872
+ /** Date and time at which the customer portal link expires. */
31873
+ expires_at: string;
31874
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal. */
31875
+ workspace_id: string;
31876
+ /** Date and time at which the customer portal link was created. */
31877
+ created_at: string;
31878
+ };
31879
+ /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
31880
+
31881
+ With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.
31882
+
31866
31883
  Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
31867
31884
  magic_link: {
31868
31885
  /** URL for the magic link. */
@@ -1 +1 @@
1
- export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
1
+ export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customer_portal, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
@@ -1,2 +1,2 @@
1
- export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
1
+ export { access_code, acs_access_group, acs_credential, acs_encoder, acs_entrance, acs_system, acs_user, action_attempt, batch, bridge, bridge_client_session, client_session, common_failed_action_attempt, common_pending_action_attempt, common_succeeded_action_attempt, connect_webview, connected_account, custom_metadata, customer_portal, customization_profile, device, device_provider, instant_key, magic_link, noise_threshold, pagination, seam_event, staff_member_resource, thermostat_daily_program, thermostat_schedule, thermostat_weekly_program, unmanaged_access_code, unmanaged_acs_access_group, unmanaged_acs_credential, unmanaged_acs_user, unmanaged_device, user_identity, webhook, workspace, } from './models/index.js';
2
2
  //# sourceMappingURL=schemas.js.map
@@ -1 +1 @@
1
- {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
1
+ {"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/schemas.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,WAAW,EACX,gBAAgB,EAChB,cAAc,EACd,WAAW,EACX,YAAY,EACZ,UAAU,EACV,QAAQ,EACR,cAAc,EACd,KAAK,EACL,MAAM,EACN,qBAAqB,EACrB,cAAc,EACd,4BAA4B,EAC5B,6BAA6B,EAC7B,+BAA+B,EAC/B,eAAe,EACf,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,qBAAqB,EACrB,MAAM,EACN,eAAe,EACf,WAAW,EACX,UAAU,EACV,eAAe,EACf,UAAU,EACV,UAAU,EACV,qBAAqB,EACrB,wBAAwB,EACxB,mBAAmB,EACnB,yBAAyB,EACzB,qBAAqB,EACrB,0BAA0B,EAC1B,wBAAwB,EACxB,kBAAkB,EAClB,gBAAgB,EAChB,aAAa,EACb,OAAO,EACP,SAAS,GACV,MAAM,mBAAmB,CAAA"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.803.0",
3
+ "version": "1.805.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -39,6 +39,7 @@ export {
39
39
  custom_metadata_input,
40
40
  customer,
41
41
  customer_data,
42
+ customer_portal,
42
43
  customer_portal_theme,
43
44
  device_capability_flags,
44
45
  device_metadata,
@@ -0,0 +1,35 @@
1
+ import { z } from 'zod'
2
+
3
+ export const customer_portal = z
4
+ .object({
5
+ url: z.string().url().describe('URL for the customer portal.'),
6
+ customer_key: z.string().describe('Customer key for the customer portal.'),
7
+ expires_at: z
8
+ .string()
9
+ .datetime()
10
+ .describe('Date and time at which the customer portal link expires.'),
11
+ workspace_id: z
12
+ .string()
13
+ .uuid()
14
+ .describe(
15
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal.',
16
+ ),
17
+ created_at: z
18
+ .string()
19
+ .datetime()
20
+ .describe('Date and time at which the customer portal link was created.'),
21
+ })
22
+ .describe(
23
+ `
24
+ ---
25
+ route_path: /customers
26
+ ---
27
+ Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
28
+
29
+ With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.
30
+
31
+ Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control.
32
+ `,
33
+ )
34
+
35
+ export type CustomerPortal = z.infer<typeof customer_portal>
@@ -1 +1,2 @@
1
+ export * from './customer-portal.js'
1
2
  export * from './magic-link.js'
@@ -11306,6 +11306,48 @@ export default {
11306
11306
  'x-route-path': '/customers',
11307
11307
  'x-undocumented': 'Internal resource.',
11308
11308
  },
11309
+ customer_portal: {
11310
+ description:
11311
+ "Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.\n\nWith Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.\n\nSeam hosts these flows, handling everything from account connection and device mapping to full-featured device control.",
11312
+ properties: {
11313
+ created_at: {
11314
+ description:
11315
+ 'Date and time at which the customer portal link was created.',
11316
+ format: 'date-time',
11317
+ type: 'string',
11318
+ },
11319
+ customer_key: {
11320
+ description: 'Customer key for the customer portal.',
11321
+ type: 'string',
11322
+ },
11323
+ expires_at: {
11324
+ description:
11325
+ 'Date and time at which the customer portal link expires.',
11326
+ format: 'date-time',
11327
+ type: 'string',
11328
+ },
11329
+ url: {
11330
+ description: 'URL for the customer portal.',
11331
+ format: 'uri',
11332
+ type: 'string',
11333
+ },
11334
+ workspace_id: {
11335
+ description:
11336
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal.',
11337
+ format: 'uuid',
11338
+ type: 'string',
11339
+ },
11340
+ },
11341
+ required: [
11342
+ 'url',
11343
+ 'customer_key',
11344
+ 'expires_at',
11345
+ 'workspace_id',
11346
+ 'created_at',
11347
+ ],
11348
+ type: 'object',
11349
+ 'x-route-path': '/customers',
11350
+ },
11309
11351
  customization_profile: {
11310
11352
  description: 'A customization profile.',
11311
11353
  properties: {
@@ -51570,10 +51612,13 @@ export default {
51570
51612
  'application/json': {
51571
51613
  schema: {
51572
51614
  properties: {
51615
+ customer_portal: {
51616
+ $ref: '#/components/schemas/customer_portal',
51617
+ },
51573
51618
  magic_link: { $ref: '#/components/schemas/magic_link' },
51574
51619
  ok: { type: 'boolean' },
51575
51620
  },
51576
- required: ['magic_link', 'ok'],
51621
+ required: ['customer_portal', 'magic_link', 'ok'],
51577
51622
  type: 'object',
51578
51623
  },
51579
51624
  },
@@ -51592,8 +51637,8 @@ export default {
51592
51637
  tags: [],
51593
51638
  'x-fern-sdk-group-name': ['customers'],
51594
51639
  'x-fern-sdk-method-name': 'create_portal',
51595
- 'x-fern-sdk-return-value': 'magic_link',
51596
- 'x-response-key': 'magic_link',
51640
+ 'x-fern-sdk-return-value': 'customer_portal',
51641
+ 'x-response-key': 'customer_portal',
51597
51642
  'x-title': 'Create Customer Portal',
51598
51643
  },
51599
51644
  },
@@ -36891,6 +36891,23 @@ export type Routes = {
36891
36891
 
36892
36892
  With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.
36893
36893
 
36894
+ Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
36895
+ customer_portal: {
36896
+ /** URL for the customer portal. */
36897
+ url: string
36898
+ /** Customer key for the customer portal. */
36899
+ customer_key: string
36900
+ /** Date and time at which the customer portal link expires. */
36901
+ expires_at: string
36902
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the customer portal. */
36903
+ workspace_id: string
36904
+ /** Date and time at which the customer portal link was created. */
36905
+ created_at: string
36906
+ }
36907
+ /** Represents a Customer Portal. Customer Portal is a hosted, customizable interface for managing device access. It enables you to embed secure, pre-authenticated access flows into your product—either by sharing a link with users or embedding a view in an iframe.
36908
+
36909
+ With Customer Portal, you no longer need to build out frontend experiences for physical access, thermostats, and sensors. Instead, you can ship enterprise-grade access control experiences in a fraction of the time, while maintaining your product's branding and user experience.
36910
+
36894
36911
  Seam hosts these flows, handling everything from account connection and device mapping to full-featured device control. */
36895
36912
  magic_link: {
36896
36913
  /** URL for the magic link. */
@@ -17,6 +17,7 @@ export {
17
17
  connect_webview,
18
18
  connected_account,
19
19
  custom_metadata,
20
+ customer_portal,
20
21
  customization_profile,
21
22
  device,
22
23
  device_provider,