@seamapi/http 2.1.0 → 2.2.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/seam/connect/resources/access-code.d.ts +743 -56
- package/lib/seam/connect/resources/access-grant.d.ts +279 -10
- package/lib/seam/connect/resources/access-method.d.ts +204 -8
- package/lib/seam/connect/resources/acs-access-group.d.ts +242 -9
- package/lib/seam/connect/resources/acs-credential.d.ts +212 -6
- package/lib/seam/connect/resources/acs-encoder.d.ts +46 -0
- package/lib/seam/connect/resources/acs-entrance.d.ts +298 -5
- package/lib/seam/connect/resources/acs-system.d.ts +227 -11
- package/lib/seam/connect/resources/acs-user.d.ts +388 -19
- package/lib/seam/connect/resources/action-attempt.d.ts +954 -0
- package/lib/seam/connect/resources/batch.d.ts +3 -0
- package/lib/seam/connect/resources/client-session.d.ts +48 -0
- package/lib/seam/connect/resources/connect-webview.d.ts +70 -0
- package/lib/seam/connect/resources/connected-account.d.ts +281 -12
- package/lib/seam/connect/resources/customer-portal.d.ts +22 -0
- package/lib/seam/connect/resources/device-provider.d.ts +72 -0
- package/lib/seam/connect/resources/device.d.ts +2063 -41
- package/lib/seam/connect/resources/event.d.ts +4014 -0
- package/lib/seam/connect/resources/instant-key.d.ts +41 -0
- package/lib/seam/connect/resources/noise-threshold.d.ts +24 -0
- package/lib/seam/connect/resources/phone.d.ts +72 -0
- package/lib/seam/connect/resources/space.d.ts +54 -0
- package/lib/seam/connect/resources/thermostat-daily-program.d.ts +27 -0
- package/lib/seam/connect/resources/thermostat-schedule.d.ts +45 -0
- package/lib/seam/connect/resources/unmanaged-access-code.d.ts +602 -50
- package/lib/seam/connect/resources/unmanaged-access-grant.d.ts +267 -10
- package/lib/seam/connect/resources/unmanaged-access-method.d.ts +195 -8
- package/lib/seam/connect/resources/unmanaged-device.d.ts +810 -120
- package/lib/seam/connect/resources/unmanaged-user-identity.d.ts +79 -3
- package/lib/seam/connect/resources/user-identity.d.ts +82 -3
- package/lib/seam/connect/resources/webhook.d.ts +15 -0
- package/lib/seam/connect/resources/workspace.d.ts +45 -0
- package/lib/seam/connect/routes/access-codes/access-codes.d.ts +288 -0
- package/lib/seam/connect/routes/access-codes/access-codes.js +60 -0
- package/lib/seam/connect/routes/access-codes/access-codes.js.map +1 -1
- package/lib/seam/connect/routes/access-codes/simulate/simulate.d.ts +12 -0
- package/lib/seam/connect/routes/access-codes/simulate/simulate.js +3 -0
- package/lib/seam/connect/routes/access-codes/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/access-codes/unmanaged/unmanaged.d.ts +72 -0
- package/lib/seam/connect/routes/access-codes/unmanaged/unmanaged.js +21 -0
- package/lib/seam/connect/routes/access-codes/unmanaged/unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/access-grants/access-grants.d.ts +177 -0
- package/lib/seam/connect/routes/access-grants/access-grants.js +21 -0
- package/lib/seam/connect/routes/access-grants/access-grants.js.map +1 -1
- package/lib/seam/connect/routes/access-grants/unmanaged/unmanaged.d.ts +43 -0
- package/lib/seam/connect/routes/access-grants/unmanaged/unmanaged.js +13 -0
- package/lib/seam/connect/routes/access-grants/unmanaged/unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/access-methods/access-methods.d.ts +78 -0
- package/lib/seam/connect/routes/access-methods/access-methods.js +21 -0
- package/lib/seam/connect/routes/access-methods/access-methods.js.map +1 -1
- package/lib/seam/connect/routes/access-methods/unmanaged/unmanaged.d.ts +21 -0
- package/lib/seam/connect/routes/access-methods/unmanaged/unmanaged.js +6 -0
- package/lib/seam/connect/routes/access-methods/unmanaged/unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/acs/access-groups/access-groups.d.ts +63 -0
- package/lib/seam/connect/routes/acs/access-groups/access-groups.js +21 -0
- package/lib/seam/connect/routes/acs/access-groups/access-groups.js.map +1 -1
- package/lib/seam/connect/routes/acs/credentials/credentials.d.ts +126 -0
- package/lib/seam/connect/routes/acs/credentials/credentials.js +24 -0
- package/lib/seam/connect/routes/acs/credentials/credentials.js.map +1 -1
- package/lib/seam/connect/routes/acs/encoders/encoders.d.ts +66 -0
- package/lib/seam/connect/routes/acs/encoders/encoders.js +15 -0
- package/lib/seam/connect/routes/acs/encoders/encoders.js.map +1 -1
- package/lib/seam/connect/routes/acs/encoders/simulate/simulate.d.ts +39 -0
- package/lib/seam/connect/routes/acs/encoders/simulate/simulate.js +12 -0
- package/lib/seam/connect/routes/acs/encoders/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/acs/entrances/entrances.d.ts +72 -0
- package/lib/seam/connect/routes/acs/entrances/entrances.js +15 -0
- package/lib/seam/connect/routes/acs/entrances/entrances.js.map +1 -1
- package/lib/seam/connect/routes/acs/systems/systems.d.ts +64 -0
- package/lib/seam/connect/routes/acs/systems/systems.js +16 -0
- package/lib/seam/connect/routes/acs/systems/systems.js.map +1 -1
- package/lib/seam/connect/routes/acs/users/users.d.ts +189 -0
- package/lib/seam/connect/routes/acs/users/users.js +33 -0
- package/lib/seam/connect/routes/acs/users/users.js.map +1 -1
- package/lib/seam/connect/routes/action-attempts/action-attempts.d.ts +21 -0
- package/lib/seam/connect/routes/action-attempts/action-attempts.js +6 -0
- package/lib/seam/connect/routes/action-attempts/action-attempts.js.map +1 -1
- package/lib/seam/connect/routes/client-sessions/client-sessions.d.ts +113 -0
- package/lib/seam/connect/routes/client-sessions/client-sessions.js +23 -0
- package/lib/seam/connect/routes/client-sessions/client-sessions.js.map +1 -1
- package/lib/seam/connect/routes/connect-webviews/connect-webviews.d.ts +76 -0
- package/lib/seam/connect/routes/connect-webviews/connect-webviews.js +22 -0
- package/lib/seam/connect/routes/connect-webviews/connect-webviews.js.map +1 -1
- package/lib/seam/connect/routes/connected-accounts/connected-accounts.d.ts +70 -0
- package/lib/seam/connect/routes/connected-accounts/connected-accounts.js +19 -0
- package/lib/seam/connect/routes/connected-accounts/connected-accounts.js.map +1 -1
- package/lib/seam/connect/routes/connected-accounts/simulate/simulate.d.ts +6 -0
- package/lib/seam/connect/routes/connected-accounts/simulate/simulate.js +3 -0
- package/lib/seam/connect/routes/connected-accounts/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/customers/customers.d.ts +1042 -0
- package/lib/seam/connect/routes/customers/customers.js +10 -0
- package/lib/seam/connect/routes/customers/customers.js.map +1 -1
- package/lib/seam/connect/routes/devices/devices.d.ts +122 -0
- package/lib/seam/connect/routes/devices/devices.js +23 -0
- package/lib/seam/connect/routes/devices/devices.js.map +1 -1
- package/lib/seam/connect/routes/devices/simulate/simulate.d.ts +42 -0
- package/lib/seam/connect/routes/devices/simulate/simulate.js +27 -0
- package/lib/seam/connect/routes/devices/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/devices/unmanaged/unmanaged.d.ts +80 -0
- package/lib/seam/connect/routes/devices/unmanaged/unmanaged.js +17 -0
- package/lib/seam/connect/routes/devices/unmanaged/unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/events/events.d.ts +99 -0
- package/lib/seam/connect/routes/events/events.js +6 -0
- package/lib/seam/connect/routes/events/events.js.map +1 -1
- package/lib/seam/connect/routes/instant-keys/instant-keys.d.ts +21 -0
- package/lib/seam/connect/routes/instant-keys/instant-keys.js +9 -0
- package/lib/seam/connect/routes/instant-keys/instant-keys.js.map +1 -1
- package/lib/seam/connect/routes/locks/locks.d.ts +85 -0
- package/lib/seam/connect/routes/locks/locks.js +16 -0
- package/lib/seam/connect/routes/locks/locks.js.map +1 -1
- package/lib/seam/connect/routes/locks/simulate/simulate.d.ts +15 -0
- package/lib/seam/connect/routes/locks/simulate/simulate.js +6 -0
- package/lib/seam/connect/routes/locks/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/noise-sensors/noise-sensors.d.ts +51 -0
- package/lib/seam/connect/routes/noise-sensors/noise-sensors.js +3 -0
- package/lib/seam/connect/routes/noise-sensors/noise-sensors.js.map +1 -1
- package/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +66 -0
- package/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.js +15 -0
- package/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.js.map +1 -1
- package/lib/seam/connect/routes/noise-sensors/simulate/simulate.d.ts +6 -0
- package/lib/seam/connect/routes/noise-sensors/simulate/simulate.js +3 -0
- package/lib/seam/connect/routes/noise-sensors/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/phones/phones.d.ts +21 -0
- package/lib/seam/connect/routes/phones/phones.js +9 -0
- package/lib/seam/connect/routes/phones/phones.js.map +1 -1
- package/lib/seam/connect/routes/phones/simulate/simulate.d.ts +45 -0
- package/lib/seam/connect/routes/phones/simulate/simulate.js +3 -0
- package/lib/seam/connect/routes/phones/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/seam-http-endpoints-without-workspace.d.ts +6 -0
- package/lib/seam/connect/routes/seam-http-endpoints-without-workspace.js +6 -0
- package/lib/seam/connect/routes/seam-http-endpoints-without-workspace.js.map +1 -1
- package/lib/seam/connect/routes/seam-http-endpoints.d.ts +696 -0
- package/lib/seam/connect/routes/seam-http-endpoints.js +696 -0
- package/lib/seam/connect/routes/seam-http-endpoints.js.map +1 -1
- package/lib/seam/connect/routes/spaces/spaces.d.ts +165 -0
- package/lib/seam/connect/routes/spaces/spaces.js +36 -0
- package/lib/seam/connect/routes/spaces/spaces.js.map +1 -1
- package/lib/seam/connect/routes/thermostats/daily-programs/daily-programs.d.ts +42 -0
- package/lib/seam/connect/routes/thermostats/daily-programs/daily-programs.js +9 -0
- package/lib/seam/connect/routes/thermostats/daily-programs/daily-programs.js.map +1 -1
- package/lib/seam/connect/routes/thermostats/schedules/schedules.d.ts +69 -0
- package/lib/seam/connect/routes/thermostats/schedules/schedules.js +15 -0
- package/lib/seam/connect/routes/thermostats/schedules/schedules.js.map +1 -1
- package/lib/seam/connect/routes/thermostats/simulate/simulate.d.ts +33 -0
- package/lib/seam/connect/routes/thermostats/simulate/simulate.js +6 -0
- package/lib/seam/connect/routes/thermostats/simulate/simulate.js.map +1 -1
- package/lib/seam/connect/routes/thermostats/thermostats.d.ts +300 -0
- package/lib/seam/connect/routes/thermostats/thermostats.js +42 -0
- package/lib/seam/connect/routes/thermostats/thermostats.js.map +1 -1
- package/lib/seam/connect/routes/user-identities/unmanaged/unmanaged.d.ts +35 -0
- package/lib/seam/connect/routes/user-identities/unmanaged/unmanaged.js +11 -0
- package/lib/seam/connect/routes/user-identities/unmanaged/unmanaged.js.map +1 -1
- package/lib/seam/connect/routes/user-identities/user-identities.d.ts +145 -0
- package/lib/seam/connect/routes/user-identities/user-identities.js +46 -0
- package/lib/seam/connect/routes/user-identities/user-identities.js.map +1 -1
- package/lib/seam/connect/routes/webhooks/webhooks.d.ts +33 -0
- package/lib/seam/connect/routes/webhooks/webhooks.js +15 -0
- package/lib/seam/connect/routes/webhooks/webhooks.js.map +1 -1
- package/lib/seam/connect/routes/workspaces/workspaces.d.ts +88 -0
- package/lib/seam/connect/routes/workspaces/workspaces.js +15 -0
- package/lib/seam/connect/routes/workspaces/workspaces.js.map +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/resources/access-code.ts +719 -35
- package/src/lib/seam/connect/resources/access-grant.ts +284 -16
- package/src/lib/seam/connect/resources/access-method.ts +205 -10
- package/src/lib/seam/connect/resources/acs-access-group.ts +247 -14
- package/src/lib/seam/connect/resources/acs-credential.ts +210 -5
- package/src/lib/seam/connect/resources/acs-encoder.ts +46 -0
- package/src/lib/seam/connect/resources/acs-entrance.ts +296 -4
- package/src/lib/seam/connect/resources/acs-system.ts +223 -9
- package/src/lib/seam/connect/resources/acs-user.ts +382 -16
- package/src/lib/seam/connect/resources/action-attempt.ts +956 -0
- package/src/lib/seam/connect/resources/batch.ts +3 -0
- package/src/lib/seam/connect/resources/client-session.ts +48 -0
- package/src/lib/seam/connect/resources/connect-webview.ts +70 -0
- package/src/lib/seam/connect/resources/connected-account.ts +277 -10
- package/src/lib/seam/connect/resources/customer-portal.ts +22 -0
- package/src/lib/seam/connect/resources/device-provider.ts +72 -0
- package/src/lib/seam/connect/resources/device.ts +2059 -39
- package/src/lib/seam/connect/resources/event.ts +4015 -0
- package/src/lib/seam/connect/resources/instant-key.ts +41 -0
- package/src/lib/seam/connect/resources/noise-threshold.ts +24 -0
- package/src/lib/seam/connect/resources/phone.ts +72 -0
- package/src/lib/seam/connect/resources/space.ts +54 -0
- package/src/lib/seam/connect/resources/thermostat-daily-program.ts +27 -0
- package/src/lib/seam/connect/resources/thermostat-schedule.ts +45 -0
- package/src/lib/seam/connect/resources/unmanaged-access-code.ts +580 -30
- package/src/lib/seam/connect/resources/unmanaged-access-grant.ts +272 -16
- package/src/lib/seam/connect/resources/unmanaged-access-method.ts +196 -10
- package/src/lib/seam/connect/resources/unmanaged-device.ts +727 -39
- package/src/lib/seam/connect/resources/unmanaged-user-identity.ts +84 -8
- package/src/lib/seam/connect/resources/user-identity.ts +87 -8
- package/src/lib/seam/connect/resources/webhook.ts +15 -0
- package/src/lib/seam/connect/resources/workspace.ts +46 -0
- package/src/lib/seam/connect/routes/access-codes/access-codes.ts +291 -0
- package/src/lib/seam/connect/routes/access-codes/simulate/simulate.ts +12 -0
- package/src/lib/seam/connect/routes/access-codes/unmanaged/unmanaged.ts +73 -0
- package/src/lib/seam/connect/routes/access-grants/access-grants.ts +180 -0
- package/src/lib/seam/connect/routes/access-grants/unmanaged/unmanaged.ts +43 -0
- package/src/lib/seam/connect/routes/access-methods/access-methods.ts +79 -0
- package/src/lib/seam/connect/routes/access-methods/unmanaged/unmanaged.ts +21 -0
- package/src/lib/seam/connect/routes/acs/access-groups/access-groups.ts +63 -0
- package/src/lib/seam/connect/routes/acs/credentials/credentials.ts +133 -0
- package/src/lib/seam/connect/routes/acs/encoders/encoders.ts +66 -0
- package/src/lib/seam/connect/routes/acs/encoders/simulate/simulate.ts +40 -0
- package/src/lib/seam/connect/routes/acs/entrances/entrances.ts +72 -0
- package/src/lib/seam/connect/routes/acs/systems/systems.ts +64 -0
- package/src/lib/seam/connect/routes/acs/users/users.ts +189 -0
- package/src/lib/seam/connect/routes/action-attempts/action-attempts.ts +21 -0
- package/src/lib/seam/connect/routes/client-sessions/client-sessions.ts +113 -0
- package/src/lib/seam/connect/routes/connect-webviews/connect-webviews.ts +76 -0
- package/src/lib/seam/connect/routes/connected-accounts/connected-accounts.ts +70 -0
- package/src/lib/seam/connect/routes/connected-accounts/simulate/simulate.ts +6 -0
- package/src/lib/seam/connect/routes/customers/customers.ts +1058 -0
- package/src/lib/seam/connect/routes/devices/devices.ts +123 -0
- package/src/lib/seam/connect/routes/devices/simulate/simulate.ts +42 -0
- package/src/lib/seam/connect/routes/devices/unmanaged/unmanaged.ts +80 -0
- package/src/lib/seam/connect/routes/events/events.ts +99 -0
- package/src/lib/seam/connect/routes/instant-keys/instant-keys.ts +21 -0
- package/src/lib/seam/connect/routes/locks/locks.ts +85 -0
- package/src/lib/seam/connect/routes/locks/simulate/simulate.ts +15 -0
- package/src/lib/seam/connect/routes/noise-sensors/noise-sensors.ts +51 -0
- package/src/lib/seam/connect/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +66 -0
- package/src/lib/seam/connect/routes/noise-sensors/simulate/simulate.ts +6 -0
- package/src/lib/seam/connect/routes/phones/phones.ts +21 -0
- package/src/lib/seam/connect/routes/phones/simulate/simulate.ts +45 -0
- package/src/lib/seam/connect/routes/seam-http-endpoints-without-workspace.ts +6 -0
- package/src/lib/seam/connect/routes/seam-http-endpoints.ts +696 -0
- package/src/lib/seam/connect/routes/spaces/spaces.ts +166 -0
- package/src/lib/seam/connect/routes/thermostats/daily-programs/daily-programs.ts +42 -0
- package/src/lib/seam/connect/routes/thermostats/schedules/schedules.ts +69 -0
- package/src/lib/seam/connect/routes/thermostats/simulate/simulate.ts +33 -0
- package/src/lib/seam/connect/routes/thermostats/thermostats.ts +300 -0
- package/src/lib/seam/connect/routes/user-identities/unmanaged/unmanaged.ts +35 -0
- package/src/lib/seam/connect/routes/user-identities/user-identities.ts +146 -0
- package/src/lib/seam/connect/routes/webhooks/webhooks.ts +33 -0
- package/src/lib/seam/connect/routes/workspaces/workspaces.ts +88 -0
- package/src/lib/version.ts +1 -1
|
@@ -175,6 +175,13 @@ export class SeamHttpUserIdentities {
|
|
|
175
175
|
)
|
|
176
176
|
}
|
|
177
177
|
|
|
178
|
+
/**
|
|
179
|
+
* Adds a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
180
|
+
*
|
|
181
|
+
* You must specify either `user_identity_id` or `user_identity_key` to identify the user identity.
|
|
182
|
+
*
|
|
183
|
+
* If `user_identity_key` is provided, but the user identity doesn't exist, a new user identity will be created automatically using information from the ACS user.
|
|
184
|
+
*/
|
|
178
185
|
addAcsUser(
|
|
179
186
|
parameters: UserIdentitiesAddAcsUserParameters,
|
|
180
187
|
options: UserIdentitiesAddAcsUserOptions = {},
|
|
@@ -188,6 +195,9 @@ export class SeamHttpUserIdentities {
|
|
|
188
195
|
})
|
|
189
196
|
}
|
|
190
197
|
|
|
198
|
+
/**
|
|
199
|
+
* Creates a new [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
200
|
+
*/
|
|
191
201
|
create(
|
|
192
202
|
parameters?: UserIdentitiesCreateParameters,
|
|
193
203
|
options: UserIdentitiesCreateOptions = {},
|
|
@@ -201,6 +211,9 @@ export class SeamHttpUserIdentities {
|
|
|
201
211
|
})
|
|
202
212
|
}
|
|
203
213
|
|
|
214
|
+
/**
|
|
215
|
+
* Deletes a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://docs.seam.co/api/acs/credentials), [acs users](https://docs.seam.co/api/acs/users) and [client sessions](https://docs.seam.co/api/client_sessions).
|
|
216
|
+
*/
|
|
204
217
|
delete(
|
|
205
218
|
parameters: UserIdentitiesDeleteParameters,
|
|
206
219
|
options: UserIdentitiesDeleteOptions = {},
|
|
@@ -214,6 +227,9 @@ export class SeamHttpUserIdentities {
|
|
|
214
227
|
})
|
|
215
228
|
}
|
|
216
229
|
|
|
230
|
+
/**
|
|
231
|
+
* Generates a new [instant key](https://docs.seam.co/capability-guides/instant-keys) for a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
232
|
+
*/
|
|
217
233
|
generateInstantKey(
|
|
218
234
|
parameters: UserIdentitiesGenerateInstantKeyParameters,
|
|
219
235
|
options: UserIdentitiesGenerateInstantKeyOptions = {},
|
|
@@ -227,6 +243,9 @@ export class SeamHttpUserIdentities {
|
|
|
227
243
|
})
|
|
228
244
|
}
|
|
229
245
|
|
|
246
|
+
/**
|
|
247
|
+
* Returns a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
248
|
+
*/
|
|
230
249
|
get(
|
|
231
250
|
parameters?: UserIdentitiesGetParameters,
|
|
232
251
|
options: UserIdentitiesGetOptions = {},
|
|
@@ -240,6 +259,9 @@ export class SeamHttpUserIdentities {
|
|
|
240
259
|
})
|
|
241
260
|
}
|
|
242
261
|
|
|
262
|
+
/**
|
|
263
|
+
* Grants a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://docs.seam.co/core-concepts/devices/).
|
|
264
|
+
*/
|
|
243
265
|
grantAccessToDevice(
|
|
244
266
|
parameters: UserIdentitiesGrantAccessToDeviceParameters,
|
|
245
267
|
options: UserIdentitiesGrantAccessToDeviceOptions = {},
|
|
@@ -253,6 +275,9 @@ export class SeamHttpUserIdentities {
|
|
|
253
275
|
})
|
|
254
276
|
}
|
|
255
277
|
|
|
278
|
+
/**
|
|
279
|
+
* Returns a list of all [user identities](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
280
|
+
*/
|
|
256
281
|
list(
|
|
257
282
|
parameters?: UserIdentitiesListParameters,
|
|
258
283
|
options: UserIdentitiesListOptions = {},
|
|
@@ -266,6 +291,9 @@ export class SeamHttpUserIdentities {
|
|
|
266
291
|
})
|
|
267
292
|
}
|
|
268
293
|
|
|
294
|
+
/**
|
|
295
|
+
* Returns a list of all [devices](https://docs.seam.co/core-concepts/devices) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity.
|
|
296
|
+
*/
|
|
269
297
|
listAccessibleDevices(
|
|
270
298
|
parameters: UserIdentitiesListAccessibleDevicesParameters,
|
|
271
299
|
options: UserIdentitiesListAccessibleDevicesOptions = {},
|
|
@@ -279,6 +307,9 @@ export class SeamHttpUserIdentities {
|
|
|
279
307
|
})
|
|
280
308
|
}
|
|
281
309
|
|
|
310
|
+
/**
|
|
311
|
+
* Returns a list of all [ACS entrances](https://docs.seam.co/api/acs/entrances) accessible to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity.
|
|
312
|
+
*/
|
|
282
313
|
listAccessibleEntrances(
|
|
283
314
|
parameters: UserIdentitiesListAccessibleEntrancesParameters,
|
|
284
315
|
options: UserIdentitiesListAccessibleEntrancesOptions = {},
|
|
@@ -292,6 +323,9 @@ export class SeamHttpUserIdentities {
|
|
|
292
323
|
})
|
|
293
324
|
}
|
|
294
325
|
|
|
326
|
+
/**
|
|
327
|
+
* Returns a list of all [access systems](https://docs.seam.co/low-level-apis/access-systems) associated with a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
328
|
+
*/
|
|
295
329
|
listAcsSystems(
|
|
296
330
|
parameters: UserIdentitiesListAcsSystemsParameters,
|
|
297
331
|
options: UserIdentitiesListAcsSystemsOptions = {},
|
|
@@ -305,6 +339,9 @@ export class SeamHttpUserIdentities {
|
|
|
305
339
|
})
|
|
306
340
|
}
|
|
307
341
|
|
|
342
|
+
/**
|
|
343
|
+
* Returns a list of all [access system users](https://docs.seam.co/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
344
|
+
*/
|
|
308
345
|
listAcsUsers(
|
|
309
346
|
parameters: UserIdentitiesListAcsUsersParameters,
|
|
310
347
|
options: UserIdentitiesListAcsUsersOptions = {},
|
|
@@ -318,6 +355,9 @@ export class SeamHttpUserIdentities {
|
|
|
318
355
|
})
|
|
319
356
|
}
|
|
320
357
|
|
|
358
|
+
/**
|
|
359
|
+
* Removes a specified [access system user](https://docs.seam.co/low-level-apis/access-systems/user-management) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
360
|
+
*/
|
|
321
361
|
removeAcsUser(
|
|
322
362
|
parameters: UserIdentitiesRemoveAcsUserParameters,
|
|
323
363
|
options: UserIdentitiesRemoveAcsUserOptions = {},
|
|
@@ -331,6 +371,9 @@ export class SeamHttpUserIdentities {
|
|
|
331
371
|
})
|
|
332
372
|
}
|
|
333
373
|
|
|
374
|
+
/**
|
|
375
|
+
* Revokes access to a specified [device](https://docs.seam.co/core-concepts/devices/) from a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
376
|
+
*/
|
|
334
377
|
revokeAccessToDevice(
|
|
335
378
|
parameters: UserIdentitiesRevokeAccessToDeviceParameters,
|
|
336
379
|
options: UserIdentitiesRevokeAccessToDeviceOptions = {},
|
|
@@ -344,6 +387,9 @@ export class SeamHttpUserIdentities {
|
|
|
344
387
|
})
|
|
345
388
|
}
|
|
346
389
|
|
|
390
|
+
/**
|
|
391
|
+
* Updates a specified [user identity](https://docs.seam.co/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
392
|
+
*/
|
|
347
393
|
update(
|
|
348
394
|
parameters: UserIdentitiesUpdateParameters,
|
|
349
395
|
options: UserIdentitiesUpdateOptions = {},
|
|
@@ -359,9 +405,18 @@ export class SeamHttpUserIdentities {
|
|
|
359
405
|
}
|
|
360
406
|
|
|
361
407
|
export type UserIdentitiesAddAcsUserParameters = {
|
|
408
|
+
/**
|
|
409
|
+
* ID of the access system user that you want to add to the user identity.
|
|
410
|
+
*/
|
|
362
411
|
acs_user_id: string
|
|
363
412
|
|
|
413
|
+
/**
|
|
414
|
+
* ID of the user identity to which you want to add an access system user.
|
|
415
|
+
*/
|
|
364
416
|
user_identity_id?: string | undefined
|
|
417
|
+
/**
|
|
418
|
+
* Key of the user identity to which you want to add an access system user.
|
|
419
|
+
*/
|
|
365
420
|
user_identity_key?: string | undefined
|
|
366
421
|
}
|
|
367
422
|
|
|
@@ -375,10 +430,25 @@ export type UserIdentitiesAddAcsUserRequest = SeamHttpRequest<void, undefined>
|
|
|
375
430
|
export interface UserIdentitiesAddAcsUserOptions {}
|
|
376
431
|
|
|
377
432
|
export type UserIdentitiesCreateParameters = {
|
|
433
|
+
/**
|
|
434
|
+
* List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity.
|
|
435
|
+
*/
|
|
378
436
|
acs_system_ids?: Array<string> | undefined
|
|
437
|
+
/**
|
|
438
|
+
* Unique email address for the new user identity.
|
|
439
|
+
*/
|
|
379
440
|
email_address?: string | undefined
|
|
441
|
+
/**
|
|
442
|
+
* Full name of the user associated with the new user identity.
|
|
443
|
+
*/
|
|
380
444
|
full_name?: string | undefined
|
|
445
|
+
/**
|
|
446
|
+
* Unique phone number for the new user identity in E.164 format (for example, +15555550100).
|
|
447
|
+
*/
|
|
381
448
|
phone_number?: string | undefined
|
|
449
|
+
/**
|
|
450
|
+
* Unique key for the new user identity.
|
|
451
|
+
*/
|
|
382
452
|
user_identity_key?: string | undefined
|
|
383
453
|
}
|
|
384
454
|
|
|
@@ -395,6 +465,9 @@ export type UserIdentitiesCreateRequest = SeamHttpRequest<
|
|
|
395
465
|
export interface UserIdentitiesCreateOptions {}
|
|
396
466
|
|
|
397
467
|
export type UserIdentitiesDeleteParameters = {
|
|
468
|
+
/**
|
|
469
|
+
* ID of the user identity that you want to delete.
|
|
470
|
+
*/
|
|
398
471
|
user_identity_id: string
|
|
399
472
|
}
|
|
400
473
|
|
|
@@ -409,7 +482,13 @@ export interface UserIdentitiesDeleteOptions {}
|
|
|
409
482
|
|
|
410
483
|
export type UserIdentitiesGenerateInstantKeyParameters = {
|
|
411
484
|
customization_profile_id?: string | undefined
|
|
485
|
+
/**
|
|
486
|
+
* Maximum number of times the instant key can be used. Default: 1.
|
|
487
|
+
*/
|
|
412
488
|
max_use_count?: number | undefined
|
|
489
|
+
/**
|
|
490
|
+
* ID of the user identity for which you want to generate an instant key.
|
|
491
|
+
*/
|
|
413
492
|
user_identity_id: string
|
|
414
493
|
}
|
|
415
494
|
|
|
@@ -428,7 +507,11 @@ export type UserIdentitiesGenerateInstantKeyRequest = SeamHttpRequest<
|
|
|
428
507
|
export interface UserIdentitiesGenerateInstantKeyOptions {}
|
|
429
508
|
|
|
430
509
|
export type UserIdentitiesGetParameters = {
|
|
510
|
+
/**
|
|
511
|
+
* ID of the user identity that you want to get.
|
|
512
|
+
*/
|
|
431
513
|
user_identity_id?: string | undefined
|
|
514
|
+
|
|
432
515
|
user_identity_key?: string | undefined
|
|
433
516
|
}
|
|
434
517
|
|
|
@@ -445,8 +528,14 @@ export type UserIdentitiesGetRequest = SeamHttpRequest<
|
|
|
445
528
|
export interface UserIdentitiesGetOptions {}
|
|
446
529
|
|
|
447
530
|
export type UserIdentitiesGrantAccessToDeviceParameters = {
|
|
531
|
+
/**
|
|
532
|
+
* ID of the managed device to which you want to grant access to the user identity.
|
|
533
|
+
*/
|
|
448
534
|
device_id: string
|
|
449
535
|
|
|
536
|
+
/**
|
|
537
|
+
* ID of the user identity that you want to grant access to a device.
|
|
538
|
+
*/
|
|
450
539
|
user_identity_id: string
|
|
451
540
|
}
|
|
452
541
|
|
|
@@ -463,11 +552,29 @@ export type UserIdentitiesGrantAccessToDeviceRequest = SeamHttpRequest<
|
|
|
463
552
|
export interface UserIdentitiesGrantAccessToDeviceOptions {}
|
|
464
553
|
|
|
465
554
|
export type UserIdentitiesListParameters = {
|
|
555
|
+
/**
|
|
556
|
+
* Timestamp by which to limit returned user identities. Returns user identities created before this timestamp.
|
|
557
|
+
*/
|
|
466
558
|
created_before?: string | undefined
|
|
559
|
+
/**
|
|
560
|
+
* `acs_system_id` of the credential manager by which you want to filter the list of user identities.
|
|
561
|
+
*/
|
|
467
562
|
credential_manager_acs_system_id?: string | undefined
|
|
563
|
+
/**
|
|
564
|
+
* Maximum number of records to return per page.
|
|
565
|
+
*/
|
|
468
566
|
limit?: number | undefined
|
|
567
|
+
/**
|
|
568
|
+
* Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
|
|
569
|
+
*/
|
|
469
570
|
page_cursor?: string | undefined
|
|
571
|
+
/**
|
|
572
|
+
* String for which to search. Filters returned user identities to include all records that satisfy a partial match using `full_name`, `phone_number`, `email_address` or `user_identity_id`.
|
|
573
|
+
*/
|
|
470
574
|
search?: string | undefined
|
|
575
|
+
/**
|
|
576
|
+
* Array of user identity IDs by which to filter the list of user identities.
|
|
577
|
+
*/
|
|
471
578
|
user_identity_ids?: Array<string> | undefined
|
|
472
579
|
}
|
|
473
580
|
|
|
@@ -486,6 +593,9 @@ export type UserIdentitiesListRequest = SeamHttpRequest<
|
|
|
486
593
|
export interface UserIdentitiesListOptions {}
|
|
487
594
|
|
|
488
595
|
export type UserIdentitiesListAccessibleDevicesParameters = {
|
|
596
|
+
/**
|
|
597
|
+
* ID of the user identity for which you want to retrieve all accessible devices.
|
|
598
|
+
*/
|
|
489
599
|
user_identity_id: string
|
|
490
600
|
}
|
|
491
601
|
|
|
@@ -504,6 +614,9 @@ export type UserIdentitiesListAccessibleDevicesRequest = SeamHttpRequest<
|
|
|
504
614
|
export interface UserIdentitiesListAccessibleDevicesOptions {}
|
|
505
615
|
|
|
506
616
|
export type UserIdentitiesListAccessibleEntrancesParameters = {
|
|
617
|
+
/**
|
|
618
|
+
* ID of the user identity for which you want to retrieve all accessible entrances.
|
|
619
|
+
*/
|
|
507
620
|
user_identity_id: string
|
|
508
621
|
}
|
|
509
622
|
|
|
@@ -522,6 +635,9 @@ export type UserIdentitiesListAccessibleEntrancesRequest = SeamHttpRequest<
|
|
|
522
635
|
export interface UserIdentitiesListAccessibleEntrancesOptions {}
|
|
523
636
|
|
|
524
637
|
export type UserIdentitiesListAcsSystemsParameters = {
|
|
638
|
+
/**
|
|
639
|
+
* ID of the user identity for which you want to retrieve all access systems.
|
|
640
|
+
*/
|
|
525
641
|
user_identity_id: string
|
|
526
642
|
}
|
|
527
643
|
|
|
@@ -540,6 +656,9 @@ export type UserIdentitiesListAcsSystemsRequest = SeamHttpRequest<
|
|
|
540
656
|
export interface UserIdentitiesListAcsSystemsOptions {}
|
|
541
657
|
|
|
542
658
|
export type UserIdentitiesListAcsUsersParameters = {
|
|
659
|
+
/**
|
|
660
|
+
* ID of the user identity for which you want to retrieve all access system users.
|
|
661
|
+
*/
|
|
543
662
|
user_identity_id: string
|
|
544
663
|
}
|
|
545
664
|
|
|
@@ -556,8 +675,14 @@ export type UserIdentitiesListAcsUsersRequest = SeamHttpRequest<
|
|
|
556
675
|
export interface UserIdentitiesListAcsUsersOptions {}
|
|
557
676
|
|
|
558
677
|
export type UserIdentitiesRemoveAcsUserParameters = {
|
|
678
|
+
/**
|
|
679
|
+
* ID of the access system user that you want to remove from the user identity..
|
|
680
|
+
*/
|
|
559
681
|
acs_user_id: string
|
|
560
682
|
|
|
683
|
+
/**
|
|
684
|
+
* ID of the user identity from which you want to remove an access system user.
|
|
685
|
+
*/
|
|
561
686
|
user_identity_id: string
|
|
562
687
|
}
|
|
563
688
|
|
|
@@ -574,8 +699,14 @@ export type UserIdentitiesRemoveAcsUserRequest = SeamHttpRequest<
|
|
|
574
699
|
export interface UserIdentitiesRemoveAcsUserOptions {}
|
|
575
700
|
|
|
576
701
|
export type UserIdentitiesRevokeAccessToDeviceParameters = {
|
|
702
|
+
/**
|
|
703
|
+
* ID of the managed device to which you want to revoke access from the user identity.
|
|
704
|
+
*/
|
|
577
705
|
device_id: string
|
|
578
706
|
|
|
707
|
+
/**
|
|
708
|
+
* ID of the user identity from which you want to revoke access to a device.
|
|
709
|
+
*/
|
|
579
710
|
user_identity_id: string
|
|
580
711
|
}
|
|
581
712
|
|
|
@@ -592,11 +723,26 @@ export type UserIdentitiesRevokeAccessToDeviceRequest = SeamHttpRequest<
|
|
|
592
723
|
export interface UserIdentitiesRevokeAccessToDeviceOptions {}
|
|
593
724
|
|
|
594
725
|
export type UserIdentitiesUpdateParameters = {
|
|
726
|
+
/**
|
|
727
|
+
* Unique email address for the user identity.
|
|
728
|
+
*/
|
|
595
729
|
email_address?: string | undefined
|
|
730
|
+
/**
|
|
731
|
+
* Full name of the user associated with the user identity.
|
|
732
|
+
*/
|
|
596
733
|
full_name?: string | undefined
|
|
734
|
+
/**
|
|
735
|
+
* Unique phone number for the user identity.
|
|
736
|
+
*/
|
|
597
737
|
phone_number?: string | undefined
|
|
738
|
+
/**
|
|
739
|
+
* ID of the user identity that you want to update.
|
|
740
|
+
*/
|
|
598
741
|
user_identity_id: string
|
|
599
742
|
|
|
743
|
+
/**
|
|
744
|
+
* Unique key for the user identity.
|
|
745
|
+
*/
|
|
600
746
|
user_identity_key?: string | undefined
|
|
601
747
|
}
|
|
602
748
|
|
|
@@ -161,6 +161,9 @@ export class SeamHttpWebhooks {
|
|
|
161
161
|
await clientSessions.get()
|
|
162
162
|
}
|
|
163
163
|
|
|
164
|
+
/**
|
|
165
|
+
* Creates a new [webhook](https://docs.seam.co/developer-tools/webhooks).
|
|
166
|
+
*/
|
|
164
167
|
create(
|
|
165
168
|
parameters: WebhooksCreateParameters,
|
|
166
169
|
options: WebhooksCreateOptions = {},
|
|
@@ -174,6 +177,9 @@ export class SeamHttpWebhooks {
|
|
|
174
177
|
})
|
|
175
178
|
}
|
|
176
179
|
|
|
180
|
+
/**
|
|
181
|
+
* Deletes a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
|
|
182
|
+
*/
|
|
177
183
|
delete(
|
|
178
184
|
parameters: WebhooksDeleteParameters,
|
|
179
185
|
options: WebhooksDeleteOptions = {},
|
|
@@ -187,6 +193,9 @@ export class SeamHttpWebhooks {
|
|
|
187
193
|
})
|
|
188
194
|
}
|
|
189
195
|
|
|
196
|
+
/**
|
|
197
|
+
* Gets a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
|
|
198
|
+
*/
|
|
190
199
|
get(
|
|
191
200
|
parameters: WebhooksGetParameters,
|
|
192
201
|
options: WebhooksGetOptions = {},
|
|
@@ -200,6 +209,9 @@ export class SeamHttpWebhooks {
|
|
|
200
209
|
})
|
|
201
210
|
}
|
|
202
211
|
|
|
212
|
+
/**
|
|
213
|
+
* Returns a list of all [webhooks](https://docs.seam.co/developer-tools/webhooks).
|
|
214
|
+
*/
|
|
203
215
|
list(
|
|
204
216
|
parameters?: WebhooksListParameters,
|
|
205
217
|
options: WebhooksListOptions = {},
|
|
@@ -213,6 +225,9 @@ export class SeamHttpWebhooks {
|
|
|
213
225
|
})
|
|
214
226
|
}
|
|
215
227
|
|
|
228
|
+
/**
|
|
229
|
+
* Updates a specified [webhook](https://docs.seam.co/developer-tools/webhooks).
|
|
230
|
+
*/
|
|
216
231
|
update(
|
|
217
232
|
parameters: WebhooksUpdateParameters,
|
|
218
233
|
options: WebhooksUpdateOptions = {},
|
|
@@ -228,7 +243,13 @@ export class SeamHttpWebhooks {
|
|
|
228
243
|
}
|
|
229
244
|
|
|
230
245
|
export type WebhooksCreateParameters = {
|
|
246
|
+
/**
|
|
247
|
+
* Types of events that you want the new webhook to receive.
|
|
248
|
+
*/
|
|
231
249
|
event_types?: Array<string> | undefined
|
|
250
|
+
/**
|
|
251
|
+
* URL for the new webhook.
|
|
252
|
+
*/
|
|
232
253
|
url: string
|
|
233
254
|
}
|
|
234
255
|
|
|
@@ -245,6 +266,9 @@ export type WebhooksCreateRequest = SeamHttpRequest<
|
|
|
245
266
|
export interface WebhooksCreateOptions {}
|
|
246
267
|
|
|
247
268
|
export type WebhooksDeleteParameters = {
|
|
269
|
+
/**
|
|
270
|
+
* ID of the webhook that you want to delete.
|
|
271
|
+
*/
|
|
248
272
|
webhook_id: string
|
|
249
273
|
}
|
|
250
274
|
|
|
@@ -258,6 +282,9 @@ export type WebhooksDeleteRequest = SeamHttpRequest<void, undefined>
|
|
|
258
282
|
export interface WebhooksDeleteOptions {}
|
|
259
283
|
|
|
260
284
|
export type WebhooksGetParameters = {
|
|
285
|
+
/**
|
|
286
|
+
* ID of the webhook that you want to get.
|
|
287
|
+
*/
|
|
261
288
|
webhook_id: string
|
|
262
289
|
}
|
|
263
290
|
|
|
@@ -285,8 +312,14 @@ export type WebhooksListRequest = SeamHttpRequest<
|
|
|
285
312
|
export interface WebhooksListOptions {}
|
|
286
313
|
|
|
287
314
|
export type WebhooksUpdateParameters = {
|
|
315
|
+
/**
|
|
316
|
+
* Types of events that you want the webhook to receive.
|
|
317
|
+
*/
|
|
288
318
|
event_types: Array<string>
|
|
289
319
|
|
|
320
|
+
/**
|
|
321
|
+
* ID of the webhook that you want to update.
|
|
322
|
+
*/
|
|
290
323
|
webhook_id: string
|
|
291
324
|
}
|
|
292
325
|
|
|
@@ -162,6 +162,9 @@ export class SeamHttpWorkspaces {
|
|
|
162
162
|
await clientSessions.get()
|
|
163
163
|
}
|
|
164
164
|
|
|
165
|
+
/**
|
|
166
|
+
* Creates a new [workspace](https://docs.seam.co/core-concepts/workspaces).
|
|
167
|
+
*/
|
|
165
168
|
create(
|
|
166
169
|
parameters: WorkspacesCreateParameters,
|
|
167
170
|
options: WorkspacesCreateOptions = {},
|
|
@@ -175,6 +178,9 @@ export class SeamHttpWorkspaces {
|
|
|
175
178
|
})
|
|
176
179
|
}
|
|
177
180
|
|
|
181
|
+
/**
|
|
182
|
+
* Returns the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
|
|
183
|
+
*/
|
|
178
184
|
get(
|
|
179
185
|
parameters?: WorkspacesGetParameters,
|
|
180
186
|
options: WorkspacesGetOptions = {},
|
|
@@ -188,6 +194,9 @@ export class SeamHttpWorkspaces {
|
|
|
188
194
|
})
|
|
189
195
|
}
|
|
190
196
|
|
|
197
|
+
/**
|
|
198
|
+
* Returns a list of [workspaces](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
|
|
199
|
+
*/
|
|
191
200
|
list(
|
|
192
201
|
parameters?: WorkspacesListParameters,
|
|
193
202
|
options: WorkspacesListOptions = {},
|
|
@@ -201,6 +210,9 @@ export class SeamHttpWorkspaces {
|
|
|
201
210
|
})
|
|
202
211
|
}
|
|
203
212
|
|
|
213
|
+
/**
|
|
214
|
+
* Resets the [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.
|
|
215
|
+
*/
|
|
204
216
|
resetSandbox(
|
|
205
217
|
parameters?: WorkspacesResetSandboxParameters,
|
|
206
218
|
options: WorkspacesResetSandboxOptions = {},
|
|
@@ -214,6 +226,9 @@ export class SeamHttpWorkspaces {
|
|
|
214
226
|
})
|
|
215
227
|
}
|
|
216
228
|
|
|
229
|
+
/**
|
|
230
|
+
* Updates the [workspace](https://docs.seam.co/core-concepts/workspaces) associated with the authentication value.
|
|
231
|
+
*/
|
|
217
232
|
update(
|
|
218
233
|
parameters?: WorkspacesUpdateParameters,
|
|
219
234
|
options: WorkspacesUpdateOptions = {},
|
|
@@ -229,23 +244,66 @@ export class SeamHttpWorkspaces {
|
|
|
229
244
|
}
|
|
230
245
|
|
|
231
246
|
export type WorkspacesCreateParameters = {
|
|
247
|
+
/**
|
|
248
|
+
* Company name for the new workspace.
|
|
249
|
+
*/
|
|
232
250
|
company_name?: string | undefined
|
|
251
|
+
/**
|
|
252
|
+
* Connect partner name for the new workspace.
|
|
253
|
+
* @deprecated Use `company_name` instead.
|
|
254
|
+
*/
|
|
233
255
|
connect_partner_name?: string | undefined
|
|
256
|
+
/**
|
|
257
|
+
* [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
258
|
+
*/
|
|
234
259
|
connect_webview_customization?:
|
|
235
260
|
| {
|
|
261
|
+
/**
|
|
262
|
+
* Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
263
|
+
*/
|
|
236
264
|
logo_shape?: 'circle' | 'square' | undefined
|
|
265
|
+
/**
|
|
266
|
+
* Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
267
|
+
*/
|
|
237
268
|
primary_button_color?: string | undefined
|
|
269
|
+
/**
|
|
270
|
+
* Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
271
|
+
*/
|
|
238
272
|
primary_button_text_color?: string | undefined
|
|
273
|
+
/**
|
|
274
|
+
* Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
275
|
+
*/
|
|
239
276
|
success_message?: string | undefined
|
|
240
277
|
}
|
|
241
278
|
| undefined
|
|
279
|
+
/**
|
|
280
|
+
* Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/core-concepts/workspaces#sandbox-workspaces).
|
|
281
|
+
*/
|
|
242
282
|
is_sandbox?: boolean | undefined
|
|
283
|
+
/**
|
|
284
|
+
* Name of the new workspace.
|
|
285
|
+
*/
|
|
243
286
|
name: string
|
|
244
287
|
|
|
288
|
+
/**
|
|
289
|
+
* ID of the organization to associate with the new workspace.
|
|
290
|
+
*/
|
|
245
291
|
organization_id?: string | undefined
|
|
292
|
+
/**
|
|
293
|
+
* @deprecated Use `connect_webview_customization.webview_logo_shape` instead.
|
|
294
|
+
*/
|
|
246
295
|
webview_logo_shape?: 'circle' | 'square' | undefined
|
|
296
|
+
/**
|
|
297
|
+
* @deprecated Use `connect_webview_customization.webview_primary_button_color` instead.
|
|
298
|
+
*/
|
|
247
299
|
webview_primary_button_color?: string | undefined
|
|
300
|
+
/**
|
|
301
|
+
* @deprecated Use `connect_webview_customization.webview_primary_button_text_color` instead.
|
|
302
|
+
*/
|
|
248
303
|
webview_primary_button_text_color?: string | undefined
|
|
304
|
+
/**
|
|
305
|
+
* @deprecated Use `connect_webview_customization.webview_success_message` instead.
|
|
306
|
+
*/
|
|
249
307
|
webview_success_message?: string | undefined
|
|
250
308
|
}
|
|
251
309
|
|
|
@@ -307,18 +365,48 @@ export type WorkspacesResetSandboxOptions = Pick<
|
|
|
307
365
|
>
|
|
308
366
|
|
|
309
367
|
export type WorkspacesUpdateParameters = {
|
|
368
|
+
/**
|
|
369
|
+
* Connect partner name for the workspace.
|
|
370
|
+
*/
|
|
310
371
|
connect_partner_name?: string | undefined
|
|
372
|
+
/**
|
|
373
|
+
* [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
374
|
+
*/
|
|
311
375
|
connect_webview_customization?:
|
|
312
376
|
| {
|
|
377
|
+
/**
|
|
378
|
+
* Logo shape for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
379
|
+
*/
|
|
313
380
|
logo_shape?: 'circle' | 'square' | undefined
|
|
381
|
+
/**
|
|
382
|
+
* Primary button color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
383
|
+
*/
|
|
314
384
|
primary_button_color?: string | undefined
|
|
385
|
+
/**
|
|
386
|
+
* Primary button text color for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
387
|
+
*/
|
|
315
388
|
primary_button_text_color?: string | undefined
|
|
389
|
+
/**
|
|
390
|
+
* Success message for [Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews).
|
|
391
|
+
*/
|
|
316
392
|
success_message?: string | undefined
|
|
317
393
|
}
|
|
318
394
|
| undefined
|
|
395
|
+
/**
|
|
396
|
+
* Indicates whether publishable key authentication is enabled for this workspace.
|
|
397
|
+
*/
|
|
319
398
|
is_publishable_key_auth_enabled?: boolean | undefined
|
|
399
|
+
/**
|
|
400
|
+
* Indicates whether the workspace is suspended.
|
|
401
|
+
*/
|
|
320
402
|
is_suspended?: boolean | undefined
|
|
403
|
+
/**
|
|
404
|
+
* Name of the workspace.
|
|
405
|
+
*/
|
|
321
406
|
name?: string | undefined
|
|
407
|
+
/**
|
|
408
|
+
* ID of the organization to assign the workspace to. The authenticated user must be the owner of the workspace and an admin of the target organization.
|
|
409
|
+
*/
|
|
322
410
|
organization_id?: string | undefined
|
|
323
411
|
}
|
|
324
412
|
|
package/src/lib/version.ts
CHANGED