@seamapi/http 2.30.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 +103 -86
- 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 +105 -85
- 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
|
@@ -83,7 +83,7 @@ export class SeamHttpAcsUsers {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Adds a specified [access system user](https://
|
|
86
|
+
* 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).
|
|
87
87
|
*/
|
|
88
88
|
addToAccessGroup(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -99,7 +99,7 @@ export class SeamHttpAcsUsers {
|
|
|
99
99
|
});
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* Creates a new [access system user](https://
|
|
102
|
+
* Creates a new [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
103
103
|
*/
|
|
104
104
|
create(parameters, options = {}) {
|
|
105
105
|
return new SeamHttpRequest(this, {
|
|
@@ -115,7 +115,7 @@ export class SeamHttpAcsUsers {
|
|
|
115
115
|
});
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
|
-
* Deletes a specified [access system user](https://
|
|
118
|
+
* 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).
|
|
119
119
|
*/
|
|
120
120
|
delete(parameters, options = {}) {
|
|
121
121
|
return new SeamHttpRequest(this, {
|
|
@@ -135,7 +135,7 @@ export class SeamHttpAcsUsers {
|
|
|
135
135
|
});
|
|
136
136
|
}
|
|
137
137
|
/**
|
|
138
|
-
* Returns a specified [access system user](https://
|
|
138
|
+
* Returns a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
139
139
|
*/
|
|
140
140
|
get(parameters, options = {}) {
|
|
141
141
|
return new SeamHttpRequest(this, {
|
|
@@ -155,7 +155,7 @@ export class SeamHttpAcsUsers {
|
|
|
155
155
|
});
|
|
156
156
|
}
|
|
157
157
|
/**
|
|
158
|
-
* Returns a list of all [access system users](https://
|
|
158
|
+
* Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
159
159
|
*/
|
|
160
160
|
list(parameters, options = {}) {
|
|
161
161
|
return new SeamHttpRequest(this, {
|
|
@@ -172,7 +172,7 @@ export class SeamHttpAcsUsers {
|
|
|
172
172
|
});
|
|
173
173
|
}
|
|
174
174
|
/**
|
|
175
|
-
* Lists the [entrances](https://
|
|
175
|
+
* 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.
|
|
176
176
|
*/
|
|
177
177
|
listAccessibleEntrances(parameters, options = {}) {
|
|
178
178
|
return new SeamHttpRequest(this, {
|
|
@@ -192,7 +192,7 @@ export class SeamHttpAcsUsers {
|
|
|
192
192
|
});
|
|
193
193
|
}
|
|
194
194
|
/**
|
|
195
|
-
* Removes a specified [access system user](https://
|
|
195
|
+
* 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).
|
|
196
196
|
*/
|
|
197
197
|
removeFromAccessGroup(parameters, options = {}) {
|
|
198
198
|
return new SeamHttpRequest(this, {
|
|
@@ -208,7 +208,7 @@ export class SeamHttpAcsUsers {
|
|
|
208
208
|
});
|
|
209
209
|
}
|
|
210
210
|
/**
|
|
211
|
-
* Revokes access to all [entrances](https://
|
|
211
|
+
* 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).
|
|
212
212
|
*/
|
|
213
213
|
revokeAccessToAllEntrances(parameters, options = {}) {
|
|
214
214
|
return new SeamHttpRequest(this, {
|
|
@@ -228,7 +228,7 @@ export class SeamHttpAcsUsers {
|
|
|
228
228
|
});
|
|
229
229
|
}
|
|
230
230
|
/**
|
|
231
|
-
* [Suspends](https://
|
|
231
|
+
* [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.
|
|
232
232
|
*/
|
|
233
233
|
suspend(parameters, options = {}) {
|
|
234
234
|
return new SeamHttpRequest(this, {
|
|
@@ -248,7 +248,7 @@ export class SeamHttpAcsUsers {
|
|
|
248
248
|
});
|
|
249
249
|
}
|
|
250
250
|
/**
|
|
251
|
-
* [Unsuspends](https://
|
|
251
|
+
* [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.
|
|
252
252
|
*/
|
|
253
253
|
unsuspend(parameters, options = {}) {
|
|
254
254
|
return new SeamHttpRequest(this, {
|
|
@@ -268,7 +268,7 @@ export class SeamHttpAcsUsers {
|
|
|
268
268
|
});
|
|
269
269
|
}
|
|
270
270
|
/**
|
|
271
|
-
* Updates the properties of a specified [access system user](https://
|
|
271
|
+
* Updates the properties of a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
272
272
|
*/
|
|
273
273
|
update(parameters, options = {}) {
|
|
274
274
|
return new SeamHttpRequest(this, {
|
|
@@ -16,11 +16,11 @@ export declare class SeamHttpActionAttempts {
|
|
|
16
16
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
17
17
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
18
18
|
/**
|
|
19
|
-
* Returns a specified [action attempt](https://
|
|
19
|
+
* Returns a specified [action attempt](https://www.seam.co/docs/core-concepts/action-attempts).
|
|
20
20
|
*/
|
|
21
21
|
get(parameters: ActionAttemptsGetParameters, options?: ActionAttemptsGetOptions): ActionAttemptsGetRequest;
|
|
22
22
|
/**
|
|
23
|
-
* Returns a list of the [action attempts](https://
|
|
23
|
+
* 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.
|
|
24
24
|
*/
|
|
25
25
|
list(parameters?: ActionAttemptsListParameters, options?: ActionAttemptsListOptions): ActionAttemptsListRequest;
|
|
26
26
|
}
|
|
@@ -83,7 +83,7 @@ export class SeamHttpActionAttempts {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Returns a specified [action attempt](https://
|
|
86
|
+
* Returns a specified [action attempt](https://www.seam.co/docs/core-concepts/action-attempts).
|
|
87
87
|
*/
|
|
88
88
|
get(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -103,7 +103,7 @@ export class SeamHttpActionAttempts {
|
|
|
103
103
|
});
|
|
104
104
|
}
|
|
105
105
|
/**
|
|
106
|
-
* Returns a list of the [action attempts](https://
|
|
106
|
+
* 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.
|
|
107
107
|
*/
|
|
108
108
|
list(parameters, options = {}) {
|
|
109
109
|
return new SeamHttpRequest(this, {
|
|
@@ -17,43 +17,43 @@ export declare class SeamHttpClientSessions {
|
|
|
17
17
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
18
18
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
19
19
|
/**
|
|
20
|
-
* Creates a new [client session](https://
|
|
20
|
+
* Creates a new [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
21
21
|
*/
|
|
22
22
|
create(parameters?: ClientSessionsCreateParameters, options?: ClientSessionsCreateOptions): ClientSessionsCreateRequest;
|
|
23
23
|
/**
|
|
24
|
-
* Deletes a [client session](https://
|
|
24
|
+
* Deletes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
25
25
|
*/
|
|
26
26
|
delete(parameters: ClientSessionsDeleteParameters, options?: ClientSessionsDeleteOptions): ClientSessionsDeleteRequest;
|
|
27
27
|
/**
|
|
28
|
-
* Returns a specified [client session](https://
|
|
28
|
+
* Returns a specified [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
29
29
|
*/
|
|
30
30
|
get(parameters?: ClientSessionsGetParameters, options?: ClientSessionsGetOptions): ClientSessionsGetRequest;
|
|
31
31
|
/**
|
|
32
|
-
* Returns a [client session](https://
|
|
32
|
+
* 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.
|
|
33
33
|
*/
|
|
34
34
|
getOrCreate(parameters?: ClientSessionsGetOrCreateParameters, options?: ClientSessionsGetOrCreateOptions): ClientSessionsGetOrCreateRequest;
|
|
35
35
|
/**
|
|
36
|
-
* Grants a [client session](https://
|
|
36
|
+
* 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.
|
|
37
37
|
*/
|
|
38
38
|
grantAccess(parameters: ClientSessionsGrantAccessParameters, options?: ClientSessionsGrantAccessOptions): ClientSessionsGrantAccessRequest;
|
|
39
39
|
/**
|
|
40
|
-
* Returns a list of all [client sessions](https://
|
|
40
|
+
* Returns a list of all [client sessions](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
41
41
|
*/
|
|
42
42
|
list(parameters?: ClientSessionsListParameters, options?: ClientSessionsListOptions): ClientSessionsListRequest;
|
|
43
43
|
/**
|
|
44
|
-
* Revokes a [client session](https://
|
|
44
|
+
* Revokes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
45
45
|
*
|
|
46
|
-
* Note that [deleting a client session](https://
|
|
46
|
+
* Note that [deleting a client session](https://www.seam.co/docs/api/client_sessions/delete) is a separate action.
|
|
47
47
|
*/
|
|
48
48
|
revoke(parameters: ClientSessionsRevokeParameters, options?: ClientSessionsRevokeOptions): ClientSessionsRevokeRequest;
|
|
49
49
|
}
|
|
50
50
|
export type ClientSessionsCreateParameters = {
|
|
51
51
|
/**
|
|
52
|
-
* IDs of the [Connect Webviews](https://
|
|
52
|
+
* IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) for which you want to create a client session.
|
|
53
53
|
*/
|
|
54
54
|
connect_webview_ids?: Array<string> | undefined;
|
|
55
55
|
/**
|
|
56
|
-
* IDs of the [connected accounts](https://
|
|
56
|
+
* IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) for which you want to create a client session.
|
|
57
57
|
*/
|
|
58
58
|
connected_account_ids?: Array<string> | undefined;
|
|
59
59
|
/**
|
|
@@ -73,11 +73,11 @@ export type ClientSessionsCreateParameters = {
|
|
|
73
73
|
*/
|
|
74
74
|
user_identifier_key?: string | undefined;
|
|
75
75
|
/**
|
|
76
|
-
* ID of the [user identity](https://
|
|
76
|
+
* 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.
|
|
77
77
|
*/
|
|
78
78
|
user_identity_id?: string | undefined;
|
|
79
79
|
/**
|
|
80
|
-
* IDs of the [user identities](https://
|
|
80
|
+
* 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.
|
|
81
81
|
* @deprecated Use `user_identity_id` instead.
|
|
82
82
|
*/
|
|
83
83
|
user_identity_ids?: Array<string> | undefined;
|
|
@@ -125,11 +125,11 @@ export interface ClientSessionsGetOptions {
|
|
|
125
125
|
}
|
|
126
126
|
export type ClientSessionsGetOrCreateParameters = {
|
|
127
127
|
/**
|
|
128
|
-
* IDs of the [Connect Webviews](https://
|
|
128
|
+
* 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).
|
|
129
129
|
*/
|
|
130
130
|
connect_webview_ids?: Array<string> | undefined;
|
|
131
131
|
/**
|
|
132
|
-
* IDs of the [connected accounts](https://
|
|
132
|
+
* 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).
|
|
133
133
|
*/
|
|
134
134
|
connected_account_ids?: Array<string> | undefined;
|
|
135
135
|
/**
|
|
@@ -141,11 +141,11 @@ export type ClientSessionsGetOrCreateParameters = {
|
|
|
141
141
|
*/
|
|
142
142
|
user_identifier_key?: string | undefined;
|
|
143
143
|
/**
|
|
144
|
-
* ID of the [user identity](https://
|
|
144
|
+
* 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).
|
|
145
145
|
*/
|
|
146
146
|
user_identity_id?: string | undefined;
|
|
147
147
|
/**
|
|
148
|
-
* IDs of the [user identities](https://
|
|
148
|
+
* 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.
|
|
149
149
|
* @deprecated Use `user_identity_id`.
|
|
150
150
|
*/
|
|
151
151
|
user_identity_ids?: Array<string> | undefined;
|
|
@@ -165,11 +165,11 @@ export type ClientSessionsGrantAccessParameters = RequireAtLeastOne<{
|
|
|
165
165
|
*/
|
|
166
166
|
client_session_id?: string | undefined;
|
|
167
167
|
/**
|
|
168
|
-
* IDs of the [Connect Webviews](https://
|
|
168
|
+
* IDs of the [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews) that you want to associate with the client session.
|
|
169
169
|
*/
|
|
170
170
|
connect_webview_ids?: Array<string> | undefined;
|
|
171
171
|
/**
|
|
172
|
-
* IDs of the [connected accounts](https://
|
|
172
|
+
* IDs of the [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that you want to associate with the client session.
|
|
173
173
|
*/
|
|
174
174
|
connected_account_ids?: Array<string> | undefined;
|
|
175
175
|
/**
|
|
@@ -177,11 +177,11 @@ export type ClientSessionsGrantAccessParameters = RequireAtLeastOne<{
|
|
|
177
177
|
*/
|
|
178
178
|
user_identifier_key?: string | undefined;
|
|
179
179
|
/**
|
|
180
|
-
* ID of the [user identity](https://
|
|
180
|
+
* 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.
|
|
181
181
|
*/
|
|
182
182
|
user_identity_id?: string | undefined;
|
|
183
183
|
/**
|
|
184
|
-
* IDs of the [user identities](https://
|
|
184
|
+
* 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.
|
|
185
185
|
* @deprecated Use `user_identity_id`.
|
|
186
186
|
*/
|
|
187
187
|
user_identity_ids?: Array<string> | undefined;
|
|
@@ -199,7 +199,7 @@ export type ClientSessionsListParameters = {
|
|
|
199
199
|
*/
|
|
200
200
|
client_session_id?: string | undefined;
|
|
201
201
|
/**
|
|
202
|
-
* ID of the [Connect Webview](https://
|
|
202
|
+
* 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.
|
|
203
203
|
*/
|
|
204
204
|
connect_webview_id?: string | null | undefined;
|
|
205
205
|
/**
|
|
@@ -207,7 +207,7 @@ export type ClientSessionsListParameters = {
|
|
|
207
207
|
*/
|
|
208
208
|
user_identifier_key?: string | undefined;
|
|
209
209
|
/**
|
|
210
|
-
* ID of the [user identity](https://
|
|
210
|
+
* 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.
|
|
211
211
|
*/
|
|
212
212
|
user_identity_id?: string | null | undefined;
|
|
213
213
|
/**
|
|
@@ -82,7 +82,7 @@ export class SeamHttpClientSessions {
|
|
|
82
82
|
await clientSessions.get();
|
|
83
83
|
}
|
|
84
84
|
/**
|
|
85
|
-
* Creates a new [client session](https://
|
|
85
|
+
* Creates a new [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
86
86
|
*/
|
|
87
87
|
create(parameters, options = {}) {
|
|
88
88
|
return new SeamHttpRequest(this, {
|
|
@@ -98,7 +98,7 @@ export class SeamHttpClientSessions {
|
|
|
98
98
|
});
|
|
99
99
|
}
|
|
100
100
|
/**
|
|
101
|
-
* Deletes a [client session](https://
|
|
101
|
+
* Deletes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
102
102
|
*/
|
|
103
103
|
delete(parameters, options = {}) {
|
|
104
104
|
return new SeamHttpRequest(this, {
|
|
@@ -114,7 +114,7 @@ export class SeamHttpClientSessions {
|
|
|
114
114
|
});
|
|
115
115
|
}
|
|
116
116
|
/**
|
|
117
|
-
* Returns a specified [client session](https://
|
|
117
|
+
* Returns a specified [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
118
118
|
*/
|
|
119
119
|
get(parameters, options = {}) {
|
|
120
120
|
return new SeamHttpRequest(this, {
|
|
@@ -130,7 +130,7 @@ export class SeamHttpClientSessions {
|
|
|
130
130
|
});
|
|
131
131
|
}
|
|
132
132
|
/**
|
|
133
|
-
* Returns a [client session](https://
|
|
133
|
+
* 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.
|
|
134
134
|
*/
|
|
135
135
|
getOrCreate(parameters, options = {}) {
|
|
136
136
|
return new SeamHttpRequest(this, {
|
|
@@ -146,7 +146,7 @@ export class SeamHttpClientSessions {
|
|
|
146
146
|
});
|
|
147
147
|
}
|
|
148
148
|
/**
|
|
149
|
-
* Grants a [client session](https://
|
|
149
|
+
* 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.
|
|
150
150
|
*/
|
|
151
151
|
grantAccess(parameters, options = {}) {
|
|
152
152
|
return new SeamHttpRequest(this, {
|
|
@@ -169,7 +169,7 @@ export class SeamHttpClientSessions {
|
|
|
169
169
|
});
|
|
170
170
|
}
|
|
171
171
|
/**
|
|
172
|
-
* Returns a list of all [client sessions](https://
|
|
172
|
+
* Returns a list of all [client sessions](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
173
173
|
*/
|
|
174
174
|
list(parameters, options = {}) {
|
|
175
175
|
return new SeamHttpRequest(this, {
|
|
@@ -185,9 +185,9 @@ export class SeamHttpClientSessions {
|
|
|
185
185
|
});
|
|
186
186
|
}
|
|
187
187
|
/**
|
|
188
|
-
* Revokes a [client session](https://
|
|
188
|
+
* Revokes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
189
189
|
*
|
|
190
|
-
* Note that [deleting a client session](https://
|
|
190
|
+
* Note that [deleting a client session](https://www.seam.co/docs/api/client_sessions/delete) is a separate action.
|
|
191
191
|
*/
|
|
192
192
|
revoke(parameters, options = {}) {
|
|
193
193
|
return new SeamHttpRequest(this, {
|
|
@@ -16,29 +16,29 @@ export declare class SeamHttpConnectWebviews {
|
|
|
16
16
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
17
17
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
18
18
|
/**
|
|
19
|
-
* Creates a new [Connect Webview](https://
|
|
19
|
+
* Creates a new [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
20
20
|
*
|
|
21
21
|
* 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.
|
|
22
22
|
*
|
|
23
23
|
* 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.
|
|
24
24
|
*
|
|
25
|
-
* See also: [Connect Webview Process](https://
|
|
25
|
+
* See also: [Connect Webview Process](https://www.seam.co/docs/core-concepts/connect-webviews/connect-webview-process).
|
|
26
26
|
*/
|
|
27
27
|
create(parameters?: ConnectWebviewsCreateParameters, options?: ConnectWebviewsCreateOptions): ConnectWebviewsCreateRequest;
|
|
28
28
|
/**
|
|
29
|
-
* Deletes a [Connect Webview](https://
|
|
29
|
+
* Deletes a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
30
30
|
*
|
|
31
31
|
* You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.
|
|
32
32
|
*/
|
|
33
33
|
delete(parameters: ConnectWebviewsDeleteParameters, options?: ConnectWebviewsDeleteOptions): ConnectWebviewsDeleteRequest;
|
|
34
34
|
/**
|
|
35
|
-
* Returns a specified [Connect Webview](https://
|
|
35
|
+
* Returns a specified [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
36
36
|
*
|
|
37
37
|
* 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.
|
|
38
38
|
*/
|
|
39
39
|
get(parameters: ConnectWebviewsGetParameters, options?: ConnectWebviewsGetOptions): ConnectWebviewsGetRequest;
|
|
40
40
|
/**
|
|
41
|
-
* Returns a list of all [Connect Webviews](https://
|
|
41
|
+
* Returns a list of all [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
42
42
|
*/
|
|
43
43
|
list(parameters?: ConnectWebviewsListParameters, options?: ConnectWebviewsListOptions): ConnectWebviewsListRequest;
|
|
44
44
|
}
|
|
@@ -48,15 +48,15 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
48
48
|
*/
|
|
49
49
|
accepted_capabilities?: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera'> | undefined;
|
|
50
50
|
/**
|
|
51
|
-
* 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://
|
|
51
|
+
* 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.
|
|
52
52
|
*/
|
|
53
|
-
accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack'> | undefined;
|
|
53
|
+
accepted_providers?: Array<'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack'> | undefined;
|
|
54
54
|
/**
|
|
55
|
-
* Indicates whether newly-added devices should appear as [managed devices](https://
|
|
55
|
+
* 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).
|
|
56
56
|
*/
|
|
57
57
|
automatically_manage_new_devices?: boolean | undefined;
|
|
58
58
|
/**
|
|
59
|
-
* 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://
|
|
59
|
+
* 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.
|
|
60
60
|
*/
|
|
61
61
|
custom_metadata?: Record<string, string | boolean> | undefined;
|
|
62
62
|
/**
|
|
@@ -76,11 +76,11 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
76
76
|
*/
|
|
77
77
|
excluded_providers?: Array<string> | undefined;
|
|
78
78
|
/**
|
|
79
|
-
* Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://
|
|
79
|
+
* 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.
|
|
80
80
|
*/
|
|
81
81
|
provider_category?: 'stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta' | undefined;
|
|
82
82
|
/**
|
|
83
|
-
* 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://
|
|
83
|
+
* 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).
|
|
84
84
|
*/
|
|
85
85
|
wait_for_device_creation?: boolean | undefined;
|
|
86
86
|
};
|
|
@@ -123,7 +123,7 @@ export interface ConnectWebviewsGetOptions {
|
|
|
123
123
|
}
|
|
124
124
|
export type ConnectWebviewsListParameters = {
|
|
125
125
|
/**
|
|
126
|
-
* Custom metadata pairs by which you want to [filter Connect Webviews](https://
|
|
126
|
+
* 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.
|
|
127
127
|
*/
|
|
128
128
|
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
129
129
|
/**
|
|
@@ -83,13 +83,13 @@ export class SeamHttpConnectWebviews {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Creates a new [Connect Webview](https://
|
|
86
|
+
* Creates a new [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
87
87
|
*
|
|
88
88
|
* 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.
|
|
89
89
|
*
|
|
90
90
|
* 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.
|
|
91
91
|
*
|
|
92
|
-
* See also: [Connect Webview Process](https://
|
|
92
|
+
* See also: [Connect Webview Process](https://www.seam.co/docs/core-concepts/connect-webviews/connect-webview-process).
|
|
93
93
|
*/
|
|
94
94
|
create(parameters, options = {}) {
|
|
95
95
|
return new SeamHttpRequest(this, {
|
|
@@ -105,7 +105,7 @@ export class SeamHttpConnectWebviews {
|
|
|
105
105
|
});
|
|
106
106
|
}
|
|
107
107
|
/**
|
|
108
|
-
* Deletes a [Connect Webview](https://
|
|
108
|
+
* Deletes a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
109
109
|
*
|
|
110
110
|
* You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.
|
|
111
111
|
*/
|
|
@@ -123,7 +123,7 @@ export class SeamHttpConnectWebviews {
|
|
|
123
123
|
});
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
* Returns a specified [Connect Webview](https://
|
|
126
|
+
* Returns a specified [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
127
127
|
*
|
|
128
128
|
* 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.
|
|
129
129
|
*/
|
|
@@ -141,7 +141,7 @@ export class SeamHttpConnectWebviews {
|
|
|
141
141
|
});
|
|
142
142
|
}
|
|
143
143
|
/**
|
|
144
|
-
* Returns a list of all [Connect Webviews](https://
|
|
144
|
+
* Returns a list of all [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
145
145
|
*/
|
|
146
146
|
list(parameters, options = {}) {
|
|
147
147
|
return new SeamHttpRequest(this, {
|
|
@@ -19,7 +19,7 @@ export declare class SeamHttpConnectedAccounts {
|
|
|
19
19
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
20
20
|
get simulate(): SeamHttpConnectedAccountsSimulate;
|
|
21
21
|
/**
|
|
22
|
-
* Deletes a specified [connected account](https://
|
|
22
|
+
* Deletes a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
23
23
|
*
|
|
24
24
|
* 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.
|
|
25
25
|
*
|
|
@@ -27,19 +27,19 @@ export declare class SeamHttpConnectedAccounts {
|
|
|
27
27
|
*/
|
|
28
28
|
delete(parameters: ConnectedAccountsDeleteParameters, options?: ConnectedAccountsDeleteOptions): ConnectedAccountsDeleteRequest;
|
|
29
29
|
/**
|
|
30
|
-
* Returns a specified [connected account](https://
|
|
30
|
+
* Returns a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
31
31
|
*/
|
|
32
32
|
get(parameters: ConnectedAccountsGetParameters, options?: ConnectedAccountsGetOptions): ConnectedAccountsGetRequest;
|
|
33
33
|
/**
|
|
34
|
-
* Returns a list of all [connected accounts](https://
|
|
34
|
+
* Returns a list of all [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
35
35
|
*/
|
|
36
36
|
list(parameters?: ConnectedAccountsListParameters, options?: ConnectedAccountsListOptions): ConnectedAccountsListRequest;
|
|
37
37
|
/**
|
|
38
|
-
* Request a [connected account](https://
|
|
38
|
+
* Request a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.
|
|
39
39
|
*/
|
|
40
40
|
sync(parameters: ConnectedAccountsSyncParameters, options?: ConnectedAccountsSyncOptions): ConnectedAccountsSyncRequest;
|
|
41
41
|
/**
|
|
42
|
-
* Updates a [connected account](https://
|
|
42
|
+
* Updates a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
43
43
|
*/
|
|
44
44
|
update(parameters: ConnectedAccountsUpdateParameters, options?: ConnectedAccountsUpdateOptions): ConnectedAccountsUpdateRequest;
|
|
45
45
|
}
|
|
@@ -133,7 +133,7 @@ export type ConnectedAccountsUpdateParameters = {
|
|
|
133
133
|
*/
|
|
134
134
|
accepted_capabilities?: Array<'lock' | 'thermostat' | 'noise_sensor' | 'access_control' | 'camera'> | undefined;
|
|
135
135
|
/**
|
|
136
|
-
* Indicates whether newly-added devices should appear as [managed devices](https://
|
|
136
|
+
* Indicates whether newly-added devices should appear as [managed devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
137
137
|
*/
|
|
138
138
|
automatically_manage_new_devices?: boolean | undefined;
|
|
139
139
|
/**
|
|
@@ -141,7 +141,7 @@ export type ConnectedAccountsUpdateParameters = {
|
|
|
141
141
|
*/
|
|
142
142
|
connected_account_id: string;
|
|
143
143
|
/**
|
|
144
|
-
* 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://
|
|
144
|
+
* 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.
|
|
145
145
|
*/
|
|
146
146
|
custom_metadata?: Record<string, string | boolean> | undefined;
|
|
147
147
|
/**
|
|
@@ -87,7 +87,7 @@ export class SeamHttpConnectedAccounts {
|
|
|
87
87
|
return SeamHttpConnectedAccountsSimulate.fromClient(this.client, this.defaults);
|
|
88
88
|
}
|
|
89
89
|
/**
|
|
90
|
-
* Deletes a specified [connected account](https://
|
|
90
|
+
* Deletes a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
91
91
|
*
|
|
92
92
|
* 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.
|
|
93
93
|
*
|
|
@@ -107,7 +107,7 @@ export class SeamHttpConnectedAccounts {
|
|
|
107
107
|
});
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
110
|
-
* Returns a specified [connected account](https://
|
|
110
|
+
* Returns a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
111
111
|
*/
|
|
112
112
|
get(parameters, options = {}) {
|
|
113
113
|
return new SeamHttpRequest(this, {
|
|
@@ -123,7 +123,7 @@ export class SeamHttpConnectedAccounts {
|
|
|
123
123
|
});
|
|
124
124
|
}
|
|
125
125
|
/**
|
|
126
|
-
* Returns a list of all [connected accounts](https://
|
|
126
|
+
* Returns a list of all [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
127
127
|
*/
|
|
128
128
|
list(parameters, options = {}) {
|
|
129
129
|
return new SeamHttpRequest(this, {
|
|
@@ -140,7 +140,7 @@ export class SeamHttpConnectedAccounts {
|
|
|
140
140
|
});
|
|
141
141
|
}
|
|
142
142
|
/**
|
|
143
|
-
* Request a [connected account](https://
|
|
143
|
+
* Request a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.
|
|
144
144
|
*/
|
|
145
145
|
sync(parameters, options = {}) {
|
|
146
146
|
return new SeamHttpRequest(this, {
|
|
@@ -156,7 +156,7 @@ export class SeamHttpConnectedAccounts {
|
|
|
156
156
|
});
|
|
157
157
|
}
|
|
158
158
|
/**
|
|
159
|
-
* Updates a [connected account](https://
|
|
159
|
+
* Updates a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
160
160
|
*/
|
|
161
161
|
update(parameters, options = {}) {
|
|
162
162
|
return new SeamHttpRequest(this, {
|
|
@@ -15,7 +15,7 @@ export declare class SeamHttpConnectedAccountsSimulate {
|
|
|
15
15
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
16
16
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
17
17
|
/**
|
|
18
|
-
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://
|
|
18
|
+
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
19
19
|
*/
|
|
20
20
|
disconnect(parameters: ConnectedAccountsSimulateDisconnectParameters, options?: ConnectedAccountsSimulateDisconnectOptions): ConnectedAccountsSimulateDisconnectRequest;
|
|
21
21
|
}
|
|
@@ -83,7 +83,7 @@ export class SeamHttpConnectedAccountsSimulate {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://
|
|
86
|
+
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
87
87
|
*/
|
|
88
88
|
disconnect(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|