@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
|
@@ -9933,6 +9933,8 @@ export interface Routes {
|
|
|
9933
9933
|
full_name?: (string | null) | undefined;
|
|
9934
9934
|
};
|
|
9935
9935
|
}) & {
|
|
9936
|
+
/** Unique key for the access grant within the workspace. */
|
|
9937
|
+
access_grant_key?: string | undefined;
|
|
9936
9938
|
/**
|
|
9937
9939
|
* @deprecated Use `space_ids`. */
|
|
9938
9940
|
location_ids?: string[] | undefined;
|
|
@@ -9964,41 +9966,43 @@ export interface Routes {
|
|
|
9964
9966
|
};
|
|
9965
9967
|
formData: {};
|
|
9966
9968
|
jsonResponse: {
|
|
9967
|
-
/** Represents an
|
|
9969
|
+
/** 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. */
|
|
9968
9970
|
access_grant: {
|
|
9969
|
-
/** ID of the Seam workspace associated with the
|
|
9971
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
9970
9972
|
workspace_id: string;
|
|
9971
|
-
/** ID of the
|
|
9973
|
+
/** ID of the Access Grant. */
|
|
9972
9974
|
access_grant_id: string;
|
|
9973
|
-
/**
|
|
9975
|
+
/** Unique key for the access grant within the workspace. */
|
|
9976
|
+
access_grant_key?: string | undefined;
|
|
9977
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
9974
9978
|
user_identity_id: string;
|
|
9975
9979
|
/**
|
|
9976
9980
|
* @deprecated Use `space_ids`. */
|
|
9977
9981
|
location_ids: string[];
|
|
9978
|
-
/** IDs of the spaces to which the
|
|
9982
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
9979
9983
|
space_ids: string[];
|
|
9980
|
-
/** Access methods that the user requested for the
|
|
9984
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
9981
9985
|
requested_access_methods: Array<{
|
|
9982
9986
|
/** Display name of the access method. */
|
|
9983
9987
|
display_name: string;
|
|
9984
9988
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
9985
9989
|
mode: 'code' | 'card' | 'mobile_key';
|
|
9986
|
-
/** Date and time at which the requested access method was added to the
|
|
9990
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
9987
9991
|
created_at: string;
|
|
9988
9992
|
/** IDs of the access methods created for the requested access method. */
|
|
9989
9993
|
created_access_method_ids: string[];
|
|
9990
9994
|
}>;
|
|
9991
|
-
/** IDs of the access methods created for the
|
|
9995
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
9992
9996
|
access_method_ids: string[];
|
|
9993
|
-
/** Display name of the
|
|
9997
|
+
/** Display name of the Access Grant. */
|
|
9994
9998
|
display_name: string;
|
|
9995
|
-
/** Instant Key URL. Only returned if the
|
|
9999
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
9996
10000
|
instant_key_url?: string | undefined;
|
|
9997
|
-
/** Date and time at which the
|
|
10001
|
+
/** Date and time at which the Access Grant was created. */
|
|
9998
10002
|
created_at: string;
|
|
9999
|
-
/** Date and time at which the
|
|
10003
|
+
/** Date and time at which the Access Grant starts. */
|
|
10000
10004
|
starts_at?: string | undefined;
|
|
10001
|
-
/** Date and time at which the
|
|
10005
|
+
/** Date and time at which the Access Grant ends. */
|
|
10002
10006
|
ends_at?: string | undefined;
|
|
10003
10007
|
};
|
|
10004
10008
|
};
|
|
@@ -10009,7 +10013,7 @@ export interface Routes {
|
|
|
10009
10013
|
queryParams: {};
|
|
10010
10014
|
jsonBody: {};
|
|
10011
10015
|
commonParams: {
|
|
10012
|
-
/** ID of
|
|
10016
|
+
/** ID of Access Grant to delete. */
|
|
10013
10017
|
access_grant_id: string;
|
|
10014
10018
|
};
|
|
10015
10019
|
formData: {};
|
|
@@ -10021,46 +10025,51 @@ export interface Routes {
|
|
|
10021
10025
|
queryParams: {};
|
|
10022
10026
|
jsonBody: {};
|
|
10023
10027
|
commonParams: {
|
|
10024
|
-
/** ID of
|
|
10028
|
+
/** ID of Access Grant to get. */
|
|
10025
10029
|
access_grant_id: string;
|
|
10030
|
+
} | {
|
|
10031
|
+
/** Unique key of Access Grant to get. */
|
|
10032
|
+
access_grant_key: string;
|
|
10026
10033
|
};
|
|
10027
10034
|
formData: {};
|
|
10028
10035
|
jsonResponse: {
|
|
10029
|
-
/** Represents an
|
|
10036
|
+
/** 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. */
|
|
10030
10037
|
access_grant: {
|
|
10031
|
-
/** ID of the Seam workspace associated with the
|
|
10038
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
10032
10039
|
workspace_id: string;
|
|
10033
|
-
/** ID of the
|
|
10040
|
+
/** ID of the Access Grant. */
|
|
10034
10041
|
access_grant_id: string;
|
|
10035
|
-
/**
|
|
10042
|
+
/** Unique key for the access grant within the workspace. */
|
|
10043
|
+
access_grant_key?: string | undefined;
|
|
10044
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
10036
10045
|
user_identity_id: string;
|
|
10037
10046
|
/**
|
|
10038
10047
|
* @deprecated Use `space_ids`. */
|
|
10039
10048
|
location_ids: string[];
|
|
10040
|
-
/** IDs of the spaces to which the
|
|
10049
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
10041
10050
|
space_ids: string[];
|
|
10042
|
-
/** Access methods that the user requested for the
|
|
10051
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
10043
10052
|
requested_access_methods: Array<{
|
|
10044
10053
|
/** Display name of the access method. */
|
|
10045
10054
|
display_name: string;
|
|
10046
10055
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
10047
10056
|
mode: 'code' | 'card' | 'mobile_key';
|
|
10048
|
-
/** Date and time at which the requested access method was added to the
|
|
10057
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
10049
10058
|
created_at: string;
|
|
10050
10059
|
/** IDs of the access methods created for the requested access method. */
|
|
10051
10060
|
created_access_method_ids: string[];
|
|
10052
10061
|
}>;
|
|
10053
|
-
/** IDs of the access methods created for the
|
|
10062
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
10054
10063
|
access_method_ids: string[];
|
|
10055
|
-
/** Display name of the
|
|
10064
|
+
/** Display name of the Access Grant. */
|
|
10056
10065
|
display_name: string;
|
|
10057
|
-
/** Instant Key URL. Only returned if the
|
|
10066
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
10058
10067
|
instant_key_url?: string | undefined;
|
|
10059
|
-
/** Date and time at which the
|
|
10068
|
+
/** Date and time at which the Access Grant was created. */
|
|
10060
10069
|
created_at: string;
|
|
10061
|
-
/** Date and time at which the
|
|
10070
|
+
/** Date and time at which the Access Grant starts. */
|
|
10062
10071
|
starts_at?: string | undefined;
|
|
10063
|
-
/** Date and time at which the
|
|
10072
|
+
/** Date and time at which the Access Grant ends. */
|
|
10064
10073
|
ends_at?: string | undefined;
|
|
10065
10074
|
};
|
|
10066
10075
|
};
|
|
@@ -10071,54 +10080,58 @@ export interface Routes {
|
|
|
10071
10080
|
queryParams: {};
|
|
10072
10081
|
jsonBody: {};
|
|
10073
10082
|
commonParams: {
|
|
10074
|
-
/** ID of user identity to filter list of
|
|
10083
|
+
/** ID of user identity by which you want to filter the list of Access Grants. */
|
|
10075
10084
|
user_identity_id?: string | undefined;
|
|
10076
|
-
/** ID of system to filter list of
|
|
10085
|
+
/** ID of the access system by which you want to filter the list of Access Grants. */
|
|
10077
10086
|
acs_system_id?: string | undefined;
|
|
10078
|
-
/** ID of entrance to filter list of
|
|
10087
|
+
/** ID of the entrance by which you want to filter the list of Access Grants. */
|
|
10079
10088
|
acs_entrance_id?: string | undefined;
|
|
10080
10089
|
/**
|
|
10081
10090
|
* @deprecated Use `space_id`. */
|
|
10082
10091
|
location_id?: string | undefined;
|
|
10083
|
-
/** ID of space to filter list of
|
|
10092
|
+
/** ID of the space by which you want to filter the list of Access Grants. */
|
|
10084
10093
|
space_id?: string | undefined;
|
|
10094
|
+
/** Filter Access Grants by access_grant_key. */
|
|
10095
|
+
access_grant_key?: string | undefined;
|
|
10085
10096
|
};
|
|
10086
10097
|
formData: {};
|
|
10087
10098
|
jsonResponse: {
|
|
10088
10099
|
access_grants: Array<{
|
|
10089
|
-
/** ID of the Seam workspace associated with the
|
|
10100
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
10090
10101
|
workspace_id: string;
|
|
10091
|
-
/** ID of the
|
|
10102
|
+
/** ID of the Access Grant. */
|
|
10092
10103
|
access_grant_id: string;
|
|
10093
|
-
/**
|
|
10104
|
+
/** Unique key for the access grant within the workspace. */
|
|
10105
|
+
access_grant_key?: string | undefined;
|
|
10106
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
10094
10107
|
user_identity_id: string;
|
|
10095
10108
|
/**
|
|
10096
10109
|
* @deprecated Use `space_ids`. */
|
|
10097
10110
|
location_ids: string[];
|
|
10098
|
-
/** IDs of the spaces to which the
|
|
10111
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
10099
10112
|
space_ids: string[];
|
|
10100
|
-
/** Access methods that the user requested for the
|
|
10113
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
10101
10114
|
requested_access_methods: Array<{
|
|
10102
10115
|
/** Display name of the access method. */
|
|
10103
10116
|
display_name: string;
|
|
10104
10117
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
10105
10118
|
mode: 'code' | 'card' | 'mobile_key';
|
|
10106
|
-
/** Date and time at which the requested access method was added to the
|
|
10119
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
10107
10120
|
created_at: string;
|
|
10108
10121
|
/** IDs of the access methods created for the requested access method. */
|
|
10109
10122
|
created_access_method_ids: string[];
|
|
10110
10123
|
}>;
|
|
10111
|
-
/** IDs of the access methods created for the
|
|
10124
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
10112
10125
|
access_method_ids: string[];
|
|
10113
|
-
/** Display name of the
|
|
10126
|
+
/** Display name of the Access Grant. */
|
|
10114
10127
|
display_name: string;
|
|
10115
|
-
/** Instant Key URL. Only returned if the
|
|
10128
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
10116
10129
|
instant_key_url?: string | undefined;
|
|
10117
|
-
/** Date and time at which the
|
|
10130
|
+
/** Date and time at which the Access Grant was created. */
|
|
10118
10131
|
created_at: string;
|
|
10119
|
-
/** Date and time at which the
|
|
10132
|
+
/** Date and time at which the Access Grant starts. */
|
|
10120
10133
|
starts_at?: string | undefined;
|
|
10121
|
-
/** Date and time at which the
|
|
10134
|
+
/** Date and time at which the Access Grant ends. */
|
|
10122
10135
|
ends_at?: string | undefined;
|
|
10123
10136
|
}>;
|
|
10124
10137
|
};
|
|
@@ -10129,7 +10142,7 @@ export interface Routes {
|
|
|
10129
10142
|
queryParams: {};
|
|
10130
10143
|
jsonBody: {};
|
|
10131
10144
|
commonParams: {
|
|
10132
|
-
/** ID of the
|
|
10145
|
+
/** ID of the Access Grant to update. */
|
|
10133
10146
|
access_grant_id: string;
|
|
10134
10147
|
/** 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. */
|
|
10135
10148
|
starts_at?: (string | null) | undefined;
|
|
@@ -10157,7 +10170,7 @@ export interface Routes {
|
|
|
10157
10170
|
queryParams: {};
|
|
10158
10171
|
jsonBody: {};
|
|
10159
10172
|
commonParams: {
|
|
10160
|
-
/** ID of the `acs_encoder` to use to encode the `
|
|
10173
|
+
/** ID of the `acs_encoder` to use to encode the `access_method`. */
|
|
10161
10174
|
acs_encoder_id: string;
|
|
10162
10175
|
/** ID of the `access_method` to encode onto a card. */
|
|
10163
10176
|
access_method_id: string;
|
|
@@ -11422,7 +11435,7 @@ export interface Routes {
|
|
|
11422
11435
|
};
|
|
11423
11436
|
formData: {};
|
|
11424
11437
|
jsonResponse: {
|
|
11425
|
-
/** Represents an access method for an
|
|
11438
|
+
/** 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. */
|
|
11426
11439
|
access_method: {
|
|
11427
11440
|
/** ID of the Seam workspace associated with the access method. */
|
|
11428
11441
|
workspace_id: string;
|
|
@@ -11451,7 +11464,7 @@ export interface Routes {
|
|
|
11451
11464
|
queryParams: {};
|
|
11452
11465
|
jsonBody: {};
|
|
11453
11466
|
commonParams: {
|
|
11454
|
-
/** ID of
|
|
11467
|
+
/** ID of Access Grant to list access methods for. */
|
|
11455
11468
|
access_grant_id: string;
|
|
11456
11469
|
/** ID of the device for which you want to retrieve all access methods. */
|
|
11457
11470
|
device_id?: string | undefined;
|
|
@@ -26396,7 +26409,7 @@ export interface Routes {
|
|
|
26396
26409
|
created_at: string;
|
|
26397
26410
|
/** Date and time at which the event occurred. */
|
|
26398
26411
|
occurred_at: string;
|
|
26399
|
-
/** ID of the affected
|
|
26412
|
+
/** ID of the affected Access Grant. */
|
|
26400
26413
|
access_grant_id: string;
|
|
26401
26414
|
event_type: 'access_grant.created';
|
|
26402
26415
|
} | {
|
|
@@ -26408,7 +26421,7 @@ export interface Routes {
|
|
|
26408
26421
|
created_at: string;
|
|
26409
26422
|
/** Date and time at which the event occurred. */
|
|
26410
26423
|
occurred_at: string;
|
|
26411
|
-
/** ID of the affected
|
|
26424
|
+
/** ID of the affected Access Grant. */
|
|
26412
26425
|
access_grant_id: string;
|
|
26413
26426
|
event_type: 'access_grant.deleted';
|
|
26414
26427
|
} | {
|
|
@@ -26420,7 +26433,7 @@ export interface Routes {
|
|
|
26420
26433
|
created_at: string;
|
|
26421
26434
|
/** Date and time at which the event occurred. */
|
|
26422
26435
|
occurred_at: string;
|
|
26423
|
-
/** ID of the affected
|
|
26436
|
+
/** ID of the affected Access Grant. */
|
|
26424
26437
|
access_grant_id: string;
|
|
26425
26438
|
event_type: 'access_grant.access_granted_to_all_doors';
|
|
26426
26439
|
} | {
|
|
@@ -26432,7 +26445,7 @@ export interface Routes {
|
|
|
26432
26445
|
created_at: string;
|
|
26433
26446
|
/** Date and time at which the event occurred. */
|
|
26434
26447
|
occurred_at: string;
|
|
26435
|
-
/** ID of the affected
|
|
26448
|
+
/** ID of the affected Access Grant. */
|
|
26436
26449
|
access_grant_id: string;
|
|
26437
26450
|
event_type: 'access_grant.access_granted_to_door';
|
|
26438
26451
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -26446,7 +26459,7 @@ export interface Routes {
|
|
|
26446
26459
|
created_at: string;
|
|
26447
26460
|
/** Date and time at which the event occurred. */
|
|
26448
26461
|
occurred_at: string;
|
|
26449
|
-
/** ID of the affected
|
|
26462
|
+
/** ID of the affected Access Grant. */
|
|
26450
26463
|
access_grant_id: string;
|
|
26451
26464
|
event_type: 'access_grant.access_to_door_lost';
|
|
26452
26465
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -28048,7 +28061,7 @@ export interface Routes {
|
|
|
28048
28061
|
created_at: string;
|
|
28049
28062
|
/** Date and time at which the event occurred. */
|
|
28050
28063
|
occurred_at: string;
|
|
28051
|
-
/** ID of the affected
|
|
28064
|
+
/** ID of the affected Access Grant. */
|
|
28052
28065
|
access_grant_id: string;
|
|
28053
28066
|
event_type: 'access_grant.created';
|
|
28054
28067
|
} | {
|
|
@@ -28060,7 +28073,7 @@ export interface Routes {
|
|
|
28060
28073
|
created_at: string;
|
|
28061
28074
|
/** Date and time at which the event occurred. */
|
|
28062
28075
|
occurred_at: string;
|
|
28063
|
-
/** ID of the affected
|
|
28076
|
+
/** ID of the affected Access Grant. */
|
|
28064
28077
|
access_grant_id: string;
|
|
28065
28078
|
event_type: 'access_grant.deleted';
|
|
28066
28079
|
} | {
|
|
@@ -28072,7 +28085,7 @@ export interface Routes {
|
|
|
28072
28085
|
created_at: string;
|
|
28073
28086
|
/** Date and time at which the event occurred. */
|
|
28074
28087
|
occurred_at: string;
|
|
28075
|
-
/** ID of the affected
|
|
28088
|
+
/** ID of the affected Access Grant. */
|
|
28076
28089
|
access_grant_id: string;
|
|
28077
28090
|
event_type: 'access_grant.access_granted_to_all_doors';
|
|
28078
28091
|
} | {
|
|
@@ -28084,7 +28097,7 @@ export interface Routes {
|
|
|
28084
28097
|
created_at: string;
|
|
28085
28098
|
/** Date and time at which the event occurred. */
|
|
28086
28099
|
occurred_at: string;
|
|
28087
|
-
/** ID of the affected
|
|
28100
|
+
/** ID of the affected Access Grant. */
|
|
28088
28101
|
access_grant_id: string;
|
|
28089
28102
|
event_type: 'access_grant.access_granted_to_door';
|
|
28090
28103
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -28098,7 +28111,7 @@ export interface Routes {
|
|
|
28098
28111
|
created_at: string;
|
|
28099
28112
|
/** Date and time at which the event occurred. */
|
|
28100
28113
|
occurred_at: string;
|
|
28101
|
-
/** ID of the affected
|
|
28114
|
+
/** ID of the affected Access Grant. */
|
|
28102
28115
|
access_grant_id: string;
|
|
28103
28116
|
event_type: 'access_grant.access_to_door_lost';
|
|
28104
28117
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -46574,6 +46587,8 @@ export interface Routes {
|
|
|
46574
46587
|
jsonBody: {
|
|
46575
46588
|
/** Name of the space that you want to create. */
|
|
46576
46589
|
name: string;
|
|
46590
|
+
/** Unique key for the space within the workspace. */
|
|
46591
|
+
space_key?: string | undefined;
|
|
46577
46592
|
/** IDs of the devices that you want to add to the new space. */
|
|
46578
46593
|
device_ids?: string[] | undefined;
|
|
46579
46594
|
/** IDs of the entrances that you want to add to the new space. */
|
|
@@ -46588,6 +46603,8 @@ export interface Routes {
|
|
|
46588
46603
|
space_id: string;
|
|
46589
46604
|
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
46590
46605
|
workspace_id: string;
|
|
46606
|
+
/** Unique key for the space within the workspace. */
|
|
46607
|
+
space_key?: string | undefined;
|
|
46591
46608
|
/** Name of the space. */
|
|
46592
46609
|
name: string;
|
|
46593
46610
|
/** Display name for the space. */
|
|
@@ -46621,6 +46638,9 @@ export interface Routes {
|
|
|
46621
46638
|
commonParams: {
|
|
46622
46639
|
/** ID of the space that you want to get. */
|
|
46623
46640
|
space_id: string;
|
|
46641
|
+
} | {
|
|
46642
|
+
/** Unique key of the space that you want to get. */
|
|
46643
|
+
space_key: string;
|
|
46624
46644
|
};
|
|
46625
46645
|
formData: {};
|
|
46626
46646
|
jsonResponse: {
|
|
@@ -46630,6 +46650,8 @@ export interface Routes {
|
|
|
46630
46650
|
space_id: string;
|
|
46631
46651
|
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
46632
46652
|
workspace_id: string;
|
|
46653
|
+
/** Unique key for the space within the workspace. */
|
|
46654
|
+
space_key?: string | undefined;
|
|
46633
46655
|
/** Name of the space. */
|
|
46634
46656
|
name: string;
|
|
46635
46657
|
/** Display name for the space. */
|
|
@@ -46664,6 +46686,8 @@ export interface Routes {
|
|
|
46664
46686
|
space_id: string;
|
|
46665
46687
|
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
46666
46688
|
workspace_id: string;
|
|
46689
|
+
/** Unique key for the space within the workspace. */
|
|
46690
|
+
space_key?: string | undefined;
|
|
46667
46691
|
/** Name of the space. */
|
|
46668
46692
|
name: string;
|
|
46669
46693
|
/** Display name for the space. */
|
|
@@ -47942,6 +47966,8 @@ export interface Routes {
|
|
|
47942
47966
|
commonParams: {
|
|
47943
47967
|
/** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`. */
|
|
47944
47968
|
search?: string | undefined;
|
|
47969
|
+
/** Filter spaces by space_key. */
|
|
47970
|
+
space_key?: string | undefined;
|
|
47945
47971
|
};
|
|
47946
47972
|
formData: {};
|
|
47947
47973
|
jsonResponse: {
|
|
@@ -47950,6 +47976,8 @@ export interface Routes {
|
|
|
47950
47976
|
space_id: string;
|
|
47951
47977
|
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
47952
47978
|
workspace_id: string;
|
|
47979
|
+
/** Unique key for the space within the workspace. */
|
|
47980
|
+
space_key?: string | undefined;
|
|
47953
47981
|
/** Name of the space. */
|
|
47954
47982
|
name: string;
|
|
47955
47983
|
/** Display name for the space. */
|
|
@@ -48010,6 +48038,8 @@ export interface Routes {
|
|
|
48010
48038
|
space_id: string;
|
|
48011
48039
|
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the space. */
|
|
48012
48040
|
workspace_id: string;
|
|
48041
|
+
/** Unique key for the space within the workspace. */
|
|
48042
|
+
space_key?: string | undefined;
|
|
48013
48043
|
/** Name of the space. */
|
|
48014
48044
|
name: string;
|
|
48015
48045
|
/** Display name for the space. */
|
|
@@ -63457,41 +63487,43 @@ export interface Routes {
|
|
|
63457
63487
|
};
|
|
63458
63488
|
formData: {};
|
|
63459
63489
|
jsonResponse: {
|
|
63460
|
-
/** Represents an
|
|
63490
|
+
/** 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. */
|
|
63461
63491
|
access_grant: {
|
|
63462
|
-
/** ID of the Seam workspace associated with the
|
|
63492
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
63463
63493
|
workspace_id: string;
|
|
63464
|
-
/** ID of the
|
|
63494
|
+
/** ID of the Access Grant. */
|
|
63465
63495
|
access_grant_id: string;
|
|
63466
|
-
/**
|
|
63496
|
+
/** Unique key for the access grant within the workspace. */
|
|
63497
|
+
access_grant_key?: string | undefined;
|
|
63498
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
63467
63499
|
user_identity_id: string;
|
|
63468
63500
|
/**
|
|
63469
63501
|
* @deprecated Use `space_ids`. */
|
|
63470
63502
|
location_ids: string[];
|
|
63471
|
-
/** IDs of the spaces to which the
|
|
63503
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
63472
63504
|
space_ids: string[];
|
|
63473
|
-
/** Access methods that the user requested for the
|
|
63505
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
63474
63506
|
requested_access_methods: Array<{
|
|
63475
63507
|
/** Display name of the access method. */
|
|
63476
63508
|
display_name: string;
|
|
63477
63509
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
63478
63510
|
mode: 'code' | 'card' | 'mobile_key';
|
|
63479
|
-
/** Date and time at which the requested access method was added to the
|
|
63511
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
63480
63512
|
created_at: string;
|
|
63481
63513
|
/** IDs of the access methods created for the requested access method. */
|
|
63482
63514
|
created_access_method_ids: string[];
|
|
63483
63515
|
}>;
|
|
63484
|
-
/** IDs of the access methods created for the
|
|
63516
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
63485
63517
|
access_method_ids: string[];
|
|
63486
|
-
/** Display name of the
|
|
63518
|
+
/** Display name of the Access Grant. */
|
|
63487
63519
|
display_name: string;
|
|
63488
|
-
/** Instant Key URL. Only returned if the
|
|
63520
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
63489
63521
|
instant_key_url?: string | undefined;
|
|
63490
|
-
/** Date and time at which the
|
|
63522
|
+
/** Date and time at which the Access Grant was created. */
|
|
63491
63523
|
created_at: string;
|
|
63492
|
-
/** Date and time at which the
|
|
63524
|
+
/** Date and time at which the Access Grant starts. */
|
|
63493
63525
|
starts_at?: string | undefined;
|
|
63494
|
-
/** Date and time at which the
|
|
63526
|
+
/** Date and time at which the Access Grant ends. */
|
|
63495
63527
|
ends_at?: string | undefined;
|
|
63496
63528
|
};
|
|
63497
63529
|
};
|
|
@@ -63519,41 +63551,43 @@ export interface Routes {
|
|
|
63519
63551
|
};
|
|
63520
63552
|
formData: {};
|
|
63521
63553
|
jsonResponse: {
|
|
63522
|
-
/** Represents an
|
|
63554
|
+
/** 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. */
|
|
63523
63555
|
access_grant: {
|
|
63524
|
-
/** ID of the Seam workspace associated with the
|
|
63556
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
63525
63557
|
workspace_id: string;
|
|
63526
|
-
/** ID of the
|
|
63558
|
+
/** ID of the Access Grant. */
|
|
63527
63559
|
access_grant_id: string;
|
|
63528
|
-
/**
|
|
63560
|
+
/** Unique key for the access grant within the workspace. */
|
|
63561
|
+
access_grant_key?: string | undefined;
|
|
63562
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
63529
63563
|
user_identity_id: string;
|
|
63530
63564
|
/**
|
|
63531
63565
|
* @deprecated Use `space_ids`. */
|
|
63532
63566
|
location_ids: string[];
|
|
63533
|
-
/** IDs of the spaces to which the
|
|
63567
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
63534
63568
|
space_ids: string[];
|
|
63535
|
-
/** Access methods that the user requested for the
|
|
63569
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
63536
63570
|
requested_access_methods: Array<{
|
|
63537
63571
|
/** Display name of the access method. */
|
|
63538
63572
|
display_name: string;
|
|
63539
63573
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
63540
63574
|
mode: 'code' | 'card' | 'mobile_key';
|
|
63541
|
-
/** Date and time at which the requested access method was added to the
|
|
63575
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
63542
63576
|
created_at: string;
|
|
63543
63577
|
/** IDs of the access methods created for the requested access method. */
|
|
63544
63578
|
created_access_method_ids: string[];
|
|
63545
63579
|
}>;
|
|
63546
|
-
/** IDs of the access methods created for the
|
|
63580
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
63547
63581
|
access_method_ids: string[];
|
|
63548
|
-
/** Display name of the
|
|
63582
|
+
/** Display name of the Access Grant. */
|
|
63549
63583
|
display_name: string;
|
|
63550
|
-
/** Instant Key URL. Only returned if the
|
|
63584
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
63551
63585
|
instant_key_url?: string | undefined;
|
|
63552
|
-
/** Date and time at which the
|
|
63586
|
+
/** Date and time at which the Access Grant was created. */
|
|
63553
63587
|
created_at: string;
|
|
63554
|
-
/** Date and time at which the
|
|
63588
|
+
/** Date and time at which the Access Grant starts. */
|
|
63555
63589
|
starts_at?: string | undefined;
|
|
63556
|
-
/** Date and time at which the
|
|
63590
|
+
/** Date and time at which the Access Grant ends. */
|
|
63557
63591
|
ends_at?: string | undefined;
|
|
63558
63592
|
};
|
|
63559
63593
|
};
|
|
@@ -63579,39 +63613,41 @@ export interface Routes {
|
|
|
63579
63613
|
formData: {};
|
|
63580
63614
|
jsonResponse: {
|
|
63581
63615
|
access_grants: Array<{
|
|
63582
|
-
/** ID of the Seam workspace associated with the
|
|
63616
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
63583
63617
|
workspace_id: string;
|
|
63584
|
-
/** ID of the
|
|
63618
|
+
/** ID of the Access Grant. */
|
|
63585
63619
|
access_grant_id: string;
|
|
63586
|
-
/**
|
|
63620
|
+
/** Unique key for the access grant within the workspace. */
|
|
63621
|
+
access_grant_key?: string | undefined;
|
|
63622
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
63587
63623
|
user_identity_id: string;
|
|
63588
63624
|
/**
|
|
63589
63625
|
* @deprecated Use `space_ids`. */
|
|
63590
63626
|
location_ids: string[];
|
|
63591
|
-
/** IDs of the spaces to which the
|
|
63627
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
63592
63628
|
space_ids: string[];
|
|
63593
|
-
/** Access methods that the user requested for the
|
|
63629
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
63594
63630
|
requested_access_methods: Array<{
|
|
63595
63631
|
/** Display name of the access method. */
|
|
63596
63632
|
display_name: string;
|
|
63597
63633
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
63598
63634
|
mode: 'code' | 'card' | 'mobile_key';
|
|
63599
|
-
/** Date and time at which the requested access method was added to the
|
|
63635
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
63600
63636
|
created_at: string;
|
|
63601
63637
|
/** IDs of the access methods created for the requested access method. */
|
|
63602
63638
|
created_access_method_ids: string[];
|
|
63603
63639
|
}>;
|
|
63604
|
-
/** IDs of the access methods created for the
|
|
63640
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
63605
63641
|
access_method_ids: string[];
|
|
63606
|
-
/** Display name of the
|
|
63642
|
+
/** Display name of the Access Grant. */
|
|
63607
63643
|
display_name: string;
|
|
63608
|
-
/** Instant Key URL. Only returned if the
|
|
63644
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
63609
63645
|
instant_key_url?: string | undefined;
|
|
63610
|
-
/** Date and time at which the
|
|
63646
|
+
/** Date and time at which the Access Grant was created. */
|
|
63611
63647
|
created_at: string;
|
|
63612
|
-
/** Date and time at which the
|
|
63648
|
+
/** Date and time at which the Access Grant starts. */
|
|
63613
63649
|
starts_at?: string | undefined;
|
|
63614
|
-
/** Date and time at which the
|
|
63650
|
+
/** Date and time at which the Access Grant ends. */
|
|
63615
63651
|
ends_at?: string | undefined;
|
|
63616
63652
|
}>;
|
|
63617
63653
|
};
|
|
@@ -63639,7 +63675,7 @@ export interface Routes {
|
|
|
63639
63675
|
};
|
|
63640
63676
|
formData: {};
|
|
63641
63677
|
jsonResponse: {
|
|
63642
|
-
/** Represents an access method for an
|
|
63678
|
+
/** 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. */
|
|
63643
63679
|
access_method: {
|
|
63644
63680
|
/** ID of the Seam workspace associated with the access method. */
|
|
63645
63681
|
workspace_id: string;
|