@seamapi/http 2.31.0 → 2.32.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/resources/access-code.d.ts +15 -15
- package/lib/resources/access-grant.d.ts +4 -4
- package/lib/resources/access-method.d.ts +9 -9
- package/lib/resources/acs-access-group.d.ts +3 -3
- package/lib/resources/acs-credential.d.ts +35 -35
- package/lib/resources/acs-encoder.d.ts +10 -10
- package/lib/resources/acs-entrance.d.ts +20 -20
- package/lib/resources/acs-system.d.ts +37 -37
- package/lib/resources/acs-user.d.ts +35 -35
- package/lib/resources/action-attempt.d.ts +101 -101
- package/lib/resources/client-session.d.ts +12 -12
- package/lib/resources/connect-webview.d.ts +6 -6
- package/lib/resources/connected-account.d.ts +8 -8
- package/lib/resources/device-provider.d.ts +1 -1
- package/lib/resources/device.d.ts +102 -85
- package/lib/resources/event.d.ts +10 -10
- package/lib/resources/noise-threshold.d.ts +2 -2
- package/lib/resources/phone.d.ts +1 -1
- package/lib/resources/thermostat-daily-program.d.ts +1 -1
- package/lib/resources/thermostat-schedule.d.ts +11 -11
- package/lib/resources/unmanaged-access-code.d.ts +12 -12
- package/lib/resources/unmanaged-access-grant.d.ts +4 -4
- package/lib/resources/unmanaged-access-method.d.ts +9 -9
- package/lib/resources/unmanaged-device.d.ts +11 -11
- package/lib/resources/user-identity.d.ts +1 -1
- package/lib/resources/webhook.d.ts +4 -4
- package/lib/resources/workspace.d.ts +12 -12
- package/lib/routes/access-codes/access-codes.d.ts +28 -28
- package/lib/routes/access-codes/access-codes.js +13 -13
- package/lib/routes/access-codes/simulate/simulate.d.ts +1 -1
- package/lib/routes/access-codes/simulate/simulate.js +1 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/access-codes/unmanaged/unmanaged.js +5 -5
- package/lib/routes/access-grants/access-grants.d.ts +3 -3
- package/lib/routes/access-grants/access-grants.js +1 -1
- package/lib/routes/access-methods/access-methods.d.ts +2 -2
- package/lib/routes/access-methods/access-methods.js +2 -2
- package/lib/routes/acs/access-groups/access-groups.d.ts +7 -7
- package/lib/routes/acs/access-groups/access-groups.js +7 -7
- package/lib/routes/acs/credentials/credentials.d.ts +12 -12
- package/lib/routes/acs/credentials/credentials.js +8 -8
- package/lib/routes/acs/encoders/encoders.d.ts +5 -5
- package/lib/routes/acs/encoders/encoders.js +5 -5
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +4 -4
- package/lib/routes/acs/encoders/simulate/simulate.js +4 -4
- package/lib/routes/acs/entrances/entrances.d.ts +5 -5
- package/lib/routes/acs/entrances/entrances.js +5 -5
- package/lib/routes/acs/systems/systems.d.ts +3 -3
- package/lib/routes/acs/systems/systems.js +3 -3
- package/lib/routes/acs/users/users.d.ts +16 -16
- package/lib/routes/acs/users/users.js +11 -11
- package/lib/routes/action-attempts/action-attempts.d.ts +2 -2
- package/lib/routes/action-attempts/action-attempts.js +2 -2
- package/lib/routes/client-sessions/client-sessions.d.ts +22 -22
- package/lib/routes/client-sessions/client-sessions.js +8 -8
- package/lib/routes/connect-webviews/connect-webviews.d.ts +12 -12
- package/lib/routes/connect-webviews/connect-webviews.js +5 -5
- package/lib/routes/connected-accounts/connected-accounts.d.ts +7 -7
- package/lib/routes/connected-accounts/connected-accounts.js +5 -5
- package/lib/routes/connected-accounts/simulate/simulate.d.ts +1 -1
- package/lib/routes/connected-accounts/simulate/simulate.js +1 -1
- package/lib/routes/devices/devices.d.ts +12 -12
- package/lib/routes/devices/devices.js +6 -6
- package/lib/routes/devices/simulate/simulate.d.ts +3 -3
- package/lib/routes/devices/simulate/simulate.js +3 -3
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +9 -9
- package/lib/routes/devices/unmanaged/unmanaged.js +6 -6
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +2 -2
- package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
- package/lib/routes/instant-keys/instant-keys.js +3 -3
- package/lib/routes/locks/locks.d.ts +5 -5
- package/lib/routes/locks/locks.js +5 -5
- package/lib/routes/locks/simulate/simulate.d.ts +2 -2
- package/lib/routes/locks/simulate/simulate.js +2 -2
- package/lib/routes/noise-sensors/noise-sensors.d.ts +1 -1
- package/lib/routes/noise-sensors/noise-sensors.js +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +7 -7
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +5 -5
- package/lib/routes/noise-sensors/simulate/simulate.d.ts +1 -1
- package/lib/routes/noise-sensors/simulate/simulate.js +1 -1
- package/lib/routes/phones/phones.d.ts +4 -4
- package/lib/routes/phones/phones.js +3 -3
- package/lib/routes/phones/simulate/simulate.d.ts +1 -1
- package/lib/routes/phones/simulate/simulate.js +1 -1
- package/lib/routes/seam-http-endpoints-without-workspace.d.ts +2 -2
- package/lib/routes/seam-http-endpoints-without-workspace.js +2 -2
- package/lib/routes/seam-http-endpoints.d.ts +176 -176
- package/lib/routes/seam-http-endpoints.js +176 -176
- package/lib/routes/spaces/spaces.d.ts +4 -4
- package/lib/routes/spaces/spaces.js +4 -4
- package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
- package/lib/routes/thermostats/schedules/schedules.d.ts +11 -11
- package/lib/routes/thermostats/schedules/schedules.js +5 -5
- package/lib/routes/thermostats/simulate/simulate.d.ts +6 -6
- package/lib/routes/thermostats/simulate/simulate.js +2 -2
- package/lib/routes/thermostats/thermostats.d.ts +43 -43
- package/lib/routes/thermostats/thermostats.js +13 -13
- package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/user-identities/unmanaged/unmanaged.js +3 -3
- package/lib/routes/user-identities/user-identities.d.ts +15 -15
- package/lib/routes/user-identities/user-identities.js +15 -15
- package/lib/routes/webhooks/webhooks.d.ts +5 -5
- package/lib/routes/webhooks/webhooks.js +5 -5
- package/lib/routes/workspaces/workspaces.d.ts +16 -16
- package/lib/routes/workspaces/workspaces.js +5 -5
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/access-code.ts +15 -15
- package/src/lib/resources/access-grant.ts +4 -4
- package/src/lib/resources/access-method.ts +9 -9
- package/src/lib/resources/acs-access-group.ts +3 -3
- package/src/lib/resources/acs-credential.ts +35 -35
- package/src/lib/resources/acs-encoder.ts +10 -10
- package/src/lib/resources/acs-entrance.ts +20 -20
- package/src/lib/resources/acs-system.ts +37 -37
- package/src/lib/resources/acs-user.ts +35 -35
- package/src/lib/resources/action-attempt.ts +101 -101
- package/src/lib/resources/client-session.ts +12 -12
- package/src/lib/resources/connect-webview.ts +6 -6
- package/src/lib/resources/connected-account.ts +8 -8
- package/src/lib/resources/device-provider.ts +1 -0
- package/src/lib/resources/device.ts +104 -84
- package/src/lib/resources/event.ts +10 -10
- package/src/lib/resources/noise-threshold.ts +2 -2
- package/src/lib/resources/phone.ts +1 -1
- package/src/lib/resources/thermostat-daily-program.ts +1 -1
- package/src/lib/resources/thermostat-schedule.ts +11 -11
- package/src/lib/resources/unmanaged-access-code.ts +12 -12
- package/src/lib/resources/unmanaged-access-grant.ts +4 -4
- package/src/lib/resources/unmanaged-access-method.ts +9 -9
- package/src/lib/resources/unmanaged-device.ts +11 -10
- package/src/lib/resources/user-identity.ts +1 -1
- package/src/lib/resources/webhook.ts +4 -4
- package/src/lib/resources/workspace.ts +12 -12
- package/src/lib/routes/access-codes/access-codes.ts +28 -28
- package/src/lib/routes/access-codes/simulate/simulate.ts +1 -1
- package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +9 -9
- package/src/lib/routes/access-grants/access-grants.ts +3 -3
- package/src/lib/routes/access-methods/access-methods.ts +2 -2
- package/src/lib/routes/acs/access-groups/access-groups.ts +7 -7
- package/src/lib/routes/acs/credentials/credentials.ts +12 -12
- package/src/lib/routes/acs/encoders/encoders.ts +5 -5
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +4 -4
- package/src/lib/routes/acs/entrances/entrances.ts +5 -5
- package/src/lib/routes/acs/systems/systems.ts +3 -3
- package/src/lib/routes/acs/users/users.ts +16 -16
- package/src/lib/routes/action-attempts/action-attempts.ts +2 -2
- package/src/lib/routes/client-sessions/client-sessions.ts +22 -22
- package/src/lib/routes/connect-webviews/connect-webviews.ts +12 -11
- package/src/lib/routes/connected-accounts/connected-accounts.ts +7 -7
- package/src/lib/routes/connected-accounts/simulate/simulate.ts +1 -1
- package/src/lib/routes/devices/devices.ts +12 -9
- package/src/lib/routes/devices/simulate/simulate.ts +3 -3
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +9 -6
- package/src/lib/routes/events/events.ts +4 -4
- package/src/lib/routes/instant-keys/instant-keys.ts +3 -3
- package/src/lib/routes/locks/locks.ts +5 -5
- package/src/lib/routes/locks/simulate/simulate.ts +2 -2
- package/src/lib/routes/noise-sensors/noise-sensors.ts +1 -1
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +7 -7
- package/src/lib/routes/noise-sensors/simulate/simulate.ts +1 -1
- package/src/lib/routes/phones/phones.ts +4 -4
- package/src/lib/routes/phones/simulate/simulate.ts +1 -1
- package/src/lib/routes/seam-http-endpoints-without-workspace.ts +2 -2
- package/src/lib/routes/seam-http-endpoints.ts +176 -176
- package/src/lib/routes/spaces/spaces.ts +4 -4
- package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +2 -2
- package/src/lib/routes/thermostats/schedules/schedules.ts +11 -11
- package/src/lib/routes/thermostats/simulate/simulate.ts +6 -6
- package/src/lib/routes/thermostats/thermostats.ts +43 -43
- package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +3 -3
- package/src/lib/routes/user-identities/user-identities.ts +15 -15
- package/src/lib/routes/webhooks/webhooks.ts +5 -5
- package/src/lib/routes/workspaces/workspaces.ts +16 -16
- package/src/lib/version.ts +1 -1
|
@@ -16,23 +16,23 @@ export declare class SeamHttpNoiseSensorsNoiseThresholds {
|
|
|
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 [noise threshold](https://
|
|
19
|
+
* Creates a new [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
|
|
20
20
|
*/
|
|
21
21
|
create(parameters: NoiseSensorsNoiseThresholdsCreateParameters, options?: NoiseSensorsNoiseThresholdsCreateOptions): NoiseSensorsNoiseThresholdsCreateRequest;
|
|
22
22
|
/**
|
|
23
|
-
* Deletes a [noise threshold](https://
|
|
23
|
+
* Deletes a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
24
24
|
*/
|
|
25
25
|
delete(parameters: NoiseSensorsNoiseThresholdsDeleteParameters, options?: NoiseSensorsNoiseThresholdsDeleteOptions): NoiseSensorsNoiseThresholdsDeleteRequest;
|
|
26
26
|
/**
|
|
27
|
-
* Returns a specified [noise threshold](https://
|
|
27
|
+
* Returns a specified [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
28
28
|
*/
|
|
29
29
|
get(parameters: NoiseSensorsNoiseThresholdsGetParameters, options?: NoiseSensorsNoiseThresholdsGetOptions): NoiseSensorsNoiseThresholdsGetRequest;
|
|
30
30
|
/**
|
|
31
|
-
* Returns a list of all [noise thresholds](https://
|
|
31
|
+
* Returns a list of all [noise thresholds](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
32
32
|
*/
|
|
33
33
|
list(parameters: NoiseSensorsNoiseThresholdsListParameters, options?: NoiseSensorsNoiseThresholdsListOptions): NoiseSensorsNoiseThresholdsListRequest;
|
|
34
34
|
/**
|
|
35
|
-
* Updates a [noise threshold](https://
|
|
35
|
+
* Updates a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
36
36
|
*/
|
|
37
37
|
update(parameters: NoiseSensorsNoiseThresholdsUpdateParameters, options?: NoiseSensorsNoiseThresholdsUpdateOptions): NoiseSensorsNoiseThresholdsUpdateRequest;
|
|
38
38
|
}
|
|
@@ -54,7 +54,7 @@ export type NoiseSensorsNoiseThresholdsCreateParameters = {
|
|
|
54
54
|
*/
|
|
55
55
|
noise_threshold_decibels?: number | undefined;
|
|
56
56
|
/**
|
|
57
|
-
* Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://
|
|
57
|
+
* Noise level in Noiseaware Noise Risk Score (NRS) for the new noise threshold. This parameter is only relevant for [Noiseaware sensors](https://www.seam.co/docs/device-and-system-integration-guides/noiseaware-sensors).
|
|
58
58
|
*/
|
|
59
59
|
noise_threshold_nrs?: number | undefined;
|
|
60
60
|
/**
|
|
@@ -140,7 +140,7 @@ export type NoiseSensorsNoiseThresholdsUpdateParameters = {
|
|
|
140
140
|
*/
|
|
141
141
|
noise_threshold_id: string;
|
|
142
142
|
/**
|
|
143
|
-
* Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://
|
|
143
|
+
* Noise level in Noiseaware Noise Risk Score (NRS) for the noise threshold. This parameter is only relevant for [Noiseaware sensors](https://www.seam.co/docs/device-and-system-integration-guides/noiseaware-sensors).
|
|
144
144
|
*/
|
|
145
145
|
noise_threshold_nrs?: number | undefined;
|
|
146
146
|
/**
|
|
@@ -83,7 +83,7 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Creates a new [noise threshold](https://
|
|
86
|
+
* Creates a new [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors). Thresholds represent the limits of noise tolerated at a property, which can be customized for each hour of the day. Each device has its own default thresholds, but you can use the Seam API to modify them.
|
|
87
87
|
*/
|
|
88
88
|
create(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -99,7 +99,7 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
|
|
|
99
99
|
});
|
|
100
100
|
}
|
|
101
101
|
/**
|
|
102
|
-
* Deletes a [noise threshold](https://
|
|
102
|
+
* Deletes a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) from a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
103
103
|
*/
|
|
104
104
|
delete(parameters, options = {}) {
|
|
105
105
|
return new SeamHttpRequest(this, {
|
|
@@ -115,7 +115,7 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
|
|
|
115
115
|
});
|
|
116
116
|
}
|
|
117
117
|
/**
|
|
118
|
-
* Returns a specified [noise threshold](https://
|
|
118
|
+
* Returns a specified [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
119
119
|
*/
|
|
120
120
|
get(parameters, options = {}) {
|
|
121
121
|
return new SeamHttpRequest(this, {
|
|
@@ -131,7 +131,7 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
|
|
|
131
131
|
});
|
|
132
132
|
}
|
|
133
133
|
/**
|
|
134
|
-
* Returns a list of all [noise thresholds](https://
|
|
134
|
+
* Returns a list of all [noise thresholds](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
135
135
|
*/
|
|
136
136
|
list(parameters, options = {}) {
|
|
137
137
|
return new SeamHttpRequest(this, {
|
|
@@ -147,7 +147,7 @@ export class SeamHttpNoiseSensorsNoiseThresholds {
|
|
|
147
147
|
});
|
|
148
148
|
}
|
|
149
149
|
/**
|
|
150
|
-
* Updates a [noise threshold](https://
|
|
150
|
+
* Updates a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
151
151
|
*/
|
|
152
152
|
update(parameters, options = {}) {
|
|
153
153
|
return new SeamHttpRequest(this, {
|
|
@@ -15,7 +15,7 @@ export declare class SeamHttpNoiseSensorsSimulate {
|
|
|
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 the triggering of a [noise threshold](https://
|
|
18
|
+
* Simulates the triggering of a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
19
19
|
*/
|
|
20
20
|
triggerNoiseThreshold(parameters: NoiseSensorsSimulateTriggerNoiseThresholdParameters, options?: NoiseSensorsSimulateTriggerNoiseThresholdOptions): NoiseSensorsSimulateTriggerNoiseThresholdRequest;
|
|
21
21
|
}
|
|
@@ -83,7 +83,7 @@ export class SeamHttpNoiseSensorsSimulate {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Simulates the triggering of a [noise threshold](https://
|
|
86
|
+
* Simulates the triggering of a [noise threshold](https://www.seam.co/docs/capability-guides/noise-sensors/configure-noise-threshold-settings) for a [noise sensor](https://www.seam.co/docs/capability-guides/noise-sensors) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
87
87
|
*/
|
|
88
88
|
triggerNoiseThreshold(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -18,15 +18,15 @@ export declare class SeamHttpPhones {
|
|
|
18
18
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
19
19
|
get simulate(): SeamHttpPhonesSimulate;
|
|
20
20
|
/**
|
|
21
|
-
* Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://
|
|
21
|
+
* Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).
|
|
22
22
|
*/
|
|
23
23
|
deactivate(parameters: PhonesDeactivateParameters, options?: PhonesDeactivateOptions): PhonesDeactivateRequest;
|
|
24
24
|
/**
|
|
25
|
-
* Returns a specified [phone](https://
|
|
25
|
+
* Returns a specified [phone](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity).
|
|
26
26
|
*/
|
|
27
27
|
get(parameters: PhonesGetParameters, options?: PhonesGetOptions): PhonesGetRequest;
|
|
28
28
|
/**
|
|
29
|
-
* Returns a list of all [phones](https://
|
|
29
|
+
* Returns a list of all [phones](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
|
|
30
30
|
*/
|
|
31
31
|
list(parameters?: PhonesListParameters, options?: PhonesListOptions): PhonesListRequest;
|
|
32
32
|
}
|
|
@@ -60,7 +60,7 @@ export interface PhonesGetOptions {
|
|
|
60
60
|
}
|
|
61
61
|
export type PhonesListParameters = {
|
|
62
62
|
/**
|
|
63
|
-
* ID of the [credential](https://
|
|
63
|
+
* ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) by which you want to filter the list of returned phones.
|
|
64
64
|
*/
|
|
65
65
|
acs_credential_id?: string | undefined;
|
|
66
66
|
/**
|
|
@@ -87,7 +87,7 @@ export class SeamHttpPhones {
|
|
|
87
87
|
return SeamHttpPhonesSimulate.fromClient(this.client, this.defaults);
|
|
88
88
|
}
|
|
89
89
|
/**
|
|
90
|
-
* Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://
|
|
90
|
+
* Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).
|
|
91
91
|
*/
|
|
92
92
|
deactivate(parameters, options = {}) {
|
|
93
93
|
return new SeamHttpRequest(this, {
|
|
@@ -103,7 +103,7 @@ export class SeamHttpPhones {
|
|
|
103
103
|
});
|
|
104
104
|
}
|
|
105
105
|
/**
|
|
106
|
-
* Returns a specified [phone](https://
|
|
106
|
+
* Returns a specified [phone](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity).
|
|
107
107
|
*/
|
|
108
108
|
get(parameters, options = {}) {
|
|
109
109
|
return new SeamHttpRequest(this, {
|
|
@@ -119,7 +119,7 @@ export class SeamHttpPhones {
|
|
|
119
119
|
});
|
|
120
120
|
}
|
|
121
121
|
/**
|
|
122
|
-
* Returns a list of all [phones](https://
|
|
122
|
+
* Returns a list of all [phones](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity). To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.
|
|
123
123
|
*/
|
|
124
124
|
list(parameters, options = {}) {
|
|
125
125
|
return new SeamHttpRequest(this, {
|
|
@@ -16,7 +16,7 @@ export declare class SeamHttpPhonesSimulate {
|
|
|
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 simulated phone in a [sandbox workspace](https://
|
|
19
|
+
* Creates a new simulated phone in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://www.seam.co/docs/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).
|
|
20
20
|
*/
|
|
21
21
|
createSandboxPhone(parameters: PhonesSimulateCreateSandboxPhoneParameters, options?: PhonesSimulateCreateSandboxPhoneOptions): PhonesSimulateCreateSandboxPhoneRequest;
|
|
22
22
|
}
|
|
@@ -83,7 +83,7 @@ export class SeamHttpPhonesSimulate {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Creates a new simulated phone in a [sandbox workspace](https://
|
|
86
|
+
* Creates a new simulated phone in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Creating a Simulated Phone for a User Identity](https://www.seam.co/docs/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).
|
|
87
87
|
*/
|
|
88
88
|
createSandboxPhone(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -9,11 +9,11 @@ export declare class SeamHttpEndpointsWithoutWorkspace {
|
|
|
9
9
|
static fromConsoleSessionToken(consoleSessionToken: SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken['consoleSessionToken'], options?: Omit<SeamHttpWithoutWorkspaceOptionsWithConsoleSessionToken, 'consoleSessionToken'>): SeamHttpEndpointsWithoutWorkspace;
|
|
10
10
|
static fromPersonalAccessToken(personalAccessToken: SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken['personalAccessToken'], options?: Omit<SeamHttpWithoutWorkspaceOptionsWithPersonalAccessToken, 'personalAccessToken'>): SeamHttpEndpointsWithoutWorkspace;
|
|
11
11
|
/**
|
|
12
|
-
* Creates a new [workspace](https://
|
|
12
|
+
* Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
13
13
|
*/
|
|
14
14
|
get '/workspaces/create'(): (parameters: WorkspacesCreateParameters, options?: WorkspacesCreateOptions) => WorkspacesCreateRequest;
|
|
15
15
|
/**
|
|
16
|
-
* Returns a list of [workspaces](https://
|
|
16
|
+
* Returns a list of [workspaces](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
17
17
|
*/
|
|
18
18
|
get '/workspaces/list'(): (parameters?: WorkspacesListParameters, options?: WorkspacesListOptions) => WorkspacesListRequest;
|
|
19
19
|
}
|
|
@@ -36,7 +36,7 @@ export class SeamHttpEndpointsWithoutWorkspace {
|
|
|
36
36
|
return new SeamHttpEndpointsWithoutWorkspace(constructorOptions);
|
|
37
37
|
}
|
|
38
38
|
/**
|
|
39
|
-
* Creates a new [workspace](https://
|
|
39
|
+
* Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
40
40
|
*/
|
|
41
41
|
get '/workspaces/create'() {
|
|
42
42
|
const { client, defaults } = this;
|
|
@@ -46,7 +46,7 @@ export class SeamHttpEndpointsWithoutWorkspace {
|
|
|
46
46
|
};
|
|
47
47
|
}
|
|
48
48
|
/**
|
|
49
|
-
* Returns a list of [workspaces](https://
|
|
49
|
+
* Returns a list of [workspaces](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
50
50
|
*/
|
|
51
51
|
get '/workspaces/list'() {
|
|
52
52
|
const { client, defaults } = this;
|