@seamapi/http 2.31.0 → 2.33.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 +6 -6
- 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 +13 -9
- package/src/lib/routes/devices/simulate/simulate.ts +3 -3
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +10 -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 +6 -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
|
@@ -165,7 +165,7 @@ export class SeamHttpAcsEntrances {
|
|
|
165
165
|
}
|
|
166
166
|
|
|
167
167
|
/**
|
|
168
|
-
* Returns a specified [access system entrance](https://
|
|
168
|
+
* Returns a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
169
169
|
*/
|
|
170
170
|
get(
|
|
171
171
|
parameters: AcsEntrancesGetParameters,
|
|
@@ -185,7 +185,7 @@ export class SeamHttpAcsEntrances {
|
|
|
185
185
|
}
|
|
186
186
|
|
|
187
187
|
/**
|
|
188
|
-
* Grants a specified [access system user](https://
|
|
188
|
+
* 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).
|
|
189
189
|
*/
|
|
190
190
|
grantAccess(
|
|
191
191
|
parameters: AcsEntrancesGrantAccessParameters,
|
|
@@ -205,7 +205,7 @@ export class SeamHttpAcsEntrances {
|
|
|
205
205
|
}
|
|
206
206
|
|
|
207
207
|
/**
|
|
208
|
-
* Returns a list of all [access system entrances](https://
|
|
208
|
+
* Returns a list of all [access system entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
209
209
|
*/
|
|
210
210
|
list(
|
|
211
211
|
parameters?: AcsEntrancesListParameters,
|
|
@@ -226,7 +226,7 @@ export class SeamHttpAcsEntrances {
|
|
|
226
226
|
}
|
|
227
227
|
|
|
228
228
|
/**
|
|
229
|
-
* Returns a list of all [credentials](https://
|
|
229
|
+
* 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).
|
|
230
230
|
*/
|
|
231
231
|
listCredentialsWithAccess(
|
|
232
232
|
parameters: AcsEntrancesListCredentialsWithAccessParameters,
|
|
@@ -246,7 +246,7 @@ export class SeamHttpAcsEntrances {
|
|
|
246
246
|
}
|
|
247
247
|
|
|
248
248
|
/**
|
|
249
|
-
* Remotely unlocks a specified [entrance](https://
|
|
249
|
+
* 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.
|
|
250
250
|
*/
|
|
251
251
|
unlock(
|
|
252
252
|
parameters: AcsEntrancesUnlockParameters,
|
|
@@ -162,7 +162,7 @@ export class SeamHttpAcsSystems {
|
|
|
162
162
|
}
|
|
163
163
|
|
|
164
164
|
/**
|
|
165
|
-
* Returns a specified [access system](https://
|
|
165
|
+
* Returns a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
166
166
|
*/
|
|
167
167
|
get(
|
|
168
168
|
parameters: AcsSystemsGetParameters,
|
|
@@ -182,7 +182,7 @@ export class SeamHttpAcsSystems {
|
|
|
182
182
|
}
|
|
183
183
|
|
|
184
184
|
/**
|
|
185
|
-
* Returns a list of all [access systems](https://
|
|
185
|
+
* Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
186
186
|
*
|
|
187
187
|
* 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.
|
|
188
188
|
*/
|
|
@@ -204,7 +204,7 @@ export class SeamHttpAcsSystems {
|
|
|
204
204
|
}
|
|
205
205
|
|
|
206
206
|
/**
|
|
207
|
-
* Returns a list of all credential manager systems that are compatible with a specified [access system](https://
|
|
207
|
+
* 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).
|
|
208
208
|
*
|
|
209
209
|
* 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.
|
|
210
210
|
*/
|
|
@@ -164,7 +164,7 @@ export class SeamHttpAcsUsers {
|
|
|
164
164
|
}
|
|
165
165
|
|
|
166
166
|
/**
|
|
167
|
-
* Adds a specified [access system user](https://
|
|
167
|
+
* 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).
|
|
168
168
|
*/
|
|
169
169
|
addToAccessGroup(
|
|
170
170
|
parameters: AcsUsersAddToAccessGroupParameters,
|
|
@@ -184,7 +184,7 @@ export class SeamHttpAcsUsers {
|
|
|
184
184
|
}
|
|
185
185
|
|
|
186
186
|
/**
|
|
187
|
-
* Creates a new [access system user](https://
|
|
187
|
+
* Creates a new [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
188
188
|
*/
|
|
189
189
|
create(
|
|
190
190
|
parameters: AcsUsersCreateParameters,
|
|
@@ -204,7 +204,7 @@ export class SeamHttpAcsUsers {
|
|
|
204
204
|
}
|
|
205
205
|
|
|
206
206
|
/**
|
|
207
|
-
* Deletes a specified [access system user](https://
|
|
207
|
+
* 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).
|
|
208
208
|
*/
|
|
209
209
|
delete(
|
|
210
210
|
parameters: AcsUsersDeleteParameters,
|
|
@@ -228,7 +228,7 @@ export class SeamHttpAcsUsers {
|
|
|
228
228
|
}
|
|
229
229
|
|
|
230
230
|
/**
|
|
231
|
-
* Returns a specified [access system user](https://
|
|
231
|
+
* Returns a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
232
232
|
*/
|
|
233
233
|
get(
|
|
234
234
|
parameters: AcsUsersGetParameters,
|
|
@@ -252,7 +252,7 @@ export class SeamHttpAcsUsers {
|
|
|
252
252
|
}
|
|
253
253
|
|
|
254
254
|
/**
|
|
255
|
-
* Returns a list of all [access system users](https://
|
|
255
|
+
* Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
256
256
|
*/
|
|
257
257
|
list(
|
|
258
258
|
parameters?: AcsUsersListParameters,
|
|
@@ -273,7 +273,7 @@ export class SeamHttpAcsUsers {
|
|
|
273
273
|
}
|
|
274
274
|
|
|
275
275
|
/**
|
|
276
|
-
* Lists the [entrances](https://
|
|
276
|
+
* 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.
|
|
277
277
|
*/
|
|
278
278
|
listAccessibleEntrances(
|
|
279
279
|
parameters: AcsUsersListAccessibleEntrancesParameters,
|
|
@@ -297,7 +297,7 @@ export class SeamHttpAcsUsers {
|
|
|
297
297
|
}
|
|
298
298
|
|
|
299
299
|
/**
|
|
300
|
-
* Removes a specified [access system user](https://
|
|
300
|
+
* 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).
|
|
301
301
|
*/
|
|
302
302
|
removeFromAccessGroup(
|
|
303
303
|
parameters: AcsUsersRemoveFromAccessGroupParameters,
|
|
@@ -317,7 +317,7 @@ export class SeamHttpAcsUsers {
|
|
|
317
317
|
}
|
|
318
318
|
|
|
319
319
|
/**
|
|
320
|
-
* Revokes access to all [entrances](https://
|
|
320
|
+
* 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).
|
|
321
321
|
*/
|
|
322
322
|
revokeAccessToAllEntrances(
|
|
323
323
|
parameters: AcsUsersRevokeAccessToAllEntrancesParameters,
|
|
@@ -341,7 +341,7 @@ export class SeamHttpAcsUsers {
|
|
|
341
341
|
}
|
|
342
342
|
|
|
343
343
|
/**
|
|
344
|
-
* [Suspends](https://
|
|
344
|
+
* [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.
|
|
345
345
|
*/
|
|
346
346
|
suspend(
|
|
347
347
|
parameters: AcsUsersSuspendParameters,
|
|
@@ -365,7 +365,7 @@ export class SeamHttpAcsUsers {
|
|
|
365
365
|
}
|
|
366
366
|
|
|
367
367
|
/**
|
|
368
|
-
* [Unsuspends](https://
|
|
368
|
+
* [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.
|
|
369
369
|
*/
|
|
370
370
|
unsuspend(
|
|
371
371
|
parameters: AcsUsersUnsuspendParameters,
|
|
@@ -389,7 +389,7 @@ export class SeamHttpAcsUsers {
|
|
|
389
389
|
}
|
|
390
390
|
|
|
391
391
|
/**
|
|
392
|
-
* Updates the properties of a specified [access system user](https://
|
|
392
|
+
* Updates the properties of a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
393
393
|
*/
|
|
394
394
|
update(
|
|
395
395
|
parameters: AcsUsersUpdateParameters,
|
|
@@ -470,7 +470,7 @@ export type AcsUsersCreateParameters = {
|
|
|
470
470
|
*/
|
|
471
471
|
email?: string | undefined
|
|
472
472
|
/**
|
|
473
|
-
* Email address of the [access system user](https://
|
|
473
|
+
* Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
474
474
|
*/
|
|
475
475
|
email_address?: string | undefined
|
|
476
476
|
/**
|
|
@@ -479,7 +479,7 @@ export type AcsUsersCreateParameters = {
|
|
|
479
479
|
full_name: string
|
|
480
480
|
|
|
481
481
|
/**
|
|
482
|
-
* Phone number of the [access system user](https://
|
|
482
|
+
* Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
|
|
483
483
|
*/
|
|
484
484
|
phone_number?: string | undefined
|
|
485
485
|
/**
|
|
@@ -779,11 +779,11 @@ export type AcsUsersUpdateParameters = RequireAtLeastOne<
|
|
|
779
779
|
*/
|
|
780
780
|
email?: string | undefined
|
|
781
781
|
/**
|
|
782
|
-
* Email address of the [access system user](https://
|
|
782
|
+
* Email address of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
783
783
|
*/
|
|
784
784
|
email_address?: string | undefined
|
|
785
785
|
/**
|
|
786
|
-
* Full name of the [access system user](https://
|
|
786
|
+
* Full name of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
787
787
|
*/
|
|
788
788
|
full_name?: string | undefined
|
|
789
789
|
/**
|
|
@@ -791,7 +791,7 @@ export type AcsUsersUpdateParameters = RequireAtLeastOne<
|
|
|
791
791
|
*/
|
|
792
792
|
hid_acs_system_id?: string | undefined
|
|
793
793
|
/**
|
|
794
|
-
* Phone number of the [access system user](https://
|
|
794
|
+
* Phone number of the [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in E.164 format (for example, `+15555550100`).
|
|
795
795
|
*/
|
|
796
796
|
phone_number?: string | undefined
|
|
797
797
|
/**
|
|
@@ -162,7 +162,7 @@ export class SeamHttpActionAttempts {
|
|
|
162
162
|
}
|
|
163
163
|
|
|
164
164
|
/**
|
|
165
|
-
* Returns a specified [action attempt](https://
|
|
165
|
+
* Returns a specified [action attempt](https://www.seam.co/docs/core-concepts/action-attempts).
|
|
166
166
|
*/
|
|
167
167
|
get(
|
|
168
168
|
parameters: ActionAttemptsGetParameters,
|
|
@@ -187,7 +187,7 @@ export class SeamHttpActionAttempts {
|
|
|
187
187
|
}
|
|
188
188
|
|
|
189
189
|
/**
|
|
190
|
-
* Returns a list of the [action attempts](https://
|
|
190
|
+
* 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.
|
|
191
191
|
*/
|
|
192
192
|
list(
|
|
193
193
|
parameters?: ActionAttemptsListParameters,
|
|
@@ -162,7 +162,7 @@ export class SeamHttpClientSessions {
|
|
|
162
162
|
}
|
|
163
163
|
|
|
164
164
|
/**
|
|
165
|
-
* Creates a new [client session](https://
|
|
165
|
+
* Creates a new [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
166
166
|
*/
|
|
167
167
|
create(
|
|
168
168
|
parameters?: ClientSessionsCreateParameters,
|
|
@@ -182,7 +182,7 @@ export class SeamHttpClientSessions {
|
|
|
182
182
|
}
|
|
183
183
|
|
|
184
184
|
/**
|
|
185
|
-
* Deletes a [client session](https://
|
|
185
|
+
* Deletes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
186
186
|
*/
|
|
187
187
|
delete(
|
|
188
188
|
parameters: ClientSessionsDeleteParameters,
|
|
@@ -202,7 +202,7 @@ export class SeamHttpClientSessions {
|
|
|
202
202
|
}
|
|
203
203
|
|
|
204
204
|
/**
|
|
205
|
-
* Returns a specified [client session](https://
|
|
205
|
+
* Returns a specified [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
206
206
|
*/
|
|
207
207
|
get(
|
|
208
208
|
parameters?: ClientSessionsGetParameters,
|
|
@@ -222,7 +222,7 @@ export class SeamHttpClientSessions {
|
|
|
222
222
|
}
|
|
223
223
|
|
|
224
224
|
/**
|
|
225
|
-
* Returns a [client session](https://
|
|
225
|
+
* 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.
|
|
226
226
|
*/
|
|
227
227
|
getOrCreate(
|
|
228
228
|
parameters?: ClientSessionsGetOrCreateParameters,
|
|
@@ -242,7 +242,7 @@ export class SeamHttpClientSessions {
|
|
|
242
242
|
}
|
|
243
243
|
|
|
244
244
|
/**
|
|
245
|
-
* Grants a [client session](https://
|
|
245
|
+
* 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.
|
|
246
246
|
*/
|
|
247
247
|
grantAccess(
|
|
248
248
|
parameters: ClientSessionsGrantAccessParameters,
|
|
@@ -269,7 +269,7 @@ export class SeamHttpClientSessions {
|
|
|
269
269
|
}
|
|
270
270
|
|
|
271
271
|
/**
|
|
272
|
-
* Returns a list of all [client sessions](https://
|
|
272
|
+
* Returns a list of all [client sessions](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
273
273
|
*/
|
|
274
274
|
list(
|
|
275
275
|
parameters?: ClientSessionsListParameters,
|
|
@@ -289,9 +289,9 @@ export class SeamHttpClientSessions {
|
|
|
289
289
|
}
|
|
290
290
|
|
|
291
291
|
/**
|
|
292
|
-
* Revokes a [client session](https://
|
|
292
|
+
* Revokes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
293
293
|
*
|
|
294
|
-
* Note that [deleting a client session](https://
|
|
294
|
+
* Note that [deleting a client session](https://www.seam.co/docs/api/client_sessions/delete) is a separate action.
|
|
295
295
|
*/
|
|
296
296
|
revoke(
|
|
297
297
|
parameters: ClientSessionsRevokeParameters,
|
|
@@ -313,11 +313,11 @@ export class SeamHttpClientSessions {
|
|
|
313
313
|
|
|
314
314
|
export type ClientSessionsCreateParameters = {
|
|
315
315
|
/**
|
|
316
|
-
* IDs of the [Connect Webviews](https://
|
|
316
|
+
* IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) for which you want to create a client session.
|
|
317
317
|
*/
|
|
318
318
|
connect_webview_ids?: Array<string> | undefined
|
|
319
319
|
/**
|
|
320
|
-
* IDs of the [connected accounts](https://
|
|
320
|
+
* IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) for which you want to create a client session.
|
|
321
321
|
*/
|
|
322
322
|
connected_account_ids?: Array<string> | undefined
|
|
323
323
|
/**
|
|
@@ -337,11 +337,11 @@ export type ClientSessionsCreateParameters = {
|
|
|
337
337
|
*/
|
|
338
338
|
user_identifier_key?: string | undefined
|
|
339
339
|
/**
|
|
340
|
-
* ID of the [user identity](https://
|
|
340
|
+
* ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to create a client session.
|
|
341
341
|
*/
|
|
342
342
|
user_identity_id?: string | undefined
|
|
343
343
|
/**
|
|
344
|
-
* IDs of the [user identities](https://
|
|
344
|
+
* IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
|
|
345
345
|
* @deprecated Use `user_identity_id` instead.
|
|
346
346
|
*/
|
|
347
347
|
user_identity_ids?: Array<string> | undefined
|
|
@@ -400,11 +400,11 @@ export interface ClientSessionsGetOptions {}
|
|
|
400
400
|
|
|
401
401
|
export type ClientSessionsGetOrCreateParameters = {
|
|
402
402
|
/**
|
|
403
|
-
* IDs of the [Connect Webviews](https://
|
|
403
|
+
* IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) that you want to associate with the client session (or that are already associated with the existing client session).
|
|
404
404
|
*/
|
|
405
405
|
connect_webview_ids?: Array<string> | undefined
|
|
406
406
|
/**
|
|
407
|
-
* IDs of the [connected accounts](https://
|
|
407
|
+
* IDs of the [connected accounts](https://www.seam.co/docs/api/connected_accounts/object) that you want to associate with the client session (or that are already associated with the existing client session).
|
|
408
408
|
*/
|
|
409
409
|
connected_account_ids?: Array<string> | undefined
|
|
410
410
|
/**
|
|
@@ -416,11 +416,11 @@ export type ClientSessionsGetOrCreateParameters = {
|
|
|
416
416
|
*/
|
|
417
417
|
user_identifier_key?: string | undefined
|
|
418
418
|
/**
|
|
419
|
-
* ID of the [user identity](https://
|
|
419
|
+
* ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session (or that are already associated with the existing client session).
|
|
420
420
|
*/
|
|
421
421
|
user_identity_id?: string | undefined
|
|
422
422
|
/**
|
|
423
|
-
* IDs of the [user identities](https://
|
|
423
|
+
* IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
|
|
424
424
|
* @deprecated Use `user_identity_id`.
|
|
425
425
|
*/
|
|
426
426
|
user_identity_ids?: Array<string> | undefined
|
|
@@ -447,11 +447,11 @@ export type ClientSessionsGrantAccessParameters = RequireAtLeastOne<
|
|
|
447
447
|
*/
|
|
448
448
|
client_session_id?: string | undefined
|
|
449
449
|
/**
|
|
450
|
-
* IDs of the [Connect Webviews](https://
|
|
450
|
+
* IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) that you want to associate with the client session.
|
|
451
451
|
*/
|
|
452
452
|
connect_webview_ids?: Array<string> | undefined
|
|
453
453
|
/**
|
|
454
|
-
* IDs of the [connected accounts](https://
|
|
454
|
+
* IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that you want to associate with the client session.
|
|
455
455
|
*/
|
|
456
456
|
connected_account_ids?: Array<string> | undefined
|
|
457
457
|
/**
|
|
@@ -459,11 +459,11 @@ export type ClientSessionsGrantAccessParameters = RequireAtLeastOne<
|
|
|
459
459
|
*/
|
|
460
460
|
user_identifier_key?: string | undefined
|
|
461
461
|
/**
|
|
462
|
-
* ID of the [user identity](https://
|
|
462
|
+
* ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
|
|
463
463
|
*/
|
|
464
464
|
user_identity_id?: string | undefined
|
|
465
465
|
/**
|
|
466
|
-
* IDs of the [user identities](https://
|
|
466
|
+
* IDs of the [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) that you want to associate with the client session.
|
|
467
467
|
* @deprecated Use `user_identity_id`.
|
|
468
468
|
*/
|
|
469
469
|
user_identity_ids?: Array<string> | undefined
|
|
@@ -491,7 +491,7 @@ export type ClientSessionsListParameters = {
|
|
|
491
491
|
*/
|
|
492
492
|
client_session_id?: string | undefined
|
|
493
493
|
/**
|
|
494
|
-
* ID of the [Connect Webview](https://
|
|
494
|
+
* ID of the [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a Connect Webview.
|
|
495
495
|
*/
|
|
496
496
|
connect_webview_id?: string | null | undefined
|
|
497
497
|
/**
|
|
@@ -499,7 +499,7 @@ export type ClientSessionsListParameters = {
|
|
|
499
499
|
*/
|
|
500
500
|
user_identifier_key?: string | undefined
|
|
501
501
|
/**
|
|
502
|
-
* ID of the [user identity](https://
|
|
502
|
+
* ID of the [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) for which you want to retrieve client sessions. Specify `null` to retrieve client sessions that are not associated with a user identity.
|
|
503
503
|
*/
|
|
504
504
|
user_identity_id?: string | null | undefined
|
|
505
505
|
/**
|
|
@@ -162,13 +162,13 @@ export class SeamHttpConnectWebviews {
|
|
|
162
162
|
}
|
|
163
163
|
|
|
164
164
|
/**
|
|
165
|
-
* Creates a new [Connect Webview](https://
|
|
165
|
+
* Creates a new [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
166
166
|
*
|
|
167
167
|
* 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.
|
|
168
168
|
*
|
|
169
169
|
* 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.
|
|
170
170
|
*
|
|
171
|
-
* See also: [Connect Webview Process](https://
|
|
171
|
+
* See also: [Connect Webview Process](https://www.seam.co/docs/core-concepts/connect-webviews/connect-webview-process).
|
|
172
172
|
*/
|
|
173
173
|
create(
|
|
174
174
|
parameters?: ConnectWebviewsCreateParameters,
|
|
@@ -188,7 +188,7 @@ export class SeamHttpConnectWebviews {
|
|
|
188
188
|
}
|
|
189
189
|
|
|
190
190
|
/**
|
|
191
|
-
* Deletes a [Connect Webview](https://
|
|
191
|
+
* Deletes a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
192
192
|
*
|
|
193
193
|
* You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.
|
|
194
194
|
*/
|
|
@@ -210,7 +210,7 @@ export class SeamHttpConnectWebviews {
|
|
|
210
210
|
}
|
|
211
211
|
|
|
212
212
|
/**
|
|
213
|
-
* Returns a specified [Connect Webview](https://
|
|
213
|
+
* Returns a specified [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
214
214
|
*
|
|
215
215
|
* 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.
|
|
216
216
|
*/
|
|
@@ -232,7 +232,7 @@ export class SeamHttpConnectWebviews {
|
|
|
232
232
|
}
|
|
233
233
|
|
|
234
234
|
/**
|
|
235
|
-
* Returns a list of all [Connect Webviews](https://
|
|
235
|
+
* Returns a list of all [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
236
236
|
*/
|
|
237
237
|
list(
|
|
238
238
|
parameters?: ConnectWebviewsListParameters,
|
|
@@ -263,7 +263,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
263
263
|
>
|
|
264
264
|
| undefined
|
|
265
265
|
/**
|
|
266
|
-
* Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://
|
|
266
|
+
* Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [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). To list all provider keys, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with no filters.
|
|
267
267
|
*/
|
|
268
268
|
accepted_providers?:
|
|
269
269
|
| Array<
|
|
@@ -324,6 +324,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
324
324
|
| 'sifely'
|
|
325
325
|
| 'thirty_three_lock'
|
|
326
326
|
| 'ring'
|
|
327
|
+
| 'tapo'
|
|
327
328
|
| 'ical'
|
|
328
329
|
| 'lodgify'
|
|
329
330
|
| 'hostaway'
|
|
@@ -339,11 +340,11 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
339
340
|
>
|
|
340
341
|
| undefined
|
|
341
342
|
/**
|
|
342
|
-
* Indicates whether newly-added devices should appear as [managed devices](https://
|
|
343
|
+
* Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). See also: [Customize the Behavior Settings of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).
|
|
343
344
|
*/
|
|
344
345
|
automatically_manage_new_devices?: boolean | undefined
|
|
345
346
|
/**
|
|
346
|
-
* Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a Connect Webview](https://
|
|
347
|
+
* Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://www.seam.co/docs/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://www.seam.co/docs/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
347
348
|
*/
|
|
348
349
|
custom_metadata?: Record<string, string | boolean> | undefined
|
|
349
350
|
/**
|
|
@@ -363,7 +364,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
363
364
|
*/
|
|
364
365
|
excluded_providers?: Array<string> | undefined
|
|
365
366
|
/**
|
|
366
|
-
* Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://
|
|
367
|
+
* Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with the desired `provider_category` filter.
|
|
367
368
|
*/
|
|
368
369
|
provider_category?:
|
|
369
370
|
| 'stable'
|
|
@@ -377,7 +378,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
377
378
|
| 'internal_beta'
|
|
378
379
|
| undefined
|
|
379
380
|
/**
|
|
380
|
-
* Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://
|
|
381
|
+
* Indicates whether Seam should finish syncing all devices in a newly-connected account before completing the associated Connect Webview. See also: [Customize the Behavior Settings of Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-behavior-settings-of-your-connect-webviews).
|
|
381
382
|
*/
|
|
382
383
|
wait_for_device_creation?: boolean | undefined
|
|
383
384
|
}
|
|
@@ -431,7 +432,7 @@ export interface ConnectWebviewsGetOptions {}
|
|
|
431
432
|
|
|
432
433
|
export type ConnectWebviewsListParameters = {
|
|
433
434
|
/**
|
|
434
|
-
* Custom metadata pairs by which you want to [filter Connect Webviews](https://
|
|
435
|
+
* Custom metadata pairs by which you want to [filter Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.
|
|
435
436
|
*/
|
|
436
437
|
custom_metadata_has?: Record<string, string | boolean> | undefined
|
|
437
438
|
/**
|
|
@@ -172,7 +172,7 @@ export class SeamHttpConnectedAccounts {
|
|
|
172
172
|
}
|
|
173
173
|
|
|
174
174
|
/**
|
|
175
|
-
* Deletes a specified [connected account](https://
|
|
175
|
+
* Deletes a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
176
176
|
*
|
|
177
177
|
* 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.
|
|
178
178
|
*
|
|
@@ -196,7 +196,7 @@ export class SeamHttpConnectedAccounts {
|
|
|
196
196
|
}
|
|
197
197
|
|
|
198
198
|
/**
|
|
199
|
-
* Returns a specified [connected account](https://
|
|
199
|
+
* Returns a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
200
200
|
*/
|
|
201
201
|
get(
|
|
202
202
|
parameters: ConnectedAccountsGetParameters,
|
|
@@ -216,7 +216,7 @@ export class SeamHttpConnectedAccounts {
|
|
|
216
216
|
}
|
|
217
217
|
|
|
218
218
|
/**
|
|
219
|
-
* Returns a list of all [connected accounts](https://
|
|
219
|
+
* Returns a list of all [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
220
220
|
*/
|
|
221
221
|
list(
|
|
222
222
|
parameters?: ConnectedAccountsListParameters,
|
|
@@ -237,7 +237,7 @@ export class SeamHttpConnectedAccounts {
|
|
|
237
237
|
}
|
|
238
238
|
|
|
239
239
|
/**
|
|
240
|
-
* Request a [connected account](https://
|
|
240
|
+
* Request a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.
|
|
241
241
|
*/
|
|
242
242
|
sync(
|
|
243
243
|
parameters: ConnectedAccountsSyncParameters,
|
|
@@ -257,7 +257,7 @@ export class SeamHttpConnectedAccounts {
|
|
|
257
257
|
}
|
|
258
258
|
|
|
259
259
|
/**
|
|
260
|
-
* Updates a [connected account](https://
|
|
260
|
+
* Updates a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
261
261
|
*/
|
|
262
262
|
update(
|
|
263
263
|
parameters: ConnectedAccountsUpdateParameters,
|
|
@@ -392,7 +392,7 @@ export type ConnectedAccountsUpdateParameters = {
|
|
|
392
392
|
>
|
|
393
393
|
| undefined
|
|
394
394
|
/**
|
|
395
|
-
* Indicates whether newly-added devices should appear as [managed devices](https://
|
|
395
|
+
* Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
396
396
|
*/
|
|
397
397
|
automatically_manage_new_devices?: boolean | undefined
|
|
398
398
|
/**
|
|
@@ -401,7 +401,7 @@ export type ConnectedAccountsUpdateParameters = {
|
|
|
401
401
|
connected_account_id: string
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
|
-
* Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a connected account](https://
|
|
404
|
+
* Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a connected account](https://www.seam.co/docs/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://www.seam.co/docs/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
405
405
|
*/
|
|
406
406
|
custom_metadata?: Record<string, string | boolean> | undefined
|
|
407
407
|
/**
|
|
@@ -164,7 +164,7 @@ export class SeamHttpConnectedAccountsSimulate {
|
|
|
164
164
|
}
|
|
165
165
|
|
|
166
166
|
/**
|
|
167
|
-
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://
|
|
167
|
+
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
168
168
|
*/
|
|
169
169
|
disconnect(
|
|
170
170
|
parameters: ConnectedAccountsSimulateDisconnectParameters,
|