@seamapi/types 1.769.0 → 1.771.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 (32) hide show
  1. package/dist/connect.cjs +777 -35
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1530 -269
  4. package/dist/index.cjs +777 -35
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/access-grants/access-grant.d.ts +10 -10
  7. package/lib/seam/connect/models/access-grants/access-method.d.ts +6 -6
  8. package/lib/seam/connect/models/access-grants/access-method.js +2 -2
  9. package/lib/seam/connect/models/access-grants/access-method.js.map +1 -1
  10. package/lib/seam/connect/models/access-grants/requested-access-method.d.ts +3 -3
  11. package/lib/seam/connect/models/access-grants/requested-access-method.js +2 -2
  12. package/lib/seam/connect/models/access-grants/requested-access-method.js.map +1 -1
  13. package/lib/seam/connect/models/acs/acs-entrance.d.ts +6 -6
  14. package/lib/seam/connect/models/acs/acs-entrance.js +4 -4
  15. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  16. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +15 -0
  17. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +15 -0
  18. package/lib/seam/connect/models/action-attempts/encode-credential.js +11 -0
  19. package/lib/seam/connect/models/action-attempts/encode-credential.js.map +1 -1
  20. package/lib/seam/connect/models/batch.d.ts +38 -17
  21. package/lib/seam/connect/models/phones/phone-session.d.ts +16 -16
  22. package/lib/seam/connect/openapi.d.ts +952 -0
  23. package/lib/seam/connect/openapi.js +758 -27
  24. package/lib/seam/connect/openapi.js.map +1 -1
  25. package/lib/seam/connect/route-types.d.ts +336 -63
  26. package/package.json +1 -1
  27. package/src/lib/seam/connect/models/access-grants/access-method.ts +2 -2
  28. package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +2 -2
  29. package/src/lib/seam/connect/models/acs/acs-entrance.ts +4 -4
  30. package/src/lib/seam/connect/models/action-attempts/encode-credential.ts +18 -0
  31. package/src/lib/seam/connect/openapi.ts +825 -27
  32. package/src/lib/seam/connect/route-types.ts +407 -63
@@ -3611,7 +3611,7 @@ declare const access_grant: z.ZodObject<{
3611
3611
  space_ids: z.ZodArray<z.ZodString, "many">;
3612
3612
  requested_access_methods: z.ZodArray<z.ZodObject<{
3613
3613
  display_name: z.ZodString;
3614
- mode: z.ZodEnum<["code", "card", "mobile_key"]>;
3614
+ mode: z.ZodEnum<["code", "card", "mobile_key", "cloud_key"]>;
3615
3615
  code: z.ZodOptional<z.ZodString>;
3616
3616
  instant_key_max_use_count: z.ZodOptional<z.ZodNumber>;
3617
3617
  created_at: z.ZodString;
@@ -3619,14 +3619,14 @@ declare const access_grant: z.ZodObject<{
3619
3619
  }, "strip", z.ZodTypeAny, {
3620
3620
  display_name: string;
3621
3621
  created_at: string;
3622
- mode: "code" | "card" | "mobile_key";
3622
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
3623
3623
  created_access_method_ids: string[];
3624
3624
  code?: string | undefined;
3625
3625
  instant_key_max_use_count?: number | undefined;
3626
3626
  }, {
3627
3627
  display_name: string;
3628
3628
  created_at: string;
3629
- mode: "code" | "card" | "mobile_key";
3629
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
3630
3630
  created_access_method_ids: string[];
3631
3631
  code?: string | undefined;
3632
3632
  instant_key_max_use_count?: number | undefined;
@@ -3895,7 +3895,7 @@ declare const access_grant: z.ZodObject<{
3895
3895
  requested_access_methods: {
3896
3896
  display_name: string;
3897
3897
  created_at: string;
3898
- mode: "code" | "card" | "mobile_key";
3898
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
3899
3899
  created_access_method_ids: string[];
3900
3900
  code?: string | undefined;
3901
3901
  instant_key_max_use_count?: number | undefined;
@@ -3980,7 +3980,7 @@ declare const access_grant: z.ZodObject<{
3980
3980
  requested_access_methods: {
3981
3981
  display_name: string;
3982
3982
  created_at: string;
3983
- mode: "code" | "card" | "mobile_key";
3983
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
3984
3984
  created_access_method_ids: string[];
3985
3985
  code?: string | undefined;
3986
3986
  instant_key_max_use_count?: number | undefined;
@@ -4022,7 +4022,7 @@ declare const access_method: z.ZodObject<{
4022
4022
  workspace_id: z.ZodString;
4023
4023
  access_method_id: z.ZodString;
4024
4024
  display_name: z.ZodString;
4025
- mode: z.ZodEnum<["code", "card", "mobile_key"]>;
4025
+ mode: z.ZodEnum<["code", "card", "mobile_key", "cloud_key"]>;
4026
4026
  created_at: z.ZodString;
4027
4027
  issued_at: z.ZodNullable<z.ZodString>;
4028
4028
  is_issued: z.ZodBoolean;
@@ -4221,7 +4221,7 @@ declare const access_method: z.ZodObject<{
4221
4221
  warning_code: "pulled_backup_access_code";
4222
4222
  original_access_method_id?: string | undefined;
4223
4223
  })[];
4224
- mode: "code" | "card" | "mobile_key";
4224
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
4225
4225
  pending_mutations: ({
4226
4226
  message: string;
4227
4227
  created_at: string;
@@ -4282,7 +4282,7 @@ declare const access_method: z.ZodObject<{
4282
4282
  warning_code: "pulled_backup_access_code";
4283
4283
  original_access_method_id?: string | undefined;
4284
4284
  })[];
4285
- mode: "code" | "card" | "mobile_key";
4285
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
4286
4286
  pending_mutations: ({
4287
4287
  message: string;
4288
4288
  created_at: string;
@@ -6076,8 +6076,8 @@ declare const acs_entrance: z.ZodObject<{
6076
6076
  can_unlock_with_mobile_key: z.ZodOptional<z.ZodBoolean>;
6077
6077
  can_unlock_with_card: z.ZodOptional<z.ZodBoolean>;
6078
6078
  can_unlock_with_code: z.ZodOptional<z.ZodBoolean>;
6079
- can_belong_to_reservation: z.ZodOptional<z.ZodBoolean>;
6080
6079
  can_unlock_with_cloud_key: z.ZodOptional<z.ZodBoolean>;
6080
+ can_belong_to_reservation: z.ZodOptional<z.ZodBoolean>;
6081
6081
  }, "strip", z.ZodTypeAny, {
6082
6082
  display_name: string;
6083
6083
  created_at: string;
@@ -6122,8 +6122,8 @@ declare const acs_entrance: z.ZodObject<{
6122
6122
  can_unlock_with_code?: boolean | undefined;
6123
6123
  can_unlock_with_mobile_key?: boolean | undefined;
6124
6124
  can_unlock_with_card?: boolean | undefined;
6125
- can_belong_to_reservation?: boolean | undefined;
6126
6125
  can_unlock_with_cloud_key?: boolean | undefined;
6126
+ can_belong_to_reservation?: boolean | undefined;
6127
6127
  latch_metadata?: {
6128
6128
  door_name: string;
6129
6129
  is_connected: boolean;
@@ -6193,8 +6193,8 @@ declare const acs_entrance: z.ZodObject<{
6193
6193
  can_unlock_with_code?: boolean | undefined;
6194
6194
  can_unlock_with_mobile_key?: boolean | undefined;
6195
6195
  can_unlock_with_card?: boolean | undefined;
6196
- can_belong_to_reservation?: boolean | undefined;
6197
6196
  can_unlock_with_cloud_key?: boolean | undefined;
6197
+ can_belong_to_reservation?: boolean | undefined;
6198
6198
  latch_metadata?: {
6199
6199
  door_name: string;
6200
6200
  is_connected: boolean;
@@ -10662,6 +10662,15 @@ declare const action_attempt: z.ZodUnion<[z.ZodObject<{
10662
10662
  }, {
10663
10663
  message: string;
10664
10664
  type: "bridge_disconnected";
10665
+ }>, z.ZodObject<{
10666
+ type: z.ZodLiteral<"encoding_interrupted">;
10667
+ message: z.ZodString;
10668
+ }, "strip", z.ZodTypeAny, {
10669
+ message: string;
10670
+ type: "encoding_interrupted";
10671
+ }, {
10672
+ message: string;
10673
+ type: "encoding_interrupted";
10665
10674
  }>]>;
10666
10675
  }, "strip", z.ZodTypeAny, {
10667
10676
  status: "error";
@@ -10690,6 +10699,9 @@ declare const action_attempt: z.ZodUnion<[z.ZodObject<{
10690
10699
  } | {
10691
10700
  message: string;
10692
10701
  type: "bridge_disconnected";
10702
+ } | {
10703
+ message: string;
10704
+ type: "encoding_interrupted";
10693
10705
  };
10694
10706
  result: null;
10695
10707
  action_type: "ENCODE_CREDENTIAL";
@@ -10720,6 +10732,9 @@ declare const action_attempt: z.ZodUnion<[z.ZodObject<{
10720
10732
  } | {
10721
10733
  message: string;
10722
10734
  type: "bridge_disconnected";
10735
+ } | {
10736
+ message: string;
10737
+ type: "encoding_interrupted";
10723
10738
  };
10724
10739
  result: null;
10725
10740
  action_type: "ENCODE_CREDENTIAL";
@@ -17224,8 +17239,8 @@ declare const batch: z.ZodObject<{
17224
17239
  can_unlock_with_mobile_key: z.ZodOptional<z.ZodBoolean>;
17225
17240
  can_unlock_with_card: z.ZodOptional<z.ZodBoolean>;
17226
17241
  can_unlock_with_code: z.ZodOptional<z.ZodBoolean>;
17227
- can_belong_to_reservation: z.ZodOptional<z.ZodBoolean>;
17228
17242
  can_unlock_with_cloud_key: z.ZodOptional<z.ZodBoolean>;
17243
+ can_belong_to_reservation: z.ZodOptional<z.ZodBoolean>;
17229
17244
  }, "strip", z.ZodTypeAny, {
17230
17245
  display_name: string;
17231
17246
  created_at: string;
@@ -17270,8 +17285,8 @@ declare const batch: z.ZodObject<{
17270
17285
  can_unlock_with_code?: boolean | undefined;
17271
17286
  can_unlock_with_mobile_key?: boolean | undefined;
17272
17287
  can_unlock_with_card?: boolean | undefined;
17273
- can_belong_to_reservation?: boolean | undefined;
17274
17288
  can_unlock_with_cloud_key?: boolean | undefined;
17289
+ can_belong_to_reservation?: boolean | undefined;
17275
17290
  latch_metadata?: {
17276
17291
  door_name: string;
17277
17292
  is_connected: boolean;
@@ -17341,8 +17356,8 @@ declare const batch: z.ZodObject<{
17341
17356
  can_unlock_with_code?: boolean | undefined;
17342
17357
  can_unlock_with_mobile_key?: boolean | undefined;
17343
17358
  can_unlock_with_card?: boolean | undefined;
17344
- can_belong_to_reservation?: boolean | undefined;
17345
17359
  can_unlock_with_cloud_key?: boolean | undefined;
17360
+ can_belong_to_reservation?: boolean | undefined;
17346
17361
  latch_metadata?: {
17347
17362
  door_name: string;
17348
17363
  is_connected: boolean;
@@ -22223,6 +22238,15 @@ declare const batch: z.ZodObject<{
22223
22238
  }, {
22224
22239
  message: string;
22225
22240
  type: "bridge_disconnected";
22241
+ }>, z.ZodObject<{
22242
+ type: z.ZodLiteral<"encoding_interrupted">;
22243
+ message: z.ZodString;
22244
+ }, "strip", z.ZodTypeAny, {
22245
+ message: string;
22246
+ type: "encoding_interrupted";
22247
+ }, {
22248
+ message: string;
22249
+ type: "encoding_interrupted";
22226
22250
  }>]>;
22227
22251
  }, "strip", z.ZodTypeAny, {
22228
22252
  status: "error";
@@ -22251,6 +22275,9 @@ declare const batch: z.ZodObject<{
22251
22275
  } | {
22252
22276
  message: string;
22253
22277
  type: "bridge_disconnected";
22278
+ } | {
22279
+ message: string;
22280
+ type: "encoding_interrupted";
22254
22281
  };
22255
22282
  result: null;
22256
22283
  action_type: "ENCODE_CREDENTIAL";
@@ -22281,6 +22308,9 @@ declare const batch: z.ZodObject<{
22281
22308
  } | {
22282
22309
  message: string;
22283
22310
  type: "bridge_disconnected";
22311
+ } | {
22312
+ message: string;
22313
+ type: "encoding_interrupted";
22284
22314
  };
22285
22315
  result: null;
22286
22316
  action_type: "ENCODE_CREDENTIAL";
@@ -28445,7 +28475,7 @@ declare const batch: z.ZodObject<{
28445
28475
  workspace_id: z.ZodString;
28446
28476
  access_method_id: z.ZodString;
28447
28477
  display_name: z.ZodString;
28448
- mode: z.ZodEnum<["code", "card", "mobile_key"]>;
28478
+ mode: z.ZodEnum<["code", "card", "mobile_key", "cloud_key"]>;
28449
28479
  created_at: z.ZodString;
28450
28480
  issued_at: z.ZodNullable<z.ZodString>;
28451
28481
  is_issued: z.ZodBoolean;
@@ -28644,7 +28674,7 @@ declare const batch: z.ZodObject<{
28644
28674
  warning_code: "pulled_backup_access_code";
28645
28675
  original_access_method_id?: string | undefined;
28646
28676
  })[];
28647
- mode: "code" | "card" | "mobile_key";
28677
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
28648
28678
  pending_mutations: ({
28649
28679
  message: string;
28650
28680
  created_at: string;
@@ -28705,7 +28735,7 @@ declare const batch: z.ZodObject<{
28705
28735
  warning_code: "pulled_backup_access_code";
28706
28736
  original_access_method_id?: string | undefined;
28707
28737
  })[];
28708
- mode: "code" | "card" | "mobile_key";
28738
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
28709
28739
  pending_mutations: ({
28710
28740
  message: string;
28711
28741
  created_at: string;
@@ -28759,7 +28789,7 @@ declare const batch: z.ZodObject<{
28759
28789
  space_ids: z.ZodArray<z.ZodString, "many">;
28760
28790
  requested_access_methods: z.ZodArray<z.ZodObject<{
28761
28791
  display_name: z.ZodString;
28762
- mode: z.ZodEnum<["code", "card", "mobile_key"]>;
28792
+ mode: z.ZodEnum<["code", "card", "mobile_key", "cloud_key"]>;
28763
28793
  code: z.ZodOptional<z.ZodString>;
28764
28794
  instant_key_max_use_count: z.ZodOptional<z.ZodNumber>;
28765
28795
  created_at: z.ZodString;
@@ -28767,14 +28797,14 @@ declare const batch: z.ZodObject<{
28767
28797
  }, "strip", z.ZodTypeAny, {
28768
28798
  display_name: string;
28769
28799
  created_at: string;
28770
- mode: "code" | "card" | "mobile_key";
28800
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
28771
28801
  created_access_method_ids: string[];
28772
28802
  code?: string | undefined;
28773
28803
  instant_key_max_use_count?: number | undefined;
28774
28804
  }, {
28775
28805
  display_name: string;
28776
28806
  created_at: string;
28777
- mode: "code" | "card" | "mobile_key";
28807
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
28778
28808
  created_access_method_ids: string[];
28779
28809
  code?: string | undefined;
28780
28810
  instant_key_max_use_count?: number | undefined;
@@ -29043,7 +29073,7 @@ declare const batch: z.ZodObject<{
29043
29073
  requested_access_methods: {
29044
29074
  display_name: string;
29045
29075
  created_at: string;
29046
- mode: "code" | "card" | "mobile_key";
29076
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
29047
29077
  created_access_method_ids: string[];
29048
29078
  code?: string | undefined;
29049
29079
  instant_key_max_use_count?: number | undefined;
@@ -29128,7 +29158,7 @@ declare const batch: z.ZodObject<{
29128
29158
  requested_access_methods: {
29129
29159
  display_name: string;
29130
29160
  created_at: string;
29131
- mode: "code" | "card" | "mobile_key";
29161
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
29132
29162
  created_access_method_ids: string[];
29133
29163
  code?: string | undefined;
29134
29164
  instant_key_max_use_count?: number | undefined;
@@ -38216,8 +38246,8 @@ declare const batch: z.ZodObject<{
38216
38246
  can_unlock_with_code?: boolean | undefined;
38217
38247
  can_unlock_with_mobile_key?: boolean | undefined;
38218
38248
  can_unlock_with_card?: boolean | undefined;
38219
- can_belong_to_reservation?: boolean | undefined;
38220
38249
  can_unlock_with_cloud_key?: boolean | undefined;
38250
+ can_belong_to_reservation?: boolean | undefined;
38221
38251
  latch_metadata?: {
38222
38252
  door_name: string;
38223
38253
  is_connected: boolean;
@@ -39075,6 +39105,9 @@ declare const batch: z.ZodObject<{
39075
39105
  } | {
39076
39106
  message: string;
39077
39107
  type: "bridge_disconnected";
39108
+ } | {
39109
+ message: string;
39110
+ type: "encoding_interrupted";
39078
39111
  };
39079
39112
  result: null;
39080
39113
  action_type: "ENCODE_CREDENTIAL";
@@ -39996,7 +40029,7 @@ declare const batch: z.ZodObject<{
39996
40029
  warning_code: "pulled_backup_access_code";
39997
40030
  original_access_method_id?: string | undefined;
39998
40031
  })[];
39999
- mode: "code" | "card" | "mobile_key";
40032
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
40000
40033
  pending_mutations: ({
40001
40034
  message: string;
40002
40035
  created_at: string;
@@ -40090,7 +40123,7 @@ declare const batch: z.ZodObject<{
40090
40123
  requested_access_methods: {
40091
40124
  display_name: string;
40092
40125
  created_at: string;
40093
- mode: "code" | "card" | "mobile_key";
40126
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
40094
40127
  created_access_method_ids: string[];
40095
40128
  code?: string | undefined;
40096
40129
  instant_key_max_use_count?: number | undefined;
@@ -43074,8 +43107,8 @@ declare const batch: z.ZodObject<{
43074
43107
  can_unlock_with_code?: boolean | undefined;
43075
43108
  can_unlock_with_mobile_key?: boolean | undefined;
43076
43109
  can_unlock_with_card?: boolean | undefined;
43077
- can_belong_to_reservation?: boolean | undefined;
43078
43110
  can_unlock_with_cloud_key?: boolean | undefined;
43111
+ can_belong_to_reservation?: boolean | undefined;
43079
43112
  latch_metadata?: {
43080
43113
  door_name: string;
43081
43114
  is_connected: boolean;
@@ -43933,6 +43966,9 @@ declare const batch: z.ZodObject<{
43933
43966
  } | {
43934
43967
  message: string;
43935
43968
  type: "bridge_disconnected";
43969
+ } | {
43970
+ message: string;
43971
+ type: "encoding_interrupted";
43936
43972
  };
43937
43973
  result: null;
43938
43974
  action_type: "ENCODE_CREDENTIAL";
@@ -44854,7 +44890,7 @@ declare const batch: z.ZodObject<{
44854
44890
  warning_code: "pulled_backup_access_code";
44855
44891
  original_access_method_id?: string | undefined;
44856
44892
  })[];
44857
- mode: "code" | "card" | "mobile_key";
44893
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
44858
44894
  pending_mutations: ({
44859
44895
  message: string;
44860
44896
  created_at: string;
@@ -44948,7 +44984,7 @@ declare const batch: z.ZodObject<{
44948
44984
  requested_access_methods: {
44949
44985
  display_name: string;
44950
44986
  created_at: string;
44951
- mode: "code" | "card" | "mobile_key";
44987
+ mode: "code" | "card" | "mobile_key" | "cloud_key";
44952
44988
  created_access_method_ids: string[];
44953
44989
  code?: string | undefined;
44954
44990
  instant_key_max_use_count?: number | undefined;
@@ -118190,6 +118226,958 @@ declare const _default: {
118190
118226
  'x-undocumented': string;
118191
118227
  };
118192
118228
  };
118229
+ '/seam/customer/v1/portals/update': {
118230
+ patch: {
118231
+ description: string;
118232
+ operationId: string;
118233
+ requestBody: {
118234
+ content: {
118235
+ 'application/json': {
118236
+ schema: {
118237
+ properties: {
118238
+ customer_portal_id: {
118239
+ description: string;
118240
+ format: string;
118241
+ type: string;
118242
+ };
118243
+ portal_configuration: {
118244
+ description: string;
118245
+ properties: {
118246
+ customer_resources_filters: {
118247
+ description: string;
118248
+ items: {
118249
+ properties: {
118250
+ field: {
118251
+ description: string;
118252
+ pattern: string;
118253
+ type: string;
118254
+ };
118255
+ operation: {
118256
+ description: string;
118257
+ enum: string[];
118258
+ type: string;
118259
+ };
118260
+ value: {
118261
+ description: string;
118262
+ oneOf: {
118263
+ type: string;
118264
+ }[];
118265
+ };
118266
+ };
118267
+ required: string[];
118268
+ type: string;
118269
+ };
118270
+ type: string;
118271
+ };
118272
+ customization_profile_id: {
118273
+ description: string;
118274
+ format: string;
118275
+ type: string;
118276
+ };
118277
+ deep_link: {
118278
+ description: string;
118279
+ properties: {
118280
+ resource_key: {
118281
+ type: string;
118282
+ };
118283
+ resource_type: {
118284
+ enum: string[];
118285
+ type: string;
118286
+ };
118287
+ };
118288
+ required: string[];
118289
+ type: string;
118290
+ 'x-undocumented': string;
118291
+ };
118292
+ exclude_locale_picker: {
118293
+ default: boolean;
118294
+ description: string;
118295
+ type: string;
118296
+ };
118297
+ features: {
118298
+ default: {};
118299
+ properties: {
118300
+ configure: {
118301
+ default: {};
118302
+ description: string;
118303
+ properties: {
118304
+ allow_access_automation_rule_customization: {
118305
+ default: boolean;
118306
+ description: string;
118307
+ type: string;
118308
+ };
118309
+ allow_climate_automation_rule_customization: {
118310
+ default: boolean;
118311
+ description: string;
118312
+ type: string;
118313
+ };
118314
+ allow_instant_key_customization: {
118315
+ default: boolean;
118316
+ description: string;
118317
+ type: string;
118318
+ };
118319
+ exclude: {
118320
+ default: boolean;
118321
+ description: string;
118322
+ type: string;
118323
+ };
118324
+ };
118325
+ type: string;
118326
+ };
118327
+ connect: {
118328
+ default: {};
118329
+ description: string;
118330
+ properties: {
118331
+ accepted_providers: {
118332
+ description: string;
118333
+ items: {
118334
+ type: string;
118335
+ };
118336
+ type: string;
118337
+ };
118338
+ exclude: {
118339
+ default: boolean;
118340
+ description: string;
118341
+ type: string;
118342
+ };
118343
+ excluded_providers: {
118344
+ description: string;
118345
+ items: {
118346
+ type: string;
118347
+ };
118348
+ type: string;
118349
+ };
118350
+ };
118351
+ type: string;
118352
+ };
118353
+ manage: {
118354
+ default: {};
118355
+ description: string;
118356
+ properties: {
118357
+ events: {
118358
+ description: string;
118359
+ properties: {
118360
+ allowed_events: {
118361
+ description: string;
118362
+ items: {
118363
+ type: string;
118364
+ };
118365
+ type: string;
118366
+ };
118367
+ default_events: {
118368
+ description: string;
118369
+ items: {
118370
+ type: string;
118371
+ };
118372
+ type: string;
118373
+ };
118374
+ };
118375
+ type: string;
118376
+ };
118377
+ exclude: {
118378
+ default: boolean;
118379
+ description: string;
118380
+ type: string;
118381
+ };
118382
+ exclude_reservation_management: {
118383
+ default: boolean;
118384
+ description: string;
118385
+ type: string;
118386
+ };
118387
+ exclude_reservation_technical_details: {
118388
+ default: boolean;
118389
+ description: string;
118390
+ type: string;
118391
+ };
118392
+ exclude_staff_management: {
118393
+ default: boolean;
118394
+ description: string;
118395
+ type: string;
118396
+ };
118397
+ };
118398
+ type: string;
118399
+ };
118400
+ manage_devices: {
118401
+ default: {};
118402
+ description: string;
118403
+ properties: {
118404
+ exclude: {
118405
+ default: boolean;
118406
+ description: string;
118407
+ type: string;
118408
+ };
118409
+ };
118410
+ type: string;
118411
+ };
118412
+ organize: {
118413
+ default: {};
118414
+ description: string;
118415
+ properties: {
118416
+ exclude: {
118417
+ default: boolean;
118418
+ description: string;
118419
+ type: string;
118420
+ };
118421
+ };
118422
+ type: string;
118423
+ };
118424
+ };
118425
+ type: string;
118426
+ };
118427
+ is_embedded: {
118428
+ default: boolean;
118429
+ description: string;
118430
+ type: string;
118431
+ };
118432
+ landing_page: {
118433
+ description: string;
118434
+ properties: {
118435
+ manage: {
118436
+ oneOf: ({
118437
+ oneOf: ({
118438
+ properties: {
118439
+ space_key: {
118440
+ type: string;
118441
+ };
118442
+ property_key?: never;
118443
+ room_key?: never;
118444
+ common_area_key?: never;
118445
+ unit_key?: never;
118446
+ facility_key?: never;
118447
+ building_key?: never;
118448
+ listing_key?: never;
118449
+ property_listing_key?: never;
118450
+ site_key?: never;
118451
+ };
118452
+ required: string[];
118453
+ type: string;
118454
+ } | {
118455
+ properties: {
118456
+ property_key: {
118457
+ type: string;
118458
+ };
118459
+ space_key?: never;
118460
+ room_key?: never;
118461
+ common_area_key?: never;
118462
+ unit_key?: never;
118463
+ facility_key?: never;
118464
+ building_key?: never;
118465
+ listing_key?: never;
118466
+ property_listing_key?: never;
118467
+ site_key?: never;
118468
+ };
118469
+ required: string[];
118470
+ type: string;
118471
+ } | {
118472
+ properties: {
118473
+ room_key: {
118474
+ type: string;
118475
+ };
118476
+ space_key?: never;
118477
+ property_key?: never;
118478
+ common_area_key?: never;
118479
+ unit_key?: never;
118480
+ facility_key?: never;
118481
+ building_key?: never;
118482
+ listing_key?: never;
118483
+ property_listing_key?: never;
118484
+ site_key?: never;
118485
+ };
118486
+ required: string[];
118487
+ type: string;
118488
+ } | {
118489
+ properties: {
118490
+ common_area_key: {
118491
+ type: string;
118492
+ };
118493
+ space_key?: never;
118494
+ property_key?: never;
118495
+ room_key?: never;
118496
+ unit_key?: never;
118497
+ facility_key?: never;
118498
+ building_key?: never;
118499
+ listing_key?: never;
118500
+ property_listing_key?: never;
118501
+ site_key?: never;
118502
+ };
118503
+ required: string[];
118504
+ type: string;
118505
+ } | {
118506
+ properties: {
118507
+ unit_key: {
118508
+ type: string;
118509
+ };
118510
+ space_key?: never;
118511
+ property_key?: never;
118512
+ room_key?: never;
118513
+ common_area_key?: never;
118514
+ facility_key?: never;
118515
+ building_key?: never;
118516
+ listing_key?: never;
118517
+ property_listing_key?: never;
118518
+ site_key?: never;
118519
+ };
118520
+ required: string[];
118521
+ type: string;
118522
+ } | {
118523
+ properties: {
118524
+ facility_key: {
118525
+ type: string;
118526
+ };
118527
+ space_key?: never;
118528
+ property_key?: never;
118529
+ room_key?: never;
118530
+ common_area_key?: never;
118531
+ unit_key?: never;
118532
+ building_key?: never;
118533
+ listing_key?: never;
118534
+ property_listing_key?: never;
118535
+ site_key?: never;
118536
+ };
118537
+ required: string[];
118538
+ type: string;
118539
+ } | {
118540
+ properties: {
118541
+ building_key: {
118542
+ type: string;
118543
+ };
118544
+ space_key?: never;
118545
+ property_key?: never;
118546
+ room_key?: never;
118547
+ common_area_key?: never;
118548
+ unit_key?: never;
118549
+ facility_key?: never;
118550
+ listing_key?: never;
118551
+ property_listing_key?: never;
118552
+ site_key?: never;
118553
+ };
118554
+ required: string[];
118555
+ type: string;
118556
+ } | {
118557
+ properties: {
118558
+ listing_key: {
118559
+ type: string;
118560
+ };
118561
+ space_key?: never;
118562
+ property_key?: never;
118563
+ room_key?: never;
118564
+ common_area_key?: never;
118565
+ unit_key?: never;
118566
+ facility_key?: never;
118567
+ building_key?: never;
118568
+ property_listing_key?: never;
118569
+ site_key?: never;
118570
+ };
118571
+ required: string[];
118572
+ type: string;
118573
+ } | {
118574
+ properties: {
118575
+ property_listing_key: {
118576
+ type: string;
118577
+ };
118578
+ space_key?: never;
118579
+ property_key?: never;
118580
+ room_key?: never;
118581
+ common_area_key?: never;
118582
+ unit_key?: never;
118583
+ facility_key?: never;
118584
+ building_key?: never;
118585
+ listing_key?: never;
118586
+ site_key?: never;
118587
+ };
118588
+ required: string[];
118589
+ type: string;
118590
+ } | {
118591
+ properties: {
118592
+ site_key: {
118593
+ type: string;
118594
+ };
118595
+ space_key?: never;
118596
+ property_key?: never;
118597
+ room_key?: never;
118598
+ common_area_key?: never;
118599
+ unit_key?: never;
118600
+ facility_key?: never;
118601
+ building_key?: never;
118602
+ listing_key?: never;
118603
+ property_listing_key?: never;
118604
+ };
118605
+ required: string[];
118606
+ type: string;
118607
+ })[];
118608
+ } | {
118609
+ oneOf: ({
118610
+ properties: {
118611
+ reservation_key: {
118612
+ type: string;
118613
+ };
118614
+ booking_key?: never;
118615
+ access_grant_key?: never;
118616
+ };
118617
+ required: string[];
118618
+ type: string;
118619
+ } | {
118620
+ properties: {
118621
+ booking_key: {
118622
+ type: string;
118623
+ };
118624
+ reservation_key?: never;
118625
+ access_grant_key?: never;
118626
+ };
118627
+ required: string[];
118628
+ type: string;
118629
+ } | {
118630
+ properties: {
118631
+ access_grant_key: {
118632
+ type: string;
118633
+ };
118634
+ reservation_key?: never;
118635
+ booking_key?: never;
118636
+ };
118637
+ required: string[];
118638
+ type: string;
118639
+ })[];
118640
+ })[];
118641
+ };
118642
+ };
118643
+ type: string;
118644
+ };
118645
+ locale: {
118646
+ description: string;
118647
+ enum: string[];
118648
+ type: string;
118649
+ };
118650
+ navigation_mode: {
118651
+ default: string;
118652
+ description: string;
118653
+ enum: string[];
118654
+ type: string;
118655
+ };
118656
+ };
118657
+ type: string;
118658
+ };
118659
+ };
118660
+ required: string[];
118661
+ type: string;
118662
+ };
118663
+ };
118664
+ };
118665
+ };
118666
+ responses: {
118667
+ 200: {
118668
+ content: {
118669
+ 'application/json': {
118670
+ schema: {
118671
+ properties: {
118672
+ ok: {
118673
+ type: string;
118674
+ };
118675
+ };
118676
+ required: string[];
118677
+ type: string;
118678
+ };
118679
+ };
118680
+ };
118681
+ description: string;
118682
+ };
118683
+ 400: {
118684
+ description: string;
118685
+ };
118686
+ 401: {
118687
+ description: string;
118688
+ };
118689
+ };
118690
+ security: ({
118691
+ console_session_with_workspace: never[];
118692
+ api_key?: never;
118693
+ } | {
118694
+ api_key: never[];
118695
+ console_session_with_workspace?: never;
118696
+ })[];
118697
+ summary: string;
118698
+ tags: never[];
118699
+ 'x-fern-sdk-group-name': string[];
118700
+ 'x-fern-sdk-method-name': string;
118701
+ 'x-response-key': null;
118702
+ 'x-title': string;
118703
+ 'x-undocumented': string;
118704
+ };
118705
+ post: {
118706
+ description: string;
118707
+ operationId: string;
118708
+ requestBody: {
118709
+ content: {
118710
+ 'application/json': {
118711
+ schema: {
118712
+ properties: {
118713
+ customer_portal_id: {
118714
+ description: string;
118715
+ format: string;
118716
+ type: string;
118717
+ };
118718
+ portal_configuration: {
118719
+ description: string;
118720
+ properties: {
118721
+ customer_resources_filters: {
118722
+ description: string;
118723
+ items: {
118724
+ properties: {
118725
+ field: {
118726
+ description: string;
118727
+ pattern: string;
118728
+ type: string;
118729
+ };
118730
+ operation: {
118731
+ description: string;
118732
+ enum: string[];
118733
+ type: string;
118734
+ };
118735
+ value: {
118736
+ description: string;
118737
+ oneOf: {
118738
+ type: string;
118739
+ }[];
118740
+ };
118741
+ };
118742
+ required: string[];
118743
+ type: string;
118744
+ };
118745
+ type: string;
118746
+ };
118747
+ customization_profile_id: {
118748
+ description: string;
118749
+ format: string;
118750
+ type: string;
118751
+ };
118752
+ deep_link: {
118753
+ description: string;
118754
+ properties: {
118755
+ resource_key: {
118756
+ type: string;
118757
+ };
118758
+ resource_type: {
118759
+ enum: string[];
118760
+ type: string;
118761
+ };
118762
+ };
118763
+ required: string[];
118764
+ type: string;
118765
+ 'x-undocumented': string;
118766
+ };
118767
+ exclude_locale_picker: {
118768
+ default: boolean;
118769
+ description: string;
118770
+ type: string;
118771
+ };
118772
+ features: {
118773
+ default: {};
118774
+ properties: {
118775
+ configure: {
118776
+ default: {};
118777
+ description: string;
118778
+ properties: {
118779
+ allow_access_automation_rule_customization: {
118780
+ default: boolean;
118781
+ description: string;
118782
+ type: string;
118783
+ };
118784
+ allow_climate_automation_rule_customization: {
118785
+ default: boolean;
118786
+ description: string;
118787
+ type: string;
118788
+ };
118789
+ allow_instant_key_customization: {
118790
+ default: boolean;
118791
+ description: string;
118792
+ type: string;
118793
+ };
118794
+ exclude: {
118795
+ default: boolean;
118796
+ description: string;
118797
+ type: string;
118798
+ };
118799
+ };
118800
+ type: string;
118801
+ };
118802
+ connect: {
118803
+ default: {};
118804
+ description: string;
118805
+ properties: {
118806
+ accepted_providers: {
118807
+ description: string;
118808
+ items: {
118809
+ type: string;
118810
+ };
118811
+ type: string;
118812
+ };
118813
+ exclude: {
118814
+ default: boolean;
118815
+ description: string;
118816
+ type: string;
118817
+ };
118818
+ excluded_providers: {
118819
+ description: string;
118820
+ items: {
118821
+ type: string;
118822
+ };
118823
+ type: string;
118824
+ };
118825
+ };
118826
+ type: string;
118827
+ };
118828
+ manage: {
118829
+ default: {};
118830
+ description: string;
118831
+ properties: {
118832
+ events: {
118833
+ description: string;
118834
+ properties: {
118835
+ allowed_events: {
118836
+ description: string;
118837
+ items: {
118838
+ type: string;
118839
+ };
118840
+ type: string;
118841
+ };
118842
+ default_events: {
118843
+ description: string;
118844
+ items: {
118845
+ type: string;
118846
+ };
118847
+ type: string;
118848
+ };
118849
+ };
118850
+ type: string;
118851
+ };
118852
+ exclude: {
118853
+ default: boolean;
118854
+ description: string;
118855
+ type: string;
118856
+ };
118857
+ exclude_reservation_management: {
118858
+ default: boolean;
118859
+ description: string;
118860
+ type: string;
118861
+ };
118862
+ exclude_reservation_technical_details: {
118863
+ default: boolean;
118864
+ description: string;
118865
+ type: string;
118866
+ };
118867
+ exclude_staff_management: {
118868
+ default: boolean;
118869
+ description: string;
118870
+ type: string;
118871
+ };
118872
+ };
118873
+ type: string;
118874
+ };
118875
+ manage_devices: {
118876
+ default: {};
118877
+ description: string;
118878
+ properties: {
118879
+ exclude: {
118880
+ default: boolean;
118881
+ description: string;
118882
+ type: string;
118883
+ };
118884
+ };
118885
+ type: string;
118886
+ };
118887
+ organize: {
118888
+ default: {};
118889
+ description: string;
118890
+ properties: {
118891
+ exclude: {
118892
+ default: boolean;
118893
+ description: string;
118894
+ type: string;
118895
+ };
118896
+ };
118897
+ type: string;
118898
+ };
118899
+ };
118900
+ type: string;
118901
+ };
118902
+ is_embedded: {
118903
+ default: boolean;
118904
+ description: string;
118905
+ type: string;
118906
+ };
118907
+ landing_page: {
118908
+ description: string;
118909
+ properties: {
118910
+ manage: {
118911
+ oneOf: ({
118912
+ oneOf: ({
118913
+ properties: {
118914
+ space_key: {
118915
+ type: string;
118916
+ };
118917
+ property_key?: never;
118918
+ room_key?: never;
118919
+ common_area_key?: never;
118920
+ unit_key?: never;
118921
+ facility_key?: never;
118922
+ building_key?: never;
118923
+ listing_key?: never;
118924
+ property_listing_key?: never;
118925
+ site_key?: never;
118926
+ };
118927
+ required: string[];
118928
+ type: string;
118929
+ } | {
118930
+ properties: {
118931
+ property_key: {
118932
+ type: string;
118933
+ };
118934
+ space_key?: never;
118935
+ room_key?: never;
118936
+ common_area_key?: never;
118937
+ unit_key?: never;
118938
+ facility_key?: never;
118939
+ building_key?: never;
118940
+ listing_key?: never;
118941
+ property_listing_key?: never;
118942
+ site_key?: never;
118943
+ };
118944
+ required: string[];
118945
+ type: string;
118946
+ } | {
118947
+ properties: {
118948
+ room_key: {
118949
+ type: string;
118950
+ };
118951
+ space_key?: never;
118952
+ property_key?: never;
118953
+ common_area_key?: never;
118954
+ unit_key?: never;
118955
+ facility_key?: never;
118956
+ building_key?: never;
118957
+ listing_key?: never;
118958
+ property_listing_key?: never;
118959
+ site_key?: never;
118960
+ };
118961
+ required: string[];
118962
+ type: string;
118963
+ } | {
118964
+ properties: {
118965
+ common_area_key: {
118966
+ type: string;
118967
+ };
118968
+ space_key?: never;
118969
+ property_key?: never;
118970
+ room_key?: never;
118971
+ unit_key?: never;
118972
+ facility_key?: never;
118973
+ building_key?: never;
118974
+ listing_key?: never;
118975
+ property_listing_key?: never;
118976
+ site_key?: never;
118977
+ };
118978
+ required: string[];
118979
+ type: string;
118980
+ } | {
118981
+ properties: {
118982
+ unit_key: {
118983
+ type: string;
118984
+ };
118985
+ space_key?: never;
118986
+ property_key?: never;
118987
+ room_key?: never;
118988
+ common_area_key?: never;
118989
+ facility_key?: never;
118990
+ building_key?: never;
118991
+ listing_key?: never;
118992
+ property_listing_key?: never;
118993
+ site_key?: never;
118994
+ };
118995
+ required: string[];
118996
+ type: string;
118997
+ } | {
118998
+ properties: {
118999
+ facility_key: {
119000
+ type: string;
119001
+ };
119002
+ space_key?: never;
119003
+ property_key?: never;
119004
+ room_key?: never;
119005
+ common_area_key?: never;
119006
+ unit_key?: never;
119007
+ building_key?: never;
119008
+ listing_key?: never;
119009
+ property_listing_key?: never;
119010
+ site_key?: never;
119011
+ };
119012
+ required: string[];
119013
+ type: string;
119014
+ } | {
119015
+ properties: {
119016
+ building_key: {
119017
+ type: string;
119018
+ };
119019
+ space_key?: never;
119020
+ property_key?: never;
119021
+ room_key?: never;
119022
+ common_area_key?: never;
119023
+ unit_key?: never;
119024
+ facility_key?: never;
119025
+ listing_key?: never;
119026
+ property_listing_key?: never;
119027
+ site_key?: never;
119028
+ };
119029
+ required: string[];
119030
+ type: string;
119031
+ } | {
119032
+ properties: {
119033
+ listing_key: {
119034
+ type: string;
119035
+ };
119036
+ space_key?: never;
119037
+ property_key?: never;
119038
+ room_key?: never;
119039
+ common_area_key?: never;
119040
+ unit_key?: never;
119041
+ facility_key?: never;
119042
+ building_key?: never;
119043
+ property_listing_key?: never;
119044
+ site_key?: never;
119045
+ };
119046
+ required: string[];
119047
+ type: string;
119048
+ } | {
119049
+ properties: {
119050
+ property_listing_key: {
119051
+ type: string;
119052
+ };
119053
+ space_key?: never;
119054
+ property_key?: never;
119055
+ room_key?: never;
119056
+ common_area_key?: never;
119057
+ unit_key?: never;
119058
+ facility_key?: never;
119059
+ building_key?: never;
119060
+ listing_key?: never;
119061
+ site_key?: never;
119062
+ };
119063
+ required: string[];
119064
+ type: string;
119065
+ } | {
119066
+ properties: {
119067
+ site_key: {
119068
+ type: string;
119069
+ };
119070
+ space_key?: never;
119071
+ property_key?: never;
119072
+ room_key?: never;
119073
+ common_area_key?: never;
119074
+ unit_key?: never;
119075
+ facility_key?: never;
119076
+ building_key?: never;
119077
+ listing_key?: never;
119078
+ property_listing_key?: never;
119079
+ };
119080
+ required: string[];
119081
+ type: string;
119082
+ })[];
119083
+ } | {
119084
+ oneOf: ({
119085
+ properties: {
119086
+ reservation_key: {
119087
+ type: string;
119088
+ };
119089
+ booking_key?: never;
119090
+ access_grant_key?: never;
119091
+ };
119092
+ required: string[];
119093
+ type: string;
119094
+ } | {
119095
+ properties: {
119096
+ booking_key: {
119097
+ type: string;
119098
+ };
119099
+ reservation_key?: never;
119100
+ access_grant_key?: never;
119101
+ };
119102
+ required: string[];
119103
+ type: string;
119104
+ } | {
119105
+ properties: {
119106
+ access_grant_key: {
119107
+ type: string;
119108
+ };
119109
+ reservation_key?: never;
119110
+ booking_key?: never;
119111
+ };
119112
+ required: string[];
119113
+ type: string;
119114
+ })[];
119115
+ })[];
119116
+ };
119117
+ };
119118
+ type: string;
119119
+ };
119120
+ locale: {
119121
+ description: string;
119122
+ enum: string[];
119123
+ type: string;
119124
+ };
119125
+ navigation_mode: {
119126
+ default: string;
119127
+ description: string;
119128
+ enum: string[];
119129
+ type: string;
119130
+ };
119131
+ };
119132
+ type: string;
119133
+ };
119134
+ };
119135
+ required: string[];
119136
+ type: string;
119137
+ };
119138
+ };
119139
+ };
119140
+ };
119141
+ responses: {
119142
+ 200: {
119143
+ content: {
119144
+ 'application/json': {
119145
+ schema: {
119146
+ properties: {
119147
+ ok: {
119148
+ type: string;
119149
+ };
119150
+ };
119151
+ required: string[];
119152
+ type: string;
119153
+ };
119154
+ };
119155
+ };
119156
+ description: string;
119157
+ };
119158
+ 400: {
119159
+ description: string;
119160
+ };
119161
+ 401: {
119162
+ description: string;
119163
+ };
119164
+ };
119165
+ security: ({
119166
+ console_session_with_workspace: never[];
119167
+ api_key?: never;
119168
+ } | {
119169
+ api_key: never[];
119170
+ console_session_with_workspace?: never;
119171
+ })[];
119172
+ summary: string;
119173
+ tags: never[];
119174
+ 'x-fern-sdk-group-name': string[];
119175
+ 'x-fern-sdk-method-name': string;
119176
+ 'x-response-key': null;
119177
+ 'x-title': string;
119178
+ 'x-undocumented': string;
119179
+ };
119180
+ };
118193
119181
  '/seam/customer/v1/reservations/get': {
118194
119182
  get: {
118195
119183
  description: string;
@@ -134674,6 +135662,11 @@ type Routes = {
134674
135662
  type: 'bridge_disconnected';
134675
135663
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
134676
135664
  message: string;
135665
+ } | {
135666
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
135667
+ type: 'encoding_interrupted';
135668
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
135669
+ message: string;
134677
135670
  };
134678
135671
  } | {
134679
135672
  /** ID of the action attempt. */
@@ -137072,6 +138065,11 @@ type Routes = {
137072
138065
  type: 'bridge_disconnected';
137073
138066
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
137074
138067
  message: string;
138068
+ } | {
138069
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
138070
+ type: 'encoding_interrupted';
138071
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
138072
+ message: string;
137075
138073
  };
137076
138074
  } | {
137077
138075
  /** ID of the action attempt. */
@@ -141165,6 +142163,11 @@ type Routes = {
141165
142163
  type: 'bridge_disconnected';
141166
142164
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
141167
142165
  message: string;
142166
+ } | {
142167
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
142168
+ type: 'encoding_interrupted';
142169
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
142170
+ message: string;
141168
142171
  };
141169
142172
  } | {
141170
142173
  /** ID of the action attempt. */
@@ -143599,6 +144602,11 @@ type Routes = {
143599
144602
  type: 'bridge_disconnected';
143600
144603
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
143601
144604
  message: string;
144605
+ } | {
144606
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
144607
+ type: 'encoding_interrupted';
144608
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
144609
+ message: string;
143602
144610
  };
143603
144611
  } | {
143604
144612
  /** ID of the action attempt. */
@@ -144215,8 +145223,8 @@ type Routes = {
144215
145223
  /** Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted. */
144216
145224
  device_ids?: string[];
144217
145225
  requested_access_methods: {
144218
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
144219
- mode: 'code' | 'card' | 'mobile_key';
145226
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
145227
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
144220
145228
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
144221
145229
  code?: string | undefined;
144222
145230
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -144252,8 +145260,8 @@ type Routes = {
144252
145260
  requested_access_methods: {
144253
145261
  /** Display name of the access method. */
144254
145262
  display_name: string;
144255
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
144256
- mode: 'code' | 'card' | 'mobile_key';
145263
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
145264
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
144257
145265
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
144258
145266
  code?: string | undefined;
144259
145267
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -144440,8 +145448,8 @@ type Routes = {
144440
145448
  requested_access_methods: {
144441
145449
  /** Display name of the access method. */
144442
145450
  display_name: string;
144443
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
144444
- mode: 'code' | 'card' | 'mobile_key';
145451
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
145452
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
144445
145453
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
144446
145454
  code?: string | undefined;
144447
145455
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -146064,10 +147072,10 @@ type Routes = {
146064
147072
  can_unlock_with_card?: boolean | undefined;
146065
147073
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
146066
147074
  can_unlock_with_code?: boolean | undefined;
147075
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
147076
+ can_unlock_with_cloud_key?: boolean | undefined;
146067
147077
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
146068
147078
  can_belong_to_reservation?: boolean | undefined;
146069
- /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
146070
- can_unlock_with_cloud_key?: boolean | undefined;
146071
147079
  }[] | undefined;
146072
147080
  connected_accounts?: {
146073
147081
  /** ID of the connected account. */
@@ -146534,8 +147542,8 @@ type Routes = {
146534
147542
  access_method_id: string;
146535
147543
  /** Display name of the access method. */
146536
147544
  display_name: string;
146537
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
146538
- mode: 'code' | 'card' | 'mobile_key';
147545
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
147546
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
146539
147547
  /** Date and time at which the access method was created. */
146540
147548
  created_at: string;
146541
147549
  /** Date and time at which the access method was issued. */
@@ -146693,8 +147701,8 @@ type Routes = {
146693
147701
  requested_access_methods: {
146694
147702
  /** Display name of the access method. */
146695
147703
  display_name: string;
146696
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
146697
- mode: 'code' | 'card' | 'mobile_key';
147704
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
147705
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
146698
147706
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
146699
147707
  code?: string | undefined;
146700
147708
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -146852,8 +147860,8 @@ type Routes = {
146852
147860
  access_grant_id: string;
146853
147861
  /** Array of requested access methods to add to the access grant. */
146854
147862
  requested_access_methods: {
146855
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
146856
- mode: 'code' | 'card' | 'mobile_key';
147863
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
147864
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
146857
147865
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
146858
147866
  code?: string | undefined;
146859
147867
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -146883,8 +147891,8 @@ type Routes = {
146883
147891
  requested_access_methods: {
146884
147892
  /** Display name of the access method. */
146885
147893
  display_name: string;
146886
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
146887
- mode: 'code' | 'card' | 'mobile_key';
147894
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
147895
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
146888
147896
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
146889
147897
  code?: string | undefined;
146890
147898
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -147051,8 +148059,8 @@ type Routes = {
147051
148059
  requested_access_methods: {
147052
148060
  /** Display name of the access method. */
147053
148061
  display_name: string;
147054
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
147055
- mode: 'code' | 'card' | 'mobile_key';
148062
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
148063
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
147056
148064
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
147057
148065
  code?: string | undefined;
147058
148066
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -147224,8 +148232,8 @@ type Routes = {
147224
148232
  requested_access_methods: {
147225
148233
  /** Display name of the access method. */
147226
148234
  display_name: string;
147227
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
147228
- mode: 'code' | 'card' | 'mobile_key';
148235
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
148236
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
147229
148237
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
147230
148238
  code?: string | undefined;
147231
148239
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -148214,6 +149222,11 @@ type Routes = {
148214
149222
  type: 'bridge_disconnected';
148215
149223
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
148216
149224
  message: string;
149225
+ } | {
149226
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
149227
+ type: 'encoding_interrupted';
149228
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
149229
+ message: string;
148217
149230
  };
148218
149231
  } | {
148219
149232
  /** ID of the action attempt. */
@@ -148775,8 +149788,8 @@ type Routes = {
148775
149788
  access_method_id: string;
148776
149789
  /** Display name of the access method. */
148777
149790
  display_name: string;
148778
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
148779
- mode: 'code' | 'card' | 'mobile_key';
149791
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
149792
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
148780
149793
  /** Date and time at which the access method was created. */
148781
149794
  created_at: string;
148782
149795
  /** Date and time at which the access method was issued. */
@@ -150363,10 +151376,10 @@ type Routes = {
150363
151376
  can_unlock_with_card?: boolean | undefined;
150364
151377
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
150365
151378
  can_unlock_with_code?: boolean | undefined;
151379
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
151380
+ can_unlock_with_cloud_key?: boolean | undefined;
150366
151381
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
150367
151382
  can_belong_to_reservation?: boolean | undefined;
150368
- /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
150369
- can_unlock_with_cloud_key?: boolean | undefined;
150370
151383
  }[] | undefined;
150371
151384
  access_grants?: {
150372
151385
  /** ID of the Seam workspace associated with the Access Grant. */
@@ -150388,8 +151401,8 @@ type Routes = {
150388
151401
  requested_access_methods: {
150389
151402
  /** Display name of the access method. */
150390
151403
  display_name: string;
150391
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
150392
- mode: 'code' | 'card' | 'mobile_key';
151404
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
151405
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
150393
151406
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
150394
151407
  code?: string | undefined;
150395
151408
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -150532,8 +151545,8 @@ type Routes = {
150532
151545
  access_method_id: string;
150533
151546
  /** Display name of the access method. */
150534
151547
  display_name: string;
150535
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
150536
- mode: 'code' | 'card' | 'mobile_key';
151548
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
151549
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
150537
151550
  /** Date and time at which the access method was created. */
150538
151551
  created_at: string;
150539
151552
  /** Date and time at which the access method was issued. */
@@ -150850,8 +151863,8 @@ type Routes = {
150850
151863
  access_method_id: string;
150851
151864
  /** Display name of the access method. */
150852
151865
  display_name: string;
150853
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
150854
- mode: 'code' | 'card' | 'mobile_key';
151866
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
151867
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
150855
151868
  /** Date and time at which the access method was created. */
150856
151869
  created_at: string;
150857
151870
  /** Date and time at which the access method was issued. */
@@ -150975,8 +151988,8 @@ type Routes = {
150975
151988
  access_method_id: string;
150976
151989
  /** Display name of the access method. */
150977
151990
  display_name: string;
150978
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
150979
- mode: 'code' | 'card' | 'mobile_key';
151991
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
151992
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
150980
151993
  /** Date and time at which the access method was created. */
150981
151994
  created_at: string;
150982
151995
  /** Date and time at which the access method was issued. */
@@ -151099,8 +152112,8 @@ type Routes = {
151099
152112
  access_method_id: string;
151100
152113
  /** Display name of the access method. */
151101
152114
  display_name: string;
151102
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
151103
- mode: 'code' | 'card' | 'mobile_key';
152115
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
152116
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
151104
152117
  /** Date and time at which the access method was created. */
151105
152118
  created_at: string;
151106
152119
  /** Date and time at which the access method was issued. */
@@ -151715,10 +152728,10 @@ type Routes = {
151715
152728
  can_unlock_with_card?: boolean | undefined;
151716
152729
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
151717
152730
  can_unlock_with_code?: boolean | undefined;
152731
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
152732
+ can_unlock_with_cloud_key?: boolean | undefined;
151718
152733
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
151719
152734
  can_belong_to_reservation?: boolean | undefined;
151720
- /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
151721
- can_unlock_with_cloud_key?: boolean | undefined;
151722
152735
  }[];
151723
152736
  };
151724
152737
  maxDuration: undefined;
@@ -153375,10 +154388,10 @@ type Routes = {
153375
154388
  can_unlock_with_card?: boolean | undefined;
153376
154389
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
153377
154390
  can_unlock_with_code?: boolean | undefined;
154391
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
154392
+ can_unlock_with_cloud_key?: boolean | undefined;
153378
154393
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
153379
154394
  can_belong_to_reservation?: boolean | undefined;
153380
- /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
153381
- can_unlock_with_cloud_key?: boolean | undefined;
153382
154395
  }[];
153383
154396
  };
153384
154397
  maxDuration: undefined;
@@ -154788,6 +155801,11 @@ type Routes = {
154788
155801
  type: 'bridge_disconnected';
154789
155802
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
154790
155803
  message: string;
155804
+ } | {
155805
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
155806
+ type: 'encoding_interrupted';
155807
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
155808
+ message: string;
154791
155809
  };
154792
155810
  } | {
154793
155811
  /** ID of the action attempt. */
@@ -156226,6 +157244,11 @@ type Routes = {
156226
157244
  type: 'bridge_disconnected';
156227
157245
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
156228
157246
  message: string;
157247
+ } | {
157248
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
157249
+ type: 'encoding_interrupted';
157250
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
157251
+ message: string;
156229
157252
  };
156230
157253
  } | {
156231
157254
  /** ID of the action attempt. */
@@ -156776,7 +157799,7 @@ type Routes = {
156776
157799
  /** ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. */
156777
157800
  acs_encoder_id: string;
156778
157801
  /** Code of the error to simulate. */
156779
- error_code?: 'no_credential_on_encoder';
157802
+ error_code?: 'no_credential_on_encoder' | 'encoding_interrupted';
156780
157803
  } | {
156781
157804
  /** ID of the `acs_encoder` that will be used in the next request to encode the `acs_credential`. */
156782
157805
  acs_encoder_id: string;
@@ -156991,191 +158014,191 @@ type Routes = {
156991
158014
  can_unlock_with_card?: boolean | undefined;
156992
158015
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
156993
158016
  can_unlock_with_code?: boolean | undefined;
156994
- /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
156995
- can_belong_to_reservation?: boolean | undefined;
156996
- /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
158017
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
158018
+ can_unlock_with_cloud_key?: boolean | undefined;
158019
+ /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
158020
+ can_belong_to_reservation?: boolean | undefined;
158021
+ };
158022
+ };
158023
+ maxDuration: undefined;
158024
+ };
158025
+ '/acs/entrances/grant_access': {
158026
+ route: '/acs/entrances/grant_access';
158027
+ method: 'POST';
158028
+ queryParams: {};
158029
+ jsonBody: {
158030
+ /** ID of the entrance to which you want to grant an access system user access. */
158031
+ acs_entrance_id: string;
158032
+ /** ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
158033
+ user_identity_id?: string | undefined;
158034
+ /** ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. */
158035
+ acs_user_id?: string | undefined;
158036
+ };
158037
+ commonParams: {};
158038
+ formData: {};
158039
+ jsonResponse: {};
158040
+ maxDuration: undefined;
158041
+ };
158042
+ '/acs/entrances/list': {
158043
+ route: '/acs/entrances/list';
158044
+ method: 'GET' | 'POST';
158045
+ queryParams: {};
158046
+ jsonBody: {};
158047
+ commonParams: {
158048
+ /** Customer key for which you want to list entrances. */
158049
+ customer_key?: string | undefined;
158050
+ /** ID of the access system for which you want to retrieve all entrances. */
158051
+ acs_system_id?: string | undefined;
158052
+ /** ID of the credential for which you want to retrieve all entrances. */
158053
+ acs_credential_id?: string | undefined;
158054
+ /**
158055
+ * @deprecated Use `space_id`.*/
158056
+ location_id?: (string | null) | undefined;
158057
+ /** ID of the space for which you want to list entrances. */
158058
+ space_id?: string | undefined;
158059
+ /** ID of the connected account for which you want to retrieve all entrances. */
158060
+ connected_account_id?: string | undefined;
158061
+ /** IDs of the entrances for which you want to retrieve all entrances. */
158062
+ acs_entrance_ids?: string[] | undefined;
158063
+ /** String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`. */
158064
+ search?: string | undefined;
158065
+ /** Maximum number of records to return per page. */
158066
+ limit?: number;
158067
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
158068
+ page_cursor?: (string | undefined) | null;
158069
+ };
158070
+ formData: {};
158071
+ jsonResponse: {
158072
+ acs_entrances: {
158073
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158074
+ acs_system_id: string;
158075
+ /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158076
+ acs_entrance_id: string;
158077
+ /** IDs of the spaces that the entrance is in. */
158078
+ space_ids: string[];
158079
+ /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
158080
+ created_at: string;
158081
+ /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158082
+ display_name: string;
158083
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158084
+ connected_account_id: string;
158085
+ /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158086
+ errors: {
158087
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
158088
+ error_code: string;
158089
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
158090
+ message: string;
158091
+ }[];
158092
+ /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158093
+ latch_metadata?: {
158094
+ /** Accessibility type in the Latch access system. */
158095
+ accessibility_type: string;
158096
+ /** Name of the door in the Latch access system. */
158097
+ door_name: string;
158098
+ /** Type of the door in the Latch access system. */
158099
+ door_type: string;
158100
+ /** Indicates whether the entrance is connected. */
158101
+ is_connected: boolean;
158102
+ } | undefined;
158103
+ /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158104
+ hotek_metadata?: {
158105
+ /** Room number of the entrance. */
158106
+ room_number?: string | undefined;
158107
+ /** Display name of the entrance. */
158108
+ common_area_number?: string | undefined;
158109
+ /** Display name of the entrance. */
158110
+ common_area_name?: string | undefined;
158111
+ } | undefined;
158112
+ /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158113
+ visionline_metadata?: {
158114
+ /** Name of the door in the Visionline access system. */
158115
+ door_name: string;
158116
+ /** Category of the door in the Visionline access system. */
158117
+ door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
158118
+ /** Profile for the door in the Visionline access system. */
158119
+ profiles?: {
158120
+ /** Door profile ID in the Visionline access system. */
158121
+ visionline_door_profile_id: string;
158122
+ /** Door profile type in the Visionline access system. */
158123
+ visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
158124
+ }[] | undefined;
158125
+ } | undefined;
158126
+ /** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158127
+ salto_ks_metadata?: {
158128
+ /** Name of the door in the Salto KS access system. */
158129
+ door_name: string;
158130
+ /** Locked state of the door in the Salto KS access system. */
158131
+ locked_state: string;
158132
+ /** Type of the lock in the Salto KS access system. */
158133
+ lock_type: string;
158134
+ /** Indicates whether the door access device is online. */
158135
+ online?: boolean | undefined;
158136
+ /** Battery level of the door access device. */
158137
+ battery_level: string;
158138
+ /** Indicates whether the door is left open. */
158139
+ left_open_alarm?: boolean | undefined;
158140
+ /** Indicates whether an intrusion alarm is active on the door. */
158141
+ intrusion_alarm?: boolean | undefined;
158142
+ /** Indicates whether privacy mode is enabled for the lock. */
158143
+ privacy_mode?: boolean | undefined;
158144
+ } | undefined;
158145
+ /** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158146
+ dormakaba_community_metadata?: {
158147
+ /** Type of access point profile in the dormakaba Community access system. */
158148
+ access_point_profile: string;
158149
+ } | undefined;
158150
+ /** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158151
+ assa_abloy_vostio_metadata?: {
158152
+ /** Type of the door in the Vostio access system. */
158153
+ door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
158154
+ /** Name of the door in the Vostio access system. */
158155
+ door_name: string;
158156
+ /** Number of the door in the Vostio access system. */
158157
+ door_number?: number | undefined;
158158
+ /** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
158159
+ stand_open?: boolean | undefined;
158160
+ /** PMS ID of the door in the Vostio access system. */
158161
+ pms_id?: string | undefined;
158162
+ } | undefined;
158163
+ /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158164
+ salto_space_metadata?: {
158165
+ /** Door ID in the Salto Space access system. */
158166
+ door_id?: string | undefined;
158167
+ /** Name of the door in the Salto Space access system. */
158168
+ door_name?: string | undefined;
158169
+ /** Description of the door in the Salto Space access system. */
158170
+ door_description?: string | undefined;
158171
+ /** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
158172
+ audit_on_keys?: boolean | undefined;
158173
+ /** Name of the room in the Salto Space access system. */
158174
+ room_name?: string | undefined;
158175
+ /** Description of the room in the Salto Space access system. */
158176
+ room_description?: string | undefined;
158177
+ } | undefined;
158178
+ /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158179
+ dormakaba_ambiance_metadata?: {
158180
+ /** Name of the access point in the dormakaba Ambiance access system. */
158181
+ access_point_name: string;
158182
+ } | undefined;
158183
+ /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
158184
+ brivo_metadata?: {
158185
+ /** ID of the access point in the Brivo access system. */
158186
+ access_point_id: string;
158187
+ /** ID of the site that the access point belongs to. */
158188
+ site_id: number;
158189
+ /** Name of the site that the access point belongs to. */
158190
+ site_name: string;
158191
+ } | undefined;
158192
+ /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
158193
+ can_unlock_with_mobile_key?: boolean | undefined;
158194
+ /** Indicates whether the ACS entrance can be unlocked with card credentials. */
158195
+ can_unlock_with_card?: boolean | undefined;
158196
+ /** Indicates whether the ACS entrance can be unlocked with pin codes. */
158197
+ can_unlock_with_code?: boolean | undefined;
158198
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
156997
158199
  can_unlock_with_cloud_key?: boolean | undefined;
156998
- };
156999
- };
157000
- maxDuration: undefined;
157001
- };
157002
- '/acs/entrances/grant_access': {
157003
- route: '/acs/entrances/grant_access';
157004
- method: 'POST';
157005
- queryParams: {};
157006
- jsonBody: {
157007
- /** ID of the entrance to which you want to grant an access system user access. */
157008
- acs_entrance_id: string;
157009
- /** ID of the user identity to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. If the ACS system contains an ACS user with the same `email_address` or `phone_number` as the user identity that you specify, they are linked, and the access group membership belongs to the ACS user. If the ACS system does not have a corresponding ACS user, one is created. */
157010
- user_identity_id?: string | undefined;
157011
- /** ID of the access system user to whom you want to grant access to an entrance. You can only provide one of acs_user_id or user_identity_id. */
157012
- acs_user_id?: string | undefined;
157013
- };
157014
- commonParams: {};
157015
- formData: {};
157016
- jsonResponse: {};
157017
- maxDuration: undefined;
157018
- };
157019
- '/acs/entrances/list': {
157020
- route: '/acs/entrances/list';
157021
- method: 'GET' | 'POST';
157022
- queryParams: {};
157023
- jsonBody: {};
157024
- commonParams: {
157025
- /** Customer key for which you want to list entrances. */
157026
- customer_key?: string | undefined;
157027
- /** ID of the access system for which you want to retrieve all entrances. */
157028
- acs_system_id?: string | undefined;
157029
- /** ID of the credential for which you want to retrieve all entrances. */
157030
- acs_credential_id?: string | undefined;
157031
- /**
157032
- * @deprecated Use `space_id`.*/
157033
- location_id?: (string | null) | undefined;
157034
- /** ID of the space for which you want to list entrances. */
157035
- space_id?: string | undefined;
157036
- /** ID of the connected account for which you want to retrieve all entrances. */
157037
- connected_account_id?: string | undefined;
157038
- /** IDs of the entrances for which you want to retrieve all entrances. */
157039
- acs_entrance_ids?: string[] | undefined;
157040
- /** String for which to search. Filters returned entrances to include all records that satisfy a partial match using `display_name`. */
157041
- search?: string | undefined;
157042
- /** Maximum number of records to return per page. */
157043
- limit?: number;
157044
- /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
157045
- page_cursor?: (string | undefined) | null;
157046
- };
157047
- formData: {};
157048
- jsonResponse: {
157049
- acs_entrances: {
157050
- /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157051
- acs_system_id: string;
157052
- /** ID of the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157053
- acs_entrance_id: string;
157054
- /** IDs of the spaces that the entrance is in. */
157055
- space_ids: string[];
157056
- /** Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created. */
157057
- created_at: string;
157058
- /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157059
- display_name: string;
157060
- /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157061
- connected_account_id: string;
157062
- /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157063
- errors: {
157064
- /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
157065
- error_code: string;
157066
- /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
157067
- message: string;
157068
- }[];
157069
- /** Latch-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157070
- latch_metadata?: {
157071
- /** Accessibility type in the Latch access system. */
157072
- accessibility_type: string;
157073
- /** Name of the door in the Latch access system. */
157074
- door_name: string;
157075
- /** Type of the door in the Latch access system. */
157076
- door_type: string;
157077
- /** Indicates whether the entrance is connected. */
157078
- is_connected: boolean;
157079
- } | undefined;
157080
- /** Hotek-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157081
- hotek_metadata?: {
157082
- /** Room number of the entrance. */
157083
- room_number?: string | undefined;
157084
- /** Display name of the entrance. */
157085
- common_area_number?: string | undefined;
157086
- /** Display name of the entrance. */
157087
- common_area_name?: string | undefined;
157088
- } | undefined;
157089
- /** Visionline-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157090
- visionline_metadata?: {
157091
- /** Name of the door in the Visionline access system. */
157092
- door_name: string;
157093
- /** Category of the door in the Visionline access system. */
157094
- door_category: 'entrance' | 'guest' | 'elevator reader' | 'common' | 'common (PMS)';
157095
- /** Profile for the door in the Visionline access system. */
157096
- profiles?: {
157097
- /** Door profile ID in the Visionline access system. */
157098
- visionline_door_profile_id: string;
157099
- /** Door profile type in the Visionline access system. */
157100
- visionline_door_profile_type: 'BLE' | 'commonDoor' | 'touch';
157101
- }[] | undefined;
157102
- } | undefined;
157103
- /** Salto KS-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157104
- salto_ks_metadata?: {
157105
- /** Name of the door in the Salto KS access system. */
157106
- door_name: string;
157107
- /** Locked state of the door in the Salto KS access system. */
157108
- locked_state: string;
157109
- /** Type of the lock in the Salto KS access system. */
157110
- lock_type: string;
157111
- /** Indicates whether the door access device is online. */
157112
- online?: boolean | undefined;
157113
- /** Battery level of the door access device. */
157114
- battery_level: string;
157115
- /** Indicates whether the door is left open. */
157116
- left_open_alarm?: boolean | undefined;
157117
- /** Indicates whether an intrusion alarm is active on the door. */
157118
- intrusion_alarm?: boolean | undefined;
157119
- /** Indicates whether privacy mode is enabled for the lock. */
157120
- privacy_mode?: boolean | undefined;
157121
- } | undefined;
157122
- /** dormakaba Community-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157123
- dormakaba_community_metadata?: {
157124
- /** Type of access point profile in the dormakaba Community access system. */
157125
- access_point_profile: string;
157126
- } | undefined;
157127
- /** ASSA ABLOY Vostio-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157128
- assa_abloy_vostio_metadata?: {
157129
- /** Type of the door in the Vostio access system. */
157130
- door_type: 'CommonDoor' | 'EntranceDoor' | 'GuestDoor' | 'Elevator';
157131
- /** Name of the door in the Vostio access system. */
157132
- door_name: string;
157133
- /** Number of the door in the Vostio access system. */
157134
- door_number?: number | undefined;
157135
- /** Indicates whether keys are allowed to set the door in stand open mode in the Vostio access system. */
157136
- stand_open?: boolean | undefined;
157137
- /** PMS ID of the door in the Vostio access system. */
157138
- pms_id?: string | undefined;
157139
- } | undefined;
157140
- /** Salto Space-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157141
- salto_space_metadata?: {
157142
- /** Door ID in the Salto Space access system. */
157143
- door_id?: string | undefined;
157144
- /** Name of the door in the Salto Space access system. */
157145
- door_name?: string | undefined;
157146
- /** Description of the door in the Salto Space access system. */
157147
- door_description?: string | undefined;
157148
- /** Indicates whether AuditOnKeys is enabled for the door in the Salto Space access system. */
157149
- audit_on_keys?: boolean | undefined;
157150
- /** Name of the room in the Salto Space access system. */
157151
- room_name?: string | undefined;
157152
- /** Description of the room in the Salto Space access system. */
157153
- room_description?: string | undefined;
157154
- } | undefined;
157155
- /** dormakaba Ambiance-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157156
- dormakaba_ambiance_metadata?: {
157157
- /** Name of the access point in the dormakaba Ambiance access system. */
157158
- access_point_name: string;
157159
- } | undefined;
157160
- /** Brivo-specific metadata associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
157161
- brivo_metadata?: {
157162
- /** ID of the access point in the Brivo access system. */
157163
- access_point_id: string;
157164
- /** ID of the site that the access point belongs to. */
157165
- site_id: number;
157166
- /** Name of the site that the access point belongs to. */
157167
- site_name: string;
157168
- } | undefined;
157169
- /** Indicates whether the ACS entrance can be unlocked with mobile key credentials. */
157170
- can_unlock_with_mobile_key?: boolean | undefined;
157171
- /** Indicates whether the ACS entrance can be unlocked with card credentials. */
157172
- can_unlock_with_card?: boolean | undefined;
157173
- /** Indicates whether the ACS entrance can be unlocked with pin codes. */
157174
- can_unlock_with_code?: boolean | undefined;
157175
158200
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
157176
158201
  can_belong_to_reservation?: boolean | undefined;
157177
- /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
157178
- can_unlock_with_cloud_key?: boolean | undefined;
157179
158202
  }[];
157180
158203
  /** Information about the current page of results. */
157181
158204
  pagination: {
@@ -158126,6 +159149,11 @@ type Routes = {
158126
159149
  type: 'bridge_disconnected';
158127
159150
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
158128
159151
  message: string;
159152
+ } | {
159153
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
159154
+ type: 'encoding_interrupted';
159155
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
159156
+ message: string;
158129
159157
  };
158130
159158
  } | {
158131
159159
  /** ID of the action attempt. */
@@ -160086,10 +161114,10 @@ type Routes = {
160086
161114
  can_unlock_with_card?: boolean | undefined;
160087
161115
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
160088
161116
  can_unlock_with_code?: boolean | undefined;
161117
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
161118
+ can_unlock_with_cloud_key?: boolean | undefined;
160089
161119
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
160090
161120
  can_belong_to_reservation?: boolean | undefined;
160091
- /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
160092
- can_unlock_with_cloud_key?: boolean | undefined;
160093
161121
  }[];
160094
161122
  };
160095
161123
  maxDuration: undefined;
@@ -161493,6 +162521,11 @@ type Routes = {
161493
162521
  type: 'bridge_disconnected';
161494
162522
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
161495
162523
  message: string;
162524
+ } | {
162525
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
162526
+ type: 'encoding_interrupted';
162527
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
162528
+ message: string;
161496
162529
  };
161497
162530
  } | {
161498
162531
  /** ID of the action attempt. */
@@ -162824,6 +163857,11 @@ type Routes = {
162824
163857
  type: 'bridge_disconnected';
162825
163858
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
162826
163859
  message: string;
163860
+ } | {
163861
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
163862
+ type: 'encoding_interrupted';
163863
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
163864
+ message: string;
162827
163865
  };
162828
163866
  } | {
162829
163867
  /** ID of the action attempt. */
@@ -175676,6 +176714,11 @@ type Routes = {
175676
176714
  type: 'bridge_disconnected';
175677
176715
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
175678
176716
  message: string;
176717
+ } | {
176718
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
176719
+ type: 'encoding_interrupted';
176720
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
176721
+ message: string;
175679
176722
  };
175680
176723
  } | {
175681
176724
  /** ID of the action attempt. */
@@ -182353,6 +183396,11 @@ type Routes = {
182353
183396
  type: 'bridge_disconnected';
182354
183397
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
182355
183398
  message: string;
183399
+ } | {
183400
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
183401
+ type: 'encoding_interrupted';
183402
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
183403
+ message: string;
182356
183404
  };
182357
183405
  } | {
182358
183406
  /** ID of the action attempt. */
@@ -183685,6 +184733,11 @@ type Routes = {
183685
184733
  type: 'bridge_disconnected';
183686
184734
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
183687
184735
  message: string;
184736
+ } | {
184737
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
184738
+ type: 'encoding_interrupted';
184739
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
184740
+ message: string;
183688
184741
  };
183689
184742
  } | {
183690
184743
  /** ID of the action attempt. */
@@ -185015,6 +186068,11 @@ type Routes = {
185015
186068
  type: 'bridge_disconnected';
185016
186069
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
185017
186070
  message: string;
186071
+ } | {
186072
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
186073
+ type: 'encoding_interrupted';
186074
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
186075
+ message: string;
185018
186076
  };
185019
186077
  } | {
185020
186078
  /** ID of the action attempt. */
@@ -186347,6 +187405,11 @@ type Routes = {
186347
187405
  type: 'bridge_disconnected';
186348
187406
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
186349
187407
  message: string;
187408
+ } | {
187409
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
187410
+ type: 'encoding_interrupted';
187411
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
187412
+ message: string;
186350
187413
  };
186351
187414
  } | {
186352
187415
  /** ID of the action attempt. */
@@ -190378,6 +191441,11 @@ type Routes = {
190378
191441
  type: 'bridge_disconnected';
190379
191442
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
190380
191443
  message: string;
191444
+ } | {
191445
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
191446
+ type: 'encoding_interrupted';
191447
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
191448
+ message: string;
190381
191449
  };
190382
191450
  } | {
190383
191451
  /** ID of the action attempt. */
@@ -191729,6 +192797,11 @@ type Routes = {
191729
192797
  type: 'bridge_disconnected';
191730
192798
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
191731
192799
  message: string;
192800
+ } | {
192801
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
192802
+ type: 'encoding_interrupted';
192803
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
192804
+ message: string;
191732
192805
  };
191733
192806
  } | {
191734
192807
  /** ID of the action attempt. */
@@ -193136,6 +194209,11 @@ type Routes = {
193136
194209
  type: 'bridge_disconnected';
193137
194210
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
193138
194211
  message: string;
194212
+ } | {
194213
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
194214
+ type: 'encoding_interrupted';
194215
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
194216
+ message: string;
193139
194217
  };
193140
194218
  } | {
193141
194219
  /** ID of the action attempt. */
@@ -194492,8 +195570,8 @@ type Routes = {
194492
195570
  requested_access_methods: {
194493
195571
  /** Display name of the access method. */
194494
195572
  display_name: string;
194495
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
194496
- mode: 'code' | 'card' | 'mobile_key';
195573
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
195574
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
194497
195575
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
194498
195576
  code?: string | undefined;
194499
195577
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -195437,6 +196515,11 @@ type Routes = {
195437
196515
  type: 'bridge_disconnected';
195438
196516
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
195439
196517
  message: string;
196518
+ } | {
196519
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
196520
+ type: 'encoding_interrupted';
196521
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
196522
+ message: string;
195440
196523
  };
195441
196524
  } | {
195442
196525
  /** ID of the action attempt. */
@@ -199606,6 +200689,129 @@ type Routes = {
199606
200689
  };
199607
200690
  maxDuration: undefined;
199608
200691
  };
200692
+ '/seam/customer/v1/portals/update': {
200693
+ route: '/seam/customer/v1/portals/update';
200694
+ method: 'PATCH' | 'POST';
200695
+ queryParams: {};
200696
+ jsonBody: {
200697
+ /** ID of the customer portal to update. */
200698
+ customer_portal_id: string;
200699
+ /** Partial portal configuration to merge with the existing configuration. */
200700
+ portal_configuration: {
200701
+ features?: {
200702
+ /** Configuration for the connect accounts feature. */
200703
+ connect?: {
200704
+ /** Whether to exclude this feature from the portal. */
200705
+ exclude?: boolean;
200706
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
200707
+ accepted_providers?: string[] | undefined;
200708
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
200709
+ excluded_providers?: string[] | undefined;
200710
+ };
200711
+ /** Configuration for the manage feature. */
200712
+ manage?: {
200713
+ /** Whether to exclude this feature from the portal. */
200714
+ exclude?: boolean;
200715
+ /** Indicates whether the customer can manage reservations for their properties. */
200716
+ exclude_reservation_management?: boolean;
200717
+ /** Indicates whether to exclude technical details from reservation views. */
200718
+ exclude_reservation_technical_details?: boolean;
200719
+ /** Indicates whether the customer can manage staff for their properties. */
200720
+ exclude_staff_management?: boolean;
200721
+ /** Configuration for event type filtering in the manage feature. */
200722
+ events?: {
200723
+ /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
200724
+ allowed_events?: string[] | undefined;
200725
+ /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
200726
+ default_events?: string[] | undefined;
200727
+ } | undefined;
200728
+ };
200729
+ /** Configuration for the manage devices feature.
200730
+ ---
200731
+ deprecated: Use `manage` instead.
200732
+ --- */
200733
+ manage_devices?: {
200734
+ /** Whether to exclude this feature from the portal. */
200735
+ exclude?: boolean;
200736
+ };
200737
+ /** Configuration for the organize feature. */
200738
+ organize?: {
200739
+ /** Whether to exclude this feature from the portal. */
200740
+ exclude?: boolean;
200741
+ };
200742
+ /** Configuration for the configure feature. */
200743
+ configure?: {
200744
+ /** Whether to exclude this feature from the portal. */
200745
+ exclude?: boolean;
200746
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
200747
+ allow_access_automation_rule_customization?: boolean;
200748
+ /** Indicates whether the customer can customize the climate automation rules for their properties. */
200749
+ allow_climate_automation_rule_customization?: boolean;
200750
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
200751
+ allow_instant_key_customization?: boolean;
200752
+ };
200753
+ } | undefined;
200754
+ /** Whether the portal is embedded in another application. */
200755
+ is_embedded?: boolean | undefined;
200756
+ /** Configuration for the landing page when the portal loads. */
200757
+ landing_page?: ({
200758
+ manage?: (({
200759
+ space_key: string;
200760
+ } | {
200761
+ property_key: string;
200762
+ } | {
200763
+ room_key: string;
200764
+ } | {
200765
+ common_area_key: string;
200766
+ } | {
200767
+ unit_key: string;
200768
+ } | {
200769
+ facility_key: string;
200770
+ } | {
200771
+ building_key: string;
200772
+ } | {
200773
+ listing_key: string;
200774
+ } | {
200775
+ property_listing_key: string;
200776
+ } | {
200777
+ site_key: string;
200778
+ }) | ({
200779
+ reservation_key: string;
200780
+ } | {
200781
+ booking_key: string;
200782
+ } | {
200783
+ access_grant_key: string;
200784
+ })) | undefined;
200785
+ } | undefined) | undefined;
200786
+ /** The locale to use for the portal. */
200787
+ locale?: (('en-US' | 'pt-PT' | 'fr-FR' | 'it-IT' | 'es-ES') | undefined) | undefined;
200788
+ /** Whether to exclude the option to select a locale within the portal UI. */
200789
+ exclude_locale_picker?: boolean | undefined;
200790
+ /** The ID of the customization profile to use for the portal. */
200791
+ customization_profile_id?: (string | undefined) | undefined;
200792
+ /** Filter configuration for resources based on their custom_metadata. Each filter specifies a field, operation, and value to match against resource custom_metadata. */
200793
+ customer_resources_filters?: ({
200794
+ /** The custom_metadata field name to filter on. */
200795
+ field: string;
200796
+ /** The comparison operation. Currently only '=' is supported. */
200797
+ operation: '=';
200798
+ /** The value to compare against. */
200799
+ value: string | boolean;
200800
+ }[] | undefined) | undefined;
200801
+ /** Navigation mode for the portal. 'restricted' tells frontend to hide navigation UI, typically used for embedded deep links. */
200802
+ navigation_mode?: ('full' | 'restricted') | undefined;
200803
+ /** Deep link target resource for initial redirect. When set, the portal will navigate directly to the specified resource. */
200804
+ deep_link?: ({
200805
+ resource_type: 'reservation' | 'space';
200806
+ resource_key: string;
200807
+ } | undefined) | undefined;
200808
+ };
200809
+ };
200810
+ commonParams: {};
200811
+ formData: {};
200812
+ jsonResponse: {};
200813
+ maxDuration: undefined;
200814
+ };
199609
200815
  '/seam/customer/v1/reservations/get': {
199610
200816
  route: '/seam/customer/v1/reservations/get';
199611
200817
  method: 'GET' | 'POST';
@@ -199793,8 +200999,8 @@ type Routes = {
199793
200999
  requested_access_methods: {
199794
201000
  /** Display name of the access method. */
199795
201001
  display_name: string;
199796
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
199797
- mode: 'code' | 'card' | 'mobile_key';
201002
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
201003
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
199798
201004
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
199799
201005
  code?: string | undefined;
199800
201006
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -200215,8 +201421,8 @@ type Routes = {
200215
201421
  requested_access_methods: {
200216
201422
  /** Display name of the access method. */
200217
201423
  display_name: string;
200218
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
200219
- mode: 'code' | 'card' | 'mobile_key';
201424
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
201425
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
200220
201426
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
200221
201427
  code?: string | undefined;
200222
201428
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -200951,10 +202157,10 @@ type Routes = {
200951
202157
  can_unlock_with_card?: boolean | undefined;
200952
202158
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
200953
202159
  can_unlock_with_code?: boolean | undefined;
202160
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
202161
+ can_unlock_with_cloud_key?: boolean | undefined;
200954
202162
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
200955
202163
  can_belong_to_reservation?: boolean | undefined;
200956
- /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
200957
- can_unlock_with_cloud_key?: boolean | undefined;
200958
202164
  }[];
200959
202165
  }[];
200960
202166
  }[];
@@ -202676,10 +203882,10 @@ type Routes = {
202676
203882
  can_unlock_with_card?: boolean | undefined;
202677
203883
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
202678
203884
  can_unlock_with_code?: boolean | undefined;
203885
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
203886
+ can_unlock_with_cloud_key?: boolean | undefined;
202679
203887
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
202680
203888
  can_belong_to_reservation?: boolean | undefined;
202681
- /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
202682
- can_unlock_with_cloud_key?: boolean | undefined;
202683
203889
  }[] | undefined;
202684
203890
  connected_accounts?: {
202685
203891
  /** ID of the connected account. */
@@ -202944,8 +204150,8 @@ type Routes = {
202944
204150
  access_method_id: string;
202945
204151
  /** Display name of the access method. */
202946
204152
  display_name: string;
202947
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
202948
- mode: 'code' | 'card' | 'mobile_key';
204153
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
204154
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
202949
204155
  /** Date and time at which the access method was created. */
202950
204156
  created_at: string;
202951
204157
  /** Date and time at which the access method was issued. */
@@ -203960,6 +205166,11 @@ type Routes = {
203960
205166
  type: 'bridge_disconnected';
203961
205167
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
203962
205168
  message: string;
205169
+ } | {
205170
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
205171
+ type: 'encoding_interrupted';
205172
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
205173
+ message: string;
203963
205174
  };
203964
205175
  } | {
203965
205176
  /** ID of the action attempt. */
@@ -205296,6 +206507,11 @@ type Routes = {
205296
206507
  type: 'bridge_disconnected';
205297
206508
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
205298
206509
  message: string;
206510
+ } | {
206511
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
206512
+ type: 'encoding_interrupted';
206513
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
206514
+ message: string;
205299
206515
  };
205300
206516
  } | {
205301
206517
  /** ID of the action attempt. */
@@ -206738,6 +207954,11 @@ type Routes = {
206738
207954
  type: 'bridge_disconnected';
206739
207955
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
206740
207956
  message: string;
207957
+ } | {
207958
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
207959
+ type: 'encoding_interrupted';
207960
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
207961
+ message: string;
206741
207962
  };
206742
207963
  } | {
206743
207964
  /** ID of the action attempt. */
@@ -209425,6 +210646,11 @@ type Routes = {
209425
210646
  type: 'bridge_disconnected';
209426
210647
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
209427
210648
  message: string;
210649
+ } | {
210650
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
210651
+ type: 'encoding_interrupted';
210652
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
210653
+ message: string;
209428
210654
  };
209429
210655
  } | {
209430
210656
  /** ID of the action attempt. */
@@ -210765,6 +211991,11 @@ type Routes = {
210765
211991
  type: 'bridge_disconnected';
210766
211992
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
210767
211993
  message: string;
211994
+ } | {
211995
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
211996
+ type: 'encoding_interrupted';
211997
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
211998
+ message: string;
210768
211999
  };
210769
212000
  } | {
210770
212001
  /** ID of the action attempt. */
@@ -214786,6 +216017,11 @@ type Routes = {
214786
216017
  type: 'bridge_disconnected';
214787
216018
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
214788
216019
  message: string;
216020
+ } | {
216021
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
216022
+ type: 'encoding_interrupted';
216023
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
216024
+ message: string;
214789
216025
  };
214790
216026
  } | {
214791
216027
  /** ID of the action attempt. */
@@ -216321,6 +217557,11 @@ type Routes = {
216321
217557
  type: 'bridge_disconnected';
216322
217558
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
216323
217559
  message: string;
217560
+ } | {
217561
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
217562
+ type: 'encoding_interrupted';
217563
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
217564
+ message: string;
216324
217565
  };
216325
217566
  } | {
216326
217567
  /** ID of the action attempt. */
@@ -217684,6 +218925,11 @@ type Routes = {
217684
218925
  type: 'bridge_disconnected';
217685
218926
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
217686
218927
  message: string;
218928
+ } | {
218929
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
218930
+ type: 'encoding_interrupted';
218931
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
218932
+ message: string;
217687
218933
  };
217688
218934
  } | {
217689
218935
  /** ID of the action attempt. */
@@ -219159,6 +220405,11 @@ type Routes = {
219159
220405
  type: 'bridge_disconnected';
219160
220406
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
219161
220407
  message: string;
220408
+ } | {
220409
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
220410
+ type: 'encoding_interrupted';
220411
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
220412
+ message: string;
219162
220413
  };
219163
220414
  } | {
219164
220415
  /** ID of the action attempt. */
@@ -225324,10 +226575,10 @@ type Routes = {
225324
226575
  can_unlock_with_card?: boolean | undefined;
225325
226576
  /** Indicates whether the ACS entrance can be unlocked with pin codes. */
225326
226577
  can_unlock_with_code?: boolean | undefined;
226578
+ /** Indicates whether the ACS entrance can be unlocked with cloud key credentials. */
226579
+ can_unlock_with_cloud_key?: boolean | undefined;
225327
226580
  /** Indicates whether the ACS entrance can belong to a reservation via an access_grant.reservation_key. */
225328
226581
  can_belong_to_reservation?: boolean | undefined;
225329
- /** Indicates whether the ACS entrance can be remotely unlocked using a cloud_key credential. */
225330
- can_unlock_with_cloud_key?: boolean | undefined;
225331
226582
  }[] | undefined;
225332
226583
  acs_systems?: {
225333
226584
  /** ID of the default credential manager `acs_system` for this [access control system](https://docs.seam.co/latest/capability-guides/access-systems). */
@@ -226632,6 +227883,11 @@ type Routes = {
226632
227883
  type: 'bridge_disconnected';
226633
227884
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
226634
227885
  message: string;
227886
+ } | {
227887
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
227888
+ type: 'encoding_interrupted';
227889
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
227890
+ message: string;
226635
227891
  };
226636
227892
  } | {
226637
227893
  /** ID of the action attempt. */
@@ -228094,8 +229350,8 @@ type Routes = {
228094
229350
  access_method_id: string;
228095
229351
  /** Display name of the access method. */
228096
229352
  display_name: string;
228097
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
228098
- mode: 'code' | 'card' | 'mobile_key';
229353
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
229354
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
228099
229355
  /** Date and time at which the access method was created. */
228100
229356
  created_at: string;
228101
229357
  /** Date and time at which the access method was issued. */
@@ -228217,8 +229473,8 @@ type Routes = {
228217
229473
  requested_access_methods: {
228218
229474
  /** Display name of the access method. */
228219
229475
  display_name: string;
228220
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
228221
- mode: 'code' | 'card' | 'mobile_key';
229476
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
229477
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
228222
229478
  /** Specific PIN code to use for this access method. Only applicable when mode is 'code'. */
228223
229479
  code?: string | undefined;
228224
229480
  /** Maximum number of times the instant key can be used. Only applicable when mode is 'mobile_key'. Defaults to 1 if not specified. */
@@ -233493,6 +234749,11 @@ type Routes = {
233493
234749
  type: 'bridge_disconnected';
233494
234750
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
233495
234751
  message: string;
234752
+ } | {
234753
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
234754
+ type: 'encoding_interrupted';
234755
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
234756
+ message: string;
233496
234757
  };
233497
234758
  } | {
233498
234759
  /** ID of the action attempt. */