@seamapi/types 1.445.0 → 1.446.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/dist/connect.cjs +148 -103
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +230 -135
- package/dist/index.cjs +148 -103
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +3 -0
- package/lib/seam/connect/models/access-grants/access-grant.js +16 -12
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/access-grants/access-method.js +1 -1
- package/lib/seam/connect/models/access-grants/requested-access-method.js +1 -1
- package/lib/seam/connect/models/batches/batch.d.ts +5 -0
- package/lib/seam/connect/models/batches/spaces.d.ts +5 -0
- package/lib/seam/connect/models/events/access-grants.js +6 -6
- package/lib/seam/connect/models/events/access-methods.js +1 -1
- package/lib/seam/connect/models/spaces/space.d.ts +3 -0
- package/lib/seam/connect/models/spaces/space.js +4 -0
- package/lib/seam/connect/models/spaces/space.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +86 -38
- package/lib/seam/connect/openapi.js +140 -96
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +133 -97
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +16 -12
- package/src/lib/seam/connect/models/access-grants/access-method.ts +1 -1
- package/src/lib/seam/connect/models/access-grants/requested-access-method.ts +1 -1
- package/src/lib/seam/connect/models/events/access-grants.ts +6 -6
- package/src/lib/seam/connect/models/events/access-methods.ts +1 -1
- package/src/lib/seam/connect/models/spaces/space.ts +4 -0
- package/src/lib/seam/connect/openapi.ts +147 -96
- package/src/lib/seam/connect/route-types.ts +144 -104
|
@@ -11155,6 +11155,8 @@ export interface Routes {
|
|
|
11155
11155
|
}
|
|
11156
11156
|
}
|
|
11157
11157
|
) & {
|
|
11158
|
+
/** Unique key for the access grant within the workspace. */
|
|
11159
|
+
access_grant_key?: string | undefined
|
|
11158
11160
|
/**
|
|
11159
11161
|
* @deprecated Use `space_ids`. */
|
|
11160
11162
|
location_ids?: string[] | undefined
|
|
@@ -11188,41 +11190,43 @@ export interface Routes {
|
|
|
11188
11190
|
}
|
|
11189
11191
|
formData: {}
|
|
11190
11192
|
jsonResponse: {
|
|
11191
|
-
/** Represents an
|
|
11193
|
+
/** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
|
|
11192
11194
|
access_grant: {
|
|
11193
|
-
/** ID of the Seam workspace associated with the
|
|
11195
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
11194
11196
|
workspace_id: string
|
|
11195
|
-
/** ID of the
|
|
11197
|
+
/** ID of the Access Grant. */
|
|
11196
11198
|
access_grant_id: string
|
|
11197
|
-
/**
|
|
11199
|
+
/** Unique key for the access grant within the workspace. */
|
|
11200
|
+
access_grant_key?: string | undefined
|
|
11201
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
11198
11202
|
user_identity_id: string
|
|
11199
11203
|
/**
|
|
11200
11204
|
* @deprecated Use `space_ids`. */
|
|
11201
11205
|
location_ids: string[]
|
|
11202
|
-
/** IDs of the spaces to which the
|
|
11206
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
11203
11207
|
space_ids: string[]
|
|
11204
|
-
/** Access methods that the user requested for the
|
|
11208
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
11205
11209
|
requested_access_methods: Array<{
|
|
11206
11210
|
/** Display name of the access method. */
|
|
11207
11211
|
display_name: string
|
|
11208
11212
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
11209
11213
|
mode: 'code' | 'card' | 'mobile_key'
|
|
11210
|
-
/** Date and time at which the requested access method was added to the
|
|
11214
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
11211
11215
|
created_at: string
|
|
11212
11216
|
/** IDs of the access methods created for the requested access method. */
|
|
11213
11217
|
created_access_method_ids: string[]
|
|
11214
11218
|
}>
|
|
11215
|
-
/** IDs of the access methods created for the
|
|
11219
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
11216
11220
|
access_method_ids: string[]
|
|
11217
|
-
/** Display name of the
|
|
11221
|
+
/** Display name of the Access Grant. */
|
|
11218
11222
|
display_name: string
|
|
11219
|
-
/** Instant Key URL. Only returned if the
|
|
11223
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
11220
11224
|
instant_key_url?: string | undefined
|
|
11221
|
-
/** Date and time at which the
|
|
11225
|
+
/** Date and time at which the Access Grant was created. */
|
|
11222
11226
|
created_at: string
|
|
11223
|
-
/** Date and time at which the
|
|
11227
|
+
/** Date and time at which the Access Grant starts. */
|
|
11224
11228
|
starts_at?: string | undefined
|
|
11225
|
-
/** Date and time at which the
|
|
11229
|
+
/** Date and time at which the Access Grant ends. */
|
|
11226
11230
|
ends_at?: string | undefined
|
|
11227
11231
|
}
|
|
11228
11232
|
}
|
|
@@ -11233,7 +11237,7 @@ export interface Routes {
|
|
|
11233
11237
|
queryParams: {}
|
|
11234
11238
|
jsonBody: {}
|
|
11235
11239
|
commonParams: {
|
|
11236
|
-
/** ID of
|
|
11240
|
+
/** ID of Access Grant to delete. */
|
|
11237
11241
|
access_grant_id: string
|
|
11238
11242
|
}
|
|
11239
11243
|
formData: {}
|
|
@@ -11244,47 +11248,54 @@ export interface Routes {
|
|
|
11244
11248
|
method: 'GET' | 'POST'
|
|
11245
11249
|
queryParams: {}
|
|
11246
11250
|
jsonBody: {}
|
|
11247
|
-
commonParams:
|
|
11248
|
-
|
|
11249
|
-
|
|
11250
|
-
|
|
11251
|
+
commonParams:
|
|
11252
|
+
| {
|
|
11253
|
+
/** ID of Access Grant to get. */
|
|
11254
|
+
access_grant_id: string
|
|
11255
|
+
}
|
|
11256
|
+
| {
|
|
11257
|
+
/** Unique key of Access Grant to get. */
|
|
11258
|
+
access_grant_key: string
|
|
11259
|
+
}
|
|
11251
11260
|
formData: {}
|
|
11252
11261
|
jsonResponse: {
|
|
11253
|
-
/** Represents an
|
|
11262
|
+
/** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
|
|
11254
11263
|
access_grant: {
|
|
11255
|
-
/** ID of the Seam workspace associated with the
|
|
11264
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
11256
11265
|
workspace_id: string
|
|
11257
|
-
/** ID of the
|
|
11266
|
+
/** ID of the Access Grant. */
|
|
11258
11267
|
access_grant_id: string
|
|
11259
|
-
/**
|
|
11268
|
+
/** Unique key for the access grant within the workspace. */
|
|
11269
|
+
access_grant_key?: string | undefined
|
|
11270
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
11260
11271
|
user_identity_id: string
|
|
11261
11272
|
/**
|
|
11262
11273
|
* @deprecated Use `space_ids`. */
|
|
11263
11274
|
location_ids: string[]
|
|
11264
|
-
/** IDs of the spaces to which the
|
|
11275
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
11265
11276
|
space_ids: string[]
|
|
11266
|
-
/** Access methods that the user requested for the
|
|
11277
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
11267
11278
|
requested_access_methods: Array<{
|
|
11268
11279
|
/** Display name of the access method. */
|
|
11269
11280
|
display_name: string
|
|
11270
11281
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
11271
11282
|
mode: 'code' | 'card' | 'mobile_key'
|
|
11272
|
-
/** Date and time at which the requested access method was added to the
|
|
11283
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
11273
11284
|
created_at: string
|
|
11274
11285
|
/** IDs of the access methods created for the requested access method. */
|
|
11275
11286
|
created_access_method_ids: string[]
|
|
11276
11287
|
}>
|
|
11277
|
-
/** IDs of the access methods created for the
|
|
11288
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
11278
11289
|
access_method_ids: string[]
|
|
11279
|
-
/** Display name of the
|
|
11290
|
+
/** Display name of the Access Grant. */
|
|
11280
11291
|
display_name: string
|
|
11281
|
-
/** Instant Key URL. Only returned if the
|
|
11292
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
11282
11293
|
instant_key_url?: string | undefined
|
|
11283
|
-
/** Date and time at which the
|
|
11294
|
+
/** Date and time at which the Access Grant was created. */
|
|
11284
11295
|
created_at: string
|
|
11285
|
-
/** Date and time at which the
|
|
11296
|
+
/** Date and time at which the Access Grant starts. */
|
|
11286
11297
|
starts_at?: string | undefined
|
|
11287
|
-
/** Date and time at which the
|
|
11298
|
+
/** Date and time at which the Access Grant ends. */
|
|
11288
11299
|
ends_at?: string | undefined
|
|
11289
11300
|
}
|
|
11290
11301
|
}
|
|
@@ -11295,54 +11306,58 @@ export interface Routes {
|
|
|
11295
11306
|
queryParams: {}
|
|
11296
11307
|
jsonBody: {}
|
|
11297
11308
|
commonParams: {
|
|
11298
|
-
/** ID of user identity to filter list of
|
|
11309
|
+
/** ID of user identity by which you want to filter the list of Access Grants. */
|
|
11299
11310
|
user_identity_id?: string | undefined
|
|
11300
|
-
/** ID of system to filter list of
|
|
11311
|
+
/** ID of the access system by which you want to filter the list of Access Grants. */
|
|
11301
11312
|
acs_system_id?: string | undefined
|
|
11302
|
-
/** ID of entrance to filter list of
|
|
11313
|
+
/** ID of the entrance by which you want to filter the list of Access Grants. */
|
|
11303
11314
|
acs_entrance_id?: string | undefined
|
|
11304
11315
|
/**
|
|
11305
11316
|
* @deprecated Use `space_id`. */
|
|
11306
11317
|
location_id?: string | undefined
|
|
11307
|
-
/** ID of space to filter list of
|
|
11318
|
+
/** ID of the space by which you want to filter the list of Access Grants. */
|
|
11308
11319
|
space_id?: string | undefined
|
|
11320
|
+
/** Filter Access Grants by access_grant_key. */
|
|
11321
|
+
access_grant_key?: string | undefined
|
|
11309
11322
|
}
|
|
11310
11323
|
formData: {}
|
|
11311
11324
|
jsonResponse: {
|
|
11312
11325
|
access_grants: Array<{
|
|
11313
|
-
/** ID of the Seam workspace associated with the
|
|
11326
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
11314
11327
|
workspace_id: string
|
|
11315
|
-
/** ID of the
|
|
11328
|
+
/** ID of the Access Grant. */
|
|
11316
11329
|
access_grant_id: string
|
|
11317
|
-
/**
|
|
11330
|
+
/** Unique key for the access grant within the workspace. */
|
|
11331
|
+
access_grant_key?: string | undefined
|
|
11332
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
11318
11333
|
user_identity_id: string
|
|
11319
11334
|
/**
|
|
11320
11335
|
* @deprecated Use `space_ids`. */
|
|
11321
11336
|
location_ids: string[]
|
|
11322
|
-
/** IDs of the spaces to which the
|
|
11337
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
11323
11338
|
space_ids: string[]
|
|
11324
|
-
/** Access methods that the user requested for the
|
|
11339
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
11325
11340
|
requested_access_methods: Array<{
|
|
11326
11341
|
/** Display name of the access method. */
|
|
11327
11342
|
display_name: string
|
|
11328
11343
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
11329
11344
|
mode: 'code' | 'card' | 'mobile_key'
|
|
11330
|
-
/** Date and time at which the requested access method was added to the
|
|
11345
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
11331
11346
|
created_at: string
|
|
11332
11347
|
/** IDs of the access methods created for the requested access method. */
|
|
11333
11348
|
created_access_method_ids: string[]
|
|
11334
11349
|
}>
|
|
11335
|
-
/** IDs of the access methods created for the
|
|
11350
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
11336
11351
|
access_method_ids: string[]
|
|
11337
|
-
/** Display name of the
|
|
11352
|
+
/** Display name of the Access Grant. */
|
|
11338
11353
|
display_name: string
|
|
11339
|
-
/** Instant Key URL. Only returned if the
|
|
11354
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
11340
11355
|
instant_key_url?: string | undefined
|
|
11341
|
-
/** Date and time at which the
|
|
11356
|
+
/** Date and time at which the Access Grant was created. */
|
|
11342
11357
|
created_at: string
|
|
11343
|
-
/** Date and time at which the
|
|
11358
|
+
/** Date and time at which the Access Grant starts. */
|
|
11344
11359
|
starts_at?: string | undefined
|
|
11345
|
-
/** Date and time at which the
|
|
11360
|
+
/** Date and time at which the Access Grant ends. */
|
|
11346
11361
|
ends_at?: string | undefined
|
|
11347
11362
|
}>
|
|
11348
11363
|
}
|
|
@@ -11353,7 +11368,7 @@ export interface Routes {
|
|
|
11353
11368
|
queryParams: {}
|
|
11354
11369
|
jsonBody: {}
|
|
11355
11370
|
commonParams: {
|
|
11356
|
-
/** ID of the
|
|
11371
|
+
/** ID of the Access Grant to update. */
|
|
11357
11372
|
access_grant_id: string
|
|
11358
11373
|
/** Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
11359
11374
|
starts_at?: (string | null) | undefined
|
|
@@ -11381,7 +11396,7 @@ export interface Routes {
|
|
|
11381
11396
|
queryParams: {}
|
|
11382
11397
|
jsonBody: {}
|
|
11383
11398
|
commonParams: {
|
|
11384
|
-
/** ID of the `acs_encoder` to use to encode the `
|
|
11399
|
+
/** ID of the `acs_encoder` to use to encode the `access_method`. */
|
|
11385
11400
|
acs_encoder_id: string
|
|
11386
11401
|
/** ID of the `access_method` to encode onto a card. */
|
|
11387
11402
|
access_method_id: string
|
|
@@ -12827,7 +12842,7 @@ export interface Routes {
|
|
|
12827
12842
|
}
|
|
12828
12843
|
formData: {}
|
|
12829
12844
|
jsonResponse: {
|
|
12830
|
-
/** Represents an access method for an
|
|
12845
|
+
/** Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
|
|
12831
12846
|
access_method: {
|
|
12832
12847
|
/** ID of the Seam workspace associated with the access method. */
|
|
12833
12848
|
workspace_id: string
|
|
@@ -12856,7 +12871,7 @@ export interface Routes {
|
|
|
12856
12871
|
queryParams: {}
|
|
12857
12872
|
jsonBody: {}
|
|
12858
12873
|
commonParams: {
|
|
12859
|
-
/** ID of
|
|
12874
|
+
/** ID of Access Grant to list access methods for. */
|
|
12860
12875
|
access_grant_id: string
|
|
12861
12876
|
/** ID of the device for which you want to retrieve all access methods. */
|
|
12862
12877
|
device_id?: string | undefined
|
|
@@ -30707,7 +30722,7 @@ export interface Routes {
|
|
|
30707
30722
|
created_at: string
|
|
30708
30723
|
/** Date and time at which the event occurred. */
|
|
30709
30724
|
occurred_at: string
|
|
30710
|
-
/** ID of the affected
|
|
30725
|
+
/** ID of the affected Access Grant. */
|
|
30711
30726
|
access_grant_id: string
|
|
30712
30727
|
event_type: 'access_grant.created'
|
|
30713
30728
|
}
|
|
@@ -30720,7 +30735,7 @@ export interface Routes {
|
|
|
30720
30735
|
created_at: string
|
|
30721
30736
|
/** Date and time at which the event occurred. */
|
|
30722
30737
|
occurred_at: string
|
|
30723
|
-
/** ID of the affected
|
|
30738
|
+
/** ID of the affected Access Grant. */
|
|
30724
30739
|
access_grant_id: string
|
|
30725
30740
|
event_type: 'access_grant.deleted'
|
|
30726
30741
|
}
|
|
@@ -30733,7 +30748,7 @@ export interface Routes {
|
|
|
30733
30748
|
created_at: string
|
|
30734
30749
|
/** Date and time at which the event occurred. */
|
|
30735
30750
|
occurred_at: string
|
|
30736
|
-
/** ID of the affected
|
|
30751
|
+
/** ID of the affected Access Grant. */
|
|
30737
30752
|
access_grant_id: string
|
|
30738
30753
|
event_type: 'access_grant.access_granted_to_all_doors'
|
|
30739
30754
|
}
|
|
@@ -30746,7 +30761,7 @@ export interface Routes {
|
|
|
30746
30761
|
created_at: string
|
|
30747
30762
|
/** Date and time at which the event occurred. */
|
|
30748
30763
|
occurred_at: string
|
|
30749
|
-
/** ID of the affected
|
|
30764
|
+
/** ID of the affected Access Grant. */
|
|
30750
30765
|
access_grant_id: string
|
|
30751
30766
|
event_type: 'access_grant.access_granted_to_door'
|
|
30752
30767
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -30761,7 +30776,7 @@ export interface Routes {
|
|
|
30761
30776
|
created_at: string
|
|
30762
30777
|
/** Date and time at which the event occurred. */
|
|
30763
30778
|
occurred_at: string
|
|
30764
|
-
/** ID of the affected
|
|
30779
|
+
/** ID of the affected Access Grant. */
|
|
30765
30780
|
access_grant_id: string
|
|
30766
30781
|
event_type: 'access_grant.access_to_door_lost'
|
|
30767
30782
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -32875,7 +32890,7 @@ export interface Routes {
|
|
|
32875
32890
|
created_at: string
|
|
32876
32891
|
/** Date and time at which the event occurred. */
|
|
32877
32892
|
occurred_at: string
|
|
32878
|
-
/** ID of the affected
|
|
32893
|
+
/** ID of the affected Access Grant. */
|
|
32879
32894
|
access_grant_id: string
|
|
32880
32895
|
event_type: 'access_grant.created'
|
|
32881
32896
|
}
|
|
@@ -32888,7 +32903,7 @@ export interface Routes {
|
|
|
32888
32903
|
created_at: string
|
|
32889
32904
|
/** Date and time at which the event occurred. */
|
|
32890
32905
|
occurred_at: string
|
|
32891
|
-
/** ID of the affected
|
|
32906
|
+
/** ID of the affected Access Grant. */
|
|
32892
32907
|
access_grant_id: string
|
|
32893
32908
|
event_type: 'access_grant.deleted'
|
|
32894
32909
|
}
|
|
@@ -32901,7 +32916,7 @@ export interface Routes {
|
|
|
32901
32916
|
created_at: string
|
|
32902
32917
|
/** Date and time at which the event occurred. */
|
|
32903
32918
|
occurred_at: string
|
|
32904
|
-
/** ID of the affected
|
|
32919
|
+
/** ID of the affected Access Grant. */
|
|
32905
32920
|
access_grant_id: string
|
|
32906
32921
|
event_type: 'access_grant.access_granted_to_all_doors'
|
|
32907
32922
|
}
|
|
@@ -32914,7 +32929,7 @@ export interface Routes {
|
|
|
32914
32929
|
created_at: string
|
|
32915
32930
|
/** Date and time at which the event occurred. */
|
|
32916
32931
|
occurred_at: string
|
|
32917
|
-
/** ID of the affected
|
|
32932
|
+
/** ID of the affected Access Grant. */
|
|
32918
32933
|
access_grant_id: string
|
|
32919
32934
|
event_type: 'access_grant.access_granted_to_door'
|
|
32920
32935
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -32929,7 +32944,7 @@ export interface Routes {
|
|
|
32929
32944
|
created_at: string
|
|
32930
32945
|
/** Date and time at which the event occurred. */
|
|
32931
32946
|
occurred_at: string
|
|
32932
|
-
/** ID of the affected
|
|
32947
|
+
/** ID of the affected Access Grant. */
|
|
32933
32948
|
access_grant_id: string
|
|
32934
32949
|
event_type: 'access_grant.access_to_door_lost'
|
|
32935
32950
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -54931,6 +54946,8 @@ export interface Routes {
|
|
|
54931
54946
|
jsonBody: {
|
|
54932
54947
|
/** Name of the space that you want to create. */
|
|
54933
54948
|
name: string
|
|
54949
|
+
/** Unique key for the space within the workspace. */
|
|
54950
|
+
space_key?: string | undefined
|
|
54934
54951
|
/** IDs of the devices that you want to add to the new space. */
|
|
54935
54952
|
device_ids?: string[] | undefined
|
|
54936
54953
|
/** IDs of the entrances that you want to add to the new space. */
|
|
@@ -54945,6 +54962,8 @@ export interface Routes {
|
|
|
54945
54962
|
space_id: string
|
|
54946
54963
|
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
54947
54964
|
workspace_id: string
|
|
54965
|
+
/** Unique key for the space within the workspace. */
|
|
54966
|
+
space_key?: string | undefined
|
|
54948
54967
|
/** Name of the space. */
|
|
54949
54968
|
name: string
|
|
54950
54969
|
/** Display name for the space. */
|
|
@@ -54975,10 +54994,15 @@ export interface Routes {
|
|
|
54975
54994
|
method: 'GET' | 'POST'
|
|
54976
54995
|
queryParams: {}
|
|
54977
54996
|
jsonBody: {}
|
|
54978
|
-
commonParams:
|
|
54979
|
-
|
|
54980
|
-
|
|
54981
|
-
|
|
54997
|
+
commonParams:
|
|
54998
|
+
| {
|
|
54999
|
+
/** ID of the space that you want to get. */
|
|
55000
|
+
space_id: string
|
|
55001
|
+
}
|
|
55002
|
+
| {
|
|
55003
|
+
/** Unique key of the space that you want to get. */
|
|
55004
|
+
space_key: string
|
|
55005
|
+
}
|
|
54982
55006
|
formData: {}
|
|
54983
55007
|
jsonResponse: {
|
|
54984
55008
|
/** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
|
|
@@ -54987,6 +55011,8 @@ export interface Routes {
|
|
|
54987
55011
|
space_id: string
|
|
54988
55012
|
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
54989
55013
|
workspace_id: string
|
|
55014
|
+
/** Unique key for the space within the workspace. */
|
|
55015
|
+
space_key?: string | undefined
|
|
54990
55016
|
/** Name of the space. */
|
|
54991
55017
|
name: string
|
|
54992
55018
|
/** Display name for the space. */
|
|
@@ -55022,6 +55048,8 @@ export interface Routes {
|
|
|
55022
55048
|
space_id: string
|
|
55023
55049
|
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
55024
55050
|
workspace_id: string
|
|
55051
|
+
/** Unique key for the space within the workspace. */
|
|
55052
|
+
space_key?: string | undefined
|
|
55025
55053
|
/** Name of the space. */
|
|
55026
55054
|
name: string
|
|
55027
55055
|
/** Display name for the space. */
|
|
@@ -56644,6 +56672,8 @@ export interface Routes {
|
|
|
56644
56672
|
commonParams: {
|
|
56645
56673
|
/** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
|
|
56646
56674
|
search?: string | undefined
|
|
56675
|
+
/** Filter spaces by space_key. */
|
|
56676
|
+
space_key?: string | undefined
|
|
56647
56677
|
}
|
|
56648
56678
|
formData: {}
|
|
56649
56679
|
jsonResponse: {
|
|
@@ -56652,6 +56682,8 @@ export interface Routes {
|
|
|
56652
56682
|
space_id: string
|
|
56653
56683
|
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
56654
56684
|
workspace_id: string
|
|
56685
|
+
/** Unique key for the space within the workspace. */
|
|
56686
|
+
space_key?: string | undefined
|
|
56655
56687
|
/** Name of the space. */
|
|
56656
56688
|
name: string
|
|
56657
56689
|
/** Display name for the space. */
|
|
@@ -56712,6 +56744,8 @@ export interface Routes {
|
|
|
56712
56744
|
space_id: string
|
|
56713
56745
|
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
56714
56746
|
workspace_id: string
|
|
56747
|
+
/** Unique key for the space within the workspace. */
|
|
56748
|
+
space_key?: string | undefined
|
|
56715
56749
|
/** Name of the space. */
|
|
56716
56750
|
name: string
|
|
56717
56751
|
/** Display name for the space. */
|
|
@@ -74724,41 +74758,43 @@ export interface Routes {
|
|
|
74724
74758
|
}
|
|
74725
74759
|
formData: {}
|
|
74726
74760
|
jsonResponse: {
|
|
74727
|
-
/** Represents an
|
|
74761
|
+
/** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
|
|
74728
74762
|
access_grant: {
|
|
74729
|
-
/** ID of the Seam workspace associated with the
|
|
74763
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
74730
74764
|
workspace_id: string
|
|
74731
|
-
/** ID of the
|
|
74765
|
+
/** ID of the Access Grant. */
|
|
74732
74766
|
access_grant_id: string
|
|
74733
|
-
/**
|
|
74767
|
+
/** Unique key for the access grant within the workspace. */
|
|
74768
|
+
access_grant_key?: string | undefined
|
|
74769
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
74734
74770
|
user_identity_id: string
|
|
74735
74771
|
/**
|
|
74736
74772
|
* @deprecated Use `space_ids`. */
|
|
74737
74773
|
location_ids: string[]
|
|
74738
|
-
/** IDs of the spaces to which the
|
|
74774
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
74739
74775
|
space_ids: string[]
|
|
74740
|
-
/** Access methods that the user requested for the
|
|
74776
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
74741
74777
|
requested_access_methods: Array<{
|
|
74742
74778
|
/** Display name of the access method. */
|
|
74743
74779
|
display_name: string
|
|
74744
74780
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
74745
74781
|
mode: 'code' | 'card' | 'mobile_key'
|
|
74746
|
-
/** Date and time at which the requested access method was added to the
|
|
74782
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
74747
74783
|
created_at: string
|
|
74748
74784
|
/** IDs of the access methods created for the requested access method. */
|
|
74749
74785
|
created_access_method_ids: string[]
|
|
74750
74786
|
}>
|
|
74751
|
-
/** IDs of the access methods created for the
|
|
74787
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
74752
74788
|
access_method_ids: string[]
|
|
74753
|
-
/** Display name of the
|
|
74789
|
+
/** Display name of the Access Grant. */
|
|
74754
74790
|
display_name: string
|
|
74755
|
-
/** Instant Key URL. Only returned if the
|
|
74791
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
74756
74792
|
instant_key_url?: string | undefined
|
|
74757
|
-
/** Date and time at which the
|
|
74793
|
+
/** Date and time at which the Access Grant was created. */
|
|
74758
74794
|
created_at: string
|
|
74759
|
-
/** Date and time at which the
|
|
74795
|
+
/** Date and time at which the Access Grant starts. */
|
|
74760
74796
|
starts_at?: string | undefined
|
|
74761
|
-
/** Date and time at which the
|
|
74797
|
+
/** Date and time at which the Access Grant ends. */
|
|
74762
74798
|
ends_at?: string | undefined
|
|
74763
74799
|
}
|
|
74764
74800
|
}
|
|
@@ -74786,41 +74822,43 @@ export interface Routes {
|
|
|
74786
74822
|
}
|
|
74787
74823
|
formData: {}
|
|
74788
74824
|
jsonResponse: {
|
|
74789
|
-
/** Represents an
|
|
74825
|
+
/** Represents an Access Grant. Access Grants enable you to grant a user identity access to spaces, entrances, and devices through one or more access methods, such as mobile keys, plastic cards, and PIN codes. You can create an Access Grant for an existing user identity, or you can create a new user identity *while* creating the new Access Grant. */
|
|
74790
74826
|
access_grant: {
|
|
74791
|
-
/** ID of the Seam workspace associated with the
|
|
74827
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
74792
74828
|
workspace_id: string
|
|
74793
|
-
/** ID of the
|
|
74829
|
+
/** ID of the Access Grant. */
|
|
74794
74830
|
access_grant_id: string
|
|
74795
|
-
/**
|
|
74831
|
+
/** Unique key for the access grant within the workspace. */
|
|
74832
|
+
access_grant_key?: string | undefined
|
|
74833
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
74796
74834
|
user_identity_id: string
|
|
74797
74835
|
/**
|
|
74798
74836
|
* @deprecated Use `space_ids`. */
|
|
74799
74837
|
location_ids: string[]
|
|
74800
|
-
/** IDs of the spaces to which the
|
|
74838
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
74801
74839
|
space_ids: string[]
|
|
74802
|
-
/** Access methods that the user requested for the
|
|
74840
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
74803
74841
|
requested_access_methods: Array<{
|
|
74804
74842
|
/** Display name of the access method. */
|
|
74805
74843
|
display_name: string
|
|
74806
74844
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
74807
74845
|
mode: 'code' | 'card' | 'mobile_key'
|
|
74808
|
-
/** Date and time at which the requested access method was added to the
|
|
74846
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
74809
74847
|
created_at: string
|
|
74810
74848
|
/** IDs of the access methods created for the requested access method. */
|
|
74811
74849
|
created_access_method_ids: string[]
|
|
74812
74850
|
}>
|
|
74813
|
-
/** IDs of the access methods created for the
|
|
74851
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
74814
74852
|
access_method_ids: string[]
|
|
74815
|
-
/** Display name of the
|
|
74853
|
+
/** Display name of the Access Grant. */
|
|
74816
74854
|
display_name: string
|
|
74817
|
-
/** Instant Key URL. Only returned if the
|
|
74855
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
74818
74856
|
instant_key_url?: string | undefined
|
|
74819
|
-
/** Date and time at which the
|
|
74857
|
+
/** Date and time at which the Access Grant was created. */
|
|
74820
74858
|
created_at: string
|
|
74821
|
-
/** Date and time at which the
|
|
74859
|
+
/** Date and time at which the Access Grant starts. */
|
|
74822
74860
|
starts_at?: string | undefined
|
|
74823
|
-
/** Date and time at which the
|
|
74861
|
+
/** Date and time at which the Access Grant ends. */
|
|
74824
74862
|
ends_at?: string | undefined
|
|
74825
74863
|
}
|
|
74826
74864
|
}
|
|
@@ -74846,39 +74884,41 @@ export interface Routes {
|
|
|
74846
74884
|
formData: {}
|
|
74847
74885
|
jsonResponse: {
|
|
74848
74886
|
access_grants: Array<{
|
|
74849
|
-
/** ID of the Seam workspace associated with the
|
|
74887
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
74850
74888
|
workspace_id: string
|
|
74851
|
-
/** ID of the
|
|
74889
|
+
/** ID of the Access Grant. */
|
|
74852
74890
|
access_grant_id: string
|
|
74853
|
-
/**
|
|
74891
|
+
/** Unique key for the access grant within the workspace. */
|
|
74892
|
+
access_grant_key?: string | undefined
|
|
74893
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
74854
74894
|
user_identity_id: string
|
|
74855
74895
|
/**
|
|
74856
74896
|
* @deprecated Use `space_ids`. */
|
|
74857
74897
|
location_ids: string[]
|
|
74858
|
-
/** IDs of the spaces to which the
|
|
74898
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
74859
74899
|
space_ids: string[]
|
|
74860
|
-
/** Access methods that the user requested for the
|
|
74900
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
74861
74901
|
requested_access_methods: Array<{
|
|
74862
74902
|
/** Display name of the access method. */
|
|
74863
74903
|
display_name: string
|
|
74864
74904
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
74865
74905
|
mode: 'code' | 'card' | 'mobile_key'
|
|
74866
|
-
/** Date and time at which the requested access method was added to the
|
|
74906
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
74867
74907
|
created_at: string
|
|
74868
74908
|
/** IDs of the access methods created for the requested access method. */
|
|
74869
74909
|
created_access_method_ids: string[]
|
|
74870
74910
|
}>
|
|
74871
|
-
/** IDs of the access methods created for the
|
|
74911
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
74872
74912
|
access_method_ids: string[]
|
|
74873
|
-
/** Display name of the
|
|
74913
|
+
/** Display name of the Access Grant. */
|
|
74874
74914
|
display_name: string
|
|
74875
|
-
/** Instant Key URL. Only returned if the
|
|
74915
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
74876
74916
|
instant_key_url?: string | undefined
|
|
74877
|
-
/** Date and time at which the
|
|
74917
|
+
/** Date and time at which the Access Grant was created. */
|
|
74878
74918
|
created_at: string
|
|
74879
|
-
/** Date and time at which the
|
|
74919
|
+
/** Date and time at which the Access Grant starts. */
|
|
74880
74920
|
starts_at?: string | undefined
|
|
74881
|
-
/** Date and time at which the
|
|
74921
|
+
/** Date and time at which the Access Grant ends. */
|
|
74882
74922
|
ends_at?: string | undefined
|
|
74883
74923
|
}>
|
|
74884
74924
|
}
|
|
@@ -74906,7 +74946,7 @@ export interface Routes {
|
|
|
74906
74946
|
}
|
|
74907
74947
|
formData: {}
|
|
74908
74948
|
jsonResponse: {
|
|
74909
|
-
/** Represents an access method for an
|
|
74949
|
+
/** Represents an access method for an Access Grant. Access methods describe the modes of access, such as PIN codes, plastic cards, and mobile keys. For a mobile key, the access method also stores the URL for the associated Instant Key. */
|
|
74910
74950
|
access_method: {
|
|
74911
74951
|
/** ID of the Seam workspace associated with the access method. */
|
|
74912
74952
|
workspace_id: string
|