@seamapi/types 1.445.0 → 1.445.1
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 +65 -65
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +97 -97
- package/dist/index.cjs +65 -65
- package/dist/index.cjs.map +1 -1
- package/lib/seam/connect/models/access-grants/access-grant.js +12 -12
- 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/events/access-grants.js +6 -6
- package/lib/seam/connect/models/events/access-methods.js +1 -1
- package/lib/seam/connect/openapi.js +58 -58
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +97 -97
- package/package.json +1 -1
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +12 -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/openapi.ts +61 -58
- package/src/lib/seam/connect/route-types.ts +97 -97
|
@@ -9964,41 +9964,41 @@ export interface Routes {
|
|
|
9964
9964
|
};
|
|
9965
9965
|
formData: {};
|
|
9966
9966
|
jsonResponse: {
|
|
9967
|
-
/** Represents an
|
|
9967
|
+
/** 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
9968
|
access_grant: {
|
|
9969
|
-
/** ID of the Seam workspace associated with the
|
|
9969
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
9970
9970
|
workspace_id: string;
|
|
9971
|
-
/** ID of the
|
|
9971
|
+
/** ID of the Access Grant. */
|
|
9972
9972
|
access_grant_id: string;
|
|
9973
|
-
/** ID of user identity to which the
|
|
9973
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
9974
9974
|
user_identity_id: string;
|
|
9975
9975
|
/**
|
|
9976
9976
|
* @deprecated Use `space_ids`. */
|
|
9977
9977
|
location_ids: string[];
|
|
9978
|
-
/** IDs of the spaces to which the
|
|
9978
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
9979
9979
|
space_ids: string[];
|
|
9980
|
-
/** Access methods that the user requested for the
|
|
9980
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
9981
9981
|
requested_access_methods: Array<{
|
|
9982
9982
|
/** Display name of the access method. */
|
|
9983
9983
|
display_name: string;
|
|
9984
9984
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
9985
9985
|
mode: 'code' | 'card' | 'mobile_key';
|
|
9986
|
-
/** Date and time at which the requested access method was added to the
|
|
9986
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
9987
9987
|
created_at: string;
|
|
9988
9988
|
/** IDs of the access methods created for the requested access method. */
|
|
9989
9989
|
created_access_method_ids: string[];
|
|
9990
9990
|
}>;
|
|
9991
|
-
/** IDs of the access methods created for the
|
|
9991
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
9992
9992
|
access_method_ids: string[];
|
|
9993
|
-
/** Display name of the
|
|
9993
|
+
/** Display name of the Access Grant. */
|
|
9994
9994
|
display_name: string;
|
|
9995
|
-
/** Instant Key URL. Only returned if the
|
|
9995
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
9996
9996
|
instant_key_url?: string | undefined;
|
|
9997
|
-
/** Date and time at which the
|
|
9997
|
+
/** Date and time at which the Access Grant was created. */
|
|
9998
9998
|
created_at: string;
|
|
9999
|
-
/** Date and time at which the
|
|
9999
|
+
/** Date and time at which the Access Grant starts. */
|
|
10000
10000
|
starts_at?: string | undefined;
|
|
10001
|
-
/** Date and time at which the
|
|
10001
|
+
/** Date and time at which the Access Grant ends. */
|
|
10002
10002
|
ends_at?: string | undefined;
|
|
10003
10003
|
};
|
|
10004
10004
|
};
|
|
@@ -10009,7 +10009,7 @@ export interface Routes {
|
|
|
10009
10009
|
queryParams: {};
|
|
10010
10010
|
jsonBody: {};
|
|
10011
10011
|
commonParams: {
|
|
10012
|
-
/** ID of
|
|
10012
|
+
/** ID of Access Grant to delete. */
|
|
10013
10013
|
access_grant_id: string;
|
|
10014
10014
|
};
|
|
10015
10015
|
formData: {};
|
|
@@ -10021,46 +10021,46 @@ export interface Routes {
|
|
|
10021
10021
|
queryParams: {};
|
|
10022
10022
|
jsonBody: {};
|
|
10023
10023
|
commonParams: {
|
|
10024
|
-
/** ID of
|
|
10024
|
+
/** ID of Access Grant to get. */
|
|
10025
10025
|
access_grant_id: string;
|
|
10026
10026
|
};
|
|
10027
10027
|
formData: {};
|
|
10028
10028
|
jsonResponse: {
|
|
10029
|
-
/** Represents an
|
|
10029
|
+
/** 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
10030
|
access_grant: {
|
|
10031
|
-
/** ID of the Seam workspace associated with the
|
|
10031
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
10032
10032
|
workspace_id: string;
|
|
10033
|
-
/** ID of the
|
|
10033
|
+
/** ID of the Access Grant. */
|
|
10034
10034
|
access_grant_id: string;
|
|
10035
|
-
/** ID of user identity to which the
|
|
10035
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
10036
10036
|
user_identity_id: string;
|
|
10037
10037
|
/**
|
|
10038
10038
|
* @deprecated Use `space_ids`. */
|
|
10039
10039
|
location_ids: string[];
|
|
10040
|
-
/** IDs of the spaces to which the
|
|
10040
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
10041
10041
|
space_ids: string[];
|
|
10042
|
-
/** Access methods that the user requested for the
|
|
10042
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
10043
10043
|
requested_access_methods: Array<{
|
|
10044
10044
|
/** Display name of the access method. */
|
|
10045
10045
|
display_name: string;
|
|
10046
10046
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
10047
10047
|
mode: 'code' | 'card' | 'mobile_key';
|
|
10048
|
-
/** Date and time at which the requested access method was added to the
|
|
10048
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
10049
10049
|
created_at: string;
|
|
10050
10050
|
/** IDs of the access methods created for the requested access method. */
|
|
10051
10051
|
created_access_method_ids: string[];
|
|
10052
10052
|
}>;
|
|
10053
|
-
/** IDs of the access methods created for the
|
|
10053
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
10054
10054
|
access_method_ids: string[];
|
|
10055
|
-
/** Display name of the
|
|
10055
|
+
/** Display name of the Access Grant. */
|
|
10056
10056
|
display_name: string;
|
|
10057
|
-
/** Instant Key URL. Only returned if the
|
|
10057
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
10058
10058
|
instant_key_url?: string | undefined;
|
|
10059
|
-
/** Date and time at which the
|
|
10059
|
+
/** Date and time at which the Access Grant was created. */
|
|
10060
10060
|
created_at: string;
|
|
10061
|
-
/** Date and time at which the
|
|
10061
|
+
/** Date and time at which the Access Grant starts. */
|
|
10062
10062
|
starts_at?: string | undefined;
|
|
10063
|
-
/** Date and time at which the
|
|
10063
|
+
/** Date and time at which the Access Grant ends. */
|
|
10064
10064
|
ends_at?: string | undefined;
|
|
10065
10065
|
};
|
|
10066
10066
|
};
|
|
@@ -10071,54 +10071,54 @@ export interface Routes {
|
|
|
10071
10071
|
queryParams: {};
|
|
10072
10072
|
jsonBody: {};
|
|
10073
10073
|
commonParams: {
|
|
10074
|
-
/** ID of user identity to filter list of
|
|
10074
|
+
/** ID of user identity by which you want to filter the list of Access Grants. */
|
|
10075
10075
|
user_identity_id?: string | undefined;
|
|
10076
|
-
/** ID of system to filter list of
|
|
10076
|
+
/** ID of the access system by which you want to filter the list of Access Grants. */
|
|
10077
10077
|
acs_system_id?: string | undefined;
|
|
10078
|
-
/** ID of entrance to filter list of
|
|
10078
|
+
/** ID of the entrance by which you want to filter the list of Access Grants. */
|
|
10079
10079
|
acs_entrance_id?: string | undefined;
|
|
10080
10080
|
/**
|
|
10081
10081
|
* @deprecated Use `space_id`. */
|
|
10082
10082
|
location_id?: string | undefined;
|
|
10083
|
-
/** ID of space to filter list of
|
|
10083
|
+
/** ID of the space by which you want to filter the list of Access Grants. */
|
|
10084
10084
|
space_id?: string | undefined;
|
|
10085
10085
|
};
|
|
10086
10086
|
formData: {};
|
|
10087
10087
|
jsonResponse: {
|
|
10088
10088
|
access_grants: Array<{
|
|
10089
|
-
/** ID of the Seam workspace associated with the
|
|
10089
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
10090
10090
|
workspace_id: string;
|
|
10091
|
-
/** ID of the
|
|
10091
|
+
/** ID of the Access Grant. */
|
|
10092
10092
|
access_grant_id: string;
|
|
10093
|
-
/** ID of user identity to which the
|
|
10093
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
10094
10094
|
user_identity_id: string;
|
|
10095
10095
|
/**
|
|
10096
10096
|
* @deprecated Use `space_ids`. */
|
|
10097
10097
|
location_ids: string[];
|
|
10098
|
-
/** IDs of the spaces to which the
|
|
10098
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
10099
10099
|
space_ids: string[];
|
|
10100
|
-
/** Access methods that the user requested for the
|
|
10100
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
10101
10101
|
requested_access_methods: Array<{
|
|
10102
10102
|
/** Display name of the access method. */
|
|
10103
10103
|
display_name: string;
|
|
10104
10104
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
10105
10105
|
mode: 'code' | 'card' | 'mobile_key';
|
|
10106
|
-
/** Date and time at which the requested access method was added to the
|
|
10106
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
10107
10107
|
created_at: string;
|
|
10108
10108
|
/** IDs of the access methods created for the requested access method. */
|
|
10109
10109
|
created_access_method_ids: string[];
|
|
10110
10110
|
}>;
|
|
10111
|
-
/** IDs of the access methods created for the
|
|
10111
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
10112
10112
|
access_method_ids: string[];
|
|
10113
|
-
/** Display name of the
|
|
10113
|
+
/** Display name of the Access Grant. */
|
|
10114
10114
|
display_name: string;
|
|
10115
|
-
/** Instant Key URL. Only returned if the
|
|
10115
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
10116
10116
|
instant_key_url?: string | undefined;
|
|
10117
|
-
/** Date and time at which the
|
|
10117
|
+
/** Date and time at which the Access Grant was created. */
|
|
10118
10118
|
created_at: string;
|
|
10119
|
-
/** Date and time at which the
|
|
10119
|
+
/** Date and time at which the Access Grant starts. */
|
|
10120
10120
|
starts_at?: string | undefined;
|
|
10121
|
-
/** Date and time at which the
|
|
10121
|
+
/** Date and time at which the Access Grant ends. */
|
|
10122
10122
|
ends_at?: string | undefined;
|
|
10123
10123
|
}>;
|
|
10124
10124
|
};
|
|
@@ -10129,7 +10129,7 @@ export interface Routes {
|
|
|
10129
10129
|
queryParams: {};
|
|
10130
10130
|
jsonBody: {};
|
|
10131
10131
|
commonParams: {
|
|
10132
|
-
/** ID of the
|
|
10132
|
+
/** ID of the Access Grant to update. */
|
|
10133
10133
|
access_grant_id: string;
|
|
10134
10134
|
/** 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
10135
|
starts_at?: (string | null) | undefined;
|
|
@@ -10157,7 +10157,7 @@ export interface Routes {
|
|
|
10157
10157
|
queryParams: {};
|
|
10158
10158
|
jsonBody: {};
|
|
10159
10159
|
commonParams: {
|
|
10160
|
-
/** ID of the `acs_encoder` to use to encode the `
|
|
10160
|
+
/** ID of the `acs_encoder` to use to encode the `access_method`. */
|
|
10161
10161
|
acs_encoder_id: string;
|
|
10162
10162
|
/** ID of the `access_method` to encode onto a card. */
|
|
10163
10163
|
access_method_id: string;
|
|
@@ -11422,7 +11422,7 @@ export interface Routes {
|
|
|
11422
11422
|
};
|
|
11423
11423
|
formData: {};
|
|
11424
11424
|
jsonResponse: {
|
|
11425
|
-
/** Represents an access method for an
|
|
11425
|
+
/** 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
11426
|
access_method: {
|
|
11427
11427
|
/** ID of the Seam workspace associated with the access method. */
|
|
11428
11428
|
workspace_id: string;
|
|
@@ -11451,7 +11451,7 @@ export interface Routes {
|
|
|
11451
11451
|
queryParams: {};
|
|
11452
11452
|
jsonBody: {};
|
|
11453
11453
|
commonParams: {
|
|
11454
|
-
/** ID of
|
|
11454
|
+
/** ID of Access Grant to list access methods for. */
|
|
11455
11455
|
access_grant_id: string;
|
|
11456
11456
|
/** ID of the device for which you want to retrieve all access methods. */
|
|
11457
11457
|
device_id?: string | undefined;
|
|
@@ -26396,7 +26396,7 @@ export interface Routes {
|
|
|
26396
26396
|
created_at: string;
|
|
26397
26397
|
/** Date and time at which the event occurred. */
|
|
26398
26398
|
occurred_at: string;
|
|
26399
|
-
/** ID of the affected
|
|
26399
|
+
/** ID of the affected Access Grant. */
|
|
26400
26400
|
access_grant_id: string;
|
|
26401
26401
|
event_type: 'access_grant.created';
|
|
26402
26402
|
} | {
|
|
@@ -26408,7 +26408,7 @@ export interface Routes {
|
|
|
26408
26408
|
created_at: string;
|
|
26409
26409
|
/** Date and time at which the event occurred. */
|
|
26410
26410
|
occurred_at: string;
|
|
26411
|
-
/** ID of the affected
|
|
26411
|
+
/** ID of the affected Access Grant. */
|
|
26412
26412
|
access_grant_id: string;
|
|
26413
26413
|
event_type: 'access_grant.deleted';
|
|
26414
26414
|
} | {
|
|
@@ -26420,7 +26420,7 @@ export interface Routes {
|
|
|
26420
26420
|
created_at: string;
|
|
26421
26421
|
/** Date and time at which the event occurred. */
|
|
26422
26422
|
occurred_at: string;
|
|
26423
|
-
/** ID of the affected
|
|
26423
|
+
/** ID of the affected Access Grant. */
|
|
26424
26424
|
access_grant_id: string;
|
|
26425
26425
|
event_type: 'access_grant.access_granted_to_all_doors';
|
|
26426
26426
|
} | {
|
|
@@ -26432,7 +26432,7 @@ export interface Routes {
|
|
|
26432
26432
|
created_at: string;
|
|
26433
26433
|
/** Date and time at which the event occurred. */
|
|
26434
26434
|
occurred_at: string;
|
|
26435
|
-
/** ID of the affected
|
|
26435
|
+
/** ID of the affected Access Grant. */
|
|
26436
26436
|
access_grant_id: string;
|
|
26437
26437
|
event_type: 'access_grant.access_granted_to_door';
|
|
26438
26438
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -26446,7 +26446,7 @@ export interface Routes {
|
|
|
26446
26446
|
created_at: string;
|
|
26447
26447
|
/** Date and time at which the event occurred. */
|
|
26448
26448
|
occurred_at: string;
|
|
26449
|
-
/** ID of the affected
|
|
26449
|
+
/** ID of the affected Access Grant. */
|
|
26450
26450
|
access_grant_id: string;
|
|
26451
26451
|
event_type: 'access_grant.access_to_door_lost';
|
|
26452
26452
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -28048,7 +28048,7 @@ export interface Routes {
|
|
|
28048
28048
|
created_at: string;
|
|
28049
28049
|
/** Date and time at which the event occurred. */
|
|
28050
28050
|
occurred_at: string;
|
|
28051
|
-
/** ID of the affected
|
|
28051
|
+
/** ID of the affected Access Grant. */
|
|
28052
28052
|
access_grant_id: string;
|
|
28053
28053
|
event_type: 'access_grant.created';
|
|
28054
28054
|
} | {
|
|
@@ -28060,7 +28060,7 @@ export interface Routes {
|
|
|
28060
28060
|
created_at: string;
|
|
28061
28061
|
/** Date and time at which the event occurred. */
|
|
28062
28062
|
occurred_at: string;
|
|
28063
|
-
/** ID of the affected
|
|
28063
|
+
/** ID of the affected Access Grant. */
|
|
28064
28064
|
access_grant_id: string;
|
|
28065
28065
|
event_type: 'access_grant.deleted';
|
|
28066
28066
|
} | {
|
|
@@ -28072,7 +28072,7 @@ export interface Routes {
|
|
|
28072
28072
|
created_at: string;
|
|
28073
28073
|
/** Date and time at which the event occurred. */
|
|
28074
28074
|
occurred_at: string;
|
|
28075
|
-
/** ID of the affected
|
|
28075
|
+
/** ID of the affected Access Grant. */
|
|
28076
28076
|
access_grant_id: string;
|
|
28077
28077
|
event_type: 'access_grant.access_granted_to_all_doors';
|
|
28078
28078
|
} | {
|
|
@@ -28084,7 +28084,7 @@ export interface Routes {
|
|
|
28084
28084
|
created_at: string;
|
|
28085
28085
|
/** Date and time at which the event occurred. */
|
|
28086
28086
|
occurred_at: string;
|
|
28087
|
-
/** ID of the affected
|
|
28087
|
+
/** ID of the affected Access Grant. */
|
|
28088
28088
|
access_grant_id: string;
|
|
28089
28089
|
event_type: 'access_grant.access_granted_to_door';
|
|
28090
28090
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -28098,7 +28098,7 @@ export interface Routes {
|
|
|
28098
28098
|
created_at: string;
|
|
28099
28099
|
/** Date and time at which the event occurred. */
|
|
28100
28100
|
occurred_at: string;
|
|
28101
|
-
/** ID of the affected
|
|
28101
|
+
/** ID of the affected Access Grant. */
|
|
28102
28102
|
access_grant_id: string;
|
|
28103
28103
|
event_type: 'access_grant.access_to_door_lost';
|
|
28104
28104
|
/** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
|
|
@@ -63457,41 +63457,41 @@ export interface Routes {
|
|
|
63457
63457
|
};
|
|
63458
63458
|
formData: {};
|
|
63459
63459
|
jsonResponse: {
|
|
63460
|
-
/** Represents an
|
|
63460
|
+
/** 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
63461
|
access_grant: {
|
|
63462
|
-
/** ID of the Seam workspace associated with the
|
|
63462
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
63463
63463
|
workspace_id: string;
|
|
63464
|
-
/** ID of the
|
|
63464
|
+
/** ID of the Access Grant. */
|
|
63465
63465
|
access_grant_id: string;
|
|
63466
|
-
/** ID of user identity to which the
|
|
63466
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
63467
63467
|
user_identity_id: string;
|
|
63468
63468
|
/**
|
|
63469
63469
|
* @deprecated Use `space_ids`. */
|
|
63470
63470
|
location_ids: string[];
|
|
63471
|
-
/** IDs of the spaces to which the
|
|
63471
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
63472
63472
|
space_ids: string[];
|
|
63473
|
-
/** Access methods that the user requested for the
|
|
63473
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
63474
63474
|
requested_access_methods: Array<{
|
|
63475
63475
|
/** Display name of the access method. */
|
|
63476
63476
|
display_name: string;
|
|
63477
63477
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
63478
63478
|
mode: 'code' | 'card' | 'mobile_key';
|
|
63479
|
-
/** Date and time at which the requested access method was added to the
|
|
63479
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
63480
63480
|
created_at: string;
|
|
63481
63481
|
/** IDs of the access methods created for the requested access method. */
|
|
63482
63482
|
created_access_method_ids: string[];
|
|
63483
63483
|
}>;
|
|
63484
|
-
/** IDs of the access methods created for the
|
|
63484
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
63485
63485
|
access_method_ids: string[];
|
|
63486
|
-
/** Display name of the
|
|
63486
|
+
/** Display name of the Access Grant. */
|
|
63487
63487
|
display_name: string;
|
|
63488
|
-
/** Instant Key URL. Only returned if the
|
|
63488
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
63489
63489
|
instant_key_url?: string | undefined;
|
|
63490
|
-
/** Date and time at which the
|
|
63490
|
+
/** Date and time at which the Access Grant was created. */
|
|
63491
63491
|
created_at: string;
|
|
63492
|
-
/** Date and time at which the
|
|
63492
|
+
/** Date and time at which the Access Grant starts. */
|
|
63493
63493
|
starts_at?: string | undefined;
|
|
63494
|
-
/** Date and time at which the
|
|
63494
|
+
/** Date and time at which the Access Grant ends. */
|
|
63495
63495
|
ends_at?: string | undefined;
|
|
63496
63496
|
};
|
|
63497
63497
|
};
|
|
@@ -63519,41 +63519,41 @@ export interface Routes {
|
|
|
63519
63519
|
};
|
|
63520
63520
|
formData: {};
|
|
63521
63521
|
jsonResponse: {
|
|
63522
|
-
/** Represents an
|
|
63522
|
+
/** 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
63523
|
access_grant: {
|
|
63524
|
-
/** ID of the Seam workspace associated with the
|
|
63524
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
63525
63525
|
workspace_id: string;
|
|
63526
|
-
/** ID of the
|
|
63526
|
+
/** ID of the Access Grant. */
|
|
63527
63527
|
access_grant_id: string;
|
|
63528
|
-
/** ID of user identity to which the
|
|
63528
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
63529
63529
|
user_identity_id: string;
|
|
63530
63530
|
/**
|
|
63531
63531
|
* @deprecated Use `space_ids`. */
|
|
63532
63532
|
location_ids: string[];
|
|
63533
|
-
/** IDs of the spaces to which the
|
|
63533
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
63534
63534
|
space_ids: string[];
|
|
63535
|
-
/** Access methods that the user requested for the
|
|
63535
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
63536
63536
|
requested_access_methods: Array<{
|
|
63537
63537
|
/** Display name of the access method. */
|
|
63538
63538
|
display_name: string;
|
|
63539
63539
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
63540
63540
|
mode: 'code' | 'card' | 'mobile_key';
|
|
63541
|
-
/** Date and time at which the requested access method was added to the
|
|
63541
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
63542
63542
|
created_at: string;
|
|
63543
63543
|
/** IDs of the access methods created for the requested access method. */
|
|
63544
63544
|
created_access_method_ids: string[];
|
|
63545
63545
|
}>;
|
|
63546
|
-
/** IDs of the access methods created for the
|
|
63546
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
63547
63547
|
access_method_ids: string[];
|
|
63548
|
-
/** Display name of the
|
|
63548
|
+
/** Display name of the Access Grant. */
|
|
63549
63549
|
display_name: string;
|
|
63550
|
-
/** Instant Key URL. Only returned if the
|
|
63550
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
63551
63551
|
instant_key_url?: string | undefined;
|
|
63552
|
-
/** Date and time at which the
|
|
63552
|
+
/** Date and time at which the Access Grant was created. */
|
|
63553
63553
|
created_at: string;
|
|
63554
|
-
/** Date and time at which the
|
|
63554
|
+
/** Date and time at which the Access Grant starts. */
|
|
63555
63555
|
starts_at?: string | undefined;
|
|
63556
|
-
/** Date and time at which the
|
|
63556
|
+
/** Date and time at which the Access Grant ends. */
|
|
63557
63557
|
ends_at?: string | undefined;
|
|
63558
63558
|
};
|
|
63559
63559
|
};
|
|
@@ -63579,39 +63579,39 @@ export interface Routes {
|
|
|
63579
63579
|
formData: {};
|
|
63580
63580
|
jsonResponse: {
|
|
63581
63581
|
access_grants: Array<{
|
|
63582
|
-
/** ID of the Seam workspace associated with the
|
|
63582
|
+
/** ID of the Seam workspace associated with the Access Grant. */
|
|
63583
63583
|
workspace_id: string;
|
|
63584
|
-
/** ID of the
|
|
63584
|
+
/** ID of the Access Grant. */
|
|
63585
63585
|
access_grant_id: string;
|
|
63586
|
-
/** ID of user identity to which the
|
|
63586
|
+
/** ID of user identity to which the Access Grant gives access. */
|
|
63587
63587
|
user_identity_id: string;
|
|
63588
63588
|
/**
|
|
63589
63589
|
* @deprecated Use `space_ids`. */
|
|
63590
63590
|
location_ids: string[];
|
|
63591
|
-
/** IDs of the spaces to which the
|
|
63591
|
+
/** IDs of the spaces to which the Access Grant gives access. */
|
|
63592
63592
|
space_ids: string[];
|
|
63593
|
-
/** Access methods that the user requested for the
|
|
63593
|
+
/** Access methods that the user requested for the Access Grant. */
|
|
63594
63594
|
requested_access_methods: Array<{
|
|
63595
63595
|
/** Display name of the access method. */
|
|
63596
63596
|
display_name: string;
|
|
63597
63597
|
/** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
|
|
63598
63598
|
mode: 'code' | 'card' | 'mobile_key';
|
|
63599
|
-
/** Date and time at which the requested access method was added to the
|
|
63599
|
+
/** Date and time at which the requested access method was added to the Access Grant. */
|
|
63600
63600
|
created_at: string;
|
|
63601
63601
|
/** IDs of the access methods created for the requested access method. */
|
|
63602
63602
|
created_access_method_ids: string[];
|
|
63603
63603
|
}>;
|
|
63604
|
-
/** IDs of the access methods created for the
|
|
63604
|
+
/** IDs of the access methods created for the Access Grant. */
|
|
63605
63605
|
access_method_ids: string[];
|
|
63606
|
-
/** Display name of the
|
|
63606
|
+
/** Display name of the Access Grant. */
|
|
63607
63607
|
display_name: string;
|
|
63608
|
-
/** Instant Key URL. Only returned if the
|
|
63608
|
+
/** Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. */
|
|
63609
63609
|
instant_key_url?: string | undefined;
|
|
63610
|
-
/** Date and time at which the
|
|
63610
|
+
/** Date and time at which the Access Grant was created. */
|
|
63611
63611
|
created_at: string;
|
|
63612
|
-
/** Date and time at which the
|
|
63612
|
+
/** Date and time at which the Access Grant starts. */
|
|
63613
63613
|
starts_at?: string | undefined;
|
|
63614
|
-
/** Date and time at which the
|
|
63614
|
+
/** Date and time at which the Access Grant ends. */
|
|
63615
63615
|
ends_at?: string | undefined;
|
|
63616
63616
|
}>;
|
|
63617
63617
|
};
|
|
@@ -63639,7 +63639,7 @@ export interface Routes {
|
|
|
63639
63639
|
};
|
|
63640
63640
|
formData: {};
|
|
63641
63641
|
jsonResponse: {
|
|
63642
|
-
/** Represents an access method for an
|
|
63642
|
+
/** 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
63643
|
access_method: {
|
|
63644
63644
|
/** ID of the Seam workspace associated with the access method. */
|
|
63645
63645
|
workspace_id: string;
|
package/package.json
CHANGED
|
@@ -6,12 +6,12 @@ export const access_grant = z.object({
|
|
|
6
6
|
workspace_id: z
|
|
7
7
|
.string()
|
|
8
8
|
.uuid()
|
|
9
|
-
.describe('ID of the Seam workspace associated with the
|
|
10
|
-
access_grant_id: z.string().uuid().describe('ID of the
|
|
9
|
+
.describe('ID of the Seam workspace associated with the Access Grant.'),
|
|
10
|
+
access_grant_id: z.string().uuid().describe('ID of the Access Grant.'),
|
|
11
11
|
user_identity_id: z
|
|
12
12
|
.string()
|
|
13
13
|
.uuid()
|
|
14
|
-
.describe('ID of user identity to which the
|
|
14
|
+
.describe('ID of user identity to which the Access Grant gives access.'),
|
|
15
15
|
location_ids: z.array(z.string().uuid()).describe(`
|
|
16
16
|
---
|
|
17
17
|
deprecated: Use \`space_ids\`.
|
|
@@ -19,41 +19,41 @@ export const access_grant = z.object({
|
|
|
19
19
|
`),
|
|
20
20
|
space_ids: z
|
|
21
21
|
.array(z.string().uuid())
|
|
22
|
-
.describe('IDs of the spaces to which the
|
|
22
|
+
.describe('IDs of the spaces to which the Access Grant gives access.'),
|
|
23
23
|
requested_access_methods: z
|
|
24
24
|
.array(requested_access_method)
|
|
25
|
-
.describe('Access methods that the user requested for the
|
|
25
|
+
.describe('Access methods that the user requested for the Access Grant.'),
|
|
26
26
|
access_method_ids: z
|
|
27
27
|
.array(z.string().uuid())
|
|
28
|
-
.describe('IDs of the access methods created for the
|
|
29
|
-
display_name: z.string().describe('Display name of the
|
|
28
|
+
.describe('IDs of the access methods created for the Access Grant.'),
|
|
29
|
+
display_name: z.string().describe('Display name of the Access Grant.'),
|
|
30
30
|
instant_key_url: z
|
|
31
31
|
.string()
|
|
32
32
|
.url()
|
|
33
33
|
.optional()
|
|
34
34
|
.describe(
|
|
35
|
-
'Instant Key URL. Only returned if the
|
|
35
|
+
'Instant Key URL. Only returned if the Access Grant has a single mobile_key access_method. ',
|
|
36
36
|
),
|
|
37
37
|
created_at: z
|
|
38
38
|
.string()
|
|
39
39
|
.datetime()
|
|
40
|
-
.describe('Date and time at which the
|
|
40
|
+
.describe('Date and time at which the Access Grant was created.'),
|
|
41
41
|
starts_at: z
|
|
42
42
|
.string()
|
|
43
43
|
.datetime()
|
|
44
44
|
.optional()
|
|
45
|
-
.describe('Date and time at which the
|
|
45
|
+
.describe('Date and time at which the Access Grant starts.'),
|
|
46
46
|
ends_at: z
|
|
47
47
|
.string()
|
|
48
48
|
.datetime()
|
|
49
49
|
.optional()
|
|
50
|
-
.describe('Date and time at which the
|
|
50
|
+
.describe('Date and time at which the Access Grant ends.'),
|
|
51
51
|
}).describe(`
|
|
52
52
|
---
|
|
53
53
|
draft: Early access.
|
|
54
54
|
route_path: /access_grants
|
|
55
55
|
---
|
|
56
|
-
Represents an
|
|
56
|
+
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.
|
|
57
57
|
`)
|
|
58
58
|
|
|
59
59
|
export type AccessGrant = z.infer<typeof access_grant>
|
|
@@ -41,7 +41,7 @@ export const access_method = z.object({
|
|
|
41
41
|
draft: Early access.
|
|
42
42
|
route_path: /access_methods
|
|
43
43
|
---
|
|
44
|
-
Represents an access method for an
|
|
44
|
+
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.
|
|
45
45
|
`)
|
|
46
46
|
|
|
47
47
|
export type AccessMethod = z.infer<typeof access_method>
|
|
@@ -11,7 +11,7 @@ export const requested_access_method = z.object({
|
|
|
11
11
|
.string()
|
|
12
12
|
.datetime()
|
|
13
13
|
.describe(
|
|
14
|
-
'Date and time at which the requested access method was added to the
|
|
14
|
+
'Date and time at which the requested access method was added to the Access Grant.',
|
|
15
15
|
),
|
|
16
16
|
created_access_method_ids: z
|
|
17
17
|
.array(z.string().uuid())
|