@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
|
@@ -21,11 +21,11 @@ export declare class SeamHttpAccessCodes {
|
|
|
21
21
|
get simulate(): SeamHttpAccessCodesSimulate;
|
|
22
22
|
get unmanaged(): SeamHttpAccessCodesUnmanaged;
|
|
23
23
|
/**
|
|
24
|
-
* Creates a new [access code](https://
|
|
24
|
+
* 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.
|
|
25
25
|
*/
|
|
26
26
|
create(parameters: AccessCodesCreateParameters, options?: AccessCodesCreateOptions): AccessCodesCreateRequest;
|
|
27
27
|
/**
|
|
28
|
-
* Creates new [access codes](https://
|
|
28
|
+
* Creates new [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
29
29
|
*
|
|
30
30
|
* 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.
|
|
31
31
|
*
|
|
@@ -33,33 +33,33 @@ export declare class SeamHttpAccessCodes {
|
|
|
33
33
|
*
|
|
34
34
|
* 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`.
|
|
35
35
|
*
|
|
36
|
-
* See also [Creating and Updating Multiple Linked Access Codes](https://
|
|
36
|
+
* 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).
|
|
37
37
|
*
|
|
38
|
-
* For granting a person access to a space, [Access Grants](https://
|
|
38
|
+
* 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.
|
|
39
39
|
*/
|
|
40
40
|
createMultiple(parameters: AccessCodesCreateMultipleParameters, options?: AccessCodesCreateMultipleOptions): AccessCodesCreateMultipleRequest;
|
|
41
41
|
/**
|
|
42
|
-
* Deletes an [access code](https://
|
|
42
|
+
* Deletes an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
43
43
|
*/
|
|
44
44
|
delete(parameters: AccessCodesDeleteParameters, options?: AccessCodesDeleteOptions): AccessCodesDeleteRequest;
|
|
45
45
|
/**
|
|
46
|
-
* Generates a code for an [access code](https://
|
|
46
|
+
* Generates a code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes), given a device ID.
|
|
47
47
|
*/
|
|
48
48
|
generateCode(parameters: AccessCodesGenerateCodeParameters, options?: AccessCodesGenerateCodeOptions): AccessCodesGenerateCodeRequest;
|
|
49
49
|
/**
|
|
50
|
-
* Returns a specified [access code](https://
|
|
50
|
+
* Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
51
51
|
*
|
|
52
52
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
53
53
|
*/
|
|
54
54
|
get(parameters: AccessCodesGetParameters, options?: AccessCodesGetOptions): AccessCodesGetRequest;
|
|
55
55
|
/**
|
|
56
|
-
* Returns a list of all [access codes](https://
|
|
56
|
+
* Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
57
57
|
*
|
|
58
58
|
* Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
|
|
59
59
|
*/
|
|
60
60
|
list(parameters: AccessCodesListParameters, options?: AccessCodesListOptions): AccessCodesListRequest;
|
|
61
61
|
/**
|
|
62
|
-
* Retrieves a backup access code for an [access code](https://
|
|
62
|
+
* 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).
|
|
63
63
|
*
|
|
64
64
|
* 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.
|
|
65
65
|
*
|
|
@@ -77,23 +77,23 @@ export declare class SeamHttpAccessCodes {
|
|
|
77
77
|
*/
|
|
78
78
|
reportDeviceConstraints(parameters: AccessCodesReportDeviceConstraintsParameters, options?: AccessCodesReportDeviceConstraintsOptions): AccessCodesReportDeviceConstraintsRequest;
|
|
79
79
|
/**
|
|
80
|
-
* Updates a specified active or upcoming [access code](https://
|
|
80
|
+
* Updates a specified active or upcoming [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
81
81
|
*
|
|
82
|
-
* See also [Modifying Access Codes](https://
|
|
82
|
+
* See also [Modifying Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes).
|
|
83
83
|
*/
|
|
84
84
|
update(parameters: AccessCodesUpdateParameters, options?: AccessCodesUpdateOptions): AccessCodesUpdateRequest;
|
|
85
85
|
/**
|
|
86
|
-
* Updates [access codes](https://
|
|
86
|
+
* Updates [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
87
87
|
*
|
|
88
88
|
* Specify the `common_code_key` to identify the set of access codes that you want to update.
|
|
89
89
|
*
|
|
90
|
-
* See also [Update Linked Access Codes](https://
|
|
90
|
+
* 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).
|
|
91
91
|
*/
|
|
92
92
|
updateMultiple(parameters: AccessCodesUpdateMultipleParameters, options?: AccessCodesUpdateMultipleOptions): AccessCodesUpdateMultipleRequest;
|
|
93
93
|
}
|
|
94
94
|
export type AccessCodesCreateParameters = {
|
|
95
95
|
/**
|
|
96
|
-
* Indicates whether [external modification](https://
|
|
96
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
97
97
|
*/
|
|
98
98
|
allow_external_modification?: boolean | undefined;
|
|
99
99
|
attempt_for_offline_device?: boolean | undefined;
|
|
@@ -102,7 +102,7 @@ export type AccessCodesCreateParameters = {
|
|
|
102
102
|
*/
|
|
103
103
|
code?: string | undefined;
|
|
104
104
|
/**
|
|
105
|
-
* Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. See also [Creating and Updating Multiple Linked Access Codes](https://
|
|
105
|
+
* Key to identify access codes that should have the same code. Any two access codes with the same `common_code_key` are guaranteed to have the same `code`. 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).
|
|
106
106
|
*/
|
|
107
107
|
common_code_key?: string | undefined;
|
|
108
108
|
/**
|
|
@@ -114,19 +114,19 @@ export type AccessCodesCreateParameters = {
|
|
|
114
114
|
*/
|
|
115
115
|
ends_at?: string | undefined;
|
|
116
116
|
/**
|
|
117
|
-
* Indicates whether [external modification](https://
|
|
117
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
118
118
|
*/
|
|
119
119
|
is_external_modification_allowed?: boolean | undefined;
|
|
120
120
|
/**
|
|
121
|
-
* Indicates whether the access code is an [offline access code](https://
|
|
121
|
+
* Indicates whether the access code is an [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes).
|
|
122
122
|
*/
|
|
123
123
|
is_offline_access_code?: boolean | undefined;
|
|
124
124
|
/**
|
|
125
|
-
* Indicates whether the [offline access code](https://
|
|
125
|
+
* Indicates whether the [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes) is a single-use access code.
|
|
126
126
|
*/
|
|
127
127
|
is_one_time_use?: boolean | undefined;
|
|
128
128
|
/**
|
|
129
|
-
* Maximum rounding adjustment. To create a daily-bound [offline access code](https://
|
|
129
|
+
* Maximum rounding adjustment. To create a daily-bound [offline access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/offline-access-codes) for devices that support this feature, set this parameter to `1d`.
|
|
130
130
|
*/
|
|
131
131
|
max_time_rounding?: '1hour' | '1day' | '1h' | '1d' | undefined;
|
|
132
132
|
/**
|
|
@@ -140,7 +140,7 @@ export type AccessCodesCreateParameters = {
|
|
|
140
140
|
*/
|
|
141
141
|
name?: string | undefined;
|
|
142
142
|
/**
|
|
143
|
-
* Indicates whether [native scheduling](https://
|
|
143
|
+
* Indicates whether [native scheduling](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
|
|
144
144
|
*/
|
|
145
145
|
prefer_native_scheduling?: boolean | undefined;
|
|
146
146
|
/**
|
|
@@ -152,7 +152,7 @@ export type AccessCodesCreateParameters = {
|
|
|
152
152
|
*/
|
|
153
153
|
starts_at?: string | undefined;
|
|
154
154
|
/**
|
|
155
|
-
* Indicates whether to use a [backup access code pool](https://
|
|
155
|
+
* Indicates whether to use a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://www.seam.co/docs/api/access_codes/pull_backup_access_code).
|
|
156
156
|
*/
|
|
157
157
|
use_backup_access_code_pool?: boolean | undefined;
|
|
158
158
|
/**
|
|
@@ -171,7 +171,7 @@ export interface AccessCodesCreateOptions {
|
|
|
171
171
|
}
|
|
172
172
|
export type AccessCodesCreateMultipleParameters = {
|
|
173
173
|
/**
|
|
174
|
-
* Indicates whether [external modification](https://
|
|
174
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
175
175
|
*/
|
|
176
176
|
allow_external_modification?: boolean | undefined;
|
|
177
177
|
attempt_for_offline_device?: boolean | undefined;
|
|
@@ -192,7 +192,7 @@ export type AccessCodesCreateMultipleParameters = {
|
|
|
192
192
|
*/
|
|
193
193
|
ends_at?: string | undefined;
|
|
194
194
|
/**
|
|
195
|
-
* Indicates whether [external modification](https://
|
|
195
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
196
196
|
*/
|
|
197
197
|
is_external_modification_allowed?: boolean | undefined;
|
|
198
198
|
/**
|
|
@@ -206,7 +206,7 @@ export type AccessCodesCreateMultipleParameters = {
|
|
|
206
206
|
*/
|
|
207
207
|
name?: string | undefined;
|
|
208
208
|
/**
|
|
209
|
-
* Indicates whether [native scheduling](https://
|
|
209
|
+
* Indicates whether [native scheduling](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#native-scheduling) should be used for time-bound codes when supported by the provider. Default: `true`.
|
|
210
210
|
*/
|
|
211
211
|
prefer_native_scheduling?: boolean | undefined;
|
|
212
212
|
/**
|
|
@@ -218,7 +218,7 @@ export type AccessCodesCreateMultipleParameters = {
|
|
|
218
218
|
*/
|
|
219
219
|
starts_at?: string | undefined;
|
|
220
220
|
/**
|
|
221
|
-
* Indicates whether to use a [backup access code pool](https://
|
|
221
|
+
* Indicates whether to use a [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) provided by Seam. If `true`, you can use [`/access_codes/pull_backup_access_code`](https://www.seam.co/docs/api/access_codes/pull_backup_access_code).
|
|
222
222
|
*/
|
|
223
223
|
use_backup_access_code_pool?: boolean | undefined;
|
|
224
224
|
};
|
|
@@ -383,7 +383,7 @@ export type AccessCodesUpdateParameters = {
|
|
|
383
383
|
*/
|
|
384
384
|
access_code_id: string;
|
|
385
385
|
/**
|
|
386
|
-
* Indicates whether [external modification](https://
|
|
386
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
387
387
|
*/
|
|
388
388
|
allow_external_modification?: boolean | undefined;
|
|
389
389
|
attempt_for_offline_device?: boolean | undefined;
|
|
@@ -400,7 +400,7 @@ export type AccessCodesUpdateParameters = {
|
|
|
400
400
|
*/
|
|
401
401
|
ends_at?: string | undefined;
|
|
402
402
|
/**
|
|
403
|
-
* Indicates whether [external modification](https://
|
|
403
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed. Default: `false`.
|
|
404
404
|
*/
|
|
405
405
|
is_external_modification_allowed?: boolean | undefined;
|
|
406
406
|
/**
|
|
@@ -422,7 +422,7 @@ export type AccessCodesUpdateParameters = {
|
|
|
422
422
|
*/
|
|
423
423
|
starts_at?: string | undefined;
|
|
424
424
|
/**
|
|
425
|
-
* Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://
|
|
425
|
+
* Type to which you want to convert the access code. To convert a time-bound access code to an ongoing access code, set `type` to `ongoing`. See also [Changing a time-bound access code to permanent access](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes#special-case-2-changing-a-time-bound-access-code-to-permanent-access).
|
|
426
426
|
*/
|
|
427
427
|
type?: 'ongoing' | 'time_bound' | undefined;
|
|
428
428
|
};
|
|
@@ -91,7 +91,7 @@ export class SeamHttpAccessCodes {
|
|
|
91
91
|
return SeamHttpAccessCodesUnmanaged.fromClient(this.client, this.defaults);
|
|
92
92
|
}
|
|
93
93
|
/**
|
|
94
|
-
* Creates a new [access code](https://
|
|
94
|
+
* 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.
|
|
95
95
|
*/
|
|
96
96
|
create(parameters, options = {}) {
|
|
97
97
|
return new SeamHttpRequest(this, {
|
|
@@ -107,7 +107,7 @@ export class SeamHttpAccessCodes {
|
|
|
107
107
|
});
|
|
108
108
|
}
|
|
109
109
|
/**
|
|
110
|
-
* Creates new [access codes](https://
|
|
110
|
+
* Creates new [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
111
111
|
*
|
|
112
112
|
* 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.
|
|
113
113
|
*
|
|
@@ -115,9 +115,9 @@ export class SeamHttpAccessCodes {
|
|
|
115
115
|
*
|
|
116
116
|
* 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`.
|
|
117
117
|
*
|
|
118
|
-
* See also [Creating and Updating Multiple Linked Access Codes](https://
|
|
118
|
+
* 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).
|
|
119
119
|
*
|
|
120
|
-
* For granting a person access to a space, [Access Grants](https://
|
|
120
|
+
* 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.
|
|
121
121
|
*/
|
|
122
122
|
createMultiple(parameters, options = {}) {
|
|
123
123
|
return new SeamHttpRequest(this, {
|
|
@@ -133,7 +133,7 @@ export class SeamHttpAccessCodes {
|
|
|
133
133
|
});
|
|
134
134
|
}
|
|
135
135
|
/**
|
|
136
|
-
* Deletes an [access code](https://
|
|
136
|
+
* Deletes an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
137
137
|
*/
|
|
138
138
|
delete(parameters, options = {}) {
|
|
139
139
|
return new SeamHttpRequest(this, {
|
|
@@ -149,7 +149,7 @@ export class SeamHttpAccessCodes {
|
|
|
149
149
|
});
|
|
150
150
|
}
|
|
151
151
|
/**
|
|
152
|
-
* Generates a code for an [access code](https://
|
|
152
|
+
* Generates a code for an [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes), given a device ID.
|
|
153
153
|
*/
|
|
154
154
|
generateCode(parameters, options = {}) {
|
|
155
155
|
return new SeamHttpRequest(this, {
|
|
@@ -165,7 +165,7 @@ export class SeamHttpAccessCodes {
|
|
|
165
165
|
});
|
|
166
166
|
}
|
|
167
167
|
/**
|
|
168
|
-
* Returns a specified [access code](https://
|
|
168
|
+
* Returns a specified [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
169
169
|
*
|
|
170
170
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
171
171
|
*/
|
|
@@ -183,7 +183,7 @@ export class SeamHttpAccessCodes {
|
|
|
183
183
|
});
|
|
184
184
|
}
|
|
185
185
|
/**
|
|
186
|
-
* Returns a list of all [access codes](https://
|
|
186
|
+
* Returns a list of all [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
187
187
|
*
|
|
188
188
|
* Specify `device_id`, `access_code_ids`, `access_method_id`, `access_grant_id`, or `access_grant_key`.
|
|
189
189
|
*/
|
|
@@ -211,7 +211,7 @@ export class SeamHttpAccessCodes {
|
|
|
211
211
|
});
|
|
212
212
|
}
|
|
213
213
|
/**
|
|
214
|
-
* Retrieves a backup access code for an [access code](https://
|
|
214
|
+
* 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).
|
|
215
215
|
*
|
|
216
216
|
* 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.
|
|
217
217
|
*
|
|
@@ -253,9 +253,9 @@ export class SeamHttpAccessCodes {
|
|
|
253
253
|
});
|
|
254
254
|
}
|
|
255
255
|
/**
|
|
256
|
-
* Updates a specified active or upcoming [access code](https://
|
|
256
|
+
* Updates a specified active or upcoming [access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes).
|
|
257
257
|
*
|
|
258
|
-
* See also [Modifying Access Codes](https://
|
|
258
|
+
* See also [Modifying Access Codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/modifying-access-codes).
|
|
259
259
|
*/
|
|
260
260
|
update(parameters, options = {}) {
|
|
261
261
|
return new SeamHttpRequest(this, {
|
|
@@ -271,11 +271,11 @@ export class SeamHttpAccessCodes {
|
|
|
271
271
|
});
|
|
272
272
|
}
|
|
273
273
|
/**
|
|
274
|
-
* Updates [access codes](https://
|
|
274
|
+
* Updates [access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes) that share a common code across multiple devices.
|
|
275
275
|
*
|
|
276
276
|
* Specify the `common_code_key` to identify the set of access codes that you want to update.
|
|
277
277
|
*
|
|
278
|
-
* See also [Update Linked Access Codes](https://
|
|
278
|
+
* 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).
|
|
279
279
|
*/
|
|
280
280
|
updateMultiple(parameters, options = {}) {
|
|
281
281
|
return new SeamHttpRequest(this, {
|
|
@@ -16,7 +16,7 @@ export declare class SeamHttpAccessCodesSimulate {
|
|
|
16
16
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
17
17
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
18
18
|
/**
|
|
19
|
-
* Simulates the creation of an [unmanaged access code](https://
|
|
19
|
+
* 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).
|
|
20
20
|
*/
|
|
21
21
|
createUnmanagedAccessCode(parameters: AccessCodesSimulateCreateUnmanagedAccessCodeParameters, options?: AccessCodesSimulateCreateUnmanagedAccessCodeOptions): AccessCodesSimulateCreateUnmanagedAccessCodeRequest;
|
|
22
22
|
}
|
|
@@ -83,7 +83,7 @@ export class SeamHttpAccessCodesSimulate {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Simulates the creation of an [unmanaged access code](https://
|
|
86
|
+
* 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).
|
|
87
87
|
*/
|
|
88
88
|
createUnmanagedAccessCode(parameters, options = {}) {
|
|
89
89
|
return new SeamHttpRequest(this, {
|
|
@@ -17,7 +17,7 @@ export declare class SeamHttpAccessCodesUnmanaged {
|
|
|
17
17
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
18
18
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
19
19
|
/**
|
|
20
|
-
* Converts an [unmanaged access code](https://
|
|
20
|
+
* 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).
|
|
21
21
|
*
|
|
22
22
|
* 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.
|
|
23
23
|
*
|
|
@@ -25,21 +25,21 @@ export declare class SeamHttpAccessCodesUnmanaged {
|
|
|
25
25
|
*/
|
|
26
26
|
convertToManaged(parameters: AccessCodesUnmanagedConvertToManagedParameters, options?: AccessCodesUnmanagedConvertToManagedOptions): AccessCodesUnmanagedConvertToManagedRequest;
|
|
27
27
|
/**
|
|
28
|
-
* Deletes an [unmanaged access code](https://
|
|
28
|
+
* Deletes an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
29
29
|
*/
|
|
30
30
|
delete(parameters: AccessCodesUnmanagedDeleteParameters, options?: AccessCodesUnmanagedDeleteOptions): AccessCodesUnmanagedDeleteRequest;
|
|
31
31
|
/**
|
|
32
|
-
* Returns a specified [unmanaged access code](https://
|
|
32
|
+
* Returns a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
33
33
|
*
|
|
34
34
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
35
35
|
*/
|
|
36
36
|
get(parameters: AccessCodesUnmanagedGetParameters, options?: AccessCodesUnmanagedGetOptions): AccessCodesUnmanagedGetRequest;
|
|
37
37
|
/**
|
|
38
|
-
* Returns a list of all [unmanaged access codes](https://
|
|
38
|
+
* Returns a list of all [unmanaged access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
39
39
|
*/
|
|
40
40
|
list(parameters: AccessCodesUnmanagedListParameters, options?: AccessCodesUnmanagedListOptions): AccessCodesUnmanagedListRequest;
|
|
41
41
|
/**
|
|
42
|
-
* Updates a specified [unmanaged access code](https://
|
|
42
|
+
* Updates a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
43
43
|
*/
|
|
44
44
|
update(parameters: AccessCodesUnmanagedUpdateParameters, options?: AccessCodesUnmanagedUpdateOptions): AccessCodesUnmanagedUpdateRequest;
|
|
45
45
|
}
|
|
@@ -49,7 +49,7 @@ export type AccessCodesUnmanagedConvertToManagedParameters = {
|
|
|
49
49
|
*/
|
|
50
50
|
access_code_id: string;
|
|
51
51
|
/**
|
|
52
|
-
* Indicates whether [external modification](https://
|
|
52
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
|
|
53
53
|
*/
|
|
54
54
|
allow_external_modification?: boolean | undefined;
|
|
55
55
|
/**
|
|
@@ -57,7 +57,7 @@ export type AccessCodesUnmanagedConvertToManagedParameters = {
|
|
|
57
57
|
*/
|
|
58
58
|
force?: boolean | undefined;
|
|
59
59
|
/**
|
|
60
|
-
* Indicates whether [external modification](https://
|
|
60
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the access code is allowed.
|
|
61
61
|
*/
|
|
62
62
|
is_external_modification_allowed?: boolean | undefined;
|
|
63
63
|
};
|
|
@@ -141,7 +141,7 @@ export type AccessCodesUnmanagedUpdateParameters = {
|
|
|
141
141
|
*/
|
|
142
142
|
access_code_id: string;
|
|
143
143
|
/**
|
|
144
|
-
* Indicates whether [external modification](https://
|
|
144
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
|
|
145
145
|
*/
|
|
146
146
|
allow_external_modification?: boolean | undefined;
|
|
147
147
|
/**
|
|
@@ -149,7 +149,7 @@ export type AccessCodesUnmanagedUpdateParameters = {
|
|
|
149
149
|
*/
|
|
150
150
|
force?: boolean | undefined;
|
|
151
151
|
/**
|
|
152
|
-
* Indicates whether [external modification](https://
|
|
152
|
+
* Indicates whether [external modification](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes#external-modification) of the code is allowed.
|
|
153
153
|
*/
|
|
154
154
|
is_external_modification_allowed?: boolean | undefined;
|
|
155
155
|
is_managed: boolean;
|
|
@@ -83,7 +83,7 @@ export class SeamHttpAccessCodesUnmanaged {
|
|
|
83
83
|
await clientSessions.get();
|
|
84
84
|
}
|
|
85
85
|
/**
|
|
86
|
-
* Converts an [unmanaged access code](https://
|
|
86
|
+
* 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).
|
|
87
87
|
*
|
|
88
88
|
* 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.
|
|
89
89
|
*
|
|
@@ -103,7 +103,7 @@ export class SeamHttpAccessCodesUnmanaged {
|
|
|
103
103
|
});
|
|
104
104
|
}
|
|
105
105
|
/**
|
|
106
|
-
* Deletes an [unmanaged access code](https://
|
|
106
|
+
* Deletes an [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
107
107
|
*/
|
|
108
108
|
delete(parameters, options = {}) {
|
|
109
109
|
return new SeamHttpRequest(this, {
|
|
@@ -119,7 +119,7 @@ export class SeamHttpAccessCodesUnmanaged {
|
|
|
119
119
|
});
|
|
120
120
|
}
|
|
121
121
|
/**
|
|
122
|
-
* Returns a specified [unmanaged access code](https://
|
|
122
|
+
* Returns a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
123
123
|
*
|
|
124
124
|
* You must specify either `access_code_id` or both `device_id` and `code`.
|
|
125
125
|
*/
|
|
@@ -137,7 +137,7 @@ export class SeamHttpAccessCodesUnmanaged {
|
|
|
137
137
|
});
|
|
138
138
|
}
|
|
139
139
|
/**
|
|
140
|
-
* Returns a list of all [unmanaged access codes](https://
|
|
140
|
+
* Returns a list of all [unmanaged access codes](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
141
141
|
*/
|
|
142
142
|
list(parameters, options = {}) {
|
|
143
143
|
return new SeamHttpRequest(this, {
|
|
@@ -154,7 +154,7 @@ export class SeamHttpAccessCodesUnmanaged {
|
|
|
154
154
|
});
|
|
155
155
|
}
|
|
156
156
|
/**
|
|
157
|
-
* Updates a specified [unmanaged access code](https://
|
|
157
|
+
* Updates a specified [unmanaged access code](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/migrating-existing-access-codes).
|
|
158
158
|
*/
|
|
159
159
|
update(parameters, options = {}) {
|
|
160
160
|
return new SeamHttpRequest(this, {
|
|
@@ -20,7 +20,7 @@ export declare class SeamHttpAccessGrants {
|
|
|
20
20
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
21
21
|
get unmanaged(): SeamHttpAccessGrantsUnmanaged;
|
|
22
22
|
/**
|
|
23
|
-
* Creates a new [Access Grant](https://
|
|
23
|
+
* 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.
|
|
24
24
|
*/
|
|
25
25
|
create(parameters: AccessGrantsCreateParameters, options?: AccessGrantsCreateOptions): AccessGrantsCreateRequest;
|
|
26
26
|
/**
|
|
@@ -54,7 +54,7 @@ export type AccessGrantsCreateParameters = {
|
|
|
54
54
|
*/
|
|
55
55
|
access_grant_key?: string | undefined;
|
|
56
56
|
/**
|
|
57
|
-
* Set of IDs of the [entrances](https://
|
|
57
|
+
* Set of IDs of the [entrances](https://www.seam.co/docs/api/acs/systems/list) to which access is being granted.
|
|
58
58
|
*/
|
|
59
59
|
acs_entrance_ids?: Array<string> | undefined;
|
|
60
60
|
/**
|
|
@@ -62,7 +62,7 @@ export type AccessGrantsCreateParameters = {
|
|
|
62
62
|
*/
|
|
63
63
|
customization_profile_id?: string | undefined;
|
|
64
64
|
/**
|
|
65
|
-
* Set of IDs of the [devices](https://
|
|
65
|
+
* Set of IDs of the [devices](https://www.seam.co/docs/api/devices/list) to which access is being granted.
|
|
66
66
|
*/
|
|
67
67
|
device_ids?: Array<string> | undefined;
|
|
68
68
|
/**
|
|
@@ -87,7 +87,7 @@ export class SeamHttpAccessGrants {
|
|
|
87
87
|
return SeamHttpAccessGrantsUnmanaged.fromClient(this.client, this.defaults);
|
|
88
88
|
}
|
|
89
89
|
/**
|
|
90
|
-
* Creates a new [Access Grant](https://
|
|
90
|
+
* 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.
|
|
91
91
|
*/
|
|
92
92
|
create(parameters, options = {}) {
|
|
93
93
|
return new SeamHttpRequest(this, {
|
|
@@ -29,7 +29,7 @@ export declare class SeamHttpAccessMethods {
|
|
|
29
29
|
*/
|
|
30
30
|
delete(parameters: AccessMethodsDeleteParameters, options?: AccessMethodsDeleteOptions): AccessMethodsDeleteRequest;
|
|
31
31
|
/**
|
|
32
|
-
* Encodes an existing access method onto a plastic card placed on the specified [encoder](https://
|
|
32
|
+
* 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).
|
|
33
33
|
*/
|
|
34
34
|
encode(parameters: AccessMethodsEncodeParameters, options?: AccessMethodsEncodeOptions): AccessMethodsEncodeRequest;
|
|
35
35
|
/**
|
|
@@ -45,7 +45,7 @@ export declare class SeamHttpAccessMethods {
|
|
|
45
45
|
*/
|
|
46
46
|
list(parameters: AccessMethodsListParameters, options?: AccessMethodsListOptions): AccessMethodsListRequest;
|
|
47
47
|
/**
|
|
48
|
-
* Remotely unlocks a specified [entrance](https://
|
|
48
|
+
* 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.
|
|
49
49
|
*/
|
|
50
50
|
unlockDoor(parameters: AccessMethodsUnlockDoorParameters, options?: AccessMethodsUnlockDoorOptions): AccessMethodsUnlockDoorRequest;
|
|
51
51
|
}
|
|
@@ -128,7 +128,7 @@ export class SeamHttpAccessMethods {
|
|
|
128
128
|
});
|
|
129
129
|
}
|
|
130
130
|
/**
|
|
131
|
-
* Encodes an existing access method onto a plastic card placed on the specified [encoder](https://
|
|
131
|
+
* 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).
|
|
132
132
|
*/
|
|
133
133
|
encode(parameters, options = {}) {
|
|
134
134
|
return new SeamHttpRequest(this, {
|
|
@@ -204,7 +204,7 @@ export class SeamHttpAccessMethods {
|
|
|
204
204
|
});
|
|
205
205
|
}
|
|
206
206
|
/**
|
|
207
|
-
* Remotely unlocks a specified [entrance](https://
|
|
207
|
+
* 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.
|
|
208
208
|
*/
|
|
209
209
|
unlockDoor(parameters, options = {}) {
|
|
210
210
|
return new SeamHttpRequest(this, {
|
|
@@ -18,31 +18,31 @@ export declare class SeamHttpAcsAccessGroups {
|
|
|
18
18
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(request: SeamPaginatedRequest<TResponse, TResponseKey>): SeamPaginator<TResponse, TResponseKey>;
|
|
19
19
|
updateClientSessionToken(clientSessionToken: SeamHttpOptionsWithClientSessionToken['clientSessionToken']): Promise<void>;
|
|
20
20
|
/**
|
|
21
|
-
* Adds a specified [access system user](https://
|
|
21
|
+
* 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).
|
|
22
22
|
*/
|
|
23
23
|
addUser(parameters: AcsAccessGroupsAddUserParameters, options?: AcsAccessGroupsAddUserOptions): AcsAccessGroupsAddUserRequest;
|
|
24
24
|
/**
|
|
25
|
-
* Deletes a specified [access group](https://
|
|
25
|
+
* Deletes a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
26
26
|
*/
|
|
27
27
|
delete(parameters: AcsAccessGroupsDeleteParameters, options?: AcsAccessGroupsDeleteOptions): AcsAccessGroupsDeleteRequest;
|
|
28
28
|
/**
|
|
29
|
-
* Returns a specified [access group](https://
|
|
29
|
+
* Returns a specified [access group](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
30
30
|
*/
|
|
31
31
|
get(parameters: AcsAccessGroupsGetParameters, options?: AcsAccessGroupsGetOptions): AcsAccessGroupsGetRequest;
|
|
32
32
|
/**
|
|
33
|
-
* Returns a list of all [access groups](https://
|
|
33
|
+
* Returns a list of all [access groups](https://www.seam.co/docs/low-level-apis/access-systems/user-management/assigning-users-to-access-groups).
|
|
34
34
|
*/
|
|
35
35
|
list(parameters?: AcsAccessGroupsListParameters, options?: AcsAccessGroupsListOptions): AcsAccessGroupsListRequest;
|
|
36
36
|
/**
|
|
37
|
-
* Returns a list of all accessible entrances for a specified [access group](https://
|
|
37
|
+
* 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).
|
|
38
38
|
*/
|
|
39
39
|
listAccessibleEntrances(parameters: AcsAccessGroupsListAccessibleEntrancesParameters, options?: AcsAccessGroupsListAccessibleEntrancesOptions): AcsAccessGroupsListAccessibleEntrancesRequest;
|
|
40
40
|
/**
|
|
41
|
-
* Returns a list of all [access system users](https://
|
|
41
|
+
* 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).
|
|
42
42
|
*/
|
|
43
43
|
listUsers(parameters: AcsAccessGroupsListUsersParameters, options?: AcsAccessGroupsListUsersOptions): AcsAccessGroupsListUsersRequest;
|
|
44
44
|
/**
|
|
45
|
-
* Removes a specified [access system user](https://
|
|
45
|
+
* 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).
|
|
46
46
|
*/
|
|
47
47
|
removeUser(parameters: AcsAccessGroupsRemoveUserParameters, options?: AcsAccessGroupsRemoveUserOptions): AcsAccessGroupsRemoveUserRequest;
|
|
48
48
|
}
|