@seamapi/types 1.731.0 → 1.733.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.
Files changed (30) hide show
  1. package/dist/connect.cjs +58 -0
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +195 -0
  4. package/dist/index.cjs +58 -0
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/acs/acs-entrance.d.ts +23 -0
  7. package/lib/seam/connect/models/acs/acs-entrance.js +4 -1
  8. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  9. package/lib/seam/connect/models/acs/metadata/brivo.d.ts +15 -0
  10. package/lib/seam/connect/models/acs/metadata/brivo.js +15 -0
  11. package/lib/seam/connect/models/acs/metadata/brivo.js.map +1 -0
  12. package/lib/seam/connect/models/acs/metadata/index.d.ts +1 -0
  13. package/lib/seam/connect/models/acs/metadata/index.js +1 -0
  14. package/lib/seam/connect/models/acs/metadata/index.js.map +1 -1
  15. package/lib/seam/connect/models/batch.d.ts +33 -0
  16. package/lib/seam/connect/models/customer/customer-portal.d.ts +4 -0
  17. package/lib/seam/connect/models/customer/customer-portal.js +8 -0
  18. package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
  19. package/lib/seam/connect/models/phones/phone-session.d.ts +96 -0
  20. package/lib/seam/connect/openapi.d.ts +47 -0
  21. package/lib/seam/connect/openapi.js +50 -0
  22. package/lib/seam/connect/openapi.js.map +1 -1
  23. package/lib/seam/connect/route-types.d.ts +92 -0
  24. package/package.json +1 -1
  25. package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
  26. package/src/lib/seam/connect/models/acs/metadata/brivo.ts +19 -0
  27. package/src/lib/seam/connect/models/acs/metadata/index.ts +1 -0
  28. package/src/lib/seam/connect/models/customer/customer-portal.ts +8 -0
  29. package/src/lib/seam/connect/openapi.ts +58 -0
  30. package/src/lib/seam/connect/route-types.ts +112 -0
@@ -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;
@@ -97007,6 +97103,12 @@ declare const _default: {
97007
97103
  };
97008
97104
  description: string;
97009
97105
  properties: {
97106
+ _dev: {
97107
+ default: boolean;
97108
+ description: string;
97109
+ type: string;
97110
+ 'x-undocumented': string;
97111
+ };
97010
97112
  customer_resources_filters: {
97011
97113
  description: string;
97012
97114
  items: {
@@ -98220,6 +98322,7 @@ declare const _default: {
98220
98322
  required: string[];
98221
98323
  type: string;
98222
98324
  };
98325
+ _dev?: never;
98223
98326
  customer_resources_filters?: never;
98224
98327
  customization_profile_id?: never;
98225
98328
  deep_link?: never;
@@ -139489,6 +139592,15 @@ type Routes = {
139489
139592
  /** Name of the access point in the dormakaba Ambiance access system. */
139490
139593
  access_point_name: string;
139491
139594
  } | undefined;
139595
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
139596
+ brivo_metadata?: {
139597
+ /** ID of the access point in the Brivo access system. */
139598
+ access_point_id: string;
139599
+ /** ID of the site that the access point belongs to. */
139600
+ site_id: number;
139601
+ /** Name of the site that the access point belongs to. */
139602
+ site_name: string;
139603
+ } | undefined;
139492
139604
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
139493
139605
  can_unlock_with_mobile_key?: boolean | undefined;
139494
139606
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -143554,6 +143666,15 @@ type Routes = {
143554
143666
  /** Name of the access point in the dormakaba Ambiance access system. */
143555
143667
  access_point_name: string;
143556
143668
  } | undefined;
143669
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
143670
+ brivo_metadata?: {
143671
+ /** ID of the access point in the Brivo access system. */
143672
+ access_point_id: string;
143673
+ /** ID of the site that the access point belongs to. */
143674
+ site_id: number;
143675
+ /** Name of the site that the access point belongs to. */
143676
+ site_name: string;
143677
+ } | undefined;
143557
143678
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
143558
143679
  can_unlock_with_mobile_key?: boolean | undefined;
143559
143680
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -144637,6 +144758,15 @@ type Routes = {
144637
144758
  /** Name of the access point in the dormakaba Ambiance access system. */
144638
144759
  access_point_name: string;
144639
144760
  } | undefined;
144761
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
144762
+ brivo_metadata?: {
144763
+ /** ID of the access point in the Brivo access system. */
144764
+ access_point_id: string;
144765
+ /** ID of the site that the access point belongs to. */
144766
+ site_id: number;
144767
+ /** Name of the site that the access point belongs to. */
144768
+ site_name: string;
144769
+ } | undefined;
144640
144770
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
144641
144771
  can_unlock_with_mobile_key?: boolean | undefined;
144642
144772
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -146063,6 +146193,15 @@ type Routes = {
146063
146193
  /** Name of the access point in the dormakaba Ambiance access system. */
146064
146194
  access_point_name: string;
146065
146195
  } | undefined;
146196
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
146197
+ brivo_metadata?: {
146198
+ /** ID of the access point in the Brivo access system. */
146199
+ access_point_id: string;
146200
+ /** ID of the site that the access point belongs to. */
146201
+ site_id: number;
146202
+ /** Name of the site that the access point belongs to. */
146203
+ site_name: string;
146204
+ } | undefined;
146066
146205
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
146067
146206
  can_unlock_with_mobile_key?: boolean | undefined;
146068
146207
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -149558,6 +149697,15 @@ type Routes = {
149558
149697
  /** Name of the access point in the dormakaba Ambiance access system. */
149559
149698
  access_point_name: string;
149560
149699
  } | undefined;
149700
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
149701
+ brivo_metadata?: {
149702
+ /** ID of the access point in the Brivo access system. */
149703
+ access_point_id: string;
149704
+ /** ID of the site that the access point belongs to. */
149705
+ site_id: number;
149706
+ /** Name of the site that the access point belongs to. */
149707
+ site_name: string;
149708
+ } | undefined;
149561
149709
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
149562
149710
  can_unlock_with_mobile_key?: boolean | undefined;
149563
149711
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -149728,6 +149876,15 @@ type Routes = {
149728
149876
  /** Name of the access point in the dormakaba Ambiance access system. */
149729
149877
  access_point_name: string;
149730
149878
  } | undefined;
149879
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
149880
+ brivo_metadata?: {
149881
+ /** ID of the access point in the Brivo access system. */
149882
+ access_point_id: string;
149883
+ /** ID of the site that the access point belongs to. */
149884
+ site_id: number;
149885
+ /** Name of the site that the access point belongs to. */
149886
+ site_name: string;
149887
+ } | undefined;
149731
149888
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
149732
149889
  can_unlock_with_mobile_key?: boolean | undefined;
149733
149890
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -151266,6 +151423,15 @@ type Routes = {
151266
151423
  /** Name of the access point in the dormakaba Ambiance access system. */
151267
151424
  access_point_name: string;
151268
151425
  } | undefined;
151426
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
151427
+ brivo_metadata?: {
151428
+ /** ID of the access point in the Brivo access system. */
151429
+ access_point_id: string;
151430
+ /** ID of the site that the access point belongs to. */
151431
+ site_id: number;
151432
+ /** Name of the site that the access point belongs to. */
151433
+ site_name: string;
151434
+ } | undefined;
151269
151435
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
151270
151436
  can_unlock_with_mobile_key?: boolean | undefined;
151271
151437
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -155688,6 +155854,8 @@ type Routes = {
155688
155854
  resource_type: 'reservation' | 'space';
155689
155855
  resource_key: string;
155690
155856
  } | undefined;
155857
+ /** Whether the portal is in developer mode. Only available for Seam employees. */
155858
+ _dev?: boolean;
155691
155859
  } & {
155692
155860
  customer_data?: {
155693
155861
  /** Your unique identifier for the customer. */
@@ -189447,6 +189615,15 @@ type Routes = {
189447
189615
  /** Name of the access point in the dormakaba Ambiance access system. */
189448
189616
  access_point_name: string;
189449
189617
  } | undefined;
189618
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
189619
+ brivo_metadata?: {
189620
+ /** ID of the access point in the Brivo access system. */
189621
+ access_point_id: string;
189622
+ /** ID of the site that the access point belongs to. */
189623
+ site_id: number;
189624
+ /** Name of the site that the access point belongs to. */
189625
+ site_name: string;
189626
+ } | undefined;
189450
189627
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
189451
189628
  can_unlock_with_mobile_key?: boolean | undefined;
189452
189629
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -191140,6 +191317,15 @@ type Routes = {
191140
191317
  /** Name of the access point in the dormakaba Ambiance access system. */
191141
191318
  access_point_name: string;
191142
191319
  } | undefined;
191320
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
191321
+ brivo_metadata?: {
191322
+ /** ID of the access point in the Brivo access system. */
191323
+ access_point_id: string;
191324
+ /** ID of the site that the access point belongs to. */
191325
+ site_id: number;
191326
+ /** Name of the site that the access point belongs to. */
191327
+ site_name: string;
191328
+ } | undefined;
191143
191329
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
191144
191330
  can_unlock_with_mobile_key?: boolean | undefined;
191145
191331
  /** Indicates whether the ACS entrance can be unlocked with card credentials. */
@@ -213134,6 +213320,15 @@ type Routes = {
213134
213320
  /** Name of the access point in the dormakaba Ambiance access system. */
213135
213321
  access_point_name: string;
213136
213322
  } | undefined;
213323
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
213324
+ brivo_metadata?: {
213325
+ /** ID of the access point in the Brivo access system. */
213326
+ access_point_id: string;
213327
+ /** ID of the site that the access point belongs to. */
213328
+ site_id: number;
213329
+ /** Name of the site that the access point belongs to. */
213330
+ site_name: string;
213331
+ } | undefined;
213137
213332
  /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
213138
213333
  can_unlock_with_mobile_key?: boolean | undefined;
213139
213334
  /** 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"
@@ -49921,6 +49973,12 @@ var openapi_default = {
49921
49973
  },
49922
49974
  description: "Configuration for a customer portal",
49923
49975
  properties: {
49976
+ _dev: {
49977
+ default: false,
49978
+ description: "Whether the portal is in developer mode. Only available for Seam employees.",
49979
+ type: "boolean",
49980
+ "x-undocumented": "Internal developer mode flag."
49981
+ },
49924
49982
  customer_resources_filters: {
49925
49983
  description: "Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata.",
49926
49984
  items: {