@seamapi/types 1.301.0 → 1.302.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 +87 -8
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +232 -29
- package/lib/seam/connect/models/devices/device-metadata.d.ts +5 -5
- package/lib/seam/connect/models/devices/device-metadata.js +1 -1
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +1 -1
- package/lib/seam/connect/models/devices/device-provider.js +0 -1
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +7 -7
- package/lib/seam/connect/models/devices/phone.d.ts +5 -5
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +5 -5
- package/lib/seam/connect/openapi.d.ts +96 -2
- package/lib/seam/connect/openapi.js +84 -4
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +124 -15
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device-metadata.ts +1 -1
- package/src/lib/seam/connect/models/devices/device-provider.ts +0 -1
- package/src/lib/seam/connect/openapi.ts +92 -4
- package/src/lib/seam/connect/route-types.ts +139 -15
|
@@ -4498,12 +4498,13 @@ export interface Routes {
|
|
|
4498
4498
|
allowed_acs_entrance_ids?: string[];
|
|
4499
4499
|
/** Visionline-specific metadata for the new credential. */
|
|
4500
4500
|
visionline_metadata?: {
|
|
4501
|
-
/**
|
|
4501
|
+
/**
|
|
4502
|
+
* @deprecated Read-only endpoint references moved to `endpoint`. */
|
|
4502
4503
|
assa_abloy_credential_service_mobile_endpoint_id?: string | undefined;
|
|
4503
4504
|
card_format?: ('TLCode' | 'rfid48') | undefined;
|
|
4504
4505
|
card_function_type?: 'guest' | 'staff';
|
|
4505
4506
|
/**
|
|
4506
|
-
* @deprecated
|
|
4507
|
+
* @deprecated Use `override` instead. */
|
|
4507
4508
|
is_override_key?: boolean | undefined;
|
|
4508
4509
|
override?: boolean | undefined;
|
|
4509
4510
|
auto_join?: boolean | undefined;
|
|
@@ -4611,6 +4612,114 @@ export interface Routes {
|
|
|
4611
4612
|
};
|
|
4612
4613
|
};
|
|
4613
4614
|
};
|
|
4615
|
+
'/acs/credentials/create_offline_code': {
|
|
4616
|
+
route: '/acs/credentials/create_offline_code';
|
|
4617
|
+
method: 'POST';
|
|
4618
|
+
queryParams: {};
|
|
4619
|
+
jsonBody: {};
|
|
4620
|
+
commonParams: {
|
|
4621
|
+
/** ID of the ACS user to whom the new credential belongs. */
|
|
4622
|
+
acs_user_id: string;
|
|
4623
|
+
/** IDs of the [`acs_entrance`s](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access. */
|
|
4624
|
+
allowed_acs_entrance_id?: string | undefined;
|
|
4625
|
+
/** Indicates whether the code is one-time-use or reusable. */
|
|
4626
|
+
is_one_time_use?: boolean;
|
|
4627
|
+
/** Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
4628
|
+
starts_at?: string | undefined;
|
|
4629
|
+
/** Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
4630
|
+
ends_at?: string | undefined;
|
|
4631
|
+
};
|
|
4632
|
+
formData: {};
|
|
4633
|
+
jsonResponse: {
|
|
4634
|
+
/** Means by which a user gains access at an entrance.
|
|
4635
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
4636
|
+
acs_credential: {
|
|
4637
|
+
/** ID of the credential. */
|
|
4638
|
+
acs_credential_id: string;
|
|
4639
|
+
/** ID of the ACS user to whom the credential belongs. */
|
|
4640
|
+
acs_user_id?: string | undefined;
|
|
4641
|
+
acs_credential_pool_id?: string | undefined;
|
|
4642
|
+
/** ID of the access control system that contains the credential. */
|
|
4643
|
+
acs_system_id: string;
|
|
4644
|
+
/** ID of the parent credential. */
|
|
4645
|
+
parent_acs_credential_id?: string | undefined;
|
|
4646
|
+
/** Display name that corresponds to the credential type. */
|
|
4647
|
+
display_name: string;
|
|
4648
|
+
/** Access (PIN) code for the credential. */
|
|
4649
|
+
code?: (string | undefined) | null;
|
|
4650
|
+
card_number?: (string | undefined) | null;
|
|
4651
|
+
is_issued?: boolean | undefined;
|
|
4652
|
+
issued_at?: (string | undefined) | null;
|
|
4653
|
+
/** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
|
|
4654
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
4655
|
+
/** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
4656
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential') | undefined;
|
|
4657
|
+
/** Display name that corresponds to the brand-specific terminology for the credential type. */
|
|
4658
|
+
external_type_display_name?: string | undefined;
|
|
4659
|
+
/** Date and time at which the credential was created. */
|
|
4660
|
+
created_at: string;
|
|
4661
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
|
|
4662
|
+
workspace_id: string;
|
|
4663
|
+
/** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
4664
|
+
starts_at?: string | undefined;
|
|
4665
|
+
/** Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
4666
|
+
ends_at?: string | undefined;
|
|
4667
|
+
/** Errors associated with the `acs_credential`. */
|
|
4668
|
+
errors: Array<{
|
|
4669
|
+
error_code: string;
|
|
4670
|
+
message: string;
|
|
4671
|
+
}>;
|
|
4672
|
+
/** Warnings associated with the `acs_credential`. */
|
|
4673
|
+
warnings: Array<{
|
|
4674
|
+
/** Date and time at which Seam created the warning. */
|
|
4675
|
+
created_at: string;
|
|
4676
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
4677
|
+
message: string;
|
|
4678
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
4679
|
+
warning_code: 'waiting_to_be_issued';
|
|
4680
|
+
} | {
|
|
4681
|
+
/** Date and time at which Seam created the warning. */
|
|
4682
|
+
created_at: string;
|
|
4683
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
4684
|
+
message: string;
|
|
4685
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
4686
|
+
warning_code: 'schedule_externally_modified';
|
|
4687
|
+
} | {
|
|
4688
|
+
/** Date and time at which Seam created the warning. */
|
|
4689
|
+
created_at: string;
|
|
4690
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
4691
|
+
message: string;
|
|
4692
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
4693
|
+
warning_code: 'schedule_modified';
|
|
4694
|
+
} | {
|
|
4695
|
+
/** Date and time at which Seam created the warning. */
|
|
4696
|
+
created_at: string;
|
|
4697
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
4698
|
+
message: string;
|
|
4699
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
4700
|
+
warning_code: 'being_deleted';
|
|
4701
|
+
}>;
|
|
4702
|
+
/** Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
4703
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
4704
|
+
/** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
|
|
4705
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined;
|
|
4706
|
+
/** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
|
|
4707
|
+
latest_desired_state_synced_with_provider_at?: string | undefined;
|
|
4708
|
+
/** Visionline-specific metadata for the credential. */
|
|
4709
|
+
visionline_metadata?: {
|
|
4710
|
+
card_function_type: 'guest' | 'staff';
|
|
4711
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
4712
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
4713
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
4714
|
+
is_valid?: boolean | undefined;
|
|
4715
|
+
auto_join?: boolean | undefined;
|
|
4716
|
+
card_id?: string | undefined;
|
|
4717
|
+
credential_id?: string | undefined;
|
|
4718
|
+
} | undefined;
|
|
4719
|
+
is_managed: true;
|
|
4720
|
+
};
|
|
4721
|
+
};
|
|
4722
|
+
};
|
|
4614
4723
|
'/acs/credentials/delete': {
|
|
4615
4724
|
route: '/acs/credentials/delete';
|
|
4616
4725
|
method: 'DELETE' | 'POST';
|
|
@@ -10693,7 +10802,7 @@ export interface Routes {
|
|
|
10693
10802
|
nest_metadata?: {
|
|
10694
10803
|
nest_device_id: string;
|
|
10695
10804
|
device_name: string;
|
|
10696
|
-
|
|
10805
|
+
device_custom_name: string;
|
|
10697
10806
|
display_name?: string | undefined;
|
|
10698
10807
|
} | undefined;
|
|
10699
10808
|
ecobee_metadata?: {
|
|
@@ -11243,7 +11352,7 @@ export interface Routes {
|
|
|
11243
11352
|
nest_metadata?: {
|
|
11244
11353
|
nest_device_id: string;
|
|
11245
11354
|
device_name: string;
|
|
11246
|
-
|
|
11355
|
+
device_custom_name: string;
|
|
11247
11356
|
display_name?: string | undefined;
|
|
11248
11357
|
} | undefined;
|
|
11249
11358
|
ecobee_metadata?: {
|
|
@@ -12196,7 +12305,7 @@ export interface Routes {
|
|
|
12196
12305
|
nest_metadata?: {
|
|
12197
12306
|
nest_device_id: string;
|
|
12198
12307
|
device_name: string;
|
|
12199
|
-
|
|
12308
|
+
device_custom_name: string;
|
|
12200
12309
|
display_name?: string | undefined;
|
|
12201
12310
|
} | undefined;
|
|
12202
12311
|
ecobee_metadata?: {
|
|
@@ -12709,7 +12818,7 @@ export interface Routes {
|
|
|
12709
12818
|
nest_metadata?: {
|
|
12710
12819
|
nest_device_id: string;
|
|
12711
12820
|
device_name: string;
|
|
12712
|
-
|
|
12821
|
+
device_custom_name: string;
|
|
12713
12822
|
display_name?: string | undefined;
|
|
12714
12823
|
} | undefined;
|
|
12715
12824
|
ecobee_metadata?: {
|
|
@@ -13259,7 +13368,7 @@ export interface Routes {
|
|
|
13259
13368
|
nest_metadata?: {
|
|
13260
13369
|
nest_device_id: string;
|
|
13261
13370
|
device_name: string;
|
|
13262
|
-
|
|
13371
|
+
device_custom_name: string;
|
|
13263
13372
|
display_name?: string | undefined;
|
|
13264
13373
|
} | undefined;
|
|
13265
13374
|
ecobee_metadata?: {
|
|
@@ -13772,7 +13881,7 @@ export interface Routes {
|
|
|
13772
13881
|
nest_metadata?: {
|
|
13773
13882
|
nest_device_id: string;
|
|
13774
13883
|
device_name: string;
|
|
13775
|
-
|
|
13884
|
+
device_custom_name: string;
|
|
13776
13885
|
display_name?: string | undefined;
|
|
13777
13886
|
} | undefined;
|
|
13778
13887
|
ecobee_metadata?: {
|
|
@@ -16038,7 +16147,7 @@ export interface Routes {
|
|
|
16038
16147
|
nest_metadata?: {
|
|
16039
16148
|
nest_device_id: string;
|
|
16040
16149
|
device_name: string;
|
|
16041
|
-
|
|
16150
|
+
device_custom_name: string;
|
|
16042
16151
|
display_name?: string | undefined;
|
|
16043
16152
|
} | undefined;
|
|
16044
16153
|
ecobee_metadata?: {
|
|
@@ -16551,7 +16660,7 @@ export interface Routes {
|
|
|
16551
16660
|
nest_metadata?: {
|
|
16552
16661
|
nest_device_id: string;
|
|
16553
16662
|
device_name: string;
|
|
16554
|
-
|
|
16663
|
+
device_custom_name: string;
|
|
16555
16664
|
display_name?: string | undefined;
|
|
16556
16665
|
} | undefined;
|
|
16557
16666
|
ecobee_metadata?: {
|
|
@@ -21581,7 +21690,7 @@ export interface Routes {
|
|
|
21581
21690
|
nest_metadata?: {
|
|
21582
21691
|
nest_device_id: string;
|
|
21583
21692
|
device_name: string;
|
|
21584
|
-
|
|
21693
|
+
device_custom_name: string;
|
|
21585
21694
|
display_name?: string | undefined;
|
|
21586
21695
|
} | undefined;
|
|
21587
21696
|
ecobee_metadata?: {
|
|
@@ -23829,7 +23938,7 @@ export interface Routes {
|
|
|
23829
23938
|
nest_metadata?: {
|
|
23830
23939
|
nest_device_id: string;
|
|
23831
23940
|
device_name: string;
|
|
23832
|
-
|
|
23941
|
+
device_custom_name: string;
|
|
23833
23942
|
display_name?: string | undefined;
|
|
23834
23943
|
} | undefined;
|
|
23835
23944
|
ecobee_metadata?: {
|
|
@@ -24342,7 +24451,7 @@ export interface Routes {
|
|
|
24342
24451
|
nest_metadata?: {
|
|
24343
24452
|
nest_device_id: string;
|
|
24344
24453
|
device_name: string;
|
|
24345
|
-
|
|
24454
|
+
device_custom_name: string;
|
|
24346
24455
|
display_name?: string | undefined;
|
|
24347
24456
|
} | undefined;
|
|
24348
24457
|
ecobee_metadata?: {
|
|
@@ -27876,7 +27985,7 @@ export interface Routes {
|
|
|
27876
27985
|
nest_metadata?: {
|
|
27877
27986
|
nest_device_id: string;
|
|
27878
27987
|
device_name: string;
|
|
27879
|
-
|
|
27988
|
+
device_custom_name: string;
|
|
27880
27989
|
display_name?: string | undefined;
|
|
27881
27990
|
} | undefined;
|
|
27882
27991
|
ecobee_metadata?: {
|
|
@@ -28391,7 +28500,7 @@ export interface Routes {
|
|
|
28391
28500
|
nest_metadata?: {
|
|
28392
28501
|
nest_device_id: string;
|
|
28393
28502
|
device_name: string;
|
|
28394
|
-
|
|
28503
|
+
device_custom_name: string;
|
|
28395
28504
|
display_name?: string | undefined;
|
|
28396
28505
|
} | undefined;
|
|
28397
28506
|
ecobee_metadata?: {
|
package/package.json
CHANGED
|
@@ -197,7 +197,7 @@ export const device_metadata = z
|
|
|
197
197
|
nest_metadata: z.object({
|
|
198
198
|
nest_device_id: z.string(),
|
|
199
199
|
device_name: z.string(), // set by Google
|
|
200
|
-
|
|
200
|
+
device_custom_name: z.string(), // set by device owner
|
|
201
201
|
display_name: z.string().optional(),
|
|
202
202
|
}),
|
|
203
203
|
|
|
@@ -4898,7 +4898,7 @@ export default {
|
|
|
4898
4898
|
},
|
|
4899
4899
|
nest_metadata: {
|
|
4900
4900
|
properties: {
|
|
4901
|
-
|
|
4901
|
+
device_custom_name: { type: 'string' },
|
|
4902
4902
|
device_name: { type: 'string' },
|
|
4903
4903
|
display_name: { type: 'string' },
|
|
4904
4904
|
nest_device_id: { type: 'string' },
|
|
@@ -4906,7 +4906,7 @@ export default {
|
|
|
4906
4906
|
required: [
|
|
4907
4907
|
'nest_device_id',
|
|
4908
4908
|
'device_name',
|
|
4909
|
-
'
|
|
4909
|
+
'device_custom_name',
|
|
4910
4910
|
],
|
|
4911
4911
|
type: 'object',
|
|
4912
4912
|
},
|
|
@@ -8934,9 +8934,13 @@ export default {
|
|
|
8934
8934
|
'Visionline-specific metadata for the new credential.',
|
|
8935
8935
|
properties: {
|
|
8936
8936
|
assa_abloy_credential_service_mobile_endpoint_id: {
|
|
8937
|
-
|
|
8937
|
+
deprecated: true,
|
|
8938
8938
|
format: 'uuid',
|
|
8939
8939
|
type: 'string',
|
|
8940
|
+
'x-deprecated':
|
|
8941
|
+
'Read-only endpoint references moved to `endpoint`.',
|
|
8942
|
+
'x-undocumented':
|
|
8943
|
+
'Deprecated. Read-only endpoint references moved to `endpoint`.',
|
|
8940
8944
|
},
|
|
8941
8945
|
auto_join: { type: 'boolean' },
|
|
8942
8946
|
card_format: {
|
|
@@ -8951,7 +8955,8 @@ export default {
|
|
|
8951
8955
|
is_override_key: {
|
|
8952
8956
|
deprecated: true,
|
|
8953
8957
|
type: 'boolean',
|
|
8954
|
-
'x-deprecated': '
|
|
8958
|
+
'x-deprecated': 'Use `override` instead.',
|
|
8959
|
+
'x-undocumented': 'Use `override` instead.',
|
|
8955
8960
|
},
|
|
8956
8961
|
joiner_acs_credential_ids: {
|
|
8957
8962
|
items: { format: 'uuid', type: 'string' },
|
|
@@ -9003,6 +9008,89 @@ export default {
|
|
|
9003
9008
|
'x-title': 'Create a Credential for an ACS User',
|
|
9004
9009
|
},
|
|
9005
9010
|
},
|
|
9011
|
+
'/acs/credentials/create_offline_code': {
|
|
9012
|
+
post: {
|
|
9013
|
+
description:
|
|
9014
|
+
'Creates a new offline [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) for a specified [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management).',
|
|
9015
|
+
operationId: 'acsCredentialsCreateOfflineCodePost',
|
|
9016
|
+
requestBody: {
|
|
9017
|
+
content: {
|
|
9018
|
+
'application/json': {
|
|
9019
|
+
schema: {
|
|
9020
|
+
properties: {
|
|
9021
|
+
acs_user_id: {
|
|
9022
|
+
description:
|
|
9023
|
+
'ID of the ACS user to whom the new credential belongs.',
|
|
9024
|
+
format: 'uuid',
|
|
9025
|
+
type: 'string',
|
|
9026
|
+
},
|
|
9027
|
+
allowed_acs_entrance_id: {
|
|
9028
|
+
description:
|
|
9029
|
+
'IDs of the [`acs_entrance`s](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access.',
|
|
9030
|
+
format: 'uuid',
|
|
9031
|
+
type: 'string',
|
|
9032
|
+
},
|
|
9033
|
+
ends_at: {
|
|
9034
|
+
description:
|
|
9035
|
+
'Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.',
|
|
9036
|
+
format: 'date-time',
|
|
9037
|
+
type: 'string',
|
|
9038
|
+
},
|
|
9039
|
+
is_one_time_use: {
|
|
9040
|
+
default: false,
|
|
9041
|
+
description:
|
|
9042
|
+
'Indicates whether the code is one-time-use or reusable.',
|
|
9043
|
+
type: 'boolean',
|
|
9044
|
+
},
|
|
9045
|
+
starts_at: {
|
|
9046
|
+
description:
|
|
9047
|
+
'Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
9048
|
+
format: 'date-time',
|
|
9049
|
+
type: 'string',
|
|
9050
|
+
},
|
|
9051
|
+
},
|
|
9052
|
+
required: ['acs_user_id'],
|
|
9053
|
+
type: 'object',
|
|
9054
|
+
},
|
|
9055
|
+
},
|
|
9056
|
+
},
|
|
9057
|
+
},
|
|
9058
|
+
responses: {
|
|
9059
|
+
200: {
|
|
9060
|
+
content: {
|
|
9061
|
+
'application/json': {
|
|
9062
|
+
schema: {
|
|
9063
|
+
properties: {
|
|
9064
|
+
acs_credential: {
|
|
9065
|
+
$ref: '#/components/schemas/acs_credential',
|
|
9066
|
+
},
|
|
9067
|
+
ok: { type: 'boolean' },
|
|
9068
|
+
},
|
|
9069
|
+
required: ['acs_credential', 'ok'],
|
|
9070
|
+
type: 'object',
|
|
9071
|
+
},
|
|
9072
|
+
},
|
|
9073
|
+
},
|
|
9074
|
+
description: 'OK',
|
|
9075
|
+
},
|
|
9076
|
+
400: { description: 'Bad Request' },
|
|
9077
|
+
401: { description: 'Unauthorized' },
|
|
9078
|
+
},
|
|
9079
|
+
security: [
|
|
9080
|
+
{ pat_with_workspace: [] },
|
|
9081
|
+
{ console_session: [] },
|
|
9082
|
+
{ api_key: [] },
|
|
9083
|
+
],
|
|
9084
|
+
summary: '/acs/credentials/create_offline_code',
|
|
9085
|
+
tags: ['/acs'],
|
|
9086
|
+
'x-fern-sdk-group-name': ['acs', 'credentials'],
|
|
9087
|
+
'x-fern-sdk-method-name': 'create_offline_code',
|
|
9088
|
+
'x-fern-sdk-return-value': 'acs_credential',
|
|
9089
|
+
'x-response-key': 'acs_credential',
|
|
9090
|
+
'x-title': 'Create an Offline Credential for an ACS User',
|
|
9091
|
+
'x-undocumented': 'Unreleased.',
|
|
9092
|
+
},
|
|
9093
|
+
},
|
|
9006
9094
|
'/acs/credentials/delete': {
|
|
9007
9095
|
post: {
|
|
9008
9096
|
description:
|
|
@@ -5203,14 +5203,15 @@ export interface Routes {
|
|
|
5203
5203
|
/** Visionline-specific metadata for the new credential. */
|
|
5204
5204
|
visionline_metadata?:
|
|
5205
5205
|
| {
|
|
5206
|
-
/**
|
|
5206
|
+
/**
|
|
5207
|
+
* @deprecated Read-only endpoint references moved to `endpoint`. */
|
|
5207
5208
|
assa_abloy_credential_service_mobile_endpoint_id?:
|
|
5208
5209
|
| string
|
|
5209
5210
|
| undefined
|
|
5210
5211
|
card_format?: ('TLCode' | 'rfid48') | undefined
|
|
5211
5212
|
card_function_type?: 'guest' | 'staff'
|
|
5212
5213
|
/**
|
|
5213
|
-
* @deprecated
|
|
5214
|
+
* @deprecated Use `override` instead. */
|
|
5214
5215
|
is_override_key?: boolean | undefined
|
|
5215
5216
|
override?: boolean | undefined
|
|
5216
5217
|
auto_join?: boolean | undefined
|
|
@@ -5336,6 +5337,129 @@ export interface Routes {
|
|
|
5336
5337
|
}
|
|
5337
5338
|
}
|
|
5338
5339
|
}
|
|
5340
|
+
'/acs/credentials/create_offline_code': {
|
|
5341
|
+
route: '/acs/credentials/create_offline_code'
|
|
5342
|
+
method: 'POST'
|
|
5343
|
+
queryParams: {}
|
|
5344
|
+
jsonBody: {}
|
|
5345
|
+
commonParams: {
|
|
5346
|
+
/** ID of the ACS user to whom the new credential belongs. */
|
|
5347
|
+
acs_user_id: string
|
|
5348
|
+
/** IDs of the [`acs_entrance`s](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for which the new credential grants access. */
|
|
5349
|
+
allowed_acs_entrance_id?: string | undefined
|
|
5350
|
+
/** Indicates whether the code is one-time-use or reusable. */
|
|
5351
|
+
is_one_time_use?: boolean
|
|
5352
|
+
/** Date and time at which the validity of the new credential starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
5353
|
+
starts_at?: string | undefined
|
|
5354
|
+
/** Date and time at which the validity of the new credential ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
5355
|
+
ends_at?: string | undefined
|
|
5356
|
+
}
|
|
5357
|
+
formData: {}
|
|
5358
|
+
jsonResponse: {
|
|
5359
|
+
/** Means by which a user gains access at an entrance.
|
|
5360
|
+
The `acs_credential` object represents a credential that provides an ACS user access within an access control system. For each acs_credential object, you define the access method. You can also specify additional properties, such as a code. */
|
|
5361
|
+
acs_credential: {
|
|
5362
|
+
/** ID of the credential. */
|
|
5363
|
+
acs_credential_id: string
|
|
5364
|
+
/** ID of the ACS user to whom the credential belongs. */
|
|
5365
|
+
acs_user_id?: string | undefined
|
|
5366
|
+
acs_credential_pool_id?: string | undefined
|
|
5367
|
+
/** ID of the access control system that contains the credential. */
|
|
5368
|
+
acs_system_id: string
|
|
5369
|
+
/** ID of the parent credential. */
|
|
5370
|
+
parent_acs_credential_id?: string | undefined
|
|
5371
|
+
/** Display name that corresponds to the credential type. */
|
|
5372
|
+
display_name: string
|
|
5373
|
+
/** Access (PIN) code for the credential. */
|
|
5374
|
+
code?: (string | undefined) | null
|
|
5375
|
+
card_number?: (string | undefined) | null
|
|
5376
|
+
is_issued?: boolean | undefined
|
|
5377
|
+
issued_at?: (string | undefined) | null
|
|
5378
|
+
/** Access method for the credential. Supported values: `code`, `card`, `mobile_key`. */
|
|
5379
|
+
access_method: 'code' | 'card' | 'mobile_key'
|
|
5380
|
+
/** Brand-specific terminology for the credential type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
5381
|
+
external_type?:
|
|
5382
|
+
| (
|
|
5383
|
+
| 'pti_card'
|
|
5384
|
+
| 'brivo_credential'
|
|
5385
|
+
| 'hid_credential'
|
|
5386
|
+
| 'visionline_card'
|
|
5387
|
+
| 'salto_ks_credential'
|
|
5388
|
+
)
|
|
5389
|
+
| undefined
|
|
5390
|
+
/** Display name that corresponds to the brand-specific terminology for the credential type. */
|
|
5391
|
+
external_type_display_name?: string | undefined
|
|
5392
|
+
/** Date and time at which the credential was created. */
|
|
5393
|
+
created_at: string
|
|
5394
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the credential. */
|
|
5395
|
+
workspace_id: string
|
|
5396
|
+
/** Date and time at which the credential validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
5397
|
+
starts_at?: string | undefined
|
|
5398
|
+
/** Date and time at which the credential validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
5399
|
+
ends_at?: string | undefined
|
|
5400
|
+
/** Errors associated with the `acs_credential`. */
|
|
5401
|
+
errors: Array<{
|
|
5402
|
+
error_code: string
|
|
5403
|
+
message: string
|
|
5404
|
+
}>
|
|
5405
|
+
/** Warnings associated with the `acs_credential`. */
|
|
5406
|
+
warnings: Array<
|
|
5407
|
+
| {
|
|
5408
|
+
/** Date and time at which Seam created the warning. */
|
|
5409
|
+
created_at: string
|
|
5410
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
5411
|
+
message: string
|
|
5412
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
5413
|
+
warning_code: 'waiting_to_be_issued'
|
|
5414
|
+
}
|
|
5415
|
+
| {
|
|
5416
|
+
/** Date and time at which Seam created the warning. */
|
|
5417
|
+
created_at: string
|
|
5418
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
5419
|
+
message: string
|
|
5420
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
5421
|
+
warning_code: 'schedule_externally_modified'
|
|
5422
|
+
}
|
|
5423
|
+
| {
|
|
5424
|
+
/** Date and time at which Seam created the warning. */
|
|
5425
|
+
created_at: string
|
|
5426
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
5427
|
+
message: string
|
|
5428
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
5429
|
+
warning_code: 'schedule_modified'
|
|
5430
|
+
}
|
|
5431
|
+
| {
|
|
5432
|
+
/** Date and time at which Seam created the warning. */
|
|
5433
|
+
created_at: string
|
|
5434
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
5435
|
+
message: string
|
|
5436
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
5437
|
+
warning_code: 'being_deleted'
|
|
5438
|
+
}
|
|
5439
|
+
>
|
|
5440
|
+
/** Indicates whether the credential is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access-in-development/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
5441
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
5442
|
+
/** Indicates whether the latest state of the credential has been synced from Seam to the provider. */
|
|
5443
|
+
is_latest_desired_state_synced_with_provider?: boolean | undefined
|
|
5444
|
+
/** Date and time at which the state of the credential was most recently synced from Seam to the provider. */
|
|
5445
|
+
latest_desired_state_synced_with_provider_at?: string | undefined
|
|
5446
|
+
/** Visionline-specific metadata for the credential. */
|
|
5447
|
+
visionline_metadata?:
|
|
5448
|
+
| {
|
|
5449
|
+
card_function_type: 'guest' | 'staff'
|
|
5450
|
+
joiner_acs_credential_ids?: string[] | undefined
|
|
5451
|
+
guest_acs_entrance_ids?: string[] | undefined
|
|
5452
|
+
common_acs_entrance_ids?: string[] | undefined
|
|
5453
|
+
is_valid?: boolean | undefined
|
|
5454
|
+
auto_join?: boolean | undefined
|
|
5455
|
+
card_id?: string | undefined
|
|
5456
|
+
credential_id?: string | undefined
|
|
5457
|
+
}
|
|
5458
|
+
| undefined
|
|
5459
|
+
is_managed: true
|
|
5460
|
+
}
|
|
5461
|
+
}
|
|
5462
|
+
}
|
|
5339
5463
|
'/acs/credentials/delete': {
|
|
5340
5464
|
route: '/acs/credentials/delete'
|
|
5341
5465
|
method: 'DELETE' | 'POST'
|
|
@@ -12588,7 +12712,7 @@ export interface Routes {
|
|
|
12588
12712
|
| {
|
|
12589
12713
|
nest_device_id: string
|
|
12590
12714
|
device_name: string
|
|
12591
|
-
|
|
12715
|
+
device_custom_name: string
|
|
12592
12716
|
display_name?: string | undefined
|
|
12593
12717
|
}
|
|
12594
12718
|
| undefined
|
|
@@ -13464,7 +13588,7 @@ export interface Routes {
|
|
|
13464
13588
|
| {
|
|
13465
13589
|
nest_device_id: string
|
|
13466
13590
|
device_name: string
|
|
13467
|
-
|
|
13591
|
+
device_custom_name: string
|
|
13468
13592
|
display_name?: string | undefined
|
|
13469
13593
|
}
|
|
13470
13594
|
| undefined
|
|
@@ -15054,7 +15178,7 @@ export interface Routes {
|
|
|
15054
15178
|
| {
|
|
15055
15179
|
nest_device_id: string
|
|
15056
15180
|
device_name: string
|
|
15057
|
-
|
|
15181
|
+
device_custom_name: string
|
|
15058
15182
|
display_name?: string | undefined
|
|
15059
15183
|
}
|
|
15060
15184
|
| undefined
|
|
@@ -15749,7 +15873,7 @@ export interface Routes {
|
|
|
15749
15873
|
| {
|
|
15750
15874
|
nest_device_id: string
|
|
15751
15875
|
device_name: string
|
|
15752
|
-
|
|
15876
|
+
device_custom_name: string
|
|
15753
15877
|
display_name?: string | undefined
|
|
15754
15878
|
}
|
|
15755
15879
|
| undefined
|
|
@@ -16625,7 +16749,7 @@ export interface Routes {
|
|
|
16625
16749
|
| {
|
|
16626
16750
|
nest_device_id: string
|
|
16627
16751
|
device_name: string
|
|
16628
|
-
|
|
16752
|
+
device_custom_name: string
|
|
16629
16753
|
display_name?: string | undefined
|
|
16630
16754
|
}
|
|
16631
16755
|
| undefined
|
|
@@ -17320,7 +17444,7 @@ export interface Routes {
|
|
|
17320
17444
|
| {
|
|
17321
17445
|
nest_device_id: string
|
|
17322
17446
|
device_name: string
|
|
17323
|
-
|
|
17447
|
+
device_custom_name: string
|
|
17324
17448
|
display_name?: string | undefined
|
|
17325
17449
|
}
|
|
17326
17450
|
| undefined
|
|
@@ -20204,7 +20328,7 @@ export interface Routes {
|
|
|
20204
20328
|
| {
|
|
20205
20329
|
nest_device_id: string
|
|
20206
20330
|
device_name: string
|
|
20207
|
-
|
|
20331
|
+
device_custom_name: string
|
|
20208
20332
|
display_name?: string | undefined
|
|
20209
20333
|
}
|
|
20210
20334
|
| undefined
|
|
@@ -20899,7 +21023,7 @@ export interface Routes {
|
|
|
20899
21023
|
| {
|
|
20900
21024
|
nest_device_id: string
|
|
20901
21025
|
device_name: string
|
|
20902
|
-
|
|
21026
|
+
device_custom_name: string
|
|
20903
21027
|
display_name?: string | undefined
|
|
20904
21028
|
}
|
|
20905
21029
|
| undefined
|
|
@@ -26865,7 +26989,7 @@ export interface Routes {
|
|
|
26865
26989
|
| {
|
|
26866
26990
|
nest_device_id: string
|
|
26867
26991
|
device_name: string
|
|
26868
|
-
|
|
26992
|
+
device_custom_name: string
|
|
26869
26993
|
display_name?: string | undefined
|
|
26870
26994
|
}
|
|
26871
26995
|
| undefined
|
|
@@ -29731,7 +29855,7 @@ export interface Routes {
|
|
|
29731
29855
|
| {
|
|
29732
29856
|
nest_device_id: string
|
|
29733
29857
|
device_name: string
|
|
29734
|
-
|
|
29858
|
+
device_custom_name: string
|
|
29735
29859
|
display_name?: string | undefined
|
|
29736
29860
|
}
|
|
29737
29861
|
| undefined
|
|
@@ -30426,7 +30550,7 @@ export interface Routes {
|
|
|
30426
30550
|
| {
|
|
30427
30551
|
nest_device_id: string
|
|
30428
30552
|
device_name: string
|
|
30429
|
-
|
|
30553
|
+
device_custom_name: string
|
|
30430
30554
|
display_name?: string | undefined
|
|
30431
30555
|
}
|
|
30432
30556
|
| undefined
|
|
@@ -34586,7 +34710,7 @@ export interface Routes {
|
|
|
34586
34710
|
| {
|
|
34587
34711
|
nest_device_id: string
|
|
34588
34712
|
device_name: string
|
|
34589
|
-
|
|
34713
|
+
device_custom_name: string
|
|
34590
34714
|
display_name?: string | undefined
|
|
34591
34715
|
}
|
|
34592
34716
|
| undefined
|
|
@@ -35283,7 +35407,7 @@ export interface Routes {
|
|
|
35283
35407
|
| {
|
|
35284
35408
|
nest_device_id: string
|
|
35285
35409
|
device_name: string
|
|
35286
|
-
|
|
35410
|
+
device_custom_name: string
|
|
35287
35411
|
display_name?: string | undefined
|
|
35288
35412
|
}
|
|
35289
35413
|
| undefined
|