@seamapi/types 1.846.0 → 1.848.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.
@@ -7063,6 +7063,10 @@ export type Routes = {
7063
7063
  ends_at?: (string | null) | undefined;
7064
7064
  /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device. */
7065
7065
  status: 'set' | 'unset';
7066
+ /** Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations. */
7067
+ cannot_be_managed?: true | undefined;
7068
+ /** Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app. */
7069
+ cannot_delete_unmanaged_access_code?: true | undefined;
7066
7070
  /** Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices. */
7067
7071
  dormakaba_oracode_metadata?: ({
7068
7072
  /** Dormakaba Oracode stay ID associated with this access code. */
@@ -8957,6 +8961,10 @@ export type Routes = {
8957
8961
  ends_at?: (string | null) | undefined;
8958
8962
  /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device. */
8959
8963
  status: 'set' | 'unset';
8964
+ /** Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations. */
8965
+ cannot_be_managed?: true | undefined;
8966
+ /** Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app. */
8967
+ cannot_delete_unmanaged_access_code?: true | undefined;
8960
8968
  /** Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices. */
8961
8969
  dormakaba_oracode_metadata?: ({
8962
8970
  /** Dormakaba Oracode stay ID associated with this access code. */
@@ -9481,6 +9489,10 @@ export type Routes = {
9481
9489
  ends_at?: (string | null) | undefined;
9482
9490
  /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device. */
9483
9491
  status: 'set' | 'unset';
9492
+ /** Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations. */
9493
+ cannot_be_managed?: true | undefined;
9494
+ /** Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app. */
9495
+ cannot_delete_unmanaged_access_code?: true | undefined;
9484
9496
  /** Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices. */
9485
9497
  dormakaba_oracode_metadata?: ({
9486
9498
  /** Dormakaba Oracode stay ID associated with this access code. */
@@ -12802,14 +12814,21 @@ export type Routes = {
12802
12814
  message: string;
12803
12815
  }[];
12804
12816
  /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
12805
- warnings: {
12817
+ warnings: ({
12806
12818
  /** Date and time at which Seam created the warning. */
12807
12819
  created_at: string;
12808
12820
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
12809
12821
  message: string;
12810
12822
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
12811
12823
  warning_code: 'salto_ks_entrance_access_code_support_removed';
12812
- }[];
12824
+ } | {
12825
+ /** Date and time at which Seam created the warning. */
12826
+ created_at: string;
12827
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
12828
+ message: string;
12829
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
12830
+ warning_code: 'entrance_shares_zone';
12831
+ })[];
12813
12832
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
12814
12833
  latch_metadata?: {
12815
12834
  /** Accessibility type in the Latch access system. */
@@ -13267,13 +13286,13 @@ export type Routes = {
13267
13286
  name: string;
13268
13287
  /**
13269
13288
  * @deprecated Use `external_type`.*/
13270
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
13289
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
13271
13290
  /**
13272
13291
  * @deprecated Use `external_type_display_name`.*/
13273
13292
  access_group_type_display_name: string;
13274
13293
  display_name: string;
13275
13294
  /** Brand-specific terminology for the access group type. */
13276
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
13295
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
13277
13296
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
13278
13297
  external_type_display_name: string;
13279
13298
  /** Date and time at which the access group was created. */
@@ -17274,14 +17293,21 @@ export type Routes = {
17274
17293
  message: string;
17275
17294
  }[];
17276
17295
  /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
17277
- warnings: {
17296
+ warnings: ({
17278
17297
  /** Date and time at which Seam created the warning. */
17279
17298
  created_at: string;
17280
17299
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17281
17300
  message: string;
17282
17301
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17283
17302
  warning_code: 'salto_ks_entrance_access_code_support_removed';
17284
- }[];
17303
+ } | {
17304
+ /** Date and time at which Seam created the warning. */
17305
+ created_at: string;
17306
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
17307
+ message: string;
17308
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
17309
+ warning_code: 'entrance_shares_zone';
17310
+ })[];
17285
17311
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
17286
17312
  latch_metadata?: {
17287
17313
  /** Accessibility type in the Latch access system. */
@@ -18324,13 +18350,13 @@ export type Routes = {
18324
18350
  name: string;
18325
18351
  /**
18326
18352
  * @deprecated Use `external_type`.*/
18327
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
18353
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
18328
18354
  /**
18329
18355
  * @deprecated Use `external_type_display_name`.*/
18330
18356
  access_group_type_display_name: string;
18331
18357
  display_name: string;
18332
18358
  /** Brand-specific terminology for the access group type. */
18333
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
18359
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
18334
18360
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
18335
18361
  external_type_display_name: string;
18336
18362
  /** Date and time at which the access group was created. */
@@ -18508,13 +18534,13 @@ export type Routes = {
18508
18534
  name: string;
18509
18535
  /**
18510
18536
  * @deprecated Use `external_type`.*/
18511
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
18537
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
18512
18538
  /**
18513
18539
  * @deprecated Use `external_type_display_name`.*/
18514
18540
  access_group_type_display_name: string;
18515
18541
  display_name: string;
18516
18542
  /** Brand-specific terminology for the access group type. */
18517
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
18543
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
18518
18544
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
18519
18545
  external_type_display_name: string;
18520
18546
  /** Date and time at which the access group was created. */
@@ -18694,14 +18720,21 @@ export type Routes = {
18694
18720
  message: string;
18695
18721
  }[];
18696
18722
  /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
18697
- warnings: {
18723
+ warnings: ({
18698
18724
  /** Date and time at which Seam created the warning. */
18699
18725
  created_at: string;
18700
18726
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
18701
18727
  message: string;
18702
18728
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
18703
18729
  warning_code: 'salto_ks_entrance_access_code_support_removed';
18704
- }[];
18730
+ } | {
18731
+ /** Date and time at which Seam created the warning. */
18732
+ created_at: string;
18733
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
18734
+ message: string;
18735
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
18736
+ warning_code: 'entrance_shares_zone';
18737
+ })[];
18705
18738
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
18706
18739
  latch_metadata?: {
18707
18740
  /** Accessibility type in the Latch access system. */
@@ -19141,13 +19174,13 @@ export type Routes = {
19141
19174
  name: string;
19142
19175
  /**
19143
19176
  * @deprecated Use `external_type`.*/
19144
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
19177
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
19145
19178
  /**
19146
19179
  * @deprecated Use `external_type_display_name`.*/
19147
19180
  access_group_type_display_name: string;
19148
19181
  display_name: string;
19149
19182
  /** Brand-specific terminology for the access group type. */
19150
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
19183
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
19151
19184
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
19152
19185
  external_type_display_name: string;
19153
19186
  /** Date and time at which the access group was created. */
@@ -19323,13 +19356,13 @@ export type Routes = {
19323
19356
  name: string;
19324
19357
  /**
19325
19358
  * @deprecated Use `external_type`.*/
19326
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
19359
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
19327
19360
  /**
19328
19361
  * @deprecated Use `external_type_display_name`.*/
19329
19362
  access_group_type_display_name: string;
19330
19363
  display_name: string;
19331
19364
  /** Brand-specific terminology for the access group type. */
19332
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
19365
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
19333
19366
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
19334
19367
  external_type_display_name: string;
19335
19368
  /** Date and time at which the access group was created. */
@@ -20415,14 +20448,21 @@ export type Routes = {
20415
20448
  message: string;
20416
20449
  }[];
20417
20450
  /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
20418
- warnings: {
20451
+ warnings: ({
20419
20452
  /** Date and time at which Seam created the warning. */
20420
20453
  created_at: string;
20421
20454
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20422
20455
  message: string;
20423
20456
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20424
20457
  warning_code: 'salto_ks_entrance_access_code_support_removed';
20425
- }[];
20458
+ } | {
20459
+ /** Date and time at which Seam created the warning. */
20460
+ created_at: string;
20461
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
20462
+ message: string;
20463
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
20464
+ warning_code: 'entrance_shares_zone';
20465
+ })[];
20426
20466
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
20427
20467
  latch_metadata?: {
20428
20468
  /** Accessibility type in the Latch access system. */
@@ -24077,14 +24117,21 @@ export type Routes = {
24077
24117
  message: string;
24078
24118
  }[];
24079
24119
  /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
24080
- warnings: {
24120
+ warnings: ({
24081
24121
  /** Date and time at which Seam created the warning. */
24082
24122
  created_at: string;
24083
24123
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
24084
24124
  message: string;
24085
24125
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
24086
24126
  warning_code: 'salto_ks_entrance_access_code_support_removed';
24087
- }[];
24127
+ } | {
24128
+ /** Date and time at which Seam created the warning. */
24129
+ created_at: string;
24130
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
24131
+ message: string;
24132
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
24133
+ warning_code: 'entrance_shares_zone';
24134
+ })[];
24088
24135
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
24089
24136
  latch_metadata?: {
24090
24137
  /** Accessibility type in the Latch access system. */
@@ -24284,14 +24331,21 @@ export type Routes = {
24284
24331
  message: string;
24285
24332
  }[];
24286
24333
  /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
24287
- warnings: {
24334
+ warnings: ({
24288
24335
  /** Date and time at which Seam created the warning. */
24289
24336
  created_at: string;
24290
24337
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
24291
24338
  message: string;
24292
24339
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
24293
24340
  warning_code: 'salto_ks_entrance_access_code_support_removed';
24294
- }[];
24341
+ } | {
24342
+ /** Date and time at which Seam created the warning. */
24343
+ created_at: string;
24344
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
24345
+ message: string;
24346
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
24347
+ warning_code: 'entrance_shares_zone';
24348
+ })[];
24295
24349
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
24296
24350
  latch_metadata?: {
24297
24351
  /** Accessibility type in the Latch access system. */
@@ -27285,14 +27339,21 @@ export type Routes = {
27285
27339
  message: string;
27286
27340
  }[];
27287
27341
  /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
27288
- warnings: {
27342
+ warnings: ({
27289
27343
  /** Date and time at which Seam created the warning. */
27290
27344
  created_at: string;
27291
27345
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27292
27346
  message: string;
27293
27347
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27294
27348
  warning_code: 'salto_ks_entrance_access_code_support_removed';
27295
- }[];
27349
+ } | {
27350
+ /** Date and time at which Seam created the warning. */
27351
+ created_at: string;
27352
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
27353
+ message: string;
27354
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
27355
+ warning_code: 'entrance_shares_zone';
27356
+ })[];
27296
27357
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
27297
27358
  latch_metadata?: {
27298
27359
  /** Accessibility type in the Latch access system. */
@@ -68978,14 +69039,21 @@ export type Routes = {
68978
69039
  message: string;
68979
69040
  }[];
68980
69041
  /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
68981
- warnings: {
69042
+ warnings: ({
68982
69043
  /** Date and time at which Seam created the warning. */
68983
69044
  created_at: string;
68984
69045
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
68985
69046
  message: string;
68986
69047
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
68987
69048
  warning_code: 'salto_ks_entrance_access_code_support_removed';
68988
- }[];
69049
+ } | {
69050
+ /** Date and time at which Seam created the warning. */
69051
+ created_at: string;
69052
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
69053
+ message: string;
69054
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
69055
+ warning_code: 'entrance_shares_zone';
69056
+ })[];
68989
69057
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
68990
69058
  latch_metadata?: {
68991
69059
  /** Accessibility type in the Latch access system. */
@@ -70805,14 +70873,21 @@ export type Routes = {
70805
70873
  message: string;
70806
70874
  }[];
70807
70875
  /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
70808
- warnings: {
70876
+ warnings: ({
70809
70877
  /** Date and time at which Seam created the warning. */
70810
70878
  created_at: string;
70811
70879
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
70812
70880
  message: string;
70813
70881
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
70814
70882
  warning_code: 'salto_ks_entrance_access_code_support_removed';
70815
- }[];
70883
+ } | {
70884
+ /** Date and time at which Seam created the warning. */
70885
+ created_at: string;
70886
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
70887
+ message: string;
70888
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
70889
+ warning_code: 'entrance_shares_zone';
70890
+ })[];
70816
70891
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
70817
70892
  latch_metadata?: {
70818
70893
  /** Accessibility type in the Latch access system. */
@@ -91430,14 +91505,21 @@ export type Routes = {
91430
91505
  message: string;
91431
91506
  }[];
91432
91507
  /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
91433
- warnings: {
91508
+ warnings: ({
91434
91509
  /** Date and time at which Seam created the warning. */
91435
91510
  created_at: string;
91436
91511
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
91437
91512
  message: string;
91438
91513
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
91439
91514
  warning_code: 'salto_ks_entrance_access_code_support_removed';
91440
- }[];
91515
+ } | {
91516
+ /** Date and time at which Seam created the warning. */
91517
+ created_at: string;
91518
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
91519
+ message: string;
91520
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
91521
+ warning_code: 'entrance_shares_zone';
91522
+ })[];
91441
91523
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
91442
91524
  latch_metadata?: {
91443
91525
  /** Accessibility type in the Latch access system. */
@@ -93917,14 +93999,21 @@ export type Routes = {
93917
93999
  message: string;
93918
94000
  }[];
93919
94001
  /** Warnings associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
93920
- warnings: {
94002
+ warnings: ({
93921
94003
  /** Date and time at which Seam created the warning. */
93922
94004
  created_at: string;
93923
94005
  /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
93924
94006
  message: string;
93925
94007
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
93926
94008
  warning_code: 'salto_ks_entrance_access_code_support_removed';
93927
- }[];
94009
+ } | {
94010
+ /** Date and time at which Seam created the warning. */
94011
+ created_at: string;
94012
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
94013
+ message: string;
94014
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
94015
+ warning_code: 'entrance_shares_zone';
94016
+ })[];
93928
94017
  /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
93929
94018
  latch_metadata?: {
93930
94019
  /** Accessibility type in the Latch access system. */
@@ -94436,13 +94525,13 @@ export type Routes = {
94436
94525
  name: string;
94437
94526
  /**
94438
94527
  * @deprecated Use `external_type`.*/
94439
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
94528
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
94440
94529
  /**
94441
94530
  * @deprecated Use `external_type_display_name`.*/
94442
94531
  access_group_type_display_name: string;
94443
94532
  display_name: string;
94444
94533
  /** Brand-specific terminology for the access group type. */
94445
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
94534
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
94446
94535
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
94447
94536
  external_type_display_name: string;
94448
94537
  /** Date and time at which the access group was created. */
@@ -96223,13 +96312,13 @@ export type Routes = {
96223
96312
  name: string;
96224
96313
  /**
96225
96314
  * @deprecated Use `external_type`.*/
96226
- access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
96315
+ access_group_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
96227
96316
  /**
96228
96317
  * @deprecated Use `external_type_display_name`.*/
96229
96318
  access_group_type_display_name: string;
96230
96319
  display_name: string;
96231
96320
  /** Brand-specific terminology for the access group type. */
96232
- external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group';
96321
+ external_type: 'pti_unit' | 'pti_access_level' | 'salto_ks_access_group' | 'brivo_group' | 'salto_space_group' | 'dormakaba_community_access_group' | 'dormakaba_ambiance_access_group' | 'avigilon_alta_group';
96233
96322
  /** Display name that corresponds to the brand-specific terminology for the access group type. */
96234
96323
  external_type_display_name: string;
96235
96324
  /** Date and time at which the access group was created. */
@@ -100882,6 +100971,10 @@ export type Routes = {
100882
100971
  ends_at?: (string | null) | undefined;
100883
100972
  /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device. */
100884
100973
  status: 'set' | 'unset';
100974
+ /** Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations. */
100975
+ cannot_be_managed?: true | undefined;
100976
+ /** Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app. */
100977
+ cannot_delete_unmanaged_access_code?: true | undefined;
100885
100978
  /** Metadata for a dormakaba Oracode unmanaged access code. Only present for unmanaged access codes from dormakaba Oracode devices. */
100886
100979
  dormakaba_oracode_metadata?: ({
100887
100980
  /** Dormakaba Oracode stay ID associated with this access code. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@seamapi/types",
3
- "version": "1.846.0",
3
+ "version": "1.848.0",
4
4
  "description": "TypeScript types for the Seam API.",
5
5
  "type": "module",
6
6
  "main": "index.js",
@@ -29,6 +29,18 @@ export const unmanaged_access_code = access_code
29
29
  .describe(
30
30
  'Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. `unset` indicates that the code exists on the provider but is not usable on the device.',
31
31
  ),
32
+ cannot_be_managed: z
33
+ .literal(true)
34
+ .optional()
35
+ .describe(
36
+ 'Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations.',
37
+ ),
38
+ cannot_delete_unmanaged_access_code: z
39
+ .literal(true)
40
+ .optional()
41
+ .describe(
42
+ 'Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app.',
43
+ ),
32
44
  dormakaba_oracode_metadata: dormakaba_oracode_access_code_metadata
33
45
  .nullable()
34
46
  .optional()
@@ -12,6 +12,7 @@ export const acs_access_group_external_type = z.enum([
12
12
  'salto_space_group',
13
13
  'dormakaba_community_access_group',
14
14
  'dormakaba_ambiance_access_group',
15
+ 'avigilon_alta_group',
15
16
  ])
16
17
 
17
18
  export type AcsAccessGroupExternalType = z.infer<
@@ -39,9 +39,20 @@ const salto_ks_entrance_access_code_support_removed =
39
39
  'Indicates that a change in the reported device model has been detected for this Salto KS entrance, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
40
40
  )
41
41
 
42
+ const entrance_shares_zone = common_acs_entrance_warning
43
+ .extend({
44
+ warning_code: z
45
+ .literal('entrance_shares_zone')
46
+ .describe(warning_code_description),
47
+ })
48
+ .describe(
49
+ 'Indicates that this entrance shares a zone with other entrances in Avigilon Alta and cannot be added to an access group individually.',
50
+ )
51
+
42
52
  const acs_entrance_warning = z
43
53
  .discriminatedUnion('warning_code', [
44
54
  salto_ks_entrance_access_code_support_removed,
55
+ entrance_shares_zone,
45
56
  ])
46
57
  .describe(
47
58
  'Warning associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
@@ -50,6 +61,7 @@ const acs_entrance_warning = z
50
61
  const _acs_entrance_warning_map = z.object({
51
62
  salto_ks_entrance_access_code_support_removed:
52
63
  salto_ks_entrance_access_code_support_removed.optional().nullable(),
64
+ entrance_shares_zone: entrance_shares_zone.optional().nullable(),
53
65
  })
54
66
 
55
67
  export type AcsEntranceWarningMap = z.infer<typeof _acs_entrance_warning_map>
@@ -3150,6 +3150,7 @@ const openapi: OpenAPISpec = {
3150
3150
  'salto_space_group',
3151
3151
  'dormakaba_community_access_group',
3152
3152
  'dormakaba_ambiance_access_group',
3153
+ 'avigilon_alta_group',
3153
3154
  ],
3154
3155
  type: 'string',
3155
3156
  'x-deprecated': 'Use `external_type`.',
@@ -3249,6 +3250,7 @@ const openapi: OpenAPISpec = {
3249
3250
  'salto_space_group',
3250
3251
  'dormakaba_community_access_group',
3251
3252
  'dormakaba_ambiance_access_group',
3253
+ 'avigilon_alta_group',
3252
3254
  ],
3253
3255
  type: 'string',
3254
3256
  },
@@ -4684,6 +4686,31 @@ const openapi: OpenAPISpec = {
4684
4686
  required: ['created_at', 'message', 'warning_code'],
4685
4687
  type: 'object',
4686
4688
  },
4689
+ {
4690
+ description:
4691
+ 'Indicates that this entrance shares a zone with other entrances in Avigilon Alta and cannot be added to an access group individually.',
4692
+ properties: {
4693
+ created_at: {
4694
+ description:
4695
+ 'Date and time at which Seam created the warning.',
4696
+ format: 'date-time',
4697
+ type: 'string',
4698
+ },
4699
+ message: {
4700
+ description:
4701
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
4702
+ type: 'string',
4703
+ },
4704
+ warning_code: {
4705
+ description:
4706
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
4707
+ enum: ['entrance_shares_zone'],
4708
+ type: 'string',
4709
+ },
4710
+ },
4711
+ required: ['created_at', 'message', 'warning_code'],
4712
+ type: 'object',
4713
+ },
4687
4714
  ],
4688
4715
  },
4689
4716
  type: 'array',
@@ -25506,6 +25533,35 @@ const openapi: OpenAPISpec = {
25506
25533
  ],
25507
25534
  type: 'object',
25508
25535
  },
25536
+ {
25537
+ description:
25538
+ 'Indicates that this entrance shares a zone with other entrances in Avigilon Alta and cannot be added to an access group individually.',
25539
+ properties: {
25540
+ created_at: {
25541
+ description:
25542
+ 'Date and time at which Seam created the warning.',
25543
+ format: 'date-time',
25544
+ type: 'string',
25545
+ },
25546
+ message: {
25547
+ description:
25548
+ 'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
25549
+ type: 'string',
25550
+ },
25551
+ warning_code: {
25552
+ description:
25553
+ 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
25554
+ enum: ['entrance_shares_zone'],
25555
+ type: 'string',
25556
+ },
25557
+ },
25558
+ required: [
25559
+ 'created_at',
25560
+ 'message',
25561
+ 'warning_code',
25562
+ ],
25563
+ type: 'object',
25564
+ },
25509
25565
  ],
25510
25566
  },
25511
25567
  type: 'array',
@@ -26545,6 +26601,18 @@ const openapi: OpenAPISpec = {
26545
26601
  format: 'uuid',
26546
26602
  type: 'string',
26547
26603
  },
26604
+ cannot_be_managed: {
26605
+ description:
26606
+ 'Indicates that Seam cannot convert this unmanaged access code to a managed access code. Some providers do not support management of unmanaged access codes through API integrations.',
26607
+ enum: [true],
26608
+ type: 'boolean',
26609
+ },
26610
+ cannot_delete_unmanaged_access_code: {
26611
+ description:
26612
+ 'Indicates that Seam cannot delete this unmanaged access code through the provider. If this access code needs to be deleted, it will only be possible from the manufacturer app.',
26613
+ enum: [true],
26614
+ type: 'boolean',
26615
+ },
26548
26616
  code: {
26549
26617
  description:
26550
26618
  'Code used for access. Typically, a numeric or alphanumeric string.',
@@ -28351,6 +28419,7 @@ const openapi: OpenAPISpec = {
28351
28419
  'salto_space_group',
28352
28420
  'dormakaba_community_access_group',
28353
28421
  'dormakaba_ambiance_access_group',
28422
+ 'avigilon_alta_group',
28354
28423
  ],
28355
28424
  type: 'string',
28356
28425
  'x-deprecated': 'Use `external_type`.',
@@ -28450,6 +28519,7 @@ const openapi: OpenAPISpec = {
28450
28519
  'salto_space_group',
28451
28520
  'dormakaba_community_access_group',
28452
28521
  'dormakaba_ambiance_access_group',
28522
+ 'avigilon_alta_group',
28453
28523
  ],
28454
28524
  type: 'string',
28455
28525
  },