@seamapi/types 1.375.2 → 1.377.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 (31) hide show
  1. package/dist/connect.cjs +1708 -529
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1588 -363
  4. package/lib/seam/connect/models/access-codes/managed-access-code.js +48 -23
  5. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  6. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js +13 -2
  7. package/lib/seam/connect/models/access-codes/unmanaged-access-code.js.map +1 -1
  8. package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +182 -150
  9. package/lib/seam/connect/models/acs/acs-users/acs-user.js +2 -3
  10. package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
  11. package/lib/seam/connect/models/acs/acs-users/index.d.ts +1 -1
  12. package/lib/seam/connect/models/acs/acs-users/index.js +1 -1
  13. package/lib/seam/connect/models/acs/acs-users/index.js.map +1 -1
  14. package/lib/seam/connect/models/acs/acs-users/{pending-modifications.d.ts → pending-mutations.d.ts} +191 -106
  15. package/lib/seam/connect/models/acs/acs-users/pending-mutations.js +90 -0
  16. package/lib/seam/connect/models/acs/acs-users/pending-mutations.js.map +1 -0
  17. package/lib/seam/connect/openapi.d.ts +257 -58
  18. package/lib/seam/connect/openapi.js +1588 -436
  19. package/lib/seam/connect/openapi.js.map +1 -1
  20. package/lib/seam/connect/route-types.d.ts +1155 -161
  21. package/package.json +1 -1
  22. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +95 -60
  23. package/src/lib/seam/connect/models/access-codes/unmanaged-access-code.ts +15 -2
  24. package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +2 -3
  25. package/src/lib/seam/connect/models/acs/acs-users/index.ts +1 -1
  26. package/src/lib/seam/connect/models/acs/acs-users/pending-mutations.ts +110 -0
  27. package/src/lib/seam/connect/openapi.ts +1928 -446
  28. package/src/lib/seam/connect/route-types.ts +1162 -161
  29. package/lib/seam/connect/models/acs/acs-users/pending-modifications.js +0 -85
  30. package/lib/seam/connect/models/acs/acs-users/pending-modifications.js.map +0 -1
  31. package/src/lib/seam/connect/models/acs/acs-users/pending-modifications.ts +0 -109
@@ -4,22 +4,37 @@ export interface Routes {
4
4
  method: 'POST';
5
5
  queryParams: {};
6
6
  jsonBody: {
7
+ /** ID of the device for which to create the new access code. */
7
8
  device_id: string;
9
+ /** Name of the new access code. */
8
10
  name?: string | undefined;
11
+ /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
9
12
  starts_at?: string | undefined;
13
+ /** Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
10
14
  ends_at?: string | undefined;
15
+ /** Code to be used for access. */
11
16
  code?: string | undefined;
17
+ /** */
12
18
  sync?: boolean;
13
19
  attempt_for_offline_device?: boolean;
20
+ /** Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes). */
14
21
  common_code_key?: string | undefined;
22
+ /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
15
23
  prefer_native_scheduling?: boolean | undefined;
24
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
16
25
  use_backup_access_code_pool?: boolean | undefined;
26
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
17
27
  allow_external_modification?: boolean | undefined;
28
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
18
29
  is_external_modification_allowed?: boolean | undefined;
30
+ /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
19
31
  preferred_code_length?: number | undefined;
20
32
  use_offline_access_code?: boolean | undefined;
33
+ /** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
21
34
  is_offline_access_code?: boolean | undefined;
35
+ /** Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
22
36
  is_one_time_use?: boolean | undefined;
37
+ /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
23
38
  max_time_rounding?: '1hour' | '1day' | '1h' | '1d';
24
39
  };
25
40
  commonParams: {};
@@ -975,13 +990,19 @@ export interface Routes {
975
990
  message: string;
976
991
  };
977
992
  };
978
- /** */
993
+ /** Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
994
+
995
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
996
+
997
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
998
+
999
+ In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
979
1000
  access_code: {
980
1001
  /** Unique identifier for a group of access codes that share the same code. */
981
1002
  common_code_key: string | null;
982
1003
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
983
1004
  is_scheduled_on_device?: boolean | undefined;
984
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
1005
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
985
1006
  type: 'time_bound' | 'ongoing';
986
1007
  /** Indicates whether the access code is waiting for a code assignment. */
987
1008
  is_waiting_for_code_assignment?: boolean | undefined;
@@ -995,148 +1016,220 @@ export interface Routes {
995
1016
  code: string | null;
996
1017
  /** Date and time at which the access code was created. */
997
1018
  created_at: string;
998
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
1019
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
999
1020
  errors: Array<{
1021
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1000
1022
  message: string;
1023
+ /** Indicates that this is an access code error. */
1001
1024
  is_access_code_error: true;
1025
+ /** Date and time at which Seam created the error. */
1002
1026
  created_at?: string | undefined;
1003
1027
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1004
1028
  error_code: 'smartthings_failed_to_set_access_code';
1005
1029
  } | {
1030
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1006
1031
  message: string;
1032
+ /** Indicates that this is an access code error. */
1007
1033
  is_access_code_error: true;
1034
+ /** Date and time at which Seam created the error. */
1008
1035
  created_at?: string | undefined;
1009
1036
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1010
1037
  error_code: 'smartthings_failed_to_set_after_multiple_retries';
1011
1038
  } | {
1039
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1012
1040
  message: string;
1041
+ /** Indicates that this is an access code error. */
1013
1042
  is_access_code_error: true;
1043
+ /** Date and time at which Seam created the error. */
1014
1044
  created_at?: string | undefined;
1015
1045
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1016
1046
  error_code: 'smartthings_no_free_slots_available';
1017
1047
  } | {
1048
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1018
1049
  message: string;
1050
+ /** Indicates that this is an access code error. */
1019
1051
  is_access_code_error: true;
1052
+ /** Date and time at which Seam created the error. */
1020
1053
  created_at?: string | undefined;
1021
1054
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1022
1055
  error_code: 'failed_to_set_on_device';
1023
1056
  } | {
1057
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1024
1058
  message: string;
1059
+ /** Indicates that this is an access code error. */
1025
1060
  is_access_code_error: true;
1061
+ /** Date and time at which Seam created the error. */
1026
1062
  created_at?: string | undefined;
1027
1063
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1028
1064
  error_code: 'failed_to_remove_from_device';
1029
1065
  } | {
1066
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1030
1067
  message: string;
1068
+ /** Indicates that this is an access code error. */
1031
1069
  is_access_code_error: true;
1070
+ /** Date and time at which Seam created the error. */
1032
1071
  created_at?: string | undefined;
1033
1072
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1034
1073
  error_code: 'duplicate_code_on_device';
1035
1074
  } | {
1075
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1036
1076
  message: string;
1077
+ /** Indicates that this is an access code error. */
1037
1078
  is_access_code_error: true;
1079
+ /** Date and time at which Seam created the error. */
1038
1080
  created_at?: string | undefined;
1039
1081
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1040
1082
  error_code: 'duplicate_code_attempt_prevented';
1041
1083
  } | {
1084
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1042
1085
  message: string;
1086
+ /** Indicates that this is an access code error. */
1043
1087
  is_access_code_error: true;
1088
+ /** Date and time at which Seam created the error. */
1044
1089
  created_at?: string | undefined;
1045
1090
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1046
1091
  error_code: 'igloohome_bridge_too_many_pending_jobs';
1047
1092
  } | {
1093
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1048
1094
  message: string;
1095
+ /** Indicates that this is an access code error. */
1049
1096
  is_access_code_error: true;
1097
+ /** Date and time at which Seam created the error. */
1050
1098
  created_at?: string | undefined;
1051
1099
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1052
1100
  error_code: 'igloohome_bridge_offline';
1053
1101
  } | {
1102
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1054
1103
  message: string;
1104
+ /** Indicates that this is an access code error. */
1055
1105
  is_access_code_error: true;
1106
+ /** Date and time at which Seam created the error. */
1056
1107
  created_at?: string | undefined;
1057
1108
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1058
1109
  error_code: 'igloohome_offline_access_code_no_variance_available';
1059
1110
  } | {
1111
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1060
1112
  message: string;
1113
+ /** Indicates that this is an access code error. */
1061
1114
  is_access_code_error: true;
1115
+ /** Date and time at which Seam created the error. */
1062
1116
  created_at?: string | undefined;
1063
1117
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1064
1118
  error_code: 'kwikset_unable_to_confirm_code';
1065
1119
  } | {
1120
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1066
1121
  message: string;
1122
+ /** Indicates that this is an access code error. */
1067
1123
  is_access_code_error: true;
1124
+ /** Date and time at which Seam created the error. */
1068
1125
  created_at?: string | undefined;
1069
1126
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1070
1127
  error_code: 'kwikset_unable_to_confirm_deletion';
1071
1128
  } | {
1129
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1072
1130
  message: string;
1131
+ /** Indicates that this is an access code error. */
1073
1132
  is_access_code_error: true;
1133
+ /** Date and time at which Seam created the error. */
1074
1134
  created_at?: string | undefined;
1075
1135
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1076
1136
  error_code: 'code_modified_external_to_seam';
1077
1137
  } | {
1138
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1078
1139
  message: string;
1140
+ /** Indicates that this is an access code error. */
1079
1141
  is_access_code_error: true;
1142
+ /** Date and time at which Seam created the error. */
1080
1143
  created_at?: string | undefined;
1081
1144
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1082
1145
  error_code: 'august_lock_invalid_code_length';
1083
1146
  } | {
1147
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1084
1148
  message: string;
1149
+ /** Indicates that this is an access code error. */
1085
1150
  is_access_code_error: true;
1151
+ /** Date and time at which Seam created the error. */
1086
1152
  created_at?: string | undefined;
1087
1153
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1088
1154
  error_code: 'august_device_programming_delay';
1089
1155
  } | {
1156
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1090
1157
  message: string;
1158
+ /** Indicates that this is an access code error. */
1091
1159
  is_access_code_error: true;
1160
+ /** Date and time at which Seam created the error. */
1092
1161
  created_at?: string | undefined;
1093
1162
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1094
1163
  error_code: 'august_device_slots_full';
1095
1164
  } | {
1165
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1096
1166
  message: string;
1167
+ /** Indicates that this is an access code error. */
1097
1168
  is_access_code_error: true;
1169
+ /** Date and time at which Seam created the error. */
1098
1170
  created_at?: string | undefined;
1099
1171
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1100
1172
  error_code: 'august_lock_missing_keypad';
1101
1173
  } | {
1174
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1102
1175
  message: string;
1176
+ /** Indicates that this is an access code error. */
1103
1177
  is_access_code_error: true;
1178
+ /** Date and time at which Seam created the error. */
1104
1179
  created_at?: string | undefined;
1105
1180
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1106
1181
  error_code: 'august_lock_temporarily_offline';
1107
1182
  } | {
1183
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1108
1184
  message: string;
1185
+ /** Indicates that this is an access code error. */
1109
1186
  is_access_code_error: true;
1187
+ /** Date and time at which Seam created the error. */
1110
1188
  created_at?: string | undefined;
1111
1189
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1112
1190
  error_code: 'salto_ks_user_not_subscribed';
1113
1191
  } | {
1192
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1114
1193
  message: string;
1194
+ /** Indicates that this is an access code error. */
1115
1195
  is_access_code_error: true;
1196
+ /** Date and time at which Seam created the error. */
1116
1197
  created_at?: string | undefined;
1117
1198
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1118
1199
  error_code: 'hubitat_device_programming_delay';
1119
1200
  } | {
1201
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1120
1202
  message: string;
1203
+ /** Indicates that this is an access code error. */
1121
1204
  is_access_code_error: true;
1205
+ /** Date and time at which Seam created the error. */
1122
1206
  created_at?: string | undefined;
1123
1207
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1124
1208
  error_code: 'hubitat_no_free_positions_available';
1125
1209
  } | {
1210
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1126
1211
  message: string;
1212
+ /** Indicates that this is an access code error. */
1127
1213
  is_access_code_error: true;
1214
+ /** Date and time at which Seam created the error. */
1128
1215
  created_at?: string | undefined;
1129
1216
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1130
1217
  error_code: 'wyze_duplicate_code_name';
1131
1218
  } | {
1219
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1132
1220
  message: string;
1221
+ /** Indicates that this is an access code error. */
1133
1222
  is_access_code_error: true;
1223
+ /** Date and time at which Seam created the error. */
1134
1224
  created_at?: string | undefined;
1135
1225
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1136
1226
  error_code: 'wyze_potential_duplicate_code';
1137
1227
  } | {
1228
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1138
1229
  message: string;
1230
+ /** Indicates that this is an access code error. */
1139
1231
  is_access_code_error: true;
1232
+ /** Date and time at which Seam created the error. */
1140
1233
  created_at?: string | undefined;
1141
1234
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1142
1235
  error_code: 'dormakaba_oracode_no_valid_user_level';
@@ -1237,64 +1330,88 @@ export interface Routes {
1237
1330
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1238
1331
  error_code: 'bridge_disconnected';
1239
1332
  }>;
1240
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
1333
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
1241
1334
  warnings: Array<{
1335
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1242
1336
  message: string;
1337
+ /** Date and time at which Seam created the warning. */
1243
1338
  created_at?: string | undefined;
1244
1339
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1245
1340
  warning_code: 'smartthings_failed_to_set_access_code';
1246
1341
  } | {
1342
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1247
1343
  message: string;
1344
+ /** Date and time at which Seam created the warning. */
1248
1345
  created_at?: string | undefined;
1249
1346
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1250
1347
  warning_code: 'schlage_detected_duplicate';
1251
1348
  } | {
1349
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1252
1350
  message: string;
1351
+ /** Date and time at which Seam created the warning. */
1253
1352
  created_at?: string | undefined;
1254
1353
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1255
1354
  warning_code: 'schlage_creation_outage';
1256
1355
  } | {
1356
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1257
1357
  message: string;
1358
+ /** Date and time at which Seam created the warning. */
1258
1359
  created_at?: string | undefined;
1259
1360
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1260
1361
  warning_code: 'code_modified_external_to_seam';
1261
1362
  } | {
1363
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1262
1364
  message: string;
1365
+ /** Date and time at which Seam created the warning. */
1263
1366
  created_at?: string | undefined;
1264
1367
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1265
1368
  warning_code: 'delay_in_setting_on_device';
1266
1369
  } | {
1370
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1267
1371
  message: string;
1372
+ /** Date and time at which Seam created the warning. */
1268
1373
  created_at?: string | undefined;
1269
1374
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1270
1375
  warning_code: 'delay_in_removing_from_device';
1271
1376
  } | {
1377
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1272
1378
  message: string;
1379
+ /** Date and time at which Seam created the warning. */
1273
1380
  created_at?: string | undefined;
1274
1381
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1275
1382
  warning_code: 'third_party_integration_detected';
1276
1383
  } | {
1384
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1277
1385
  message: string;
1386
+ /** Date and time at which Seam created the warning. */
1278
1387
  created_at?: string | undefined;
1279
1388
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1280
1389
  warning_code: 'august_device_programming_delay';
1281
1390
  } | {
1391
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1282
1392
  message: string;
1393
+ /** Date and time at which Seam created the warning. */
1283
1394
  created_at?: string | undefined;
1284
1395
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1285
1396
  warning_code: 'august_lock_temporarily_offline';
1286
1397
  } | {
1398
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1287
1399
  message: string;
1400
+ /** Date and time at which Seam created the warning. */
1288
1401
  created_at?: string | undefined;
1289
1402
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1290
1403
  warning_code: 'igloo_algopin_must_be_used_within_24_hours';
1291
1404
  } | {
1405
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1292
1406
  message: string;
1407
+ /** Date and time at which Seam created the warning. */
1293
1408
  created_at?: string | undefined;
1294
1409
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1295
1410
  warning_code: 'management_transferred';
1296
1411
  } | {
1412
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1297
1413
  message: string;
1414
+ /** Date and time at which Seam created the warning. */
1298
1415
  created_at?: string | undefined;
1299
1416
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1300
1417
  warning_code: 'kwikset_unable_to_confirm_code';
@@ -1305,9 +1422,7 @@ export interface Routes {
1305
1422
  starts_at?: (string | null) | undefined;
1306
1423
  /** Date and time after which the time-bound access code becomes inactive. */
1307
1424
  ends_at?: (string | null) | undefined;
1308
- /**
1309
- Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
1310
- */
1425
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
1311
1426
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
1312
1427
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
1313
1428
  is_backup_access_code_available: boolean;
@@ -1317,9 +1432,9 @@ export interface Routes {
1317
1432
  pulled_backup_access_code_id?: (string | null) | undefined;
1318
1433
  /** Indicates whether changes to the access code from external sources are permitted. */
1319
1434
  is_external_modification_allowed: boolean;
1320
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
1435
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
1321
1436
  is_one_time_use: boolean;
1322
- /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
1437
+ /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
1323
1438
  is_offline_access_code: boolean;
1324
1439
  };
1325
1440
  };
@@ -1329,21 +1444,35 @@ export interface Routes {
1329
1444
  method: 'POST' | 'PUT';
1330
1445
  queryParams: {};
1331
1446
  jsonBody: {
1447
+ /** IDs of the devices for which to create the new access codes. */
1332
1448
  device_ids: string[];
1449
+ /** Desired behavior if any device cannot share a code. If `throw` (default), no access codes will be created if any device cannot share a code. If `create_random_code`, a random code will be created on devices that cannot share a code. */
1333
1450
  behavior_when_code_cannot_be_shared?: 'throw' | 'create_random_code';
1451
+ /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
1334
1452
  preferred_code_length?: number | undefined;
1453
+ /** Name of the new access code. */
1335
1454
  name?: string | undefined;
1455
+ /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
1336
1456
  starts_at?: string | undefined;
1457
+ /** Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
1337
1458
  ends_at?: string | undefined;
1459
+ /** Code to be used for access. */
1338
1460
  code?: string | undefined;
1339
1461
  attempt_for_offline_device?: boolean;
1462
+ /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
1340
1463
  prefer_native_scheduling?: boolean | undefined;
1464
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
1341
1465
  use_backup_access_code_pool?: boolean | undefined;
1466
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
1342
1467
  allow_external_modification?: boolean | undefined;
1468
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
1343
1469
  is_external_modification_allowed?: boolean | undefined;
1344
1470
  use_offline_access_code?: boolean | undefined;
1471
+ /** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
1345
1472
  is_offline_access_code?: boolean | undefined;
1473
+ /** Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
1346
1474
  is_one_time_use?: boolean | undefined;
1475
+ /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
1347
1476
  max_time_rounding?: '1hour' | '1day' | '1h' | '1d';
1348
1477
  };
1349
1478
  commonParams: {};
@@ -1354,7 +1483,7 @@ export interface Routes {
1354
1483
  common_code_key: string | null;
1355
1484
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
1356
1485
  is_scheduled_on_device?: boolean | undefined;
1357
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
1486
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
1358
1487
  type: 'time_bound' | 'ongoing';
1359
1488
  /** Indicates whether the access code is waiting for a code assignment. */
1360
1489
  is_waiting_for_code_assignment?: boolean | undefined;
@@ -1368,148 +1497,220 @@ export interface Routes {
1368
1497
  code: string | null;
1369
1498
  /** Date and time at which the access code was created. */
1370
1499
  created_at: string;
1371
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
1500
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
1372
1501
  errors: Array<{
1502
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1373
1503
  message: string;
1504
+ /** Indicates that this is an access code error. */
1374
1505
  is_access_code_error: true;
1506
+ /** Date and time at which Seam created the error. */
1375
1507
  created_at?: string | undefined;
1376
1508
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1377
1509
  error_code: 'smartthings_failed_to_set_access_code';
1378
1510
  } | {
1511
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1379
1512
  message: string;
1513
+ /** Indicates that this is an access code error. */
1380
1514
  is_access_code_error: true;
1515
+ /** Date and time at which Seam created the error. */
1381
1516
  created_at?: string | undefined;
1382
1517
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1383
1518
  error_code: 'smartthings_failed_to_set_after_multiple_retries';
1384
1519
  } | {
1520
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1385
1521
  message: string;
1522
+ /** Indicates that this is an access code error. */
1386
1523
  is_access_code_error: true;
1524
+ /** Date and time at which Seam created the error. */
1387
1525
  created_at?: string | undefined;
1388
1526
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1389
1527
  error_code: 'smartthings_no_free_slots_available';
1390
1528
  } | {
1529
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1391
1530
  message: string;
1531
+ /** Indicates that this is an access code error. */
1392
1532
  is_access_code_error: true;
1533
+ /** Date and time at which Seam created the error. */
1393
1534
  created_at?: string | undefined;
1394
1535
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1395
1536
  error_code: 'failed_to_set_on_device';
1396
1537
  } | {
1538
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1397
1539
  message: string;
1540
+ /** Indicates that this is an access code error. */
1398
1541
  is_access_code_error: true;
1542
+ /** Date and time at which Seam created the error. */
1399
1543
  created_at?: string | undefined;
1400
1544
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1401
1545
  error_code: 'failed_to_remove_from_device';
1402
1546
  } | {
1547
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1403
1548
  message: string;
1549
+ /** Indicates that this is an access code error. */
1404
1550
  is_access_code_error: true;
1551
+ /** Date and time at which Seam created the error. */
1405
1552
  created_at?: string | undefined;
1406
1553
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1407
1554
  error_code: 'duplicate_code_on_device';
1408
1555
  } | {
1556
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1409
1557
  message: string;
1558
+ /** Indicates that this is an access code error. */
1410
1559
  is_access_code_error: true;
1560
+ /** Date and time at which Seam created the error. */
1411
1561
  created_at?: string | undefined;
1412
1562
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1413
1563
  error_code: 'duplicate_code_attempt_prevented';
1414
1564
  } | {
1565
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1415
1566
  message: string;
1567
+ /** Indicates that this is an access code error. */
1416
1568
  is_access_code_error: true;
1569
+ /** Date and time at which Seam created the error. */
1417
1570
  created_at?: string | undefined;
1418
1571
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1419
1572
  error_code: 'igloohome_bridge_too_many_pending_jobs';
1420
1573
  } | {
1574
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1421
1575
  message: string;
1576
+ /** Indicates that this is an access code error. */
1422
1577
  is_access_code_error: true;
1578
+ /** Date and time at which Seam created the error. */
1423
1579
  created_at?: string | undefined;
1424
1580
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1425
1581
  error_code: 'igloohome_bridge_offline';
1426
1582
  } | {
1583
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1427
1584
  message: string;
1585
+ /** Indicates that this is an access code error. */
1428
1586
  is_access_code_error: true;
1587
+ /** Date and time at which Seam created the error. */
1429
1588
  created_at?: string | undefined;
1430
1589
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1431
1590
  error_code: 'igloohome_offline_access_code_no_variance_available';
1432
1591
  } | {
1592
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1433
1593
  message: string;
1594
+ /** Indicates that this is an access code error. */
1434
1595
  is_access_code_error: true;
1596
+ /** Date and time at which Seam created the error. */
1435
1597
  created_at?: string | undefined;
1436
1598
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1437
1599
  error_code: 'kwikset_unable_to_confirm_code';
1438
1600
  } | {
1601
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1439
1602
  message: string;
1603
+ /** Indicates that this is an access code error. */
1440
1604
  is_access_code_error: true;
1605
+ /** Date and time at which Seam created the error. */
1441
1606
  created_at?: string | undefined;
1442
1607
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1443
1608
  error_code: 'kwikset_unable_to_confirm_deletion';
1444
1609
  } | {
1610
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1445
1611
  message: string;
1612
+ /** Indicates that this is an access code error. */
1446
1613
  is_access_code_error: true;
1614
+ /** Date and time at which Seam created the error. */
1447
1615
  created_at?: string | undefined;
1448
1616
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1449
1617
  error_code: 'code_modified_external_to_seam';
1450
1618
  } | {
1619
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1451
1620
  message: string;
1621
+ /** Indicates that this is an access code error. */
1452
1622
  is_access_code_error: true;
1623
+ /** Date and time at which Seam created the error. */
1453
1624
  created_at?: string | undefined;
1454
1625
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1455
1626
  error_code: 'august_lock_invalid_code_length';
1456
1627
  } | {
1628
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1457
1629
  message: string;
1630
+ /** Indicates that this is an access code error. */
1458
1631
  is_access_code_error: true;
1632
+ /** Date and time at which Seam created the error. */
1459
1633
  created_at?: string | undefined;
1460
1634
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1461
1635
  error_code: 'august_device_programming_delay';
1462
1636
  } | {
1637
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1463
1638
  message: string;
1639
+ /** Indicates that this is an access code error. */
1464
1640
  is_access_code_error: true;
1641
+ /** Date and time at which Seam created the error. */
1465
1642
  created_at?: string | undefined;
1466
1643
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1467
1644
  error_code: 'august_device_slots_full';
1468
1645
  } | {
1646
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1469
1647
  message: string;
1648
+ /** Indicates that this is an access code error. */
1470
1649
  is_access_code_error: true;
1650
+ /** Date and time at which Seam created the error. */
1471
1651
  created_at?: string | undefined;
1472
1652
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1473
1653
  error_code: 'august_lock_missing_keypad';
1474
1654
  } | {
1655
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1475
1656
  message: string;
1657
+ /** Indicates that this is an access code error. */
1476
1658
  is_access_code_error: true;
1659
+ /** Date and time at which Seam created the error. */
1477
1660
  created_at?: string | undefined;
1478
1661
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1479
1662
  error_code: 'august_lock_temporarily_offline';
1480
1663
  } | {
1664
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1481
1665
  message: string;
1666
+ /** Indicates that this is an access code error. */
1482
1667
  is_access_code_error: true;
1668
+ /** Date and time at which Seam created the error. */
1483
1669
  created_at?: string | undefined;
1484
1670
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1485
1671
  error_code: 'salto_ks_user_not_subscribed';
1486
1672
  } | {
1673
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1487
1674
  message: string;
1675
+ /** Indicates that this is an access code error. */
1488
1676
  is_access_code_error: true;
1677
+ /** Date and time at which Seam created the error. */
1489
1678
  created_at?: string | undefined;
1490
1679
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1491
1680
  error_code: 'hubitat_device_programming_delay';
1492
1681
  } | {
1682
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1493
1683
  message: string;
1684
+ /** Indicates that this is an access code error. */
1494
1685
  is_access_code_error: true;
1686
+ /** Date and time at which Seam created the error. */
1495
1687
  created_at?: string | undefined;
1496
1688
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1497
1689
  error_code: 'hubitat_no_free_positions_available';
1498
1690
  } | {
1691
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1499
1692
  message: string;
1693
+ /** Indicates that this is an access code error. */
1500
1694
  is_access_code_error: true;
1695
+ /** Date and time at which Seam created the error. */
1501
1696
  created_at?: string | undefined;
1502
1697
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1503
1698
  error_code: 'wyze_duplicate_code_name';
1504
1699
  } | {
1700
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1505
1701
  message: string;
1702
+ /** Indicates that this is an access code error. */
1506
1703
  is_access_code_error: true;
1704
+ /** Date and time at which Seam created the error. */
1507
1705
  created_at?: string | undefined;
1508
1706
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1509
1707
  error_code: 'wyze_potential_duplicate_code';
1510
1708
  } | {
1709
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1511
1710
  message: string;
1711
+ /** Indicates that this is an access code error. */
1512
1712
  is_access_code_error: true;
1713
+ /** Date and time at which Seam created the error. */
1513
1714
  created_at?: string | undefined;
1514
1715
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1515
1716
  error_code: 'dormakaba_oracode_no_valid_user_level';
@@ -1610,64 +1811,88 @@ export interface Routes {
1610
1811
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1611
1812
  error_code: 'bridge_disconnected';
1612
1813
  }>;
1613
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
1814
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
1614
1815
  warnings: Array<{
1816
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1615
1817
  message: string;
1818
+ /** Date and time at which Seam created the warning. */
1616
1819
  created_at?: string | undefined;
1617
1820
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1618
1821
  warning_code: 'smartthings_failed_to_set_access_code';
1619
1822
  } | {
1823
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1620
1824
  message: string;
1825
+ /** Date and time at which Seam created the warning. */
1621
1826
  created_at?: string | undefined;
1622
1827
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1623
1828
  warning_code: 'schlage_detected_duplicate';
1624
1829
  } | {
1830
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1625
1831
  message: string;
1832
+ /** Date and time at which Seam created the warning. */
1626
1833
  created_at?: string | undefined;
1627
1834
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1628
1835
  warning_code: 'schlage_creation_outage';
1629
1836
  } | {
1837
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1630
1838
  message: string;
1839
+ /** Date and time at which Seam created the warning. */
1631
1840
  created_at?: string | undefined;
1632
1841
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1633
1842
  warning_code: 'code_modified_external_to_seam';
1634
1843
  } | {
1844
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1635
1845
  message: string;
1846
+ /** Date and time at which Seam created the warning. */
1636
1847
  created_at?: string | undefined;
1637
1848
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1638
1849
  warning_code: 'delay_in_setting_on_device';
1639
1850
  } | {
1851
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1640
1852
  message: string;
1853
+ /** Date and time at which Seam created the warning. */
1641
1854
  created_at?: string | undefined;
1642
1855
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1643
1856
  warning_code: 'delay_in_removing_from_device';
1644
1857
  } | {
1858
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1645
1859
  message: string;
1860
+ /** Date and time at which Seam created the warning. */
1646
1861
  created_at?: string | undefined;
1647
1862
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1648
1863
  warning_code: 'third_party_integration_detected';
1649
1864
  } | {
1865
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1650
1866
  message: string;
1867
+ /** Date and time at which Seam created the warning. */
1651
1868
  created_at?: string | undefined;
1652
1869
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1653
1870
  warning_code: 'august_device_programming_delay';
1654
1871
  } | {
1872
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1655
1873
  message: string;
1874
+ /** Date and time at which Seam created the warning. */
1656
1875
  created_at?: string | undefined;
1657
1876
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
1658
1877
  warning_code: 'august_lock_temporarily_offline';
1659
1878
  } | {
1879
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1660
1880
  message: string;
1881
+ /** Date and time at which Seam created the warning. */
1661
1882
  created_at?: string | undefined;
1662
1883
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1663
1884
  warning_code: 'igloo_algopin_must_be_used_within_24_hours';
1664
1885
  } | {
1886
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1665
1887
  message: string;
1888
+ /** Date and time at which Seam created the warning. */
1666
1889
  created_at?: string | undefined;
1667
1890
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1668
1891
  warning_code: 'management_transferred';
1669
1892
  } | {
1893
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
1670
1894
  message: string;
1895
+ /** Date and time at which Seam created the warning. */
1671
1896
  created_at?: string | undefined;
1672
1897
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
1673
1898
  warning_code: 'kwikset_unable_to_confirm_code';
@@ -1678,9 +1903,7 @@ export interface Routes {
1678
1903
  starts_at?: (string | null) | undefined;
1679
1904
  /** Date and time after which the time-bound access code becomes inactive. */
1680
1905
  ends_at?: (string | null) | undefined;
1681
- /**
1682
- Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
1683
- */
1906
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
1684
1907
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
1685
1908
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
1686
1909
  is_backup_access_code_available: boolean;
@@ -1690,9 +1913,9 @@ export interface Routes {
1690
1913
  pulled_backup_access_code_id?: (string | null) | undefined;
1691
1914
  /** Indicates whether changes to the access code from external sources are permitted. */
1692
1915
  is_external_modification_allowed: boolean;
1693
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
1916
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
1694
1917
  is_one_time_use: boolean;
1695
- /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
1918
+ /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
1696
1919
  is_offline_access_code: boolean;
1697
1920
  }>;
1698
1921
  };
@@ -1703,8 +1926,11 @@ export interface Routes {
1703
1926
  queryParams: {};
1704
1927
  jsonBody: {};
1705
1928
  commonParams: {
1929
+ /** ID of the device for which to delete the access code. */
1706
1930
  device_id?: string | undefined;
1931
+ /** ID of the access code to delete. */
1707
1932
  access_code_id: string;
1933
+ /** */
1708
1934
  sync?: boolean;
1709
1935
  };
1710
1936
  formData: {};
@@ -2683,19 +2909,28 @@ export interface Routes {
2683
2909
  queryParams: {};
2684
2910
  jsonBody: {};
2685
2911
  commonParams: {
2912
+ /** ID of the device containing the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
2686
2913
  device_id?: string | undefined;
2914
+ /** ID of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
2687
2915
  access_code_id?: string | undefined;
2916
+ /** Code of the access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
2688
2917
  code?: string | undefined;
2689
2918
  };
2690
2919
  formData: {};
2691
2920
  jsonResponse: {
2692
- /** */
2921
+ /** Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
2922
+
2923
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
2924
+
2925
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
2926
+
2927
+ In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
2693
2928
  access_code: {
2694
2929
  /** Unique identifier for a group of access codes that share the same code. */
2695
2930
  common_code_key: string | null;
2696
2931
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
2697
2932
  is_scheduled_on_device?: boolean | undefined;
2698
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
2933
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
2699
2934
  type: 'time_bound' | 'ongoing';
2700
2935
  /** Indicates whether the access code is waiting for a code assignment. */
2701
2936
  is_waiting_for_code_assignment?: boolean | undefined;
@@ -2709,148 +2944,220 @@ export interface Routes {
2709
2944
  code: string | null;
2710
2945
  /** Date and time at which the access code was created. */
2711
2946
  created_at: string;
2712
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
2947
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
2713
2948
  errors: Array<{
2949
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2714
2950
  message: string;
2951
+ /** Indicates that this is an access code error. */
2715
2952
  is_access_code_error: true;
2953
+ /** Date and time at which Seam created the error. */
2716
2954
  created_at?: string | undefined;
2717
2955
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2718
2956
  error_code: 'smartthings_failed_to_set_access_code';
2719
2957
  } | {
2958
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2720
2959
  message: string;
2960
+ /** Indicates that this is an access code error. */
2721
2961
  is_access_code_error: true;
2962
+ /** Date and time at which Seam created the error. */
2722
2963
  created_at?: string | undefined;
2723
2964
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2724
2965
  error_code: 'smartthings_failed_to_set_after_multiple_retries';
2725
2966
  } | {
2967
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2726
2968
  message: string;
2969
+ /** Indicates that this is an access code error. */
2727
2970
  is_access_code_error: true;
2971
+ /** Date and time at which Seam created the error. */
2728
2972
  created_at?: string | undefined;
2729
2973
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2730
2974
  error_code: 'smartthings_no_free_slots_available';
2731
2975
  } | {
2976
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2732
2977
  message: string;
2978
+ /** Indicates that this is an access code error. */
2733
2979
  is_access_code_error: true;
2980
+ /** Date and time at which Seam created the error. */
2734
2981
  created_at?: string | undefined;
2735
2982
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2736
2983
  error_code: 'failed_to_set_on_device';
2737
2984
  } | {
2985
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2738
2986
  message: string;
2987
+ /** Indicates that this is an access code error. */
2739
2988
  is_access_code_error: true;
2989
+ /** Date and time at which Seam created the error. */
2740
2990
  created_at?: string | undefined;
2741
2991
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2742
2992
  error_code: 'failed_to_remove_from_device';
2743
2993
  } | {
2994
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2744
2995
  message: string;
2996
+ /** Indicates that this is an access code error. */
2745
2997
  is_access_code_error: true;
2998
+ /** Date and time at which Seam created the error. */
2746
2999
  created_at?: string | undefined;
2747
3000
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2748
3001
  error_code: 'duplicate_code_on_device';
2749
3002
  } | {
3003
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2750
3004
  message: string;
3005
+ /** Indicates that this is an access code error. */
2751
3006
  is_access_code_error: true;
3007
+ /** Date and time at which Seam created the error. */
2752
3008
  created_at?: string | undefined;
2753
3009
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2754
3010
  error_code: 'duplicate_code_attempt_prevented';
2755
3011
  } | {
3012
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2756
3013
  message: string;
3014
+ /** Indicates that this is an access code error. */
2757
3015
  is_access_code_error: true;
3016
+ /** Date and time at which Seam created the error. */
2758
3017
  created_at?: string | undefined;
2759
3018
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2760
3019
  error_code: 'igloohome_bridge_too_many_pending_jobs';
2761
3020
  } | {
3021
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2762
3022
  message: string;
3023
+ /** Indicates that this is an access code error. */
2763
3024
  is_access_code_error: true;
3025
+ /** Date and time at which Seam created the error. */
2764
3026
  created_at?: string | undefined;
2765
3027
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2766
3028
  error_code: 'igloohome_bridge_offline';
2767
3029
  } | {
3030
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2768
3031
  message: string;
3032
+ /** Indicates that this is an access code error. */
2769
3033
  is_access_code_error: true;
3034
+ /** Date and time at which Seam created the error. */
2770
3035
  created_at?: string | undefined;
2771
3036
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2772
3037
  error_code: 'igloohome_offline_access_code_no_variance_available';
2773
3038
  } | {
3039
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2774
3040
  message: string;
3041
+ /** Indicates that this is an access code error. */
2775
3042
  is_access_code_error: true;
3043
+ /** Date and time at which Seam created the error. */
2776
3044
  created_at?: string | undefined;
2777
3045
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2778
3046
  error_code: 'kwikset_unable_to_confirm_code';
2779
3047
  } | {
3048
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2780
3049
  message: string;
3050
+ /** Indicates that this is an access code error. */
2781
3051
  is_access_code_error: true;
3052
+ /** Date and time at which Seam created the error. */
2782
3053
  created_at?: string | undefined;
2783
3054
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2784
3055
  error_code: 'kwikset_unable_to_confirm_deletion';
2785
3056
  } | {
3057
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2786
3058
  message: string;
3059
+ /** Indicates that this is an access code error. */
2787
3060
  is_access_code_error: true;
3061
+ /** Date and time at which Seam created the error. */
2788
3062
  created_at?: string | undefined;
2789
3063
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2790
3064
  error_code: 'code_modified_external_to_seam';
2791
3065
  } | {
3066
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2792
3067
  message: string;
3068
+ /** Indicates that this is an access code error. */
2793
3069
  is_access_code_error: true;
3070
+ /** Date and time at which Seam created the error. */
2794
3071
  created_at?: string | undefined;
2795
3072
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2796
3073
  error_code: 'august_lock_invalid_code_length';
2797
3074
  } | {
3075
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2798
3076
  message: string;
3077
+ /** Indicates that this is an access code error. */
2799
3078
  is_access_code_error: true;
3079
+ /** Date and time at which Seam created the error. */
2800
3080
  created_at?: string | undefined;
2801
3081
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2802
3082
  error_code: 'august_device_programming_delay';
2803
3083
  } | {
3084
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2804
3085
  message: string;
3086
+ /** Indicates that this is an access code error. */
2805
3087
  is_access_code_error: true;
3088
+ /** Date and time at which Seam created the error. */
2806
3089
  created_at?: string | undefined;
2807
3090
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2808
3091
  error_code: 'august_device_slots_full';
2809
3092
  } | {
3093
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2810
3094
  message: string;
3095
+ /** Indicates that this is an access code error. */
2811
3096
  is_access_code_error: true;
3097
+ /** Date and time at which Seam created the error. */
2812
3098
  created_at?: string | undefined;
2813
3099
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2814
3100
  error_code: 'august_lock_missing_keypad';
2815
3101
  } | {
3102
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2816
3103
  message: string;
3104
+ /** Indicates that this is an access code error. */
2817
3105
  is_access_code_error: true;
3106
+ /** Date and time at which Seam created the error. */
2818
3107
  created_at?: string | undefined;
2819
3108
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2820
3109
  error_code: 'august_lock_temporarily_offline';
2821
3110
  } | {
3111
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2822
3112
  message: string;
3113
+ /** Indicates that this is an access code error. */
2823
3114
  is_access_code_error: true;
3115
+ /** Date and time at which Seam created the error. */
2824
3116
  created_at?: string | undefined;
2825
3117
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2826
3118
  error_code: 'salto_ks_user_not_subscribed';
2827
3119
  } | {
3120
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2828
3121
  message: string;
3122
+ /** Indicates that this is an access code error. */
2829
3123
  is_access_code_error: true;
3124
+ /** Date and time at which Seam created the error. */
2830
3125
  created_at?: string | undefined;
2831
3126
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2832
3127
  error_code: 'hubitat_device_programming_delay';
2833
3128
  } | {
3129
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2834
3130
  message: string;
3131
+ /** Indicates that this is an access code error. */
2835
3132
  is_access_code_error: true;
3133
+ /** Date and time at which Seam created the error. */
2836
3134
  created_at?: string | undefined;
2837
3135
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2838
3136
  error_code: 'hubitat_no_free_positions_available';
2839
3137
  } | {
3138
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2840
3139
  message: string;
3140
+ /** Indicates that this is an access code error. */
2841
3141
  is_access_code_error: true;
3142
+ /** Date and time at which Seam created the error. */
2842
3143
  created_at?: string | undefined;
2843
3144
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2844
3145
  error_code: 'wyze_duplicate_code_name';
2845
3146
  } | {
3147
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2846
3148
  message: string;
3149
+ /** Indicates that this is an access code error. */
2847
3150
  is_access_code_error: true;
3151
+ /** Date and time at which Seam created the error. */
2848
3152
  created_at?: string | undefined;
2849
3153
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2850
3154
  error_code: 'wyze_potential_duplicate_code';
2851
3155
  } | {
3156
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
2852
3157
  message: string;
3158
+ /** Indicates that this is an access code error. */
2853
3159
  is_access_code_error: true;
3160
+ /** Date and time at which Seam created the error. */
2854
3161
  created_at?: string | undefined;
2855
3162
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2856
3163
  error_code: 'dormakaba_oracode_no_valid_user_level';
@@ -2951,64 +3258,88 @@ export interface Routes {
2951
3258
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2952
3259
  error_code: 'bridge_disconnected';
2953
3260
  }>;
2954
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
3261
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
2955
3262
  warnings: Array<{
3263
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
2956
3264
  message: string;
3265
+ /** Date and time at which Seam created the warning. */
2957
3266
  created_at?: string | undefined;
2958
3267
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
2959
3268
  warning_code: 'smartthings_failed_to_set_access_code';
2960
3269
  } | {
3270
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
2961
3271
  message: string;
3272
+ /** Date and time at which Seam created the warning. */
2962
3273
  created_at?: string | undefined;
2963
3274
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
2964
3275
  warning_code: 'schlage_detected_duplicate';
2965
3276
  } | {
3277
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
2966
3278
  message: string;
3279
+ /** Date and time at which Seam created the warning. */
2967
3280
  created_at?: string | undefined;
2968
3281
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
2969
3282
  warning_code: 'schlage_creation_outage';
2970
3283
  } | {
3284
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
2971
3285
  message: string;
3286
+ /** Date and time at which Seam created the warning. */
2972
3287
  created_at?: string | undefined;
2973
3288
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
2974
3289
  warning_code: 'code_modified_external_to_seam';
2975
3290
  } | {
3291
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
2976
3292
  message: string;
3293
+ /** Date and time at which Seam created the warning. */
2977
3294
  created_at?: string | undefined;
2978
3295
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
2979
3296
  warning_code: 'delay_in_setting_on_device';
2980
3297
  } | {
3298
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
2981
3299
  message: string;
3300
+ /** Date and time at which Seam created the warning. */
2982
3301
  created_at?: string | undefined;
2983
3302
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
2984
3303
  warning_code: 'delay_in_removing_from_device';
2985
3304
  } | {
3305
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
2986
3306
  message: string;
3307
+ /** Date and time at which Seam created the warning. */
2987
3308
  created_at?: string | undefined;
2988
3309
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
2989
3310
  warning_code: 'third_party_integration_detected';
2990
3311
  } | {
3312
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
2991
3313
  message: string;
3314
+ /** Date and time at which Seam created the warning. */
2992
3315
  created_at?: string | undefined;
2993
3316
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
2994
3317
  warning_code: 'august_device_programming_delay';
2995
3318
  } | {
3319
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
2996
3320
  message: string;
3321
+ /** Date and time at which Seam created the warning. */
2997
3322
  created_at?: string | undefined;
2998
3323
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
2999
3324
  warning_code: 'august_lock_temporarily_offline';
3000
3325
  } | {
3326
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3001
3327
  message: string;
3328
+ /** Date and time at which Seam created the warning. */
3002
3329
  created_at?: string | undefined;
3003
3330
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3004
3331
  warning_code: 'igloo_algopin_must_be_used_within_24_hours';
3005
3332
  } | {
3333
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3006
3334
  message: string;
3335
+ /** Date and time at which Seam created the warning. */
3007
3336
  created_at?: string | undefined;
3008
3337
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3009
3338
  warning_code: 'management_transferred';
3010
3339
  } | {
3340
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3011
3341
  message: string;
3342
+ /** Date and time at which Seam created the warning. */
3012
3343
  created_at?: string | undefined;
3013
3344
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3014
3345
  warning_code: 'kwikset_unable_to_confirm_code';
@@ -3019,9 +3350,7 @@ export interface Routes {
3019
3350
  starts_at?: (string | null) | undefined;
3020
3351
  /** Date and time after which the time-bound access code becomes inactive. */
3021
3352
  ends_at?: (string | null) | undefined;
3022
- /**
3023
- Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
3024
- */
3353
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
3025
3354
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
3026
3355
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
3027
3356
  is_backup_access_code_available: boolean;
@@ -3031,9 +3360,9 @@ export interface Routes {
3031
3360
  pulled_backup_access_code_id?: (string | null) | undefined;
3032
3361
  /** Indicates whether changes to the access code from external sources are permitted. */
3033
3362
  is_external_modification_allowed: boolean;
3034
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
3363
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
3035
3364
  is_one_time_use: boolean;
3036
- /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
3365
+ /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
3037
3366
  is_offline_access_code: boolean;
3038
3367
  };
3039
3368
  };
@@ -3044,8 +3373,11 @@ export interface Routes {
3044
3373
  queryParams: {};
3045
3374
  jsonBody: {};
3046
3375
  commonParams: {
3376
+ /** ID of the device for which you want to list access codes. Specify either `device_id` or `access_code_ids`. */
3047
3377
  device_id?: string | undefined;
3378
+ /** IDs of the access codes that you want to retrieve. Specify either `device_id` or `access_code_ids`. */
3048
3379
  access_code_ids?: string[] | undefined;
3380
+ /** Your user ID for the user by which to filter access codes. */
3049
3381
  user_identifier_key?: string | undefined;
3050
3382
  };
3051
3383
  formData: {};
@@ -3055,7 +3387,7 @@ export interface Routes {
3055
3387
  common_code_key: string | null;
3056
3388
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
3057
3389
  is_scheduled_on_device?: boolean | undefined;
3058
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
3390
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
3059
3391
  type: 'time_bound' | 'ongoing';
3060
3392
  /** Indicates whether the access code is waiting for a code assignment. */
3061
3393
  is_waiting_for_code_assignment?: boolean | undefined;
@@ -3069,148 +3401,220 @@ export interface Routes {
3069
3401
  code: string | null;
3070
3402
  /** Date and time at which the access code was created. */
3071
3403
  created_at: string;
3072
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
3404
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
3073
3405
  errors: Array<{
3406
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3074
3407
  message: string;
3408
+ /** Indicates that this is an access code error. */
3075
3409
  is_access_code_error: true;
3410
+ /** Date and time at which Seam created the error. */
3076
3411
  created_at?: string | undefined;
3077
3412
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3078
3413
  error_code: 'smartthings_failed_to_set_access_code';
3079
3414
  } | {
3415
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3080
3416
  message: string;
3417
+ /** Indicates that this is an access code error. */
3081
3418
  is_access_code_error: true;
3419
+ /** Date and time at which Seam created the error. */
3082
3420
  created_at?: string | undefined;
3083
3421
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3084
3422
  error_code: 'smartthings_failed_to_set_after_multiple_retries';
3085
3423
  } | {
3424
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3086
3425
  message: string;
3426
+ /** Indicates that this is an access code error. */
3087
3427
  is_access_code_error: true;
3428
+ /** Date and time at which Seam created the error. */
3088
3429
  created_at?: string | undefined;
3089
3430
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3090
3431
  error_code: 'smartthings_no_free_slots_available';
3091
3432
  } | {
3433
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3092
3434
  message: string;
3435
+ /** Indicates that this is an access code error. */
3093
3436
  is_access_code_error: true;
3437
+ /** Date and time at which Seam created the error. */
3094
3438
  created_at?: string | undefined;
3095
3439
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3096
3440
  error_code: 'failed_to_set_on_device';
3097
3441
  } | {
3442
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3098
3443
  message: string;
3444
+ /** Indicates that this is an access code error. */
3099
3445
  is_access_code_error: true;
3446
+ /** Date and time at which Seam created the error. */
3100
3447
  created_at?: string | undefined;
3101
3448
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3102
3449
  error_code: 'failed_to_remove_from_device';
3103
3450
  } | {
3451
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3104
3452
  message: string;
3453
+ /** Indicates that this is an access code error. */
3105
3454
  is_access_code_error: true;
3455
+ /** Date and time at which Seam created the error. */
3106
3456
  created_at?: string | undefined;
3107
3457
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3108
3458
  error_code: 'duplicate_code_on_device';
3109
3459
  } | {
3460
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3110
3461
  message: string;
3462
+ /** Indicates that this is an access code error. */
3111
3463
  is_access_code_error: true;
3464
+ /** Date and time at which Seam created the error. */
3112
3465
  created_at?: string | undefined;
3113
3466
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3114
3467
  error_code: 'duplicate_code_attempt_prevented';
3115
3468
  } | {
3469
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3116
3470
  message: string;
3471
+ /** Indicates that this is an access code error. */
3117
3472
  is_access_code_error: true;
3473
+ /** Date and time at which Seam created the error. */
3118
3474
  created_at?: string | undefined;
3119
3475
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3120
3476
  error_code: 'igloohome_bridge_too_many_pending_jobs';
3121
3477
  } | {
3478
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3122
3479
  message: string;
3480
+ /** Indicates that this is an access code error. */
3123
3481
  is_access_code_error: true;
3482
+ /** Date and time at which Seam created the error. */
3124
3483
  created_at?: string | undefined;
3125
3484
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3126
3485
  error_code: 'igloohome_bridge_offline';
3127
3486
  } | {
3487
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3128
3488
  message: string;
3489
+ /** Indicates that this is an access code error. */
3129
3490
  is_access_code_error: true;
3491
+ /** Date and time at which Seam created the error. */
3130
3492
  created_at?: string | undefined;
3131
3493
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3132
3494
  error_code: 'igloohome_offline_access_code_no_variance_available';
3133
3495
  } | {
3496
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3134
3497
  message: string;
3498
+ /** Indicates that this is an access code error. */
3135
3499
  is_access_code_error: true;
3500
+ /** Date and time at which Seam created the error. */
3136
3501
  created_at?: string | undefined;
3137
3502
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3138
3503
  error_code: 'kwikset_unable_to_confirm_code';
3139
3504
  } | {
3505
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3140
3506
  message: string;
3507
+ /** Indicates that this is an access code error. */
3141
3508
  is_access_code_error: true;
3509
+ /** Date and time at which Seam created the error. */
3142
3510
  created_at?: string | undefined;
3143
3511
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3144
3512
  error_code: 'kwikset_unable_to_confirm_deletion';
3145
3513
  } | {
3514
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3146
3515
  message: string;
3516
+ /** Indicates that this is an access code error. */
3147
3517
  is_access_code_error: true;
3518
+ /** Date and time at which Seam created the error. */
3148
3519
  created_at?: string | undefined;
3149
3520
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3150
3521
  error_code: 'code_modified_external_to_seam';
3151
3522
  } | {
3523
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3152
3524
  message: string;
3525
+ /** Indicates that this is an access code error. */
3153
3526
  is_access_code_error: true;
3527
+ /** Date and time at which Seam created the error. */
3154
3528
  created_at?: string | undefined;
3155
3529
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3156
3530
  error_code: 'august_lock_invalid_code_length';
3157
3531
  } | {
3532
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3158
3533
  message: string;
3534
+ /** Indicates that this is an access code error. */
3159
3535
  is_access_code_error: true;
3536
+ /** Date and time at which Seam created the error. */
3160
3537
  created_at?: string | undefined;
3161
3538
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3162
3539
  error_code: 'august_device_programming_delay';
3163
3540
  } | {
3541
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3164
3542
  message: string;
3543
+ /** Indicates that this is an access code error. */
3165
3544
  is_access_code_error: true;
3545
+ /** Date and time at which Seam created the error. */
3166
3546
  created_at?: string | undefined;
3167
3547
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3168
3548
  error_code: 'august_device_slots_full';
3169
3549
  } | {
3550
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3170
3551
  message: string;
3552
+ /** Indicates that this is an access code error. */
3171
3553
  is_access_code_error: true;
3554
+ /** Date and time at which Seam created the error. */
3172
3555
  created_at?: string | undefined;
3173
3556
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3174
3557
  error_code: 'august_lock_missing_keypad';
3175
3558
  } | {
3559
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3176
3560
  message: string;
3561
+ /** Indicates that this is an access code error. */
3177
3562
  is_access_code_error: true;
3563
+ /** Date and time at which Seam created the error. */
3178
3564
  created_at?: string | undefined;
3179
3565
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3180
3566
  error_code: 'august_lock_temporarily_offline';
3181
3567
  } | {
3568
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3182
3569
  message: string;
3570
+ /** Indicates that this is an access code error. */
3183
3571
  is_access_code_error: true;
3572
+ /** Date and time at which Seam created the error. */
3184
3573
  created_at?: string | undefined;
3185
3574
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3186
3575
  error_code: 'salto_ks_user_not_subscribed';
3187
3576
  } | {
3577
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3188
3578
  message: string;
3579
+ /** Indicates that this is an access code error. */
3189
3580
  is_access_code_error: true;
3581
+ /** Date and time at which Seam created the error. */
3190
3582
  created_at?: string | undefined;
3191
3583
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3192
3584
  error_code: 'hubitat_device_programming_delay';
3193
3585
  } | {
3586
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3194
3587
  message: string;
3588
+ /** Indicates that this is an access code error. */
3195
3589
  is_access_code_error: true;
3590
+ /** Date and time at which Seam created the error. */
3196
3591
  created_at?: string | undefined;
3197
3592
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3198
3593
  error_code: 'hubitat_no_free_positions_available';
3199
3594
  } | {
3595
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3200
3596
  message: string;
3597
+ /** Indicates that this is an access code error. */
3201
3598
  is_access_code_error: true;
3599
+ /** Date and time at which Seam created the error. */
3202
3600
  created_at?: string | undefined;
3203
3601
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3204
3602
  error_code: 'wyze_duplicate_code_name';
3205
3603
  } | {
3604
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3206
3605
  message: string;
3606
+ /** Indicates that this is an access code error. */
3207
3607
  is_access_code_error: true;
3608
+ /** Date and time at which Seam created the error. */
3208
3609
  created_at?: string | undefined;
3209
3610
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3210
3611
  error_code: 'wyze_potential_duplicate_code';
3211
3612
  } | {
3613
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3212
3614
  message: string;
3615
+ /** Indicates that this is an access code error. */
3213
3616
  is_access_code_error: true;
3617
+ /** Date and time at which Seam created the error. */
3214
3618
  created_at?: string | undefined;
3215
3619
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3216
3620
  error_code: 'dormakaba_oracode_no_valid_user_level';
@@ -3311,64 +3715,88 @@ export interface Routes {
3311
3715
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3312
3716
  error_code: 'bridge_disconnected';
3313
3717
  }>;
3314
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
3718
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
3315
3719
  warnings: Array<{
3720
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3316
3721
  message: string;
3722
+ /** Date and time at which Seam created the warning. */
3317
3723
  created_at?: string | undefined;
3318
3724
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3319
3725
  warning_code: 'smartthings_failed_to_set_access_code';
3320
3726
  } | {
3727
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3321
3728
  message: string;
3729
+ /** Date and time at which Seam created the warning. */
3322
3730
  created_at?: string | undefined;
3323
3731
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3324
3732
  warning_code: 'schlage_detected_duplicate';
3325
3733
  } | {
3734
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3326
3735
  message: string;
3736
+ /** Date and time at which Seam created the warning. */
3327
3737
  created_at?: string | undefined;
3328
3738
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3329
3739
  warning_code: 'schlage_creation_outage';
3330
3740
  } | {
3741
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3331
3742
  message: string;
3743
+ /** Date and time at which Seam created the warning. */
3332
3744
  created_at?: string | undefined;
3333
3745
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3334
3746
  warning_code: 'code_modified_external_to_seam';
3335
3747
  } | {
3748
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3336
3749
  message: string;
3750
+ /** Date and time at which Seam created the warning. */
3337
3751
  created_at?: string | undefined;
3338
3752
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3339
3753
  warning_code: 'delay_in_setting_on_device';
3340
3754
  } | {
3755
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3341
3756
  message: string;
3757
+ /** Date and time at which Seam created the warning. */
3342
3758
  created_at?: string | undefined;
3343
3759
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3344
3760
  warning_code: 'delay_in_removing_from_device';
3345
3761
  } | {
3762
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3346
3763
  message: string;
3764
+ /** Date and time at which Seam created the warning. */
3347
3765
  created_at?: string | undefined;
3348
3766
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3349
3767
  warning_code: 'third_party_integration_detected';
3350
3768
  } | {
3769
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3351
3770
  message: string;
3771
+ /** Date and time at which Seam created the warning. */
3352
3772
  created_at?: string | undefined;
3353
3773
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3354
3774
  warning_code: 'august_device_programming_delay';
3355
3775
  } | {
3776
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3356
3777
  message: string;
3778
+ /** Date and time at which Seam created the warning. */
3357
3779
  created_at?: string | undefined;
3358
3780
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3359
3781
  warning_code: 'august_lock_temporarily_offline';
3360
3782
  } | {
3783
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3361
3784
  message: string;
3785
+ /** Date and time at which Seam created the warning. */
3362
3786
  created_at?: string | undefined;
3363
3787
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3364
3788
  warning_code: 'igloo_algopin_must_be_used_within_24_hours';
3365
3789
  } | {
3790
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3366
3791
  message: string;
3792
+ /** Date and time at which Seam created the warning. */
3367
3793
  created_at?: string | undefined;
3368
3794
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3369
3795
  warning_code: 'management_transferred';
3370
3796
  } | {
3797
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3371
3798
  message: string;
3799
+ /** Date and time at which Seam created the warning. */
3372
3800
  created_at?: string | undefined;
3373
3801
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3374
3802
  warning_code: 'kwikset_unable_to_confirm_code';
@@ -3379,9 +3807,7 @@ export interface Routes {
3379
3807
  starts_at?: (string | null) | undefined;
3380
3808
  /** Date and time after which the time-bound access code becomes inactive. */
3381
3809
  ends_at?: (string | null) | undefined;
3382
- /**
3383
- Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
3384
- */
3810
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
3385
3811
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
3386
3812
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
3387
3813
  is_backup_access_code_available: boolean;
@@ -3391,9 +3817,9 @@ export interface Routes {
3391
3817
  pulled_backup_access_code_id?: (string | null) | undefined;
3392
3818
  /** Indicates whether changes to the access code from external sources are permitted. */
3393
3819
  is_external_modification_allowed: boolean;
3394
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
3820
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
3395
3821
  is_one_time_use: boolean;
3396
- /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
3822
+ /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
3397
3823
  is_offline_access_code: boolean;
3398
3824
  }>;
3399
3825
  };
@@ -3403,18 +3829,25 @@ export interface Routes {
3403
3829
  method: 'POST';
3404
3830
  queryParams: {};
3405
3831
  jsonBody: {
3832
+ /** ID of the access code for which you want to pull a backup access code. */
3406
3833
  access_code_id: string;
3407
3834
  };
3408
3835
  commonParams: {};
3409
3836
  formData: {};
3410
3837
  jsonResponse: {
3411
- /** */
3838
+ /** Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
3839
+
3840
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
3841
+
3842
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
3843
+
3844
+ In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
3412
3845
  backup_access_code: {
3413
3846
  /** Unique identifier for a group of access codes that share the same code. */
3414
3847
  common_code_key: string | null;
3415
3848
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
3416
3849
  is_scheduled_on_device?: boolean | undefined;
3417
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
3850
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
3418
3851
  type: 'time_bound' | 'ongoing';
3419
3852
  /** Indicates whether the access code is waiting for a code assignment. */
3420
3853
  is_waiting_for_code_assignment?: boolean | undefined;
@@ -3428,148 +3861,220 @@ export interface Routes {
3428
3861
  code: string | null;
3429
3862
  /** Date and time at which the access code was created. */
3430
3863
  created_at: string;
3431
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
3864
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
3432
3865
  errors: Array<{
3866
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3433
3867
  message: string;
3868
+ /** Indicates that this is an access code error. */
3434
3869
  is_access_code_error: true;
3870
+ /** Date and time at which Seam created the error. */
3435
3871
  created_at?: string | undefined;
3436
3872
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3437
3873
  error_code: 'smartthings_failed_to_set_access_code';
3438
3874
  } | {
3875
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3439
3876
  message: string;
3877
+ /** Indicates that this is an access code error. */
3440
3878
  is_access_code_error: true;
3879
+ /** Date and time at which Seam created the error. */
3441
3880
  created_at?: string | undefined;
3442
3881
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3443
3882
  error_code: 'smartthings_failed_to_set_after_multiple_retries';
3444
3883
  } | {
3884
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3445
3885
  message: string;
3886
+ /** Indicates that this is an access code error. */
3446
3887
  is_access_code_error: true;
3888
+ /** Date and time at which Seam created the error. */
3447
3889
  created_at?: string | undefined;
3448
3890
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3449
3891
  error_code: 'smartthings_no_free_slots_available';
3450
3892
  } | {
3893
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3451
3894
  message: string;
3895
+ /** Indicates that this is an access code error. */
3452
3896
  is_access_code_error: true;
3897
+ /** Date and time at which Seam created the error. */
3453
3898
  created_at?: string | undefined;
3454
3899
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3455
3900
  error_code: 'failed_to_set_on_device';
3456
3901
  } | {
3902
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3457
3903
  message: string;
3904
+ /** Indicates that this is an access code error. */
3458
3905
  is_access_code_error: true;
3906
+ /** Date and time at which Seam created the error. */
3459
3907
  created_at?: string | undefined;
3460
3908
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3461
3909
  error_code: 'failed_to_remove_from_device';
3462
3910
  } | {
3911
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3463
3912
  message: string;
3913
+ /** Indicates that this is an access code error. */
3464
3914
  is_access_code_error: true;
3915
+ /** Date and time at which Seam created the error. */
3465
3916
  created_at?: string | undefined;
3466
3917
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3467
3918
  error_code: 'duplicate_code_on_device';
3468
3919
  } | {
3920
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3469
3921
  message: string;
3922
+ /** Indicates that this is an access code error. */
3470
3923
  is_access_code_error: true;
3924
+ /** Date and time at which Seam created the error. */
3471
3925
  created_at?: string | undefined;
3472
3926
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3473
3927
  error_code: 'duplicate_code_attempt_prevented';
3474
3928
  } | {
3929
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3475
3930
  message: string;
3931
+ /** Indicates that this is an access code error. */
3476
3932
  is_access_code_error: true;
3933
+ /** Date and time at which Seam created the error. */
3477
3934
  created_at?: string | undefined;
3478
3935
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3479
3936
  error_code: 'igloohome_bridge_too_many_pending_jobs';
3480
3937
  } | {
3938
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3481
3939
  message: string;
3940
+ /** Indicates that this is an access code error. */
3482
3941
  is_access_code_error: true;
3942
+ /** Date and time at which Seam created the error. */
3483
3943
  created_at?: string | undefined;
3484
3944
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3485
3945
  error_code: 'igloohome_bridge_offline';
3486
3946
  } | {
3947
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3487
3948
  message: string;
3949
+ /** Indicates that this is an access code error. */
3488
3950
  is_access_code_error: true;
3951
+ /** Date and time at which Seam created the error. */
3489
3952
  created_at?: string | undefined;
3490
3953
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3491
3954
  error_code: 'igloohome_offline_access_code_no_variance_available';
3492
3955
  } | {
3956
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3493
3957
  message: string;
3958
+ /** Indicates that this is an access code error. */
3494
3959
  is_access_code_error: true;
3960
+ /** Date and time at which Seam created the error. */
3495
3961
  created_at?: string | undefined;
3496
3962
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3497
3963
  error_code: 'kwikset_unable_to_confirm_code';
3498
3964
  } | {
3965
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3499
3966
  message: string;
3967
+ /** Indicates that this is an access code error. */
3500
3968
  is_access_code_error: true;
3969
+ /** Date and time at which Seam created the error. */
3501
3970
  created_at?: string | undefined;
3502
3971
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3503
3972
  error_code: 'kwikset_unable_to_confirm_deletion';
3504
3973
  } | {
3974
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3505
3975
  message: string;
3976
+ /** Indicates that this is an access code error. */
3506
3977
  is_access_code_error: true;
3978
+ /** Date and time at which Seam created the error. */
3507
3979
  created_at?: string | undefined;
3508
3980
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3509
3981
  error_code: 'code_modified_external_to_seam';
3510
3982
  } | {
3983
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3511
3984
  message: string;
3985
+ /** Indicates that this is an access code error. */
3512
3986
  is_access_code_error: true;
3987
+ /** Date and time at which Seam created the error. */
3513
3988
  created_at?: string | undefined;
3514
3989
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3515
3990
  error_code: 'august_lock_invalid_code_length';
3516
3991
  } | {
3992
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3517
3993
  message: string;
3994
+ /** Indicates that this is an access code error. */
3518
3995
  is_access_code_error: true;
3996
+ /** Date and time at which Seam created the error. */
3519
3997
  created_at?: string | undefined;
3520
3998
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3521
3999
  error_code: 'august_device_programming_delay';
3522
4000
  } | {
4001
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3523
4002
  message: string;
4003
+ /** Indicates that this is an access code error. */
3524
4004
  is_access_code_error: true;
4005
+ /** Date and time at which Seam created the error. */
3525
4006
  created_at?: string | undefined;
3526
4007
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3527
4008
  error_code: 'august_device_slots_full';
3528
4009
  } | {
4010
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3529
4011
  message: string;
4012
+ /** Indicates that this is an access code error. */
3530
4013
  is_access_code_error: true;
4014
+ /** Date and time at which Seam created the error. */
3531
4015
  created_at?: string | undefined;
3532
4016
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3533
4017
  error_code: 'august_lock_missing_keypad';
3534
4018
  } | {
4019
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3535
4020
  message: string;
4021
+ /** Indicates that this is an access code error. */
3536
4022
  is_access_code_error: true;
4023
+ /** Date and time at which Seam created the error. */
3537
4024
  created_at?: string | undefined;
3538
4025
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3539
4026
  error_code: 'august_lock_temporarily_offline';
3540
4027
  } | {
4028
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3541
4029
  message: string;
4030
+ /** Indicates that this is an access code error. */
3542
4031
  is_access_code_error: true;
4032
+ /** Date and time at which Seam created the error. */
3543
4033
  created_at?: string | undefined;
3544
4034
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3545
4035
  error_code: 'salto_ks_user_not_subscribed';
3546
4036
  } | {
4037
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3547
4038
  message: string;
4039
+ /** Indicates that this is an access code error. */
3548
4040
  is_access_code_error: true;
4041
+ /** Date and time at which Seam created the error. */
3549
4042
  created_at?: string | undefined;
3550
4043
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3551
4044
  error_code: 'hubitat_device_programming_delay';
3552
4045
  } | {
4046
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3553
4047
  message: string;
4048
+ /** Indicates that this is an access code error. */
3554
4049
  is_access_code_error: true;
4050
+ /** Date and time at which Seam created the error. */
3555
4051
  created_at?: string | undefined;
3556
4052
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3557
4053
  error_code: 'hubitat_no_free_positions_available';
3558
4054
  } | {
4055
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3559
4056
  message: string;
4057
+ /** Indicates that this is an access code error. */
3560
4058
  is_access_code_error: true;
4059
+ /** Date and time at which Seam created the error. */
3561
4060
  created_at?: string | undefined;
3562
4061
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3563
4062
  error_code: 'wyze_duplicate_code_name';
3564
4063
  } | {
4064
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3565
4065
  message: string;
4066
+ /** Indicates that this is an access code error. */
3566
4067
  is_access_code_error: true;
4068
+ /** Date and time at which Seam created the error. */
3567
4069
  created_at?: string | undefined;
3568
4070
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3569
4071
  error_code: 'wyze_potential_duplicate_code';
3570
4072
  } | {
4073
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3571
4074
  message: string;
4075
+ /** Indicates that this is an access code error. */
3572
4076
  is_access_code_error: true;
4077
+ /** Date and time at which Seam created the error. */
3573
4078
  created_at?: string | undefined;
3574
4079
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3575
4080
  error_code: 'dormakaba_oracode_no_valid_user_level';
@@ -3670,64 +4175,88 @@ export interface Routes {
3670
4175
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3671
4176
  error_code: 'bridge_disconnected';
3672
4177
  }>;
3673
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
4178
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
3674
4179
  warnings: Array<{
4180
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3675
4181
  message: string;
4182
+ /** Date and time at which Seam created the warning. */
3676
4183
  created_at?: string | undefined;
3677
4184
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3678
4185
  warning_code: 'smartthings_failed_to_set_access_code';
3679
4186
  } | {
4187
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3680
4188
  message: string;
4189
+ /** Date and time at which Seam created the warning. */
3681
4190
  created_at?: string | undefined;
3682
4191
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3683
4192
  warning_code: 'schlage_detected_duplicate';
3684
4193
  } | {
4194
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3685
4195
  message: string;
4196
+ /** Date and time at which Seam created the warning. */
3686
4197
  created_at?: string | undefined;
3687
4198
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3688
4199
  warning_code: 'schlage_creation_outage';
3689
4200
  } | {
4201
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3690
4202
  message: string;
4203
+ /** Date and time at which Seam created the warning. */
3691
4204
  created_at?: string | undefined;
3692
4205
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3693
4206
  warning_code: 'code_modified_external_to_seam';
3694
4207
  } | {
4208
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3695
4209
  message: string;
4210
+ /** Date and time at which Seam created the warning. */
3696
4211
  created_at?: string | undefined;
3697
4212
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3698
4213
  warning_code: 'delay_in_setting_on_device';
3699
4214
  } | {
4215
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3700
4216
  message: string;
4217
+ /** Date and time at which Seam created the warning. */
3701
4218
  created_at?: string | undefined;
3702
4219
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3703
4220
  warning_code: 'delay_in_removing_from_device';
3704
4221
  } | {
4222
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3705
4223
  message: string;
4224
+ /** Date and time at which Seam created the warning. */
3706
4225
  created_at?: string | undefined;
3707
4226
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3708
4227
  warning_code: 'third_party_integration_detected';
3709
4228
  } | {
4229
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3710
4230
  message: string;
4231
+ /** Date and time at which Seam created the warning. */
3711
4232
  created_at?: string | undefined;
3712
4233
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3713
4234
  warning_code: 'august_device_programming_delay';
3714
4235
  } | {
4236
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3715
4237
  message: string;
4238
+ /** Date and time at which Seam created the warning. */
3716
4239
  created_at?: string | undefined;
3717
4240
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3718
4241
  warning_code: 'august_lock_temporarily_offline';
3719
4242
  } | {
4243
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3720
4244
  message: string;
4245
+ /** Date and time at which Seam created the warning. */
3721
4246
  created_at?: string | undefined;
3722
4247
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3723
4248
  warning_code: 'igloo_algopin_must_be_used_within_24_hours';
3724
4249
  } | {
4250
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3725
4251
  message: string;
4252
+ /** Date and time at which Seam created the warning. */
3726
4253
  created_at?: string | undefined;
3727
4254
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3728
4255
  warning_code: 'management_transferred';
3729
4256
  } | {
4257
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
3730
4258
  message: string;
4259
+ /** Date and time at which Seam created the warning. */
3731
4260
  created_at?: string | undefined;
3732
4261
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
3733
4262
  warning_code: 'kwikset_unable_to_confirm_code';
@@ -3738,9 +4267,7 @@ export interface Routes {
3738
4267
  starts_at?: (string | null) | undefined;
3739
4268
  /** Date and time after which the time-bound access code becomes inactive. */
3740
4269
  ends_at?: (string | null) | undefined;
3741
- /**
3742
- Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
3743
- */
4270
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
3744
4271
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
3745
4272
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
3746
4273
  is_backup_access_code_available: boolean;
@@ -3750,18 +4277,24 @@ export interface Routes {
3750
4277
  pulled_backup_access_code_id?: (string | null) | undefined;
3751
4278
  /** Indicates whether changes to the access code from external sources are permitted. */
3752
4279
  is_external_modification_allowed: boolean;
3753
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
4280
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
3754
4281
  is_one_time_use: boolean;
3755
- /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
4282
+ /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
3756
4283
  is_offline_access_code: boolean;
3757
4284
  };
3758
- /** */
4285
+ /** Represents a smart lock [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes).
4286
+
4287
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly. Using the Seam Access Code API, you can easily generate access codes on the hundreds of door lock models with which we integrate.
4288
+
4289
+ Seam supports programming two types of access codes: [ongoing](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#ongoing-access-codes) and [time-bound](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#time-bound-access-codes). To differentiate between the two, refer to the `type` property of the access code. Ongoing codes display as `ongoing`, whereas time-bound codes are labeled `time_bound`.
4290
+
4291
+ In addition, for certain devices, Seam also supports [offline access codes](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#offline-access-codes). Offline access (PIN) codes are designed for door locks that might not always maintain an internet connection. For this type of access code, the device manufacturer uses encryption keys (tokens) to create server-based registries of algorithmically-generated offline PIN codes. Because the tokens remain synchronized with the managed devices, the locks do not require an active internet connection—and you do not need to be near the locks—to create an offline access code. Then, owners or managers can share these offline codes with users through a variety of mechanisms, such as messaging applications. That is, lock users do not need to install a smartphone application to receive an offline access code. */
3759
4292
  access_code: {
3760
4293
  /** Unique identifier for a group of access codes that share the same code. */
3761
4294
  common_code_key: string | null;
3762
4295
  /** Indicates whether the code is set on the device according to a preconfigured schedule. */
3763
4296
  is_scheduled_on_device?: boolean | undefined;
3764
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
4297
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
3765
4298
  type: 'time_bound' | 'ongoing';
3766
4299
  /** Indicates whether the access code is waiting for a code assignment. */
3767
4300
  is_waiting_for_code_assignment?: boolean | undefined;
@@ -3775,148 +4308,220 @@ export interface Routes {
3775
4308
  code: string | null;
3776
4309
  /** Date and time at which the access code was created. */
3777
4310
  created_at: string;
3778
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
4311
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
3779
4312
  errors: Array<{
4313
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3780
4314
  message: string;
4315
+ /** Indicates that this is an access code error. */
3781
4316
  is_access_code_error: true;
4317
+ /** Date and time at which Seam created the error. */
3782
4318
  created_at?: string | undefined;
3783
4319
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3784
4320
  error_code: 'smartthings_failed_to_set_access_code';
3785
4321
  } | {
4322
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3786
4323
  message: string;
4324
+ /** Indicates that this is an access code error. */
3787
4325
  is_access_code_error: true;
4326
+ /** Date and time at which Seam created the error. */
3788
4327
  created_at?: string | undefined;
3789
4328
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3790
4329
  error_code: 'smartthings_failed_to_set_after_multiple_retries';
3791
4330
  } | {
4331
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3792
4332
  message: string;
4333
+ /** Indicates that this is an access code error. */
3793
4334
  is_access_code_error: true;
4335
+ /** Date and time at which Seam created the error. */
3794
4336
  created_at?: string | undefined;
3795
4337
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3796
4338
  error_code: 'smartthings_no_free_slots_available';
3797
4339
  } | {
4340
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3798
4341
  message: string;
4342
+ /** Indicates that this is an access code error. */
3799
4343
  is_access_code_error: true;
4344
+ /** Date and time at which Seam created the error. */
3800
4345
  created_at?: string | undefined;
3801
4346
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3802
4347
  error_code: 'failed_to_set_on_device';
3803
4348
  } | {
4349
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3804
4350
  message: string;
4351
+ /** Indicates that this is an access code error. */
3805
4352
  is_access_code_error: true;
4353
+ /** Date and time at which Seam created the error. */
3806
4354
  created_at?: string | undefined;
3807
4355
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3808
4356
  error_code: 'failed_to_remove_from_device';
3809
4357
  } | {
4358
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3810
4359
  message: string;
4360
+ /** Indicates that this is an access code error. */
3811
4361
  is_access_code_error: true;
4362
+ /** Date and time at which Seam created the error. */
3812
4363
  created_at?: string | undefined;
3813
4364
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3814
4365
  error_code: 'duplicate_code_on_device';
3815
4366
  } | {
4367
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3816
4368
  message: string;
4369
+ /** Indicates that this is an access code error. */
3817
4370
  is_access_code_error: true;
4371
+ /** Date and time at which Seam created the error. */
3818
4372
  created_at?: string | undefined;
3819
4373
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3820
4374
  error_code: 'duplicate_code_attempt_prevented';
3821
4375
  } | {
4376
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3822
4377
  message: string;
4378
+ /** Indicates that this is an access code error. */
3823
4379
  is_access_code_error: true;
4380
+ /** Date and time at which Seam created the error. */
3824
4381
  created_at?: string | undefined;
3825
4382
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3826
4383
  error_code: 'igloohome_bridge_too_many_pending_jobs';
3827
4384
  } | {
4385
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3828
4386
  message: string;
4387
+ /** Indicates that this is an access code error. */
3829
4388
  is_access_code_error: true;
4389
+ /** Date and time at which Seam created the error. */
3830
4390
  created_at?: string | undefined;
3831
4391
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3832
4392
  error_code: 'igloohome_bridge_offline';
3833
4393
  } | {
4394
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3834
4395
  message: string;
4396
+ /** Indicates that this is an access code error. */
3835
4397
  is_access_code_error: true;
4398
+ /** Date and time at which Seam created the error. */
3836
4399
  created_at?: string | undefined;
3837
4400
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3838
4401
  error_code: 'igloohome_offline_access_code_no_variance_available';
3839
4402
  } | {
4403
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3840
4404
  message: string;
4405
+ /** Indicates that this is an access code error. */
3841
4406
  is_access_code_error: true;
4407
+ /** Date and time at which Seam created the error. */
3842
4408
  created_at?: string | undefined;
3843
4409
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3844
4410
  error_code: 'kwikset_unable_to_confirm_code';
3845
4411
  } | {
4412
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3846
4413
  message: string;
4414
+ /** Indicates that this is an access code error. */
3847
4415
  is_access_code_error: true;
4416
+ /** Date and time at which Seam created the error. */
3848
4417
  created_at?: string | undefined;
3849
4418
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3850
4419
  error_code: 'kwikset_unable_to_confirm_deletion';
3851
4420
  } | {
4421
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3852
4422
  message: string;
4423
+ /** Indicates that this is an access code error. */
3853
4424
  is_access_code_error: true;
4425
+ /** Date and time at which Seam created the error. */
3854
4426
  created_at?: string | undefined;
3855
4427
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3856
4428
  error_code: 'code_modified_external_to_seam';
3857
4429
  } | {
4430
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3858
4431
  message: string;
4432
+ /** Indicates that this is an access code error. */
3859
4433
  is_access_code_error: true;
4434
+ /** Date and time at which Seam created the error. */
3860
4435
  created_at?: string | undefined;
3861
4436
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3862
4437
  error_code: 'august_lock_invalid_code_length';
3863
4438
  } | {
4439
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3864
4440
  message: string;
4441
+ /** Indicates that this is an access code error. */
3865
4442
  is_access_code_error: true;
4443
+ /** Date and time at which Seam created the error. */
3866
4444
  created_at?: string | undefined;
3867
4445
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3868
4446
  error_code: 'august_device_programming_delay';
3869
4447
  } | {
4448
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3870
4449
  message: string;
4450
+ /** Indicates that this is an access code error. */
3871
4451
  is_access_code_error: true;
4452
+ /** Date and time at which Seam created the error. */
3872
4453
  created_at?: string | undefined;
3873
4454
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3874
4455
  error_code: 'august_device_slots_full';
3875
4456
  } | {
4457
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3876
4458
  message: string;
4459
+ /** Indicates that this is an access code error. */
3877
4460
  is_access_code_error: true;
4461
+ /** Date and time at which Seam created the error. */
3878
4462
  created_at?: string | undefined;
3879
4463
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3880
4464
  error_code: 'august_lock_missing_keypad';
3881
4465
  } | {
4466
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3882
4467
  message: string;
4468
+ /** Indicates that this is an access code error. */
3883
4469
  is_access_code_error: true;
4470
+ /** Date and time at which Seam created the error. */
3884
4471
  created_at?: string | undefined;
3885
4472
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3886
4473
  error_code: 'august_lock_temporarily_offline';
3887
4474
  } | {
4475
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3888
4476
  message: string;
4477
+ /** Indicates that this is an access code error. */
3889
4478
  is_access_code_error: true;
4479
+ /** Date and time at which Seam created the error. */
3890
4480
  created_at?: string | undefined;
3891
4481
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3892
4482
  error_code: 'salto_ks_user_not_subscribed';
3893
4483
  } | {
4484
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3894
4485
  message: string;
4486
+ /** Indicates that this is an access code error. */
3895
4487
  is_access_code_error: true;
4488
+ /** Date and time at which Seam created the error. */
3896
4489
  created_at?: string | undefined;
3897
4490
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3898
4491
  error_code: 'hubitat_device_programming_delay';
3899
4492
  } | {
4493
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3900
4494
  message: string;
4495
+ /** Indicates that this is an access code error. */
3901
4496
  is_access_code_error: true;
4497
+ /** Date and time at which Seam created the error. */
3902
4498
  created_at?: string | undefined;
3903
4499
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3904
4500
  error_code: 'hubitat_no_free_positions_available';
3905
4501
  } | {
4502
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3906
4503
  message: string;
4504
+ /** Indicates that this is an access code error. */
3907
4505
  is_access_code_error: true;
4506
+ /** Date and time at which Seam created the error. */
3908
4507
  created_at?: string | undefined;
3909
4508
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3910
4509
  error_code: 'wyze_duplicate_code_name';
3911
4510
  } | {
4511
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3912
4512
  message: string;
4513
+ /** Indicates that this is an access code error. */
3913
4514
  is_access_code_error: true;
4515
+ /** Date and time at which Seam created the error. */
3914
4516
  created_at?: string | undefined;
3915
4517
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3916
4518
  error_code: 'wyze_potential_duplicate_code';
3917
4519
  } | {
4520
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3918
4521
  message: string;
4522
+ /** Indicates that this is an access code error. */
3919
4523
  is_access_code_error: true;
4524
+ /** Date and time at which Seam created the error. */
3920
4525
  created_at?: string | undefined;
3921
4526
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
3922
4527
  error_code: 'dormakaba_oracode_no_valid_user_level';
@@ -4017,64 +4622,88 @@ export interface Routes {
4017
4622
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4018
4623
  error_code: 'bridge_disconnected';
4019
4624
  }>;
4020
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
4625
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
4021
4626
  warnings: Array<{
4627
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4022
4628
  message: string;
4629
+ /** Date and time at which Seam created the warning. */
4023
4630
  created_at?: string | undefined;
4024
4631
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4025
4632
  warning_code: 'smartthings_failed_to_set_access_code';
4026
4633
  } | {
4634
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4027
4635
  message: string;
4636
+ /** Date and time at which Seam created the warning. */
4028
4637
  created_at?: string | undefined;
4029
4638
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4030
4639
  warning_code: 'schlage_detected_duplicate';
4031
4640
  } | {
4641
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4032
4642
  message: string;
4643
+ /** Date and time at which Seam created the warning. */
4033
4644
  created_at?: string | undefined;
4034
4645
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4035
4646
  warning_code: 'schlage_creation_outage';
4036
4647
  } | {
4648
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4037
4649
  message: string;
4650
+ /** Date and time at which Seam created the warning. */
4038
4651
  created_at?: string | undefined;
4039
4652
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4040
4653
  warning_code: 'code_modified_external_to_seam';
4041
4654
  } | {
4655
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4042
4656
  message: string;
4657
+ /** Date and time at which Seam created the warning. */
4043
4658
  created_at?: string | undefined;
4044
4659
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4045
4660
  warning_code: 'delay_in_setting_on_device';
4046
4661
  } | {
4662
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4047
4663
  message: string;
4664
+ /** Date and time at which Seam created the warning. */
4048
4665
  created_at?: string | undefined;
4049
4666
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4050
4667
  warning_code: 'delay_in_removing_from_device';
4051
4668
  } | {
4669
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4052
4670
  message: string;
4671
+ /** Date and time at which Seam created the warning. */
4053
4672
  created_at?: string | undefined;
4054
4673
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4055
4674
  warning_code: 'third_party_integration_detected';
4056
4675
  } | {
4676
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4057
4677
  message: string;
4678
+ /** Date and time at which Seam created the warning. */
4058
4679
  created_at?: string | undefined;
4059
4680
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4060
4681
  warning_code: 'august_device_programming_delay';
4061
4682
  } | {
4683
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4062
4684
  message: string;
4685
+ /** Date and time at which Seam created the warning. */
4063
4686
  created_at?: string | undefined;
4064
4687
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4065
4688
  warning_code: 'august_lock_temporarily_offline';
4066
4689
  } | {
4690
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4067
4691
  message: string;
4692
+ /** Date and time at which Seam created the warning. */
4068
4693
  created_at?: string | undefined;
4069
4694
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4070
4695
  warning_code: 'igloo_algopin_must_be_used_within_24_hours';
4071
4696
  } | {
4697
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4072
4698
  message: string;
4699
+ /** Date and time at which Seam created the warning. */
4073
4700
  created_at?: string | undefined;
4074
4701
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4075
4702
  warning_code: 'management_transferred';
4076
4703
  } | {
4704
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4077
4705
  message: string;
4706
+ /** Date and time at which Seam created the warning. */
4078
4707
  created_at?: string | undefined;
4079
4708
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4080
4709
  warning_code: 'kwikset_unable_to_confirm_code';
@@ -4085,9 +4714,7 @@ export interface Routes {
4085
4714
  starts_at?: (string | null) | undefined;
4086
4715
  /** Date and time after which the time-bound access code becomes inactive. */
4087
4716
  ends_at?: (string | null) | undefined;
4088
- /**
4089
- Current status of the access code within the operational lifecycle. Values are "setting," a transitional phase that indicates that the code is being configured or activated; "set", which indicates that the code is active and operational; "unset," which indicates a deactivated or unused state, either before activation or after deliberate deactivation; "removing," which indicates a transitional period in which the code is being deleted or made inactive; and "unknown," which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting.
4090
- */
4717
+ /** Current status of the access code within the operational lifecycle. Values are `setting`, a transitional phase that indicates that the code is being configured or activated; `set`, which indicates that the code is active and operational; `unset`, which indicates a deactivated or unused state, either before activation or after deliberate deactivation; `removing`, which indicates a transitional period in which the code is being deleted or made inactive; and `unknown`, which indicates an indeterminate state, due to reasons such as system errors or incomplete data, that highlights a potential need for system review or troubleshooting. */
4091
4718
  status: 'setting' | 'set' | 'unset' | 'removing' | 'unknown';
4092
4719
  /** Indicates whether a backup access code is available for use if the primary access code is lost or compromised. */
4093
4720
  is_backup_access_code_available: boolean;
@@ -4097,9 +4724,9 @@ export interface Routes {
4097
4724
  pulled_backup_access_code_id?: (string | null) | undefined;
4098
4725
  /** Indicates whether changes to the access code from external sources are permitted. */
4099
4726
  is_external_modification_allowed: boolean;
4100
- /** Indicates whether the access code can only be used once. If "true," the code becomes invalid after the first use. */
4727
+ /** Indicates whether the access code can only be used once. If `true`, the code becomes invalid after the first use. */
4101
4728
  is_one_time_use: boolean;
4102
- /** Indicates whether the access code is intended for use in offline scenarios. If "true," this code can be created on a device without a network connection. */
4729
+ /** Indicates whether the access code is intended for use in offline scenarios. If `true`, this code can be created on a device without a network connection. */
4103
4730
  is_offline_access_code: boolean;
4104
4731
  };
4105
4732
  };
@@ -4109,16 +4736,25 @@ export interface Routes {
4109
4736
  method: 'POST';
4110
4737
  queryParams: {};
4111
4738
  jsonBody: {
4739
+ /** ID of the device for which you want to simulate the creation of an unmanaged access code. */
4112
4740
  device_id: string;
4741
+ /** Name of the simulated unmanaged access code. */
4113
4742
  name: string;
4743
+ /** Code of the simulated unmanaged access code. */
4114
4744
  code: string;
4115
4745
  };
4116
4746
  commonParams: {};
4117
4747
  formData: {};
4118
4748
  jsonResponse: {
4119
- /** */
4749
+ /** Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
4750
+
4751
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.
4752
+
4753
+ When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
4754
+
4755
+ Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. */
4120
4756
  access_code: {
4121
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
4757
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
4122
4758
  type: 'time_bound' | 'ongoing';
4123
4759
  /** Unique identifier for the access code. */
4124
4760
  access_code_id: string;
@@ -4130,148 +4766,220 @@ export interface Routes {
4130
4766
  code: string | null;
4131
4767
  /** Date and time at which the access code was created. */
4132
4768
  created_at: string;
4133
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
4769
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
4134
4770
  errors: Array<{
4771
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4135
4772
  message: string;
4773
+ /** Indicates that this is an access code error. */
4136
4774
  is_access_code_error: true;
4775
+ /** Date and time at which Seam created the error. */
4137
4776
  created_at?: string | undefined;
4138
4777
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4139
4778
  error_code: 'smartthings_failed_to_set_access_code';
4140
4779
  } | {
4780
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4141
4781
  message: string;
4782
+ /** Indicates that this is an access code error. */
4142
4783
  is_access_code_error: true;
4784
+ /** Date and time at which Seam created the error. */
4143
4785
  created_at?: string | undefined;
4144
4786
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4145
4787
  error_code: 'smartthings_failed_to_set_after_multiple_retries';
4146
4788
  } | {
4789
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4147
4790
  message: string;
4791
+ /** Indicates that this is an access code error. */
4148
4792
  is_access_code_error: true;
4793
+ /** Date and time at which Seam created the error. */
4149
4794
  created_at?: string | undefined;
4150
4795
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4151
4796
  error_code: 'smartthings_no_free_slots_available';
4152
4797
  } | {
4798
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4153
4799
  message: string;
4800
+ /** Indicates that this is an access code error. */
4154
4801
  is_access_code_error: true;
4802
+ /** Date and time at which Seam created the error. */
4155
4803
  created_at?: string | undefined;
4156
4804
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4157
4805
  error_code: 'failed_to_set_on_device';
4158
4806
  } | {
4807
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4159
4808
  message: string;
4809
+ /** Indicates that this is an access code error. */
4160
4810
  is_access_code_error: true;
4811
+ /** Date and time at which Seam created the error. */
4161
4812
  created_at?: string | undefined;
4162
4813
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4163
4814
  error_code: 'failed_to_remove_from_device';
4164
4815
  } | {
4816
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4165
4817
  message: string;
4818
+ /** Indicates that this is an access code error. */
4166
4819
  is_access_code_error: true;
4820
+ /** Date and time at which Seam created the error. */
4167
4821
  created_at?: string | undefined;
4168
4822
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4169
4823
  error_code: 'duplicate_code_on_device';
4170
4824
  } | {
4825
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4171
4826
  message: string;
4827
+ /** Indicates that this is an access code error. */
4172
4828
  is_access_code_error: true;
4829
+ /** Date and time at which Seam created the error. */
4173
4830
  created_at?: string | undefined;
4174
4831
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4175
4832
  error_code: 'duplicate_code_attempt_prevented';
4176
4833
  } | {
4834
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4177
4835
  message: string;
4836
+ /** Indicates that this is an access code error. */
4178
4837
  is_access_code_error: true;
4838
+ /** Date and time at which Seam created the error. */
4179
4839
  created_at?: string | undefined;
4180
4840
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4181
4841
  error_code: 'igloohome_bridge_too_many_pending_jobs';
4182
4842
  } | {
4843
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4183
4844
  message: string;
4845
+ /** Indicates that this is an access code error. */
4184
4846
  is_access_code_error: true;
4847
+ /** Date and time at which Seam created the error. */
4185
4848
  created_at?: string | undefined;
4186
4849
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4187
4850
  error_code: 'igloohome_bridge_offline';
4188
4851
  } | {
4852
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4189
4853
  message: string;
4854
+ /** Indicates that this is an access code error. */
4190
4855
  is_access_code_error: true;
4856
+ /** Date and time at which Seam created the error. */
4191
4857
  created_at?: string | undefined;
4192
4858
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4193
4859
  error_code: 'igloohome_offline_access_code_no_variance_available';
4194
4860
  } | {
4861
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4195
4862
  message: string;
4863
+ /** Indicates that this is an access code error. */
4196
4864
  is_access_code_error: true;
4865
+ /** Date and time at which Seam created the error. */
4197
4866
  created_at?: string | undefined;
4198
4867
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4199
4868
  error_code: 'kwikset_unable_to_confirm_code';
4200
4869
  } | {
4870
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4201
4871
  message: string;
4872
+ /** Indicates that this is an access code error. */
4202
4873
  is_access_code_error: true;
4874
+ /** Date and time at which Seam created the error. */
4203
4875
  created_at?: string | undefined;
4204
4876
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4205
4877
  error_code: 'kwikset_unable_to_confirm_deletion';
4206
4878
  } | {
4879
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4207
4880
  message: string;
4881
+ /** Indicates that this is an access code error. */
4208
4882
  is_access_code_error: true;
4883
+ /** Date and time at which Seam created the error. */
4209
4884
  created_at?: string | undefined;
4210
4885
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4211
4886
  error_code: 'code_modified_external_to_seam';
4212
4887
  } | {
4888
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4213
4889
  message: string;
4890
+ /** Indicates that this is an access code error. */
4214
4891
  is_access_code_error: true;
4892
+ /** Date and time at which Seam created the error. */
4215
4893
  created_at?: string | undefined;
4216
4894
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4217
4895
  error_code: 'august_lock_invalid_code_length';
4218
4896
  } | {
4897
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4219
4898
  message: string;
4899
+ /** Indicates that this is an access code error. */
4220
4900
  is_access_code_error: true;
4901
+ /** Date and time at which Seam created the error. */
4221
4902
  created_at?: string | undefined;
4222
4903
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4223
4904
  error_code: 'august_device_programming_delay';
4224
4905
  } | {
4906
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4225
4907
  message: string;
4908
+ /** Indicates that this is an access code error. */
4226
4909
  is_access_code_error: true;
4910
+ /** Date and time at which Seam created the error. */
4227
4911
  created_at?: string | undefined;
4228
4912
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4229
4913
  error_code: 'august_device_slots_full';
4230
4914
  } | {
4915
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4231
4916
  message: string;
4917
+ /** Indicates that this is an access code error. */
4232
4918
  is_access_code_error: true;
4919
+ /** Date and time at which Seam created the error. */
4233
4920
  created_at?: string | undefined;
4234
4921
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4235
4922
  error_code: 'august_lock_missing_keypad';
4236
4923
  } | {
4924
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4237
4925
  message: string;
4926
+ /** Indicates that this is an access code error. */
4238
4927
  is_access_code_error: true;
4928
+ /** Date and time at which Seam created the error. */
4239
4929
  created_at?: string | undefined;
4240
4930
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4241
4931
  error_code: 'august_lock_temporarily_offline';
4242
4932
  } | {
4933
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4243
4934
  message: string;
4935
+ /** Indicates that this is an access code error. */
4244
4936
  is_access_code_error: true;
4937
+ /** Date and time at which Seam created the error. */
4245
4938
  created_at?: string | undefined;
4246
4939
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4247
4940
  error_code: 'salto_ks_user_not_subscribed';
4248
4941
  } | {
4942
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4249
4943
  message: string;
4944
+ /** Indicates that this is an access code error. */
4250
4945
  is_access_code_error: true;
4946
+ /** Date and time at which Seam created the error. */
4251
4947
  created_at?: string | undefined;
4252
4948
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4253
4949
  error_code: 'hubitat_device_programming_delay';
4254
4950
  } | {
4951
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4255
4952
  message: string;
4953
+ /** Indicates that this is an access code error. */
4256
4954
  is_access_code_error: true;
4955
+ /** Date and time at which Seam created the error. */
4257
4956
  created_at?: string | undefined;
4258
4957
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4259
4958
  error_code: 'hubitat_no_free_positions_available';
4260
4959
  } | {
4960
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4261
4961
  message: string;
4962
+ /** Indicates that this is an access code error. */
4262
4963
  is_access_code_error: true;
4964
+ /** Date and time at which Seam created the error. */
4263
4965
  created_at?: string | undefined;
4264
4966
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4265
4967
  error_code: 'wyze_duplicate_code_name';
4266
4968
  } | {
4969
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4267
4970
  message: string;
4971
+ /** Indicates that this is an access code error. */
4268
4972
  is_access_code_error: true;
4973
+ /** Date and time at which Seam created the error. */
4269
4974
  created_at?: string | undefined;
4270
4975
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4271
4976
  error_code: 'wyze_potential_duplicate_code';
4272
4977
  } | {
4978
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
4273
4979
  message: string;
4980
+ /** Indicates that this is an access code error. */
4274
4981
  is_access_code_error: true;
4982
+ /** Date and time at which Seam created the error. */
4275
4983
  created_at?: string | undefined;
4276
4984
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4277
4985
  error_code: 'dormakaba_oracode_no_valid_user_level';
@@ -4372,73 +5080,99 @@ export interface Routes {
4372
5080
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4373
5081
  error_code: 'bridge_disconnected';
4374
5082
  }>;
4375
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
5083
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
4376
5084
  warnings: Array<{
5085
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4377
5086
  message: string;
5087
+ /** Date and time at which Seam created the warning. */
4378
5088
  created_at?: string | undefined;
4379
5089
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4380
5090
  warning_code: 'smartthings_failed_to_set_access_code';
4381
5091
  } | {
5092
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4382
5093
  message: string;
5094
+ /** Date and time at which Seam created the warning. */
4383
5095
  created_at?: string | undefined;
4384
5096
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4385
5097
  warning_code: 'schlage_detected_duplicate';
4386
5098
  } | {
5099
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4387
5100
  message: string;
5101
+ /** Date and time at which Seam created the warning. */
4388
5102
  created_at?: string | undefined;
4389
5103
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4390
5104
  warning_code: 'schlage_creation_outage';
4391
5105
  } | {
5106
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4392
5107
  message: string;
5108
+ /** Date and time at which Seam created the warning. */
4393
5109
  created_at?: string | undefined;
4394
5110
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4395
5111
  warning_code: 'code_modified_external_to_seam';
4396
5112
  } | {
5113
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4397
5114
  message: string;
5115
+ /** Date and time at which Seam created the warning. */
4398
5116
  created_at?: string | undefined;
4399
5117
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4400
5118
  warning_code: 'delay_in_setting_on_device';
4401
5119
  } | {
5120
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4402
5121
  message: string;
5122
+ /** Date and time at which Seam created the warning. */
4403
5123
  created_at?: string | undefined;
4404
5124
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4405
5125
  warning_code: 'delay_in_removing_from_device';
4406
5126
  } | {
5127
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4407
5128
  message: string;
5129
+ /** Date and time at which Seam created the warning. */
4408
5130
  created_at?: string | undefined;
4409
5131
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4410
5132
  warning_code: 'third_party_integration_detected';
4411
5133
  } | {
5134
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4412
5135
  message: string;
5136
+ /** Date and time at which Seam created the warning. */
4413
5137
  created_at?: string | undefined;
4414
5138
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4415
5139
  warning_code: 'august_device_programming_delay';
4416
5140
  } | {
5141
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4417
5142
  message: string;
5143
+ /** Date and time at which Seam created the warning. */
4418
5144
  created_at?: string | undefined;
4419
5145
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
4420
5146
  warning_code: 'august_lock_temporarily_offline';
4421
5147
  } | {
5148
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4422
5149
  message: string;
5150
+ /** Date and time at which Seam created the warning. */
4423
5151
  created_at?: string | undefined;
4424
5152
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4425
5153
  warning_code: 'igloo_algopin_must_be_used_within_24_hours';
4426
5154
  } | {
5155
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4427
5156
  message: string;
5157
+ /** Date and time at which Seam created the warning. */
4428
5158
  created_at?: string | undefined;
4429
5159
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4430
5160
  warning_code: 'management_transferred';
4431
5161
  } | {
5162
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
4432
5163
  message: string;
5164
+ /** Date and time at which Seam created the warning. */
4433
5165
  created_at?: string | undefined;
4434
5166
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
4435
5167
  warning_code: 'kwikset_unable_to_confirm_code';
4436
5168
  }>;
5169
+ /** Indicates that Seam does not manage the access code. */
4437
5170
  is_managed: false;
4438
5171
  /** Date and time at which the time-bound access code becomes active. */
4439
5172
  starts_at?: (string | null) | undefined;
4440
5173
  /** Date and time after which the time-bound access code becomes inactive. */
4441
5174
  ends_at?: (string | null) | undefined;
5175
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
4442
5176
  status: 'set';
4443
5177
  };
4444
5178
  };
@@ -4449,10 +5183,15 @@ export interface Routes {
4449
5183
  queryParams: {};
4450
5184
  jsonBody: {};
4451
5185
  commonParams: {
5186
+ /** ID of the unmanaged access code that you want to convert to a managed access code. */
4452
5187
  access_code_id: string;
5188
+ /** Indicates whether external modification of the access code is allowed. */
4453
5189
  is_external_modification_allowed?: boolean | undefined;
5190
+ /** Indicates whether external modification of the access code is allowed. */
4454
5191
  allow_external_modification?: boolean | undefined;
5192
+ /** Indicates whether to force the access code conversion. To switch management of an access code from one Seam workspace to another, set `force` to `true`. */
4455
5193
  force?: boolean | undefined;
5194
+ /** */
4456
5195
  sync?: boolean;
4457
5196
  };
4458
5197
  formData: {};
@@ -4464,7 +5203,9 @@ export interface Routes {
4464
5203
  queryParams: {};
4465
5204
  jsonBody: {};
4466
5205
  commonParams: {
5206
+ /** ID of the unmanaged access code to delete. */
4467
5207
  access_code_id: string;
5208
+ /** */
4468
5209
  sync?: boolean;
4469
5210
  };
4470
5211
  formData: {};
@@ -5427,15 +6168,24 @@ export interface Routes {
5427
6168
  queryParams: {};
5428
6169
  jsonBody: {};
5429
6170
  commonParams: {
6171
+ /** ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
5430
6172
  device_id?: string | undefined;
6173
+ /** ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
5431
6174
  access_code_id?: string | undefined;
6175
+ /** Code of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`. */
5432
6176
  code?: string | undefined;
5433
6177
  };
5434
6178
  formData: {};
5435
6179
  jsonResponse: {
5436
- /** */
6180
+ /** Represents an [unmanaged smart lock access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/migrating-existing-access-codes).
6181
+
6182
+ An access code is a code used for a keypad or pinpad device. Unlike physical keys, which can easily be lost or duplicated, PIN codes can be customized, tracked, and altered on the fly.
6183
+
6184
+ When you create an access code on a device in Seam, it is created as a managed access code. Access codes that exist on a device that were not created through Seam are considered unmanaged codes. We strictly limit the operations that can be performed on unmanaged codes.
6185
+
6186
+ Prior to using Seam to manage your devices, you may have used another lock management system to manage the access codes on your devices. Where possible, we help you keep any existing access codes on devices and transition those codes to ones managed by your Seam workspace. */
5437
6187
  access_code: {
5438
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
6188
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
5439
6189
  type: 'time_bound' | 'ongoing';
5440
6190
  /** Unique identifier for the access code. */
5441
6191
  access_code_id: string;
@@ -5447,148 +6197,220 @@ export interface Routes {
5447
6197
  code: string | null;
5448
6198
  /** Date and time at which the access code was created. */
5449
6199
  created_at: string;
5450
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6200
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
5451
6201
  errors: Array<{
6202
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5452
6203
  message: string;
6204
+ /** Indicates that this is an access code error. */
5453
6205
  is_access_code_error: true;
6206
+ /** Date and time at which Seam created the error. */
5454
6207
  created_at?: string | undefined;
5455
6208
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5456
6209
  error_code: 'smartthings_failed_to_set_access_code';
5457
6210
  } | {
6211
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5458
6212
  message: string;
6213
+ /** Indicates that this is an access code error. */
5459
6214
  is_access_code_error: true;
6215
+ /** Date and time at which Seam created the error. */
5460
6216
  created_at?: string | undefined;
5461
6217
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5462
6218
  error_code: 'smartthings_failed_to_set_after_multiple_retries';
5463
6219
  } | {
6220
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5464
6221
  message: string;
6222
+ /** Indicates that this is an access code error. */
5465
6223
  is_access_code_error: true;
6224
+ /** Date and time at which Seam created the error. */
5466
6225
  created_at?: string | undefined;
5467
6226
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5468
6227
  error_code: 'smartthings_no_free_slots_available';
5469
6228
  } | {
6229
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5470
6230
  message: string;
6231
+ /** Indicates that this is an access code error. */
5471
6232
  is_access_code_error: true;
6233
+ /** Date and time at which Seam created the error. */
5472
6234
  created_at?: string | undefined;
5473
6235
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5474
6236
  error_code: 'failed_to_set_on_device';
5475
6237
  } | {
6238
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5476
6239
  message: string;
6240
+ /** Indicates that this is an access code error. */
5477
6241
  is_access_code_error: true;
6242
+ /** Date and time at which Seam created the error. */
5478
6243
  created_at?: string | undefined;
5479
6244
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5480
6245
  error_code: 'failed_to_remove_from_device';
5481
6246
  } | {
6247
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5482
6248
  message: string;
6249
+ /** Indicates that this is an access code error. */
5483
6250
  is_access_code_error: true;
6251
+ /** Date and time at which Seam created the error. */
5484
6252
  created_at?: string | undefined;
5485
6253
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5486
6254
  error_code: 'duplicate_code_on_device';
5487
6255
  } | {
6256
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5488
6257
  message: string;
6258
+ /** Indicates that this is an access code error. */
5489
6259
  is_access_code_error: true;
6260
+ /** Date and time at which Seam created the error. */
5490
6261
  created_at?: string | undefined;
5491
6262
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5492
6263
  error_code: 'duplicate_code_attempt_prevented';
5493
6264
  } | {
6265
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5494
6266
  message: string;
6267
+ /** Indicates that this is an access code error. */
5495
6268
  is_access_code_error: true;
6269
+ /** Date and time at which Seam created the error. */
5496
6270
  created_at?: string | undefined;
5497
6271
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5498
6272
  error_code: 'igloohome_bridge_too_many_pending_jobs';
5499
6273
  } | {
6274
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5500
6275
  message: string;
6276
+ /** Indicates that this is an access code error. */
5501
6277
  is_access_code_error: true;
6278
+ /** Date and time at which Seam created the error. */
5502
6279
  created_at?: string | undefined;
5503
6280
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5504
6281
  error_code: 'igloohome_bridge_offline';
5505
6282
  } | {
6283
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5506
6284
  message: string;
6285
+ /** Indicates that this is an access code error. */
5507
6286
  is_access_code_error: true;
6287
+ /** Date and time at which Seam created the error. */
5508
6288
  created_at?: string | undefined;
5509
6289
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5510
6290
  error_code: 'igloohome_offline_access_code_no_variance_available';
5511
6291
  } | {
6292
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5512
6293
  message: string;
6294
+ /** Indicates that this is an access code error. */
5513
6295
  is_access_code_error: true;
6296
+ /** Date and time at which Seam created the error. */
5514
6297
  created_at?: string | undefined;
5515
6298
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5516
6299
  error_code: 'kwikset_unable_to_confirm_code';
5517
6300
  } | {
6301
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5518
6302
  message: string;
6303
+ /** Indicates that this is an access code error. */
5519
6304
  is_access_code_error: true;
6305
+ /** Date and time at which Seam created the error. */
5520
6306
  created_at?: string | undefined;
5521
6307
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5522
6308
  error_code: 'kwikset_unable_to_confirm_deletion';
5523
6309
  } | {
6310
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5524
6311
  message: string;
6312
+ /** Indicates that this is an access code error. */
5525
6313
  is_access_code_error: true;
6314
+ /** Date and time at which Seam created the error. */
5526
6315
  created_at?: string | undefined;
5527
6316
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5528
6317
  error_code: 'code_modified_external_to_seam';
5529
6318
  } | {
6319
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5530
6320
  message: string;
6321
+ /** Indicates that this is an access code error. */
5531
6322
  is_access_code_error: true;
6323
+ /** Date and time at which Seam created the error. */
5532
6324
  created_at?: string | undefined;
5533
6325
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5534
6326
  error_code: 'august_lock_invalid_code_length';
5535
6327
  } | {
6328
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5536
6329
  message: string;
6330
+ /** Indicates that this is an access code error. */
5537
6331
  is_access_code_error: true;
6332
+ /** Date and time at which Seam created the error. */
5538
6333
  created_at?: string | undefined;
5539
6334
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5540
6335
  error_code: 'august_device_programming_delay';
5541
6336
  } | {
6337
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5542
6338
  message: string;
6339
+ /** Indicates that this is an access code error. */
5543
6340
  is_access_code_error: true;
6341
+ /** Date and time at which Seam created the error. */
5544
6342
  created_at?: string | undefined;
5545
6343
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5546
6344
  error_code: 'august_device_slots_full';
5547
6345
  } | {
6346
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5548
6347
  message: string;
6348
+ /** Indicates that this is an access code error. */
5549
6349
  is_access_code_error: true;
6350
+ /** Date and time at which Seam created the error. */
5550
6351
  created_at?: string | undefined;
5551
6352
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5552
6353
  error_code: 'august_lock_missing_keypad';
5553
6354
  } | {
6355
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5554
6356
  message: string;
6357
+ /** Indicates that this is an access code error. */
5555
6358
  is_access_code_error: true;
6359
+ /** Date and time at which Seam created the error. */
5556
6360
  created_at?: string | undefined;
5557
6361
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5558
6362
  error_code: 'august_lock_temporarily_offline';
5559
6363
  } | {
6364
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5560
6365
  message: string;
6366
+ /** Indicates that this is an access code error. */
5561
6367
  is_access_code_error: true;
6368
+ /** Date and time at which Seam created the error. */
5562
6369
  created_at?: string | undefined;
5563
6370
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5564
6371
  error_code: 'salto_ks_user_not_subscribed';
5565
6372
  } | {
6373
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5566
6374
  message: string;
6375
+ /** Indicates that this is an access code error. */
5567
6376
  is_access_code_error: true;
6377
+ /** Date and time at which Seam created the error. */
5568
6378
  created_at?: string | undefined;
5569
6379
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5570
6380
  error_code: 'hubitat_device_programming_delay';
5571
6381
  } | {
6382
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5572
6383
  message: string;
6384
+ /** Indicates that this is an access code error. */
5573
6385
  is_access_code_error: true;
6386
+ /** Date and time at which Seam created the error. */
5574
6387
  created_at?: string | undefined;
5575
6388
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5576
6389
  error_code: 'hubitat_no_free_positions_available';
5577
6390
  } | {
6391
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5578
6392
  message: string;
6393
+ /** Indicates that this is an access code error. */
5579
6394
  is_access_code_error: true;
6395
+ /** Date and time at which Seam created the error. */
5580
6396
  created_at?: string | undefined;
5581
6397
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5582
6398
  error_code: 'wyze_duplicate_code_name';
5583
6399
  } | {
6400
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5584
6401
  message: string;
6402
+ /** Indicates that this is an access code error. */
5585
6403
  is_access_code_error: true;
6404
+ /** Date and time at which Seam created the error. */
5586
6405
  created_at?: string | undefined;
5587
6406
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5588
6407
  error_code: 'wyze_potential_duplicate_code';
5589
6408
  } | {
6409
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5590
6410
  message: string;
6411
+ /** Indicates that this is an access code error. */
5591
6412
  is_access_code_error: true;
6413
+ /** Date and time at which Seam created the error. */
5592
6414
  created_at?: string | undefined;
5593
6415
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5594
6416
  error_code: 'dormakaba_oracode_no_valid_user_level';
@@ -5689,73 +6511,99 @@ export interface Routes {
5689
6511
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5690
6512
  error_code: 'bridge_disconnected';
5691
6513
  }>;
5692
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
6514
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
5693
6515
  warnings: Array<{
6516
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5694
6517
  message: string;
6518
+ /** Date and time at which Seam created the warning. */
5695
6519
  created_at?: string | undefined;
5696
6520
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5697
6521
  warning_code: 'smartthings_failed_to_set_access_code';
5698
6522
  } | {
6523
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5699
6524
  message: string;
6525
+ /** Date and time at which Seam created the warning. */
5700
6526
  created_at?: string | undefined;
5701
6527
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5702
6528
  warning_code: 'schlage_detected_duplicate';
5703
6529
  } | {
6530
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5704
6531
  message: string;
6532
+ /** Date and time at which Seam created the warning. */
5705
6533
  created_at?: string | undefined;
5706
6534
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5707
6535
  warning_code: 'schlage_creation_outage';
5708
6536
  } | {
6537
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5709
6538
  message: string;
6539
+ /** Date and time at which Seam created the warning. */
5710
6540
  created_at?: string | undefined;
5711
6541
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5712
6542
  warning_code: 'code_modified_external_to_seam';
5713
6543
  } | {
6544
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5714
6545
  message: string;
6546
+ /** Date and time at which Seam created the warning. */
5715
6547
  created_at?: string | undefined;
5716
6548
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5717
6549
  warning_code: 'delay_in_setting_on_device';
5718
6550
  } | {
6551
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5719
6552
  message: string;
6553
+ /** Date and time at which Seam created the warning. */
5720
6554
  created_at?: string | undefined;
5721
6555
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5722
6556
  warning_code: 'delay_in_removing_from_device';
5723
6557
  } | {
6558
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5724
6559
  message: string;
6560
+ /** Date and time at which Seam created the warning. */
5725
6561
  created_at?: string | undefined;
5726
6562
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5727
6563
  warning_code: 'third_party_integration_detected';
5728
6564
  } | {
6565
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5729
6566
  message: string;
6567
+ /** Date and time at which Seam created the warning. */
5730
6568
  created_at?: string | undefined;
5731
6569
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5732
6570
  warning_code: 'august_device_programming_delay';
5733
6571
  } | {
6572
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5734
6573
  message: string;
6574
+ /** Date and time at which Seam created the warning. */
5735
6575
  created_at?: string | undefined;
5736
6576
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5737
6577
  warning_code: 'august_lock_temporarily_offline';
5738
6578
  } | {
6579
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5739
6580
  message: string;
6581
+ /** Date and time at which Seam created the warning. */
5740
6582
  created_at?: string | undefined;
5741
6583
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5742
6584
  warning_code: 'igloo_algopin_must_be_used_within_24_hours';
5743
6585
  } | {
6586
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5744
6587
  message: string;
6588
+ /** Date and time at which Seam created the warning. */
5745
6589
  created_at?: string | undefined;
5746
6590
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5747
6591
  warning_code: 'management_transferred';
5748
6592
  } | {
6593
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
5749
6594
  message: string;
6595
+ /** Date and time at which Seam created the warning. */
5750
6596
  created_at?: string | undefined;
5751
6597
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
5752
6598
  warning_code: 'kwikset_unable_to_confirm_code';
5753
6599
  }>;
6600
+ /** Indicates that Seam does not manage the access code. */
5754
6601
  is_managed: false;
5755
6602
  /** Date and time at which the time-bound access code becomes active. */
5756
6603
  starts_at?: (string | null) | undefined;
5757
6604
  /** Date and time after which the time-bound access code becomes inactive. */
5758
6605
  ends_at?: (string | null) | undefined;
6606
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
5759
6607
  status: 'set';
5760
6608
  };
5761
6609
  };
@@ -5766,13 +6614,15 @@ export interface Routes {
5766
6614
  queryParams: {};
5767
6615
  jsonBody: {};
5768
6616
  commonParams: {
6617
+ /** ID of the device for which you want to list unmanaged access codes. */
5769
6618
  device_id: string;
6619
+ /** Your user ID for the user by which to filter unmanaged access codes. */
5770
6620
  user_identifier_key?: string | undefined;
5771
6621
  };
5772
6622
  formData: {};
5773
6623
  jsonResponse: {
5774
6624
  access_codes: Array<{
5775
- /** Nature of the access code. Values are "ongoing" for access codes that are active continuously until deactivated manually or "time_bound" for access codes that have a specific duration. */
6625
+ /** Nature of the access code. Values are `ongoing` for access codes that are active continuously until deactivated manually or `time_bound` for access codes that have a specific duration. */
5776
6626
  type: 'time_bound' | 'ongoing';
5777
6627
  /** Unique identifier for the access code. */
5778
6628
  access_code_id: string;
@@ -5784,148 +6634,220 @@ export interface Routes {
5784
6634
  code: string | null;
5785
6635
  /** Date and time at which the access code was created. */
5786
6636
  created_at: string;
5787
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6637
+ /** Errors associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
5788
6638
  errors: Array<{
6639
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5789
6640
  message: string;
6641
+ /** Indicates that this is an access code error. */
5790
6642
  is_access_code_error: true;
6643
+ /** Date and time at which Seam created the error. */
5791
6644
  created_at?: string | undefined;
5792
6645
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5793
6646
  error_code: 'smartthings_failed_to_set_access_code';
5794
6647
  } | {
6648
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5795
6649
  message: string;
6650
+ /** Indicates that this is an access code error. */
5796
6651
  is_access_code_error: true;
6652
+ /** Date and time at which Seam created the error. */
5797
6653
  created_at?: string | undefined;
5798
6654
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5799
6655
  error_code: 'smartthings_failed_to_set_after_multiple_retries';
5800
6656
  } | {
6657
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5801
6658
  message: string;
6659
+ /** Indicates that this is an access code error. */
5802
6660
  is_access_code_error: true;
6661
+ /** Date and time at which Seam created the error. */
5803
6662
  created_at?: string | undefined;
5804
6663
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5805
6664
  error_code: 'smartthings_no_free_slots_available';
5806
6665
  } | {
6666
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5807
6667
  message: string;
6668
+ /** Indicates that this is an access code error. */
5808
6669
  is_access_code_error: true;
6670
+ /** Date and time at which Seam created the error. */
5809
6671
  created_at?: string | undefined;
5810
6672
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5811
6673
  error_code: 'failed_to_set_on_device';
5812
6674
  } | {
6675
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5813
6676
  message: string;
6677
+ /** Indicates that this is an access code error. */
5814
6678
  is_access_code_error: true;
6679
+ /** Date and time at which Seam created the error. */
5815
6680
  created_at?: string | undefined;
5816
6681
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5817
6682
  error_code: 'failed_to_remove_from_device';
5818
6683
  } | {
6684
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5819
6685
  message: string;
6686
+ /** Indicates that this is an access code error. */
5820
6687
  is_access_code_error: true;
6688
+ /** Date and time at which Seam created the error. */
5821
6689
  created_at?: string | undefined;
5822
6690
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5823
6691
  error_code: 'duplicate_code_on_device';
5824
6692
  } | {
6693
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5825
6694
  message: string;
6695
+ /** Indicates that this is an access code error. */
5826
6696
  is_access_code_error: true;
6697
+ /** Date and time at which Seam created the error. */
5827
6698
  created_at?: string | undefined;
5828
6699
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5829
6700
  error_code: 'duplicate_code_attempt_prevented';
5830
6701
  } | {
6702
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5831
6703
  message: string;
6704
+ /** Indicates that this is an access code error. */
5832
6705
  is_access_code_error: true;
6706
+ /** Date and time at which Seam created the error. */
5833
6707
  created_at?: string | undefined;
5834
6708
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5835
6709
  error_code: 'igloohome_bridge_too_many_pending_jobs';
5836
6710
  } | {
6711
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5837
6712
  message: string;
6713
+ /** Indicates that this is an access code error. */
5838
6714
  is_access_code_error: true;
6715
+ /** Date and time at which Seam created the error. */
5839
6716
  created_at?: string | undefined;
5840
6717
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5841
6718
  error_code: 'igloohome_bridge_offline';
5842
6719
  } | {
6720
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5843
6721
  message: string;
6722
+ /** Indicates that this is an access code error. */
5844
6723
  is_access_code_error: true;
6724
+ /** Date and time at which Seam created the error. */
5845
6725
  created_at?: string | undefined;
5846
6726
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5847
6727
  error_code: 'igloohome_offline_access_code_no_variance_available';
5848
6728
  } | {
6729
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5849
6730
  message: string;
6731
+ /** Indicates that this is an access code error. */
5850
6732
  is_access_code_error: true;
6733
+ /** Date and time at which Seam created the error. */
5851
6734
  created_at?: string | undefined;
5852
6735
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5853
6736
  error_code: 'kwikset_unable_to_confirm_code';
5854
6737
  } | {
6738
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5855
6739
  message: string;
6740
+ /** Indicates that this is an access code error. */
5856
6741
  is_access_code_error: true;
6742
+ /** Date and time at which Seam created the error. */
5857
6743
  created_at?: string | undefined;
5858
6744
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5859
6745
  error_code: 'kwikset_unable_to_confirm_deletion';
5860
6746
  } | {
6747
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5861
6748
  message: string;
6749
+ /** Indicates that this is an access code error. */
5862
6750
  is_access_code_error: true;
6751
+ /** Date and time at which Seam created the error. */
5863
6752
  created_at?: string | undefined;
5864
6753
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5865
6754
  error_code: 'code_modified_external_to_seam';
5866
6755
  } | {
6756
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5867
6757
  message: string;
6758
+ /** Indicates that this is an access code error. */
5868
6759
  is_access_code_error: true;
6760
+ /** Date and time at which Seam created the error. */
5869
6761
  created_at?: string | undefined;
5870
6762
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5871
6763
  error_code: 'august_lock_invalid_code_length';
5872
6764
  } | {
6765
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5873
6766
  message: string;
6767
+ /** Indicates that this is an access code error. */
5874
6768
  is_access_code_error: true;
6769
+ /** Date and time at which Seam created the error. */
5875
6770
  created_at?: string | undefined;
5876
6771
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5877
6772
  error_code: 'august_device_programming_delay';
5878
6773
  } | {
6774
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5879
6775
  message: string;
6776
+ /** Indicates that this is an access code error. */
5880
6777
  is_access_code_error: true;
6778
+ /** Date and time at which Seam created the error. */
5881
6779
  created_at?: string | undefined;
5882
6780
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5883
6781
  error_code: 'august_device_slots_full';
5884
6782
  } | {
6783
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5885
6784
  message: string;
6785
+ /** Indicates that this is an access code error. */
5886
6786
  is_access_code_error: true;
6787
+ /** Date and time at which Seam created the error. */
5887
6788
  created_at?: string | undefined;
5888
6789
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5889
6790
  error_code: 'august_lock_missing_keypad';
5890
6791
  } | {
6792
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5891
6793
  message: string;
6794
+ /** Indicates that this is an access code error. */
5892
6795
  is_access_code_error: true;
6796
+ /** Date and time at which Seam created the error. */
5893
6797
  created_at?: string | undefined;
5894
6798
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5895
6799
  error_code: 'august_lock_temporarily_offline';
5896
6800
  } | {
6801
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5897
6802
  message: string;
6803
+ /** Indicates that this is an access code error. */
5898
6804
  is_access_code_error: true;
6805
+ /** Date and time at which Seam created the error. */
5899
6806
  created_at?: string | undefined;
5900
6807
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5901
6808
  error_code: 'salto_ks_user_not_subscribed';
5902
6809
  } | {
6810
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5903
6811
  message: string;
6812
+ /** Indicates that this is an access code error. */
5904
6813
  is_access_code_error: true;
6814
+ /** Date and time at which Seam created the error. */
5905
6815
  created_at?: string | undefined;
5906
6816
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5907
6817
  error_code: 'hubitat_device_programming_delay';
5908
6818
  } | {
6819
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5909
6820
  message: string;
6821
+ /** Indicates that this is an access code error. */
5910
6822
  is_access_code_error: true;
6823
+ /** Date and time at which Seam created the error. */
5911
6824
  created_at?: string | undefined;
5912
6825
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5913
6826
  error_code: 'hubitat_no_free_positions_available';
5914
6827
  } | {
6828
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5915
6829
  message: string;
6830
+ /** Indicates that this is an access code error. */
5916
6831
  is_access_code_error: true;
6832
+ /** Date and time at which Seam created the error. */
5917
6833
  created_at?: string | undefined;
5918
6834
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5919
6835
  error_code: 'wyze_duplicate_code_name';
5920
6836
  } | {
6837
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5921
6838
  message: string;
6839
+ /** Indicates that this is an access code error. */
5922
6840
  is_access_code_error: true;
6841
+ /** Date and time at which Seam created the error. */
5923
6842
  created_at?: string | undefined;
5924
6843
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5925
6844
  error_code: 'wyze_potential_duplicate_code';
5926
6845
  } | {
6846
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5927
6847
  message: string;
6848
+ /** Indicates that this is an access code error. */
5928
6849
  is_access_code_error: true;
6850
+ /** Date and time at which Seam created the error. */
5929
6851
  created_at?: string | undefined;
5930
6852
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
5931
6853
  error_code: 'dormakaba_oracode_no_valid_user_level';
@@ -6026,73 +6948,99 @@ export interface Routes {
6026
6948
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6027
6949
  error_code: 'bridge_disconnected';
6028
6950
  }>;
6029
- /** Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention. */
6951
+ /** Warnings associated with the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes). */
6030
6952
  warnings: Array<{
6953
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6031
6954
  message: string;
6955
+ /** Date and time at which Seam created the warning. */
6032
6956
  created_at?: string | undefined;
6033
6957
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6034
6958
  warning_code: 'smartthings_failed_to_set_access_code';
6035
6959
  } | {
6960
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6036
6961
  message: string;
6962
+ /** Date and time at which Seam created the warning. */
6037
6963
  created_at?: string | undefined;
6038
6964
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6039
6965
  warning_code: 'schlage_detected_duplicate';
6040
6966
  } | {
6967
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6041
6968
  message: string;
6969
+ /** Date and time at which Seam created the warning. */
6042
6970
  created_at?: string | undefined;
6043
6971
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6044
6972
  warning_code: 'schlage_creation_outage';
6045
6973
  } | {
6974
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6046
6975
  message: string;
6976
+ /** Date and time at which Seam created the warning. */
6047
6977
  created_at?: string | undefined;
6048
6978
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6049
6979
  warning_code: 'code_modified_external_to_seam';
6050
6980
  } | {
6981
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6051
6982
  message: string;
6983
+ /** Date and time at which Seam created the warning. */
6052
6984
  created_at?: string | undefined;
6053
6985
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6054
6986
  warning_code: 'delay_in_setting_on_device';
6055
6987
  } | {
6988
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6056
6989
  message: string;
6990
+ /** Date and time at which Seam created the warning. */
6057
6991
  created_at?: string | undefined;
6058
6992
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6059
6993
  warning_code: 'delay_in_removing_from_device';
6060
6994
  } | {
6995
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6061
6996
  message: string;
6997
+ /** Date and time at which Seam created the warning. */
6062
6998
  created_at?: string | undefined;
6063
6999
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6064
7000
  warning_code: 'third_party_integration_detected';
6065
7001
  } | {
7002
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6066
7003
  message: string;
7004
+ /** Date and time at which Seam created the warning. */
6067
7005
  created_at?: string | undefined;
6068
7006
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6069
7007
  warning_code: 'august_device_programming_delay';
6070
7008
  } | {
7009
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6071
7010
  message: string;
7011
+ /** Date and time at which Seam created the warning. */
6072
7012
  created_at?: string | undefined;
6073
7013
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
6074
7014
  warning_code: 'august_lock_temporarily_offline';
6075
7015
  } | {
7016
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6076
7017
  message: string;
7018
+ /** Date and time at which Seam created the warning. */
6077
7019
  created_at?: string | undefined;
6078
7020
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6079
7021
  warning_code: 'igloo_algopin_must_be_used_within_24_hours';
6080
7022
  } | {
7023
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6081
7024
  message: string;
7025
+ /** Date and time at which Seam created the warning. */
6082
7026
  created_at?: string | undefined;
6083
7027
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6084
7028
  warning_code: 'management_transferred';
6085
7029
  } | {
7030
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
6086
7031
  message: string;
7032
+ /** Date and time at which Seam created the warning. */
6087
7033
  created_at?: string | undefined;
6088
7034
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
6089
7035
  warning_code: 'kwikset_unable_to_confirm_code';
6090
7036
  }>;
7037
+ /** Indicates that Seam does not manage the access code. */
6091
7038
  is_managed: false;
6092
7039
  /** Date and time at which the time-bound access code becomes active. */
6093
7040
  starts_at?: (string | null) | undefined;
6094
7041
  /** Date and time after which the time-bound access code becomes inactive. */
6095
7042
  ends_at?: (string | null) | undefined;
7043
+ /** Current status of the access code within the operational lifecycle. `set` indicates that the code is active and operational. */
6096
7044
  status: 'set';
6097
7045
  }>;
6098
7046
  };
@@ -6103,10 +7051,14 @@ export interface Routes {
6103
7051
  queryParams: {};
6104
7052
  jsonBody: {};
6105
7053
  commonParams: {
7054
+ /** ID of the unmanaged access code that you want to update. */
6106
7055
  access_code_id: string;
6107
7056
  is_managed: boolean;
7057
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. */
6108
7058
  allow_external_modification?: boolean | undefined;
7059
+ /** Indicates whether [external modification](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#external-modification) of the code is allowed. */
6109
7060
  is_external_modification_allowed?: boolean | undefined;
7061
+ /** Indicates whether to force the unmanaged access code update. */
6110
7062
  force?: boolean | undefined;
6111
7063
  };
6112
7064
  formData: {};
@@ -6117,24 +7069,41 @@ export interface Routes {
6117
7069
  method: 'POST' | 'PATCH' | 'PUT';
6118
7070
  queryParams: {};
6119
7071
  jsonBody: {
7072
+ /** Name of the new access code. */
6120
7073
  name?: string | undefined;
7074
+ /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
6121
7075
  starts_at?: string | undefined;
7076
+ /** Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
6122
7077
  ends_at?: string | undefined;
7078
+ /** Code to be used for access. */
6123
7079
  code?: string | undefined;
7080
+ /** */
6124
7081
  sync?: boolean;
6125
7082
  attempt_for_offline_device?: boolean;
7083
+ /** Indicates whether [native scheduling](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`. */
6126
7084
  prefer_native_scheduling?: boolean | undefined;
7085
+ /** Indicates whether to use a [backup access code pool](https://docs.seam.co/latest/core-concepts/access-codes#backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://docs.seam.co/latest/api-clients/access_codes/pull_backup_access_code). */
6127
7086
  use_backup_access_code_pool?: boolean | undefined;
7087
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
6128
7088
  allow_external_modification?: boolean | undefined;
7089
+ /** Indicates whether [external modification](https://docs.seam.co/latest/api/access_codes#external-modification) of the code is allowed. Default: `false`. */
6129
7090
  is_external_modification_allowed?: boolean | undefined;
7091
+ /** Preferred code length. Only applicable if you do not specify a `code`. If the affected device does not support the preferred code length, Seam reverts to using the shortest supported code length. */
6130
7092
  preferred_code_length?: number | undefined;
6131
7093
  use_offline_access_code?: boolean | undefined;
7094
+ /** Indicates whether the access code is an [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes). */
6132
7095
  is_offline_access_code?: boolean | undefined;
7096
+ /** Indicates whether the [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) is a single-use access code. */
6133
7097
  is_one_time_use?: boolean | undefined;
7098
+ /** Maximum rounding adjustment. To create a daily-bound [offline access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`. */
6134
7099
  max_time_rounding?: ('1hour' | '1day' | '1h' | '1d') | undefined;
7100
+ /** ID of the access code that you want to update. */
6135
7101
  access_code_id: string;
7102
+ /** ID of the device containing the access code that you want to update. */
6136
7103
  device_id?: string | undefined;
7104
+ /** Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access). */
6137
7105
  type?: ('ongoing' | 'time_bound') | undefined;
7106
+ /** Indicates whether the access code is managed through Seam. Note that to convert an unmanaged access code into a managed access code, use `/access_codes/unmanaged/convert_to_managed`. */
6138
7107
  is_managed?: boolean | undefined;
6139
7108
  };
6140
7109
  commonParams: {};
@@ -7097,9 +8066,13 @@ export interface Routes {
7097
8066
  method: 'POST' | 'PATCH';
7098
8067
  queryParams: {};
7099
8068
  jsonBody: {
8069
+ /** Date and time at which the validity of the new access code ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
7100
8070
  ends_at?: string | undefined;
8071
+ /** Date and time at which the validity of the new access code starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
7101
8072
  starts_at?: string | undefined;
8073
+ /** Name of the new access code. */
7102
8074
  name?: string | undefined;
8075
+ /** Key that links the group of access codes, assigned on creation by `/access_codes/create_multiple`. */
7103
8076
  common_code_key: string;
7104
8077
  };
7105
8078
  commonParams: {};
@@ -7395,32 +8368,35 @@ export interface Routes {
7395
8368
  error_code: 'failed_to_delete_on_acs_system';
7396
8369
  }>;
7397
8370
  /** */
7398
- pending_modifications?: Array<{
8371
+ pending_mutations?: Array<{
8372
+ created_at: string;
8373
+ mutation_code: 'creating';
8374
+ } | {
7399
8375
  created_at: string;
7400
- modification_code: 'create';
8376
+ mutation_code: 'deleting';
7401
8377
  } | {
7402
8378
  created_at: string;
7403
- modification_code: 'profile';
7404
- modified_from: {
8379
+ mutation_code: 'updating_user_information';
8380
+ from: {
7405
8381
  email_address?: (string | null) | undefined;
7406
8382
  full_name?: (string | null) | undefined;
7407
8383
  phone_number?: ((string | undefined) | null) | undefined;
7408
8384
  };
7409
- modified_to: {
8385
+ to: {
7410
8386
  email_address?: (string | null) | undefined;
7411
8387
  full_name?: (string | null) | undefined;
7412
8388
  phone_number?: ((string | undefined) | null) | undefined;
7413
8389
  };
7414
8390
  } | {
7415
8391
  created_at: string;
7416
- modification_code: 'access_schedule';
7417
- modified_from: {
8392
+ mutation_code: 'updating_access_schedule';
8393
+ from: {
7418
8394
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
7419
8395
  starts_at: string;
7420
8396
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
7421
8397
  ends_at: string | null;
7422
8398
  };
7423
- modified_to: {
8399
+ to: {
7424
8400
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
7425
8401
  starts_at: string;
7426
8402
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -7428,20 +8404,20 @@ export interface Routes {
7428
8404
  };
7429
8405
  } | {
7430
8406
  created_at: string;
7431
- modification_code: 'suspension_state';
7432
- modified_from: {
8407
+ mutation_code: 'updating_suspension_state';
8408
+ from: {
7433
8409
  is_suspended: boolean;
7434
8410
  };
7435
- modified_to: {
8411
+ to: {
7436
8412
  is_suspended: boolean;
7437
8413
  };
7438
8414
  } | {
7439
8415
  created_at: string;
7440
- modification_code: 'acs_access_group_membership';
7441
- modified_from: {
8416
+ mutation_code: 'updating_group_membership';
8417
+ from: {
7442
8418
  acs_access_group_id: string | null;
7443
8419
  };
7444
- modified_to: {
8420
+ to: {
7445
8421
  acs_access_group_id: string | null;
7446
8422
  };
7447
8423
  }> | undefined;
@@ -11841,32 +12817,35 @@ export interface Routes {
11841
12817
  error_code: 'failed_to_delete_on_acs_system';
11842
12818
  }>;
11843
12819
  /** */
11844
- pending_modifications?: Array<{
12820
+ pending_mutations?: Array<{
11845
12821
  created_at: string;
11846
- modification_code: 'create';
12822
+ mutation_code: 'creating';
11847
12823
  } | {
11848
12824
  created_at: string;
11849
- modification_code: 'profile';
11850
- modified_from: {
12825
+ mutation_code: 'deleting';
12826
+ } | {
12827
+ created_at: string;
12828
+ mutation_code: 'updating_user_information';
12829
+ from: {
11851
12830
  email_address?: (string | null) | undefined;
11852
12831
  full_name?: (string | null) | undefined;
11853
12832
  phone_number?: ((string | undefined) | null) | undefined;
11854
12833
  };
11855
- modified_to: {
12834
+ to: {
11856
12835
  email_address?: (string | null) | undefined;
11857
12836
  full_name?: (string | null) | undefined;
11858
12837
  phone_number?: ((string | undefined) | null) | undefined;
11859
12838
  };
11860
12839
  } | {
11861
12840
  created_at: string;
11862
- modification_code: 'access_schedule';
11863
- modified_from: {
12841
+ mutation_code: 'updating_access_schedule';
12842
+ from: {
11864
12843
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11865
12844
  starts_at: string;
11866
12845
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11867
12846
  ends_at: string | null;
11868
12847
  };
11869
- modified_to: {
12848
+ to: {
11870
12849
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
11871
12850
  starts_at: string;
11872
12851
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -11874,20 +12853,20 @@ export interface Routes {
11874
12853
  };
11875
12854
  } | {
11876
12855
  created_at: string;
11877
- modification_code: 'suspension_state';
11878
- modified_from: {
12856
+ mutation_code: 'updating_suspension_state';
12857
+ from: {
11879
12858
  is_suspended: boolean;
11880
12859
  };
11881
- modified_to: {
12860
+ to: {
11882
12861
  is_suspended: boolean;
11883
12862
  };
11884
12863
  } | {
11885
12864
  created_at: string;
11886
- modification_code: 'acs_access_group_membership';
11887
- modified_from: {
12865
+ mutation_code: 'updating_group_membership';
12866
+ from: {
11888
12867
  acs_access_group_id: string | null;
11889
12868
  };
11890
- modified_to: {
12869
+ to: {
11891
12870
  acs_access_group_id: string | null;
11892
12871
  };
11893
12872
  }> | undefined;
@@ -12022,32 +13001,35 @@ export interface Routes {
12022
13001
  error_code: 'failed_to_delete_on_acs_system';
12023
13002
  }>;
12024
13003
  /** */
12025
- pending_modifications?: Array<{
13004
+ pending_mutations?: Array<{
13005
+ created_at: string;
13006
+ mutation_code: 'creating';
13007
+ } | {
12026
13008
  created_at: string;
12027
- modification_code: 'create';
13009
+ mutation_code: 'deleting';
12028
13010
  } | {
12029
13011
  created_at: string;
12030
- modification_code: 'profile';
12031
- modified_from: {
13012
+ mutation_code: 'updating_user_information';
13013
+ from: {
12032
13014
  email_address?: (string | null) | undefined;
12033
13015
  full_name?: (string | null) | undefined;
12034
13016
  phone_number?: ((string | undefined) | null) | undefined;
12035
13017
  };
12036
- modified_to: {
13018
+ to: {
12037
13019
  email_address?: (string | null) | undefined;
12038
13020
  full_name?: (string | null) | undefined;
12039
13021
  phone_number?: ((string | undefined) | null) | undefined;
12040
13022
  };
12041
13023
  } | {
12042
13024
  created_at: string;
12043
- modification_code: 'access_schedule';
12044
- modified_from: {
13025
+ mutation_code: 'updating_access_schedule';
13026
+ from: {
12045
13027
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12046
13028
  starts_at: string;
12047
13029
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12048
13030
  ends_at: string | null;
12049
13031
  };
12050
- modified_to: {
13032
+ to: {
12051
13033
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12052
13034
  starts_at: string;
12053
13035
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -12055,20 +13037,20 @@ export interface Routes {
12055
13037
  };
12056
13038
  } | {
12057
13039
  created_at: string;
12058
- modification_code: 'suspension_state';
12059
- modified_from: {
13040
+ mutation_code: 'updating_suspension_state';
13041
+ from: {
12060
13042
  is_suspended: boolean;
12061
13043
  };
12062
- modified_to: {
13044
+ to: {
12063
13045
  is_suspended: boolean;
12064
13046
  };
12065
13047
  } | {
12066
13048
  created_at: string;
12067
- modification_code: 'acs_access_group_membership';
12068
- modified_from: {
13049
+ mutation_code: 'updating_group_membership';
13050
+ from: {
12069
13051
  acs_access_group_id: string | null;
12070
13052
  };
12071
- modified_to: {
13053
+ to: {
12072
13054
  acs_access_group_id: string | null;
12073
13055
  };
12074
13056
  }> | undefined;
@@ -12199,32 +13181,35 @@ export interface Routes {
12199
13181
  error_code: 'failed_to_delete_on_acs_system';
12200
13182
  }>;
12201
13183
  /** */
12202
- pending_modifications?: Array<{
13184
+ pending_mutations?: Array<{
12203
13185
  created_at: string;
12204
- modification_code: 'create';
13186
+ mutation_code: 'creating';
12205
13187
  } | {
12206
13188
  created_at: string;
12207
- modification_code: 'profile';
12208
- modified_from: {
13189
+ mutation_code: 'deleting';
13190
+ } | {
13191
+ created_at: string;
13192
+ mutation_code: 'updating_user_information';
13193
+ from: {
12209
13194
  email_address?: (string | null) | undefined;
12210
13195
  full_name?: (string | null) | undefined;
12211
13196
  phone_number?: ((string | undefined) | null) | undefined;
12212
13197
  };
12213
- modified_to: {
13198
+ to: {
12214
13199
  email_address?: (string | null) | undefined;
12215
13200
  full_name?: (string | null) | undefined;
12216
13201
  phone_number?: ((string | undefined) | null) | undefined;
12217
13202
  };
12218
13203
  } | {
12219
13204
  created_at: string;
12220
- modification_code: 'access_schedule';
12221
- modified_from: {
13205
+ mutation_code: 'updating_access_schedule';
13206
+ from: {
12222
13207
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12223
13208
  starts_at: string;
12224
13209
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12225
13210
  ends_at: string | null;
12226
13211
  };
12227
- modified_to: {
13212
+ to: {
12228
13213
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12229
13214
  starts_at: string;
12230
13215
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -12232,20 +13217,20 @@ export interface Routes {
12232
13217
  };
12233
13218
  } | {
12234
13219
  created_at: string;
12235
- modification_code: 'suspension_state';
12236
- modified_from: {
13220
+ mutation_code: 'updating_suspension_state';
13221
+ from: {
12237
13222
  is_suspended: boolean;
12238
13223
  };
12239
- modified_to: {
13224
+ to: {
12240
13225
  is_suspended: boolean;
12241
13226
  };
12242
13227
  } | {
12243
13228
  created_at: string;
12244
- modification_code: 'acs_access_group_membership';
12245
- modified_from: {
13229
+ mutation_code: 'updating_group_membership';
13230
+ from: {
12246
13231
  acs_access_group_id: string | null;
12247
13232
  };
12248
- modified_to: {
13233
+ to: {
12249
13234
  acs_access_group_id: string | null;
12250
13235
  };
12251
13236
  }> | undefined;
@@ -12485,32 +13470,35 @@ export interface Routes {
12485
13470
  error_code: 'failed_to_delete_on_acs_system';
12486
13471
  }>;
12487
13472
  /** */
12488
- pending_modifications?: Array<{
13473
+ pending_mutations?: Array<{
13474
+ created_at: string;
13475
+ mutation_code: 'creating';
13476
+ } | {
12489
13477
  created_at: string;
12490
- modification_code: 'create';
13478
+ mutation_code: 'deleting';
12491
13479
  } | {
12492
13480
  created_at: string;
12493
- modification_code: 'profile';
12494
- modified_from: {
13481
+ mutation_code: 'updating_user_information';
13482
+ from: {
12495
13483
  email_address?: (string | null) | undefined;
12496
13484
  full_name?: (string | null) | undefined;
12497
13485
  phone_number?: ((string | undefined) | null) | undefined;
12498
13486
  };
12499
- modified_to: {
13487
+ to: {
12500
13488
  email_address?: (string | null) | undefined;
12501
13489
  full_name?: (string | null) | undefined;
12502
13490
  phone_number?: ((string | undefined) | null) | undefined;
12503
13491
  };
12504
13492
  } | {
12505
13493
  created_at: string;
12506
- modification_code: 'access_schedule';
12507
- modified_from: {
13494
+ mutation_code: 'updating_access_schedule';
13495
+ from: {
12508
13496
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12509
13497
  starts_at: string;
12510
13498
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12511
13499
  ends_at: string | null;
12512
13500
  };
12513
- modified_to: {
13501
+ to: {
12514
13502
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12515
13503
  starts_at: string;
12516
13504
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -12518,20 +13506,20 @@ export interface Routes {
12518
13506
  };
12519
13507
  } | {
12520
13508
  created_at: string;
12521
- modification_code: 'suspension_state';
12522
- modified_from: {
13509
+ mutation_code: 'updating_suspension_state';
13510
+ from: {
12523
13511
  is_suspended: boolean;
12524
13512
  };
12525
- modified_to: {
13513
+ to: {
12526
13514
  is_suspended: boolean;
12527
13515
  };
12528
13516
  } | {
12529
13517
  created_at: string;
12530
- modification_code: 'acs_access_group_membership';
12531
- modified_from: {
13518
+ mutation_code: 'updating_group_membership';
13519
+ from: {
12532
13520
  acs_access_group_id: string | null;
12533
13521
  };
12534
- modified_to: {
13522
+ to: {
12535
13523
  acs_access_group_id: string | null;
12536
13524
  };
12537
13525
  }> | undefined;
@@ -12652,32 +13640,35 @@ export interface Routes {
12652
13640
  error_code: 'failed_to_delete_on_acs_system';
12653
13641
  }>;
12654
13642
  /** */
12655
- pending_modifications?: Array<{
13643
+ pending_mutations?: Array<{
12656
13644
  created_at: string;
12657
- modification_code: 'create';
13645
+ mutation_code: 'creating';
12658
13646
  } | {
12659
13647
  created_at: string;
12660
- modification_code: 'profile';
12661
- modified_from: {
13648
+ mutation_code: 'deleting';
13649
+ } | {
13650
+ created_at: string;
13651
+ mutation_code: 'updating_user_information';
13652
+ from: {
12662
13653
  email_address?: (string | null) | undefined;
12663
13654
  full_name?: (string | null) | undefined;
12664
13655
  phone_number?: ((string | undefined) | null) | undefined;
12665
13656
  };
12666
- modified_to: {
13657
+ to: {
12667
13658
  email_address?: (string | null) | undefined;
12668
13659
  full_name?: (string | null) | undefined;
12669
13660
  phone_number?: ((string | undefined) | null) | undefined;
12670
13661
  };
12671
13662
  } | {
12672
13663
  created_at: string;
12673
- modification_code: 'access_schedule';
12674
- modified_from: {
13664
+ mutation_code: 'updating_access_schedule';
13665
+ from: {
12675
13666
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12676
13667
  starts_at: string;
12677
13668
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12678
13669
  ends_at: string | null;
12679
13670
  };
12680
- modified_to: {
13671
+ to: {
12681
13672
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
12682
13673
  starts_at: string;
12683
13674
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -12685,20 +13676,20 @@ export interface Routes {
12685
13676
  };
12686
13677
  } | {
12687
13678
  created_at: string;
12688
- modification_code: 'suspension_state';
12689
- modified_from: {
13679
+ mutation_code: 'updating_suspension_state';
13680
+ from: {
12690
13681
  is_suspended: boolean;
12691
13682
  };
12692
- modified_to: {
13683
+ to: {
12693
13684
  is_suspended: boolean;
12694
13685
  };
12695
13686
  } | {
12696
13687
  created_at: string;
12697
- modification_code: 'acs_access_group_membership';
12698
- modified_from: {
13688
+ mutation_code: 'updating_group_membership';
13689
+ from: {
12699
13690
  acs_access_group_id: string | null;
12700
13691
  };
12701
- modified_to: {
13692
+ to: {
12702
13693
  acs_access_group_id: string | null;
12703
13694
  };
12704
13695
  }> | undefined;
@@ -41074,32 +42065,35 @@ export interface Routes {
41074
42065
  error_code: 'failed_to_delete_on_acs_system';
41075
42066
  }>;
41076
42067
  /** */
41077
- pending_modifications?: Array<{
42068
+ pending_mutations?: Array<{
42069
+ created_at: string;
42070
+ mutation_code: 'creating';
42071
+ } | {
41078
42072
  created_at: string;
41079
- modification_code: 'create';
42073
+ mutation_code: 'deleting';
41080
42074
  } | {
41081
42075
  created_at: string;
41082
- modification_code: 'profile';
41083
- modified_from: {
42076
+ mutation_code: 'updating_user_information';
42077
+ from: {
41084
42078
  email_address?: (string | null) | undefined;
41085
42079
  full_name?: (string | null) | undefined;
41086
42080
  phone_number?: ((string | undefined) | null) | undefined;
41087
42081
  };
41088
- modified_to: {
42082
+ to: {
41089
42083
  email_address?: (string | null) | undefined;
41090
42084
  full_name?: (string | null) | undefined;
41091
42085
  phone_number?: ((string | undefined) | null) | undefined;
41092
42086
  };
41093
42087
  } | {
41094
42088
  created_at: string;
41095
- modification_code: 'access_schedule';
41096
- modified_from: {
42089
+ mutation_code: 'updating_access_schedule';
42090
+ from: {
41097
42091
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41098
42092
  starts_at: string;
41099
42093
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41100
42094
  ends_at: string | null;
41101
42095
  };
41102
- modified_to: {
42096
+ to: {
41103
42097
  /** Date and time at which the user's access starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
41104
42098
  starts_at: string;
41105
42099
  /** Date and time at which the user's access ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -41107,20 +42101,20 @@ export interface Routes {
41107
42101
  };
41108
42102
  } | {
41109
42103
  created_at: string;
41110
- modification_code: 'suspension_state';
41111
- modified_from: {
42104
+ mutation_code: 'updating_suspension_state';
42105
+ from: {
41112
42106
  is_suspended: boolean;
41113
42107
  };
41114
- modified_to: {
42108
+ to: {
41115
42109
  is_suspended: boolean;
41116
42110
  };
41117
42111
  } | {
41118
42112
  created_at: string;
41119
- modification_code: 'acs_access_group_membership';
41120
- modified_from: {
42113
+ mutation_code: 'updating_group_membership';
42114
+ from: {
41121
42115
  acs_access_group_id: string | null;
41122
42116
  };
41123
- modified_to: {
42117
+ to: {
41124
42118
  acs_access_group_id: string | null;
41125
42119
  };
41126
42120
  }> | undefined;