@seamapi/types 1.731.0 → 1.732.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.
@@ -5281,6 +5281,19 @@ declare const acs_entrance: z.ZodObject<{
5281
5281
  }, {
5282
5282
  access_point_name: string;
5283
5283
  }>>;
5284
+ brivo_metadata: z.ZodOptional<z.ZodObject<{
5285
+ access_point_id: z.ZodString;
5286
+ site_id: z.ZodNumber;
5287
+ site_name: z.ZodString;
5288
+ }, "strip", z.ZodTypeAny, {
5289
+ site_id: number;
5290
+ site_name: string;
5291
+ access_point_id: string;
5292
+ }, {
5293
+ site_id: number;
5294
+ site_name: string;
5295
+ access_point_id: string;
5296
+ }>>;
5284
5297
  } & {
5285
5298
  can_unlock_with_mobile_key: z.ZodOptional<z.ZodBoolean>;
5286
5299
  can_unlock_with_card: z.ZodOptional<z.ZodBoolean>;
@@ -5307,6 +5320,11 @@ declare const acs_entrance: z.ZodObject<{
5307
5320
  intrusion_alarm?: boolean | undefined;
5308
5321
  privacy_mode?: boolean | undefined;
5309
5322
  } | undefined;
5323
+ brivo_metadata?: {
5324
+ site_id: number;
5325
+ site_name: string;
5326
+ access_point_id: string;
5327
+ } | undefined;
5310
5328
  visionline_metadata?: {
5311
5329
  door_name: string;
5312
5330
  door_category: "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)";
@@ -5372,6 +5390,11 @@ declare const acs_entrance: z.ZodObject<{
5372
5390
  intrusion_alarm?: boolean | undefined;
5373
5391
  privacy_mode?: boolean | undefined;
5374
5392
  } | undefined;
5393
+ brivo_metadata?: {
5394
+ site_id: number;
5395
+ site_name: string;
5396
+ access_point_id: string;
5397
+ } | undefined;
5375
5398
  visionline_metadata?: {
5376
5399
  door_name: string;
5377
5400
  door_category: "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)";
@@ -16137,6 +16160,19 @@ declare const batch: z.ZodObject<{
16137
16160
  }, {
16138
16161
  access_point_name: string;
16139
16162
  }>>;
16163
+ brivo_metadata: z.ZodOptional<z.ZodObject<{
16164
+ access_point_id: z.ZodString;
16165
+ site_id: z.ZodNumber;
16166
+ site_name: z.ZodString;
16167
+ }, "strip", z.ZodTypeAny, {
16168
+ site_id: number;
16169
+ site_name: string;
16170
+ access_point_id: string;
16171
+ }, {
16172
+ site_id: number;
16173
+ site_name: string;
16174
+ access_point_id: string;
16175
+ }>>;
16140
16176
  } & {
16141
16177
  can_unlock_with_mobile_key: z.ZodOptional<z.ZodBoolean>;
16142
16178
  can_unlock_with_card: z.ZodOptional<z.ZodBoolean>;
@@ -16163,6 +16199,11 @@ declare const batch: z.ZodObject<{
16163
16199
  intrusion_alarm?: boolean | undefined;
16164
16200
  privacy_mode?: boolean | undefined;
16165
16201
  } | undefined;
16202
+ brivo_metadata?: {
16203
+ site_id: number;
16204
+ site_name: string;
16205
+ access_point_id: string;
16206
+ } | undefined;
16166
16207
  visionline_metadata?: {
16167
16208
  door_name: string;
16168
16209
  door_category: "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)";
@@ -16228,6 +16269,11 @@ declare const batch: z.ZodObject<{
16228
16269
  intrusion_alarm?: boolean | undefined;
16229
16270
  privacy_mode?: boolean | undefined;
16230
16271
  } | undefined;
16272
+ brivo_metadata?: {
16273
+ site_id: number;
16274
+ site_name: string;
16275
+ access_point_id: string;
16276
+ } | undefined;
16231
16277
  visionline_metadata?: {
16232
16278
  door_name: string;
16233
16279
  door_category: "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)";
@@ -35979,6 +36025,11 @@ declare const batch: z.ZodObject<{
35979
36025
  intrusion_alarm?: boolean | undefined;
35980
36026
  privacy_mode?: boolean | undefined;
35981
36027
  } | undefined;
36028
+ brivo_metadata?: {
36029
+ site_id: number;
36030
+ site_name: string;
36031
+ access_point_id: string;
36032
+ } | undefined;
35982
36033
  visionline_metadata?: {
35983
36034
  door_name: string;
35984
36035
  door_category: "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)";
@@ -40605,6 +40656,11 @@ declare const batch: z.ZodObject<{
40605
40656
  intrusion_alarm?: boolean | undefined;
40606
40657
  privacy_mode?: boolean | undefined;
40607
40658
  } | undefined;
40659
+ brivo_metadata?: {
40660
+ site_id: number;
40661
+ site_name: string;
40662
+ access_point_id: string;
40663
+ } | undefined;
40608
40664
  visionline_metadata?: {
40609
40665
  door_name: string;
40610
40666
  door_category: "entrance" | "guest" | "elevator reader" | "common" | "common (PMS)";
@@ -61094,6 +61150,26 @@ declare const _default: {
61094
61150
  required: string[];
61095
61151
  type: string;
61096
61152
  };
61153
+ brivo_metadata: {
61154
+ description: string;
61155
+ properties: {
61156
+ access_point_id: {
61157
+ description: string;
61158
+ type: string;
61159
+ };
61160
+ site_id: {
61161
+ description: string;
61162
+ format: string;
61163
+ type: string;
61164
+ };
61165
+ site_name: {
61166
+ description: string;
61167
+ type: string;
61168
+ };
61169
+ };
61170
+ required: string[];
61171
+ type: string;
61172
+ };
61097
61173
  can_belong_to_reservation: {
61098
61174
  description: string;
61099
61175
  type: string;
@@ -74177,6 +74253,26 @@ declare const _default: {
74177
74253
  required: string[];
74178
74254
  type: string;
74179
74255
  };
74256
+ brivo_metadata: {
74257
+ description: string;
74258
+ properties: {
74259
+ access_point_id: {
74260
+ description: string;
74261
+ type: string;
74262
+ };
74263
+ site_id: {
74264
+ description: string;
74265
+ format: string;
74266
+ type: string;
74267
+ };
74268
+ site_name: {
74269
+ description: string;
74270
+ type: string;
74271
+ };
74272
+ };
74273
+ required: string[];
74274
+ type: string;
74275
+ };
74180
74276
  can_belong_to_reservation: {
74181
74277
  description: string;
74182
74278
  type: string;
@@ -139489,6 +139585,15 @@ type Routes = {
139489
139585
  /** Name of the access point in the dormakaba Ambiance access system. */
139490
139586
  access_point_name: string;
139491
139587
  } | undefined;
139588
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
139589
+ brivo_metadata?: {
139590
+ /** ID of the access point in the Brivo access system. */
139591
+ access_point_id: string;
139592
+ /** ID of the site that the access point belongs to. */
139593
+ site_id: number;
139594
+ /** Name of the site that the access point belongs to. */
139595
+ site_name: string;
139596
+ } | undefined;
139492
139597
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
139493
139598
  can_unlock_with_mobile_key?: boolean | undefined;
139494
139599
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -143554,6 +143659,15 @@ type Routes = {
143554
143659
  /** Name of the access point in the dormakaba Ambiance access system. */
143555
143660
  access_point_name: string;
143556
143661
  } | undefined;
143662
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
143663
+ brivo_metadata?: {
143664
+ /** ID of the access point in the Brivo access system. */
143665
+ access_point_id: string;
143666
+ /** ID of the site that the access point belongs to. */
143667
+ site_id: number;
143668
+ /** Name of the site that the access point belongs to. */
143669
+ site_name: string;
143670
+ } | undefined;
143557
143671
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
143558
143672
  can_unlock_with_mobile_key?: boolean | undefined;
143559
143673
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -144637,6 +144751,15 @@ type Routes = {
144637
144751
  /** Name of the access point in the dormakaba Ambiance access system. */
144638
144752
  access_point_name: string;
144639
144753
  } | undefined;
144754
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
144755
+ brivo_metadata?: {
144756
+ /** ID of the access point in the Brivo access system. */
144757
+ access_point_id: string;
144758
+ /** ID of the site that the access point belongs to. */
144759
+ site_id: number;
144760
+ /** Name of the site that the access point belongs to. */
144761
+ site_name: string;
144762
+ } | undefined;
144640
144763
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
144641
144764
  can_unlock_with_mobile_key?: boolean | undefined;
144642
144765
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -146063,6 +146186,15 @@ type Routes = {
146063
146186
  /** Name of the access point in the dormakaba Ambiance access system. */
146064
146187
  access_point_name: string;
146065
146188
  } | undefined;
146189
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
146190
+ brivo_metadata?: {
146191
+ /** ID of the access point in the Brivo access system. */
146192
+ access_point_id: string;
146193
+ /** ID of the site that the access point belongs to. */
146194
+ site_id: number;
146195
+ /** Name of the site that the access point belongs to. */
146196
+ site_name: string;
146197
+ } | undefined;
146066
146198
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
146067
146199
  can_unlock_with_mobile_key?: boolean | undefined;
146068
146200
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -149558,6 +149690,15 @@ type Routes = {
149558
149690
  /** Name of the access point in the dormakaba Ambiance access system. */
149559
149691
  access_point_name: string;
149560
149692
  } | undefined;
149693
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
149694
+ brivo_metadata?: {
149695
+ /** ID of the access point in the Brivo access system. */
149696
+ access_point_id: string;
149697
+ /** ID of the site that the access point belongs to. */
149698
+ site_id: number;
149699
+ /** Name of the site that the access point belongs to. */
149700
+ site_name: string;
149701
+ } | undefined;
149561
149702
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
149562
149703
  can_unlock_with_mobile_key?: boolean | undefined;
149563
149704
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -149728,6 +149869,15 @@ type Routes = {
149728
149869
  /** Name of the access point in the dormakaba Ambiance access system. */
149729
149870
  access_point_name: string;
149730
149871
  } | undefined;
149872
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
149873
+ brivo_metadata?: {
149874
+ /** ID of the access point in the Brivo access system. */
149875
+ access_point_id: string;
149876
+ /** ID of the site that the access point belongs to. */
149877
+ site_id: number;
149878
+ /** Name of the site that the access point belongs to. */
149879
+ site_name: string;
149880
+ } | undefined;
149731
149881
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
149732
149882
  can_unlock_with_mobile_key?: boolean | undefined;
149733
149883
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -151266,6 +151416,15 @@ type Routes = {
151266
151416
  /** Name of the access point in the dormakaba Ambiance access system. */
151267
151417
  access_point_name: string;
151268
151418
  } | undefined;
151419
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
151420
+ brivo_metadata?: {
151421
+ /** ID of the access point in the Brivo access system. */
151422
+ access_point_id: string;
151423
+ /** ID of the site that the access point belongs to. */
151424
+ site_id: number;
151425
+ /** Name of the site that the access point belongs to. */
151426
+ site_name: string;
151427
+ } | undefined;
151269
151428
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
151270
151429
  can_unlock_with_mobile_key?: boolean | undefined;
151271
151430
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -189447,6 +189606,15 @@ type Routes = {
189447
189606
  /** Name of the access point in the dormakaba Ambiance access system. */
189448
189607
  access_point_name: string;
189449
189608
  } | undefined;
189609
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
189610
+ brivo_metadata?: {
189611
+ /** ID of the access point in the Brivo access system. */
189612
+ access_point_id: string;
189613
+ /** ID of the site that the access point belongs to. */
189614
+ site_id: number;
189615
+ /** Name of the site that the access point belongs to. */
189616
+ site_name: string;
189617
+ } | undefined;
189450
189618
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
189451
189619
  can_unlock_with_mobile_key?: boolean | undefined;
189452
189620
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -191140,6 +191308,15 @@ type Routes = {
191140
191308
  /** Name of the access point in the dormakaba Ambiance access system. */
191141
191309
  access_point_name: string;
191142
191310
  } | undefined;
191311
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
191312
+ brivo_metadata?: {
191313
+ /** ID of the access point in the Brivo access system. */
191314
+ access_point_id: string;
191315
+ /** ID of the site that the access point belongs to. */
191316
+ site_id: number;
191317
+ /** Name of the site that the access point belongs to. */
191318
+ site_name: string;
191319
+ } | undefined;
191143
191320
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
191144
191321
  can_unlock_with_mobile_key?: boolean | undefined;
191145
191322
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -213134,6 +213311,15 @@ type Routes = {
213134
213311
  /** Name of the access point in the dormakaba Ambiance access system. */
213135
213312
  access_point_name: string;
213136
213313
  } | undefined;
213314
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
213315
+ brivo_metadata?: {
213316
+ /** ID of the access point in the Brivo access system. */
213317
+ access_point_id: string;
213318
+ /** ID of the site that the access point belongs to. */
213319
+ site_id: number;
213320
+ /** Name of the site that the access point belongs to. */
213321
+ site_name: string;
213322
+ } | undefined;
213137
213323
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
213138
213324
  can_unlock_with_mobile_key?: boolean | undefined;
213139
213325
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
package/dist/index.cjs CHANGED
@@ -2937,6 +2937,11 @@ var acs_credential_vostio_metadata = zod.z.object({
2937
2937
  }).describe(
2938
2938
  "ASSA ABLOY Vostio-specific metadata associated with the credential."
2939
2939
  );
2940
+ var acs_entrance_brivo_metadata = zod.z.object({
2941
+ access_point_id: zod.z.string().describe("ID of the access point in the Brivo access system."),
2942
+ site_id: zod.z.number().describe("ID of the site that the access point belongs to."),
2943
+ site_name: zod.z.string().describe("Name of the site that the access point belongs to.")
2944
+ }).describe("Brivo-specific metadata associated with the entrance.");
2940
2945
  var acs_entrance_dormakaba_ambiance_metadata = zod.z.object({
2941
2946
  access_point_name: zod.z.string().describe(
2942
2947
  "Name of the access point in the dormakaba Ambiance access system."
@@ -3379,6 +3384,9 @@ var acs_entrance = zod.z.object({
3379
3384
  ),
3380
3385
  dormakaba_ambiance_metadata: acs_entrance_dormakaba_ambiance_metadata.optional().describe(
3381
3386
  "dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
3387
+ ),
3388
+ brivo_metadata: acs_entrance_brivo_metadata.optional().describe(
3389
+ "Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details)."
3382
3390
  )
3383
3391
  }).merge(acs_entrance_capability_flags).describe(`
3384
3392
  ---
@@ -9387,6 +9395,26 @@ var openapi_default = {
9387
9395
  required: ["door_type", "door_name"],
9388
9396
  type: "object"
9389
9397
  },
9398
+ brivo_metadata: {
9399
+ description: "Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
9400
+ properties: {
9401
+ access_point_id: {
9402
+ description: "ID of the access point in the Brivo access system.",
9403
+ type: "string"
9404
+ },
9405
+ site_id: {
9406
+ description: "ID of the site that the access point belongs to.",
9407
+ format: "float",
9408
+ type: "number"
9409
+ },
9410
+ site_name: {
9411
+ description: "Name of the site that the access point belongs to.",
9412
+ type: "string"
9413
+ }
9414
+ },
9415
+ required: ["access_point_id", "site_id", "site_name"],
9416
+ type: "object"
9417
+ },
9390
9418
  can_belong_to_reservation: {
9391
9419
  description: "Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.",
9392
9420
  type: "boolean"
@@ -27407,6 +27435,30 @@ var openapi_default = {
27407
27435
  required: ["door_type", "door_name"],
27408
27436
  type: "object"
27409
27437
  },
27438
+ brivo_metadata: {
27439
+ description: "Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).",
27440
+ properties: {
27441
+ access_point_id: {
27442
+ description: "ID of the access point in the Brivo access system.",
27443
+ type: "string"
27444
+ },
27445
+ site_id: {
27446
+ description: "ID of the site that the access point belongs to.",
27447
+ format: "float",
27448
+ type: "number"
27449
+ },
27450
+ site_name: {
27451
+ description: "Name of the site that the access point belongs to.",
27452
+ type: "string"
27453
+ }
27454
+ },
27455
+ required: [
27456
+ "access_point_id",
27457
+ "site_id",
27458
+ "site_name"
27459
+ ],
27460
+ type: "object"
27461
+ },
27410
27462
  can_belong_to_reservation: {
27411
27463
  description: "Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key.",
27412
27464
  type: "boolean"