@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
|
@@ -122,7 +122,7 @@ export class SeamHttpEndpoints {
|
|
|
122
122
|
await clientSessions.get();
|
|
123
123
|
}
|
|
124
124
|
/**
|
|
125
|
-
* Creates a new [access code](https://
|
|
125
|
+
* 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.
|
|
126
126
|
*/
|
|
127
127
|
get '/access_codes/create'() {
|
|
128
128
|
const { client, defaults } = this;
|
|
@@ -132,7 +132,7 @@ export class SeamHttpEndpoints {
|
|
|
132
132
|
};
|
|
133
133
|
}
|
|
134
134
|
/**
|
|
135
|
-
* Creates new [access codes](https://
|
|
135
|
+
* Creates new [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
136
136
|
*
|
|
137
137
|
* 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.
|
|
138
138
|
*
|
|
@@ -140,9 +140,9 @@ export class SeamHttpEndpoints {
|
|
|
140
140
|
*
|
|
141
141
|
* 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`.
|
|
142
142
|
*
|
|
143
|
-
* See also [Creating and Updating Multiple Linked Access Codes](https://
|
|
143
|
+
* 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).
|
|
144
144
|
*
|
|
145
|
-
* For granting a person access to a space, [Access Grants](https://
|
|
145
|
+
* 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.
|
|
146
146
|
*/
|
|
147
147
|
get '/access_codes/create_multiple'() {
|
|
148
148
|
const { client, defaults } = this;
|
|
@@ -152,7 +152,7 @@ export class SeamHttpEndpoints {
|
|
|
152
152
|
};
|
|
153
153
|
}
|
|
154
154
|
/**
|
|
155
|
-
* Deletes an [access code](https://
|
|
155
|
+
* Deletes an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
156
156
|
*/
|
|
157
157
|
get '/access_codes/delete'() {
|
|
158
158
|
const { client, defaults } = this;
|
|
@@ -162,7 +162,7 @@ export class SeamHttpEndpoints {
|
|
|
162
162
|
};
|
|
163
163
|
}
|
|
164
164
|
/**
|
|
165
|
-
* Generates a code for an [access code](https://
|
|
165
|
+
* Generates a code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes), given a device ID.
|
|
166
166
|
*/
|
|
167
167
|
get '/access_codes/generate_code'() {
|
|
168
168
|
const { client, defaults } = this;
|
|
@@ -172,7 +172,7 @@ export class SeamHttpEndpoints {
|
|
|
172
172
|
};
|
|
173
173
|
}
|
|
174
174
|
/**
|
|
175
|
-
* Returns a specified [access code](https://
|
|
175
|
+
* Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
176
176
|
*
|
|
177
177
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
178
178
|
*/
|
|
@@ -184,7 +184,7 @@ export class SeamHttpEndpoints {
|
|
|
184
184
|
};
|
|
185
185
|
}
|
|
186
186
|
/**
|
|
187
|
-
* Returns a list of all [access codes](https://
|
|
187
|
+
* Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
188
188
|
*
|
|
189
189
|
* Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
|
|
190
190
|
*/
|
|
@@ -196,7 +196,7 @@ export class SeamHttpEndpoints {
|
|
|
196
196
|
};
|
|
197
197
|
}
|
|
198
198
|
/**
|
|
199
|
-
* Retrieves a backup access code for an [access code](https://
|
|
199
|
+
* 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).
|
|
200
200
|
*
|
|
201
201
|
* 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.
|
|
202
202
|
*
|
|
@@ -226,9 +226,9 @@ export class SeamHttpEndpoints {
|
|
|
226
226
|
};
|
|
227
227
|
}
|
|
228
228
|
/**
|
|
229
|
-
* Updates a specified active or upcoming [access code](https://
|
|
229
|
+
* Updates a specified active or upcoming [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
230
230
|
*
|
|
231
|
-
* See also [Modifying Access Codes](https://
|
|
231
|
+
* See also [Modifying Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes).
|
|
232
232
|
*/
|
|
233
233
|
get '/access_codes/update'() {
|
|
234
234
|
const { client, defaults } = this;
|
|
@@ -238,11 +238,11 @@ export class SeamHttpEndpoints {
|
|
|
238
238
|
};
|
|
239
239
|
}
|
|
240
240
|
/**
|
|
241
|
-
* Updates [access codes](https://
|
|
241
|
+
* Updates [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
242
242
|
*
|
|
243
243
|
* Specify the `common_code_key` to identify the set of access codes that you want to update.
|
|
244
244
|
*
|
|
245
|
-
* See also [Update Linked Access Codes](https://
|
|
245
|
+
* 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).
|
|
246
246
|
*/
|
|
247
247
|
get '/access_codes/update_multiple'() {
|
|
248
248
|
const { client, defaults } = this;
|
|
@@ -252,7 +252,7 @@ export class SeamHttpEndpoints {
|
|
|
252
252
|
};
|
|
253
253
|
}
|
|
254
254
|
/**
|
|
255
|
-
* Simulates the creation of an [unmanaged access code](https://
|
|
255
|
+
* 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).
|
|
256
256
|
*/
|
|
257
257
|
get '/access_codes/simulate/create_unmanaged_access_code'() {
|
|
258
258
|
const { client, defaults } = this;
|
|
@@ -262,7 +262,7 @@ export class SeamHttpEndpoints {
|
|
|
262
262
|
};
|
|
263
263
|
}
|
|
264
264
|
/**
|
|
265
|
-
* Converts an [unmanaged access code](https://
|
|
265
|
+
* 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).
|
|
266
266
|
*
|
|
267
267
|
* 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.
|
|
268
268
|
*
|
|
@@ -276,7 +276,7 @@ export class SeamHttpEndpoints {
|
|
|
276
276
|
};
|
|
277
277
|
}
|
|
278
278
|
/**
|
|
279
|
-
* Deletes an [unmanaged access code](https://
|
|
279
|
+
* Deletes an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
280
280
|
*/
|
|
281
281
|
get '/access_codes/unmanaged/delete'() {
|
|
282
282
|
const { client, defaults } = this;
|
|
@@ -286,7 +286,7 @@ export class SeamHttpEndpoints {
|
|
|
286
286
|
};
|
|
287
287
|
}
|
|
288
288
|
/**
|
|
289
|
-
* Returns a specified [unmanaged access code](https://
|
|
289
|
+
* Returns a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
290
290
|
*
|
|
291
291
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
292
292
|
*/
|
|
@@ -298,7 +298,7 @@ export class SeamHttpEndpoints {
|
|
|
298
298
|
};
|
|
299
299
|
}
|
|
300
300
|
/**
|
|
301
|
-
* Returns a list of all [unmanaged access codes](https://
|
|
301
|
+
* Returns a list of all [unmanaged access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
302
302
|
*/
|
|
303
303
|
get '/access_codes/unmanaged/list'() {
|
|
304
304
|
const { client, defaults } = this;
|
|
@@ -308,7 +308,7 @@ export class SeamHttpEndpoints {
|
|
|
308
308
|
};
|
|
309
309
|
}
|
|
310
310
|
/**
|
|
311
|
-
* Updates a specified [unmanaged access code](https://
|
|
311
|
+
* Updates a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
312
312
|
*/
|
|
313
313
|
get '/access_codes/unmanaged/update'() {
|
|
314
314
|
const { client, defaults } = this;
|
|
@@ -318,7 +318,7 @@ export class SeamHttpEndpoints {
|
|
|
318
318
|
};
|
|
319
319
|
}
|
|
320
320
|
/**
|
|
321
|
-
* Creates a new [Access Grant](https://
|
|
321
|
+
* 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.
|
|
322
322
|
*/
|
|
323
323
|
get '/access_grants/create'() {
|
|
324
324
|
const { client, defaults } = this;
|
|
@@ -442,7 +442,7 @@ export class SeamHttpEndpoints {
|
|
|
442
442
|
};
|
|
443
443
|
}
|
|
444
444
|
/**
|
|
445
|
-
* Encodes an existing access method onto a plastic card placed on the specified [encoder](https://
|
|
445
|
+
* 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).
|
|
446
446
|
*/
|
|
447
447
|
get '/access_methods/encode'() {
|
|
448
448
|
const { client, defaults } = this;
|
|
@@ -482,7 +482,7 @@ export class SeamHttpEndpoints {
|
|
|
482
482
|
};
|
|
483
483
|
}
|
|
484
484
|
/**
|
|
485
|
-
* Remotely unlocks a specified [entrance](https://
|
|
485
|
+
* 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.
|
|
486
486
|
*/
|
|
487
487
|
get '/access_methods/unlock_door'() {
|
|
488
488
|
const { client, defaults } = this;
|
|
@@ -512,7 +512,7 @@ export class SeamHttpEndpoints {
|
|
|
512
512
|
};
|
|
513
513
|
}
|
|
514
514
|
/**
|
|
515
|
-
* Adds a specified [access system user](https://
|
|
515
|
+
* 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).
|
|
516
516
|
*/
|
|
517
517
|
get '/acs/access_groups/add_user'() {
|
|
518
518
|
const { client, defaults } = this;
|
|
@@ -522,7 +522,7 @@ export class SeamHttpEndpoints {
|
|
|
522
522
|
};
|
|
523
523
|
}
|
|
524
524
|
/**
|
|
525
|
-
* Deletes a specified [access group](https://
|
|
525
|
+
* Deletes a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
526
526
|
*/
|
|
527
527
|
get '/acs/access_groups/delete'() {
|
|
528
528
|
const { client, defaults } = this;
|
|
@@ -532,7 +532,7 @@ export class SeamHttpEndpoints {
|
|
|
532
532
|
};
|
|
533
533
|
}
|
|
534
534
|
/**
|
|
535
|
-
* Returns a specified [access group](https://
|
|
535
|
+
* Returns a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
536
536
|
*/
|
|
537
537
|
get '/acs/access_groups/get'() {
|
|
538
538
|
const { client, defaults } = this;
|
|
@@ -542,7 +542,7 @@ export class SeamHttpEndpoints {
|
|
|
542
542
|
};
|
|
543
543
|
}
|
|
544
544
|
/**
|
|
545
|
-
* Returns a list of all [access groups](https://
|
|
545
|
+
* Returns a list of all [access groups](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
546
546
|
*/
|
|
547
547
|
get '/acs/access_groups/list'() {
|
|
548
548
|
const { client, defaults } = this;
|
|
@@ -552,7 +552,7 @@ export class SeamHttpEndpoints {
|
|
|
552
552
|
};
|
|
553
553
|
}
|
|
554
554
|
/**
|
|
555
|
-
* Returns a list of all accessible entrances for a specified [access group](https://
|
|
555
|
+
* 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).
|
|
556
556
|
*/
|
|
557
557
|
get '/acs/access_groups/list_accessible_entrances'() {
|
|
558
558
|
const { client, defaults } = this;
|
|
@@ -562,7 +562,7 @@ export class SeamHttpEndpoints {
|
|
|
562
562
|
};
|
|
563
563
|
}
|
|
564
564
|
/**
|
|
565
|
-
* Returns a list of all [access system users](https://
|
|
565
|
+
* 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).
|
|
566
566
|
*/
|
|
567
567
|
get '/acs/access_groups/list_users'() {
|
|
568
568
|
const { client, defaults } = this;
|
|
@@ -572,7 +572,7 @@ export class SeamHttpEndpoints {
|
|
|
572
572
|
};
|
|
573
573
|
}
|
|
574
574
|
/**
|
|
575
|
-
* Removes a specified [access system user](https://
|
|
575
|
+
* 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).
|
|
576
576
|
*/
|
|
577
577
|
get '/acs/access_groups/remove_user'() {
|
|
578
578
|
const { client, defaults } = this;
|
|
@@ -582,7 +582,7 @@ export class SeamHttpEndpoints {
|
|
|
582
582
|
};
|
|
583
583
|
}
|
|
584
584
|
/**
|
|
585
|
-
* Assigns a specified [credential](https://
|
|
585
|
+
* 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).
|
|
586
586
|
*/
|
|
587
587
|
get '/acs/credentials/assign'() {
|
|
588
588
|
const { client, defaults } = this;
|
|
@@ -592,7 +592,7 @@ export class SeamHttpEndpoints {
|
|
|
592
592
|
};
|
|
593
593
|
}
|
|
594
594
|
/**
|
|
595
|
-
* Creates a new [credential](https://
|
|
595
|
+
* 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.
|
|
596
596
|
*/
|
|
597
597
|
get '/acs/credentials/create'() {
|
|
598
598
|
const { client, defaults } = this;
|
|
@@ -602,7 +602,7 @@ export class SeamHttpEndpoints {
|
|
|
602
602
|
};
|
|
603
603
|
}
|
|
604
604
|
/**
|
|
605
|
-
* Deletes a specified [credential](https://
|
|
605
|
+
* Deletes a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
606
606
|
*/
|
|
607
607
|
get '/acs/credentials/delete'() {
|
|
608
608
|
const { client, defaults } = this;
|
|
@@ -612,7 +612,7 @@ export class SeamHttpEndpoints {
|
|
|
612
612
|
};
|
|
613
613
|
}
|
|
614
614
|
/**
|
|
615
|
-
* Returns a specified [credential](https://
|
|
615
|
+
* Returns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
616
616
|
*/
|
|
617
617
|
get '/acs/credentials/get'() {
|
|
618
618
|
const { client, defaults } = this;
|
|
@@ -622,7 +622,7 @@ export class SeamHttpEndpoints {
|
|
|
622
622
|
};
|
|
623
623
|
}
|
|
624
624
|
/**
|
|
625
|
-
* Returns a list of all [credentials](https://
|
|
625
|
+
* Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
626
626
|
*/
|
|
627
627
|
get '/acs/credentials/list'() {
|
|
628
628
|
const { client, defaults } = this;
|
|
@@ -632,7 +632,7 @@ export class SeamHttpEndpoints {
|
|
|
632
632
|
};
|
|
633
633
|
}
|
|
634
634
|
/**
|
|
635
|
-
* Returns a list of all [entrances](https://
|
|
635
|
+
* 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.
|
|
636
636
|
*/
|
|
637
637
|
get '/acs/credentials/list_accessible_entrances'() {
|
|
638
638
|
const { client, defaults } = this;
|
|
@@ -642,7 +642,7 @@ export class SeamHttpEndpoints {
|
|
|
642
642
|
};
|
|
643
643
|
}
|
|
644
644
|
/**
|
|
645
|
-
* Unassigns a specified [credential](https://
|
|
645
|
+
* 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).
|
|
646
646
|
*/
|
|
647
647
|
get '/acs/credentials/unassign'() {
|
|
648
648
|
const { client, defaults } = this;
|
|
@@ -652,7 +652,7 @@ export class SeamHttpEndpoints {
|
|
|
652
652
|
};
|
|
653
653
|
}
|
|
654
654
|
/**
|
|
655
|
-
* Updates the code and ends at date and time for a specified [credential](https://
|
|
655
|
+
* 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).
|
|
656
656
|
*/
|
|
657
657
|
get '/acs/credentials/update'() {
|
|
658
658
|
const { client, defaults } = this;
|
|
@@ -662,7 +662,7 @@ export class SeamHttpEndpoints {
|
|
|
662
662
|
};
|
|
663
663
|
}
|
|
664
664
|
/**
|
|
665
|
-
* Encodes an existing [credential](https://
|
|
665
|
+
* 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`
|
|
666
666
|
*/
|
|
667
667
|
get '/acs/encoders/encode_credential'() {
|
|
668
668
|
const { client, defaults } = this;
|
|
@@ -672,7 +672,7 @@ export class SeamHttpEndpoints {
|
|
|
672
672
|
};
|
|
673
673
|
}
|
|
674
674
|
/**
|
|
675
|
-
* Returns a specified [encoder](https://
|
|
675
|
+
* Returns a specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
676
676
|
*/
|
|
677
677
|
get '/acs/encoders/get'() {
|
|
678
678
|
const { client, defaults } = this;
|
|
@@ -682,7 +682,7 @@ export class SeamHttpEndpoints {
|
|
|
682
682
|
};
|
|
683
683
|
}
|
|
684
684
|
/**
|
|
685
|
-
* Returns a list of all [encoders](https://
|
|
685
|
+
* Returns a list of all [encoders](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
686
686
|
*/
|
|
687
687
|
get '/acs/encoders/list'() {
|
|
688
688
|
const { client, defaults } = this;
|
|
@@ -692,7 +692,7 @@ export class SeamHttpEndpoints {
|
|
|
692
692
|
};
|
|
693
693
|
}
|
|
694
694
|
/**
|
|
695
|
-
* Scans an encoded [acs_credential](https://
|
|
695
|
+
* 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).
|
|
696
696
|
*/
|
|
697
697
|
get '/acs/encoders/scan_credential'() {
|
|
698
698
|
const { client, defaults } = this;
|
|
@@ -702,7 +702,7 @@ export class SeamHttpEndpoints {
|
|
|
702
702
|
};
|
|
703
703
|
}
|
|
704
704
|
/**
|
|
705
|
-
* Scans a physical card placed on the specified [encoder](https://
|
|
705
|
+
* 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`.
|
|
706
706
|
*/
|
|
707
707
|
get '/acs/encoders/scan_to_assign_credential'() {
|
|
708
708
|
const { client, defaults } = this;
|
|
@@ -712,7 +712,7 @@ export class SeamHttpEndpoints {
|
|
|
712
712
|
};
|
|
713
713
|
}
|
|
714
714
|
/**
|
|
715
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
715
|
+
* 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).
|
|
716
716
|
*/
|
|
717
717
|
get '/acs/encoders/simulate/next_credential_encode_will_fail'() {
|
|
718
718
|
const { client, defaults } = this;
|
|
@@ -722,7 +722,7 @@ export class SeamHttpEndpoints {
|
|
|
722
722
|
};
|
|
723
723
|
}
|
|
724
724
|
/**
|
|
725
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
725
|
+
* 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).
|
|
726
726
|
*/
|
|
727
727
|
get '/acs/encoders/simulate/next_credential_encode_will_succeed'() {
|
|
728
728
|
const { client, defaults } = this;
|
|
@@ -732,7 +732,7 @@ export class SeamHttpEndpoints {
|
|
|
732
732
|
};
|
|
733
733
|
}
|
|
734
734
|
/**
|
|
735
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
735
|
+
* 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).
|
|
736
736
|
*/
|
|
737
737
|
get '/acs/encoders/simulate/next_credential_scan_will_fail'() {
|
|
738
738
|
const { client, defaults } = this;
|
|
@@ -742,7 +742,7 @@ export class SeamHttpEndpoints {
|
|
|
742
742
|
};
|
|
743
743
|
}
|
|
744
744
|
/**
|
|
745
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
745
|
+
* 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).
|
|
746
746
|
*/
|
|
747
747
|
get '/acs/encoders/simulate/next_credential_scan_will_succeed'() {
|
|
748
748
|
const { client, defaults } = this;
|
|
@@ -752,7 +752,7 @@ export class SeamHttpEndpoints {
|
|
|
752
752
|
};
|
|
753
753
|
}
|
|
754
754
|
/**
|
|
755
|
-
* Returns a specified [access system entrance](https://
|
|
755
|
+
* Returns a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
756
756
|
*/
|
|
757
757
|
get '/acs/entrances/get'() {
|
|
758
758
|
const { client, defaults } = this;
|
|
@@ -762,7 +762,7 @@ export class SeamHttpEndpoints {
|
|
|
762
762
|
};
|
|
763
763
|
}
|
|
764
764
|
/**
|
|
765
|
-
* Grants a specified [access system user](https://
|
|
765
|
+
* 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).
|
|
766
766
|
*/
|
|
767
767
|
get '/acs/entrances/grant_access'() {
|
|
768
768
|
const { client, defaults } = this;
|
|
@@ -772,7 +772,7 @@ export class SeamHttpEndpoints {
|
|
|
772
772
|
};
|
|
773
773
|
}
|
|
774
774
|
/**
|
|
775
|
-
* Returns a list of all [access system entrances](https://
|
|
775
|
+
* Returns a list of all [access system entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
776
776
|
*/
|
|
777
777
|
get '/acs/entrances/list'() {
|
|
778
778
|
const { client, defaults } = this;
|
|
@@ -782,7 +782,7 @@ export class SeamHttpEndpoints {
|
|
|
782
782
|
};
|
|
783
783
|
}
|
|
784
784
|
/**
|
|
785
|
-
* Returns a list of all [credentials](https://
|
|
785
|
+
* 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).
|
|
786
786
|
*/
|
|
787
787
|
get '/acs/entrances/list_credentials_with_access'() {
|
|
788
788
|
const { client, defaults } = this;
|
|
@@ -792,7 +792,7 @@ export class SeamHttpEndpoints {
|
|
|
792
792
|
};
|
|
793
793
|
}
|
|
794
794
|
/**
|
|
795
|
-
* Remotely unlocks a specified [entrance](https://
|
|
795
|
+
* 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.
|
|
796
796
|
*/
|
|
797
797
|
get '/acs/entrances/unlock'() {
|
|
798
798
|
const { client, defaults } = this;
|
|
@@ -802,7 +802,7 @@ export class SeamHttpEndpoints {
|
|
|
802
802
|
};
|
|
803
803
|
}
|
|
804
804
|
/**
|
|
805
|
-
* Returns a specified [access system](https://
|
|
805
|
+
* Returns a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
806
806
|
*/
|
|
807
807
|
get '/acs/systems/get'() {
|
|
808
808
|
const { client, defaults } = this;
|
|
@@ -812,7 +812,7 @@ export class SeamHttpEndpoints {
|
|
|
812
812
|
};
|
|
813
813
|
}
|
|
814
814
|
/**
|
|
815
|
-
* Returns a list of all [access systems](https://
|
|
815
|
+
* Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
816
816
|
*
|
|
817
817
|
* 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.
|
|
818
818
|
*/
|
|
@@ -824,7 +824,7 @@ export class SeamHttpEndpoints {
|
|
|
824
824
|
};
|
|
825
825
|
}
|
|
826
826
|
/**
|
|
827
|
-
* Returns a list of all credential manager systems that are compatible with a specified [access system](https://
|
|
827
|
+
* 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).
|
|
828
828
|
*
|
|
829
829
|
* 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.
|
|
830
830
|
*/
|
|
@@ -846,7 +846,7 @@ export class SeamHttpEndpoints {
|
|
|
846
846
|
};
|
|
847
847
|
}
|
|
848
848
|
/**
|
|
849
|
-
* Adds a specified [access system user](https://
|
|
849
|
+
* 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).
|
|
850
850
|
*/
|
|
851
851
|
get '/acs/users/add_to_access_group'() {
|
|
852
852
|
const { client, defaults } = this;
|
|
@@ -856,7 +856,7 @@ export class SeamHttpEndpoints {
|
|
|
856
856
|
};
|
|
857
857
|
}
|
|
858
858
|
/**
|
|
859
|
-
* Creates a new [access system user](https://
|
|
859
|
+
* Creates a new [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
860
860
|
*/
|
|
861
861
|
get '/acs/users/create'() {
|
|
862
862
|
const { client, defaults } = this;
|
|
@@ -866,7 +866,7 @@ export class SeamHttpEndpoints {
|
|
|
866
866
|
};
|
|
867
867
|
}
|
|
868
868
|
/**
|
|
869
|
-
* Deletes a specified [access system user](https://
|
|
869
|
+
* 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).
|
|
870
870
|
*/
|
|
871
871
|
get '/acs/users/delete'() {
|
|
872
872
|
const { client, defaults } = this;
|
|
@@ -876,7 +876,7 @@ export class SeamHttpEndpoints {
|
|
|
876
876
|
};
|
|
877
877
|
}
|
|
878
878
|
/**
|
|
879
|
-
* Returns a specified [access system user](https://
|
|
879
|
+
* Returns a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
880
880
|
*/
|
|
881
881
|
get '/acs/users/get'() {
|
|
882
882
|
const { client, defaults } = this;
|
|
@@ -886,7 +886,7 @@ export class SeamHttpEndpoints {
|
|
|
886
886
|
};
|
|
887
887
|
}
|
|
888
888
|
/**
|
|
889
|
-
* Returns a list of all [access system users](https://
|
|
889
|
+
* Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
890
890
|
*/
|
|
891
891
|
get '/acs/users/list'() {
|
|
892
892
|
const { client, defaults } = this;
|
|
@@ -896,7 +896,7 @@ export class SeamHttpEndpoints {
|
|
|
896
896
|
};
|
|
897
897
|
}
|
|
898
898
|
/**
|
|
899
|
-
* Lists the [entrances](https://
|
|
899
|
+
* 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.
|
|
900
900
|
*/
|
|
901
901
|
get '/acs/users/list_accessible_entrances'() {
|
|
902
902
|
const { client, defaults } = this;
|
|
@@ -906,7 +906,7 @@ export class SeamHttpEndpoints {
|
|
|
906
906
|
};
|
|
907
907
|
}
|
|
908
908
|
/**
|
|
909
|
-
* Removes a specified [access system user](https://
|
|
909
|
+
* 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).
|
|
910
910
|
*/
|
|
911
911
|
get '/acs/users/remove_from_access_group'() {
|
|
912
912
|
const { client, defaults } = this;
|
|
@@ -916,7 +916,7 @@ export class SeamHttpEndpoints {
|
|
|
916
916
|
};
|
|
917
917
|
}
|
|
918
918
|
/**
|
|
919
|
-
* Revokes access to all [entrances](https://
|
|
919
|
+
* 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).
|
|
920
920
|
*/
|
|
921
921
|
get '/acs/users/revoke_access_to_all_entrances'() {
|
|
922
922
|
const { client, defaults } = this;
|
|
@@ -926,7 +926,7 @@ export class SeamHttpEndpoints {
|
|
|
926
926
|
};
|
|
927
927
|
}
|
|
928
928
|
/**
|
|
929
|
-
* [Suspends](https://
|
|
929
|
+
* [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.
|
|
930
930
|
*/
|
|
931
931
|
get '/acs/users/suspend'() {
|
|
932
932
|
const { client, defaults } = this;
|
|
@@ -936,7 +936,7 @@ export class SeamHttpEndpoints {
|
|
|
936
936
|
};
|
|
937
937
|
}
|
|
938
938
|
/**
|
|
939
|
-
* [Unsuspends](https://
|
|
939
|
+
* [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.
|
|
940
940
|
*/
|
|
941
941
|
get '/acs/users/unsuspend'() {
|
|
942
942
|
const { client, defaults } = this;
|
|
@@ -946,7 +946,7 @@ export class SeamHttpEndpoints {
|
|
|
946
946
|
};
|
|
947
947
|
}
|
|
948
948
|
/**
|
|
949
|
-
* Updates the properties of a specified [access system user](https://
|
|
949
|
+
* Updates the properties of a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
950
950
|
*/
|
|
951
951
|
get '/acs/users/update'() {
|
|
952
952
|
const { client, defaults } = this;
|
|
@@ -956,7 +956,7 @@ export class SeamHttpEndpoints {
|
|
|
956
956
|
};
|
|
957
957
|
}
|
|
958
958
|
/**
|
|
959
|
-
* Returns a specified [action attempt](https://
|
|
959
|
+
* Returns a specified [action attempt](https://www.seam.co/docs/core-concepts/action-attempts).
|
|
960
960
|
*/
|
|
961
961
|
get '/action_attempts/get'() {
|
|
962
962
|
const { client, defaults } = this;
|
|
@@ -966,7 +966,7 @@ export class SeamHttpEndpoints {
|
|
|
966
966
|
};
|
|
967
967
|
}
|
|
968
968
|
/**
|
|
969
|
-
* Returns a list of the [action attempts](https://
|
|
969
|
+
* 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.
|
|
970
970
|
*/
|
|
971
971
|
get '/action_attempts/list'() {
|
|
972
972
|
const { client, defaults } = this;
|
|
@@ -976,7 +976,7 @@ export class SeamHttpEndpoints {
|
|
|
976
976
|
};
|
|
977
977
|
}
|
|
978
978
|
/**
|
|
979
|
-
* Creates a new [client session](https://
|
|
979
|
+
* Creates a new [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
980
980
|
*/
|
|
981
981
|
get '/client_sessions/create'() {
|
|
982
982
|
const { client, defaults } = this;
|
|
@@ -986,7 +986,7 @@ export class SeamHttpEndpoints {
|
|
|
986
986
|
};
|
|
987
987
|
}
|
|
988
988
|
/**
|
|
989
|
-
* Deletes a [client session](https://
|
|
989
|
+
* Deletes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
990
990
|
*/
|
|
991
991
|
get '/client_sessions/delete'() {
|
|
992
992
|
const { client, defaults } = this;
|
|
@@ -996,7 +996,7 @@ export class SeamHttpEndpoints {
|
|
|
996
996
|
};
|
|
997
997
|
}
|
|
998
998
|
/**
|
|
999
|
-
* Returns a specified [client session](https://
|
|
999
|
+
* Returns a specified [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
1000
1000
|
*/
|
|
1001
1001
|
get '/client_sessions/get'() {
|
|
1002
1002
|
const { client, defaults } = this;
|
|
@@ -1006,7 +1006,7 @@ export class SeamHttpEndpoints {
|
|
|
1006
1006
|
};
|
|
1007
1007
|
}
|
|
1008
1008
|
/**
|
|
1009
|
-
* Returns a [client session](https://
|
|
1009
|
+
* 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.
|
|
1010
1010
|
*/
|
|
1011
1011
|
get '/client_sessions/get_or_create'() {
|
|
1012
1012
|
const { client, defaults } = this;
|
|
@@ -1016,7 +1016,7 @@ export class SeamHttpEndpoints {
|
|
|
1016
1016
|
};
|
|
1017
1017
|
}
|
|
1018
1018
|
/**
|
|
1019
|
-
* Grants a [client session](https://
|
|
1019
|
+
* 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.
|
|
1020
1020
|
*/
|
|
1021
1021
|
get '/client_sessions/grant_access'() {
|
|
1022
1022
|
const { client, defaults } = this;
|
|
@@ -1026,7 +1026,7 @@ export class SeamHttpEndpoints {
|
|
|
1026
1026
|
};
|
|
1027
1027
|
}
|
|
1028
1028
|
/**
|
|
1029
|
-
* Returns a list of all [client sessions](https://
|
|
1029
|
+
* Returns a list of all [client sessions](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
1030
1030
|
*/
|
|
1031
1031
|
get '/client_sessions/list'() {
|
|
1032
1032
|
const { client, defaults } = this;
|
|
@@ -1036,9 +1036,9 @@ export class SeamHttpEndpoints {
|
|
|
1036
1036
|
};
|
|
1037
1037
|
}
|
|
1038
1038
|
/**
|
|
1039
|
-
* Revokes a [client session](https://
|
|
1039
|
+
* Revokes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
1040
1040
|
*
|
|
1041
|
-
* Note that [deleting a client session](https://
|
|
1041
|
+
* Note that [deleting a client session](https://www.seam.co/docs/api/client_sessions/delete) is a separate action.
|
|
1042
1042
|
*/
|
|
1043
1043
|
get '/client_sessions/revoke'() {
|
|
1044
1044
|
const { client, defaults } = this;
|
|
@@ -1048,13 +1048,13 @@ export class SeamHttpEndpoints {
|
|
|
1048
1048
|
};
|
|
1049
1049
|
}
|
|
1050
1050
|
/**
|
|
1051
|
-
* Creates a new [Connect Webview](https://
|
|
1051
|
+
* Creates a new [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
1052
1052
|
*
|
|
1053
1053
|
* 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.
|
|
1054
1054
|
*
|
|
1055
1055
|
* 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.
|
|
1056
1056
|
*
|
|
1057
|
-
* See also: [Connect Webview Process](https://
|
|
1057
|
+
* See also: [Connect Webview Process](https://www.seam.co/docs/core-concepts/connect-webviews/connect-webview-process).
|
|
1058
1058
|
*/
|
|
1059
1059
|
get '/connect_webviews/create'() {
|
|
1060
1060
|
const { client, defaults } = this;
|
|
@@ -1064,7 +1064,7 @@ export class SeamHttpEndpoints {
|
|
|
1064
1064
|
};
|
|
1065
1065
|
}
|
|
1066
1066
|
/**
|
|
1067
|
-
* Deletes a [Connect Webview](https://
|
|
1067
|
+
* Deletes a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
1068
1068
|
*
|
|
1069
1069
|
* You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.
|
|
1070
1070
|
*/
|
|
@@ -1076,7 +1076,7 @@ export class SeamHttpEndpoints {
|
|
|
1076
1076
|
};
|
|
1077
1077
|
}
|
|
1078
1078
|
/**
|
|
1079
|
-
* Returns a specified [Connect Webview](https://
|
|
1079
|
+
* Returns a specified [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
1080
1080
|
*
|
|
1081
1081
|
* 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.
|
|
1082
1082
|
*/
|
|
@@ -1088,7 +1088,7 @@ export class SeamHttpEndpoints {
|
|
|
1088
1088
|
};
|
|
1089
1089
|
}
|
|
1090
1090
|
/**
|
|
1091
|
-
* Returns a list of all [Connect Webviews](https://
|
|
1091
|
+
* Returns a list of all [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
1092
1092
|
*/
|
|
1093
1093
|
get '/connect_webviews/list'() {
|
|
1094
1094
|
const { client, defaults } = this;
|
|
@@ -1098,7 +1098,7 @@ export class SeamHttpEndpoints {
|
|
|
1098
1098
|
};
|
|
1099
1099
|
}
|
|
1100
1100
|
/**
|
|
1101
|
-
* Deletes a specified [connected account](https://
|
|
1101
|
+
* Deletes a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
1102
1102
|
*
|
|
1103
1103
|
* 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.
|
|
1104
1104
|
*
|
|
@@ -1112,7 +1112,7 @@ export class SeamHttpEndpoints {
|
|
|
1112
1112
|
};
|
|
1113
1113
|
}
|
|
1114
1114
|
/**
|
|
1115
|
-
* Returns a specified [connected account](https://
|
|
1115
|
+
* Returns a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
1116
1116
|
*/
|
|
1117
1117
|
get '/connected_accounts/get'() {
|
|
1118
1118
|
const { client, defaults } = this;
|
|
@@ -1122,7 +1122,7 @@ export class SeamHttpEndpoints {
|
|
|
1122
1122
|
};
|
|
1123
1123
|
}
|
|
1124
1124
|
/**
|
|
1125
|
-
* Returns a list of all [connected accounts](https://
|
|
1125
|
+
* Returns a list of all [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
1126
1126
|
*/
|
|
1127
1127
|
get '/connected_accounts/list'() {
|
|
1128
1128
|
const { client, defaults } = this;
|
|
@@ -1132,7 +1132,7 @@ export class SeamHttpEndpoints {
|
|
|
1132
1132
|
};
|
|
1133
1133
|
}
|
|
1134
1134
|
/**
|
|
1135
|
-
* Request a [connected account](https://
|
|
1135
|
+
* Request a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.
|
|
1136
1136
|
*/
|
|
1137
1137
|
get '/connected_accounts/sync'() {
|
|
1138
1138
|
const { client, defaults } = this;
|
|
@@ -1142,7 +1142,7 @@ export class SeamHttpEndpoints {
|
|
|
1142
1142
|
};
|
|
1143
1143
|
}
|
|
1144
1144
|
/**
|
|
1145
|
-
* Updates a [connected account](https://
|
|
1145
|
+
* Updates a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
1146
1146
|
*/
|
|
1147
1147
|
get '/connected_accounts/update'() {
|
|
1148
1148
|
const { client, defaults } = this;
|
|
@@ -1152,7 +1152,7 @@ export class SeamHttpEndpoints {
|
|
|
1152
1152
|
};
|
|
1153
1153
|
}
|
|
1154
1154
|
/**
|
|
1155
|
-
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://
|
|
1155
|
+
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
1156
1156
|
*/
|
|
1157
1157
|
get '/connected_accounts/simulate/disconnect'() {
|
|
1158
1158
|
const { client, defaults } = this;
|
|
@@ -1193,7 +1193,7 @@ export class SeamHttpEndpoints {
|
|
|
1193
1193
|
};
|
|
1194
1194
|
}
|
|
1195
1195
|
/**
|
|
1196
|
-
* Returns a specified [device](https://
|
|
1196
|
+
* Returns a specified [device](https://www.seam.co/docs/core-concepts/devices).
|
|
1197
1197
|
*
|
|
1198
1198
|
* You must specify either `device_id` or `name`.
|
|
1199
1199
|
*/
|
|
@@ -1205,7 +1205,7 @@ export class SeamHttpEndpoints {
|
|
|
1205
1205
|
};
|
|
1206
1206
|
}
|
|
1207
1207
|
/**
|
|
1208
|
-
* Returns a list of all [devices](https://
|
|
1208
|
+
* Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices).
|
|
1209
1209
|
*/
|
|
1210
1210
|
get '/devices/list'() {
|
|
1211
1211
|
const { client, defaults } = this;
|
|
@@ -1217,9 +1217,9 @@ export class SeamHttpEndpoints {
|
|
|
1217
1217
|
/**
|
|
1218
1218
|
* Returns a list of all device providers.
|
|
1219
1219
|
*
|
|
1220
|
-
* The information that this endpoint returns for each provider includes a set of [capability flags](https://
|
|
1220
|
+
* 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`.
|
|
1221
1221
|
*
|
|
1222
|
-
* When you create a [Connect Webview](https://
|
|
1222
|
+
* 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).
|
|
1223
1223
|
*/
|
|
1224
1224
|
get '/devices/list_device_providers'() {
|
|
1225
1225
|
const { client, defaults } = this;
|
|
@@ -1239,9 +1239,9 @@ export class SeamHttpEndpoints {
|
|
|
1239
1239
|
};
|
|
1240
1240
|
}
|
|
1241
1241
|
/**
|
|
1242
|
-
* Updates a specified [device](https://
|
|
1242
|
+
* Updates a specified [device](https://www.seam.co/docs/core-concepts/devices).
|
|
1243
1243
|
*
|
|
1244
|
-
* You can add or change [custom metadata](https://
|
|
1244
|
+
* 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).
|
|
1245
1245
|
*/
|
|
1246
1246
|
get '/devices/update'() {
|
|
1247
1247
|
const { client, defaults } = this;
|
|
@@ -1251,7 +1251,7 @@ export class SeamHttpEndpoints {
|
|
|
1251
1251
|
};
|
|
1252
1252
|
}
|
|
1253
1253
|
/**
|
|
1254
|
-
* Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://
|
|
1254
|
+
* 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).
|
|
1255
1255
|
*/
|
|
1256
1256
|
get '/devices/simulate/connect'() {
|
|
1257
1257
|
const { client, defaults } = this;
|
|
@@ -1274,7 +1274,7 @@ export class SeamHttpEndpoints {
|
|
|
1274
1274
|
};
|
|
1275
1275
|
}
|
|
1276
1276
|
/**
|
|
1277
|
-
* Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://
|
|
1277
|
+
* 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).
|
|
1278
1278
|
*/
|
|
1279
1279
|
get '/devices/simulate/disconnect'() {
|
|
1280
1280
|
const { client, defaults } = this;
|
|
@@ -1310,7 +1310,7 @@ export class SeamHttpEndpoints {
|
|
|
1310
1310
|
};
|
|
1311
1311
|
}
|
|
1312
1312
|
/**
|
|
1313
|
-
* Simulates removing a device from Seam. Only applicable for [sandbox devices](https://
|
|
1313
|
+
* 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).
|
|
1314
1314
|
*/
|
|
1315
1315
|
get '/devices/simulate/remove'() {
|
|
1316
1316
|
const { client, defaults } = this;
|
|
@@ -1320,9 +1320,9 @@ export class SeamHttpEndpoints {
|
|
|
1320
1320
|
};
|
|
1321
1321
|
}
|
|
1322
1322
|
/**
|
|
1323
|
-
* Returns a specified [unmanaged device](https://
|
|
1323
|
+
* Returns a specified [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
1324
1324
|
*
|
|
1325
|
-
* 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://
|
|
1325
|
+
* 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).
|
|
1326
1326
|
*
|
|
1327
1327
|
* You must specify either `device_id` or `name`.
|
|
1328
1328
|
*/
|
|
@@ -1334,9 +1334,9 @@ export class SeamHttpEndpoints {
|
|
|
1334
1334
|
};
|
|
1335
1335
|
}
|
|
1336
1336
|
/**
|
|
1337
|
-
* Returns a list of all [unmanaged devices](https://
|
|
1337
|
+
* Returns a list of all [unmanaged devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
1338
1338
|
*
|
|
1339
|
-
* 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://
|
|
1339
|
+
* 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).
|
|
1340
1340
|
*/
|
|
1341
1341
|
get '/devices/unmanaged/list'() {
|
|
1342
1342
|
const { client, defaults } = this;
|
|
@@ -1346,9 +1346,9 @@ export class SeamHttpEndpoints {
|
|
|
1346
1346
|
};
|
|
1347
1347
|
}
|
|
1348
1348
|
/**
|
|
1349
|
-
* Updates a specified [unmanaged device](https://
|
|
1349
|
+
* 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`.
|
|
1350
1350
|
*
|
|
1351
|
-
* 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://
|
|
1351
|
+
* 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).
|
|
1352
1352
|
*/
|
|
1353
1353
|
get '/devices/unmanaged/update'() {
|
|
1354
1354
|
const { client, defaults } = this;
|
|
@@ -1358,7 +1358,7 @@ export class SeamHttpEndpoints {
|
|
|
1358
1358
|
};
|
|
1359
1359
|
}
|
|
1360
1360
|
/**
|
|
1361
|
-
* Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://
|
|
1361
|
+
* 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.
|
|
1362
1362
|
*/
|
|
1363
1363
|
get '/events/get'() {
|
|
1364
1364
|
const { client, defaults } = this;
|
|
@@ -1368,7 +1368,7 @@ export class SeamHttpEndpoints {
|
|
|
1368
1368
|
};
|
|
1369
1369
|
}
|
|
1370
1370
|
/**
|
|
1371
|
-
* Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://
|
|
1371
|
+
* 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.
|
|
1372
1372
|
*/
|
|
1373
1373
|
get '/events/list'() {
|
|
1374
1374
|
const { client, defaults } = this;
|
|
@@ -1378,7 +1378,7 @@ export class SeamHttpEndpoints {
|
|
|
1378
1378
|
};
|
|
1379
1379
|
}
|
|
1380
1380
|
/**
|
|
1381
|
-
* Deletes a specified [Instant Key](https://
|
|
1381
|
+
* Deletes a specified [Instant Key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
1382
1382
|
*/
|
|
1383
1383
|
get '/instant_keys/delete'() {
|
|
1384
1384
|
const { client, defaults } = this;
|
|
@@ -1388,7 +1388,7 @@ export class SeamHttpEndpoints {
|
|
|
1388
1388
|
};
|
|
1389
1389
|
}
|
|
1390
1390
|
/**
|
|
1391
|
-
* Gets an [instant key](https://
|
|
1391
|
+
* Gets an [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
1392
1392
|
*/
|
|
1393
1393
|
get '/instant_keys/get'() {
|
|
1394
1394
|
const { client, defaults } = this;
|
|
@@ -1398,7 +1398,7 @@ export class SeamHttpEndpoints {
|
|
|
1398
1398
|
};
|
|
1399
1399
|
}
|
|
1400
1400
|
/**
|
|
1401
|
-
* Returns a list of all [instant keys](https://
|
|
1401
|
+
* Returns a list of all [instant keys](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
1402
1402
|
*/
|
|
1403
1403
|
get '/instant_keys/list'() {
|
|
1404
1404
|
const { client, defaults } = this;
|
|
@@ -1408,7 +1408,7 @@ export class SeamHttpEndpoints {
|
|
|
1408
1408
|
};
|
|
1409
1409
|
}
|
|
1410
1410
|
/**
|
|
1411
|
-
* Configures the auto-lock setting for a specified [lock](https://
|
|
1411
|
+
* Configures the auto-lock setting for a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
1412
1412
|
*/
|
|
1413
1413
|
get '/locks/configure_auto_lock'() {
|
|
1414
1414
|
const { client, defaults } = this;
|
|
@@ -1418,7 +1418,7 @@ export class SeamHttpEndpoints {
|
|
|
1418
1418
|
};
|
|
1419
1419
|
}
|
|
1420
1420
|
/**
|
|
1421
|
-
* Returns a specified [lock](https://
|
|
1421
|
+
* Returns a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
1422
1422
|
* @deprecated Use `/devices/get` instead.
|
|
1423
1423
|
*/
|
|
1424
1424
|
get '/locks/get'() {
|
|
@@ -1429,7 +1429,7 @@ export class SeamHttpEndpoints {
|
|
|
1429
1429
|
};
|
|
1430
1430
|
}
|
|
1431
1431
|
/**
|
|
1432
|
-
* Returns a list of all [locks](https://
|
|
1432
|
+
* Returns a list of all [locks](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
1433
1433
|
*/
|
|
1434
1434
|
get '/locks/list'() {
|
|
1435
1435
|
const { client, defaults } = this;
|
|
@@ -1439,7 +1439,7 @@ export class SeamHttpEndpoints {
|
|
|
1439
1439
|
};
|
|
1440
1440
|
}
|
|
1441
1441
|
/**
|
|
1442
|
-
* Locks a [lock](https://
|
|
1442
|
+
* 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).
|
|
1443
1443
|
*/
|
|
1444
1444
|
get '/locks/lock_door'() {
|
|
1445
1445
|
const { client, defaults } = this;
|
|
@@ -1449,7 +1449,7 @@ export class SeamHttpEndpoints {
|
|
|
1449
1449
|
};
|
|
1450
1450
|
}
|
|
1451
1451
|
/**
|
|
1452
|
-
* Unlocks a [lock](https://
|
|
1452
|
+
* 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).
|
|
1453
1453
|
*/
|
|
1454
1454
|
get '/locks/unlock_door'() {
|
|
1455
1455
|
const { client, defaults } = this;
|
|
@@ -1459,7 +1459,7 @@ export class SeamHttpEndpoints {
|
|
|
1459
1459
|
};
|
|
1460
1460
|
}
|
|
1461
1461
|
/**
|
|
1462
|
-
* Simulates the entry of a code on a keypad. You can only perform this action for [August](https://
|
|
1462
|
+
* 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).
|
|
1463
1463
|
*/
|
|
1464
1464
|
get '/locks/simulate/keypad_code_entry'() {
|
|
1465
1465
|
const { client, defaults } = this;
|
|
@@ -1469,7 +1469,7 @@ export class SeamHttpEndpoints {
|
|
|
1469
1469
|
};
|
|
1470
1470
|
}
|
|
1471
1471
|
/**
|
|
1472
|
-
* Simulates a manual lock action using a keypad. You can only perform this action for [August](https://
|
|
1472
|
+
* 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).
|
|
1473
1473
|
*/
|
|
1474
1474
|
get '/locks/simulate/manual_lock_via_keypad'() {
|
|
1475
1475
|
const { client, defaults } = this;
|
|
@@ -1479,7 +1479,7 @@ export class SeamHttpEndpoints {
|
|
|
1479
1479
|
};
|
|
1480
1480
|
}
|
|
1481
1481
|
/**
|
|
1482
|
-
* Returns a list of all [noise sensors](https://
|
|
1482
|
+
* Returns a list of all [noise sensors](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
1483
1483
|
*/
|
|
1484
1484
|
get '/noise_sensors/list'() {
|
|
1485
1485
|
const { client, defaults } = this;
|
|
@@ -1489,7 +1489,7 @@ export class SeamHttpEndpoints {
|
|
|
1489
1489
|
};
|
|
1490
1490
|
}
|
|
1491
1491
|
/**
|
|
1492
|
-
* Creates a new [noise threshold](https://
|
|
1492
|
+
* 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.
|
|
1493
1493
|
*/
|
|
1494
1494
|
get '/noise_sensors/noise_thresholds/create'() {
|
|
1495
1495
|
const { client, defaults } = this;
|
|
@@ -1499,7 +1499,7 @@ export class SeamHttpEndpoints {
|
|
|
1499
1499
|
};
|
|
1500
1500
|
}
|
|
1501
1501
|
/**
|
|
1502
|
-
* Deletes a [noise threshold](https://
|
|
1502
|
+
* 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).
|
|
1503
1503
|
*/
|
|
1504
1504
|
get '/noise_sensors/noise_thresholds/delete'() {
|
|
1505
1505
|
const { client, defaults } = this;
|
|
@@ -1509,7 +1509,7 @@ export class SeamHttpEndpoints {
|
|
|
1509
1509
|
};
|
|
1510
1510
|
}
|
|
1511
1511
|
/**
|
|
1512
|
-
* Returns a specified [noise threshold](https://
|
|
1512
|
+
* 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).
|
|
1513
1513
|
*/
|
|
1514
1514
|
get '/noise_sensors/noise_thresholds/get'() {
|
|
1515
1515
|
const { client, defaults } = this;
|
|
@@ -1519,7 +1519,7 @@ export class SeamHttpEndpoints {
|
|
|
1519
1519
|
};
|
|
1520
1520
|
}
|
|
1521
1521
|
/**
|
|
1522
|
-
* Returns a list of all [noise thresholds](https://
|
|
1522
|
+
* 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).
|
|
1523
1523
|
*/
|
|
1524
1524
|
get '/noise_sensors/noise_thresholds/list'() {
|
|
1525
1525
|
const { client, defaults } = this;
|
|
@@ -1529,7 +1529,7 @@ export class SeamHttpEndpoints {
|
|
|
1529
1529
|
};
|
|
1530
1530
|
}
|
|
1531
1531
|
/**
|
|
1532
|
-
* Updates a [noise threshold](https://
|
|
1532
|
+
* 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).
|
|
1533
1533
|
*/
|
|
1534
1534
|
get '/noise_sensors/noise_thresholds/update'() {
|
|
1535
1535
|
const { client, defaults } = this;
|
|
@@ -1539,7 +1539,7 @@ export class SeamHttpEndpoints {
|
|
|
1539
1539
|
};
|
|
1540
1540
|
}
|
|
1541
1541
|
/**
|
|
1542
|
-
* Simulates the triggering of a [noise threshold](https://
|
|
1542
|
+
* 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).
|
|
1543
1543
|
*/
|
|
1544
1544
|
get '/noise_sensors/simulate/trigger_noise_threshold'() {
|
|
1545
1545
|
const { client, defaults } = this;
|
|
@@ -1549,7 +1549,7 @@ export class SeamHttpEndpoints {
|
|
|
1549
1549
|
};
|
|
1550
1550
|
}
|
|
1551
1551
|
/**
|
|
1552
|
-
* 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://
|
|
1552
|
+
* 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).
|
|
1553
1553
|
*/
|
|
1554
1554
|
get '/phones/deactivate'() {
|
|
1555
1555
|
const { client, defaults } = this;
|
|
@@ -1559,7 +1559,7 @@ export class SeamHttpEndpoints {
|
|
|
1559
1559
|
};
|
|
1560
1560
|
}
|
|
1561
1561
|
/**
|
|
1562
|
-
* Returns a specified [phone](https://
|
|
1562
|
+
* Returns a specified [phone](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity).
|
|
1563
1563
|
*/
|
|
1564
1564
|
get '/phones/get'() {
|
|
1565
1565
|
const { client, defaults } = this;
|
|
@@ -1569,7 +1569,7 @@ export class SeamHttpEndpoints {
|
|
|
1569
1569
|
};
|
|
1570
1570
|
}
|
|
1571
1571
|
/**
|
|
1572
|
-
* Returns a list of all [phones](https://
|
|
1572
|
+
* 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.
|
|
1573
1573
|
*/
|
|
1574
1574
|
get '/phones/list'() {
|
|
1575
1575
|
const { client, defaults } = this;
|
|
@@ -1579,7 +1579,7 @@ export class SeamHttpEndpoints {
|
|
|
1579
1579
|
};
|
|
1580
1580
|
}
|
|
1581
1581
|
/**
|
|
1582
|
-
* Creates a new simulated phone in a [sandbox workspace](https://
|
|
1582
|
+
* 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).
|
|
1583
1583
|
*/
|
|
1584
1584
|
get '/phones/simulate/create_sandbox_phone'() {
|
|
1585
1585
|
const { client, defaults } = this;
|
|
@@ -1589,7 +1589,7 @@ export class SeamHttpEndpoints {
|
|
|
1589
1589
|
};
|
|
1590
1590
|
}
|
|
1591
1591
|
/**
|
|
1592
|
-
* Adds [entrances](https://
|
|
1592
|
+
* Adds [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.
|
|
1593
1593
|
*/
|
|
1594
1594
|
get '/spaces/add_acs_entrances'() {
|
|
1595
1595
|
const { client, defaults } = this;
|
|
@@ -1599,7 +1599,7 @@ export class SeamHttpEndpoints {
|
|
|
1599
1599
|
};
|
|
1600
1600
|
}
|
|
1601
1601
|
/**
|
|
1602
|
-
* Adds a [connected account](https://
|
|
1602
|
+
* Adds a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to a specific space.
|
|
1603
1603
|
*/
|
|
1604
1604
|
get '/spaces/add_connected_account'() {
|
|
1605
1605
|
const { client, defaults } = this;
|
|
@@ -1669,7 +1669,7 @@ export class SeamHttpEndpoints {
|
|
|
1669
1669
|
};
|
|
1670
1670
|
}
|
|
1671
1671
|
/**
|
|
1672
|
-
* Removes [entrances](https://
|
|
1672
|
+
* Removes [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.
|
|
1673
1673
|
*/
|
|
1674
1674
|
get '/spaces/remove_acs_entrances'() {
|
|
1675
1675
|
const { client, defaults } = this;
|
|
@@ -1679,7 +1679,7 @@ export class SeamHttpEndpoints {
|
|
|
1679
1679
|
};
|
|
1680
1680
|
}
|
|
1681
1681
|
/**
|
|
1682
|
-
* Removes a [connected account](https://
|
|
1682
|
+
* Removes a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) from a specific space.
|
|
1683
1683
|
*/
|
|
1684
1684
|
get '/spaces/remove_connected_account'() {
|
|
1685
1685
|
const { client, defaults } = this;
|
|
@@ -1709,7 +1709,7 @@ export class SeamHttpEndpoints {
|
|
|
1709
1709
|
};
|
|
1710
1710
|
}
|
|
1711
1711
|
/**
|
|
1712
|
-
* Activates a specified [climate preset](https://
|
|
1712
|
+
* 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).
|
|
1713
1713
|
*/
|
|
1714
1714
|
get '/thermostats/activate_climate_preset'() {
|
|
1715
1715
|
const { client, defaults } = this;
|
|
@@ -1719,7 +1719,7 @@ export class SeamHttpEndpoints {
|
|
|
1719
1719
|
};
|
|
1720
1720
|
}
|
|
1721
1721
|
/**
|
|
1722
|
-
* Sets a specified [thermostat](https://
|
|
1722
|
+
* 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).
|
|
1723
1723
|
*/
|
|
1724
1724
|
get '/thermostats/cool'() {
|
|
1725
1725
|
const { client, defaults } = this;
|
|
@@ -1729,7 +1729,7 @@ export class SeamHttpEndpoints {
|
|
|
1729
1729
|
};
|
|
1730
1730
|
}
|
|
1731
1731
|
/**
|
|
1732
|
-
* Creates a [climate preset](https://
|
|
1732
|
+
* 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).
|
|
1733
1733
|
*/
|
|
1734
1734
|
get '/thermostats/create_climate_preset'() {
|
|
1735
1735
|
const { client, defaults } = this;
|
|
@@ -1739,7 +1739,7 @@ export class SeamHttpEndpoints {
|
|
|
1739
1739
|
};
|
|
1740
1740
|
}
|
|
1741
1741
|
/**
|
|
1742
|
-
* Deletes a specified [climate preset](https://
|
|
1742
|
+
* 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).
|
|
1743
1743
|
*/
|
|
1744
1744
|
get '/thermostats/delete_climate_preset'() {
|
|
1745
1745
|
const { client, defaults } = this;
|
|
@@ -1749,7 +1749,7 @@ export class SeamHttpEndpoints {
|
|
|
1749
1749
|
};
|
|
1750
1750
|
}
|
|
1751
1751
|
/**
|
|
1752
|
-
* Sets a specified [thermostat](https://
|
|
1752
|
+
* 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).
|
|
1753
1753
|
*/
|
|
1754
1754
|
get '/thermostats/heat'() {
|
|
1755
1755
|
const { client, defaults } = this;
|
|
@@ -1759,7 +1759,7 @@ export class SeamHttpEndpoints {
|
|
|
1759
1759
|
};
|
|
1760
1760
|
}
|
|
1761
1761
|
/**
|
|
1762
|
-
* Sets a specified [thermostat](https://
|
|
1762
|
+
* 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).
|
|
1763
1763
|
*/
|
|
1764
1764
|
get '/thermostats/heat_cool'() {
|
|
1765
1765
|
const { client, defaults } = this;
|
|
@@ -1769,7 +1769,7 @@ export class SeamHttpEndpoints {
|
|
|
1769
1769
|
};
|
|
1770
1770
|
}
|
|
1771
1771
|
/**
|
|
1772
|
-
* Returns a list of all [thermostats](https://
|
|
1772
|
+
* Returns a list of all [thermostats](https://www.seam.co/docs/capability-guides/thermostats).
|
|
1773
1773
|
*/
|
|
1774
1774
|
get '/thermostats/list'() {
|
|
1775
1775
|
const { client, defaults } = this;
|
|
@@ -1779,7 +1779,7 @@ export class SeamHttpEndpoints {
|
|
|
1779
1779
|
};
|
|
1780
1780
|
}
|
|
1781
1781
|
/**
|
|
1782
|
-
* Sets a specified [thermostat](https://
|
|
1782
|
+
* 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).
|
|
1783
1783
|
*/
|
|
1784
1784
|
get '/thermostats/off'() {
|
|
1785
1785
|
const { client, defaults } = this;
|
|
@@ -1789,7 +1789,7 @@ export class SeamHttpEndpoints {
|
|
|
1789
1789
|
};
|
|
1790
1790
|
}
|
|
1791
1791
|
/**
|
|
1792
|
-
* Sets a specified [climate preset](https://
|
|
1792
|
+
* 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).
|
|
1793
1793
|
*/
|
|
1794
1794
|
get '/thermostats/set_fallback_climate_preset'() {
|
|
1795
1795
|
const { client, defaults } = this;
|
|
@@ -1799,7 +1799,7 @@ export class SeamHttpEndpoints {
|
|
|
1799
1799
|
};
|
|
1800
1800
|
}
|
|
1801
1801
|
/**
|
|
1802
|
-
* Sets the [fan mode setting](https://
|
|
1802
|
+
* 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).
|
|
1803
1803
|
*/
|
|
1804
1804
|
get '/thermostats/set_fan_mode'() {
|
|
1805
1805
|
const { client, defaults } = this;
|
|
@@ -1809,7 +1809,7 @@ export class SeamHttpEndpoints {
|
|
|
1809
1809
|
};
|
|
1810
1810
|
}
|
|
1811
1811
|
/**
|
|
1812
|
-
* Sets the [HVAC mode](https://
|
|
1812
|
+
* 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).
|
|
1813
1813
|
*/
|
|
1814
1814
|
get '/thermostats/set_hvac_mode'() {
|
|
1815
1815
|
const { client, defaults } = this;
|
|
@@ -1819,7 +1819,7 @@ export class SeamHttpEndpoints {
|
|
|
1819
1819
|
};
|
|
1820
1820
|
}
|
|
1821
1821
|
/**
|
|
1822
|
-
* Sets a [temperature threshold](https://
|
|
1822
|
+
* 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.
|
|
1823
1823
|
*/
|
|
1824
1824
|
get '/thermostats/set_temperature_threshold'() {
|
|
1825
1825
|
const { client, defaults } = this;
|
|
@@ -1829,7 +1829,7 @@ export class SeamHttpEndpoints {
|
|
|
1829
1829
|
};
|
|
1830
1830
|
}
|
|
1831
1831
|
/**
|
|
1832
|
-
* Updates a specified [climate preset](https://
|
|
1832
|
+
* 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).
|
|
1833
1833
|
*/
|
|
1834
1834
|
get '/thermostats/update_climate_preset'() {
|
|
1835
1835
|
const { client, defaults } = this;
|
|
@@ -1879,7 +1879,7 @@ export class SeamHttpEndpoints {
|
|
|
1879
1879
|
};
|
|
1880
1880
|
}
|
|
1881
1881
|
/**
|
|
1882
|
-
* Creates a new [thermostat schedule](https://
|
|
1882
|
+
* 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).
|
|
1883
1883
|
*/
|
|
1884
1884
|
get '/thermostats/schedules/create'() {
|
|
1885
1885
|
const { client, defaults } = this;
|
|
@@ -1889,7 +1889,7 @@ export class SeamHttpEndpoints {
|
|
|
1889
1889
|
};
|
|
1890
1890
|
}
|
|
1891
1891
|
/**
|
|
1892
|
-
* Deletes a [thermostat schedule](https://
|
|
1892
|
+
* 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).
|
|
1893
1893
|
*/
|
|
1894
1894
|
get '/thermostats/schedules/delete'() {
|
|
1895
1895
|
const { client, defaults } = this;
|
|
@@ -1899,7 +1899,7 @@ export class SeamHttpEndpoints {
|
|
|
1899
1899
|
};
|
|
1900
1900
|
}
|
|
1901
1901
|
/**
|
|
1902
|
-
* Returns a specified [thermostat schedule](https://
|
|
1902
|
+
* Returns a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1903
1903
|
*/
|
|
1904
1904
|
get '/thermostats/schedules/get'() {
|
|
1905
1905
|
const { client, defaults } = this;
|
|
@@ -1909,7 +1909,7 @@ export class SeamHttpEndpoints {
|
|
|
1909
1909
|
};
|
|
1910
1910
|
}
|
|
1911
1911
|
/**
|
|
1912
|
-
* Returns a list of all [thermostat schedules](https://
|
|
1912
|
+
* 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).
|
|
1913
1913
|
*/
|
|
1914
1914
|
get '/thermostats/schedules/list'() {
|
|
1915
1915
|
const { client, defaults } = this;
|
|
@@ -1919,7 +1919,7 @@ export class SeamHttpEndpoints {
|
|
|
1919
1919
|
};
|
|
1920
1920
|
}
|
|
1921
1921
|
/**
|
|
1922
|
-
* Updates a specified [thermostat schedule](https://
|
|
1922
|
+
* Updates a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
1923
1923
|
*/
|
|
1924
1924
|
get '/thermostats/schedules/update'() {
|
|
1925
1925
|
const { client, defaults } = this;
|
|
@@ -1929,7 +1929,7 @@ export class SeamHttpEndpoints {
|
|
|
1929
1929
|
};
|
|
1930
1930
|
}
|
|
1931
1931
|
/**
|
|
1932
|
-
* Simulates having adjusted the [HVAC mode](https://
|
|
1932
|
+
* 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).
|
|
1933
1933
|
*/
|
|
1934
1934
|
get '/thermostats/simulate/hvac_mode_adjusted'() {
|
|
1935
1935
|
const { client, defaults } = this;
|
|
@@ -1939,7 +1939,7 @@ export class SeamHttpEndpoints {
|
|
|
1939
1939
|
};
|
|
1940
1940
|
}
|
|
1941
1941
|
/**
|
|
1942
|
-
* Simulates a [thermostat](https://
|
|
1942
|
+
* 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).
|
|
1943
1943
|
*/
|
|
1944
1944
|
get '/thermostats/simulate/temperature_reached'() {
|
|
1945
1945
|
const { client, defaults } = this;
|
|
@@ -1949,7 +1949,7 @@ export class SeamHttpEndpoints {
|
|
|
1949
1949
|
};
|
|
1950
1950
|
}
|
|
1951
1951
|
/**
|
|
1952
|
-
* Adds a specified [access system user](https://
|
|
1952
|
+
* 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).
|
|
1953
1953
|
*
|
|
1954
1954
|
* You must specify either `user_identity_id` or `user_identity_key` to identify the user identity.
|
|
1955
1955
|
*
|
|
@@ -1963,7 +1963,7 @@ export class SeamHttpEndpoints {
|
|
|
1963
1963
|
};
|
|
1964
1964
|
}
|
|
1965
1965
|
/**
|
|
1966
|
-
* Creates a new [user identity](https://
|
|
1966
|
+
* 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).
|
|
1967
1967
|
*/
|
|
1968
1968
|
get '/user_identities/create'() {
|
|
1969
1969
|
const { client, defaults } = this;
|
|
@@ -1973,7 +1973,7 @@ export class SeamHttpEndpoints {
|
|
|
1973
1973
|
};
|
|
1974
1974
|
}
|
|
1975
1975
|
/**
|
|
1976
|
-
* Deletes a specified [user identity](https://
|
|
1976
|
+
* 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).
|
|
1977
1977
|
*/
|
|
1978
1978
|
get '/user_identities/delete'() {
|
|
1979
1979
|
const { client, defaults } = this;
|
|
@@ -1983,7 +1983,7 @@ export class SeamHttpEndpoints {
|
|
|
1983
1983
|
};
|
|
1984
1984
|
}
|
|
1985
1985
|
/**
|
|
1986
|
-
* Generates a new [instant key](https://
|
|
1986
|
+
* 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).
|
|
1987
1987
|
*/
|
|
1988
1988
|
get '/user_identities/generate_instant_key'() {
|
|
1989
1989
|
const { client, defaults } = this;
|
|
@@ -1993,7 +1993,7 @@ export class SeamHttpEndpoints {
|
|
|
1993
1993
|
};
|
|
1994
1994
|
}
|
|
1995
1995
|
/**
|
|
1996
|
-
* Returns a specified [user identity](https://
|
|
1996
|
+
* 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).
|
|
1997
1997
|
*/
|
|
1998
1998
|
get '/user_identities/get'() {
|
|
1999
1999
|
const { client, defaults } = this;
|
|
@@ -2003,7 +2003,7 @@ export class SeamHttpEndpoints {
|
|
|
2003
2003
|
};
|
|
2004
2004
|
}
|
|
2005
2005
|
/**
|
|
2006
|
-
* Grants a specified [user identity](https://
|
|
2006
|
+
* 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).
|
|
2007
2007
|
*/
|
|
2008
2008
|
get '/user_identities/grant_access_to_device'() {
|
|
2009
2009
|
const { client, defaults } = this;
|
|
@@ -2013,7 +2013,7 @@ export class SeamHttpEndpoints {
|
|
|
2013
2013
|
};
|
|
2014
2014
|
}
|
|
2015
2015
|
/**
|
|
2016
|
-
* Returns a list of all [user identities](https://
|
|
2016
|
+
* 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).
|
|
2017
2017
|
*/
|
|
2018
2018
|
get '/user_identities/list'() {
|
|
2019
2019
|
const { client, defaults } = this;
|
|
@@ -2023,7 +2023,7 @@ export class SeamHttpEndpoints {
|
|
|
2023
2023
|
};
|
|
2024
2024
|
}
|
|
2025
2025
|
/**
|
|
2026
|
-
* Returns a list of all [devices](https://
|
|
2026
|
+
* 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.
|
|
2027
2027
|
*/
|
|
2028
2028
|
get '/user_identities/list_accessible_devices'() {
|
|
2029
2029
|
const { client, defaults } = this;
|
|
@@ -2033,7 +2033,7 @@ export class SeamHttpEndpoints {
|
|
|
2033
2033
|
};
|
|
2034
2034
|
}
|
|
2035
2035
|
/**
|
|
2036
|
-
* Returns a list of all [ACS entrances](https://
|
|
2036
|
+
* 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.
|
|
2037
2037
|
*/
|
|
2038
2038
|
get '/user_identities/list_accessible_entrances'() {
|
|
2039
2039
|
const { client, defaults } = this;
|
|
@@ -2043,7 +2043,7 @@ export class SeamHttpEndpoints {
|
|
|
2043
2043
|
};
|
|
2044
2044
|
}
|
|
2045
2045
|
/**
|
|
2046
|
-
* Returns a list of all [access systems](https://
|
|
2046
|
+
* 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).
|
|
2047
2047
|
*/
|
|
2048
2048
|
get '/user_identities/list_acs_systems'() {
|
|
2049
2049
|
const { client, defaults } = this;
|
|
@@ -2053,7 +2053,7 @@ export class SeamHttpEndpoints {
|
|
|
2053
2053
|
};
|
|
2054
2054
|
}
|
|
2055
2055
|
/**
|
|
2056
|
-
* Returns a list of all [access system users](https://
|
|
2056
|
+
* 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).
|
|
2057
2057
|
*/
|
|
2058
2058
|
get '/user_identities/list_acs_users'() {
|
|
2059
2059
|
const { client, defaults } = this;
|
|
@@ -2063,7 +2063,7 @@ export class SeamHttpEndpoints {
|
|
|
2063
2063
|
};
|
|
2064
2064
|
}
|
|
2065
2065
|
/**
|
|
2066
|
-
* Merges one or more [user identities](https://
|
|
2066
|
+
* 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.
|
|
2067
2067
|
*
|
|
2068
2068
|
* 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`.
|
|
2069
2069
|
*
|
|
@@ -2079,7 +2079,7 @@ export class SeamHttpEndpoints {
|
|
|
2079
2079
|
};
|
|
2080
2080
|
}
|
|
2081
2081
|
/**
|
|
2082
|
-
* Removes a specified [access system user](https://
|
|
2082
|
+
* 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).
|
|
2083
2083
|
*/
|
|
2084
2084
|
get '/user_identities/remove_acs_user'() {
|
|
2085
2085
|
const { client, defaults } = this;
|
|
@@ -2089,7 +2089,7 @@ export class SeamHttpEndpoints {
|
|
|
2089
2089
|
};
|
|
2090
2090
|
}
|
|
2091
2091
|
/**
|
|
2092
|
-
* Revokes access to a specified [device](https://
|
|
2092
|
+
* 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).
|
|
2093
2093
|
*/
|
|
2094
2094
|
get '/user_identities/revoke_access_to_device'() {
|
|
2095
2095
|
const { client, defaults } = this;
|
|
@@ -2099,7 +2099,7 @@ export class SeamHttpEndpoints {
|
|
|
2099
2099
|
};
|
|
2100
2100
|
}
|
|
2101
2101
|
/**
|
|
2102
|
-
* Updates a specified [user identity](https://
|
|
2102
|
+
* 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).
|
|
2103
2103
|
*/
|
|
2104
2104
|
get '/user_identities/update'() {
|
|
2105
2105
|
const { client, defaults } = this;
|
|
@@ -2109,7 +2109,7 @@ export class SeamHttpEndpoints {
|
|
|
2109
2109
|
};
|
|
2110
2110
|
}
|
|
2111
2111
|
/**
|
|
2112
|
-
* Returns a specified unmanaged [user identity](https://
|
|
2112
|
+
* 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).
|
|
2113
2113
|
*/
|
|
2114
2114
|
get '/user_identities/unmanaged/get'() {
|
|
2115
2115
|
const { client, defaults } = this;
|
|
@@ -2119,7 +2119,7 @@ export class SeamHttpEndpoints {
|
|
|
2119
2119
|
};
|
|
2120
2120
|
}
|
|
2121
2121
|
/**
|
|
2122
|
-
* Returns a list of all unmanaged [user identities](https://
|
|
2122
|
+
* 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).
|
|
2123
2123
|
*/
|
|
2124
2124
|
get '/user_identities/unmanaged/list'() {
|
|
2125
2125
|
const { client, defaults } = this;
|
|
@@ -2129,7 +2129,7 @@ export class SeamHttpEndpoints {
|
|
|
2129
2129
|
};
|
|
2130
2130
|
}
|
|
2131
2131
|
/**
|
|
2132
|
-
* Updates an unmanaged [user identity](https://
|
|
2132
|
+
* 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.
|
|
2133
2133
|
*
|
|
2134
2134
|
* 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.
|
|
2135
2135
|
*/
|
|
@@ -2141,7 +2141,7 @@ export class SeamHttpEndpoints {
|
|
|
2141
2141
|
};
|
|
2142
2142
|
}
|
|
2143
2143
|
/**
|
|
2144
|
-
* Creates a new [webhook](https://
|
|
2144
|
+
* Creates a new [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
2145
2145
|
*/
|
|
2146
2146
|
get '/webhooks/create'() {
|
|
2147
2147
|
const { client, defaults } = this;
|
|
@@ -2151,7 +2151,7 @@ export class SeamHttpEndpoints {
|
|
|
2151
2151
|
};
|
|
2152
2152
|
}
|
|
2153
2153
|
/**
|
|
2154
|
-
* Deletes a specified [webhook](https://
|
|
2154
|
+
* Deletes a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
2155
2155
|
*/
|
|
2156
2156
|
get '/webhooks/delete'() {
|
|
2157
2157
|
const { client, defaults } = this;
|
|
@@ -2161,7 +2161,7 @@ export class SeamHttpEndpoints {
|
|
|
2161
2161
|
};
|
|
2162
2162
|
}
|
|
2163
2163
|
/**
|
|
2164
|
-
* Gets a specified [webhook](https://
|
|
2164
|
+
* Gets a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
2165
2165
|
*/
|
|
2166
2166
|
get '/webhooks/get'() {
|
|
2167
2167
|
const { client, defaults } = this;
|
|
@@ -2171,7 +2171,7 @@ export class SeamHttpEndpoints {
|
|
|
2171
2171
|
};
|
|
2172
2172
|
}
|
|
2173
2173
|
/**
|
|
2174
|
-
* Returns a list of all [webhooks](https://
|
|
2174
|
+
* Returns a list of all [webhooks](https://www.seam.co/docs/developer-tools/webhooks).
|
|
2175
2175
|
*/
|
|
2176
2176
|
get '/webhooks/list'() {
|
|
2177
2177
|
const { client, defaults } = this;
|
|
@@ -2181,7 +2181,7 @@ export class SeamHttpEndpoints {
|
|
|
2181
2181
|
};
|
|
2182
2182
|
}
|
|
2183
2183
|
/**
|
|
2184
|
-
* Updates a specified [webhook](https://
|
|
2184
|
+
* Updates a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
2185
2185
|
*/
|
|
2186
2186
|
get '/webhooks/update'() {
|
|
2187
2187
|
const { client, defaults } = this;
|
|
@@ -2191,7 +2191,7 @@ export class SeamHttpEndpoints {
|
|
|
2191
2191
|
};
|
|
2192
2192
|
}
|
|
2193
2193
|
/**
|
|
2194
|
-
* Creates a new [workspace](https://
|
|
2194
|
+
* Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
2195
2195
|
*/
|
|
2196
2196
|
get '/workspaces/create'() {
|
|
2197
2197
|
const { client, defaults } = this;
|
|
@@ -2201,7 +2201,7 @@ export class SeamHttpEndpoints {
|
|
|
2201
2201
|
};
|
|
2202
2202
|
}
|
|
2203
2203
|
/**
|
|
2204
|
-
* Returns the [workspace](https://
|
|
2204
|
+
* Returns the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
2205
2205
|
*/
|
|
2206
2206
|
get '/workspaces/get'() {
|
|
2207
2207
|
const { client, defaults } = this;
|
|
@@ -2211,7 +2211,7 @@ export class SeamHttpEndpoints {
|
|
|
2211
2211
|
};
|
|
2212
2212
|
}
|
|
2213
2213
|
/**
|
|
2214
|
-
* Returns a list of [workspaces](https://
|
|
2214
|
+
* Returns a list of [workspaces](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
2215
2215
|
*/
|
|
2216
2216
|
get '/workspaces/list'() {
|
|
2217
2217
|
const { client, defaults } = this;
|
|
@@ -2221,7 +2221,7 @@ export class SeamHttpEndpoints {
|
|
|
2221
2221
|
};
|
|
2222
2222
|
}
|
|
2223
2223
|
/**
|
|
2224
|
-
* Resets the [sandbox workspace](https://
|
|
2224
|
+
* 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.
|
|
2225
2225
|
*/
|
|
2226
2226
|
get '/workspaces/reset_sandbox'() {
|
|
2227
2227
|
const { client, defaults } = this;
|
|
@@ -2231,7 +2231,7 @@ export class SeamHttpEndpoints {
|
|
|
2231
2231
|
};
|
|
2232
2232
|
}
|
|
2233
2233
|
/**
|
|
2234
|
-
* Updates the [workspace](https://
|
|
2234
|
+
* Updates the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
2235
2235
|
*/
|
|
2236
2236
|
get '/workspaces/update'() {
|
|
2237
2237
|
const { client, defaults } = this;
|