@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
|
@@ -56,11 +56,11 @@ export declare class SeamHttpEndpoints {
|
|
|
56
56
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
57
57
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
58
58
|
/**
|
|
59
|
-
* Creates a new [access code](https://
|
|
59
|
+
* Creates a new [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). For granting access, we recommend [Access Grants](https://www.seam.co/docs/use-cases/granting-access) instead: they work across both standalone smart locks and access control systems and manage the underlying codes for you. Use this low-level endpoint only when you need direct control over a code on a single device, such as setting a custom PIN value.
|
|
60
60
|
*/
|
|
61
61
|
get '/access_codes/create'(): (parameters: AccessCodesCreateParameters, options?: AccessCodesCreateOptions) => AccessCodesCreateRequest;
|
|
62
62
|
/**
|
|
63
|
-
* Creates new [access codes](https://
|
|
63
|
+
* Creates new [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
64
64
|
*
|
|
65
65
|
* Users with more than one door lock in a property may want to create groups of linked access codes, all of which have the same code (PIN). For example, a short-term rental host may want to provide guests the same PIN for both a front door lock and a back door lock.
|
|
66
66
|
*
|
|
@@ -68,33 +68,33 @@ export declare class SeamHttpEndpoints {
|
|
|
68
68
|
*
|
|
69
69
|
* If you want to change these access codes that are not linked by a `common_code_key`, you cannot use `/access_codes/update_multiple`. However, you can update each of these access codes individually, using `/access_codes/update`.
|
|
70
70
|
*
|
|
71
|
-
* See also [Creating and Updating Multiple Linked Access Codes](https://
|
|
71
|
+
* See also [Creating and Updating Multiple Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes).
|
|
72
72
|
*
|
|
73
|
-
* For granting a person access to a space, [Access Grants](https://
|
|
73
|
+
* For granting a person access to a space, [Access Grants](https://www.seam.co/docs/use-cases/granting-access) are the default and recommended approach and work across both standalone smart locks and access systems. Use the lower-level Access Codes API directly only when you specifically need to manage individual PIN codes.
|
|
74
74
|
*/
|
|
75
75
|
get '/access_codes/create_multiple'(): (parameters: AccessCodesCreateMultipleParameters, options?: AccessCodesCreateMultipleOptions) => AccessCodesCreateMultipleRequest;
|
|
76
76
|
/**
|
|
77
|
-
* Deletes an [access code](https://
|
|
77
|
+
* Deletes an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
78
78
|
*/
|
|
79
79
|
get '/access_codes/delete'(): (parameters: AccessCodesDeleteParameters, options?: AccessCodesDeleteOptions) => AccessCodesDeleteRequest;
|
|
80
80
|
/**
|
|
81
|
-
* Generates a code for an [access code](https://
|
|
81
|
+
* Generates a code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes), given a device ID.
|
|
82
82
|
*/
|
|
83
83
|
get '/access_codes/generate_code'(): (parameters: AccessCodesGenerateCodeParameters, options?: AccessCodesGenerateCodeOptions) => AccessCodesGenerateCodeRequest;
|
|
84
84
|
/**
|
|
85
|
-
* Returns a specified [access code](https://
|
|
85
|
+
* Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
86
86
|
*
|
|
87
87
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
88
88
|
*/
|
|
89
89
|
get '/access_codes/get'(): (parameters: AccessCodesGetParameters, options?: AccessCodesGetOptions) => AccessCodesGetRequest;
|
|
90
90
|
/**
|
|
91
|
-
* Returns a list of all [access codes](https://
|
|
91
|
+
* Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
92
92
|
*
|
|
93
93
|
* Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
|
|
94
94
|
*/
|
|
95
95
|
get '/access_codes/list'(): (parameters: AccessCodesListParameters, options?: AccessCodesListOptions) => AccessCodesListRequest;
|
|
96
96
|
/**
|
|
97
|
-
* Retrieves a backup access code for an [access code](https://
|
|
97
|
+
* Retrieves a backup access code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes). See also [Managing Backup Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes).
|
|
98
98
|
*
|
|
99
99
|
* A backup access code pool is a collection of pre-programmed access codes stored on a device, ready for use. These codes are programmed in addition to the regular access codes on Seam, serving as a safety net for any issues with the primary codes. If there's ever a complication with a primary access code—be it due to intermittent connectivity, manual removal from a device, or provider outages—a backup code can be retrieved. Its end time can then be adjusted to align with the original code, facilitating seamless and uninterrupted access.
|
|
100
100
|
*
|
|
@@ -112,25 +112,25 @@ export declare class SeamHttpEndpoints {
|
|
|
112
112
|
*/
|
|
113
113
|
get '/access_codes/report_device_constraints'(): (parameters: AccessCodesReportDeviceConstraintsParameters, options?: AccessCodesReportDeviceConstraintsOptions) => AccessCodesReportDeviceConstraintsRequest;
|
|
114
114
|
/**
|
|
115
|
-
* Updates a specified active or upcoming [access code](https://
|
|
115
|
+
* Updates a specified active or upcoming [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
116
116
|
*
|
|
117
|
-
* See also [Modifying Access Codes](https://
|
|
117
|
+
* See also [Modifying Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes).
|
|
118
118
|
*/
|
|
119
119
|
get '/access_codes/update'(): (parameters: AccessCodesUpdateParameters, options?: AccessCodesUpdateOptions) => AccessCodesUpdateRequest;
|
|
120
120
|
/**
|
|
121
|
-
* Updates [access codes](https://
|
|
121
|
+
* Updates [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
122
122
|
*
|
|
123
123
|
* Specify the `common_code_key` to identify the set of access codes that you want to update.
|
|
124
124
|
*
|
|
125
|
-
* See also [Update Linked Access Codes](https://
|
|
125
|
+
* See also [Update Linked Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/creating-and-updating-multiple-linked-access-codes#update-linked-access-codes).
|
|
126
126
|
*/
|
|
127
127
|
get '/access_codes/update_multiple'(): (parameters: AccessCodesUpdateMultipleParameters, options?: AccessCodesUpdateMultipleOptions) => AccessCodesUpdateMultipleRequest;
|
|
128
128
|
/**
|
|
129
|
-
* Simulates the creation of an [unmanaged access code](https://
|
|
129
|
+
* Simulates the creation of an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) in a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
130
130
|
*/
|
|
131
131
|
get '/access_codes/simulate/create_unmanaged_access_code'(): (parameters: AccessCodesSimulateCreateUnmanagedAccessCodeParameters, options?: AccessCodesSimulateCreateUnmanagedAccessCodeOptions) => AccessCodesSimulateCreateUnmanagedAccessCodeRequest;
|
|
132
132
|
/**
|
|
133
|
-
* Converts an [unmanaged access code](https://
|
|
133
|
+
* Converts an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) to an [access code managed through Seam](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
134
134
|
*
|
|
135
135
|
* An unmanaged access code has a limited set of operations that you can perform on it. Once you convert an unmanaged access code to a managed access code, the full set of access code operations and lifecycle events becomes available for it.
|
|
136
136
|
*
|
|
@@ -138,25 +138,25 @@ export declare class SeamHttpEndpoints {
|
|
|
138
138
|
*/
|
|
139
139
|
get '/access_codes/unmanaged/convert_to_managed'(): (parameters: AccessCodesUnmanagedConvertToManagedParameters, options?: AccessCodesUnmanagedConvertToManagedOptions) => AccessCodesUnmanagedConvertToManagedRequest;
|
|
140
140
|
/**
|
|
141
|
-
* Deletes an [unmanaged access code](https://
|
|
141
|
+
* Deletes an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
142
142
|
*/
|
|
143
143
|
get '/access_codes/unmanaged/delete'(): (parameters: AccessCodesUnmanagedDeleteParameters, options?: AccessCodesUnmanagedDeleteOptions) => AccessCodesUnmanagedDeleteRequest;
|
|
144
144
|
/**
|
|
145
|
-
* Returns a specified [unmanaged access code](https://
|
|
145
|
+
* Returns a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
146
146
|
*
|
|
147
147
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
148
148
|
*/
|
|
149
149
|
get '/access_codes/unmanaged/get'(): (parameters: AccessCodesUnmanagedGetParameters, options?: AccessCodesUnmanagedGetOptions) => AccessCodesUnmanagedGetRequest;
|
|
150
150
|
/**
|
|
151
|
-
* Returns a list of all [unmanaged access codes](https://
|
|
151
|
+
* Returns a list of all [unmanaged access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
152
152
|
*/
|
|
153
153
|
get '/access_codes/unmanaged/list'(): (parameters: AccessCodesUnmanagedListParameters, options?: AccessCodesUnmanagedListOptions) => AccessCodesUnmanagedListRequest;
|
|
154
154
|
/**
|
|
155
|
-
* Updates a specified [unmanaged access code](https://
|
|
155
|
+
* Updates a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
156
156
|
*/
|
|
157
157
|
get '/access_codes/unmanaged/update'(): (parameters: AccessCodesUnmanagedUpdateParameters, options?: AccessCodesUnmanagedUpdateOptions) => AccessCodesUnmanagedUpdateRequest;
|
|
158
158
|
/**
|
|
159
|
-
* Creates a new [Access Grant](https://
|
|
159
|
+
* Creates a new [Access Grant](https://www.seam.co/docs/use-cases/granting-access). Access Grants are the default and recommended way to grant a user access to any physical space, irrespective of the locking hardware. They work with both standalone smart locks (using `device_ids`) and access control systems (using `acs_entrance_ids` or `space_ids`), and can issue PIN codes, key cards, and mobile keys through a single request.
|
|
160
160
|
*/
|
|
161
161
|
get '/access_grants/create'(): (parameters: AccessGrantsCreateParameters, options?: AccessGrantsCreateOptions) => AccessGrantsCreateRequest;
|
|
162
162
|
/**
|
|
@@ -208,7 +208,7 @@ export declare class SeamHttpEndpoints {
|
|
|
208
208
|
*/
|
|
209
209
|
get '/access_methods/delete'(): (parameters: AccessMethodsDeleteParameters, options?: AccessMethodsDeleteOptions) => AccessMethodsDeleteRequest;
|
|
210
210
|
/**
|
|
211
|
-
* Encodes an existing access method onto a plastic card placed on the specified [encoder](https://
|
|
211
|
+
* Encodes an existing access method onto a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
212
212
|
*/
|
|
213
213
|
get '/access_methods/encode'(): (parameters: AccessMethodsEncodeParameters, options?: AccessMethodsEncodeOptions) => AccessMethodsEncodeRequest;
|
|
214
214
|
/**
|
|
@@ -224,7 +224,7 @@ export declare class SeamHttpEndpoints {
|
|
|
224
224
|
*/
|
|
225
225
|
get '/access_methods/list'(): (parameters: AccessMethodsListParameters, options?: AccessMethodsListOptions) => AccessMethodsListRequest;
|
|
226
226
|
/**
|
|
227
|
-
* Remotely unlocks a specified [entrance](https://
|
|
227
|
+
* Remotely unlocks a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) using the cloud key credential associated with an access method. Returns an action attempt that tracks the progress of the unlock operation.
|
|
228
228
|
*/
|
|
229
229
|
get '/access_methods/unlock_door'(): (parameters: AccessMethodsUnlockDoorParameters, options?: AccessMethodsUnlockDoorOptions) => AccessMethodsUnlockDoorRequest;
|
|
230
230
|
/**
|
|
@@ -236,133 +236,133 @@ export declare class SeamHttpEndpoints {
|
|
|
236
236
|
*/
|
|
237
237
|
get '/access_methods/unmanaged/list'(): (parameters: AccessMethodsUnmanagedListParameters, options?: AccessMethodsUnmanagedListOptions) => AccessMethodsUnmanagedListRequest;
|
|
238
238
|
/**
|
|
239
|
-
* Adds a specified [access system user](https://
|
|
239
|
+
* 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).
|
|
240
240
|
*/
|
|
241
241
|
get '/acs/access_groups/add_user'(): (parameters: AcsAccessGroupsAddUserParameters, options?: AcsAccessGroupsAddUserOptions) => AcsAccessGroupsAddUserRequest;
|
|
242
242
|
/**
|
|
243
|
-
* Deletes a specified [access group](https://
|
|
243
|
+
* Deletes a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
244
244
|
*/
|
|
245
245
|
get '/acs/access_groups/delete'(): (parameters: AcsAccessGroupsDeleteParameters, options?: AcsAccessGroupsDeleteOptions) => AcsAccessGroupsDeleteRequest;
|
|
246
246
|
/**
|
|
247
|
-
* Returns a specified [access group](https://
|
|
247
|
+
* Returns a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
248
248
|
*/
|
|
249
249
|
get '/acs/access_groups/get'(): (parameters: AcsAccessGroupsGetParameters, options?: AcsAccessGroupsGetOptions) => AcsAccessGroupsGetRequest;
|
|
250
250
|
/**
|
|
251
|
-
* Returns a list of all [access groups](https://
|
|
251
|
+
* Returns a list of all [access groups](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
252
252
|
*/
|
|
253
253
|
get '/acs/access_groups/list'(): (parameters?: AcsAccessGroupsListParameters, options?: AcsAccessGroupsListOptions) => AcsAccessGroupsListRequest;
|
|
254
254
|
/**
|
|
255
|
-
* Returns a list of all accessible entrances for a specified [access group](https://
|
|
255
|
+
* Returns a list of all accessible entrances for a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
256
256
|
*/
|
|
257
257
|
get '/acs/access_groups/list_accessible_entrances'(): (parameters: AcsAccessGroupsListAccessibleEntrancesParameters, options?: AcsAccessGroupsListAccessibleEntrancesOptions) => AcsAccessGroupsListAccessibleEntrancesRequest;
|
|
258
258
|
/**
|
|
259
|
-
* Returns a list of all [access system users](https://
|
|
259
|
+
* Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management) in an [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
260
260
|
*/
|
|
261
261
|
get '/acs/access_groups/list_users'(): (parameters: AcsAccessGroupsListUsersParameters, options?: AcsAccessGroupsListUsersOptions) => AcsAccessGroupsListUsersRequest;
|
|
262
262
|
/**
|
|
263
|
-
* Removes a specified [access system user](https://
|
|
263
|
+
* 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).
|
|
264
264
|
*/
|
|
265
265
|
get '/acs/access_groups/remove_user'(): (parameters: AcsAccessGroupsRemoveUserParameters, options?: AcsAccessGroupsRemoveUserOptions) => AcsAccessGroupsRemoveUserRequest;
|
|
266
266
|
/**
|
|
267
|
-
* Assigns a specified [credential](https://
|
|
267
|
+
* Assigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) to a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
268
268
|
*/
|
|
269
269
|
get '/acs/credentials/assign'(): (parameters: AcsCredentialsAssignParameters, options?: AcsCredentialsAssignOptions) => AcsCredentialsAssignRequest;
|
|
270
270
|
/**
|
|
271
|
-
* Creates a new [credential](https://
|
|
271
|
+
* Creates a new [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) for a specified [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management). For granting access, we recommend [Access Grants](https://www.seam.co/docs/use-cases/granting-access) instead: they create and manage the underlying credentials for you, across access systems and standalone smart locks alike. Use this low-level endpoint only when you need direct control over an individual ACS credential.
|
|
272
272
|
*/
|
|
273
273
|
get '/acs/credentials/create'(): (parameters: AcsCredentialsCreateParameters, options?: AcsCredentialsCreateOptions) => AcsCredentialsCreateRequest;
|
|
274
274
|
/**
|
|
275
|
-
* Deletes a specified [credential](https://
|
|
275
|
+
* Deletes a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
276
276
|
*/
|
|
277
277
|
get '/acs/credentials/delete'(): (parameters: AcsCredentialsDeleteParameters, options?: AcsCredentialsDeleteOptions) => AcsCredentialsDeleteRequest;
|
|
278
278
|
/**
|
|
279
|
-
* Returns a specified [credential](https://
|
|
279
|
+
* Returns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
280
280
|
*/
|
|
281
281
|
get '/acs/credentials/get'(): (parameters: AcsCredentialsGetParameters, options?: AcsCredentialsGetOptions) => AcsCredentialsGetRequest;
|
|
282
282
|
/**
|
|
283
|
-
* Returns a list of all [credentials](https://
|
|
283
|
+
* Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
284
284
|
*/
|
|
285
285
|
get '/acs/credentials/list'(): (parameters?: AcsCredentialsListParameters, options?: AcsCredentialsListOptions) => AcsCredentialsListRequest;
|
|
286
286
|
/**
|
|
287
|
-
* Returns a list of all [entrances](https://
|
|
287
|
+
* Returns a list of all [entrances](https://www.seam.co/docs/api/acs/entrances/object) to which a [credential](https://www.seam.co/docs/api/acs/credentials/object) grants access.
|
|
288
288
|
*/
|
|
289
289
|
get '/acs/credentials/list_accessible_entrances'(): (parameters: AcsCredentialsListAccessibleEntrancesParameters, options?: AcsCredentialsListAccessibleEntrancesOptions) => AcsCredentialsListAccessibleEntrancesRequest;
|
|
290
290
|
/**
|
|
291
|
-
* Unassigns a specified [credential](https://
|
|
291
|
+
* Unassigns a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
292
292
|
*/
|
|
293
293
|
get '/acs/credentials/unassign'(): (parameters: AcsCredentialsUnassignParameters, options?: AcsCredentialsUnassignOptions) => AcsCredentialsUnassignRequest;
|
|
294
294
|
/**
|
|
295
|
-
* Updates the code and ends at date and time for a specified [credential](https://
|
|
295
|
+
* Updates the code and ends at date and time for a specified [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials).
|
|
296
296
|
*/
|
|
297
297
|
get '/acs/credentials/update'(): (parameters: AcsCredentialsUpdateParameters, options?: AcsCredentialsUpdateOptions) => AcsCredentialsUpdateRequest;
|
|
298
298
|
/**
|
|
299
|
-
* Encodes an existing [credential](https://
|
|
299
|
+
* Encodes an existing [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) onto a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners). Either provide an `acs_credential_id` or an `access_method_id`
|
|
300
300
|
*/
|
|
301
301
|
get '/acs/encoders/encode_credential'(): (parameters: AcsEncodersEncodeCredentialParameters, options?: AcsEncodersEncodeCredentialOptions) => AcsEncodersEncodeCredentialRequest;
|
|
302
302
|
/**
|
|
303
|
-
* Returns a specified [encoder](https://
|
|
303
|
+
* Returns a specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
304
304
|
*/
|
|
305
305
|
get '/acs/encoders/get'(): (parameters: AcsEncodersGetParameters, options?: AcsEncodersGetOptions) => AcsEncodersGetRequest;
|
|
306
306
|
/**
|
|
307
|
-
* Returns a list of all [encoders](https://
|
|
307
|
+
* Returns a list of all [encoders](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
308
308
|
*/
|
|
309
309
|
get '/acs/encoders/list'(): (parameters?: AcsEncodersListParameters, options?: AcsEncodersListOptions) => AcsEncodersListRequest;
|
|
310
310
|
/**
|
|
311
|
-
* Scans an encoded [acs_credential](https://
|
|
311
|
+
* Scans an encoded [acs_credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) from a plastic card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners).
|
|
312
312
|
*/
|
|
313
313
|
get '/acs/encoders/scan_credential'(): (parameters: AcsEncodersScanCredentialParameters, options?: AcsEncodersScanCredentialOptions) => AcsEncodersScanCredentialRequest;
|
|
314
314
|
/**
|
|
315
|
-
* Scans a physical card placed on the specified [encoder](https://
|
|
315
|
+
* Scans a physical card placed on the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) and assigns the scanned credential to an ACS user. Provide either an `acs_user_id` or a `user_identity_id`.
|
|
316
316
|
*/
|
|
317
317
|
get '/acs/encoders/scan_to_assign_credential'(): (parameters: AcsEncodersScanToAssignCredentialParameters, options?: AcsEncodersScanToAssignCredentialOptions) => AcsEncodersScanToAssignCredentialRequest;
|
|
318
318
|
/**
|
|
319
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
319
|
+
* Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
320
320
|
*/
|
|
321
321
|
get '/acs/encoders/simulate/next_credential_encode_will_fail'(): (parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters, options?: AcsEncodersSimulateNextCredentialEncodeWillFailOptions) => AcsEncodersSimulateNextCredentialEncodeWillFailRequest;
|
|
322
322
|
/**
|
|
323
|
-
* Simulates that the next attempt to encode a [credential](https://
|
|
323
|
+
* Simulates that the next attempt to encode a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
324
324
|
*/
|
|
325
325
|
get '/acs/encoders/simulate/next_credential_encode_will_succeed'(): (parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters, options?: AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions) => AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest;
|
|
326
326
|
/**
|
|
327
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
327
|
+
* Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will fail. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
328
328
|
*/
|
|
329
329
|
get '/acs/encoders/simulate/next_credential_scan_will_fail'(): (parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters, options?: AcsEncodersSimulateNextCredentialScanWillFailOptions) => AcsEncodersSimulateNextCredentialScanWillFailRequest;
|
|
330
330
|
/**
|
|
331
|
-
* Simulates that the next attempt to scan a [credential](https://
|
|
331
|
+
* Simulates that the next attempt to scan a [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) using the specified [encoder](https://www.seam.co/docs/low-level-apis/access-systems/working-with-card-encoders-and-scanners) will succeed. You can only perform this action within a [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
332
332
|
*/
|
|
333
333
|
get '/acs/encoders/simulate/next_credential_scan_will_succeed'(): (parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters, options?: AcsEncodersSimulateNextCredentialScanWillSucceedOptions) => AcsEncodersSimulateNextCredentialScanWillSucceedRequest;
|
|
334
334
|
/**
|
|
335
|
-
* Returns a specified [access system entrance](https://
|
|
335
|
+
* Returns a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
336
336
|
*/
|
|
337
337
|
get '/acs/entrances/get'(): (parameters: AcsEntrancesGetParameters, options?: AcsEntrancesGetOptions) => AcsEntrancesGetRequest;
|
|
338
338
|
/**
|
|
339
|
-
* Grants a specified [access system user](https://
|
|
339
|
+
* Grants a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) access to a specified [access system entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
340
340
|
*/
|
|
341
341
|
get '/acs/entrances/grant_access'(): (parameters: AcsEntrancesGrantAccessParameters, options?: AcsEntrancesGrantAccessOptions) => AcsEntrancesGrantAccessRequest;
|
|
342
342
|
/**
|
|
343
|
-
* Returns a list of all [access system entrances](https://
|
|
343
|
+
* Returns a list of all [access system entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
344
344
|
*/
|
|
345
345
|
get '/acs/entrances/list'(): (parameters?: AcsEntrancesListParameters, options?: AcsEntrancesListOptions) => AcsEntrancesListRequest;
|
|
346
346
|
/**
|
|
347
|
-
* Returns a list of all [credentials](https://
|
|
347
|
+
* Returns a list of all [credentials](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) with access to a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).
|
|
348
348
|
*/
|
|
349
349
|
get '/acs/entrances/list_credentials_with_access'(): (parameters: AcsEntrancesListCredentialsWithAccessParameters, options?: AcsEntrancesListCredentialsWithAccessOptions) => AcsEntrancesListCredentialsWithAccessRequest;
|
|
350
350
|
/**
|
|
351
|
-
* Remotely unlocks a specified [entrance](https://
|
|
351
|
+
* Remotely unlocks a specified [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) using a cloud_key credential. Returns an action attempt that tracks the progress of the unlock operation.
|
|
352
352
|
*/
|
|
353
353
|
get '/acs/entrances/unlock'(): (parameters: AcsEntrancesUnlockParameters, options?: AcsEntrancesUnlockOptions) => AcsEntrancesUnlockRequest;
|
|
354
354
|
/**
|
|
355
|
-
* Returns a specified [access system](https://
|
|
355
|
+
* Returns a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
356
356
|
*/
|
|
357
357
|
get '/acs/systems/get'(): (parameters: AcsSystemsGetParameters, options?: AcsSystemsGetOptions) => AcsSystemsGetRequest;
|
|
358
358
|
/**
|
|
359
|
-
* Returns a list of all [access systems](https://
|
|
359
|
+
* Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
360
360
|
*
|
|
361
361
|
* To filter the list of returned access systems by a specific connected account ID, include the `connected_account_id` in the request body. If you omit the `connected_account_id` parameter, the response includes all access systems connected to your workspace.
|
|
362
362
|
*/
|
|
363
363
|
get '/acs/systems/list'(): (parameters?: AcsSystemsListParameters, options?: AcsSystemsListOptions) => AcsSystemsListRequest;
|
|
364
364
|
/**
|
|
365
|
-
* Returns a list of all credential manager systems that are compatible with a specified [access system](https://
|
|
365
|
+
* Returns a list of all credential manager systems that are compatible with a specified [access system](https://www.seam.co/docs/low-level-apis/access-systems).
|
|
366
366
|
*
|
|
367
367
|
* Specify the access system for which you want to retrieve all compatible credential manager systems by including the corresponding `acs_system_id` in the request body.
|
|
368
368
|
*/
|
|
@@ -372,115 +372,115 @@ export declare class SeamHttpEndpoints {
|
|
|
372
372
|
*/
|
|
373
373
|
get '/acs/systems/report_devices'(): (parameters: AcsSystemsReportDevicesParameters, options?: AcsSystemsReportDevicesOptions) => AcsSystemsReportDevicesRequest;
|
|
374
374
|
/**
|
|
375
|
-
* Adds a specified [access system user](https://
|
|
375
|
+
* 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).
|
|
376
376
|
*/
|
|
377
377
|
get '/acs/users/add_to_access_group'(): (parameters: AcsUsersAddToAccessGroupParameters, options?: AcsUsersAddToAccessGroupOptions) => AcsUsersAddToAccessGroupRequest;
|
|
378
378
|
/**
|
|
379
|
-
* Creates a new [access system user](https://
|
|
379
|
+
* Creates a new [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
380
380
|
*/
|
|
381
381
|
get '/acs/users/create'(): (parameters: AcsUsersCreateParameters, options?: AcsUsersCreateOptions) => AcsUsersCreateRequest;
|
|
382
382
|
/**
|
|
383
|
-
* Deletes a specified [access system user](https://
|
|
383
|
+
* 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).
|
|
384
384
|
*/
|
|
385
385
|
get '/acs/users/delete'(): (parameters: AcsUsersDeleteParameters, options?: AcsUsersDeleteOptions) => AcsUsersDeleteRequest;
|
|
386
386
|
/**
|
|
387
|
-
* Returns a specified [access system user](https://
|
|
387
|
+
* Returns a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
388
388
|
*/
|
|
389
389
|
get '/acs/users/get'(): (parameters: AcsUsersGetParameters, options?: AcsUsersGetOptions) => AcsUsersGetRequest;
|
|
390
390
|
/**
|
|
391
|
-
* Returns a list of all [access system users](https://
|
|
391
|
+
* Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
392
392
|
*/
|
|
393
393
|
get '/acs/users/list'(): (parameters?: AcsUsersListParameters, options?: AcsUsersListOptions) => AcsUsersListRequest;
|
|
394
394
|
/**
|
|
395
|
-
* Lists the [entrances](https://
|
|
395
|
+
* 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.
|
|
396
396
|
*/
|
|
397
397
|
get '/acs/users/list_accessible_entrances'(): (parameters: AcsUsersListAccessibleEntrancesParameters, options?: AcsUsersListAccessibleEntrancesOptions) => AcsUsersListAccessibleEntrancesRequest;
|
|
398
398
|
/**
|
|
399
|
-
* Removes a specified [access system user](https://
|
|
399
|
+
* 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).
|
|
400
400
|
*/
|
|
401
401
|
get '/acs/users/remove_from_access_group'(): (parameters: AcsUsersRemoveFromAccessGroupParameters, options?: AcsUsersRemoveFromAccessGroupOptions) => AcsUsersRemoveFromAccessGroupRequest;
|
|
402
402
|
/**
|
|
403
|
-
* Revokes access to all [entrances](https://
|
|
403
|
+
* 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).
|
|
404
404
|
*/
|
|
405
405
|
get '/acs/users/revoke_access_to_all_entrances'(): (parameters: AcsUsersRevokeAccessToAllEntrancesParameters, options?: AcsUsersRevokeAccessToAllEntrancesOptions) => AcsUsersRevokeAccessToAllEntrancesRequest;
|
|
406
406
|
/**
|
|
407
|
-
* [Suspends](https://
|
|
407
|
+
* [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.
|
|
408
408
|
*/
|
|
409
409
|
get '/acs/users/suspend'(): (parameters: AcsUsersSuspendParameters, options?: AcsUsersSuspendOptions) => AcsUsersSuspendRequest;
|
|
410
410
|
/**
|
|
411
|
-
* [Unsuspends](https://
|
|
411
|
+
* [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.
|
|
412
412
|
*/
|
|
413
413
|
get '/acs/users/unsuspend'(): (parameters: AcsUsersUnsuspendParameters, options?: AcsUsersUnsuspendOptions) => AcsUsersUnsuspendRequest;
|
|
414
414
|
/**
|
|
415
|
-
* Updates the properties of a specified [access system user](https://
|
|
415
|
+
* Updates the properties of a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management).
|
|
416
416
|
*/
|
|
417
417
|
get '/acs/users/update'(): (parameters: AcsUsersUpdateParameters, options?: AcsUsersUpdateOptions) => AcsUsersUpdateRequest;
|
|
418
418
|
/**
|
|
419
|
-
* Returns a specified [action attempt](https://
|
|
419
|
+
* Returns a specified [action attempt](https://www.seam.co/docs/core-concepts/action-attempts).
|
|
420
420
|
*/
|
|
421
421
|
get '/action_attempts/get'(): (parameters: ActionAttemptsGetParameters, options?: ActionAttemptsGetOptions) => ActionAttemptsGetRequest;
|
|
422
422
|
/**
|
|
423
|
-
* Returns a list of the [action attempts](https://
|
|
423
|
+
* 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.
|
|
424
424
|
*/
|
|
425
425
|
get '/action_attempts/list'(): (parameters?: ActionAttemptsListParameters, options?: ActionAttemptsListOptions) => ActionAttemptsListRequest;
|
|
426
426
|
/**
|
|
427
|
-
* Creates a new [client session](https://
|
|
427
|
+
* Creates a new [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
428
428
|
*/
|
|
429
429
|
get '/client_sessions/create'(): (parameters?: ClientSessionsCreateParameters, options?: ClientSessionsCreateOptions) => ClientSessionsCreateRequest;
|
|
430
430
|
/**
|
|
431
|
-
* Deletes a [client session](https://
|
|
431
|
+
* Deletes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
432
432
|
*/
|
|
433
433
|
get '/client_sessions/delete'(): (parameters: ClientSessionsDeleteParameters, options?: ClientSessionsDeleteOptions) => ClientSessionsDeleteRequest;
|
|
434
434
|
/**
|
|
435
|
-
* Returns a specified [client session](https://
|
|
435
|
+
* Returns a specified [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
436
436
|
*/
|
|
437
437
|
get '/client_sessions/get'(): (parameters?: ClientSessionsGetParameters, options?: ClientSessionsGetOptions) => ClientSessionsGetRequest;
|
|
438
438
|
/**
|
|
439
|
-
* Returns a [client session](https://
|
|
439
|
+
* 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.
|
|
440
440
|
*/
|
|
441
441
|
get '/client_sessions/get_or_create'(): (parameters?: ClientSessionsGetOrCreateParameters, options?: ClientSessionsGetOrCreateOptions) => ClientSessionsGetOrCreateRequest;
|
|
442
442
|
/**
|
|
443
|
-
* Grants a [client session](https://
|
|
443
|
+
* 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.
|
|
444
444
|
*/
|
|
445
445
|
get '/client_sessions/grant_access'(): (parameters: ClientSessionsGrantAccessParameters, options?: ClientSessionsGrantAccessOptions) => ClientSessionsGrantAccessRequest;
|
|
446
446
|
/**
|
|
447
|
-
* Returns a list of all [client sessions](https://
|
|
447
|
+
* Returns a list of all [client sessions](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
448
448
|
*/
|
|
449
449
|
get '/client_sessions/list'(): (parameters?: ClientSessionsListParameters, options?: ClientSessionsListOptions) => ClientSessionsListRequest;
|
|
450
450
|
/**
|
|
451
|
-
* Revokes a [client session](https://
|
|
451
|
+
* Revokes a [client session](https://www.seam.co/docs/core-concepts/authentication/client-session-tokens).
|
|
452
452
|
*
|
|
453
|
-
* Note that [deleting a client session](https://
|
|
453
|
+
* Note that [deleting a client session](https://www.seam.co/docs/api/client_sessions/delete) is a separate action.
|
|
454
454
|
*/
|
|
455
455
|
get '/client_sessions/revoke'(): (parameters: ClientSessionsRevokeParameters, options?: ClientSessionsRevokeOptions) => ClientSessionsRevokeRequest;
|
|
456
456
|
/**
|
|
457
|
-
* Creates a new [Connect Webview](https://
|
|
457
|
+
* Creates a new [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
458
458
|
*
|
|
459
459
|
* 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.
|
|
460
460
|
*
|
|
461
461
|
* 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.
|
|
462
462
|
*
|
|
463
|
-
* See also: [Connect Webview Process](https://
|
|
463
|
+
* See also: [Connect Webview Process](https://www.seam.co/docs/core-concepts/connect-webviews/connect-webview-process).
|
|
464
464
|
*/
|
|
465
465
|
get '/connect_webviews/create'(): (parameters?: ConnectWebviewsCreateParameters, options?: ConnectWebviewsCreateOptions) => ConnectWebviewsCreateRequest;
|
|
466
466
|
/**
|
|
467
|
-
* Deletes a [Connect Webview](https://
|
|
467
|
+
* Deletes a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
468
468
|
*
|
|
469
469
|
* You do not need to delete a Connect Webview once a user completes it. Instead, you can simply ignore completed Connect Webviews.
|
|
470
470
|
*/
|
|
471
471
|
get '/connect_webviews/delete'(): (parameters: ConnectWebviewsDeleteParameters, options?: ConnectWebviewsDeleteOptions) => ConnectWebviewsDeleteRequest;
|
|
472
472
|
/**
|
|
473
|
-
* Returns a specified [Connect Webview](https://
|
|
473
|
+
* Returns a specified [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
474
474
|
*
|
|
475
475
|
* 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.
|
|
476
476
|
*/
|
|
477
477
|
get '/connect_webviews/get'(): (parameters: ConnectWebviewsGetParameters, options?: ConnectWebviewsGetOptions) => ConnectWebviewsGetRequest;
|
|
478
478
|
/**
|
|
479
|
-
* Returns a list of all [Connect Webviews](https://
|
|
479
|
+
* Returns a list of all [Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews).
|
|
480
480
|
*/
|
|
481
481
|
get '/connect_webviews/list'(): (parameters?: ConnectWebviewsListParameters, options?: ConnectWebviewsListOptions) => ConnectWebviewsListRequest;
|
|
482
482
|
/**
|
|
483
|
-
* Deletes a specified [connected account](https://
|
|
483
|
+
* Deletes a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
484
484
|
*
|
|
485
485
|
* 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.
|
|
486
486
|
*
|
|
@@ -488,23 +488,23 @@ export declare class SeamHttpEndpoints {
|
|
|
488
488
|
*/
|
|
489
489
|
get '/connected_accounts/delete'(): (parameters: ConnectedAccountsDeleteParameters, options?: ConnectedAccountsDeleteOptions) => ConnectedAccountsDeleteRequest;
|
|
490
490
|
/**
|
|
491
|
-
* Returns a specified [connected account](https://
|
|
491
|
+
* Returns a specified [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
492
492
|
*/
|
|
493
493
|
get '/connected_accounts/get'(): (parameters: ConnectedAccountsGetParameters, options?: ConnectedAccountsGetOptions) => ConnectedAccountsGetRequest;
|
|
494
494
|
/**
|
|
495
|
-
* Returns a list of all [connected accounts](https://
|
|
495
|
+
* Returns a list of all [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
496
496
|
*/
|
|
497
497
|
get '/connected_accounts/list'(): (parameters?: ConnectedAccountsListParameters, options?: ConnectedAccountsListOptions) => ConnectedAccountsListRequest;
|
|
498
498
|
/**
|
|
499
|
-
* Request a [connected account](https://
|
|
499
|
+
* Request a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) sync attempt for the specified `connected_account_id`.
|
|
500
500
|
*/
|
|
501
501
|
get '/connected_accounts/sync'(): (parameters: ConnectedAccountsSyncParameters, options?: ConnectedAccountsSyncOptions) => ConnectedAccountsSyncRequest;
|
|
502
502
|
/**
|
|
503
|
-
* Updates a [connected account](https://
|
|
503
|
+
* Updates a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts).
|
|
504
504
|
*/
|
|
505
505
|
get '/connected_accounts/update'(): (parameters: ConnectedAccountsUpdateParameters, options?: ConnectedAccountsUpdateOptions) => ConnectedAccountsUpdateRequest;
|
|
506
506
|
/**
|
|
507
|
-
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://
|
|
507
|
+
* Simulates a connected account becoming disconnected from Seam. Only applicable for [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
508
508
|
*/
|
|
509
509
|
get '/connected_accounts/simulate/disconnect'(): (parameters: ConnectedAccountsSimulateDisconnectParameters, options?: ConnectedAccountsSimulateDisconnectOptions) => ConnectedAccountsSimulateDisconnectRequest;
|
|
510
510
|
/**
|
|
@@ -521,21 +521,21 @@ export declare class SeamHttpEndpoints {
|
|
|
521
521
|
*/
|
|
522
522
|
get '/customers/push_data'(): (parameters: CustomersPushDataParameters, options?: CustomersPushDataOptions) => CustomersPushDataRequest;
|
|
523
523
|
/**
|
|
524
|
-
* Returns a specified [device](https://
|
|
524
|
+
* Returns a specified [device](https://www.seam.co/docs/core-concepts/devices).
|
|
525
525
|
*
|
|
526
526
|
* You must specify either `device_id` or `name`.
|
|
527
527
|
*/
|
|
528
528
|
get '/devices/get'(): (parameters: DevicesGetParameters, options?: DevicesGetOptions) => DevicesGetRequest;
|
|
529
529
|
/**
|
|
530
|
-
* Returns a list of all [devices](https://
|
|
530
|
+
* Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices).
|
|
531
531
|
*/
|
|
532
532
|
get '/devices/list'(): (parameters?: DevicesListParameters, options?: DevicesListOptions) => DevicesListRequest;
|
|
533
533
|
/**
|
|
534
534
|
* Returns a list of all device providers.
|
|
535
535
|
*
|
|
536
|
-
* The information that this endpoint returns for each provider includes a set of [capability flags](https://
|
|
536
|
+
* The information that this endpoint returns for each provider includes a set of [capability flags](https://www.seam.co/docs/capability-guides/device-and-system-capabilities#capability-flags), such as `device_provider.can_remotely_unlock`. If at least one supported device from a provider has a specific capability, the corresponding capability flag is `true`.
|
|
537
537
|
*
|
|
538
|
-
* When you create a [Connect Webview](https://
|
|
538
|
+
* When you create a [Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews), you can customize the providers—that is, the brands—that it displays. In the `/connect_webviews/create` request, include the desired set of device provider keys in the `accepted_providers` parameter. See also [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews).
|
|
539
539
|
*/
|
|
540
540
|
get '/devices/list_device_providers'(): (parameters?: DevicesListDeviceProvidersParameters, options?: DevicesListDeviceProvidersOptions) => DevicesListDeviceProvidersRequest;
|
|
541
541
|
/**
|
|
@@ -543,13 +543,13 @@ export declare class SeamHttpEndpoints {
|
|
|
543
543
|
*/
|
|
544
544
|
get '/devices/report_provider_metadata'(): (parameters: DevicesReportProviderMetadataParameters, options?: DevicesReportProviderMetadataOptions) => DevicesReportProviderMetadataRequest;
|
|
545
545
|
/**
|
|
546
|
-
* Updates a specified [device](https://
|
|
546
|
+
* Updates a specified [device](https://www.seam.co/docs/core-concepts/devices).
|
|
547
547
|
*
|
|
548
|
-
* You can add or change [custom metadata](https://
|
|
548
|
+
* You can add or change [custom metadata](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device) for a device, change the device's name, or [convert a managed device to unmanaged](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
549
549
|
*/
|
|
550
550
|
get '/devices/update'(): (parameters: DevicesUpdateParameters, options?: DevicesUpdateOptions) => DevicesUpdateRequest;
|
|
551
551
|
/**
|
|
552
|
-
* Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://
|
|
552
|
+
* Simulates connecting a device to Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
|
|
553
553
|
*/
|
|
554
554
|
get '/devices/simulate/connect'(): (parameters: DevicesSimulateConnectParameters, options?: DevicesSimulateConnectOptions) => DevicesSimulateConnectRequest;
|
|
555
555
|
/**
|
|
@@ -560,7 +560,7 @@ export declare class SeamHttpEndpoints {
|
|
|
560
560
|
*/
|
|
561
561
|
get '/devices/simulate/connect_to_hub'(): (parameters: DevicesSimulateConnectToHubParameters, options?: DevicesSimulateConnectToHubOptions) => DevicesSimulateConnectToHubRequest;
|
|
562
562
|
/**
|
|
563
|
-
* Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://
|
|
563
|
+
* Simulates disconnecting a device from Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
|
|
564
564
|
*/
|
|
565
565
|
get '/devices/simulate/disconnect'(): (parameters: DevicesSimulateDisconnectParameters, options?: DevicesSimulateDisconnectOptions) => DevicesSimulateDisconnectRequest;
|
|
566
566
|
/**
|
|
@@ -578,128 +578,128 @@ export declare class SeamHttpEndpoints {
|
|
|
578
578
|
*/
|
|
579
579
|
get '/devices/simulate/paid_subscription'(): (parameters: DevicesSimulatePaidSubscriptionParameters, options?: DevicesSimulatePaidSubscriptionOptions) => DevicesSimulatePaidSubscriptionRequest;
|
|
580
580
|
/**
|
|
581
|
-
* Simulates removing a device from Seam. Only applicable for [sandbox devices](https://
|
|
581
|
+
* Simulates removing a device from Seam. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your App Against Device Disconnection and Removal](https://www.seam.co/docs/core-concepts/devices/testing-your-app-against-device-disconnection-and-removal).
|
|
582
582
|
*/
|
|
583
583
|
get '/devices/simulate/remove'(): (parameters: DevicesSimulateRemoveParameters, options?: DevicesSimulateRemoveOptions) => DevicesSimulateRemoveRequest;
|
|
584
584
|
/**
|
|
585
|
-
* Returns a specified [unmanaged device](https://
|
|
585
|
+
* Returns a specified [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
586
586
|
*
|
|
587
|
-
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://
|
|
587
|
+
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
|
|
588
588
|
*
|
|
589
589
|
* You must specify either `device_id` or `name`.
|
|
590
590
|
*/
|
|
591
591
|
get '/devices/unmanaged/get'(): (parameters: DevicesUnmanagedGetParameters, options?: DevicesUnmanagedGetOptions) => DevicesUnmanagedGetRequest;
|
|
592
592
|
/**
|
|
593
|
-
* Returns a list of all [unmanaged devices](https://
|
|
593
|
+
* Returns a list of all [unmanaged devices](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices).
|
|
594
594
|
*
|
|
595
|
-
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://
|
|
595
|
+
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
|
|
596
596
|
*/
|
|
597
597
|
get '/devices/unmanaged/list'(): (parameters?: DevicesUnmanagedListParameters, options?: DevicesUnmanagedListOptions) => DevicesUnmanagedListRequest;
|
|
598
598
|
/**
|
|
599
|
-
* Updates a specified [unmanaged device](https://
|
|
599
|
+
* Updates a specified [unmanaged device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices). To convert an unmanaged device to managed, set `is_managed` to `true`.
|
|
600
600
|
*
|
|
601
|
-
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://
|
|
601
|
+
* An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes) on an unmanaged device are unmanaged. To control an unmanaged device with Seam, [convert it to a managed device](https://www.seam.co/docs/core-concepts/devices/managed-and-unmanaged-devices#convert-an-unmanaged-device-to-managed).
|
|
602
602
|
*/
|
|
603
603
|
get '/devices/unmanaged/update'(): (parameters: DevicesUnmanagedUpdateParameters, options?: DevicesUnmanagedUpdateOptions) => DevicesUnmanagedUpdateRequest;
|
|
604
604
|
/**
|
|
605
|
-
* Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://
|
|
605
|
+
* Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to retrieve an event that already took place.
|
|
606
606
|
*/
|
|
607
607
|
get '/events/get'(): (parameters: EventsGetParameters, options?: EventsGetOptions) => EventsGetRequest;
|
|
608
608
|
/**
|
|
609
|
-
* Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://
|
|
609
|
+
* Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://www.seam.co/docs/developer-tools/webhooks), but it enables you to filter or see events that already took place.
|
|
610
610
|
*/
|
|
611
611
|
get '/events/list'(): (parameters: EventsListParameters, options?: EventsListOptions) => EventsListRequest;
|
|
612
612
|
/**
|
|
613
|
-
* Deletes a specified [Instant Key](https://
|
|
613
|
+
* Deletes a specified [Instant Key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
614
614
|
*/
|
|
615
615
|
get '/instant_keys/delete'(): (parameters: InstantKeysDeleteParameters, options?: InstantKeysDeleteOptions) => InstantKeysDeleteRequest;
|
|
616
616
|
/**
|
|
617
|
-
* Gets an [instant key](https://
|
|
617
|
+
* Gets an [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
618
618
|
*/
|
|
619
619
|
get '/instant_keys/get'(): (parameters: InstantKeysGetParameters, options?: InstantKeysGetOptions) => InstantKeysGetRequest;
|
|
620
620
|
/**
|
|
621
|
-
* Returns a list of all [instant keys](https://
|
|
621
|
+
* Returns a list of all [instant keys](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys).
|
|
622
622
|
*/
|
|
623
623
|
get '/instant_keys/list'(): (parameters?: InstantKeysListParameters, options?: InstantKeysListOptions) => InstantKeysListRequest;
|
|
624
624
|
/**
|
|
625
|
-
* Configures the auto-lock setting for a specified [lock](https://
|
|
625
|
+
* Configures the auto-lock setting for a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
626
626
|
*/
|
|
627
627
|
get '/locks/configure_auto_lock'(): (parameters: LocksConfigureAutoLockParameters, options?: LocksConfigureAutoLockOptions) => LocksConfigureAutoLockRequest;
|
|
628
628
|
/**
|
|
629
|
-
* Returns a specified [lock](https://
|
|
629
|
+
* Returns a specified [lock](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
630
630
|
* @deprecated Use `/devices/get` instead.
|
|
631
631
|
*/
|
|
632
632
|
get '/locks/get'(): (parameters: LocksGetParameters, options?: LocksGetOptions) => LocksGetRequest;
|
|
633
633
|
/**
|
|
634
|
-
* Returns a list of all [locks](https://
|
|
634
|
+
* Returns a list of all [locks](https://www.seam.co/docs/low-level-apis/smart-locks).
|
|
635
635
|
*/
|
|
636
636
|
get '/locks/list'(): (parameters?: LocksListParameters, options?: LocksListOptions) => LocksListRequest;
|
|
637
637
|
/**
|
|
638
|
-
* Locks a [lock](https://
|
|
638
|
+
* Locks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock).
|
|
639
639
|
*/
|
|
640
640
|
get '/locks/lock_door'(): (parameters: LocksLockDoorParameters, options?: LocksLockDoorOptions) => LocksLockDoorRequest;
|
|
641
641
|
/**
|
|
642
|
-
* Unlocks a [lock](https://
|
|
642
|
+
* Unlocks a [lock](https://www.seam.co/docs/low-level-apis/smart-locks). See also [Locking and Unlocking Smart Locks](https://www.seam.co/docs/low-level-apis/smart-locks/lock-and-unlock).
|
|
643
643
|
*/
|
|
644
644
|
get '/locks/unlock_door'(): (parameters: LocksUnlockDoorParameters, options?: LocksUnlockDoorOptions) => LocksUnlockDoorRequest;
|
|
645
645
|
/**
|
|
646
|
-
* Simulates the entry of a code on a keypad. You can only perform this action for [August](https://
|
|
646
|
+
* Simulates the entry of a code on a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
647
647
|
*/
|
|
648
648
|
get '/locks/simulate/keypad_code_entry'(): (parameters: LocksSimulateKeypadCodeEntryParameters, options?: LocksSimulateKeypadCodeEntryOptions) => LocksSimulateKeypadCodeEntryRequest;
|
|
649
649
|
/**
|
|
650
|
-
* Simulates a manual lock action using a keypad. You can only perform this action for [August](https://
|
|
650
|
+
* Simulates a manual lock action using a keypad. You can only perform this action for [August](https://www.seam.co/docs/device-and-system-integration-guides/august-locks) devices within [sandbox workspaces](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces).
|
|
651
651
|
*/
|
|
652
652
|
get '/locks/simulate/manual_lock_via_keypad'(): (parameters: LocksSimulateManualLockViaKeypadParameters, options?: LocksSimulateManualLockViaKeypadOptions) => LocksSimulateManualLockViaKeypadRequest;
|
|
653
653
|
/**
|
|
654
|
-
* Returns a list of all [noise sensors](https://
|
|
654
|
+
* Returns a list of all [noise sensors](https://www.seam.co/docs/capability-guides/noise-sensors).
|
|
655
655
|
*/
|
|
656
656
|
get '/noise_sensors/list'(): (parameters?: NoiseSensorsListParameters, options?: NoiseSensorsListOptions) => NoiseSensorsListRequest;
|
|
657
657
|
/**
|
|
658
|
-
* Creates a new [noise threshold](https://
|
|
658
|
+
* 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.
|
|
659
659
|
*/
|
|
660
660
|
get '/noise_sensors/noise_thresholds/create'(): (parameters: NoiseSensorsNoiseThresholdsCreateParameters, options?: NoiseSensorsNoiseThresholdsCreateOptions) => NoiseSensorsNoiseThresholdsCreateRequest;
|
|
661
661
|
/**
|
|
662
|
-
* Deletes a [noise threshold](https://
|
|
662
|
+
* 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).
|
|
663
663
|
*/
|
|
664
664
|
get '/noise_sensors/noise_thresholds/delete'(): (parameters: NoiseSensorsNoiseThresholdsDeleteParameters, options?: NoiseSensorsNoiseThresholdsDeleteOptions) => NoiseSensorsNoiseThresholdsDeleteRequest;
|
|
665
665
|
/**
|
|
666
|
-
* Returns a specified [noise threshold](https://
|
|
666
|
+
* 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).
|
|
667
667
|
*/
|
|
668
668
|
get '/noise_sensors/noise_thresholds/get'(): (parameters: NoiseSensorsNoiseThresholdsGetParameters, options?: NoiseSensorsNoiseThresholdsGetOptions) => NoiseSensorsNoiseThresholdsGetRequest;
|
|
669
669
|
/**
|
|
670
|
-
* Returns a list of all [noise thresholds](https://
|
|
670
|
+
* 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).
|
|
671
671
|
*/
|
|
672
672
|
get '/noise_sensors/noise_thresholds/list'(): (parameters: NoiseSensorsNoiseThresholdsListParameters, options?: NoiseSensorsNoiseThresholdsListOptions) => NoiseSensorsNoiseThresholdsListRequest;
|
|
673
673
|
/**
|
|
674
|
-
* Updates a [noise threshold](https://
|
|
674
|
+
* 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).
|
|
675
675
|
*/
|
|
676
676
|
get '/noise_sensors/noise_thresholds/update'(): (parameters: NoiseSensorsNoiseThresholdsUpdateParameters, options?: NoiseSensorsNoiseThresholdsUpdateOptions) => NoiseSensorsNoiseThresholdsUpdateRequest;
|
|
677
677
|
/**
|
|
678
|
-
* Simulates the triggering of a [noise threshold](https://
|
|
678
|
+
* 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).
|
|
679
679
|
*/
|
|
680
680
|
get '/noise_sensors/simulate/trigger_noise_threshold'(): (parameters: NoiseSensorsSimulateTriggerNoiseThresholdParameters, options?: NoiseSensorsSimulateTriggerNoiseThresholdOptions) => NoiseSensorsSimulateTriggerNoiseThresholdRequest;
|
|
681
681
|
/**
|
|
682
|
-
* 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://
|
|
682
|
+
* 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).
|
|
683
683
|
*/
|
|
684
684
|
get '/phones/deactivate'(): (parameters: PhonesDeactivateParameters, options?: PhonesDeactivateOptions) => PhonesDeactivateRequest;
|
|
685
685
|
/**
|
|
686
|
-
* Returns a specified [phone](https://
|
|
686
|
+
* Returns a specified [phone](https://www.seam.co/docs/capability-guides/mobile-access/managing-phones-for-a-user-identity).
|
|
687
687
|
*/
|
|
688
688
|
get '/phones/get'(): (parameters: PhonesGetParameters, options?: PhonesGetOptions) => PhonesGetRequest;
|
|
689
689
|
/**
|
|
690
|
-
* Returns a list of all [phones](https://
|
|
690
|
+
* 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.
|
|
691
691
|
*/
|
|
692
692
|
get '/phones/list'(): (parameters?: PhonesListParameters, options?: PhonesListOptions) => PhonesListRequest;
|
|
693
693
|
/**
|
|
694
|
-
* Creates a new simulated phone in a [sandbox workspace](https://
|
|
694
|
+
* 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).
|
|
695
695
|
*/
|
|
696
696
|
get '/phones/simulate/create_sandbox_phone'(): (parameters: PhonesSimulateCreateSandboxPhoneParameters, options?: PhonesSimulateCreateSandboxPhoneOptions) => PhonesSimulateCreateSandboxPhoneRequest;
|
|
697
697
|
/**
|
|
698
|
-
* Adds [entrances](https://
|
|
698
|
+
* Adds [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) to a specific space.
|
|
699
699
|
*/
|
|
700
700
|
get '/spaces/add_acs_entrances'(): (parameters: SpacesAddAcsEntrancesParameters, options?: SpacesAddAcsEntrancesOptions) => SpacesAddAcsEntrancesRequest;
|
|
701
701
|
/**
|
|
702
|
-
* Adds a [connected account](https://
|
|
702
|
+
* Adds a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to a specific space.
|
|
703
703
|
*/
|
|
704
704
|
get '/spaces/add_connected_account'(): (parameters: SpacesAddConnectedAccountParameters, options?: SpacesAddConnectedAccountOptions) => SpacesAddConnectedAccountRequest;
|
|
705
705
|
/**
|
|
@@ -727,11 +727,11 @@ export declare class SeamHttpEndpoints {
|
|
|
727
727
|
*/
|
|
728
728
|
get '/spaces/list'(): (parameters?: SpacesListParameters, options?: SpacesListOptions) => SpacesListRequest;
|
|
729
729
|
/**
|
|
730
|
-
* Removes [entrances](https://
|
|
730
|
+
* Removes [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) from a specific space.
|
|
731
731
|
*/
|
|
732
732
|
get '/spaces/remove_acs_entrances'(): (parameters: SpacesRemoveAcsEntrancesParameters, options?: SpacesRemoveAcsEntrancesOptions) => SpacesRemoveAcsEntrancesRequest;
|
|
733
733
|
/**
|
|
734
|
-
* Removes a [connected account](https://
|
|
734
|
+
* Removes a [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) from a specific space.
|
|
735
735
|
*/
|
|
736
736
|
get '/spaces/remove_connected_account'(): (parameters: SpacesRemoveConnectedAccountParameters, options?: SpacesRemoveConnectedAccountOptions) => SpacesRemoveConnectedAccountRequest;
|
|
737
737
|
/**
|
|
@@ -743,55 +743,55 @@ export declare class SeamHttpEndpoints {
|
|
|
743
743
|
*/
|
|
744
744
|
get '/spaces/update'(): (parameters?: SpacesUpdateParameters, options?: SpacesUpdateOptions) => SpacesUpdateRequest;
|
|
745
745
|
/**
|
|
746
|
-
* Activates a specified [climate preset](https://
|
|
746
|
+
* Activates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
747
747
|
*/
|
|
748
748
|
get '/thermostats/activate_climate_preset'(): (parameters: ThermostatsActivateClimatePresetParameters, options?: ThermostatsActivateClimatePresetOptions) => ThermostatsActivateClimatePresetRequest;
|
|
749
749
|
/**
|
|
750
|
-
* Sets a specified [thermostat](https://
|
|
750
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [cool mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
751
751
|
*/
|
|
752
752
|
get '/thermostats/cool'(): (parameters: ThermostatsCoolParameters, options?: ThermostatsCoolOptions) => ThermostatsCoolRequest;
|
|
753
753
|
/**
|
|
754
|
-
* Creates a [climate preset](https://
|
|
754
|
+
* Creates a [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
755
755
|
*/
|
|
756
756
|
get '/thermostats/create_climate_preset'(): (parameters: ThermostatsCreateClimatePresetParameters, options?: ThermostatsCreateClimatePresetOptions) => ThermostatsCreateClimatePresetRequest;
|
|
757
757
|
/**
|
|
758
|
-
* Deletes a specified [climate preset](https://
|
|
758
|
+
* Deletes a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
759
759
|
*/
|
|
760
760
|
get '/thermostats/delete_climate_preset'(): (parameters: ThermostatsDeleteClimatePresetParameters, options?: ThermostatsDeleteClimatePresetOptions) => ThermostatsDeleteClimatePresetRequest;
|
|
761
761
|
/**
|
|
762
|
-
* Sets a specified [thermostat](https://
|
|
762
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
763
763
|
*/
|
|
764
764
|
get '/thermostats/heat'(): (parameters: ThermostatsHeatParameters, options?: ThermostatsHeatOptions) => ThermostatsHeatRequest;
|
|
765
765
|
/**
|
|
766
|
-
* Sets a specified [thermostat](https://
|
|
766
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to [heat-cool ("auto") mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
767
767
|
*/
|
|
768
768
|
get '/thermostats/heat_cool'(): (parameters: ThermostatsHeatCoolParameters, options?: ThermostatsHeatCoolOptions) => ThermostatsHeatCoolRequest;
|
|
769
769
|
/**
|
|
770
|
-
* Returns a list of all [thermostats](https://
|
|
770
|
+
* Returns a list of all [thermostats](https://www.seam.co/docs/capability-guides/thermostats).
|
|
771
771
|
*/
|
|
772
772
|
get '/thermostats/list'(): (parameters?: ThermostatsListParameters, options?: ThermostatsListOptions) => ThermostatsListRequest;
|
|
773
773
|
/**
|
|
774
|
-
* Sets a specified [thermostat](https://
|
|
774
|
+
* Sets a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats) to ["off" mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings).
|
|
775
775
|
*/
|
|
776
776
|
get '/thermostats/off'(): (parameters: ThermostatsOffParameters, options?: ThermostatsOffOptions) => ThermostatsOffRequest;
|
|
777
777
|
/**
|
|
778
|
-
* Sets a specified [climate preset](https://
|
|
778
|
+
* Sets a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) as the ["fallback"](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) preset for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
779
779
|
*/
|
|
780
780
|
get '/thermostats/set_fallback_climate_preset'(): (parameters: ThermostatsSetFallbackClimatePresetParameters, options?: ThermostatsSetFallbackClimatePresetOptions) => ThermostatsSetFallbackClimatePresetRequest;
|
|
781
781
|
/**
|
|
782
|
-
* Sets the [fan mode setting](https://
|
|
782
|
+
* Sets the [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
783
783
|
*/
|
|
784
784
|
get '/thermostats/set_fan_mode'(): (parameters: ThermostatsSetFanModeParameters, options?: ThermostatsSetFanModeOptions) => ThermostatsSetFanModeRequest;
|
|
785
785
|
/**
|
|
786
|
-
* Sets the [HVAC mode](https://
|
|
786
|
+
* Sets the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
787
787
|
*/
|
|
788
788
|
get '/thermostats/set_hvac_mode'(): (parameters: ThermostatsSetHvacModeParameters, options?: ThermostatsSetHvacModeOptions) => ThermostatsSetHvacModeRequest;
|
|
789
789
|
/**
|
|
790
|
-
* Sets a [temperature threshold](https://
|
|
790
|
+
* Sets a [temperature threshold](https://www.seam.co/docs/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) for a specified thermostat. Seam emits a `thermostat.temperature_threshold_exceeded` event and adds a warning on a thermostat if it reports a temperature outside the threshold range.
|
|
791
791
|
*/
|
|
792
792
|
get '/thermostats/set_temperature_threshold'(): (parameters: ThermostatsSetTemperatureThresholdParameters, options?: ThermostatsSetTemperatureThresholdOptions) => ThermostatsSetTemperatureThresholdRequest;
|
|
793
793
|
/**
|
|
794
|
-
* Updates a specified [climate preset](https://
|
|
794
|
+
* Updates a specified [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
795
795
|
*/
|
|
796
796
|
get '/thermostats/update_climate_preset'(): (parameters: ThermostatsUpdateClimatePresetParameters, options?: ThermostatsUpdateClimatePresetOptions) => ThermostatsUpdateClimatePresetRequest;
|
|
797
797
|
/**
|
|
@@ -811,35 +811,35 @@ export declare class SeamHttpEndpoints {
|
|
|
811
811
|
*/
|
|
812
812
|
get '/thermostats/daily_programs/update'(): (parameters: ThermostatsDailyProgramsUpdateParameters, options?: ThermostatsDailyProgramsUpdateOptions) => ThermostatsDailyProgramsUpdateRequest;
|
|
813
813
|
/**
|
|
814
|
-
* Creates a new [thermostat schedule](https://
|
|
814
|
+
* Creates a new [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
815
815
|
*/
|
|
816
816
|
get '/thermostats/schedules/create'(): (parameters: ThermostatsSchedulesCreateParameters, options?: ThermostatsSchedulesCreateOptions) => ThermostatsSchedulesCreateRequest;
|
|
817
817
|
/**
|
|
818
|
-
* Deletes a [thermostat schedule](https://
|
|
818
|
+
* Deletes a [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
819
819
|
*/
|
|
820
820
|
get '/thermostats/schedules/delete'(): (parameters: ThermostatsSchedulesDeleteParameters, options?: ThermostatsSchedulesDeleteOptions) => ThermostatsSchedulesDeleteRequest;
|
|
821
821
|
/**
|
|
822
|
-
* Returns a specified [thermostat schedule](https://
|
|
822
|
+
* Returns a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
823
823
|
*/
|
|
824
824
|
get '/thermostats/schedules/get'(): (parameters: ThermostatsSchedulesGetParameters, options?: ThermostatsSchedulesGetOptions) => ThermostatsSchedulesGetRequest;
|
|
825
825
|
/**
|
|
826
|
-
* Returns a list of all [thermostat schedules](https://
|
|
826
|
+
* Returns a list of all [thermostat schedules](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules) for a specified [thermostat](https://www.seam.co/docs/capability-guides/thermostats).
|
|
827
827
|
*/
|
|
828
828
|
get '/thermostats/schedules/list'(): (parameters: ThermostatsSchedulesListParameters, options?: ThermostatsSchedulesListOptions) => ThermostatsSchedulesListRequest;
|
|
829
829
|
/**
|
|
830
|
-
* Updates a specified [thermostat schedule](https://
|
|
830
|
+
* Updates a specified [thermostat schedule](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-thermostat-schedules).
|
|
831
831
|
*/
|
|
832
832
|
get '/thermostats/schedules/update'(): (parameters: ThermostatsSchedulesUpdateParameters, options?: ThermostatsSchedulesUpdateOptions) => ThermostatsSchedulesUpdateRequest;
|
|
833
833
|
/**
|
|
834
|
-
* Simulates having adjusted the [HVAC mode](https://
|
|
834
|
+
* Simulates having adjusted the [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://www.seam.co/docs/capability-guides/thermostats). Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
|
|
835
835
|
*/
|
|
836
836
|
get '/thermostats/simulate/hvac_mode_adjusted'(): (parameters: ThermostatsSimulateHvacModeAdjustedParameters, options?: ThermostatsSimulateHvacModeAdjustedOptions) => ThermostatsSimulateHvacModeAdjustedRequest;
|
|
837
837
|
/**
|
|
838
|
-
* Simulates a [thermostat](https://
|
|
838
|
+
* Simulates a [thermostat](https://www.seam.co/docs/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://www.seam.co/docs/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).
|
|
839
839
|
*/
|
|
840
840
|
get '/thermostats/simulate/temperature_reached'(): (parameters: ThermostatsSimulateTemperatureReachedParameters, options?: ThermostatsSimulateTemperatureReachedOptions) => ThermostatsSimulateTemperatureReachedRequest;
|
|
841
841
|
/**
|
|
842
|
-
* Adds a specified [access system user](https://
|
|
842
|
+
* Adds a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
843
843
|
*
|
|
844
844
|
* You must specify either `user_identity_id` or `user_identity_key` to identify the user identity.
|
|
845
845
|
*
|
|
@@ -847,47 +847,47 @@ export declare class SeamHttpEndpoints {
|
|
|
847
847
|
*/
|
|
848
848
|
get '/user_identities/add_acs_user'(): (parameters: UserIdentitiesAddAcsUserParameters, options?: UserIdentitiesAddAcsUserOptions) => UserIdentitiesAddAcsUserRequest;
|
|
849
849
|
/**
|
|
850
|
-
* Creates a new [user identity](https://
|
|
850
|
+
* Creates a new [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
851
851
|
*/
|
|
852
852
|
get '/user_identities/create'(): (parameters?: UserIdentitiesCreateParameters, options?: UserIdentitiesCreateOptions) => UserIdentitiesCreateRequest;
|
|
853
853
|
/**
|
|
854
|
-
* Deletes a specified [user identity](https://
|
|
854
|
+
* Deletes a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This deletes the user identity and all associated resources, including any [credentials](https://www.seam.co/docs/api/acs/credentials/object), [acs users](https://www.seam.co/docs/api/acs/users/object) and [client sessions](https://www.seam.co/docs/api/client_sessions/object).
|
|
855
855
|
*/
|
|
856
856
|
get '/user_identities/delete'(): (parameters: UserIdentitiesDeleteParameters, options?: UserIdentitiesDeleteOptions) => UserIdentitiesDeleteRequest;
|
|
857
857
|
/**
|
|
858
|
-
* Generates a new [instant key](https://
|
|
858
|
+
* Generates a new [instant key](https://www.seam.co/docs/use-cases/granting-access/using-instant-keys) for a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
859
859
|
*/
|
|
860
860
|
get '/user_identities/generate_instant_key'(): (parameters: UserIdentitiesGenerateInstantKeyParameters, options?: UserIdentitiesGenerateInstantKeyOptions) => UserIdentitiesGenerateInstantKeyRequest;
|
|
861
861
|
/**
|
|
862
|
-
* Returns a specified [user identity](https://
|
|
862
|
+
* Returns a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
863
863
|
*/
|
|
864
864
|
get '/user_identities/get'(): (parameters: UserIdentitiesGetParameters, options?: UserIdentitiesGetOptions) => UserIdentitiesGetRequest;
|
|
865
865
|
/**
|
|
866
|
-
* Grants a specified [user identity](https://
|
|
866
|
+
* Grants a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) access to a specified [device](https://www.seam.co/docs/core-concepts/devices).
|
|
867
867
|
*/
|
|
868
868
|
get '/user_identities/grant_access_to_device'(): (parameters: UserIdentitiesGrantAccessToDeviceParameters, options?: UserIdentitiesGrantAccessToDeviceOptions) => UserIdentitiesGrantAccessToDeviceRequest;
|
|
869
869
|
/**
|
|
870
|
-
* Returns a list of all [user identities](https://
|
|
870
|
+
* Returns a list of all [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
871
871
|
*/
|
|
872
872
|
get '/user_identities/list'(): (parameters?: UserIdentitiesListParameters, options?: UserIdentitiesListOptions) => UserIdentitiesListRequest;
|
|
873
873
|
/**
|
|
874
|
-
* Returns a list of all [devices](https://
|
|
874
|
+
* Returns a list of all [devices](https://www.seam.co/docs/core-concepts/devices) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes devices derived from the access grants assigned to the user identity and devices directly linked to the user identity.
|
|
875
875
|
*/
|
|
876
876
|
get '/user_identities/list_accessible_devices'(): (parameters: UserIdentitiesListAccessibleDevicesParameters, options?: UserIdentitiesListAccessibleDevicesOptions) => UserIdentitiesListAccessibleDevicesRequest;
|
|
877
877
|
/**
|
|
878
|
-
* Returns a list of all [ACS entrances](https://
|
|
878
|
+
* Returns a list of all [ACS entrances](https://www.seam.co/docs/api/acs/entrances/object) accessible to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity). This includes entrances derived from the access grants assigned to the user identity and entrances accessible through ACS users linked to the user identity.
|
|
879
879
|
*/
|
|
880
880
|
get '/user_identities/list_accessible_entrances'(): (parameters: UserIdentitiesListAccessibleEntrancesParameters, options?: UserIdentitiesListAccessibleEntrancesOptions) => UserIdentitiesListAccessibleEntrancesRequest;
|
|
881
881
|
/**
|
|
882
|
-
* Returns a list of all [access systems](https://
|
|
882
|
+
* Returns a list of all [access systems](https://www.seam.co/docs/low-level-apis/access-systems) associated with a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
883
883
|
*/
|
|
884
884
|
get '/user_identities/list_acs_systems'(): (parameters: UserIdentitiesListAcsSystemsParameters, options?: UserIdentitiesListAcsSystemsOptions) => UserIdentitiesListAcsSystemsRequest;
|
|
885
885
|
/**
|
|
886
|
-
* Returns a list of all [access system users](https://
|
|
886
|
+
* Returns a list of all [access system users](https://www.seam.co/docs/low-level-apis/access-systems/user-management) assigned to a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
887
887
|
*/
|
|
888
888
|
get '/user_identities/list_acs_users'(): (parameters: UserIdentitiesListAcsUsersParameters, options?: UserIdentitiesListAcsUsersOptions) => UserIdentitiesListAcsUsersRequest;
|
|
889
889
|
/**
|
|
890
|
-
* Merges one or more [user identities](https://
|
|
890
|
+
* Merges one or more [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) into a primary user identity, for when the same person ended up with more than one user identity.
|
|
891
891
|
*
|
|
892
892
|
* The primary user identity takes on any email address or phone number it was missing from the user identities merged into it, and the merged user identities are then deleted. Their IDs and keys keep working: looking one up returns the primary user identity, and they are listed on it as `merged_user_identity_ids` and `merged_user_identity_keys`.
|
|
893
893
|
*
|
|
@@ -897,69 +897,69 @@ export declare class SeamHttpEndpoints {
|
|
|
897
897
|
*/
|
|
898
898
|
get '/user_identities/merge'(): (parameters: UserIdentitiesMergeParameters, options?: UserIdentitiesMergeOptions) => UserIdentitiesMergeRequest;
|
|
899
899
|
/**
|
|
900
|
-
* Removes a specified [access system user](https://
|
|
900
|
+
* Removes a specified [access system user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
901
901
|
*/
|
|
902
902
|
get '/user_identities/remove_acs_user'(): (parameters: UserIdentitiesRemoveAcsUserParameters, options?: UserIdentitiesRemoveAcsUserOptions) => UserIdentitiesRemoveAcsUserRequest;
|
|
903
903
|
/**
|
|
904
|
-
* Revokes access to a specified [device](https://
|
|
904
|
+
* Revokes access to a specified [device](https://www.seam.co/docs/core-concepts/devices) from a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
905
905
|
*/
|
|
906
906
|
get '/user_identities/revoke_access_to_device'(): (parameters: UserIdentitiesRevokeAccessToDeviceParameters, options?: UserIdentitiesRevokeAccessToDeviceOptions) => UserIdentitiesRevokeAccessToDeviceRequest;
|
|
907
907
|
/**
|
|
908
|
-
* Updates a specified [user identity](https://
|
|
908
|
+
* Updates a specified [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity).
|
|
909
909
|
*/
|
|
910
910
|
get '/user_identities/update'(): (parameters: UserIdentitiesUpdateParameters, options?: UserIdentitiesUpdateOptions) => UserIdentitiesUpdateRequest;
|
|
911
911
|
/**
|
|
912
|
-
* Returns a specified unmanaged [user identity](https://
|
|
912
|
+
* Returns a specified unmanaged [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).
|
|
913
913
|
*/
|
|
914
914
|
get '/user_identities/unmanaged/get'(): (parameters: UserIdentitiesUnmanagedGetParameters, options?: UserIdentitiesUnmanagedGetOptions) => UserIdentitiesUnmanagedGetRequest;
|
|
915
915
|
/**
|
|
916
|
-
* Returns a list of all unmanaged [user identities](https://
|
|
916
|
+
* Returns a list of all unmanaged [user identities](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) (where is_managed = false).
|
|
917
917
|
*/
|
|
918
918
|
get '/user_identities/unmanaged/list'(): (parameters?: UserIdentitiesUnmanagedListParameters, options?: UserIdentitiesUnmanagedListOptions) => UserIdentitiesUnmanagedListRequest;
|
|
919
919
|
/**
|
|
920
|
-
* Updates an unmanaged [user identity](https://
|
|
920
|
+
* Updates an unmanaged [user identity](https://www.seam.co/docs/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) to make it managed.
|
|
921
921
|
*
|
|
922
922
|
* This endpoint can only be used to convert unmanaged user identities to managed ones by setting `is_managed` to `true`. It cannot be used to convert managed user identities back to unmanaged.
|
|
923
923
|
*/
|
|
924
924
|
get '/user_identities/unmanaged/update'(): (parameters: UserIdentitiesUnmanagedUpdateParameters, options?: UserIdentitiesUnmanagedUpdateOptions) => UserIdentitiesUnmanagedUpdateRequest;
|
|
925
925
|
/**
|
|
926
|
-
* Creates a new [webhook](https://
|
|
926
|
+
* Creates a new [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
927
927
|
*/
|
|
928
928
|
get '/webhooks/create'(): (parameters: WebhooksCreateParameters, options?: WebhooksCreateOptions) => WebhooksCreateRequest;
|
|
929
929
|
/**
|
|
930
|
-
* Deletes a specified [webhook](https://
|
|
930
|
+
* Deletes a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
931
931
|
*/
|
|
932
932
|
get '/webhooks/delete'(): (parameters: WebhooksDeleteParameters, options?: WebhooksDeleteOptions) => WebhooksDeleteRequest;
|
|
933
933
|
/**
|
|
934
|
-
* Gets a specified [webhook](https://
|
|
934
|
+
* Gets a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
935
935
|
*/
|
|
936
936
|
get '/webhooks/get'(): (parameters: WebhooksGetParameters, options?: WebhooksGetOptions) => WebhooksGetRequest;
|
|
937
937
|
/**
|
|
938
|
-
* Returns a list of all [webhooks](https://
|
|
938
|
+
* Returns a list of all [webhooks](https://www.seam.co/docs/developer-tools/webhooks).
|
|
939
939
|
*/
|
|
940
940
|
get '/webhooks/list'(): (parameters?: WebhooksListParameters, options?: WebhooksListOptions) => WebhooksListRequest;
|
|
941
941
|
/**
|
|
942
|
-
* Updates a specified [webhook](https://
|
|
942
|
+
* Updates a specified [webhook](https://www.seam.co/docs/developer-tools/webhooks).
|
|
943
943
|
*/
|
|
944
944
|
get '/webhooks/update'(): (parameters: WebhooksUpdateParameters, options?: WebhooksUpdateOptions) => WebhooksUpdateRequest;
|
|
945
945
|
/**
|
|
946
|
-
* Creates a new [workspace](https://
|
|
946
|
+
* Creates a new [workspace](https://www.seam.co/docs/core-concepts/workspaces).
|
|
947
947
|
*/
|
|
948
948
|
get '/workspaces/create'(): (parameters: WorkspacesCreateParameters, options?: WorkspacesCreateOptions) => WorkspacesCreateRequest;
|
|
949
949
|
/**
|
|
950
|
-
* Returns the [workspace](https://
|
|
950
|
+
* Returns the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
951
951
|
*/
|
|
952
952
|
get '/workspaces/get'(): (parameters?: WorkspacesGetParameters, options?: WorkspacesGetOptions) => WorkspacesGetRequest;
|
|
953
953
|
/**
|
|
954
|
-
* Returns a list of [workspaces](https://
|
|
954
|
+
* Returns a list of [workspaces](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
955
955
|
*/
|
|
956
956
|
get '/workspaces/list'(): (parameters?: WorkspacesListParameters, options?: WorkspacesListOptions) => WorkspacesListRequest;
|
|
957
957
|
/**
|
|
958
|
-
* Resets the [sandbox workspace](https://
|
|
958
|
+
* Resets the [sandbox workspace](https://www.seam.co/docs/core-concepts/workspaces#sandbox-workspaces) associated with the authentication value. Note that this endpoint is only available for sandbox workspaces.
|
|
959
959
|
*/
|
|
960
960
|
get '/workspaces/reset_sandbox'(): (parameters?: WorkspacesResetSandboxParameters, options?: WorkspacesResetSandboxOptions) => WorkspacesResetSandboxRequest;
|
|
961
961
|
/**
|
|
962
|
-
* Updates the [workspace](https://
|
|
962
|
+
* Updates the [workspace](https://www.seam.co/docs/core-concepts/workspaces) associated with the authentication value.
|
|
963
963
|
*/
|
|
964
964
|
get '/workspaces/update'(): (parameters?: WorkspacesUpdateParameters, options?: WorkspacesUpdateOptions) => WorkspacesUpdateRequest;
|
|
965
965
|
}
|