@seamapi/types 1.967.0 → 1.968.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.
@@ -6646,6 +6646,13 @@ declare const acs_user: z.ZodObject<{
6646
6646
  user_id?: string | undefined;
6647
6647
  audit_openings?: boolean | undefined;
6648
6648
  }>>;
6649
+ salto_ks_metadata: z.ZodOptional<z.ZodObject<{
6650
+ is_subscribed: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
6651
+ }, "strip", z.ZodTypeAny, {
6652
+ is_subscribed?: boolean | undefined;
6653
+ }, {
6654
+ is_subscribed?: boolean | undefined;
6655
+ }>>;
6649
6656
  } & {
6650
6657
  full_name: z.ZodOptional<z.ZodString>;
6651
6658
  email: z.ZodOptional<z.ZodString>;
@@ -6704,6 +6711,9 @@ declare const acs_user: z.ZodObject<{
6704
6711
  acs_user_id: string;
6705
6712
  acs_system_id: string;
6706
6713
  last_successful_sync_at: string | null;
6714
+ salto_ks_metadata?: {
6715
+ is_subscribed?: boolean | undefined;
6716
+ } | undefined;
6707
6717
  email?: string | undefined;
6708
6718
  pending_mutations?: ({
6709
6719
  message: string;
@@ -6851,6 +6861,9 @@ declare const acs_user: z.ZodObject<{
6851
6861
  acs_user_id: string;
6852
6862
  acs_system_id: string;
6853
6863
  last_successful_sync_at: string | null;
6864
+ salto_ks_metadata?: {
6865
+ is_subscribed?: boolean | undefined;
6866
+ } | undefined;
6854
6867
  email?: string | undefined;
6855
6868
  pending_mutations?: ({
6856
6869
  message: string;
@@ -7403,6 +7416,13 @@ declare const unmanaged_acs_user: z.ZodObject<{
7403
7416
  user_id?: string | undefined;
7404
7417
  audit_openings?: boolean | undefined;
7405
7418
  }>>;
7419
+ salto_ks_metadata: z.ZodOptional<z.ZodObject<{
7420
+ is_subscribed: z.ZodOptional<z.ZodOptional<z.ZodBoolean>>;
7421
+ }, "strip", z.ZodTypeAny, {
7422
+ is_subscribed?: boolean | undefined;
7423
+ }, {
7424
+ is_subscribed?: boolean | undefined;
7425
+ }>>;
7406
7426
  } & {
7407
7427
  full_name: z.ZodOptional<z.ZodString>;
7408
7428
  email: z.ZodOptional<z.ZodString>;
@@ -7461,6 +7481,9 @@ declare const unmanaged_acs_user: z.ZodObject<{
7461
7481
  acs_user_id: string;
7462
7482
  acs_system_id: string;
7463
7483
  last_successful_sync_at: string | null;
7484
+ salto_ks_metadata?: {
7485
+ is_subscribed?: boolean | undefined;
7486
+ } | undefined;
7464
7487
  email?: string | undefined;
7465
7488
  pending_mutations?: ({
7466
7489
  message: string;
@@ -7608,6 +7631,9 @@ declare const unmanaged_acs_user: z.ZodObject<{
7608
7631
  acs_user_id: string;
7609
7632
  acs_system_id: string;
7610
7633
  last_successful_sync_at: string | null;
7634
+ salto_ks_metadata?: {
7635
+ is_subscribed?: boolean | undefined;
7636
+ } | undefined;
7611
7637
  email?: string | undefined;
7612
7638
  pending_mutations?: ({
7613
7639
  message: string;
@@ -53610,6 +53636,11 @@ type Routes = {
53610
53636
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
53611
53637
  audit_openings?: (boolean | undefined) | undefined;
53612
53638
  } | undefined;
53639
+ /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
53640
+ salto_ks_metadata?: {
53641
+ /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
53642
+ is_subscribed?: (boolean | undefined) | undefined;
53643
+ } | undefined;
53613
53644
  /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
53614
53645
  full_name?: string | undefined;
53615
53646
  /**
@@ -64204,6 +64235,11 @@ type Routes = {
64204
64235
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
64205
64236
  audit_openings?: (boolean | undefined) | undefined;
64206
64237
  } | undefined;
64238
+ /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
64239
+ salto_ks_metadata?: {
64240
+ /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
64241
+ is_subscribed?: (boolean | undefined) | undefined;
64242
+ } | undefined;
64207
64243
  /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
64208
64244
  full_name?: string | undefined;
64209
64245
  /**
@@ -64498,6 +64534,11 @@ type Routes = {
64498
64534
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
64499
64535
  audit_openings?: (boolean | undefined) | undefined;
64500
64536
  } | undefined;
64537
+ /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
64538
+ salto_ks_metadata?: {
64539
+ /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
64540
+ is_subscribed?: (boolean | undefined) | undefined;
64541
+ } | undefined;
64501
64542
  /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
64502
64543
  full_name?: string | undefined;
64503
64544
  /**
@@ -64780,6 +64821,11 @@ type Routes = {
64780
64821
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
64781
64822
  audit_openings?: (boolean | undefined) | undefined;
64782
64823
  } | undefined;
64824
+ /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
64825
+ salto_ks_metadata?: {
64826
+ /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
64827
+ is_subscribed?: (boolean | undefined) | undefined;
64828
+ } | undefined;
64783
64829
  /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
64784
64830
  full_name?: string | undefined;
64785
64831
  /**
@@ -65316,6 +65362,11 @@ type Routes = {
65316
65362
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
65317
65363
  audit_openings?: (boolean | undefined) | undefined;
65318
65364
  } | undefined;
65365
+ /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
65366
+ salto_ks_metadata?: {
65367
+ /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
65368
+ is_subscribed?: (boolean | undefined) | undefined;
65369
+ } | undefined;
65319
65370
  /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
65320
65371
  full_name?: string | undefined;
65321
65372
  /**
@@ -65593,6 +65644,11 @@ type Routes = {
65593
65644
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
65594
65645
  audit_openings?: (boolean | undefined) | undefined;
65595
65646
  } | undefined;
65647
+ /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
65648
+ salto_ks_metadata?: {
65649
+ /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
65650
+ is_subscribed?: (boolean | undefined) | undefined;
65651
+ } | undefined;
65596
65652
  /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
65597
65653
  full_name?: string | undefined;
65598
65654
  /**
@@ -141298,6 +141354,11 @@ type Routes = {
141298
141354
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
141299
141355
  audit_openings?: (boolean | undefined) | undefined;
141300
141356
  } | undefined;
141357
+ /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
141358
+ salto_ks_metadata?: {
141359
+ /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
141360
+ is_subscribed?: (boolean | undefined) | undefined;
141361
+ } | undefined;
141301
141362
  /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
141302
141363
  full_name?: string | undefined;
141303
141364
  /**
@@ -143971,6 +144032,11 @@ type Routes = {
143971
144032
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
143972
144033
  audit_openings?: (boolean | undefined) | undefined;
143973
144034
  } | undefined;
144035
+ /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
144036
+ salto_ks_metadata?: {
144037
+ /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
144038
+ is_subscribed?: (boolean | undefined) | undefined;
144039
+ } | undefined;
143974
144040
  /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
143975
144041
  full_name?: string | undefined;
143976
144042
  /**
@@ -146128,6 +146194,11 @@ type Routes = {
146128
146194
  /** Indicates whether AuditOpenings is enabled for the user in the Salto Space access system. */
146129
146195
  audit_openings?: (boolean | undefined) | undefined;
146130
146196
  } | undefined;
146197
+ /** Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
146198
+ salto_ks_metadata?: {
146199
+ /** Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked. */
146200
+ is_subscribed?: (boolean | undefined) | undefined;
146201
+ } | undefined;
146131
146202
  /** Full name of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management). */
146132
146203
  full_name?: string | undefined;
146133
146204
  /**
package/dist/index.cjs CHANGED
@@ -3619,6 +3619,13 @@ var acs_entrance_salto_ks_metadata = zod.z.object({
3619
3619
  intrusion_alarm: zod.z.boolean().optional().describe("Indicates whether an intrusion alarm is active on the door."),
3620
3620
  privacy_mode: zod.z.boolean().optional().describe("Indicates whether privacy mode is enabled for the lock.")
3621
3621
  }).partial().describe("Salto KS-specific metadata associated with the entrance.");
3622
+ var acs_user_salto_ks_metadata = zod.z.object({
3623
+ is_subscribed: zod.z.boolean().optional().describe(
3624
+ "Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked."
3625
+ )
3626
+ }).partial().describe(
3627
+ "Salto KS-specific metadata associated with the access system user."
3628
+ );
3622
3629
  var acs_entrance_salto_space_metadata = zod.z.object({
3623
3630
  door_id: zod.z.string().optional().describe("Door ID in the Salto Space access system."),
3624
3631
  door_name: zod.z.string().optional().describe("Name of the door in the Salto Space access system."),
@@ -4741,6 +4748,9 @@ var common_acs_user = zod.z.object({
4741
4748
  `),
4742
4749
  salto_space_metadata: acs_user_salto_space_metadata.optional().describe(
4743
4750
  "Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management)."
4751
+ ),
4752
+ salto_ks_metadata: acs_user_salto_ks_metadata.optional().describe(
4753
+ "Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management)."
4744
4754
  )
4745
4755
  }).merge(user_fields);
4746
4756
  var acs_user = common_acs_user.merge(
@@ -12515,6 +12525,16 @@ var openapi = {
12515
12525
  description: "Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
12516
12526
  type: "string"
12517
12527
  },
12528
+ salto_ks_metadata: {
12529
+ description: "Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
12530
+ properties: {
12531
+ is_subscribed: {
12532
+ description: "Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked.",
12533
+ type: "boolean"
12534
+ }
12535
+ },
12536
+ type: "object"
12537
+ },
12518
12538
  salto_space_metadata: {
12519
12539
  description: "Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
12520
12540
  properties: {
@@ -36535,6 +36555,16 @@ var openapi = {
36535
36555
  description: "Phone number of the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).",
36536
36556
  type: "string"
36537
36557
  },
36558
+ salto_ks_metadata: {
36559
+ description: "Salto KS-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
36560
+ properties: {
36561
+ is_subscribed: {
36562
+ description: "Indicates whether the user holds an active subscription slot on the Salto KS site. Only subscribed users can unlock doors and count against the site's user-subscription limit. A user may not be subscribed because their access schedule has not started or has ended, the site has reached its subscription limit, or they were manually unsubscribed. This is distinct from `is_suspended`, which reflects whether the user has been explicitly blocked.",
36563
+ type: "boolean"
36564
+ }
36565
+ },
36566
+ type: "object"
36567
+ },
36538
36568
  salto_space_metadata: {
36539
36569
  description: "Salto Space-specific metadata associated with the [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management).",
36540
36570
  properties: {