@seamapi/http 2.31.0 → 2.32.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.
- package/lib/resources/access-code.d.ts +15 -15
- package/lib/resources/access-grant.d.ts +4 -4
- package/lib/resources/access-method.d.ts +9 -9
- package/lib/resources/acs-access-group.d.ts +3 -3
- package/lib/resources/acs-credential.d.ts +35 -35
- package/lib/resources/acs-encoder.d.ts +10 -10
- package/lib/resources/acs-entrance.d.ts +20 -20
- package/lib/resources/acs-system.d.ts +37 -37
- package/lib/resources/acs-user.d.ts +35 -35
- package/lib/resources/action-attempt.d.ts +101 -101
- package/lib/resources/client-session.d.ts +12 -12
- package/lib/resources/connect-webview.d.ts +6 -6
- package/lib/resources/connected-account.d.ts +8 -8
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +102 -85
- package/lib/resources/event.d.ts +10 -10
- package/lib/resources/noise-threshold.d.ts +2 -2
- package/lib/resources/phone.d.ts +1 -1
- package/lib/resources/thermostat-daily-program.d.ts +1 -1
- package/lib/resources/thermostat-schedule.d.ts +11 -11
- package/lib/resources/unmanaged-access-code.d.ts +12 -12
- package/lib/resources/unmanaged-access-grant.d.ts +4 -4
- package/lib/resources/unmanaged-access-method.d.ts +9 -9
- package/lib/resources/unmanaged-device.d.ts +11 -11
- package/lib/resources/user-identity.d.ts +1 -1
- package/lib/resources/webhook.d.ts +4 -4
- package/lib/resources/workspace.d.ts +12 -12
- package/lib/routes/access-codes/access-codes.d.ts +28 -28
- package/lib/routes/access-codes/access-codes.js +13 -13
- package/lib/routes/access-codes/simulate/simulate.d.ts +1 -1
- package/lib/routes/access-codes/simulate/simulate.js +1 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/access-codes/unmanaged/unmanaged.js +5 -5
- package/lib/routes/access-grants/access-grants.d.ts +3 -3
- package/lib/routes/access-grants/access-grants.js +1 -1
- package/lib/routes/access-methods/access-methods.d.ts +2 -2
- package/lib/routes/access-methods/access-methods.js +2 -2
- package/lib/routes/acs/access-groups/access-groups.d.ts +7 -7
- package/lib/routes/acs/access-groups/access-groups.js +7 -7
- package/lib/routes/acs/credentials/credentials.d.ts +12 -12
- package/lib/routes/acs/credentials/credentials.js +8 -8
- package/lib/routes/acs/encoders/encoders.d.ts +5 -5
- package/lib/routes/acs/encoders/encoders.js +5 -5
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +4 -4
- package/lib/routes/acs/encoders/simulate/simulate.js +4 -4
- package/lib/routes/acs/entrances/entrances.d.ts +5 -5
- package/lib/routes/acs/entrances/entrances.js +5 -5
- package/lib/routes/acs/systems/systems.d.ts +3 -3
- package/lib/routes/acs/systems/systems.js +3 -3
- package/lib/routes/acs/users/users.d.ts +16 -16
- package/lib/routes/acs/users/users.js +11 -11
- package/lib/routes/action-attempts/action-attempts.d.ts +2 -2
- package/lib/routes/action-attempts/action-attempts.js +2 -2
- package/lib/routes/client-sessions/client-sessions.d.ts +22 -22
- package/lib/routes/client-sessions/client-sessions.js +8 -8
- package/lib/routes/connect-webviews/connect-webviews.d.ts +12 -12
- package/lib/routes/connect-webviews/connect-webviews.js +5 -5
- package/lib/routes/connected-accounts/connected-accounts.d.ts +7 -7
- package/lib/routes/connected-accounts/connected-accounts.js +5 -5
- package/lib/routes/connected-accounts/simulate/simulate.d.ts +1 -1
- package/lib/routes/connected-accounts/simulate/simulate.js +1 -1
- package/lib/routes/devices/devices.d.ts +12 -12
- package/lib/routes/devices/devices.js +6 -6
- package/lib/routes/devices/simulate/simulate.d.ts +3 -3
- package/lib/routes/devices/simulate/simulate.js +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/devices/unmanaged/unmanaged.js +6 -6
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +2 -2
- package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
- package/lib/routes/instant-keys/instant-keys.js +3 -3
- package/lib/routes/locks/locks.d.ts +5 -5
- package/lib/routes/locks/locks.js +5 -5
- package/lib/routes/locks/simulate/simulate.d.ts +2 -2
- package/lib/routes/locks/simulate/simulate.js +2 -2
- package/lib/routes/noise-sensors/noise-sensors.d.ts +1 -1
- package/lib/routes/noise-sensors/noise-sensors.js +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +7 -7
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +5 -5
- package/lib/routes/noise-sensors/simulate/simulate.d.ts +1 -1
- package/lib/routes/noise-sensors/simulate/simulate.js +1 -1
- package/lib/routes/phones/phones.d.ts +4 -4
- package/lib/routes/phones/phones.js +3 -3
- package/lib/routes/phones/simulate/simulate.d.ts +1 -1
- package/lib/routes/phones/simulate/simulate.js +1 -1
- package/lib/routes/seam-http-endpoints-without-workspace.d.ts +2 -2
- package/lib/routes/seam-http-endpoints-without-workspace.js +2 -2
- package/lib/routes/seam-http-endpoints.d.ts +176 -176
- package/lib/routes/seam-http-endpoints.js +176 -176
- package/lib/routes/spaces/spaces.d.ts +4 -4
- package/lib/routes/spaces/spaces.js +4 -4
- package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
- package/lib/routes/thermostats/schedules/schedules.d.ts +11 -11
- package/lib/routes/thermostats/schedules/schedules.js +5 -5
- package/lib/routes/thermostats/simulate/simulate.d.ts +6 -6
- package/lib/routes/thermostats/simulate/simulate.js +2 -2
- package/lib/routes/thermostats/thermostats.d.ts +43 -43
- package/lib/routes/thermostats/thermostats.js +13 -13
- package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/user-identities/unmanaged/unmanaged.js +3 -3
- package/lib/routes/user-identities/user-identities.d.ts +15 -15
- package/lib/routes/user-identities/user-identities.js +15 -15
- package/lib/routes/webhooks/webhooks.d.ts +5 -5
- package/lib/routes/webhooks/webhooks.js +5 -5
- package/lib/routes/workspaces/workspaces.d.ts +16 -16
- package/lib/routes/workspaces/workspaces.js +5 -5
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-code.ts +15 -15
- package/src/lib/resources/access-grant.ts +4 -4
- package/src/lib/resources/access-method.ts +9 -9
- package/src/lib/resources/acs-access-group.ts +3 -3
- package/src/lib/resources/acs-credential.ts +35 -35
- package/src/lib/resources/acs-encoder.ts +10 -10
- package/src/lib/resources/acs-entrance.ts +20 -20
- package/src/lib/resources/acs-system.ts +37 -37
- package/src/lib/resources/acs-user.ts +35 -35
- package/src/lib/resources/action-attempt.ts +101 -101
- package/src/lib/resources/client-session.ts +12 -12
- package/src/lib/resources/connect-webview.ts +6 -6
- package/src/lib/resources/connected-account.ts +8 -8
- package/src/lib/resources/device-provider.ts +1 -0
- package/src/lib/resources/device.ts +104 -84
- package/src/lib/resources/event.ts +10 -10
- package/src/lib/resources/noise-threshold.ts +2 -2
- package/src/lib/resources/phone.ts +1 -1
- package/src/lib/resources/thermostat-daily-program.ts +1 -1
- package/src/lib/resources/thermostat-schedule.ts +11 -11
- package/src/lib/resources/unmanaged-access-code.ts +12 -12
- package/src/lib/resources/unmanaged-access-grant.ts +4 -4
- package/src/lib/resources/unmanaged-access-method.ts +9 -9
- package/src/lib/resources/unmanaged-device.ts +11 -10
- package/src/lib/resources/user-identity.ts +1 -1
- package/src/lib/resources/webhook.ts +4 -4
- package/src/lib/resources/workspace.ts +12 -12
- package/src/lib/routes/access-codes/access-codes.ts +28 -28
- package/src/lib/routes/access-codes/simulate/simulate.ts +1 -1
- package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +9 -9
- package/src/lib/routes/access-grants/access-grants.ts +3 -3
- package/src/lib/routes/access-methods/access-methods.ts +2 -2
- package/src/lib/routes/acs/access-groups/access-groups.ts +7 -7
- package/src/lib/routes/acs/credentials/credentials.ts +12 -12
- package/src/lib/routes/acs/encoders/encoders.ts +5 -5
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +4 -4
- package/src/lib/routes/acs/entrances/entrances.ts +5 -5
- package/src/lib/routes/acs/systems/systems.ts +3 -3
- package/src/lib/routes/acs/users/users.ts +16 -16
- package/src/lib/routes/action-attempts/action-attempts.ts +2 -2
- package/src/lib/routes/client-sessions/client-sessions.ts +22 -22
- package/src/lib/routes/connect-webviews/connect-webviews.ts +12 -11
- package/src/lib/routes/connected-accounts/connected-accounts.ts +7 -7
- package/src/lib/routes/connected-accounts/simulate/simulate.ts +1 -1
- package/src/lib/routes/devices/devices.ts +12 -9
- package/src/lib/routes/devices/simulate/simulate.ts +3 -3
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +9 -6
- package/src/lib/routes/events/events.ts +4 -4
- package/src/lib/routes/instant-keys/instant-keys.ts +3 -3
- package/src/lib/routes/locks/locks.ts +5 -5
- package/src/lib/routes/locks/simulate/simulate.ts +2 -2
- package/src/lib/routes/noise-sensors/noise-sensors.ts +1 -1
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +7 -7
- package/src/lib/routes/noise-sensors/simulate/simulate.ts +1 -1
- package/src/lib/routes/phones/phones.ts +4 -4
- package/src/lib/routes/phones/simulate/simulate.ts +1 -1
- package/src/lib/routes/seam-http-endpoints-without-workspace.ts +2 -2
- package/src/lib/routes/seam-http-endpoints.ts +176 -176
- package/src/lib/routes/spaces/spaces.ts +4 -4
- package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +2 -2
- package/src/lib/routes/thermostats/schedules/schedules.ts +11 -11
- package/src/lib/routes/thermostats/simulate/simulate.ts +6 -6
- package/src/lib/routes/thermostats/thermostats.ts +43 -43
- package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +3 -3
- package/src/lib/routes/user-identities/user-identities.ts +15 -15
- package/src/lib/routes/webhooks/webhooks.ts +5 -5
- package/src/lib/routes/workspaces/workspaces.ts +16 -16
- package/src/lib/version.ts +1 -1
|
@@ -887,7 +887,7 @@ export class SeamHttpEndpoints {
|
|
|
887
887
|
}
|
|
888
888
|
|
|
889
889
|
/**
|
|
890
|
-
* Creates a new [access code](https://
|
|
890
|
+
* Creates a new [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). For granting access, we recommend [Access Grants](https://www.seam.co/docs/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.
|
|
891
891
|
*/
|
|
892
892
|
get '/access_codes/create'(): (
|
|
893
893
|
parameters: AccessCodesCreateParameters,
|
|
@@ -903,7 +903,7 @@ export class SeamHttpEndpoints {
|
|
|
903
903
|
}
|
|
904
904
|
|
|
905
905
|
/**
|
|
906
|
-
* Creates new [access codes](https://
|
|
906
|
+
* Creates new [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
907
907
|
*
|
|
908
908
|
* Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.
|
|
909
909
|
*
|
|
@@ -911,9 +911,9 @@ export class SeamHttpEndpoints {
|
|
|
911
911
|
*
|
|
912
912
|
* If you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.
|
|
913
913
|
*
|
|
914
|
-
* See also [Creating and Updating Multiple Linked Access Codes](https://
|
|
914
|
+
* See also [Creating and Updating Multiple Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
|
|
915
915
|
*
|
|
916
|
-
* For granting a person access to a space, [Access Grants](https://
|
|
916
|
+
* For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
|
|
917
917
|
*/
|
|
918
918
|
get '/access_codes/create_multiple'(): (
|
|
919
919
|
parameters: AccessCodesCreateMultipleParameters,
|
|
@@ -929,7 +929,7 @@ export class SeamHttpEndpoints {
|
|
|
929
929
|
}
|
|
930
930
|
|
|
931
931
|
/**
|
|
932
|
-
* Deletes an [access code](https://
|
|
932
|
+
* Deletes an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
933
933
|
*/
|
|
934
934
|
get '/access_codes/delete'(): (
|
|
935
935
|
parameters: AccessCodesDeleteParameters,
|
|
@@ -945,7 +945,7 @@ export class SeamHttpEndpoints {
|
|
|
945
945
|
}
|
|
946
946
|
|
|
947
947
|
/**
|
|
948
|
-
* Generates a code for an [access code](https://
|
|
948
|
+
* Generates a code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes), given a device ID.
|
|
949
949
|
*/
|
|
950
950
|
get '/access_codes/generate_code'(): (
|
|
951
951
|
parameters: AccessCodesGenerateCodeParameters,
|
|
@@ -961,7 +961,7 @@ export class SeamHttpEndpoints {
|
|
|
961
961
|
}
|
|
962
962
|
|
|
963
963
|
/**
|
|
964
|
-
* Returns a specified [access code](https://
|
|
964
|
+
* Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
965
965
|
*
|
|
966
966
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
967
967
|
*/
|
|
@@ -979,7 +979,7 @@ export class SeamHttpEndpoints {
|
|
|
979
979
|
}
|
|
980
980
|
|
|
981
981
|
/**
|
|
982
|
-
* Returns a list of all [access codes](https://
|
|
982
|
+
* Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
983
983
|
*
|
|
984
984
|
* Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
|
|
985
985
|
*/
|
|
@@ -997,7 +997,7 @@ export class SeamHttpEndpoints {
|
|
|
997
997
|
}
|
|
998
998
|
|
|
999
999
|
/**
|
|
1000
|
-
* Retrieves a backup access code for an [access code](https://
|
|
1000
|
+
* Retrieves a backup access code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes).
|
|
1001
1001
|
*
|
|
1002
1002
|
* A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.
|
|
1003
1003
|
*
|
|
@@ -1039,9 +1039,9 @@ export class SeamHttpEndpoints {
|
|
|
1039
1039
|
}
|
|
1040
1040
|
|
|
1041
1041
|
/**
|
|
1042
|
-
* Updates a specified active or upcoming [access code](https://
|
|
1042
|
+
* Updates a specified active or upcoming [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
1043
1043
|
*
|
|
1044
|
-
* See also [Modifying Access Codes](https://
|
|
1044
|
+
* See also [Modifying Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes).
|
|
1045
1045
|
*/
|
|
1046
1046
|
get '/access_codes/update'(): (
|
|
1047
1047
|
parameters: AccessCodesUpdateParameters,
|
|
@@ -1057,11 +1057,11 @@ export class SeamHttpEndpoints {
|
|
|
1057
1057
|
}
|
|
1058
1058
|
|
|
1059
1059
|
/**
|
|
1060
|
-
* Updates [access codes](https://
|
|
1060
|
+
* Updates [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
1061
1061
|
*
|
|
1062
1062
|
* Specify the `common_code_key` to identify the set of access codes that you want to update.
|
|
1063
1063
|
*
|
|
1064
|
-
* See also [Update Linked Access Codes](https://
|
|
1064
|
+
* See also [Update Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).
|
|
1065
1065
|
*/
|
|
1066
1066
|
get '/access_codes/update_multiple'(): (
|
|
1067
1067
|
parameters: AccessCodesUpdateMultipleParameters,
|
|
@@ -1077,7 +1077,7 @@ export class SeamHttpEndpoints {
|
|
|
1077
1077
|
}
|
|
1078
1078
|
|
|
1079
1079
|
/**
|
|
1080
|
-
* Simulates the creation of an [unmanaged access code](https://
|
|
1080
|
+
* Simulates the creation of an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
1081
1081
|
*/
|
|
1082
1082
|
get '/access_codes/simulate/create_unmanaged_access_code'(): (
|
|
1083
1083
|
parameters: AccessCodesSimulateCreateUnmanagedAccessCodeParameters,
|
|
@@ -1095,7 +1095,7 @@ export class SeamHttpEndpoints {
|
|
|
1095
1095
|
}
|
|
1096
1096
|
|
|
1097
1097
|
/**
|
|
1098
|
-
* Converts an [unmanaged access code](https://
|
|
1098
|
+
* Converts an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
1099
1099
|
*
|
|
1100
1100
|
* An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.
|
|
1101
1101
|
*
|
|
@@ -1115,7 +1115,7 @@ export class SeamHttpEndpoints {
|
|
|
1115
1115
|
}
|
|
1116
1116
|
|
|
1117
1117
|
/**
|
|
1118
|
-
* Deletes an [unmanaged access code](https://
|
|
1118
|
+
* Deletes an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
1119
1119
|
*/
|
|
1120
1120
|
get '/access_codes/unmanaged/delete'(): (
|
|
1121
1121
|
parameters: AccessCodesUnmanagedDeleteParameters,
|
|
@@ -1131,7 +1131,7 @@ export class SeamHttpEndpoints {
|
|
|
1131
1131
|
}
|
|
1132
1132
|
|
|
1133
1133
|
/**
|
|
1134
|
-
* Returns a specified [unmanaged access code](https://
|
|
1134
|
+
* Returns a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
1135
1135
|
*
|
|
1136
1136
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
1137
1137
|
*/
|
|
@@ -1149,7 +1149,7 @@ export class SeamHttpEndpoints {
|
|
|
1149
1149
|
}
|
|
1150
1150
|
|
|
1151
1151
|
/**
|
|
1152
|
-
* Returns a list of all [unmanaged access codes](https://
|
|
1152
|
+
* Returns a list of all [unmanaged access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
1153
1153
|
*/
|
|
1154
1154
|
get '/access_codes/unmanaged/list'(): (
|
|
1155
1155
|
parameters: AccessCodesUnmanagedListParameters,
|
|
@@ -1165,7 +1165,7 @@ export class SeamHttpEndpoints {
|
|
|
1165
1165
|
}
|
|
1166
1166
|
|
|
1167
1167
|
/**
|
|
1168
|
-
* Updates a specified [unmanaged access code](https://
|
|
1168
|
+
* Updates a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
1169
1169
|
*/
|
|
1170
1170
|
get '/access_codes/unmanaged/update'(): (
|
|
1171
1171
|
parameters: AccessCodesUnmanagedUpdateParameters,
|
|
@@ -1181,7 +1181,7 @@ export class SeamHttpEndpoints {
|
|
|
1181
1181
|
}
|
|
1182
1182
|
|
|
1183
1183
|
/**
|
|
1184
|
-
* Creates a new [Access Grant](https://
|
|
1184
|
+
* Creates a new [Access Grant](https://www.seam.co/docs/use-cases/granting-access). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.
|
|
1185
1185
|
*/
|
|
1186
1186
|
get '/access_grants/create'(): (
|
|
1187
1187
|
parameters: AccessGrantsCreateParameters,
|
|
@@ -1377,7 +1377,7 @@ export class SeamHttpEndpoints {
|
|
|
1377
1377
|
}
|
|
1378
1378
|
|
|
1379
1379
|
/**
|
|
1380
|
-
* Encodes an existing access method onto a plastic card placed on the specified [encoder](https://
|
|
1380
|
+
* Encodes an existing access method onto a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
1381
1381
|
*/
|
|
1382
1382
|
get '/access_methods/encode'(): (
|
|
1383
1383
|
parameters: AccessMethodsEncodeParameters,
|
|
@@ -1441,7 +1441,7 @@ export class SeamHttpEndpoints {
|
|
|
1441
1441
|
}
|
|
1442
1442
|
|
|
1443
1443
|
/**
|
|
1444
|
-
* Remotely unlocks a specified [entrance](https://
|
|
1444
|
+
* Remotely unlocks a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation.
|
|
1445
1445
|
*/
|
|
1446
1446
|
get '/access_methods/unlock_door'(): (
|
|
1447
1447
|
parameters: AccessMethodsUnlockDoorParameters,
|
|
@@ -1489,7 +1489,7 @@ export class SeamHttpEndpoints {
|
|
|
1489
1489
|
}
|
|
1490
1490
|
|
|
1491
1491
|
/**
|
|
1492
|
-
* Adds a specified [access system user](https://
|
|
1492
|
+
* Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
1493
1493
|
*/
|
|
1494
1494
|
get '/acs/access_groups/add_user'(): (
|
|
1495
1495
|
parameters: AcsAccessGroupsAddUserParameters,
|
|
@@ -1505,7 +1505,7 @@ export class SeamHttpEndpoints {
|
|
|
1505
1505
|
}
|
|
1506
1506
|
|
|
1507
1507
|
/**
|
|
1508
|
-
* Deletes a specified [access group](https://
|
|
1508
|
+
* Deletes a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
1509
1509
|
*/
|
|
1510
1510
|
get '/acs/access_groups/delete'(): (
|
|
1511
1511
|
parameters: AcsAccessGroupsDeleteParameters,
|
|
@@ -1521,7 +1521,7 @@ export class SeamHttpEndpoints {
|
|
|
1521
1521
|
}
|
|
1522
1522
|
|
|
1523
1523
|
/**
|
|
1524
|
-
* Returns a specified [access group](https://
|
|
1524
|
+
* Returns a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
1525
1525
|
*/
|
|
1526
1526
|
get '/acs/access_groups/get'(): (
|
|
1527
1527
|
parameters: AcsAccessGroupsGetParameters,
|
|
@@ -1537,7 +1537,7 @@ export class SeamHttpEndpoints {
|
|
|
1537
1537
|
}
|
|
1538
1538
|
|
|
1539
1539
|
/**
|
|
1540
|
-
* Returns a list of all [access groups](https://
|
|
1540
|
+
* Returns a list of all [access groups](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
1541
1541
|
*/
|
|
1542
1542
|
get '/acs/access_groups/list'(): (
|
|
1543
1543
|
parameters?: AcsAccessGroupsListParameters,
|
|
@@ -1553,7 +1553,7 @@ export class SeamHttpEndpoints {
|
|
|
1553
1553
|
}
|
|
1554
1554
|
|
|
1555
1555
|
/**
|
|
1556
|
-
* Returns a list of all accessible entrances for a specified [access group](https://
|
|
1556
|
+
* Returns a list of all accessible entrances for a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
1557
1557
|
*/
|
|
1558
1558
|
get '/acs/access_groups/list_accessible_entrances'(): (
|
|
1559
1559
|
parameters: AcsAccessGroupsListAccessibleEntrancesParameters,
|
|
@@ -1569,7 +1569,7 @@ export class SeamHttpEndpoints {
|
|
|
1569
1569
|
}
|
|
1570
1570
|
|
|
1571
1571
|
/**
|
|
1572
|
-
* Returns a list of all [access system users](https://
|
|
1572
|
+
* Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in an [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
1573
1573
|
*/
|
|
1574
1574
|
get '/acs/access_groups/list_users'(): (
|
|
1575
1575
|
parameters: AcsAccessGroupsListUsersParameters,
|
|
@@ -1585,7 +1585,7 @@ export class SeamHttpEndpoints {
|
|
|
1585
1585
|
}
|
|
1586
1586
|
|
|
1587
1587
|
/**
|
|
1588
|
-
* Removes a specified [access system user](https://
|
|
1588
|
+
* Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
1589
1589
|
*/
|
|
1590
1590
|
get '/acs/access_groups/remove_user'(): (
|
|
1591
1591
|
parameters: AcsAccessGroupsRemoveUserParameters,
|
|
@@ -1601,7 +1601,7 @@ export class SeamHttpEndpoints {
|
|
|
1601
1601
|
}
|
|
1602
1602
|
|
|
1603
1603
|
/**
|
|
1604
|
-
* Assigns a specified [credential](https://
|
|
1604
|
+
* Assigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
1605
1605
|
*/
|
|
1606
1606
|
get '/acs/credentials/assign'(): (
|
|
1607
1607
|
parameters: AcsCredentialsAssignParameters,
|
|
@@ -1617,7 +1617,7 @@ export class SeamHttpEndpoints {
|
|
|
1617
1617
|
}
|
|
1618
1618
|
|
|
1619
1619
|
/**
|
|
1620
|
-
* Creates a new [credential](https://
|
|
1620
|
+
* Creates a new [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) for a specified [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://www.seam.co/docs/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
|
|
1621
1621
|
*/
|
|
1622
1622
|
get '/acs/credentials/create'(): (
|
|
1623
1623
|
parameters: AcsCredentialsCreateParameters,
|
|
@@ -1633,7 +1633,7 @@ export class SeamHttpEndpoints {
|
|
|
1633
1633
|
}
|
|
1634
1634
|
|
|
1635
1635
|
/**
|
|
1636
|
-
* Deletes a specified [credential](https://
|
|
1636
|
+
* Deletes a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
1637
1637
|
*/
|
|
1638
1638
|
get '/acs/credentials/delete'(): (
|
|
1639
1639
|
parameters: AcsCredentialsDeleteParameters,
|
|
@@ -1649,7 +1649,7 @@ export class SeamHttpEndpoints {
|
|
|
1649
1649
|
}
|
|
1650
1650
|
|
|
1651
1651
|
/**
|
|
1652
|
-
* Returns a specified [credential](https://
|
|
1652
|
+
* Returns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
1653
1653
|
*/
|
|
1654
1654
|
get '/acs/credentials/get'(): (
|
|
1655
1655
|
parameters: AcsCredentialsGetParameters,
|
|
@@ -1665,7 +1665,7 @@ export class SeamHttpEndpoints {
|
|
|
1665
1665
|
}
|
|
1666
1666
|
|
|
1667
1667
|
/**
|
|
1668
|
-
* Returns a list of all [credentials](https://
|
|
1668
|
+
* Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
1669
1669
|
*/
|
|
1670
1670
|
get '/acs/credentials/list'(): (
|
|
1671
1671
|
parameters?: AcsCredentialsListParameters,
|
|
@@ -1681,7 +1681,7 @@ export class SeamHttpEndpoints {
|
|
|
1681
1681
|
}
|
|
1682
1682
|
|
|
1683
1683
|
/**
|
|
1684
|
-
* Returns a list of all [entrances](https://
|
|
1684
|
+
* Returns a list of all [entrances](https://www.seam.co/docs/api/acs/entrances/object) to which a [credential](https://www.seam.co/docs/api/acs/credentials/object) grants access.
|
|
1685
1685
|
*/
|
|
1686
1686
|
get '/acs/credentials/list_accessible_entrances'(): (
|
|
1687
1687
|
parameters: AcsCredentialsListAccessibleEntrancesParameters,
|
|
@@ -1697,7 +1697,7 @@ export class SeamHttpEndpoints {
|
|
|
1697
1697
|
}
|
|
1698
1698
|
|
|
1699
1699
|
/**
|
|
1700
|
-
* Unassigns a specified [credential](https://
|
|
1700
|
+
* Unassigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
1701
1701
|
*/
|
|
1702
1702
|
get '/acs/credentials/unassign'(): (
|
|
1703
1703
|
parameters: AcsCredentialsUnassignParameters,
|
|
@@ -1713,7 +1713,7 @@ export class SeamHttpEndpoints {
|
|
|
1713
1713
|
}
|
|
1714
1714
|
|
|
1715
1715
|
/**
|
|
1716
|
-
* Updates the code and ends at date and time for a specified [credential](https://
|
|
1716
|
+
* Updates the code and ends at date and time for a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
1717
1717
|
*/
|
|
1718
1718
|
get '/acs/credentials/update'(): (
|
|
1719
1719
|
parameters: AcsCredentialsUpdateParameters,
|
|
@@ -1729,7 +1729,7 @@ export class SeamHttpEndpoints {
|
|
|
1729
1729
|
}
|
|
1730
1730
|
|
|
1731
1731
|
/**
|
|
1732
|
-
* Encodes an existing [credential](https://
|
|
1732
|
+
* Encodes an existing [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
|
|
1733
1733
|
*/
|
|
1734
1734
|
get '/acs/encoders/encode_credential'(): (
|
|
1735
1735
|
parameters: AcsEncodersEncodeCredentialParameters,
|
|
@@ -1745,7 +1745,7 @@ export class SeamHttpEndpoints {
|
|
|
1745
1745
|
}
|
|
1746
1746
|
|
|
1747
1747
|
/**
|
|
1748
|
-
* Returns a specified [encoder](https://
|
|
1748
|
+
* Returns a specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
1749
1749
|
*/
|
|
1750
1750
|
get '/acs/encoders/get'(): (
|
|
1751
1751
|
parameters: AcsEncodersGetParameters,
|
|
@@ -1761,7 +1761,7 @@ export class SeamHttpEndpoints {
|
|
|
1761
1761
|
}
|
|
1762
1762
|
|
|
1763
1763
|
/**
|
|
1764
|
-
* Returns a list of all [encoders](https://
|
|
1764
|
+
* Returns a list of all [encoders](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
1765
1765
|
*/
|
|
1766
1766
|
get '/acs/encoders/list'(): (
|
|
1767
1767
|
parameters?: AcsEncodersListParameters,
|
|
@@ -1777,7 +1777,7 @@ export class SeamHttpEndpoints {
|
|
|
1777
1777
|
}
|
|
1778
1778
|
|
|
1779
1779
|
/**
|
|
1780
|
-
* Scans an encoded [acs_credential](https://
|
|
1780
|
+
* Scans an encoded [acs_credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
1781
1781
|
*/
|
|
1782
1782
|
get '/acs/encoders/scan_credential'(): (
|
|
1783
1783
|
parameters: AcsEncodersScanCredentialParameters,
|
|
@@ -1793,7 +1793,7 @@ export class SeamHttpEndpoints {
|
|
|
1793
1793
|
}
|
|
1794
1794
|
|
|
1795
1795
|
/**
|
|
1796
|
-
* Scans a physical card placed on the specified [encoder](https://
|
|
1796
|
+
* Scans a physical card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
|
|
1797
1797
|
*/
|
|
1798
1798
|
get '/acs/encoders/scan_to_assign_credential'(): (
|
|
1799
1799
|
parameters: AcsEncodersScanToAssignCredentialParameters,
|
|
@@ -1809,7 +1809,7 @@ export class SeamHttpEndpoints {
|
|
|
1809
1809
|
}
|
|
1810
1810
|
|
|
1811
1811
|
/**
|
|
1812
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
1812
|
+
* Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
1813
1813
|
*/
|
|
1814
1814
|
get '/acs/encoders/simulate/next_credential_encode_will_fail'(): (
|
|
1815
1815
|
parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters,
|
|
@@ -1827,7 +1827,7 @@ export class SeamHttpEndpoints {
|
|
|
1827
1827
|
}
|
|
1828
1828
|
|
|
1829
1829
|
/**
|
|
1830
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
1830
|
+
* Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
1831
1831
|
*/
|
|
1832
1832
|
get '/acs/encoders/simulate/next_credential_encode_will_succeed'(): (
|
|
1833
1833
|
parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters,
|
|
@@ -1847,7 +1847,7 @@ export class SeamHttpEndpoints {
|
|
|
1847
1847
|
}
|
|
1848
1848
|
|
|
1849
1849
|
/**
|
|
1850
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
1850
|
+
* Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
1851
1851
|
*/
|
|
1852
1852
|
get '/acs/encoders/simulate/next_credential_scan_will_fail'(): (
|
|
1853
1853
|
parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters,
|
|
@@ -1865,7 +1865,7 @@ export class SeamHttpEndpoints {
|
|
|
1865
1865
|
}
|
|
1866
1866
|
|
|
1867
1867
|
/**
|
|
1868
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
1868
|
+
* Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
1869
1869
|
*/
|
|
1870
1870
|
get '/acs/encoders/simulate/next_credential_scan_will_succeed'(): (
|
|
1871
1871
|
parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters,
|
|
@@ -1885,7 +1885,7 @@ export class SeamHttpEndpoints {
|
|
|
1885
1885
|
}
|
|
1886
1886
|
|
|
1887
1887
|
/**
|
|
1888
|
-
* Returns a specified [access system entrance](https://
|
|
1888
|
+
* Returns a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
1889
1889
|
*/
|
|
1890
1890
|
get '/acs/entrances/get'(): (
|
|
1891
1891
|
parameters: AcsEntrancesGetParameters,
|
|
@@ -1901,7 +1901,7 @@ export class SeamHttpEndpoints {
|
|
|
1901
1901
|
}
|
|
1902
1902
|
|
|
1903
1903
|
/**
|
|
1904
|
-
* Grants a specified [access system user](https://
|
|
1904
|
+
* Grants a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
1905
1905
|
*/
|
|
1906
1906
|
get '/acs/entrances/grant_access'(): (
|
|
1907
1907
|
parameters: AcsEntrancesGrantAccessParameters,
|
|
@@ -1917,7 +1917,7 @@ export class SeamHttpEndpoints {
|
|
|
1917
1917
|
}
|
|
1918
1918
|
|
|
1919
1919
|
/**
|
|
1920
|
-
* Returns a list of all [access system entrances](https://
|
|
1920
|
+
* Returns a list of all [access system entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
1921
1921
|
*/
|
|
1922
1922
|
get '/acs/entrances/list'(): (
|
|
1923
1923
|
parameters?: AcsEntrancesListParameters,
|
|
@@ -1933,7 +1933,7 @@ export class SeamHttpEndpoints {
|
|
|
1933
1933
|
}
|
|
1934
1934
|
|
|
1935
1935
|
/**
|
|
1936
|
-
* Returns a list of all [credentials](https://
|
|
1936
|
+
* Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
1937
1937
|
*/
|
|
1938
1938
|
get '/acs/entrances/list_credentials_with_access'(): (
|
|
1939
1939
|
parameters: AcsEntrancesListCredentialsWithAccessParameters,
|
|
@@ -1949,7 +1949,7 @@ export class SeamHttpEndpoints {
|
|
|
1949
1949
|
}
|
|
1950
1950
|
|
|
1951
1951
|
/**
|
|
1952
|
-
* Remotely unlocks a specified [entrance](https://
|
|
1952
|
+
* Remotely unlocks a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.
|
|
1953
1953
|
*/
|
|
1954
1954
|
get '/acs/entrances/unlock'(): (
|
|
1955
1955
|
parameters: AcsEntrancesUnlockParameters,
|
|
@@ -1965,7 +1965,7 @@ export class SeamHttpEndpoints {
|
|
|
1965
1965
|
}
|
|
1966
1966
|
|
|
1967
1967
|
/**
|
|
1968
|
-
* Returns a specified [access system](https://
|
|
1968
|
+
* Returns a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
1969
1969
|
*/
|
|
1970
1970
|
get '/acs/systems/get'(): (
|
|
1971
1971
|
parameters: AcsSystemsGetParameters,
|
|
@@ -1981,7 +1981,7 @@ export class SeamHttpEndpoints {
|
|
|
1981
1981
|
}
|
|
1982
1982
|
|
|
1983
1983
|
/**
|
|
1984
|
-
* Returns a list of all [access systems](https://
|
|
1984
|
+
* Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
1985
1985
|
*
|
|
1986
1986
|
* To filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.
|
|
1987
1987
|
*/
|
|
@@ -1999,7 +1999,7 @@ export class SeamHttpEndpoints {
|
|
|
1999
1999
|
}
|
|
2000
2000
|
|
|
2001
2001
|
/**
|
|
2002
|
-
* Returns a list of all credential manager systems that are compatible with a specified [access system](https://
|
|
2002
|
+
* Returns a list of all credential manager systems that are compatible with a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
2003
2003
|
*
|
|
2004
2004
|
* Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.
|
|
2005
2005
|
*/
|
|
@@ -2037,7 +2037,7 @@ export class SeamHttpEndpoints {
|
|
|
2037
2037
|
}
|
|
2038
2038
|
|
|
2039
2039
|
/**
|
|
2040
|
-
* Adds a specified [access system user](https://
|
|
2040
|
+
* Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
2041
2041
|
*/
|
|
2042
2042
|
get '/acs/users/add_to_access_group'(): (
|
|
2043
2043
|
parameters: AcsUsersAddToAccessGroupParameters,
|
|
@@ -2053,7 +2053,7 @@ export class SeamHttpEndpoints {
|
|
|
2053
2053
|
}
|
|
2054
2054
|
|
|
2055
2055
|
/**
|
|
2056
|
-
* Creates a new [access system user](https://
|
|
2056
|
+
* Creates a new [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
2057
2057
|
*/
|
|
2058
2058
|
get '/acs/users/create'(): (
|
|
2059
2059
|
parameters: AcsUsersCreateParameters,
|
|
@@ -2069,7 +2069,7 @@ export class SeamHttpEndpoints {
|
|
|
2069
2069
|
}
|
|
2070
2070
|
|
|
2071
2071
|
/**
|
|
2072
|
-
* Deletes a specified [access system user](https://
|
|
2072
|
+
* Deletes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) and invalidates the access system user's [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
2073
2073
|
*/
|
|
2074
2074
|
get '/acs/users/delete'(): (
|
|
2075
2075
|
parameters: AcsUsersDeleteParameters,
|
|
@@ -2085,7 +2085,7 @@ export class SeamHttpEndpoints {
|
|
|
2085
2085
|
}
|
|
2086
2086
|
|
|
2087
2087
|
/**
|
|
2088
|
-
* Returns a specified [access system user](https://
|
|
2088
|
+
* Returns a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
2089
2089
|
*/
|
|
2090
2090
|
get '/acs/users/get'(): (
|
|
2091
2091
|
parameters: AcsUsersGetParameters,
|
|
@@ -2101,7 +2101,7 @@ export class SeamHttpEndpoints {
|
|
|
2101
2101
|
}
|
|
2102
2102
|
|
|
2103
2103
|
/**
|
|
2104
|
-
* Returns a list of all [access system users](https://
|
|
2104
|
+
* Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
2105
2105
|
*/
|
|
2106
2106
|
get '/acs/users/list'(): (
|
|
2107
2107
|
parameters?: AcsUsersListParameters,
|
|
@@ -2117,7 +2117,7 @@ export class SeamHttpEndpoints {
|
|
|
2117
2117
|
}
|
|
2118
2118
|
|
|
2119
2119
|
/**
|
|
2120
|
-
* Lists the [entrances](https://
|
|
2120
|
+
* Lists the [entrances](https://www.seam.co/docs/api/acs/entrances/object) to which a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) has access.
|
|
2121
2121
|
*/
|
|
2122
2122
|
get '/acs/users/list_accessible_entrances'(): (
|
|
2123
2123
|
parameters: AcsUsersListAccessibleEntrancesParameters,
|
|
@@ -2133,7 +2133,7 @@ export class SeamHttpEndpoints {
|
|
|
2133
2133
|
}
|
|
2134
2134
|
|
|
2135
2135
|
/**
|
|
2136
|
-
* Removes a specified [access system user](https://
|
|
2136
|
+
* Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
2137
2137
|
*/
|
|
2138
2138
|
get '/acs/users/remove_from_access_group'(): (
|
|
2139
2139
|
parameters: AcsUsersRemoveFromAccessGroupParameters,
|
|
@@ -2149,7 +2149,7 @@ export class SeamHttpEndpoints {
|
|
|
2149
2149
|
}
|
|
2150
2150
|
|
|
2151
2151
|
/**
|
|
2152
|
-
* Revokes access to all [entrances](https://
|
|
2152
|
+
* Revokes access to all [entrances](https://www.seam.co/docs/api/acs/entrances/object) for a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
2153
2153
|
*/
|
|
2154
2154
|
get '/acs/users/revoke_access_to_all_entrances'(): (
|
|
2155
2155
|
parameters: AcsUsersRevokeAccessToAllEntrancesParameters,
|
|
@@ -2165,7 +2165,7 @@ export class SeamHttpEndpoints {
|
|
|
2165
2165
|
}
|
|
2166
2166
|
|
|
2167
2167
|
/**
|
|
2168
|
-
* [Suspends](https://
|
|
2168
|
+
* [Suspends](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#suspend-an-acs-user) a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). Suspending an access system user revokes their access temporarily. To restore an access system user's access, you can [unsuspend](https://www.seam.co/docs/api/acs/users/unsuspend) them.
|
|
2169
2169
|
*/
|
|
2170
2170
|
get '/acs/users/suspend'(): (
|
|
2171
2171
|
parameters: AcsUsersSuspendParameters,
|
|
@@ -2181,7 +2181,7 @@ export class SeamHttpEndpoints {
|
|
|
2181
2181
|
}
|
|
2182
2182
|
|
|
2183
2183
|
/**
|
|
2184
|
-
* [Unsuspends](https://
|
|
2184
|
+
* [Unsuspends](https://www.seam.co/docs/low-level-apis/access-systems/user-management/suspending-and-unsuspending-users#unsuspend-an-acs-user) a specified suspended [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). While [suspending an access system user](https://www.seam.co/docs/api/acs/users/suspend) revokes their access temporarily, unsuspending the access system user restores their access.
|
|
2185
2185
|
*/
|
|
2186
2186
|
get '/acs/users/unsuspend'(): (
|
|
2187
2187
|
parameters: AcsUsersUnsuspendParameters,
|
|
@@ -2197,7 +2197,7 @@ export class SeamHttpEndpoints {
|
|
|
2197
2197
|
}
|
|
2198
2198
|
|
|
2199
2199
|
/**
|
|
2200
|
-
* Updates the properties of a specified [access system user](https://
|
|
2200
|
+
* Updates the properties of a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
2201
2201
|
*/
|
|
2202
2202
|
get '/acs/users/update'(): (
|
|
2203
2203
|
parameters: AcsUsersUpdateParameters,
|
|
@@ -2213,7 +2213,7 @@ export class SeamHttpEndpoints {
|
|
|
2213
2213
|
}
|
|
2214
2214
|
|
|
2215
2215
|
/**
|
|
2216
|
-
* Returns a specified [action attempt](https://
|
|
2216
|
+
* Returns a specified [action attempt](https://www.seam.co/docs/core-concepts/action-attempts).
|
|
2217
2217
|
*/
|
|
2218
2218
|
get '/action_attempts/get'(): (
|
|
2219
2219
|
parameters: ActionAttemptsGetParameters,
|
|
@@ -2229,7 +2229,7 @@ export class SeamHttpEndpoints {
|
|
|
2229
2229
|
}
|
|
2230
2230
|
|
|
2231
2231
|
/**
|
|
2232
|
-
* Returns a list of the [action attempts](https://
|
|
2232
|
+
* Returns a list of the [action attempts](https://www.seam.co/docs/core-concepts/action-attempts) that you specify as an array of `action_attempt_id`s.
|
|
2233
2233
|
*/
|
|
2234
2234
|
get '/action_attempts/list'(): (
|
|
2235
2235
|
parameters?: ActionAttemptsListParameters,
|
|
@@ -2245,7 +2245,7 @@ export class SeamHttpEndpoints {
|
|
|
2245
2245
|
}
|
|
2246
2246
|
|
|
2247
2247
|
/**
|
|
2248
|
-
* Creates a new [client session](https://
|
|
2248
|
+
* Creates a new [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
2249
2249
|
*/
|
|
2250
2250
|
get '/client_sessions/create'(): (
|
|
2251
2251
|
parameters?: ClientSessionsCreateParameters,
|
|
@@ -2261,7 +2261,7 @@ export class SeamHttpEndpoints {
|
|
|
2261
2261
|
}
|
|
2262
2262
|
|
|
2263
2263
|
/**
|
|
2264
|
-
* Deletes a [client session](https://
|
|
2264
|
+
* Deletes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
2265
2265
|
*/
|
|
2266
2266
|
get '/client_sessions/delete'(): (
|
|
2267
2267
|
parameters: ClientSessionsDeleteParameters,
|
|
@@ -2277,7 +2277,7 @@ export class SeamHttpEndpoints {
|
|
|
2277
2277
|
}
|
|
2278
2278
|
|
|
2279
2279
|
/**
|
|
2280
|
-
* Returns a specified [client session](https://
|
|
2280
|
+
* Returns a specified [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
2281
2281
|
*/
|
|
2282
2282
|
get '/client_sessions/get'(): (
|
|
2283
2283
|
parameters?: ClientSessionsGetParameters,
|
|
@@ -2293,7 +2293,7 @@ export class SeamHttpEndpoints {
|
|
|
2293
2293
|
}
|
|
2294
2294
|
|
|
2295
2295
|
/**
|
|
2296
|
-
* Returns a [client session](https://
|
|
2296
|
+
* Returns a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) with specific characteristics or creates a new client session with these characteristics if it does not yet exist.
|
|
2297
2297
|
*/
|
|
2298
2298
|
get '/client_sessions/get_or_create'(): (
|
|
2299
2299
|
parameters?: ClientSessionsGetOrCreateParameters,
|
|
@@ -2309,7 +2309,7 @@ export class SeamHttpEndpoints {
|
|
|
2309
2309
|
}
|
|
2310
2310
|
|
|
2311
2311
|
/**
|
|
2312
|
-
* Grants a [client session](https://
|
|
2312
|
+
* Grants a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens) access to one or more resources, such as [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews), [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity), and so on.
|
|
2313
2313
|
*/
|
|
2314
2314
|
get '/client_sessions/grant_access'(): (
|
|
2315
2315
|
parameters: ClientSessionsGrantAccessParameters,
|
|
@@ -2325,7 +2325,7 @@ export class SeamHttpEndpoints {
|
|
|
2325
2325
|
}
|
|
2326
2326
|
|
|
2327
2327
|
/**
|
|
2328
|
-
* Returns a list of all [client sessions](https://
|
|
2328
|
+
* Returns a list of all [client sessions](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
2329
2329
|
*/
|
|
2330
2330
|
get '/client_sessions/list'(): (
|
|
2331
2331
|
parameters?: ClientSessionsListParameters,
|
|
@@ -2341,9 +2341,9 @@ export class SeamHttpEndpoints {
|
|
|
2341
2341
|
}
|
|
2342
2342
|
|
|
2343
2343
|
/**
|
|
2344
|
-
* Revokes a [client session](https://
|
|
2344
|
+
* Revokes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
2345
2345
|
*
|
|
2346
|
-
* Note that [deleting a client session](https://
|
|
2346
|
+
* Note that [deleting a client session](https://www.seam.co/docs/api/client_sessions/delete) is a separate action.
|
|
2347
2347
|
*/
|
|
2348
2348
|
get '/client_sessions/revoke'(): (
|
|
2349
2349
|
parameters: ClientSessionsRevokeParameters,
|
|
@@ -2359,13 +2359,13 @@ export class SeamHttpEndpoints {
|
|
|
2359
2359
|
}
|
|
2360
2360
|
|
|
2361
2361
|
/**
|
|
2362
|
-
* Creates a new [Connect Webview](https://
|
|
2362
|
+
* Creates a new [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
2363
2363
|
*
|
|
2364
2364
|
* To enable a user to connect their devices or systems to Seam, they must sign in to their device or system account. To enable a user to sign in, you create a `connect_webview`. After creating the Connect Webview, you receive a URL that you can use to display the visual component of this Connect Webview for your user. You can open an iframe or new window to display the Connect Webview.
|
|
2365
2365
|
*
|
|
2366
2366
|
* You should make a new `connect_webview` for each unique login request. Each `connect_webview` tracks the user that signed in with it. You receive an error if you reuse a Connect Webview for the same user twice or if you use the same Connect Webview for multiple users.
|
|
2367
2367
|
*
|
|
2368
|
-
* See also: [Connect Webview Process](https://
|
|
2368
|
+
* See also: [Connect Webview Process](https://www.seam.co/docs/core-concepts/connect-webviews/connect-webview-process).
|
|
2369
2369
|
*/
|
|
2370
2370
|
get '/connect_webviews/create'(): (
|
|
2371
2371
|
parameters?: ConnectWebviewsCreateParameters,
|
|
@@ -2381,7 +2381,7 @@ export class SeamHttpEndpoints {
|
|
|
2381
2381
|
}
|
|
2382
2382
|
|
|
2383
2383
|
/**
|
|
2384
|
-
* Deletes a [Connect Webview](https://
|
|
2384
|
+
* Deletes a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
2385
2385
|
*
|
|
2386
2386
|
* You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.
|
|
2387
2387
|
*/
|
|
@@ -2399,7 +2399,7 @@ export class SeamHttpEndpoints {
|
|
|
2399
2399
|
}
|
|
2400
2400
|
|
|
2401
2401
|
/**
|
|
2402
|
-
* Returns a specified [Connect Webview](https://
|
|
2402
|
+
* Returns a specified [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
2403
2403
|
*
|
|
2404
2404
|
* Unless you're using a `custom_redirect_url`, you should poll a newly-created `connect_webview` to find out if the user has signed in or to get details about what devices they've connected.
|
|
2405
2405
|
*/
|
|
@@ -2417,7 +2417,7 @@ export class SeamHttpEndpoints {
|
|
|
2417
2417
|
}
|
|
2418
2418
|
|
|
2419
2419
|
/**
|
|
2420
|
-
* Returns a list of all [Connect Webviews](https://
|
|
2420
|
+
* Returns a list of all [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
2421
2421
|
*/
|
|
2422
2422
|
get '/connect_webviews/list'(): (
|
|
2423
2423
|
parameters?: ConnectWebviewsListParameters,
|
|
@@ -2433,7 +2433,7 @@ export class SeamHttpEndpoints {
|
|
|
2433
2433
|
}
|
|
2434
2434
|
|
|
2435
2435
|
/**
|
|
2436
|
-
* Deletes a specified [connected account](https://
|
|
2436
|
+
* Deletes a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
2437
2437
|
*
|
|
2438
2438
|
* Deleting a connected account triggers a `connected_account.deleted` event and removes the connected account and all data associated with the connected account from Seam, including devices, events, access codes, and so on. For every deleted resource, Seam sends a corresponding deleted event, but the resource is not deleted from the provider.
|
|
2439
2439
|
*
|
|
@@ -2453,7 +2453,7 @@ export class SeamHttpEndpoints {
|
|
|
2453
2453
|
}
|
|
2454
2454
|
|
|
2455
2455
|
/**
|
|
2456
|
-
* Returns a specified [connected account](https://
|
|
2456
|
+
* Returns a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
2457
2457
|
*/
|
|
2458
2458
|
get '/connected_accounts/get'(): (
|
|
2459
2459
|
parameters: ConnectedAccountsGetParameters,
|
|
@@ -2469,7 +2469,7 @@ export class SeamHttpEndpoints {
|
|
|
2469
2469
|
}
|
|
2470
2470
|
|
|
2471
2471
|
/**
|
|
2472
|
-
* Returns a list of all [connected accounts](https://
|
|
2472
|
+
* Returns a list of all [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
2473
2473
|
*/
|
|
2474
2474
|
get '/connected_accounts/list'(): (
|
|
2475
2475
|
parameters?: ConnectedAccountsListParameters,
|
|
@@ -2485,7 +2485,7 @@ export class SeamHttpEndpoints {
|
|
|
2485
2485
|
}
|
|
2486
2486
|
|
|
2487
2487
|
/**
|
|
2488
|
-
* Request a [connected account](https://
|
|
2488
|
+
* Request a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.
|
|
2489
2489
|
*/
|
|
2490
2490
|
get '/connected_accounts/sync'(): (
|
|
2491
2491
|
parameters: ConnectedAccountsSyncParameters,
|
|
@@ -2501,7 +2501,7 @@ export class SeamHttpEndpoints {
|
|
|
2501
2501
|
}
|
|
2502
2502
|
|
|
2503
2503
|
/**
|
|
2504
|
-
* Updates a [connected account](https://
|
|
2504
|
+
* Updates a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
2505
2505
|
*/
|
|
2506
2506
|
get '/connected_accounts/update'(): (
|
|
2507
2507
|
parameters: ConnectedAccountsUpdateParameters,
|
|
@@ -2517,7 +2517,7 @@ export class SeamHttpEndpoints {
|
|
|
2517
2517
|
}
|
|
2518
2518
|
|
|
2519
2519
|
/**
|
|
2520
|
-
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://
|
|
2520
|
+
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
2521
2521
|
*/
|
|
2522
2522
|
get '/connected_accounts/simulate/disconnect'(): (
|
|
2523
2523
|
parameters: ConnectedAccountsSimulateDisconnectParameters,
|
|
@@ -2585,7 +2585,7 @@ export class SeamHttpEndpoints {
|
|
|
2585
2585
|
}
|
|
2586
2586
|
|
|
2587
2587
|
/**
|
|
2588
|
-
* Returns a specified [device](https://
|
|
2588
|
+
* Returns a specified [device](https://www.seam.co/docs/core-concepts/devices).
|
|
2589
2589
|
*
|
|
2590
2590
|
* You must specify either `device_id` or `name`.
|
|
2591
2591
|
*/
|
|
@@ -2603,7 +2603,7 @@ export class SeamHttpEndpoints {
|
|
|
2603
2603
|
}
|
|
2604
2604
|
|
|
2605
2605
|
/**
|
|
2606
|
-
* Returns a list of all [devices](https://
|
|
2606
|
+
* Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices).
|
|
2607
2607
|
*/
|
|
2608
2608
|
get '/devices/list'(): (
|
|
2609
2609
|
parameters?: DevicesListParameters,
|
|
@@ -2621,9 +2621,9 @@ export class SeamHttpEndpoints {
|
|
|
2621
2621
|
/**
|
|
2622
2622
|
* Returns a list of all device providers.
|
|
2623
2623
|
*
|
|
2624
|
-
* The information that this endpoint returns for each provider includes a set of [capability flags](https://
|
|
2624
|
+
* The information that this endpoint returns for each provider includes a set of [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.
|
|
2625
2625
|
*
|
|
2626
|
-
* When you create a [Connect Webview](https://
|
|
2626
|
+
* When you create a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
|
|
2627
2627
|
*/
|
|
2628
2628
|
get '/devices/list_device_providers'(): (
|
|
2629
2629
|
parameters?: DevicesListDeviceProvidersParameters,
|
|
@@ -2655,9 +2655,9 @@ export class SeamHttpEndpoints {
|
|
|
2655
2655
|
}
|
|
2656
2656
|
|
|
2657
2657
|
/**
|
|
2658
|
-
* Updates a specified [device](https://
|
|
2658
|
+
* Updates a specified [device](https://www.seam.co/docs/core-concepts/devices).
|
|
2659
2659
|
*
|
|
2660
|
-
* You can add or change [custom metadata](https://
|
|
2660
|
+
* You can add or change [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
2661
2661
|
*/
|
|
2662
2662
|
get '/devices/update'(): (
|
|
2663
2663
|
parameters: DevicesUpdateParameters,
|
|
@@ -2673,7 +2673,7 @@ export class SeamHttpEndpoints {
|
|
|
2673
2673
|
}
|
|
2674
2674
|
|
|
2675
2675
|
/**
|
|
2676
|
-
* Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://
|
|
2676
|
+
* Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
|
|
2677
2677
|
*/
|
|
2678
2678
|
get '/devices/simulate/connect'(): (
|
|
2679
2679
|
parameters: DevicesSimulateConnectParameters,
|
|
@@ -2708,7 +2708,7 @@ export class SeamHttpEndpoints {
|
|
|
2708
2708
|
}
|
|
2709
2709
|
|
|
2710
2710
|
/**
|
|
2711
|
-
* Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://
|
|
2711
|
+
* Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
|
|
2712
2712
|
*/
|
|
2713
2713
|
get '/devices/simulate/disconnect'(): (
|
|
2714
2714
|
parameters: DevicesSimulateDisconnectParameters,
|
|
@@ -2762,7 +2762,7 @@ export class SeamHttpEndpoints {
|
|
|
2762
2762
|
}
|
|
2763
2763
|
|
|
2764
2764
|
/**
|
|
2765
|
-
* Simulates removing a device from Seam. Only applicable for [sandbox devices](https://
|
|
2765
|
+
* Simulates removing a device from Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
|
|
2766
2766
|
*/
|
|
2767
2767
|
get '/devices/simulate/remove'(): (
|
|
2768
2768
|
parameters: DevicesSimulateRemoveParameters,
|
|
@@ -2778,9 +2778,9 @@ export class SeamHttpEndpoints {
|
|
|
2778
2778
|
}
|
|
2779
2779
|
|
|
2780
2780
|
/**
|
|
2781
|
-
* Returns a specified [unmanaged device](https://
|
|
2781
|
+
* Returns a specified [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
2782
2782
|
*
|
|
2783
|
-
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://
|
|
2783
|
+
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
|
|
2784
2784
|
*
|
|
2785
2785
|
* You must specify either `device_id` or `name`.
|
|
2786
2786
|
*/
|
|
@@ -2798,9 +2798,9 @@ export class SeamHttpEndpoints {
|
|
|
2798
2798
|
}
|
|
2799
2799
|
|
|
2800
2800
|
/**
|
|
2801
|
-
* Returns a list of all [unmanaged devices](https://
|
|
2801
|
+
* Returns a list of all [unmanaged devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
2802
2802
|
*
|
|
2803
|
-
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://
|
|
2803
|
+
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
|
|
2804
2804
|
*/
|
|
2805
2805
|
get '/devices/unmanaged/list'(): (
|
|
2806
2806
|
parameters?: DevicesUnmanagedListParameters,
|
|
@@ -2816,9 +2816,9 @@ export class SeamHttpEndpoints {
|
|
|
2816
2816
|
}
|
|
2817
2817
|
|
|
2818
2818
|
/**
|
|
2819
|
-
* Updates a specified [unmanaged device](https://
|
|
2819
|
+
* Updates a specified [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.
|
|
2820
2820
|
*
|
|
2821
|
-
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://
|
|
2821
|
+
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
|
|
2822
2822
|
*/
|
|
2823
2823
|
get '/devices/unmanaged/update'(): (
|
|
2824
2824
|
parameters: DevicesUnmanagedUpdateParameters,
|
|
@@ -2834,7 +2834,7 @@ export class SeamHttpEndpoints {
|
|
|
2834
2834
|
}
|
|
2835
2835
|
|
|
2836
2836
|
/**
|
|
2837
|
-
* Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://
|
|
2837
|
+
* Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place.
|
|
2838
2838
|
*/
|
|
2839
2839
|
get '/events/get'(): (
|
|
2840
2840
|
parameters: EventsGetParameters,
|
|
@@ -2850,7 +2850,7 @@ export class SeamHttpEndpoints {
|
|
|
2850
2850
|
}
|
|
2851
2851
|
|
|
2852
2852
|
/**
|
|
2853
|
-
* Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://
|
|
2853
|
+
* Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place.
|
|
2854
2854
|
*/
|
|
2855
2855
|
get '/events/list'(): (
|
|
2856
2856
|
parameters: EventsListParameters,
|
|
@@ -2866,7 +2866,7 @@ export class SeamHttpEndpoints {
|
|
|
2866
2866
|
}
|
|
2867
2867
|
|
|
2868
2868
|
/**
|
|
2869
|
-
* Deletes a specified [Instant Key](https://
|
|
2869
|
+
* Deletes a specified [Instant Key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
2870
2870
|
*/
|
|
2871
2871
|
get '/instant_keys/delete'(): (
|
|
2872
2872
|
parameters: InstantKeysDeleteParameters,
|
|
@@ -2882,7 +2882,7 @@ export class SeamHttpEndpoints {
|
|
|
2882
2882
|
}
|
|
2883
2883
|
|
|
2884
2884
|
/**
|
|
2885
|
-
* Gets an [instant key](https://
|
|
2885
|
+
* Gets an [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
2886
2886
|
*/
|
|
2887
2887
|
get '/instant_keys/get'(): (
|
|
2888
2888
|
parameters: InstantKeysGetParameters,
|
|
@@ -2898,7 +2898,7 @@ export class SeamHttpEndpoints {
|
|
|
2898
2898
|
}
|
|
2899
2899
|
|
|
2900
2900
|
/**
|
|
2901
|
-
* Returns a list of all [instant keys](https://
|
|
2901
|
+
* Returns a list of all [instant keys](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
2902
2902
|
*/
|
|
2903
2903
|
get '/instant_keys/list'(): (
|
|
2904
2904
|
parameters?: InstantKeysListParameters,
|
|
@@ -2914,7 +2914,7 @@ export class SeamHttpEndpoints {
|
|
|
2914
2914
|
}
|
|
2915
2915
|
|
|
2916
2916
|
/**
|
|
2917
|
-
* Configures the auto-lock setting for a specified [lock](https://
|
|
2917
|
+
* Configures the auto-lock setting for a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
2918
2918
|
*/
|
|
2919
2919
|
get '/locks/configure_auto_lock'(): (
|
|
2920
2920
|
parameters: LocksConfigureAutoLockParameters,
|
|
@@ -2930,7 +2930,7 @@ export class SeamHttpEndpoints {
|
|
|
2930
2930
|
}
|
|
2931
2931
|
|
|
2932
2932
|
/**
|
|
2933
|
-
* Returns a specified [lock](https://
|
|
2933
|
+
* Returns a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
2934
2934
|
* @deprecated Use `/devices/get` instead.
|
|
2935
2935
|
*/
|
|
2936
2936
|
get '/locks/get'(): (
|
|
@@ -2947,7 +2947,7 @@ export class SeamHttpEndpoints {
|
|
|
2947
2947
|
}
|
|
2948
2948
|
|
|
2949
2949
|
/**
|
|
2950
|
-
* Returns a list of all [locks](https://
|
|
2950
|
+
* Returns a list of all [locks](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
2951
2951
|
*/
|
|
2952
2952
|
get '/locks/list'(): (
|
|
2953
2953
|
parameters?: LocksListParameters,
|
|
@@ -2963,7 +2963,7 @@ export class SeamHttpEndpoints {
|
|
|
2963
2963
|
}
|
|
2964
2964
|
|
|
2965
2965
|
/**
|
|
2966
|
-
* Locks a [lock](https://
|
|
2966
|
+
* Locks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock).
|
|
2967
2967
|
*/
|
|
2968
2968
|
get '/locks/lock_door'(): (
|
|
2969
2969
|
parameters: LocksLockDoorParameters,
|
|
@@ -2979,7 +2979,7 @@ export class SeamHttpEndpoints {
|
|
|
2979
2979
|
}
|
|
2980
2980
|
|
|
2981
2981
|
/**
|
|
2982
|
-
* Unlocks a [lock](https://
|
|
2982
|
+
* Unlocks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock).
|
|
2983
2983
|
*/
|
|
2984
2984
|
get '/locks/unlock_door'(): (
|
|
2985
2985
|
parameters: LocksUnlockDoorParameters,
|
|
@@ -2995,7 +2995,7 @@ export class SeamHttpEndpoints {
|
|
|
2995
2995
|
}
|
|
2996
2996
|
|
|
2997
2997
|
/**
|
|
2998
|
-
* Simulates the entry of a code on a keypad. You can only perform this action for [August](https://
|
|
2998
|
+
* Simulates the entry of a code on a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
2999
2999
|
*/
|
|
3000
3000
|
get '/locks/simulate/keypad_code_entry'(): (
|
|
3001
3001
|
parameters: LocksSimulateKeypadCodeEntryParameters,
|
|
@@ -3011,7 +3011,7 @@ export class SeamHttpEndpoints {
|
|
|
3011
3011
|
}
|
|
3012
3012
|
|
|
3013
3013
|
/**
|
|
3014
|
-
* Simulates a manual lock action using a keypad. You can only perform this action for [August](https://
|
|
3014
|
+
* Simulates a manual lock action using a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
3015
3015
|
*/
|
|
3016
3016
|
get '/locks/simulate/manual_lock_via_keypad'(): (
|
|
3017
3017
|
parameters: LocksSimulateManualLockViaKeypadParameters,
|
|
@@ -3027,7 +3027,7 @@ export class SeamHttpEndpoints {
|
|
|
3027
3027
|
}
|
|
3028
3028
|
|
|
3029
3029
|
/**
|
|
3030
|
-
* Returns a list of all [noise sensors](https://
|
|
3030
|
+
* Returns a list of all [noise sensors](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
3031
3031
|
*/
|
|
3032
3032
|
get '/noise_sensors/list'(): (
|
|
3033
3033
|
parameters?: NoiseSensorsListParameters,
|
|
@@ -3043,7 +3043,7 @@ export class SeamHttpEndpoints {
|
|
|
3043
3043
|
}
|
|
3044
3044
|
|
|
3045
3045
|
/**
|
|
3046
|
-
* Creates a new [noise threshold](https://
|
|
3046
|
+
* Creates a new [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
|
|
3047
3047
|
*/
|
|
3048
3048
|
get '/noise_sensors/noise_thresholds/create'(): (
|
|
3049
3049
|
parameters: NoiseSensorsNoiseThresholdsCreateParameters,
|
|
@@ -3062,7 +3062,7 @@ export class SeamHttpEndpoints {
|
|
|
3062
3062
|
}
|
|
3063
3063
|
|
|
3064
3064
|
/**
|
|
3065
|
-
* Deletes a [noise threshold](https://
|
|
3065
|
+
* Deletes a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
3066
3066
|
*/
|
|
3067
3067
|
get '/noise_sensors/noise_thresholds/delete'(): (
|
|
3068
3068
|
parameters: NoiseSensorsNoiseThresholdsDeleteParameters,
|
|
@@ -3081,7 +3081,7 @@ export class SeamHttpEndpoints {
|
|
|
3081
3081
|
}
|
|
3082
3082
|
|
|
3083
3083
|
/**
|
|
3084
|
-
* Returns a specified [noise threshold](https://
|
|
3084
|
+
* Returns a specified [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
3085
3085
|
*/
|
|
3086
3086
|
get '/noise_sensors/noise_thresholds/get'(): (
|
|
3087
3087
|
parameters: NoiseSensorsNoiseThresholdsGetParameters,
|
|
@@ -3100,7 +3100,7 @@ export class SeamHttpEndpoints {
|
|
|
3100
3100
|
}
|
|
3101
3101
|
|
|
3102
3102
|
/**
|
|
3103
|
-
* Returns a list of all [noise thresholds](https://
|
|
3103
|
+
* Returns a list of all [noise thresholds](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
3104
3104
|
*/
|
|
3105
3105
|
get '/noise_sensors/noise_thresholds/list'(): (
|
|
3106
3106
|
parameters: NoiseSensorsNoiseThresholdsListParameters,
|
|
@@ -3119,7 +3119,7 @@ export class SeamHttpEndpoints {
|
|
|
3119
3119
|
}
|
|
3120
3120
|
|
|
3121
3121
|
/**
|
|
3122
|
-
* Updates a [noise threshold](https://
|
|
3122
|
+
* Updates a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
3123
3123
|
*/
|
|
3124
3124
|
get '/noise_sensors/noise_thresholds/update'(): (
|
|
3125
3125
|
parameters: NoiseSensorsNoiseThresholdsUpdateParameters,
|
|
@@ -3138,7 +3138,7 @@ export class SeamHttpEndpoints {
|
|
|
3138
3138
|
}
|
|
3139
3139
|
|
|
3140
3140
|
/**
|
|
3141
|
-
* Simulates the triggering of a [noise threshold](https://
|
|
3141
|
+
* Simulates the triggering of a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
3142
3142
|
*/
|
|
3143
3143
|
get '/noise_sensors/simulate/trigger_noise_threshold'(): (
|
|
3144
3144
|
parameters: NoiseSensorsSimulateTriggerNoiseThresholdParameters,
|
|
@@ -3154,7 +3154,7 @@ export class SeamHttpEndpoints {
|
|
|
3154
3154
|
}
|
|
3155
3155
|
|
|
3156
3156
|
/**
|
|
3157
|
-
* Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://
|
|
3157
|
+
* Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).
|
|
3158
3158
|
*/
|
|
3159
3159
|
get '/phones/deactivate'(): (
|
|
3160
3160
|
parameters: PhonesDeactivateParameters,
|
|
@@ -3170,7 +3170,7 @@ export class SeamHttpEndpoints {
|
|
|
3170
3170
|
}
|
|
3171
3171
|
|
|
3172
3172
|
/**
|
|
3173
|
-
* Returns a specified [phone](https://
|
|
3173
|
+
* Returns a specified [phone](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity).
|
|
3174
3174
|
*/
|
|
3175
3175
|
get '/phones/get'(): (
|
|
3176
3176
|
parameters: PhonesGetParameters,
|
|
@@ -3186,7 +3186,7 @@ export class SeamHttpEndpoints {
|
|
|
3186
3186
|
}
|
|
3187
3187
|
|
|
3188
3188
|
/**
|
|
3189
|
-
* Returns a list of all [phones](https://
|
|
3189
|
+
* Returns a list of all [phones](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
|
|
3190
3190
|
*/
|
|
3191
3191
|
get '/phones/list'(): (
|
|
3192
3192
|
parameters?: PhonesListParameters,
|
|
@@ -3202,7 +3202,7 @@ export class SeamHttpEndpoints {
|
|
|
3202
3202
|
}
|
|
3203
3203
|
|
|
3204
3204
|
/**
|
|
3205
|
-
* Creates a new simulated phone in a [sandbox workspace](https://
|
|
3205
|
+
* Creates a new simulated phone in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://www.seam.co/docs/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).
|
|
3206
3206
|
*/
|
|
3207
3207
|
get '/phones/simulate/create_sandbox_phone'(): (
|
|
3208
3208
|
parameters: PhonesSimulateCreateSandboxPhoneParameters,
|
|
@@ -3218,7 +3218,7 @@ export class SeamHttpEndpoints {
|
|
|
3218
3218
|
}
|
|
3219
3219
|
|
|
3220
3220
|
/**
|
|
3221
|
-
* Adds [entrances](https://
|
|
3221
|
+
* Adds [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.
|
|
3222
3222
|
*/
|
|
3223
3223
|
get '/spaces/add_acs_entrances'(): (
|
|
3224
3224
|
parameters: SpacesAddAcsEntrancesParameters,
|
|
@@ -3234,7 +3234,7 @@ export class SeamHttpEndpoints {
|
|
|
3234
3234
|
}
|
|
3235
3235
|
|
|
3236
3236
|
/**
|
|
3237
|
-
* Adds a [connected account](https://
|
|
3237
|
+
* Adds a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to a specific space.
|
|
3238
3238
|
*/
|
|
3239
3239
|
get '/spaces/add_connected_account'(): (
|
|
3240
3240
|
parameters: SpacesAddConnectedAccountParameters,
|
|
@@ -3346,7 +3346,7 @@ export class SeamHttpEndpoints {
|
|
|
3346
3346
|
}
|
|
3347
3347
|
|
|
3348
3348
|
/**
|
|
3349
|
-
* Removes [entrances](https://
|
|
3349
|
+
* Removes [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.
|
|
3350
3350
|
*/
|
|
3351
3351
|
get '/spaces/remove_acs_entrances'(): (
|
|
3352
3352
|
parameters: SpacesRemoveAcsEntrancesParameters,
|
|
@@ -3362,7 +3362,7 @@ export class SeamHttpEndpoints {
|
|
|
3362
3362
|
}
|
|
3363
3363
|
|
|
3364
3364
|
/**
|
|
3365
|
-
* Removes a [connected account](https://
|
|
3365
|
+
* Removes a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) from a specific space.
|
|
3366
3366
|
*/
|
|
3367
3367
|
get '/spaces/remove_connected_account'(): (
|
|
3368
3368
|
parameters: SpacesRemoveConnectedAccountParameters,
|
|
@@ -3410,7 +3410,7 @@ export class SeamHttpEndpoints {
|
|
|
3410
3410
|
}
|
|
3411
3411
|
|
|
3412
3412
|
/**
|
|
3413
|
-
* Activates a specified [climate preset](https://
|
|
3413
|
+
* Activates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
3414
3414
|
*/
|
|
3415
3415
|
get '/thermostats/activate_climate_preset'(): (
|
|
3416
3416
|
parameters: ThermostatsActivateClimatePresetParameters,
|
|
@@ -3426,7 +3426,7 @@ export class SeamHttpEndpoints {
|
|
|
3426
3426
|
}
|
|
3427
3427
|
|
|
3428
3428
|
/**
|
|
3429
|
-
* Sets a specified [thermostat](https://
|
|
3429
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [cool mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
3430
3430
|
*/
|
|
3431
3431
|
get '/thermostats/cool'(): (
|
|
3432
3432
|
parameters: ThermostatsCoolParameters,
|
|
@@ -3442,7 +3442,7 @@ export class SeamHttpEndpoints {
|
|
|
3442
3442
|
}
|
|
3443
3443
|
|
|
3444
3444
|
/**
|
|
3445
|
-
* Creates a [climate preset](https://
|
|
3445
|
+
* Creates a [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
3446
3446
|
*/
|
|
3447
3447
|
get '/thermostats/create_climate_preset'(): (
|
|
3448
3448
|
parameters: ThermostatsCreateClimatePresetParameters,
|
|
@@ -3458,7 +3458,7 @@ export class SeamHttpEndpoints {
|
|
|
3458
3458
|
}
|
|
3459
3459
|
|
|
3460
3460
|
/**
|
|
3461
|
-
* Deletes a specified [climate preset](https://
|
|
3461
|
+
* Deletes a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
3462
3462
|
*/
|
|
3463
3463
|
get '/thermostats/delete_climate_preset'(): (
|
|
3464
3464
|
parameters: ThermostatsDeleteClimatePresetParameters,
|
|
@@ -3474,7 +3474,7 @@ export class SeamHttpEndpoints {
|
|
|
3474
3474
|
}
|
|
3475
3475
|
|
|
3476
3476
|
/**
|
|
3477
|
-
* Sets a specified [thermostat](https://
|
|
3477
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
3478
3478
|
*/
|
|
3479
3479
|
get '/thermostats/heat'(): (
|
|
3480
3480
|
parameters: ThermostatsHeatParameters,
|
|
@@ -3490,7 +3490,7 @@ export class SeamHttpEndpoints {
|
|
|
3490
3490
|
}
|
|
3491
3491
|
|
|
3492
3492
|
/**
|
|
3493
|
-
* Sets a specified [thermostat](https://
|
|
3493
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat-cool ("auto") mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
3494
3494
|
*/
|
|
3495
3495
|
get '/thermostats/heat_cool'(): (
|
|
3496
3496
|
parameters: ThermostatsHeatCoolParameters,
|
|
@@ -3506,7 +3506,7 @@ export class SeamHttpEndpoints {
|
|
|
3506
3506
|
}
|
|
3507
3507
|
|
|
3508
3508
|
/**
|
|
3509
|
-
* Returns a list of all [thermostats](https://
|
|
3509
|
+
* Returns a list of all [thermostats](https://www.seam.co/docs/capability-guides/thermostats).
|
|
3510
3510
|
*/
|
|
3511
3511
|
get '/thermostats/list'(): (
|
|
3512
3512
|
parameters?: ThermostatsListParameters,
|
|
@@ -3522,7 +3522,7 @@ export class SeamHttpEndpoints {
|
|
|
3522
3522
|
}
|
|
3523
3523
|
|
|
3524
3524
|
/**
|
|
3525
|
-
* Sets a specified [thermostat](https://
|
|
3525
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to ["off" mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
3526
3526
|
*/
|
|
3527
3527
|
get '/thermostats/off'(): (
|
|
3528
3528
|
parameters: ThermostatsOffParameters,
|
|
@@ -3538,7 +3538,7 @@ export class SeamHttpEndpoints {
|
|
|
3538
3538
|
}
|
|
3539
3539
|
|
|
3540
3540
|
/**
|
|
3541
|
-
* Sets a specified [climate preset](https://
|
|
3541
|
+
* Sets a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
3542
3542
|
*/
|
|
3543
3543
|
get '/thermostats/set_fallback_climate_preset'(): (
|
|
3544
3544
|
parameters: ThermostatsSetFallbackClimatePresetParameters,
|
|
@@ -3554,7 +3554,7 @@ export class SeamHttpEndpoints {
|
|
|
3554
3554
|
}
|
|
3555
3555
|
|
|
3556
3556
|
/**
|
|
3557
|
-
* Sets the [fan mode setting](https://
|
|
3557
|
+
* Sets the [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
3558
3558
|
*/
|
|
3559
3559
|
get '/thermostats/set_fan_mode'(): (
|
|
3560
3560
|
parameters: ThermostatsSetFanModeParameters,
|
|
@@ -3570,7 +3570,7 @@ export class SeamHttpEndpoints {
|
|
|
3570
3570
|
}
|
|
3571
3571
|
|
|
3572
3572
|
/**
|
|
3573
|
-
* Sets the [HVAC mode](https://
|
|
3573
|
+
* Sets the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
3574
3574
|
*/
|
|
3575
3575
|
get '/thermostats/set_hvac_mode'(): (
|
|
3576
3576
|
parameters: ThermostatsSetHvacModeParameters,
|
|
@@ -3586,7 +3586,7 @@ export class SeamHttpEndpoints {
|
|
|
3586
3586
|
}
|
|
3587
3587
|
|
|
3588
3588
|
/**
|
|
3589
|
-
* Sets a [temperature threshold](https://
|
|
3589
|
+
* Sets a [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.
|
|
3590
3590
|
*/
|
|
3591
3591
|
get '/thermostats/set_temperature_threshold'(): (
|
|
3592
3592
|
parameters: ThermostatsSetTemperatureThresholdParameters,
|
|
@@ -3602,7 +3602,7 @@ export class SeamHttpEndpoints {
|
|
|
3602
3602
|
}
|
|
3603
3603
|
|
|
3604
3604
|
/**
|
|
3605
|
-
* Updates a specified [climate preset](https://
|
|
3605
|
+
* Updates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
3606
3606
|
*/
|
|
3607
3607
|
get '/thermostats/update_climate_preset'(): (
|
|
3608
3608
|
parameters: ThermostatsUpdateClimatePresetParameters,
|
|
@@ -3682,7 +3682,7 @@ export class SeamHttpEndpoints {
|
|
|
3682
3682
|
}
|
|
3683
3683
|
|
|
3684
3684
|
/**
|
|
3685
|
-
* Creates a new [thermostat schedule](https://
|
|
3685
|
+
* Creates a new [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
3686
3686
|
*/
|
|
3687
3687
|
get '/thermostats/schedules/create'(): (
|
|
3688
3688
|
parameters: ThermostatsSchedulesCreateParameters,
|
|
@@ -3698,7 +3698,7 @@ export class SeamHttpEndpoints {
|
|
|
3698
3698
|
}
|
|
3699
3699
|
|
|
3700
3700
|
/**
|
|
3701
|
-
* Deletes a [thermostat schedule](https://
|
|
3701
|
+
* Deletes a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
3702
3702
|
*/
|
|
3703
3703
|
get '/thermostats/schedules/delete'(): (
|
|
3704
3704
|
parameters: ThermostatsSchedulesDeleteParameters,
|
|
@@ -3714,7 +3714,7 @@ export class SeamHttpEndpoints {
|
|
|
3714
3714
|
}
|
|
3715
3715
|
|
|
3716
3716
|
/**
|
|
3717
|
-
* Returns a specified [thermostat schedule](https://
|
|
3717
|
+
* Returns a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
3718
3718
|
*/
|
|
3719
3719
|
get '/thermostats/schedules/get'(): (
|
|
3720
3720
|
parameters: ThermostatsSchedulesGetParameters,
|
|
@@ -3730,7 +3730,7 @@ export class SeamHttpEndpoints {
|
|
|
3730
3730
|
}
|
|
3731
3731
|
|
|
3732
3732
|
/**
|
|
3733
|
-
* Returns a list of all [thermostat schedules](https://
|
|
3733
|
+
* Returns a list of all [thermostat schedules](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
3734
3734
|
*/
|
|
3735
3735
|
get '/thermostats/schedules/list'(): (
|
|
3736
3736
|
parameters: ThermostatsSchedulesListParameters,
|
|
@@ -3746,7 +3746,7 @@ export class SeamHttpEndpoints {
|
|
|
3746
3746
|
}
|
|
3747
3747
|
|
|
3748
3748
|
/**
|
|
3749
|
-
* Updates a specified [thermostat schedule](https://
|
|
3749
|
+
* Updates a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
3750
3750
|
*/
|
|
3751
3751
|
get '/thermostats/schedules/update'(): (
|
|
3752
3752
|
parameters: ThermostatsSchedulesUpdateParameters,
|
|
@@ -3762,7 +3762,7 @@ export class SeamHttpEndpoints {
|
|
|
3762
3762
|
}
|
|
3763
3763
|
|
|
3764
3764
|
/**
|
|
3765
|
-
* Simulates having adjusted the [HVAC mode](https://
|
|
3765
|
+
* Simulates having adjusted the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://www.seam.co/docs/capability-guides/thermostats). Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
|
|
3766
3766
|
*/
|
|
3767
3767
|
get '/thermostats/simulate/hvac_mode_adjusted'(): (
|
|
3768
3768
|
parameters: ThermostatsSimulateHvacModeAdjustedParameters,
|
|
@@ -3778,7 +3778,7 @@ export class SeamHttpEndpoints {
|
|
|
3778
3778
|
}
|
|
3779
3779
|
|
|
3780
3780
|
/**
|
|
3781
|
-
* Simulates a [thermostat](https://
|
|
3781
|
+
* Simulates a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
|
|
3782
3782
|
*/
|
|
3783
3783
|
get '/thermostats/simulate/temperature_reached'(): (
|
|
3784
3784
|
parameters: ThermostatsSimulateTemperatureReachedParameters,
|
|
@@ -3794,7 +3794,7 @@ export class SeamHttpEndpoints {
|
|
|
3794
3794
|
}
|
|
3795
3795
|
|
|
3796
3796
|
/**
|
|
3797
|
-
* Adds a specified [access system user](https://
|
|
3797
|
+
* Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
3798
3798
|
*
|
|
3799
3799
|
* You must specify either `user_identity_id` or `user_identity_key` to identify the user identity.
|
|
3800
3800
|
*
|
|
@@ -3814,7 +3814,7 @@ export class SeamHttpEndpoints {
|
|
|
3814
3814
|
}
|
|
3815
3815
|
|
|
3816
3816
|
/**
|
|
3817
|
-
* Creates a new [user identity](https://
|
|
3817
|
+
* Creates a new [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
3818
3818
|
*/
|
|
3819
3819
|
get '/user_identities/create'(): (
|
|
3820
3820
|
parameters?: UserIdentitiesCreateParameters,
|
|
@@ -3830,7 +3830,7 @@ export class SeamHttpEndpoints {
|
|
|
3830
3830
|
}
|
|
3831
3831
|
|
|
3832
3832
|
/**
|
|
3833
|
-
* Deletes a specified [user identity](https://
|
|
3833
|
+
* Deletes a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://www.seam.co/docs/api/acs/credentials/object), [acs users](https://www.seam.co/docs/api/acs/users/object) and [client sessions](https://www.seam.co/docs/api/client_sessions/object).
|
|
3834
3834
|
*/
|
|
3835
3835
|
get '/user_identities/delete'(): (
|
|
3836
3836
|
parameters: UserIdentitiesDeleteParameters,
|
|
@@ -3846,7 +3846,7 @@ export class SeamHttpEndpoints {
|
|
|
3846
3846
|
}
|
|
3847
3847
|
|
|
3848
3848
|
/**
|
|
3849
|
-
* Generates a new [instant key](https://
|
|
3849
|
+
* Generates a new [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys) for a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
3850
3850
|
*/
|
|
3851
3851
|
get '/user_identities/generate_instant_key'(): (
|
|
3852
3852
|
parameters: UserIdentitiesGenerateInstantKeyParameters,
|
|
@@ -3862,7 +3862,7 @@ export class SeamHttpEndpoints {
|
|
|
3862
3862
|
}
|
|
3863
3863
|
|
|
3864
3864
|
/**
|
|
3865
|
-
* Returns a specified [user identity](https://
|
|
3865
|
+
* Returns a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
3866
3866
|
*/
|
|
3867
3867
|
get '/user_identities/get'(): (
|
|
3868
3868
|
parameters: UserIdentitiesGetParameters,
|
|
@@ -3878,7 +3878,7 @@ export class SeamHttpEndpoints {
|
|
|
3878
3878
|
}
|
|
3879
3879
|
|
|
3880
3880
|
/**
|
|
3881
|
-
* Grants a specified [user identity](https://
|
|
3881
|
+
* Grants a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://www.seam.co/docs/core-concepts/devices).
|
|
3882
3882
|
*/
|
|
3883
3883
|
get '/user_identities/grant_access_to_device'(): (
|
|
3884
3884
|
parameters: UserIdentitiesGrantAccessToDeviceParameters,
|
|
@@ -3894,7 +3894,7 @@ export class SeamHttpEndpoints {
|
|
|
3894
3894
|
}
|
|
3895
3895
|
|
|
3896
3896
|
/**
|
|
3897
|
-
* Returns a list of all [user identities](https://
|
|
3897
|
+
* Returns a list of all [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
3898
3898
|
*/
|
|
3899
3899
|
get '/user_identities/list'(): (
|
|
3900
3900
|
parameters?: UserIdentitiesListParameters,
|
|
@@ -3910,7 +3910,7 @@ export class SeamHttpEndpoints {
|
|
|
3910
3910
|
}
|
|
3911
3911
|
|
|
3912
3912
|
/**
|
|
3913
|
-
* Returns a list of all [devices](https://
|
|
3913
|
+
* Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity.
|
|
3914
3914
|
*/
|
|
3915
3915
|
get '/user_identities/list_accessible_devices'(): (
|
|
3916
3916
|
parameters: UserIdentitiesListAccessibleDevicesParameters,
|
|
@@ -3926,7 +3926,7 @@ export class SeamHttpEndpoints {
|
|
|
3926
3926
|
}
|
|
3927
3927
|
|
|
3928
3928
|
/**
|
|
3929
|
-
* Returns a list of all [ACS entrances](https://
|
|
3929
|
+
* Returns a list of all [ACS entrances](https://www.seam.co/docs/api/acs/entrances/object) accessible to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity.
|
|
3930
3930
|
*/
|
|
3931
3931
|
get '/user_identities/list_accessible_entrances'(): (
|
|
3932
3932
|
parameters: UserIdentitiesListAccessibleEntrancesParameters,
|
|
@@ -3942,7 +3942,7 @@ export class SeamHttpEndpoints {
|
|
|
3942
3942
|
}
|
|
3943
3943
|
|
|
3944
3944
|
/**
|
|
3945
|
-
* Returns a list of all [access systems](https://
|
|
3945
|
+
* Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
3946
3946
|
*/
|
|
3947
3947
|
get '/user_identities/list_acs_systems'(): (
|
|
3948
3948
|
parameters: UserIdentitiesListAcsSystemsParameters,
|
|
@@ -3958,7 +3958,7 @@ export class SeamHttpEndpoints {
|
|
|
3958
3958
|
}
|
|
3959
3959
|
|
|
3960
3960
|
/**
|
|
3961
|
-
* Returns a list of all [access system users](https://
|
|
3961
|
+
* Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
3962
3962
|
*/
|
|
3963
3963
|
get '/user_identities/list_acs_users'(): (
|
|
3964
3964
|
parameters: UserIdentitiesListAcsUsersParameters,
|
|
@@ -3974,7 +3974,7 @@ export class SeamHttpEndpoints {
|
|
|
3974
3974
|
}
|
|
3975
3975
|
|
|
3976
3976
|
/**
|
|
3977
|
-
* Merges one or more [user identities](https://
|
|
3977
|
+
* Merges one or more [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity.
|
|
3978
3978
|
*
|
|
3979
3979
|
* The primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as `merged_user_identity_ids` and `merged_user_identity_keys`.
|
|
3980
3980
|
*
|
|
@@ -3996,7 +3996,7 @@ export class SeamHttpEndpoints {
|
|
|
3996
3996
|
}
|
|
3997
3997
|
|
|
3998
3998
|
/**
|
|
3999
|
-
* Removes a specified [access system user](https://
|
|
3999
|
+
* Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
4000
4000
|
*/
|
|
4001
4001
|
get '/user_identities/remove_acs_user'(): (
|
|
4002
4002
|
parameters: UserIdentitiesRemoveAcsUserParameters,
|
|
@@ -4012,7 +4012,7 @@ export class SeamHttpEndpoints {
|
|
|
4012
4012
|
}
|
|
4013
4013
|
|
|
4014
4014
|
/**
|
|
4015
|
-
* Revokes access to a specified [device](https://
|
|
4015
|
+
* Revokes access to a specified [device](https://www.seam.co/docs/core-concepts/devices) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
4016
4016
|
*/
|
|
4017
4017
|
get '/user_identities/revoke_access_to_device'(): (
|
|
4018
4018
|
parameters: UserIdentitiesRevokeAccessToDeviceParameters,
|
|
@@ -4028,7 +4028,7 @@ export class SeamHttpEndpoints {
|
|
|
4028
4028
|
}
|
|
4029
4029
|
|
|
4030
4030
|
/**
|
|
4031
|
-
* Updates a specified [user identity](https://
|
|
4031
|
+
* Updates a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
4032
4032
|
*/
|
|
4033
4033
|
get '/user_identities/update'(): (
|
|
4034
4034
|
parameters: UserIdentitiesUpdateParameters,
|
|
@@ -4044,7 +4044,7 @@ export class SeamHttpEndpoints {
|
|
|
4044
4044
|
}
|
|
4045
4045
|
|
|
4046
4046
|
/**
|
|
4047
|
-
* Returns a specified unmanaged [user identity](https://
|
|
4047
|
+
* Returns a specified unmanaged [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).
|
|
4048
4048
|
*/
|
|
4049
4049
|
get '/user_identities/unmanaged/get'(): (
|
|
4050
4050
|
parameters: UserIdentitiesUnmanagedGetParameters,
|
|
@@ -4060,7 +4060,7 @@ export class SeamHttpEndpoints {
|
|
|
4060
4060
|
}
|
|
4061
4061
|
|
|
4062
4062
|
/**
|
|
4063
|
-
* Returns a list of all unmanaged [user identities](https://
|
|
4063
|
+
* Returns a list of all unmanaged [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).
|
|
4064
4064
|
*/
|
|
4065
4065
|
get '/user_identities/unmanaged/list'(): (
|
|
4066
4066
|
parameters?: UserIdentitiesUnmanagedListParameters,
|
|
@@ -4076,7 +4076,7 @@ export class SeamHttpEndpoints {
|
|
|
4076
4076
|
}
|
|
4077
4077
|
|
|
4078
4078
|
/**
|
|
4079
|
-
* Updates an unmanaged [user identity](https://
|
|
4079
|
+
* Updates an unmanaged [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.
|
|
4080
4080
|
*
|
|
4081
4081
|
* This endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.
|
|
4082
4082
|
*/
|
|
@@ -4094,7 +4094,7 @@ export class SeamHttpEndpoints {
|
|
|
4094
4094
|
}
|
|
4095
4095
|
|
|
4096
4096
|
/**
|
|
4097
|
-
* Creates a new [webhook](https://
|
|
4097
|
+
* Creates a new [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
4098
4098
|
*/
|
|
4099
4099
|
get '/webhooks/create'(): (
|
|
4100
4100
|
parameters: WebhooksCreateParameters,
|
|
@@ -4110,7 +4110,7 @@ export class SeamHttpEndpoints {
|
|
|
4110
4110
|
}
|
|
4111
4111
|
|
|
4112
4112
|
/**
|
|
4113
|
-
* Deletes a specified [webhook](https://
|
|
4113
|
+
* Deletes a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
4114
4114
|
*/
|
|
4115
4115
|
get '/webhooks/delete'(): (
|
|
4116
4116
|
parameters: WebhooksDeleteParameters,
|
|
@@ -4126,7 +4126,7 @@ export class SeamHttpEndpoints {
|
|
|
4126
4126
|
}
|
|
4127
4127
|
|
|
4128
4128
|
/**
|
|
4129
|
-
* Gets a specified [webhook](https://
|
|
4129
|
+
* Gets a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
4130
4130
|
*/
|
|
4131
4131
|
get '/webhooks/get'(): (
|
|
4132
4132
|
parameters: WebhooksGetParameters,
|
|
@@ -4142,7 +4142,7 @@ export class SeamHttpEndpoints {
|
|
|
4142
4142
|
}
|
|
4143
4143
|
|
|
4144
4144
|
/**
|
|
4145
|
-
* Returns a list of all [webhooks](https://
|
|
4145
|
+
* Returns a list of all [webhooks](https://www.seam.co/docs/developer-tools/webhooks).
|
|
4146
4146
|
*/
|
|
4147
4147
|
get '/webhooks/list'(): (
|
|
4148
4148
|
parameters?: WebhooksListParameters,
|
|
@@ -4158,7 +4158,7 @@ export class SeamHttpEndpoints {
|
|
|
4158
4158
|
}
|
|
4159
4159
|
|
|
4160
4160
|
/**
|
|
4161
|
-
* Updates a specified [webhook](https://
|
|
4161
|
+
* Updates a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
4162
4162
|
*/
|
|
4163
4163
|
get '/webhooks/update'(): (
|
|
4164
4164
|
parameters: WebhooksUpdateParameters,
|
|
@@ -4174,7 +4174,7 @@ export class SeamHttpEndpoints {
|
|
|
4174
4174
|
}
|
|
4175
4175
|
|
|
4176
4176
|
/**
|
|
4177
|
-
* Creates a new [workspace](https://
|
|
4177
|
+
* Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
4178
4178
|
*/
|
|
4179
4179
|
get '/workspaces/create'(): (
|
|
4180
4180
|
parameters: WorkspacesCreateParameters,
|
|
@@ -4190,7 +4190,7 @@ export class SeamHttpEndpoints {
|
|
|
4190
4190
|
}
|
|
4191
4191
|
|
|
4192
4192
|
/**
|
|
4193
|
-
* Returns the [workspace](https://
|
|
4193
|
+
* Returns the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
4194
4194
|
*/
|
|
4195
4195
|
get '/workspaces/get'(): (
|
|
4196
4196
|
parameters?: WorkspacesGetParameters,
|
|
@@ -4206,7 +4206,7 @@ export class SeamHttpEndpoints {
|
|
|
4206
4206
|
}
|
|
4207
4207
|
|
|
4208
4208
|
/**
|
|
4209
|
-
* Returns a list of [workspaces](https://
|
|
4209
|
+
* Returns a list of [workspaces](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
4210
4210
|
*/
|
|
4211
4211
|
get '/workspaces/list'(): (
|
|
4212
4212
|
parameters?: WorkspacesListParameters,
|
|
@@ -4222,7 +4222,7 @@ export class SeamHttpEndpoints {
|
|
|
4222
4222
|
}
|
|
4223
4223
|
|
|
4224
4224
|
/**
|
|
4225
|
-
* Resets the [sandbox workspace](https://
|
|
4225
|
+
* Resets the [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.
|
|
4226
4226
|
*/
|
|
4227
4227
|
get '/workspaces/reset_sandbox'(): (
|
|
4228
4228
|
parameters?: WorkspacesResetSandboxParameters,
|
|
@@ -4238,7 +4238,7 @@ export class SeamHttpEndpoints {
|
|
|
4238
4238
|
}
|
|
4239
4239
|
|
|
4240
4240
|
/**
|
|
4241
|
-
* Updates the [workspace](https://
|
|
4241
|
+
* Updates the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
4242
4242
|
*/
|
|
4243
4243
|
get '/workspaces/update'(): (
|
|
4244
4244
|
parameters?: WorkspacesUpdateParameters,
|