@seamapi/types 1.385.0 → 1.386.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 +169 -9
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2505 -199
- package/lib/seam/connect/models/colors.d.ts +2 -0
- package/lib/seam/connect/models/colors.js +8 -0
- package/lib/seam/connect/models/colors.js.map +1 -0
- package/lib/seam/connect/models/events/access-grants.d.ts +277 -0
- package/lib/seam/connect/models/events/access-grants.js +60 -0
- package/lib/seam/connect/models/events/access-grants.js.map +1 -0
- package/lib/seam/connect/models/events/access-methods.d.ts +146 -0
- package/lib/seam/connect/models/events/access-methods.js +35 -0
- package/lib/seam/connect/models/events/access-methods.js.map +1 -0
- package/lib/seam/connect/models/workspaces/workspace.d.ts +33 -0
- package/lib/seam/connect/models/workspaces/workspace.js +8 -0
- package/lib/seam/connect/models/workspaces/workspace.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +208 -1
- package/lib/seam/connect/openapi.js +153 -8
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +2068 -2
- package/package.json +2 -2
- package/src/lib/seam/connect/models/colors.ts +9 -0
- package/src/lib/seam/connect/models/events/access-grants.ts +92 -0
- package/src/lib/seam/connect/models/events/access-methods.ts +51 -0
- package/src/lib/seam/connect/models/workspaces/workspace.ts +9 -0
- package/src/lib/seam/connect/openapi.ts +158 -8
- package/src/lib/seam/connect/route-types.ts +2420 -2
package/dist/connect.d.cts
CHANGED
|
@@ -19969,6 +19969,25 @@ declare const workspace: z.ZodObject<{
|
|
|
19969
19969
|
name: z.ZodString;
|
|
19970
19970
|
company_name: z.ZodString;
|
|
19971
19971
|
is_sandbox: z.ZodBoolean;
|
|
19972
|
+
connect_webview_customization: z.ZodObject<{
|
|
19973
|
+
primary_button_color: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
|
|
19974
|
+
primary_button_text_color: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
|
|
19975
|
+
success_message: z.ZodOptional<z.ZodString>;
|
|
19976
|
+
logo_shape: z.ZodOptional<z.ZodEnum<["circle", "square"]>>;
|
|
19977
|
+
inviter_logo_url: z.ZodOptional<z.ZodString>;
|
|
19978
|
+
}, "strip", z.ZodTypeAny, {
|
|
19979
|
+
primary_button_color?: string | undefined;
|
|
19980
|
+
primary_button_text_color?: string | undefined;
|
|
19981
|
+
success_message?: string | undefined;
|
|
19982
|
+
logo_shape?: "circle" | "square" | undefined;
|
|
19983
|
+
inviter_logo_url?: string | undefined;
|
|
19984
|
+
}, {
|
|
19985
|
+
primary_button_color?: string | undefined;
|
|
19986
|
+
primary_button_text_color?: string | undefined;
|
|
19987
|
+
success_message?: string | undefined;
|
|
19988
|
+
logo_shape?: "circle" | "square" | undefined;
|
|
19989
|
+
inviter_logo_url?: string | undefined;
|
|
19990
|
+
}>;
|
|
19972
19991
|
is_suspended: z.ZodBoolean;
|
|
19973
19992
|
connect_partner_name: z.ZodNullable<z.ZodNullable<z.ZodString>>;
|
|
19974
19993
|
}, "strip", z.ZodTypeAny, {
|
|
@@ -19977,6 +19996,13 @@ declare const workspace: z.ZodObject<{
|
|
|
19977
19996
|
is_suspended: boolean;
|
|
19978
19997
|
company_name: string;
|
|
19979
19998
|
is_sandbox: boolean;
|
|
19999
|
+
connect_webview_customization: {
|
|
20000
|
+
primary_button_color?: string | undefined;
|
|
20001
|
+
primary_button_text_color?: string | undefined;
|
|
20002
|
+
success_message?: string | undefined;
|
|
20003
|
+
logo_shape?: "circle" | "square" | undefined;
|
|
20004
|
+
inviter_logo_url?: string | undefined;
|
|
20005
|
+
};
|
|
19980
20006
|
connect_partner_name: string | null;
|
|
19981
20007
|
}, {
|
|
19982
20008
|
name: string;
|
|
@@ -19984,6 +20010,13 @@ declare const workspace: z.ZodObject<{
|
|
|
19984
20010
|
is_suspended: boolean;
|
|
19985
20011
|
company_name: string;
|
|
19986
20012
|
is_sandbox: boolean;
|
|
20013
|
+
connect_webview_customization: {
|
|
20014
|
+
primary_button_color?: string | undefined;
|
|
20015
|
+
primary_button_text_color?: string | undefined;
|
|
20016
|
+
success_message?: string | undefined;
|
|
20017
|
+
logo_shape?: "circle" | "square" | undefined;
|
|
20018
|
+
inviter_logo_url?: string | undefined;
|
|
20019
|
+
};
|
|
19987
20020
|
connect_partner_name: string | null;
|
|
19988
20021
|
}>;
|
|
19989
20022
|
type Workspace = z.infer<typeof workspace>;
|
|
@@ -29325,6 +29358,27 @@ declare const _default: {
|
|
|
29325
29358
|
type: string;
|
|
29326
29359
|
'x-deprecated': string;
|
|
29327
29360
|
};
|
|
29361
|
+
connect_webview_customization: {
|
|
29362
|
+
properties: {
|
|
29363
|
+
inviter_logo_url: {
|
|
29364
|
+
type: string;
|
|
29365
|
+
};
|
|
29366
|
+
logo_shape: {
|
|
29367
|
+
enum: string[];
|
|
29368
|
+
type: string;
|
|
29369
|
+
};
|
|
29370
|
+
primary_button_color: {
|
|
29371
|
+
type: string;
|
|
29372
|
+
};
|
|
29373
|
+
primary_button_text_color: {
|
|
29374
|
+
type: string;
|
|
29375
|
+
};
|
|
29376
|
+
success_message: {
|
|
29377
|
+
type: string;
|
|
29378
|
+
};
|
|
29379
|
+
};
|
|
29380
|
+
type: string;
|
|
29381
|
+
};
|
|
29328
29382
|
is_sandbox: {
|
|
29329
29383
|
type: string;
|
|
29330
29384
|
};
|
|
@@ -39747,7 +39801,8 @@ declare const _default: {
|
|
|
39747
39801
|
'x-action-attempt-type': string;
|
|
39748
39802
|
'x-fern-sdk-group-name': string[];
|
|
39749
39803
|
'x-fern-sdk-method-name': string;
|
|
39750
|
-
'x-
|
|
39804
|
+
'x-fern-sdk-return-value': string;
|
|
39805
|
+
'x-response-key': string;
|
|
39751
39806
|
'x-undocumented': string;
|
|
39752
39807
|
};
|
|
39753
39808
|
};
|
|
@@ -47066,6 +47121,12 @@ declare const _default: {
|
|
|
47066
47121
|
'application/json': {
|
|
47067
47122
|
schema: {
|
|
47068
47123
|
properties: {
|
|
47124
|
+
max_use_count: {
|
|
47125
|
+
default: number;
|
|
47126
|
+
description: string;
|
|
47127
|
+
format: string;
|
|
47128
|
+
type: string;
|
|
47129
|
+
};
|
|
47069
47130
|
user_identity_id: {
|
|
47070
47131
|
description: string;
|
|
47071
47132
|
format: string;
|
|
@@ -48431,6 +48492,28 @@ declare const _default: {
|
|
|
48431
48492
|
type: string;
|
|
48432
48493
|
'x-deprecated': string;
|
|
48433
48494
|
};
|
|
48495
|
+
connect_webview_customization: {
|
|
48496
|
+
properties: {
|
|
48497
|
+
logo_shape: {
|
|
48498
|
+
enum: string[];
|
|
48499
|
+
nullable: boolean;
|
|
48500
|
+
type: string;
|
|
48501
|
+
};
|
|
48502
|
+
primary_button_color: {
|
|
48503
|
+
nullable: boolean;
|
|
48504
|
+
type: string;
|
|
48505
|
+
};
|
|
48506
|
+
primary_button_text_color: {
|
|
48507
|
+
nullable: boolean;
|
|
48508
|
+
type: string;
|
|
48509
|
+
};
|
|
48510
|
+
success_message: {
|
|
48511
|
+
nullable: boolean;
|
|
48512
|
+
type: string;
|
|
48513
|
+
};
|
|
48514
|
+
};
|
|
48515
|
+
type: string;
|
|
48516
|
+
};
|
|
48434
48517
|
is_sandbox: {
|
|
48435
48518
|
default: boolean;
|
|
48436
48519
|
type: string;
|
|
@@ -48439,17 +48522,25 @@ declare const _default: {
|
|
|
48439
48522
|
type: string;
|
|
48440
48523
|
};
|
|
48441
48524
|
webview_logo_shape: {
|
|
48525
|
+
deprecated: boolean;
|
|
48442
48526
|
enum: string[];
|
|
48443
48527
|
type: string;
|
|
48528
|
+
'x-deprecated': string;
|
|
48444
48529
|
};
|
|
48445
48530
|
webview_primary_button_color: {
|
|
48531
|
+
deprecated: boolean;
|
|
48446
48532
|
type: string;
|
|
48533
|
+
'x-deprecated': string;
|
|
48447
48534
|
};
|
|
48448
48535
|
webview_primary_button_text_color: {
|
|
48536
|
+
deprecated: boolean;
|
|
48449
48537
|
type: string;
|
|
48538
|
+
'x-deprecated': string;
|
|
48450
48539
|
};
|
|
48451
48540
|
webview_success_message: {
|
|
48541
|
+
deprecated: boolean;
|
|
48452
48542
|
type: string;
|
|
48543
|
+
'x-deprecated': string;
|
|
48453
48544
|
};
|
|
48454
48545
|
};
|
|
48455
48546
|
required: string[];
|
|
@@ -48836,6 +48927,155 @@ declare const _default: {
|
|
|
48836
48927
|
'x-response-key': string;
|
|
48837
48928
|
};
|
|
48838
48929
|
};
|
|
48930
|
+
'/workspaces/update': {
|
|
48931
|
+
patch: {
|
|
48932
|
+
operationId: string;
|
|
48933
|
+
requestBody: {
|
|
48934
|
+
content: {
|
|
48935
|
+
'application/json': {
|
|
48936
|
+
schema: {
|
|
48937
|
+
properties: {
|
|
48938
|
+
connect_partner_name: {
|
|
48939
|
+
type: string;
|
|
48940
|
+
};
|
|
48941
|
+
connect_webview_customization: {
|
|
48942
|
+
properties: {
|
|
48943
|
+
logo_shape: {
|
|
48944
|
+
enum: string[];
|
|
48945
|
+
nullable: boolean;
|
|
48946
|
+
type: string;
|
|
48947
|
+
};
|
|
48948
|
+
primary_button_color: {
|
|
48949
|
+
nullable: boolean;
|
|
48950
|
+
type: string;
|
|
48951
|
+
};
|
|
48952
|
+
primary_button_text_color: {
|
|
48953
|
+
nullable: boolean;
|
|
48954
|
+
type: string;
|
|
48955
|
+
};
|
|
48956
|
+
success_message: {
|
|
48957
|
+
nullable: boolean;
|
|
48958
|
+
type: string;
|
|
48959
|
+
};
|
|
48960
|
+
};
|
|
48961
|
+
type: string;
|
|
48962
|
+
};
|
|
48963
|
+
is_suspended: {
|
|
48964
|
+
type: string;
|
|
48965
|
+
};
|
|
48966
|
+
name: {
|
|
48967
|
+
type: string;
|
|
48968
|
+
};
|
|
48969
|
+
};
|
|
48970
|
+
type: string;
|
|
48971
|
+
};
|
|
48972
|
+
};
|
|
48973
|
+
};
|
|
48974
|
+
};
|
|
48975
|
+
responses: {
|
|
48976
|
+
200: {
|
|
48977
|
+
description: string;
|
|
48978
|
+
};
|
|
48979
|
+
400: {
|
|
48980
|
+
description: string;
|
|
48981
|
+
};
|
|
48982
|
+
401: {
|
|
48983
|
+
description: string;
|
|
48984
|
+
};
|
|
48985
|
+
};
|
|
48986
|
+
security: ({
|
|
48987
|
+
api_key: never[];
|
|
48988
|
+
console_session_with_workspace?: never;
|
|
48989
|
+
pat_with_workspace?: never;
|
|
48990
|
+
} | {
|
|
48991
|
+
console_session_with_workspace: never[];
|
|
48992
|
+
api_key?: never;
|
|
48993
|
+
pat_with_workspace?: never;
|
|
48994
|
+
} | {
|
|
48995
|
+
pat_with_workspace: never[];
|
|
48996
|
+
api_key?: never;
|
|
48997
|
+
console_session_with_workspace?: never;
|
|
48998
|
+
})[];
|
|
48999
|
+
summary: string;
|
|
49000
|
+
tags: string[];
|
|
49001
|
+
'x-fern-ignore': boolean;
|
|
49002
|
+
'x-response-key': null;
|
|
49003
|
+
};
|
|
49004
|
+
post: {
|
|
49005
|
+
operationId: string;
|
|
49006
|
+
requestBody: {
|
|
49007
|
+
content: {
|
|
49008
|
+
'application/json': {
|
|
49009
|
+
schema: {
|
|
49010
|
+
properties: {
|
|
49011
|
+
connect_partner_name: {
|
|
49012
|
+
type: string;
|
|
49013
|
+
};
|
|
49014
|
+
connect_webview_customization: {
|
|
49015
|
+
properties: {
|
|
49016
|
+
logo_shape: {
|
|
49017
|
+
enum: string[];
|
|
49018
|
+
nullable: boolean;
|
|
49019
|
+
type: string;
|
|
49020
|
+
};
|
|
49021
|
+
primary_button_color: {
|
|
49022
|
+
nullable: boolean;
|
|
49023
|
+
type: string;
|
|
49024
|
+
};
|
|
49025
|
+
primary_button_text_color: {
|
|
49026
|
+
nullable: boolean;
|
|
49027
|
+
type: string;
|
|
49028
|
+
};
|
|
49029
|
+
success_message: {
|
|
49030
|
+
nullable: boolean;
|
|
49031
|
+
type: string;
|
|
49032
|
+
};
|
|
49033
|
+
};
|
|
49034
|
+
type: string;
|
|
49035
|
+
};
|
|
49036
|
+
is_suspended: {
|
|
49037
|
+
type: string;
|
|
49038
|
+
};
|
|
49039
|
+
name: {
|
|
49040
|
+
type: string;
|
|
49041
|
+
};
|
|
49042
|
+
};
|
|
49043
|
+
type: string;
|
|
49044
|
+
};
|
|
49045
|
+
};
|
|
49046
|
+
};
|
|
49047
|
+
};
|
|
49048
|
+
responses: {
|
|
49049
|
+
200: {
|
|
49050
|
+
description: string;
|
|
49051
|
+
};
|
|
49052
|
+
400: {
|
|
49053
|
+
description: string;
|
|
49054
|
+
};
|
|
49055
|
+
401: {
|
|
49056
|
+
description: string;
|
|
49057
|
+
};
|
|
49058
|
+
};
|
|
49059
|
+
security: ({
|
|
49060
|
+
api_key: never[];
|
|
49061
|
+
console_session_with_workspace?: never;
|
|
49062
|
+
pat_with_workspace?: never;
|
|
49063
|
+
} | {
|
|
49064
|
+
console_session_with_workspace: never[];
|
|
49065
|
+
api_key?: never;
|
|
49066
|
+
pat_with_workspace?: never;
|
|
49067
|
+
} | {
|
|
49068
|
+
pat_with_workspace: never[];
|
|
49069
|
+
api_key?: never;
|
|
49070
|
+
console_session_with_workspace?: never;
|
|
49071
|
+
})[];
|
|
49072
|
+
summary: string;
|
|
49073
|
+
tags: string[];
|
|
49074
|
+
'x-fern-sdk-group-name': string[];
|
|
49075
|
+
'x-fern-sdk-method-name': string;
|
|
49076
|
+
'x-response-key': null;
|
|
49077
|
+
};
|
|
49078
|
+
};
|
|
48839
49079
|
};
|
|
48840
49080
|
servers: {
|
|
48841
49081
|
url: string;
|
|
@@ -74267,33 +74507,6 @@ interface Routes {
|
|
|
74267
74507
|
};
|
|
74268
74508
|
commonParams: {};
|
|
74269
74509
|
formData: {};
|
|
74270
|
-
jsonResponse: {
|
|
74271
|
-
action_attempt?: any;
|
|
74272
|
-
};
|
|
74273
|
-
};
|
|
74274
|
-
'/locks/simulate/manual_lock_via_keypad': {
|
|
74275
|
-
route: '/locks/simulate/manual_lock_via_keypad';
|
|
74276
|
-
method: 'POST';
|
|
74277
|
-
queryParams: {};
|
|
74278
|
-
jsonBody: {
|
|
74279
|
-
device_id: string;
|
|
74280
|
-
};
|
|
74281
|
-
commonParams: {};
|
|
74282
|
-
formData: {};
|
|
74283
|
-
jsonResponse: {
|
|
74284
|
-
action_attempt?: any;
|
|
74285
|
-
};
|
|
74286
|
-
};
|
|
74287
|
-
'/locks/unlock_door': {
|
|
74288
|
-
route: '/locks/unlock_door';
|
|
74289
|
-
method: 'POST';
|
|
74290
|
-
queryParams: {};
|
|
74291
|
-
jsonBody: {
|
|
74292
|
-
device_id: string;
|
|
74293
|
-
sync?: boolean;
|
|
74294
|
-
};
|
|
74295
|
-
commonParams: {};
|
|
74296
|
-
formData: {};
|
|
74297
74510
|
jsonResponse: {
|
|
74298
74511
|
/** */
|
|
74299
74512
|
action_attempt: {
|
|
@@ -75303,185 +75516,2222 @@ interface Routes {
|
|
|
75303
75516
|
};
|
|
75304
75517
|
};
|
|
75305
75518
|
};
|
|
75306
|
-
'/
|
|
75307
|
-
route: '/
|
|
75308
|
-
method: '
|
|
75519
|
+
'/locks/simulate/manual_lock_via_keypad': {
|
|
75520
|
+
route: '/locks/simulate/manual_lock_via_keypad';
|
|
75521
|
+
method: 'POST';
|
|
75309
75522
|
queryParams: {};
|
|
75310
|
-
jsonBody: {
|
|
75311
|
-
|
|
75312
|
-
network_id: string;
|
|
75313
|
-
};
|
|
75314
|
-
formData: {};
|
|
75315
|
-
jsonResponse: {
|
|
75316
|
-
/** */
|
|
75317
|
-
network: {
|
|
75318
|
-
network_id: string;
|
|
75319
|
-
workspace_id: string;
|
|
75320
|
-
display_name: string;
|
|
75321
|
-
created_at: string;
|
|
75322
|
-
};
|
|
75523
|
+
jsonBody: {
|
|
75524
|
+
device_id: string;
|
|
75323
75525
|
};
|
|
75324
|
-
};
|
|
75325
|
-
'/networks/list': {
|
|
75326
|
-
route: '/networks/list';
|
|
75327
|
-
method: 'GET' | 'POST';
|
|
75328
|
-
queryParams: {};
|
|
75329
|
-
jsonBody: {};
|
|
75330
75526
|
commonParams: {};
|
|
75331
75527
|
formData: {};
|
|
75332
75528
|
jsonResponse: {
|
|
75333
|
-
networks: Array<{
|
|
75334
|
-
network_id: string;
|
|
75335
|
-
workspace_id: string;
|
|
75336
|
-
display_name: string;
|
|
75337
|
-
created_at: string;
|
|
75338
|
-
}>;
|
|
75339
|
-
};
|
|
75340
|
-
};
|
|
75341
|
-
'/noise_sensors/list': {
|
|
75342
|
-
route: '/noise_sensors/list';
|
|
75343
|
-
method: 'GET' | 'POST';
|
|
75344
|
-
queryParams: {};
|
|
75345
|
-
jsonBody: {};
|
|
75346
|
-
commonParams: {
|
|
75347
|
-
/** ID of the connected account by which to filter. */
|
|
75348
|
-
connected_account_id?: string | undefined;
|
|
75349
|
-
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
75350
|
-
connected_account_ids?: string[] | undefined;
|
|
75351
|
-
/** ID of the Connect Webview by which to filter devices. */
|
|
75352
|
-
connect_webview_id?: string | undefined;
|
|
75353
|
-
/** Device type by which to filter devices. */
|
|
75354
|
-
device_type?: ('noiseaware_activity_zone' | 'minut_sensor') | undefined;
|
|
75355
|
-
/** Array of device types by which to filter devices. */
|
|
75356
|
-
device_types?: Array<'noiseaware_activity_zone' | 'minut_sensor'> | undefined;
|
|
75357
|
-
/** Manufacturer by which to filter devices. */
|
|
75358
|
-
manufacturer?: ('noiseaware' | 'minut') | undefined;
|
|
75359
|
-
/** Array of device IDs by which to filter devices. */
|
|
75360
|
-
device_ids?: string[] | undefined;
|
|
75361
|
-
/** Numerical limit on the number of devices to return. */
|
|
75362
|
-
limit?: number;
|
|
75363
|
-
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
75364
|
-
created_before?: Date | undefined;
|
|
75365
|
-
/** Your own internal user ID for the user by which to filter devices. */
|
|
75366
|
-
user_identifier_key?: string | undefined;
|
|
75367
|
-
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
|
|
75368
|
-
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
75369
|
-
/** */
|
|
75370
|
-
include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
75371
|
-
/** */
|
|
75372
|
-
exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
75373
75529
|
/** */
|
|
75374
|
-
|
|
75375
|
-
|
|
75376
|
-
|
|
75377
|
-
|
|
75378
|
-
|
|
75379
|
-
|
|
75380
|
-
|
|
75381
|
-
|
|
75382
|
-
|
|
75383
|
-
|
|
75384
|
-
|
|
75385
|
-
|
|
75386
|
-
|
|
75387
|
-
/**
|
|
75388
|
-
|
|
75389
|
-
|
|
75390
|
-
|
|
75391
|
-
|
|
75392
|
-
|
|
75393
|
-
|
|
75394
|
-
|
|
75395
|
-
|
|
75396
|
-
|
|
75397
|
-
|
|
75398
|
-
|
|
75399
|
-
|
|
75400
|
-
|
|
75401
|
-
|
|
75402
|
-
|
|
75530
|
+
action_attempt: {
|
|
75531
|
+
/** ID of the action attempt. */
|
|
75532
|
+
action_attempt_id: string;
|
|
75533
|
+
status: 'pending';
|
|
75534
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
75535
|
+
result: null;
|
|
75536
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
75537
|
+
error: null;
|
|
75538
|
+
action_type: 'LOCK_DOOR';
|
|
75539
|
+
} | {
|
|
75540
|
+
/** ID of the action attempt. */
|
|
75541
|
+
action_attempt_id: string;
|
|
75542
|
+
status: 'success';
|
|
75543
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
75544
|
+
error: null;
|
|
75545
|
+
action_type: 'LOCK_DOOR';
|
|
75546
|
+
result: {};
|
|
75547
|
+
} | {
|
|
75548
|
+
/** ID of the action attempt. */
|
|
75549
|
+
action_attempt_id: string;
|
|
75550
|
+
status: 'error';
|
|
75551
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
75552
|
+
result: null;
|
|
75553
|
+
action_type: 'LOCK_DOOR';
|
|
75554
|
+
error: {
|
|
75555
|
+
type: string;
|
|
75556
|
+
message: string;
|
|
75557
|
+
};
|
|
75558
|
+
} | {
|
|
75559
|
+
/** ID of the action attempt. */
|
|
75560
|
+
action_attempt_id: string;
|
|
75561
|
+
status: 'pending';
|
|
75562
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
75563
|
+
result: null;
|
|
75564
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
75565
|
+
error: null;
|
|
75566
|
+
action_type: 'UNLOCK_DOOR';
|
|
75567
|
+
} | {
|
|
75568
|
+
/** ID of the action attempt. */
|
|
75569
|
+
action_attempt_id: string;
|
|
75570
|
+
status: 'success';
|
|
75571
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
75572
|
+
error: null;
|
|
75573
|
+
action_type: 'UNLOCK_DOOR';
|
|
75574
|
+
result: {};
|
|
75575
|
+
} | {
|
|
75576
|
+
/** ID of the action attempt. */
|
|
75577
|
+
action_attempt_id: string;
|
|
75578
|
+
status: 'error';
|
|
75579
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
75580
|
+
result: null;
|
|
75581
|
+
action_type: 'UNLOCK_DOOR';
|
|
75582
|
+
error: {
|
|
75583
|
+
type: string;
|
|
75584
|
+
message: string;
|
|
75585
|
+
};
|
|
75586
|
+
} | {
|
|
75587
|
+
/** ID of the action attempt. */
|
|
75588
|
+
action_attempt_id: string;
|
|
75589
|
+
status: 'pending';
|
|
75590
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
75591
|
+
result: null;
|
|
75592
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
75593
|
+
error: null;
|
|
75594
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
75595
|
+
} | {
|
|
75596
|
+
/** ID of the action attempt. */
|
|
75597
|
+
action_attempt_id: string;
|
|
75598
|
+
status: 'success';
|
|
75599
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
75600
|
+
error: null;
|
|
75601
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
75602
|
+
result: {
|
|
75603
|
+
/** Snapshot of credential data read from physical encoder. */
|
|
75604
|
+
acs_credential_on_encoder: {
|
|
75605
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
75606
|
+
created_at: string | null;
|
|
75607
|
+
is_issued: boolean | null;
|
|
75608
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
|
|
75609
|
+
starts_at: string | null;
|
|
75610
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
|
|
75611
|
+
ends_at: string | null;
|
|
75612
|
+
/** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75613
|
+
card_number: string | null;
|
|
75614
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75615
|
+
visionline_metadata?: {
|
|
75616
|
+
/** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75617
|
+
card_id: string;
|
|
75618
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
|
|
75619
|
+
cancelled: boolean;
|
|
75620
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
|
|
75621
|
+
discarded: boolean;
|
|
75622
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
|
|
75623
|
+
expired: boolean;
|
|
75624
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
|
|
75625
|
+
overwritten: boolean;
|
|
75626
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
|
|
75627
|
+
overridden?: boolean | undefined;
|
|
75628
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
|
|
75629
|
+
pending_auto_update: boolean;
|
|
75630
|
+
/** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75631
|
+
card_format: 'TLCode' | 'rfid48';
|
|
75632
|
+
/** Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75633
|
+
card_holder?: string | undefined;
|
|
75634
|
+
/** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75635
|
+
number_of_issued_cards: number;
|
|
75636
|
+
/** IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75637
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
75638
|
+
/** IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75639
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
75403
75640
|
} | undefined;
|
|
75404
|
-
} |
|
|
75405
|
-
|
|
75406
|
-
|
|
75407
|
-
|
|
75408
|
-
|
|
75409
|
-
|
|
75410
|
-
|
|
75411
|
-
|
|
75412
|
-
/**
|
|
75641
|
+
} | null;
|
|
75642
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
75643
|
+
acs_credential_on_seam: ({
|
|
75644
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75645
|
+
acs_credential_id: string;
|
|
75646
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
75647
|
+
acs_user_id?: string | undefined;
|
|
75648
|
+
acs_credential_pool_id?: string | undefined;
|
|
75649
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75650
|
+
acs_system_id: string;
|
|
75651
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75652
|
+
parent_acs_credential_id?: string | undefined;
|
|
75653
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
75413
75654
|
display_name: string;
|
|
75414
|
-
/**
|
|
75415
|
-
|
|
75416
|
-
/** Indicates whether the
|
|
75417
|
-
|
|
75418
|
-
/**
|
|
75419
|
-
|
|
75420
|
-
/** Indicates whether the
|
|
75421
|
-
|
|
75422
|
-
/**
|
|
75423
|
-
|
|
75424
|
-
|
|
75425
|
-
|
|
75426
|
-
|
|
75427
|
-
|
|
75428
|
-
|
|
75429
|
-
|
|
75430
|
-
|
|
75431
|
-
|
|
75432
|
-
|
|
75433
|
-
|
|
75434
|
-
|
|
75435
|
-
|
|
75436
|
-
|
|
75437
|
-
|
|
75438
|
-
|
|
75439
|
-
|
|
75440
|
-
|
|
75441
|
-
|
|
75442
|
-
|
|
75443
|
-
|
|
75444
|
-
|
|
75445
|
-
|
|
75446
|
-
|
|
75447
|
-
|
|
75448
|
-
|
|
75449
|
-
|
|
75450
|
-
|
|
75451
|
-
|
|
75452
|
-
|
|
75453
|
-
|
|
75454
|
-
|
|
75455
|
-
|
|
75456
|
-
|
|
75457
|
-
|
|
75458
|
-
|
|
75459
|
-
|
|
75460
|
-
|
|
75461
|
-
|
|
75462
|
-
|
|
75463
|
-
|
|
75464
|
-
|
|
75465
|
-
|
|
75466
|
-
/**
|
|
75467
|
-
|
|
75468
|
-
|
|
75469
|
-
|
|
75470
|
-
|
|
75471
|
-
|
|
75472
|
-
|
|
75473
|
-
|
|
75474
|
-
|
|
75475
|
-
|
|
75476
|
-
|
|
75477
|
-
|
|
75478
|
-
|
|
75479
|
-
|
|
75480
|
-
|
|
75481
|
-
|
|
75482
|
-
|
|
75483
|
-
|
|
75484
|
-
|
|
75655
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75656
|
+
code?: (string | undefined) | null;
|
|
75657
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
75658
|
+
is_one_time_use?: boolean | undefined;
|
|
75659
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75660
|
+
card_number?: (string | undefined) | null;
|
|
75661
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
75662
|
+
is_issued?: boolean | undefined;
|
|
75663
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
75664
|
+
issued_at?: (string | undefined) | null;
|
|
75665
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
75666
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
75667
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
75668
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
75669
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
75670
|
+
external_type_display_name?: string | undefined;
|
|
75671
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
75672
|
+
created_at: string;
|
|
75673
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75674
|
+
workspace_id: string;
|
|
75675
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
75676
|
+
starts_at?: string | undefined;
|
|
75677
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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`. */
|
|
75678
|
+
ends_at?: string | undefined;
|
|
75679
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75680
|
+
errors: Array<{
|
|
75681
|
+
error_code: string;
|
|
75682
|
+
message: string;
|
|
75683
|
+
}>;
|
|
75684
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75685
|
+
warnings: Array<{
|
|
75686
|
+
/** Date and time at which Seam created the warning. */
|
|
75687
|
+
created_at: string;
|
|
75688
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75689
|
+
message: string;
|
|
75690
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75691
|
+
warning_code: 'waiting_to_be_issued';
|
|
75692
|
+
} | {
|
|
75693
|
+
/** Date and time at which Seam created the warning. */
|
|
75694
|
+
created_at: string;
|
|
75695
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75696
|
+
message: string;
|
|
75697
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75698
|
+
warning_code: 'schedule_externally_modified';
|
|
75699
|
+
} | {
|
|
75700
|
+
/** Date and time at which Seam created the warning. */
|
|
75701
|
+
created_at: string;
|
|
75702
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75703
|
+
message: string;
|
|
75704
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75705
|
+
warning_code: 'schedule_modified';
|
|
75706
|
+
} | {
|
|
75707
|
+
/** Date and time at which Seam created the warning. */
|
|
75708
|
+
created_at: string;
|
|
75709
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75710
|
+
message: string;
|
|
75711
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75712
|
+
warning_code: 'being_deleted';
|
|
75713
|
+
} | {
|
|
75714
|
+
/** Date and time at which Seam created the warning. */
|
|
75715
|
+
created_at: string;
|
|
75716
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75717
|
+
message: string;
|
|
75718
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75719
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
75720
|
+
} | {
|
|
75721
|
+
/** Date and time at which Seam created the warning. */
|
|
75722
|
+
created_at: string;
|
|
75723
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75724
|
+
message: string;
|
|
75725
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75726
|
+
warning_code: 'needs_to_be_reissued';
|
|
75727
|
+
}>;
|
|
75728
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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). */
|
|
75729
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
75730
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
75731
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
75732
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
75733
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
75734
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75735
|
+
visionline_metadata?: {
|
|
75736
|
+
card_function_type: 'guest' | 'staff';
|
|
75737
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
75738
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
75739
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
75740
|
+
is_valid?: boolean | undefined;
|
|
75741
|
+
auto_join?: boolean | undefined;
|
|
75742
|
+
card_id?: string | undefined;
|
|
75743
|
+
credential_id?: string | undefined;
|
|
75744
|
+
} | undefined;
|
|
75745
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75746
|
+
assa_abloy_vostio_metadata?: {
|
|
75747
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
75748
|
+
key_id?: string | undefined;
|
|
75749
|
+
key_issuing_request_id?: string | undefined;
|
|
75750
|
+
door_names?: string[] | undefined;
|
|
75751
|
+
endpoint_id?: string | undefined;
|
|
75752
|
+
} | undefined;
|
|
75753
|
+
is_managed: true;
|
|
75754
|
+
} | {
|
|
75755
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75756
|
+
acs_credential_id: string;
|
|
75757
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
75758
|
+
acs_user_id?: string | undefined;
|
|
75759
|
+
acs_credential_pool_id?: string | undefined;
|
|
75760
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75761
|
+
acs_system_id: string;
|
|
75762
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75763
|
+
parent_acs_credential_id?: string | undefined;
|
|
75764
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
75765
|
+
display_name: string;
|
|
75766
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75767
|
+
code?: (string | undefined) | null;
|
|
75768
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
75769
|
+
is_one_time_use?: boolean | undefined;
|
|
75770
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75771
|
+
card_number?: (string | undefined) | null;
|
|
75772
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
75773
|
+
is_issued?: boolean | undefined;
|
|
75774
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
75775
|
+
issued_at?: (string | undefined) | null;
|
|
75776
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
75777
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
75778
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
75779
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
75780
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
75781
|
+
external_type_display_name?: string | undefined;
|
|
75782
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
75783
|
+
created_at: string;
|
|
75784
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75785
|
+
workspace_id: string;
|
|
75786
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
75787
|
+
starts_at?: string | undefined;
|
|
75788
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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`. */
|
|
75789
|
+
ends_at?: string | undefined;
|
|
75790
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75791
|
+
errors: Array<{
|
|
75792
|
+
error_code: string;
|
|
75793
|
+
message: string;
|
|
75794
|
+
}>;
|
|
75795
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75796
|
+
warnings: Array<{
|
|
75797
|
+
/** Date and time at which Seam created the warning. */
|
|
75798
|
+
created_at: string;
|
|
75799
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75800
|
+
message: string;
|
|
75801
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75802
|
+
warning_code: 'waiting_to_be_issued';
|
|
75803
|
+
} | {
|
|
75804
|
+
/** Date and time at which Seam created the warning. */
|
|
75805
|
+
created_at: string;
|
|
75806
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75807
|
+
message: string;
|
|
75808
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75809
|
+
warning_code: 'schedule_externally_modified';
|
|
75810
|
+
} | {
|
|
75811
|
+
/** Date and time at which Seam created the warning. */
|
|
75812
|
+
created_at: string;
|
|
75813
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75814
|
+
message: string;
|
|
75815
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75816
|
+
warning_code: 'schedule_modified';
|
|
75817
|
+
} | {
|
|
75818
|
+
/** Date and time at which Seam created the warning. */
|
|
75819
|
+
created_at: string;
|
|
75820
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75821
|
+
message: string;
|
|
75822
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75823
|
+
warning_code: 'being_deleted';
|
|
75824
|
+
} | {
|
|
75825
|
+
/** Date and time at which Seam created the warning. */
|
|
75826
|
+
created_at: string;
|
|
75827
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75828
|
+
message: string;
|
|
75829
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75830
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
75831
|
+
} | {
|
|
75832
|
+
/** Date and time at which Seam created the warning. */
|
|
75833
|
+
created_at: string;
|
|
75834
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75835
|
+
message: string;
|
|
75836
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75837
|
+
warning_code: 'needs_to_be_reissued';
|
|
75838
|
+
}>;
|
|
75839
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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). */
|
|
75840
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
75841
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
75842
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
75843
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
75844
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
75845
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75846
|
+
visionline_metadata?: {
|
|
75847
|
+
card_function_type: 'guest' | 'staff';
|
|
75848
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
75849
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
75850
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
75851
|
+
is_valid?: boolean | undefined;
|
|
75852
|
+
auto_join?: boolean | undefined;
|
|
75853
|
+
card_id?: string | undefined;
|
|
75854
|
+
credential_id?: string | undefined;
|
|
75855
|
+
} | undefined;
|
|
75856
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75857
|
+
assa_abloy_vostio_metadata?: {
|
|
75858
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
75859
|
+
key_id?: string | undefined;
|
|
75860
|
+
key_issuing_request_id?: string | undefined;
|
|
75861
|
+
door_names?: string[] | undefined;
|
|
75862
|
+
endpoint_id?: string | undefined;
|
|
75863
|
+
} | undefined;
|
|
75864
|
+
is_managed: false;
|
|
75865
|
+
}) | null;
|
|
75866
|
+
warnings: Array<{
|
|
75867
|
+
warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
|
|
75868
|
+
warning_message: string;
|
|
75869
|
+
}>;
|
|
75870
|
+
};
|
|
75871
|
+
} | {
|
|
75872
|
+
/** ID of the action attempt. */
|
|
75873
|
+
action_attempt_id: string;
|
|
75874
|
+
status: 'error';
|
|
75875
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
75876
|
+
result: null;
|
|
75877
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
75878
|
+
error: {
|
|
75879
|
+
/** Type of the error associated with the action attempt. */
|
|
75880
|
+
type: 'uncategorized_error';
|
|
75881
|
+
/** Message for the error associated with the action attempt. */
|
|
75882
|
+
message: string;
|
|
75883
|
+
} | {
|
|
75884
|
+
/** Type of the error associated with the action attempt. */
|
|
75885
|
+
type: 'action_attempt_expired';
|
|
75886
|
+
/** Message for the error associated with the action attempt. */
|
|
75887
|
+
message: string;
|
|
75888
|
+
} | {
|
|
75889
|
+
type: 'no_credential_on_encoder';
|
|
75890
|
+
message: string;
|
|
75891
|
+
};
|
|
75892
|
+
} | {
|
|
75893
|
+
/** ID of the action attempt. */
|
|
75894
|
+
action_attempt_id: string;
|
|
75895
|
+
status: 'pending';
|
|
75896
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
75897
|
+
result: null;
|
|
75898
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
75899
|
+
error: null;
|
|
75900
|
+
/** Type of action that the action attempt tracks. */
|
|
75901
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
75902
|
+
} | {
|
|
75903
|
+
/** ID of the action attempt. */
|
|
75904
|
+
action_attempt_id: string;
|
|
75905
|
+
status: 'success';
|
|
75906
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
75907
|
+
error: null;
|
|
75908
|
+
/** Type of action that the action attempt tracks. */
|
|
75909
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
75910
|
+
/** If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card. */
|
|
75911
|
+
result: {
|
|
75912
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75913
|
+
acs_credential_id: string;
|
|
75914
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
75915
|
+
acs_user_id?: string | undefined;
|
|
75916
|
+
acs_credential_pool_id?: string | undefined;
|
|
75917
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75918
|
+
acs_system_id: string;
|
|
75919
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75920
|
+
parent_acs_credential_id?: string | undefined;
|
|
75921
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
75922
|
+
display_name: string;
|
|
75923
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75924
|
+
code?: (string | undefined) | null;
|
|
75925
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
75926
|
+
is_one_time_use?: boolean | undefined;
|
|
75927
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75928
|
+
card_number?: (string | undefined) | null;
|
|
75929
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
75930
|
+
is_issued?: boolean | undefined;
|
|
75931
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
75932
|
+
issued_at?: (string | undefined) | null;
|
|
75933
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
75934
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
75935
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
75936
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
75937
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
75938
|
+
external_type_display_name?: string | undefined;
|
|
75939
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
75940
|
+
created_at: string;
|
|
75941
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75942
|
+
workspace_id: string;
|
|
75943
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
75944
|
+
starts_at?: string | undefined;
|
|
75945
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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`. */
|
|
75946
|
+
ends_at?: string | undefined;
|
|
75947
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75948
|
+
errors: Array<{
|
|
75949
|
+
error_code: string;
|
|
75950
|
+
message: string;
|
|
75951
|
+
}>;
|
|
75952
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
75953
|
+
warnings: Array<{
|
|
75954
|
+
/** Date and time at which Seam created the warning. */
|
|
75955
|
+
created_at: string;
|
|
75956
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75957
|
+
message: string;
|
|
75958
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75959
|
+
warning_code: 'waiting_to_be_issued';
|
|
75960
|
+
} | {
|
|
75961
|
+
/** Date and time at which Seam created the warning. */
|
|
75962
|
+
created_at: string;
|
|
75963
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75964
|
+
message: string;
|
|
75965
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75966
|
+
warning_code: 'schedule_externally_modified';
|
|
75967
|
+
} | {
|
|
75968
|
+
/** Date and time at which Seam created the warning. */
|
|
75969
|
+
created_at: string;
|
|
75970
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75971
|
+
message: string;
|
|
75972
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75973
|
+
warning_code: 'schedule_modified';
|
|
75974
|
+
} | {
|
|
75975
|
+
/** Date and time at which Seam created the warning. */
|
|
75976
|
+
created_at: string;
|
|
75977
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75978
|
+
message: string;
|
|
75979
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75980
|
+
warning_code: 'being_deleted';
|
|
75981
|
+
} | {
|
|
75982
|
+
/** Date and time at which Seam created the warning. */
|
|
75983
|
+
created_at: string;
|
|
75984
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75985
|
+
message: string;
|
|
75986
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75987
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
75988
|
+
} | {
|
|
75989
|
+
/** Date and time at which Seam created the warning. */
|
|
75990
|
+
created_at: string;
|
|
75991
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
75992
|
+
message: string;
|
|
75993
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
75994
|
+
warning_code: 'needs_to_be_reissued';
|
|
75995
|
+
}>;
|
|
75996
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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). */
|
|
75997
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
75998
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
75999
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
76000
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
76001
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
76002
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76003
|
+
visionline_metadata?: {
|
|
76004
|
+
card_function_type: 'guest' | 'staff';
|
|
76005
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
76006
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
76007
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
76008
|
+
is_valid?: boolean | undefined;
|
|
76009
|
+
auto_join?: boolean | undefined;
|
|
76010
|
+
card_id?: string | undefined;
|
|
76011
|
+
credential_id?: string | undefined;
|
|
76012
|
+
} | undefined;
|
|
76013
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76014
|
+
assa_abloy_vostio_metadata?: {
|
|
76015
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
76016
|
+
key_id?: string | undefined;
|
|
76017
|
+
key_issuing_request_id?: string | undefined;
|
|
76018
|
+
door_names?: string[] | undefined;
|
|
76019
|
+
endpoint_id?: string | undefined;
|
|
76020
|
+
} | undefined;
|
|
76021
|
+
is_managed: true;
|
|
76022
|
+
} | {
|
|
76023
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76024
|
+
acs_credential_id: string;
|
|
76025
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
76026
|
+
acs_user_id?: string | undefined;
|
|
76027
|
+
acs_credential_pool_id?: string | undefined;
|
|
76028
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76029
|
+
acs_system_id: string;
|
|
76030
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76031
|
+
parent_acs_credential_id?: string | undefined;
|
|
76032
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
76033
|
+
display_name: string;
|
|
76034
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76035
|
+
code?: (string | undefined) | null;
|
|
76036
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
76037
|
+
is_one_time_use?: boolean | undefined;
|
|
76038
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76039
|
+
card_number?: (string | undefined) | null;
|
|
76040
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
76041
|
+
is_issued?: boolean | undefined;
|
|
76042
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
76043
|
+
issued_at?: (string | undefined) | null;
|
|
76044
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
76045
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
76046
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
76047
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
76048
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
76049
|
+
external_type_display_name?: string | undefined;
|
|
76050
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
76051
|
+
created_at: string;
|
|
76052
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76053
|
+
workspace_id: string;
|
|
76054
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
76055
|
+
starts_at?: string | undefined;
|
|
76056
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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`. */
|
|
76057
|
+
ends_at?: string | undefined;
|
|
76058
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76059
|
+
errors: Array<{
|
|
76060
|
+
error_code: string;
|
|
76061
|
+
message: string;
|
|
76062
|
+
}>;
|
|
76063
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76064
|
+
warnings: Array<{
|
|
76065
|
+
/** Date and time at which Seam created the warning. */
|
|
76066
|
+
created_at: string;
|
|
76067
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76068
|
+
message: string;
|
|
76069
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76070
|
+
warning_code: 'waiting_to_be_issued';
|
|
76071
|
+
} | {
|
|
76072
|
+
/** Date and time at which Seam created the warning. */
|
|
76073
|
+
created_at: string;
|
|
76074
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76075
|
+
message: string;
|
|
76076
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76077
|
+
warning_code: 'schedule_externally_modified';
|
|
76078
|
+
} | {
|
|
76079
|
+
/** Date and time at which Seam created the warning. */
|
|
76080
|
+
created_at: string;
|
|
76081
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76082
|
+
message: string;
|
|
76083
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76084
|
+
warning_code: 'schedule_modified';
|
|
76085
|
+
} | {
|
|
76086
|
+
/** Date and time at which Seam created the warning. */
|
|
76087
|
+
created_at: string;
|
|
76088
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76089
|
+
message: string;
|
|
76090
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76091
|
+
warning_code: 'being_deleted';
|
|
76092
|
+
} | {
|
|
76093
|
+
/** Date and time at which Seam created the warning. */
|
|
76094
|
+
created_at: string;
|
|
76095
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76096
|
+
message: string;
|
|
76097
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76098
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
76099
|
+
} | {
|
|
76100
|
+
/** Date and time at which Seam created the warning. */
|
|
76101
|
+
created_at: string;
|
|
76102
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76103
|
+
message: string;
|
|
76104
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76105
|
+
warning_code: 'needs_to_be_reissued';
|
|
76106
|
+
}>;
|
|
76107
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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). */
|
|
76108
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
76109
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
76110
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
76111
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
76112
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
76113
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76114
|
+
visionline_metadata?: {
|
|
76115
|
+
card_function_type: 'guest' | 'staff';
|
|
76116
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
76117
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
76118
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
76119
|
+
is_valid?: boolean | undefined;
|
|
76120
|
+
auto_join?: boolean | undefined;
|
|
76121
|
+
card_id?: string | undefined;
|
|
76122
|
+
credential_id?: string | undefined;
|
|
76123
|
+
} | undefined;
|
|
76124
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76125
|
+
assa_abloy_vostio_metadata?: {
|
|
76126
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
76127
|
+
key_id?: string | undefined;
|
|
76128
|
+
key_issuing_request_id?: string | undefined;
|
|
76129
|
+
door_names?: string[] | undefined;
|
|
76130
|
+
endpoint_id?: string | undefined;
|
|
76131
|
+
} | undefined;
|
|
76132
|
+
is_managed: false;
|
|
76133
|
+
};
|
|
76134
|
+
} | {
|
|
76135
|
+
/** ID of the action attempt. */
|
|
76136
|
+
action_attempt_id: string;
|
|
76137
|
+
status: 'error';
|
|
76138
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76139
|
+
result: null;
|
|
76140
|
+
/** Type of action that the action attempt tracks. */
|
|
76141
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
76142
|
+
error: {
|
|
76143
|
+
/** Type of the error associated with the action attempt. */
|
|
76144
|
+
type: 'uncategorized_error';
|
|
76145
|
+
/** Message for the error associated with the action attempt. */
|
|
76146
|
+
message: string;
|
|
76147
|
+
} | {
|
|
76148
|
+
/** Type of the error associated with the action attempt. */
|
|
76149
|
+
type: 'action_attempt_expired';
|
|
76150
|
+
/** Message for the error associated with the action attempt. */
|
|
76151
|
+
message: string;
|
|
76152
|
+
} | {
|
|
76153
|
+
type: 'no_credential_on_encoder';
|
|
76154
|
+
message: string;
|
|
76155
|
+
} | {
|
|
76156
|
+
type: 'incompatible_card_format';
|
|
76157
|
+
message: string;
|
|
76158
|
+
} | {
|
|
76159
|
+
type: 'credential_cannot_be_reissued';
|
|
76160
|
+
message: string;
|
|
76161
|
+
};
|
|
76162
|
+
} | {
|
|
76163
|
+
/** ID of the action attempt. */
|
|
76164
|
+
action_attempt_id: string;
|
|
76165
|
+
status: 'pending';
|
|
76166
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76167
|
+
result: null;
|
|
76168
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76169
|
+
error: null;
|
|
76170
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
76171
|
+
} | {
|
|
76172
|
+
/** ID of the action attempt. */
|
|
76173
|
+
action_attempt_id: string;
|
|
76174
|
+
status: 'success';
|
|
76175
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76176
|
+
error: null;
|
|
76177
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
76178
|
+
result: {};
|
|
76179
|
+
} | {
|
|
76180
|
+
/** ID of the action attempt. */
|
|
76181
|
+
action_attempt_id: string;
|
|
76182
|
+
status: 'error';
|
|
76183
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76184
|
+
result: null;
|
|
76185
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
76186
|
+
error: {
|
|
76187
|
+
type: string;
|
|
76188
|
+
message: string;
|
|
76189
|
+
};
|
|
76190
|
+
} | {
|
|
76191
|
+
/** ID of the action attempt. */
|
|
76192
|
+
action_attempt_id: string;
|
|
76193
|
+
status: 'pending';
|
|
76194
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76195
|
+
result: null;
|
|
76196
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76197
|
+
error: null;
|
|
76198
|
+
action_type: 'SET_FAN_MODE';
|
|
76199
|
+
} | {
|
|
76200
|
+
/** ID of the action attempt. */
|
|
76201
|
+
action_attempt_id: string;
|
|
76202
|
+
status: 'success';
|
|
76203
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76204
|
+
error: null;
|
|
76205
|
+
action_type: 'SET_FAN_MODE';
|
|
76206
|
+
result: {};
|
|
76207
|
+
} | {
|
|
76208
|
+
/** ID of the action attempt. */
|
|
76209
|
+
action_attempt_id: string;
|
|
76210
|
+
status: 'error';
|
|
76211
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76212
|
+
result: null;
|
|
76213
|
+
action_type: 'SET_FAN_MODE';
|
|
76214
|
+
error: {
|
|
76215
|
+
type: string;
|
|
76216
|
+
message: string;
|
|
76217
|
+
};
|
|
76218
|
+
} | {
|
|
76219
|
+
/** ID of the action attempt. */
|
|
76220
|
+
action_attempt_id: string;
|
|
76221
|
+
status: 'pending';
|
|
76222
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76223
|
+
result: null;
|
|
76224
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76225
|
+
error: null;
|
|
76226
|
+
action_type: 'SET_HVAC_MODE';
|
|
76227
|
+
} | {
|
|
76228
|
+
/** ID of the action attempt. */
|
|
76229
|
+
action_attempt_id: string;
|
|
76230
|
+
status: 'success';
|
|
76231
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76232
|
+
error: null;
|
|
76233
|
+
action_type: 'SET_HVAC_MODE';
|
|
76234
|
+
result: {};
|
|
76235
|
+
} | {
|
|
76236
|
+
/** ID of the action attempt. */
|
|
76237
|
+
action_attempt_id: string;
|
|
76238
|
+
status: 'error';
|
|
76239
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76240
|
+
result: null;
|
|
76241
|
+
action_type: 'SET_HVAC_MODE';
|
|
76242
|
+
error: {
|
|
76243
|
+
type: string;
|
|
76244
|
+
message: string;
|
|
76245
|
+
};
|
|
76246
|
+
} | {
|
|
76247
|
+
/** ID of the action attempt. */
|
|
76248
|
+
action_attempt_id: string;
|
|
76249
|
+
status: 'pending';
|
|
76250
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76251
|
+
result: null;
|
|
76252
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76253
|
+
error: null;
|
|
76254
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
76255
|
+
} | {
|
|
76256
|
+
/** ID of the action attempt. */
|
|
76257
|
+
action_attempt_id: string;
|
|
76258
|
+
status: 'success';
|
|
76259
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76260
|
+
error: null;
|
|
76261
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
76262
|
+
result: {};
|
|
76263
|
+
} | {
|
|
76264
|
+
/** ID of the action attempt. */
|
|
76265
|
+
action_attempt_id: string;
|
|
76266
|
+
status: 'error';
|
|
76267
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76268
|
+
result: null;
|
|
76269
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
76270
|
+
error: {
|
|
76271
|
+
type: string;
|
|
76272
|
+
message: string;
|
|
76273
|
+
};
|
|
76274
|
+
} | {
|
|
76275
|
+
/** ID of the action attempt. */
|
|
76276
|
+
action_attempt_id: string;
|
|
76277
|
+
status: 'pending';
|
|
76278
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76279
|
+
result: null;
|
|
76280
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76281
|
+
error: null;
|
|
76282
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
76283
|
+
} | {
|
|
76284
|
+
/** ID of the action attempt. */
|
|
76285
|
+
action_attempt_id: string;
|
|
76286
|
+
status: 'success';
|
|
76287
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76288
|
+
error: null;
|
|
76289
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
76290
|
+
result: {};
|
|
76291
|
+
} | {
|
|
76292
|
+
/** ID of the action attempt. */
|
|
76293
|
+
action_attempt_id: string;
|
|
76294
|
+
status: 'error';
|
|
76295
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76296
|
+
result: null;
|
|
76297
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
76298
|
+
error: {
|
|
76299
|
+
type: string;
|
|
76300
|
+
message: string;
|
|
76301
|
+
};
|
|
76302
|
+
} | {
|
|
76303
|
+
/** ID of the action attempt. */
|
|
76304
|
+
action_attempt_id: string;
|
|
76305
|
+
status: 'pending';
|
|
76306
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76307
|
+
result: null;
|
|
76308
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76309
|
+
error: null;
|
|
76310
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
76311
|
+
} | {
|
|
76312
|
+
/** ID of the action attempt. */
|
|
76313
|
+
action_attempt_id: string;
|
|
76314
|
+
status: 'success';
|
|
76315
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76316
|
+
error: null;
|
|
76317
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
76318
|
+
result: {};
|
|
76319
|
+
} | {
|
|
76320
|
+
/** ID of the action attempt. */
|
|
76321
|
+
action_attempt_id: string;
|
|
76322
|
+
status: 'error';
|
|
76323
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76324
|
+
result: null;
|
|
76325
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
76326
|
+
error: {
|
|
76327
|
+
type: string;
|
|
76328
|
+
message: string;
|
|
76329
|
+
};
|
|
76330
|
+
} | {
|
|
76331
|
+
/** ID of the action attempt. */
|
|
76332
|
+
action_attempt_id: string;
|
|
76333
|
+
status: 'pending';
|
|
76334
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76335
|
+
result: null;
|
|
76336
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76337
|
+
error: null;
|
|
76338
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
76339
|
+
} | {
|
|
76340
|
+
/** ID of the action attempt. */
|
|
76341
|
+
action_attempt_id: string;
|
|
76342
|
+
status: 'success';
|
|
76343
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76344
|
+
error: null;
|
|
76345
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
76346
|
+
result: {};
|
|
76347
|
+
} | {
|
|
76348
|
+
/** ID of the action attempt. */
|
|
76349
|
+
action_attempt_id: string;
|
|
76350
|
+
status: 'error';
|
|
76351
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76352
|
+
result: null;
|
|
76353
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
76354
|
+
error: {
|
|
76355
|
+
type: string;
|
|
76356
|
+
message: string;
|
|
76357
|
+
};
|
|
76358
|
+
} | {
|
|
76359
|
+
/** ID of the action attempt. */
|
|
76360
|
+
action_attempt_id: string;
|
|
76361
|
+
status: 'pending';
|
|
76362
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76363
|
+
result: null;
|
|
76364
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76365
|
+
error: null;
|
|
76366
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
76367
|
+
} | {
|
|
76368
|
+
/** ID of the action attempt. */
|
|
76369
|
+
action_attempt_id: string;
|
|
76370
|
+
status: 'success';
|
|
76371
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76372
|
+
error: null;
|
|
76373
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
76374
|
+
result: {
|
|
76375
|
+
access_code?: any;
|
|
76376
|
+
};
|
|
76377
|
+
} | {
|
|
76378
|
+
/** ID of the action attempt. */
|
|
76379
|
+
action_attempt_id: string;
|
|
76380
|
+
status: 'error';
|
|
76381
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76382
|
+
result: null;
|
|
76383
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
76384
|
+
error: {
|
|
76385
|
+
type: string;
|
|
76386
|
+
message: string;
|
|
76387
|
+
};
|
|
76388
|
+
} | {
|
|
76389
|
+
/** ID of the action attempt. */
|
|
76390
|
+
action_attempt_id: string;
|
|
76391
|
+
status: 'pending';
|
|
76392
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76393
|
+
result: null;
|
|
76394
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76395
|
+
error: null;
|
|
76396
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
76397
|
+
} | {
|
|
76398
|
+
/** ID of the action attempt. */
|
|
76399
|
+
action_attempt_id: string;
|
|
76400
|
+
status: 'success';
|
|
76401
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76402
|
+
error: null;
|
|
76403
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
76404
|
+
result: {};
|
|
76405
|
+
} | {
|
|
76406
|
+
/** ID of the action attempt. */
|
|
76407
|
+
action_attempt_id: string;
|
|
76408
|
+
status: 'error';
|
|
76409
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76410
|
+
result: null;
|
|
76411
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
76412
|
+
error: {
|
|
76413
|
+
type: string;
|
|
76414
|
+
message: string;
|
|
76415
|
+
};
|
|
76416
|
+
} | {
|
|
76417
|
+
/** ID of the action attempt. */
|
|
76418
|
+
action_attempt_id: string;
|
|
76419
|
+
status: 'pending';
|
|
76420
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76421
|
+
result: null;
|
|
76422
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76423
|
+
error: null;
|
|
76424
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
76425
|
+
} | {
|
|
76426
|
+
/** ID of the action attempt. */
|
|
76427
|
+
action_attempt_id: string;
|
|
76428
|
+
status: 'success';
|
|
76429
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76430
|
+
error: null;
|
|
76431
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
76432
|
+
result: {
|
|
76433
|
+
access_code?: any;
|
|
76434
|
+
};
|
|
76435
|
+
} | {
|
|
76436
|
+
/** ID of the action attempt. */
|
|
76437
|
+
action_attempt_id: string;
|
|
76438
|
+
status: 'error';
|
|
76439
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76440
|
+
result: null;
|
|
76441
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
76442
|
+
error: {
|
|
76443
|
+
type: string;
|
|
76444
|
+
message: string;
|
|
76445
|
+
};
|
|
76446
|
+
} | {
|
|
76447
|
+
/** ID of the action attempt. */
|
|
76448
|
+
action_attempt_id: string;
|
|
76449
|
+
status: 'pending';
|
|
76450
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76451
|
+
result: null;
|
|
76452
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76453
|
+
error: null;
|
|
76454
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
76455
|
+
} | {
|
|
76456
|
+
/** ID of the action attempt. */
|
|
76457
|
+
action_attempt_id: string;
|
|
76458
|
+
status: 'success';
|
|
76459
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76460
|
+
error: null;
|
|
76461
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
76462
|
+
result: {
|
|
76463
|
+
noise_threshold?: any;
|
|
76464
|
+
};
|
|
76465
|
+
} | {
|
|
76466
|
+
/** ID of the action attempt. */
|
|
76467
|
+
action_attempt_id: string;
|
|
76468
|
+
status: 'error';
|
|
76469
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76470
|
+
result: null;
|
|
76471
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
76472
|
+
error: {
|
|
76473
|
+
type: string;
|
|
76474
|
+
message: string;
|
|
76475
|
+
};
|
|
76476
|
+
} | {
|
|
76477
|
+
/** ID of the action attempt. */
|
|
76478
|
+
action_attempt_id: string;
|
|
76479
|
+
status: 'pending';
|
|
76480
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76481
|
+
result: null;
|
|
76482
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76483
|
+
error: null;
|
|
76484
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
76485
|
+
} | {
|
|
76486
|
+
/** ID of the action attempt. */
|
|
76487
|
+
action_attempt_id: string;
|
|
76488
|
+
status: 'success';
|
|
76489
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76490
|
+
error: null;
|
|
76491
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
76492
|
+
result: {};
|
|
76493
|
+
} | {
|
|
76494
|
+
/** ID of the action attempt. */
|
|
76495
|
+
action_attempt_id: string;
|
|
76496
|
+
status: 'error';
|
|
76497
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76498
|
+
result: null;
|
|
76499
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
76500
|
+
error: {
|
|
76501
|
+
type: string;
|
|
76502
|
+
message: string;
|
|
76503
|
+
};
|
|
76504
|
+
} | {
|
|
76505
|
+
/** ID of the action attempt. */
|
|
76506
|
+
action_attempt_id: string;
|
|
76507
|
+
status: 'pending';
|
|
76508
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76509
|
+
result: null;
|
|
76510
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76511
|
+
error: null;
|
|
76512
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
76513
|
+
} | {
|
|
76514
|
+
/** ID of the action attempt. */
|
|
76515
|
+
action_attempt_id: string;
|
|
76516
|
+
status: 'success';
|
|
76517
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76518
|
+
error: null;
|
|
76519
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
76520
|
+
result: {
|
|
76521
|
+
noise_threshold?: any;
|
|
76522
|
+
};
|
|
76523
|
+
} | {
|
|
76524
|
+
/** ID of the action attempt. */
|
|
76525
|
+
action_attempt_id: string;
|
|
76526
|
+
status: 'error';
|
|
76527
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76528
|
+
result: null;
|
|
76529
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
76530
|
+
error: {
|
|
76531
|
+
type: string;
|
|
76532
|
+
message: string;
|
|
76533
|
+
};
|
|
76534
|
+
};
|
|
76535
|
+
};
|
|
76536
|
+
};
|
|
76537
|
+
'/locks/unlock_door': {
|
|
76538
|
+
route: '/locks/unlock_door';
|
|
76539
|
+
method: 'POST';
|
|
76540
|
+
queryParams: {};
|
|
76541
|
+
jsonBody: {
|
|
76542
|
+
device_id: string;
|
|
76543
|
+
sync?: boolean;
|
|
76544
|
+
};
|
|
76545
|
+
commonParams: {};
|
|
76546
|
+
formData: {};
|
|
76547
|
+
jsonResponse: {
|
|
76548
|
+
/** */
|
|
76549
|
+
action_attempt: {
|
|
76550
|
+
/** ID of the action attempt. */
|
|
76551
|
+
action_attempt_id: string;
|
|
76552
|
+
status: 'pending';
|
|
76553
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76554
|
+
result: null;
|
|
76555
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76556
|
+
error: null;
|
|
76557
|
+
action_type: 'LOCK_DOOR';
|
|
76558
|
+
} | {
|
|
76559
|
+
/** ID of the action attempt. */
|
|
76560
|
+
action_attempt_id: string;
|
|
76561
|
+
status: 'success';
|
|
76562
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76563
|
+
error: null;
|
|
76564
|
+
action_type: 'LOCK_DOOR';
|
|
76565
|
+
result: {};
|
|
76566
|
+
} | {
|
|
76567
|
+
/** ID of the action attempt. */
|
|
76568
|
+
action_attempt_id: string;
|
|
76569
|
+
status: 'error';
|
|
76570
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76571
|
+
result: null;
|
|
76572
|
+
action_type: 'LOCK_DOOR';
|
|
76573
|
+
error: {
|
|
76574
|
+
type: string;
|
|
76575
|
+
message: string;
|
|
76576
|
+
};
|
|
76577
|
+
} | {
|
|
76578
|
+
/** ID of the action attempt. */
|
|
76579
|
+
action_attempt_id: string;
|
|
76580
|
+
status: 'pending';
|
|
76581
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76582
|
+
result: null;
|
|
76583
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76584
|
+
error: null;
|
|
76585
|
+
action_type: 'UNLOCK_DOOR';
|
|
76586
|
+
} | {
|
|
76587
|
+
/** ID of the action attempt. */
|
|
76588
|
+
action_attempt_id: string;
|
|
76589
|
+
status: 'success';
|
|
76590
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76591
|
+
error: null;
|
|
76592
|
+
action_type: 'UNLOCK_DOOR';
|
|
76593
|
+
result: {};
|
|
76594
|
+
} | {
|
|
76595
|
+
/** ID of the action attempt. */
|
|
76596
|
+
action_attempt_id: string;
|
|
76597
|
+
status: 'error';
|
|
76598
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76599
|
+
result: null;
|
|
76600
|
+
action_type: 'UNLOCK_DOOR';
|
|
76601
|
+
error: {
|
|
76602
|
+
type: string;
|
|
76603
|
+
message: string;
|
|
76604
|
+
};
|
|
76605
|
+
} | {
|
|
76606
|
+
/** ID of the action attempt. */
|
|
76607
|
+
action_attempt_id: string;
|
|
76608
|
+
status: 'pending';
|
|
76609
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76610
|
+
result: null;
|
|
76611
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76612
|
+
error: null;
|
|
76613
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
76614
|
+
} | {
|
|
76615
|
+
/** ID of the action attempt. */
|
|
76616
|
+
action_attempt_id: string;
|
|
76617
|
+
status: 'success';
|
|
76618
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76619
|
+
error: null;
|
|
76620
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
76621
|
+
result: {
|
|
76622
|
+
/** Snapshot of credential data read from physical encoder. */
|
|
76623
|
+
acs_credential_on_encoder: {
|
|
76624
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
76625
|
+
created_at: string | null;
|
|
76626
|
+
is_issued: boolean | null;
|
|
76627
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
|
|
76628
|
+
starts_at: string | null;
|
|
76629
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
|
|
76630
|
+
ends_at: string | null;
|
|
76631
|
+
/** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76632
|
+
card_number: string | null;
|
|
76633
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76634
|
+
visionline_metadata?: {
|
|
76635
|
+
/** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76636
|
+
card_id: string;
|
|
76637
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
|
|
76638
|
+
cancelled: boolean;
|
|
76639
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
|
|
76640
|
+
discarded: boolean;
|
|
76641
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
|
|
76642
|
+
expired: boolean;
|
|
76643
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
|
|
76644
|
+
overwritten: boolean;
|
|
76645
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
|
|
76646
|
+
overridden?: boolean | undefined;
|
|
76647
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
|
|
76648
|
+
pending_auto_update: boolean;
|
|
76649
|
+
/** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76650
|
+
card_format: 'TLCode' | 'rfid48';
|
|
76651
|
+
/** Holden of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76652
|
+
card_holder?: string | undefined;
|
|
76653
|
+
/** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76654
|
+
number_of_issued_cards: number;
|
|
76655
|
+
/** IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76656
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
76657
|
+
/** IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76658
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
76659
|
+
} | undefined;
|
|
76660
|
+
} | null;
|
|
76661
|
+
/** Matching acs_credential currently encoded on this card. */
|
|
76662
|
+
acs_credential_on_seam: ({
|
|
76663
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76664
|
+
acs_credential_id: string;
|
|
76665
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
76666
|
+
acs_user_id?: string | undefined;
|
|
76667
|
+
acs_credential_pool_id?: string | undefined;
|
|
76668
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76669
|
+
acs_system_id: string;
|
|
76670
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76671
|
+
parent_acs_credential_id?: string | undefined;
|
|
76672
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
76673
|
+
display_name: string;
|
|
76674
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76675
|
+
code?: (string | undefined) | null;
|
|
76676
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
76677
|
+
is_one_time_use?: boolean | undefined;
|
|
76678
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76679
|
+
card_number?: (string | undefined) | null;
|
|
76680
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
76681
|
+
is_issued?: boolean | undefined;
|
|
76682
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
76683
|
+
issued_at?: (string | undefined) | null;
|
|
76684
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
76685
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
76686
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
76687
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
76688
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
76689
|
+
external_type_display_name?: string | undefined;
|
|
76690
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
76691
|
+
created_at: string;
|
|
76692
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76693
|
+
workspace_id: string;
|
|
76694
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
76695
|
+
starts_at?: string | undefined;
|
|
76696
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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`. */
|
|
76697
|
+
ends_at?: string | undefined;
|
|
76698
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76699
|
+
errors: Array<{
|
|
76700
|
+
error_code: string;
|
|
76701
|
+
message: string;
|
|
76702
|
+
}>;
|
|
76703
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76704
|
+
warnings: Array<{
|
|
76705
|
+
/** Date and time at which Seam created the warning. */
|
|
76706
|
+
created_at: string;
|
|
76707
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76708
|
+
message: string;
|
|
76709
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76710
|
+
warning_code: 'waiting_to_be_issued';
|
|
76711
|
+
} | {
|
|
76712
|
+
/** Date and time at which Seam created the warning. */
|
|
76713
|
+
created_at: string;
|
|
76714
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76715
|
+
message: string;
|
|
76716
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76717
|
+
warning_code: 'schedule_externally_modified';
|
|
76718
|
+
} | {
|
|
76719
|
+
/** Date and time at which Seam created the warning. */
|
|
76720
|
+
created_at: string;
|
|
76721
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76722
|
+
message: string;
|
|
76723
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76724
|
+
warning_code: 'schedule_modified';
|
|
76725
|
+
} | {
|
|
76726
|
+
/** Date and time at which Seam created the warning. */
|
|
76727
|
+
created_at: string;
|
|
76728
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76729
|
+
message: string;
|
|
76730
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76731
|
+
warning_code: 'being_deleted';
|
|
76732
|
+
} | {
|
|
76733
|
+
/** Date and time at which Seam created the warning. */
|
|
76734
|
+
created_at: string;
|
|
76735
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76736
|
+
message: string;
|
|
76737
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76738
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
76739
|
+
} | {
|
|
76740
|
+
/** Date and time at which Seam created the warning. */
|
|
76741
|
+
created_at: string;
|
|
76742
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76743
|
+
message: string;
|
|
76744
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76745
|
+
warning_code: 'needs_to_be_reissued';
|
|
76746
|
+
}>;
|
|
76747
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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). */
|
|
76748
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
76749
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
76750
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
76751
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
76752
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
76753
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76754
|
+
visionline_metadata?: {
|
|
76755
|
+
card_function_type: 'guest' | 'staff';
|
|
76756
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
76757
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
76758
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
76759
|
+
is_valid?: boolean | undefined;
|
|
76760
|
+
auto_join?: boolean | undefined;
|
|
76761
|
+
card_id?: string | undefined;
|
|
76762
|
+
credential_id?: string | undefined;
|
|
76763
|
+
} | undefined;
|
|
76764
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76765
|
+
assa_abloy_vostio_metadata?: {
|
|
76766
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
76767
|
+
key_id?: string | undefined;
|
|
76768
|
+
key_issuing_request_id?: string | undefined;
|
|
76769
|
+
door_names?: string[] | undefined;
|
|
76770
|
+
endpoint_id?: string | undefined;
|
|
76771
|
+
} | undefined;
|
|
76772
|
+
is_managed: true;
|
|
76773
|
+
} | {
|
|
76774
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76775
|
+
acs_credential_id: string;
|
|
76776
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
76777
|
+
acs_user_id?: string | undefined;
|
|
76778
|
+
acs_credential_pool_id?: string | undefined;
|
|
76779
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76780
|
+
acs_system_id: string;
|
|
76781
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76782
|
+
parent_acs_credential_id?: string | undefined;
|
|
76783
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
76784
|
+
display_name: string;
|
|
76785
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76786
|
+
code?: (string | undefined) | null;
|
|
76787
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
76788
|
+
is_one_time_use?: boolean | undefined;
|
|
76789
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76790
|
+
card_number?: (string | undefined) | null;
|
|
76791
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
76792
|
+
is_issued?: boolean | undefined;
|
|
76793
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
76794
|
+
issued_at?: (string | undefined) | null;
|
|
76795
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
76796
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
76797
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
76798
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
76799
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
76800
|
+
external_type_display_name?: string | undefined;
|
|
76801
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
76802
|
+
created_at: string;
|
|
76803
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76804
|
+
workspace_id: string;
|
|
76805
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
76806
|
+
starts_at?: string | undefined;
|
|
76807
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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`. */
|
|
76808
|
+
ends_at?: string | undefined;
|
|
76809
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76810
|
+
errors: Array<{
|
|
76811
|
+
error_code: string;
|
|
76812
|
+
message: string;
|
|
76813
|
+
}>;
|
|
76814
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76815
|
+
warnings: Array<{
|
|
76816
|
+
/** Date and time at which Seam created the warning. */
|
|
76817
|
+
created_at: string;
|
|
76818
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76819
|
+
message: string;
|
|
76820
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76821
|
+
warning_code: 'waiting_to_be_issued';
|
|
76822
|
+
} | {
|
|
76823
|
+
/** Date and time at which Seam created the warning. */
|
|
76824
|
+
created_at: string;
|
|
76825
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76826
|
+
message: string;
|
|
76827
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76828
|
+
warning_code: 'schedule_externally_modified';
|
|
76829
|
+
} | {
|
|
76830
|
+
/** Date and time at which Seam created the warning. */
|
|
76831
|
+
created_at: string;
|
|
76832
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76833
|
+
message: string;
|
|
76834
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76835
|
+
warning_code: 'schedule_modified';
|
|
76836
|
+
} | {
|
|
76837
|
+
/** Date and time at which Seam created the warning. */
|
|
76838
|
+
created_at: string;
|
|
76839
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76840
|
+
message: string;
|
|
76841
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76842
|
+
warning_code: 'being_deleted';
|
|
76843
|
+
} | {
|
|
76844
|
+
/** Date and time at which Seam created the warning. */
|
|
76845
|
+
created_at: string;
|
|
76846
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76847
|
+
message: string;
|
|
76848
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76849
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
76850
|
+
} | {
|
|
76851
|
+
/** Date and time at which Seam created the warning. */
|
|
76852
|
+
created_at: string;
|
|
76853
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76854
|
+
message: string;
|
|
76855
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76856
|
+
warning_code: 'needs_to_be_reissued';
|
|
76857
|
+
}>;
|
|
76858
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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). */
|
|
76859
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
76860
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
76861
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
76862
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
76863
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
76864
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76865
|
+
visionline_metadata?: {
|
|
76866
|
+
card_function_type: 'guest' | 'staff';
|
|
76867
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
76868
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
76869
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
76870
|
+
is_valid?: boolean | undefined;
|
|
76871
|
+
auto_join?: boolean | undefined;
|
|
76872
|
+
card_id?: string | undefined;
|
|
76873
|
+
credential_id?: string | undefined;
|
|
76874
|
+
} | undefined;
|
|
76875
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76876
|
+
assa_abloy_vostio_metadata?: {
|
|
76877
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
76878
|
+
key_id?: string | undefined;
|
|
76879
|
+
key_issuing_request_id?: string | undefined;
|
|
76880
|
+
door_names?: string[] | undefined;
|
|
76881
|
+
endpoint_id?: string | undefined;
|
|
76882
|
+
} | undefined;
|
|
76883
|
+
is_managed: false;
|
|
76884
|
+
}) | null;
|
|
76885
|
+
warnings: Array<{
|
|
76886
|
+
warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
|
|
76887
|
+
warning_message: string;
|
|
76888
|
+
}>;
|
|
76889
|
+
};
|
|
76890
|
+
} | {
|
|
76891
|
+
/** ID of the action attempt. */
|
|
76892
|
+
action_attempt_id: string;
|
|
76893
|
+
status: 'error';
|
|
76894
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
76895
|
+
result: null;
|
|
76896
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
76897
|
+
error: {
|
|
76898
|
+
/** Type of the error associated with the action attempt. */
|
|
76899
|
+
type: 'uncategorized_error';
|
|
76900
|
+
/** Message for the error associated with the action attempt. */
|
|
76901
|
+
message: string;
|
|
76902
|
+
} | {
|
|
76903
|
+
/** Type of the error associated with the action attempt. */
|
|
76904
|
+
type: 'action_attempt_expired';
|
|
76905
|
+
/** Message for the error associated with the action attempt. */
|
|
76906
|
+
message: string;
|
|
76907
|
+
} | {
|
|
76908
|
+
type: 'no_credential_on_encoder';
|
|
76909
|
+
message: string;
|
|
76910
|
+
};
|
|
76911
|
+
} | {
|
|
76912
|
+
/** ID of the action attempt. */
|
|
76913
|
+
action_attempt_id: string;
|
|
76914
|
+
status: 'pending';
|
|
76915
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
76916
|
+
result: null;
|
|
76917
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
76918
|
+
error: null;
|
|
76919
|
+
/** Type of action that the action attempt tracks. */
|
|
76920
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
76921
|
+
} | {
|
|
76922
|
+
/** ID of the action attempt. */
|
|
76923
|
+
action_attempt_id: string;
|
|
76924
|
+
status: 'success';
|
|
76925
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
76926
|
+
error: null;
|
|
76927
|
+
/** Type of action that the action attempt tracks. */
|
|
76928
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
76929
|
+
/** If an encoding attempt was successful, includes the `acs_credential` data that was encoded onto the card. */
|
|
76930
|
+
result: {
|
|
76931
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76932
|
+
acs_credential_id: string;
|
|
76933
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
76934
|
+
acs_user_id?: string | undefined;
|
|
76935
|
+
acs_credential_pool_id?: string | undefined;
|
|
76936
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76937
|
+
acs_system_id: string;
|
|
76938
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76939
|
+
parent_acs_credential_id?: string | undefined;
|
|
76940
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
76941
|
+
display_name: string;
|
|
76942
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76943
|
+
code?: (string | undefined) | null;
|
|
76944
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
76945
|
+
is_one_time_use?: boolean | undefined;
|
|
76946
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76947
|
+
card_number?: (string | undefined) | null;
|
|
76948
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
76949
|
+
is_issued?: boolean | undefined;
|
|
76950
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
76951
|
+
issued_at?: (string | undefined) | null;
|
|
76952
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
76953
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
76954
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
76955
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
76956
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
76957
|
+
external_type_display_name?: string | undefined;
|
|
76958
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
76959
|
+
created_at: string;
|
|
76960
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76961
|
+
workspace_id: string;
|
|
76962
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
76963
|
+
starts_at?: string | undefined;
|
|
76964
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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`. */
|
|
76965
|
+
ends_at?: string | undefined;
|
|
76966
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76967
|
+
errors: Array<{
|
|
76968
|
+
error_code: string;
|
|
76969
|
+
message: string;
|
|
76970
|
+
}>;
|
|
76971
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
76972
|
+
warnings: Array<{
|
|
76973
|
+
/** Date and time at which Seam created the warning. */
|
|
76974
|
+
created_at: string;
|
|
76975
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76976
|
+
message: string;
|
|
76977
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76978
|
+
warning_code: 'waiting_to_be_issued';
|
|
76979
|
+
} | {
|
|
76980
|
+
/** Date and time at which Seam created the warning. */
|
|
76981
|
+
created_at: string;
|
|
76982
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76983
|
+
message: string;
|
|
76984
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76985
|
+
warning_code: 'schedule_externally_modified';
|
|
76986
|
+
} | {
|
|
76987
|
+
/** Date and time at which Seam created the warning. */
|
|
76988
|
+
created_at: string;
|
|
76989
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76990
|
+
message: string;
|
|
76991
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76992
|
+
warning_code: 'schedule_modified';
|
|
76993
|
+
} | {
|
|
76994
|
+
/** Date and time at which Seam created the warning. */
|
|
76995
|
+
created_at: string;
|
|
76996
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
76997
|
+
message: string;
|
|
76998
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
76999
|
+
warning_code: 'being_deleted';
|
|
77000
|
+
} | {
|
|
77001
|
+
/** Date and time at which Seam created the warning. */
|
|
77002
|
+
created_at: string;
|
|
77003
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
77004
|
+
message: string;
|
|
77005
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
77006
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
77007
|
+
} | {
|
|
77008
|
+
/** Date and time at which Seam created the warning. */
|
|
77009
|
+
created_at: string;
|
|
77010
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
77011
|
+
message: string;
|
|
77012
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
77013
|
+
warning_code: 'needs_to_be_reissued';
|
|
77014
|
+
}>;
|
|
77015
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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). */
|
|
77016
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
77017
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
77018
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
77019
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
77020
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
77021
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77022
|
+
visionline_metadata?: {
|
|
77023
|
+
card_function_type: 'guest' | 'staff';
|
|
77024
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
77025
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
77026
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
77027
|
+
is_valid?: boolean | undefined;
|
|
77028
|
+
auto_join?: boolean | undefined;
|
|
77029
|
+
card_id?: string | undefined;
|
|
77030
|
+
credential_id?: string | undefined;
|
|
77031
|
+
} | undefined;
|
|
77032
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77033
|
+
assa_abloy_vostio_metadata?: {
|
|
77034
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
77035
|
+
key_id?: string | undefined;
|
|
77036
|
+
key_issuing_request_id?: string | undefined;
|
|
77037
|
+
door_names?: string[] | undefined;
|
|
77038
|
+
endpoint_id?: string | undefined;
|
|
77039
|
+
} | undefined;
|
|
77040
|
+
is_managed: true;
|
|
77041
|
+
} | {
|
|
77042
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77043
|
+
acs_credential_id: string;
|
|
77044
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
77045
|
+
acs_user_id?: string | undefined;
|
|
77046
|
+
acs_credential_pool_id?: string | undefined;
|
|
77047
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77048
|
+
acs_system_id: string;
|
|
77049
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77050
|
+
parent_acs_credential_id?: string | undefined;
|
|
77051
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
77052
|
+
display_name: string;
|
|
77053
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77054
|
+
code?: (string | undefined) | null;
|
|
77055
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
77056
|
+
is_one_time_use?: boolean | undefined;
|
|
77057
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77058
|
+
card_number?: (string | undefined) | null;
|
|
77059
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
77060
|
+
is_issued?: boolean | undefined;
|
|
77061
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
77062
|
+
issued_at?: (string | undefined) | null;
|
|
77063
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
|
|
77064
|
+
access_method: 'code' | 'card' | 'mobile_key';
|
|
77065
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
77066
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key') | undefined;
|
|
77067
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
77068
|
+
external_type_display_name?: string | undefined;
|
|
77069
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
77070
|
+
created_at: string;
|
|
77071
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77072
|
+
workspace_id: string;
|
|
77073
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
77074
|
+
starts_at?: string | undefined;
|
|
77075
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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`. */
|
|
77076
|
+
ends_at?: string | undefined;
|
|
77077
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77078
|
+
errors: Array<{
|
|
77079
|
+
error_code: string;
|
|
77080
|
+
message: string;
|
|
77081
|
+
}>;
|
|
77082
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77083
|
+
warnings: Array<{
|
|
77084
|
+
/** Date and time at which Seam created the warning. */
|
|
77085
|
+
created_at: string;
|
|
77086
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
77087
|
+
message: string;
|
|
77088
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
77089
|
+
warning_code: 'waiting_to_be_issued';
|
|
77090
|
+
} | {
|
|
77091
|
+
/** Date and time at which Seam created the warning. */
|
|
77092
|
+
created_at: string;
|
|
77093
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
77094
|
+
message: string;
|
|
77095
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
77096
|
+
warning_code: 'schedule_externally_modified';
|
|
77097
|
+
} | {
|
|
77098
|
+
/** Date and time at which Seam created the warning. */
|
|
77099
|
+
created_at: string;
|
|
77100
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
77101
|
+
message: string;
|
|
77102
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
77103
|
+
warning_code: 'schedule_modified';
|
|
77104
|
+
} | {
|
|
77105
|
+
/** Date and time at which Seam created the warning. */
|
|
77106
|
+
created_at: string;
|
|
77107
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
77108
|
+
message: string;
|
|
77109
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
77110
|
+
warning_code: 'being_deleted';
|
|
77111
|
+
} | {
|
|
77112
|
+
/** Date and time at which Seam created the warning. */
|
|
77113
|
+
created_at: string;
|
|
77114
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
77115
|
+
message: string;
|
|
77116
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
77117
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
77118
|
+
} | {
|
|
77119
|
+
/** Date and time at which Seam created the warning. */
|
|
77120
|
+
created_at: string;
|
|
77121
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
77122
|
+
message: string;
|
|
77123
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
77124
|
+
warning_code: 'needs_to_be_reissued';
|
|
77125
|
+
}>;
|
|
77126
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) 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). */
|
|
77127
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
77128
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
77129
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
77130
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
77131
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
77132
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77133
|
+
visionline_metadata?: {
|
|
77134
|
+
card_function_type: 'guest' | 'staff';
|
|
77135
|
+
joiner_acs_credential_ids?: string[] | undefined;
|
|
77136
|
+
guest_acs_entrance_ids?: string[] | undefined;
|
|
77137
|
+
common_acs_entrance_ids?: string[] | undefined;
|
|
77138
|
+
is_valid?: boolean | undefined;
|
|
77139
|
+
auto_join?: boolean | undefined;
|
|
77140
|
+
card_id?: string | undefined;
|
|
77141
|
+
credential_id?: string | undefined;
|
|
77142
|
+
} | undefined;
|
|
77143
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
77144
|
+
assa_abloy_vostio_metadata?: {
|
|
77145
|
+
override_guest_acs_entrance_ids?: string[] | undefined;
|
|
77146
|
+
key_id?: string | undefined;
|
|
77147
|
+
key_issuing_request_id?: string | undefined;
|
|
77148
|
+
door_names?: string[] | undefined;
|
|
77149
|
+
endpoint_id?: string | undefined;
|
|
77150
|
+
} | undefined;
|
|
77151
|
+
is_managed: false;
|
|
77152
|
+
};
|
|
77153
|
+
} | {
|
|
77154
|
+
/** ID of the action attempt. */
|
|
77155
|
+
action_attempt_id: string;
|
|
77156
|
+
status: 'error';
|
|
77157
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77158
|
+
result: null;
|
|
77159
|
+
/** Type of action that the action attempt tracks. */
|
|
77160
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
77161
|
+
error: {
|
|
77162
|
+
/** Type of the error associated with the action attempt. */
|
|
77163
|
+
type: 'uncategorized_error';
|
|
77164
|
+
/** Message for the error associated with the action attempt. */
|
|
77165
|
+
message: string;
|
|
77166
|
+
} | {
|
|
77167
|
+
/** Type of the error associated with the action attempt. */
|
|
77168
|
+
type: 'action_attempt_expired';
|
|
77169
|
+
/** Message for the error associated with the action attempt. */
|
|
77170
|
+
message: string;
|
|
77171
|
+
} | {
|
|
77172
|
+
type: 'no_credential_on_encoder';
|
|
77173
|
+
message: string;
|
|
77174
|
+
} | {
|
|
77175
|
+
type: 'incompatible_card_format';
|
|
77176
|
+
message: string;
|
|
77177
|
+
} | {
|
|
77178
|
+
type: 'credential_cannot_be_reissued';
|
|
77179
|
+
message: string;
|
|
77180
|
+
};
|
|
77181
|
+
} | {
|
|
77182
|
+
/** ID of the action attempt. */
|
|
77183
|
+
action_attempt_id: string;
|
|
77184
|
+
status: 'pending';
|
|
77185
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77186
|
+
result: null;
|
|
77187
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77188
|
+
error: null;
|
|
77189
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
77190
|
+
} | {
|
|
77191
|
+
/** ID of the action attempt. */
|
|
77192
|
+
action_attempt_id: string;
|
|
77193
|
+
status: 'success';
|
|
77194
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77195
|
+
error: null;
|
|
77196
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
77197
|
+
result: {};
|
|
77198
|
+
} | {
|
|
77199
|
+
/** ID of the action attempt. */
|
|
77200
|
+
action_attempt_id: string;
|
|
77201
|
+
status: 'error';
|
|
77202
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77203
|
+
result: null;
|
|
77204
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
77205
|
+
error: {
|
|
77206
|
+
type: string;
|
|
77207
|
+
message: string;
|
|
77208
|
+
};
|
|
77209
|
+
} | {
|
|
77210
|
+
/** ID of the action attempt. */
|
|
77211
|
+
action_attempt_id: string;
|
|
77212
|
+
status: 'pending';
|
|
77213
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77214
|
+
result: null;
|
|
77215
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77216
|
+
error: null;
|
|
77217
|
+
action_type: 'SET_FAN_MODE';
|
|
77218
|
+
} | {
|
|
77219
|
+
/** ID of the action attempt. */
|
|
77220
|
+
action_attempt_id: string;
|
|
77221
|
+
status: 'success';
|
|
77222
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77223
|
+
error: null;
|
|
77224
|
+
action_type: 'SET_FAN_MODE';
|
|
77225
|
+
result: {};
|
|
77226
|
+
} | {
|
|
77227
|
+
/** ID of the action attempt. */
|
|
77228
|
+
action_attempt_id: string;
|
|
77229
|
+
status: 'error';
|
|
77230
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77231
|
+
result: null;
|
|
77232
|
+
action_type: 'SET_FAN_MODE';
|
|
77233
|
+
error: {
|
|
77234
|
+
type: string;
|
|
77235
|
+
message: string;
|
|
77236
|
+
};
|
|
77237
|
+
} | {
|
|
77238
|
+
/** ID of the action attempt. */
|
|
77239
|
+
action_attempt_id: string;
|
|
77240
|
+
status: 'pending';
|
|
77241
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77242
|
+
result: null;
|
|
77243
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77244
|
+
error: null;
|
|
77245
|
+
action_type: 'SET_HVAC_MODE';
|
|
77246
|
+
} | {
|
|
77247
|
+
/** ID of the action attempt. */
|
|
77248
|
+
action_attempt_id: string;
|
|
77249
|
+
status: 'success';
|
|
77250
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77251
|
+
error: null;
|
|
77252
|
+
action_type: 'SET_HVAC_MODE';
|
|
77253
|
+
result: {};
|
|
77254
|
+
} | {
|
|
77255
|
+
/** ID of the action attempt. */
|
|
77256
|
+
action_attempt_id: string;
|
|
77257
|
+
status: 'error';
|
|
77258
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77259
|
+
result: null;
|
|
77260
|
+
action_type: 'SET_HVAC_MODE';
|
|
77261
|
+
error: {
|
|
77262
|
+
type: string;
|
|
77263
|
+
message: string;
|
|
77264
|
+
};
|
|
77265
|
+
} | {
|
|
77266
|
+
/** ID of the action attempt. */
|
|
77267
|
+
action_attempt_id: string;
|
|
77268
|
+
status: 'pending';
|
|
77269
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77270
|
+
result: null;
|
|
77271
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77272
|
+
error: null;
|
|
77273
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
77274
|
+
} | {
|
|
77275
|
+
/** ID of the action attempt. */
|
|
77276
|
+
action_attempt_id: string;
|
|
77277
|
+
status: 'success';
|
|
77278
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77279
|
+
error: null;
|
|
77280
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
77281
|
+
result: {};
|
|
77282
|
+
} | {
|
|
77283
|
+
/** ID of the action attempt. */
|
|
77284
|
+
action_attempt_id: string;
|
|
77285
|
+
status: 'error';
|
|
77286
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77287
|
+
result: null;
|
|
77288
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
77289
|
+
error: {
|
|
77290
|
+
type: string;
|
|
77291
|
+
message: string;
|
|
77292
|
+
};
|
|
77293
|
+
} | {
|
|
77294
|
+
/** ID of the action attempt. */
|
|
77295
|
+
action_attempt_id: string;
|
|
77296
|
+
status: 'pending';
|
|
77297
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77298
|
+
result: null;
|
|
77299
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77300
|
+
error: null;
|
|
77301
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
77302
|
+
} | {
|
|
77303
|
+
/** ID of the action attempt. */
|
|
77304
|
+
action_attempt_id: string;
|
|
77305
|
+
status: 'success';
|
|
77306
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77307
|
+
error: null;
|
|
77308
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
77309
|
+
result: {};
|
|
77310
|
+
} | {
|
|
77311
|
+
/** ID of the action attempt. */
|
|
77312
|
+
action_attempt_id: string;
|
|
77313
|
+
status: 'error';
|
|
77314
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77315
|
+
result: null;
|
|
77316
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
77317
|
+
error: {
|
|
77318
|
+
type: string;
|
|
77319
|
+
message: string;
|
|
77320
|
+
};
|
|
77321
|
+
} | {
|
|
77322
|
+
/** ID of the action attempt. */
|
|
77323
|
+
action_attempt_id: string;
|
|
77324
|
+
status: 'pending';
|
|
77325
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77326
|
+
result: null;
|
|
77327
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77328
|
+
error: null;
|
|
77329
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
77330
|
+
} | {
|
|
77331
|
+
/** ID of the action attempt. */
|
|
77332
|
+
action_attempt_id: string;
|
|
77333
|
+
status: 'success';
|
|
77334
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77335
|
+
error: null;
|
|
77336
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
77337
|
+
result: {};
|
|
77338
|
+
} | {
|
|
77339
|
+
/** ID of the action attempt. */
|
|
77340
|
+
action_attempt_id: string;
|
|
77341
|
+
status: 'error';
|
|
77342
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77343
|
+
result: null;
|
|
77344
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
77345
|
+
error: {
|
|
77346
|
+
type: string;
|
|
77347
|
+
message: string;
|
|
77348
|
+
};
|
|
77349
|
+
} | {
|
|
77350
|
+
/** ID of the action attempt. */
|
|
77351
|
+
action_attempt_id: string;
|
|
77352
|
+
status: 'pending';
|
|
77353
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77354
|
+
result: null;
|
|
77355
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77356
|
+
error: null;
|
|
77357
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
77358
|
+
} | {
|
|
77359
|
+
/** ID of the action attempt. */
|
|
77360
|
+
action_attempt_id: string;
|
|
77361
|
+
status: 'success';
|
|
77362
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77363
|
+
error: null;
|
|
77364
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
77365
|
+
result: {};
|
|
77366
|
+
} | {
|
|
77367
|
+
/** ID of the action attempt. */
|
|
77368
|
+
action_attempt_id: string;
|
|
77369
|
+
status: 'error';
|
|
77370
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77371
|
+
result: null;
|
|
77372
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
77373
|
+
error: {
|
|
77374
|
+
type: string;
|
|
77375
|
+
message: string;
|
|
77376
|
+
};
|
|
77377
|
+
} | {
|
|
77378
|
+
/** ID of the action attempt. */
|
|
77379
|
+
action_attempt_id: string;
|
|
77380
|
+
status: 'pending';
|
|
77381
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77382
|
+
result: null;
|
|
77383
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77384
|
+
error: null;
|
|
77385
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
77386
|
+
} | {
|
|
77387
|
+
/** ID of the action attempt. */
|
|
77388
|
+
action_attempt_id: string;
|
|
77389
|
+
status: 'success';
|
|
77390
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77391
|
+
error: null;
|
|
77392
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
77393
|
+
result: {
|
|
77394
|
+
access_code?: any;
|
|
77395
|
+
};
|
|
77396
|
+
} | {
|
|
77397
|
+
/** ID of the action attempt. */
|
|
77398
|
+
action_attempt_id: string;
|
|
77399
|
+
status: 'error';
|
|
77400
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77401
|
+
result: null;
|
|
77402
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
77403
|
+
error: {
|
|
77404
|
+
type: string;
|
|
77405
|
+
message: string;
|
|
77406
|
+
};
|
|
77407
|
+
} | {
|
|
77408
|
+
/** ID of the action attempt. */
|
|
77409
|
+
action_attempt_id: string;
|
|
77410
|
+
status: 'pending';
|
|
77411
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77412
|
+
result: null;
|
|
77413
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77414
|
+
error: null;
|
|
77415
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
77416
|
+
} | {
|
|
77417
|
+
/** ID of the action attempt. */
|
|
77418
|
+
action_attempt_id: string;
|
|
77419
|
+
status: 'success';
|
|
77420
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77421
|
+
error: null;
|
|
77422
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
77423
|
+
result: {};
|
|
77424
|
+
} | {
|
|
77425
|
+
/** ID of the action attempt. */
|
|
77426
|
+
action_attempt_id: string;
|
|
77427
|
+
status: 'error';
|
|
77428
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77429
|
+
result: null;
|
|
77430
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
77431
|
+
error: {
|
|
77432
|
+
type: string;
|
|
77433
|
+
message: string;
|
|
77434
|
+
};
|
|
77435
|
+
} | {
|
|
77436
|
+
/** ID of the action attempt. */
|
|
77437
|
+
action_attempt_id: string;
|
|
77438
|
+
status: 'pending';
|
|
77439
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77440
|
+
result: null;
|
|
77441
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77442
|
+
error: null;
|
|
77443
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
77444
|
+
} | {
|
|
77445
|
+
/** ID of the action attempt. */
|
|
77446
|
+
action_attempt_id: string;
|
|
77447
|
+
status: 'success';
|
|
77448
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77449
|
+
error: null;
|
|
77450
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
77451
|
+
result: {
|
|
77452
|
+
access_code?: any;
|
|
77453
|
+
};
|
|
77454
|
+
} | {
|
|
77455
|
+
/** ID of the action attempt. */
|
|
77456
|
+
action_attempt_id: string;
|
|
77457
|
+
status: 'error';
|
|
77458
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77459
|
+
result: null;
|
|
77460
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
77461
|
+
error: {
|
|
77462
|
+
type: string;
|
|
77463
|
+
message: string;
|
|
77464
|
+
};
|
|
77465
|
+
} | {
|
|
77466
|
+
/** ID of the action attempt. */
|
|
77467
|
+
action_attempt_id: string;
|
|
77468
|
+
status: 'pending';
|
|
77469
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77470
|
+
result: null;
|
|
77471
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77472
|
+
error: null;
|
|
77473
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
77474
|
+
} | {
|
|
77475
|
+
/** ID of the action attempt. */
|
|
77476
|
+
action_attempt_id: string;
|
|
77477
|
+
status: 'success';
|
|
77478
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77479
|
+
error: null;
|
|
77480
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
77481
|
+
result: {
|
|
77482
|
+
noise_threshold?: any;
|
|
77483
|
+
};
|
|
77484
|
+
} | {
|
|
77485
|
+
/** ID of the action attempt. */
|
|
77486
|
+
action_attempt_id: string;
|
|
77487
|
+
status: 'error';
|
|
77488
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77489
|
+
result: null;
|
|
77490
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
77491
|
+
error: {
|
|
77492
|
+
type: string;
|
|
77493
|
+
message: string;
|
|
77494
|
+
};
|
|
77495
|
+
} | {
|
|
77496
|
+
/** ID of the action attempt. */
|
|
77497
|
+
action_attempt_id: string;
|
|
77498
|
+
status: 'pending';
|
|
77499
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77500
|
+
result: null;
|
|
77501
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77502
|
+
error: null;
|
|
77503
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
77504
|
+
} | {
|
|
77505
|
+
/** ID of the action attempt. */
|
|
77506
|
+
action_attempt_id: string;
|
|
77507
|
+
status: 'success';
|
|
77508
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77509
|
+
error: null;
|
|
77510
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
77511
|
+
result: {};
|
|
77512
|
+
} | {
|
|
77513
|
+
/** ID of the action attempt. */
|
|
77514
|
+
action_attempt_id: string;
|
|
77515
|
+
status: 'error';
|
|
77516
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77517
|
+
result: null;
|
|
77518
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
77519
|
+
error: {
|
|
77520
|
+
type: string;
|
|
77521
|
+
message: string;
|
|
77522
|
+
};
|
|
77523
|
+
} | {
|
|
77524
|
+
/** ID of the action attempt. */
|
|
77525
|
+
action_attempt_id: string;
|
|
77526
|
+
status: 'pending';
|
|
77527
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77528
|
+
result: null;
|
|
77529
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77530
|
+
error: null;
|
|
77531
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
77532
|
+
} | {
|
|
77533
|
+
/** ID of the action attempt. */
|
|
77534
|
+
action_attempt_id: string;
|
|
77535
|
+
status: 'success';
|
|
77536
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77537
|
+
error: null;
|
|
77538
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
77539
|
+
result: {
|
|
77540
|
+
noise_threshold?: any;
|
|
77541
|
+
};
|
|
77542
|
+
} | {
|
|
77543
|
+
/** ID of the action attempt. */
|
|
77544
|
+
action_attempt_id: string;
|
|
77545
|
+
status: 'error';
|
|
77546
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77547
|
+
result: null;
|
|
77548
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
77549
|
+
error: {
|
|
77550
|
+
type: string;
|
|
77551
|
+
message: string;
|
|
77552
|
+
};
|
|
77553
|
+
};
|
|
77554
|
+
};
|
|
77555
|
+
};
|
|
77556
|
+
'/networks/get': {
|
|
77557
|
+
route: '/networks/get';
|
|
77558
|
+
method: 'GET' | 'POST';
|
|
77559
|
+
queryParams: {};
|
|
77560
|
+
jsonBody: {};
|
|
77561
|
+
commonParams: {
|
|
77562
|
+
network_id: string;
|
|
77563
|
+
};
|
|
77564
|
+
formData: {};
|
|
77565
|
+
jsonResponse: {
|
|
77566
|
+
/** */
|
|
77567
|
+
network: {
|
|
77568
|
+
network_id: string;
|
|
77569
|
+
workspace_id: string;
|
|
77570
|
+
display_name: string;
|
|
77571
|
+
created_at: string;
|
|
77572
|
+
};
|
|
77573
|
+
};
|
|
77574
|
+
};
|
|
77575
|
+
'/networks/list': {
|
|
77576
|
+
route: '/networks/list';
|
|
77577
|
+
method: 'GET' | 'POST';
|
|
77578
|
+
queryParams: {};
|
|
77579
|
+
jsonBody: {};
|
|
77580
|
+
commonParams: {};
|
|
77581
|
+
formData: {};
|
|
77582
|
+
jsonResponse: {
|
|
77583
|
+
networks: Array<{
|
|
77584
|
+
network_id: string;
|
|
77585
|
+
workspace_id: string;
|
|
77586
|
+
display_name: string;
|
|
77587
|
+
created_at: string;
|
|
77588
|
+
}>;
|
|
77589
|
+
};
|
|
77590
|
+
};
|
|
77591
|
+
'/noise_sensors/list': {
|
|
77592
|
+
route: '/noise_sensors/list';
|
|
77593
|
+
method: 'GET' | 'POST';
|
|
77594
|
+
queryParams: {};
|
|
77595
|
+
jsonBody: {};
|
|
77596
|
+
commonParams: {
|
|
77597
|
+
/** ID of the connected account by which to filter. */
|
|
77598
|
+
connected_account_id?: string | undefined;
|
|
77599
|
+
/** Array of IDs of the connected accounts by which to filter devices. */
|
|
77600
|
+
connected_account_ids?: string[] | undefined;
|
|
77601
|
+
/** ID of the Connect Webview by which to filter devices. */
|
|
77602
|
+
connect_webview_id?: string | undefined;
|
|
77603
|
+
/** Device type by which to filter devices. */
|
|
77604
|
+
device_type?: ('noiseaware_activity_zone' | 'minut_sensor') | undefined;
|
|
77605
|
+
/** Array of device types by which to filter devices. */
|
|
77606
|
+
device_types?: Array<'noiseaware_activity_zone' | 'minut_sensor'> | undefined;
|
|
77607
|
+
/** Manufacturer by which to filter devices. */
|
|
77608
|
+
manufacturer?: ('noiseaware' | 'minut') | undefined;
|
|
77609
|
+
/** Array of device IDs by which to filter devices. */
|
|
77610
|
+
device_ids?: string[] | undefined;
|
|
77611
|
+
/** Numerical limit on the number of devices to return. */
|
|
77612
|
+
limit?: number;
|
|
77613
|
+
/** Date threshold for devices to return. If specified, returns only devices created before the specified date. */
|
|
77614
|
+
created_before?: Date | undefined;
|
|
77615
|
+
/** Your own internal user ID for the user by which to filter devices. */
|
|
77616
|
+
user_identifier_key?: string | undefined;
|
|
77617
|
+
/** Set of key:value [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) pairs by which you want to filter devices. */
|
|
77618
|
+
custom_metadata_has?: Record<string, string | boolean> | undefined;
|
|
77619
|
+
/** */
|
|
77620
|
+
include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
77621
|
+
/** */
|
|
77622
|
+
exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
|
|
77623
|
+
/** */
|
|
77624
|
+
unstable_location_id?: (string | null) | undefined;
|
|
77625
|
+
};
|
|
77626
|
+
formData: {};
|
|
77627
|
+
jsonResponse: {
|
|
77628
|
+
noise_sensors: Array<{
|
|
77629
|
+
/** Unique identifier for the device. */
|
|
77630
|
+
device_id: string;
|
|
77631
|
+
/** Type of the device. */
|
|
77632
|
+
device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat') | ('ios_phone' | 'android_phone');
|
|
77633
|
+
/** Optional nickname to describe the device, settable through Seam */
|
|
77634
|
+
nickname?: string | undefined;
|
|
77635
|
+
/** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
77636
|
+
display_name: string;
|
|
77637
|
+
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
77638
|
+
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
77639
|
+
/** Properties of the device. */
|
|
77640
|
+
properties: (({
|
|
77641
|
+
/** Indicates whether the device is online. */
|
|
77642
|
+
online: boolean;
|
|
77643
|
+
/** Name of the device.
|
|
77644
|
+
* @deprecated use device.display_name instead */
|
|
77645
|
+
name: string;
|
|
77646
|
+
/** Represents the accessory keypad state. */
|
|
77647
|
+
accessory_keypad?: {
|
|
77648
|
+
/** Indicates if the accessory_keypad is connected to the device. */
|
|
77649
|
+
is_connected: boolean;
|
|
77650
|
+
/** Indicates if the keypad battery properties. */
|
|
77651
|
+
battery?: {
|
|
77652
|
+
level: number;
|
|
77653
|
+
} | undefined;
|
|
77654
|
+
} | undefined;
|
|
77655
|
+
appearance: {
|
|
77656
|
+
/** Name of the device as seen from the provider API and application, not settable through Seam. */
|
|
77657
|
+
name: string;
|
|
77658
|
+
};
|
|
77659
|
+
model: {
|
|
77660
|
+
/** Indicates whether the device can connect a accessory keypad. */
|
|
77661
|
+
can_connect_accessory_keypad?: boolean | undefined;
|
|
77662
|
+
/** Display name of the device model. */
|
|
77663
|
+
display_name: string;
|
|
77664
|
+
/** Display name that corresponds to the manufacturer-specific terminology for the device. */
|
|
77665
|
+
manufacturer_display_name: string;
|
|
77666
|
+
/** Indicates whether the device has a built in accessory keypad. */
|
|
77667
|
+
has_built_in_keypad?: boolean | undefined;
|
|
77668
|
+
/** Indicates whether the device supports offline access codes. */
|
|
77669
|
+
offline_access_codes_supported?: boolean | undefined;
|
|
77670
|
+
/** Indicates whether the device supports online access codes. */
|
|
77671
|
+
online_access_codes_supported?: boolean | undefined;
|
|
77672
|
+
/**
|
|
77673
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
77674
|
+
accessory_keypad_supported?: boolean | undefined;
|
|
77675
|
+
};
|
|
77676
|
+
/** Indicates whether the device has direct power. */
|
|
77677
|
+
has_direct_power?: boolean | undefined;
|
|
77678
|
+
/** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
|
|
77679
|
+
battery_level?: number | undefined;
|
|
77680
|
+
/** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
|
|
77681
|
+
battery?: {
|
|
77682
|
+
level: number;
|
|
77683
|
+
status: 'critical' | 'low' | 'good' | 'full';
|
|
77684
|
+
} | undefined;
|
|
77685
|
+
/** Manufacturer of the device. */
|
|
77686
|
+
manufacturer?: string | undefined;
|
|
77687
|
+
/** Image URL for the device. */
|
|
77688
|
+
image_url?: string | undefined;
|
|
77689
|
+
/** Alt text for the device image. */
|
|
77690
|
+
image_alt_text?: string | undefined;
|
|
77691
|
+
/** Serial number of the device. */
|
|
77692
|
+
serial_number?: string | undefined;
|
|
77693
|
+
/** Indicates whether it is currently possible to use online access codes for the device. */
|
|
77694
|
+
online_access_codes_enabled?: boolean | undefined;
|
|
77695
|
+
/** Indicates whether it is currently possible to use offline access codes for the device. */
|
|
77696
|
+
offline_access_codes_enabled?: boolean | undefined;
|
|
77697
|
+
/**
|
|
77698
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
77699
|
+
supports_accessory_keypad?: boolean | undefined;
|
|
77700
|
+
/**
|
|
77701
|
+
* @deprecated use offline_access_codes_enabled */
|
|
77702
|
+
supports_offline_access_codes?: boolean | undefined;
|
|
77703
|
+
/** Indicates current noise level in decibels, if the device supports noise detection. */
|
|
77704
|
+
noise_level_decibels?: number | undefined;
|
|
77705
|
+
/** Array of noise threshold IDs that are currently triggering. */
|
|
77706
|
+
currently_triggering_noise_threshold_ids?: string[] | undefined;
|
|
77707
|
+
} & {
|
|
77708
|
+
/** ASSA ABLOY Credential Service metadata for the phone. */
|
|
77709
|
+
assa_abloy_credential_service_metadata?: ({
|
|
77710
|
+
/** Indicates whether the credential service has active endpoints associated with the phone. */
|
|
77711
|
+
has_active_endpoint: boolean;
|
|
77712
|
+
/** Endpoints associated with the phone. */
|
|
77713
|
+
endpoints: Array<{
|
|
77714
|
+
/** ID of the associated endpoint. */
|
|
77715
|
+
endpoint_id: string;
|
|
77716
|
+
/** Indicated whether the endpoint is active. */
|
|
77717
|
+
is_active: boolean;
|
|
77718
|
+
}>;
|
|
77719
|
+
} | undefined) | undefined;
|
|
77720
|
+
/** Salto Space credential service metadata for the phone. */
|
|
77721
|
+
salto_space_credential_service_metadata?: ({
|
|
77722
|
+
/** Indicates whether the credential service has an active associated phone. */
|
|
77723
|
+
has_active_phone: boolean;
|
|
77724
|
+
} | undefined) | undefined;
|
|
77725
|
+
}) & {
|
|
77726
|
+
august_metadata?: {
|
|
77727
|
+
lock_id: string;
|
|
77728
|
+
lock_name: string;
|
|
77729
|
+
house_name: string;
|
|
77730
|
+
has_keypad: boolean;
|
|
77731
|
+
keypad_battery_level?: string | undefined;
|
|
77732
|
+
model?: string | undefined;
|
|
77733
|
+
house_id?: string | undefined;
|
|
77734
|
+
} | undefined;
|
|
75485
77735
|
avigilon_alta_metadata?: {
|
|
75486
77736
|
entry_name: string;
|
|
75487
77737
|
org_name: string;
|
|
@@ -90598,6 +92848,8 @@ interface Routes {
|
|
|
90598
92848
|
commonParams: {
|
|
90599
92849
|
/** ID of the user identity for which you want to generate an instant key. */
|
|
90600
92850
|
user_identity_id: string;
|
|
92851
|
+
/** The maximum number of times the instant key can be used. Defaults to 1. */
|
|
92852
|
+
max_use_count?: number;
|
|
90601
92853
|
};
|
|
90602
92854
|
formData: {};
|
|
90603
92855
|
jsonResponse: {
|
|
@@ -92550,10 +94802,24 @@ interface Routes {
|
|
|
92550
94802
|
* @deprecated use company_name */
|
|
92551
94803
|
connect_partner_name?: ((string | null) | null) | undefined;
|
|
92552
94804
|
is_sandbox?: boolean;
|
|
94805
|
+
/**
|
|
94806
|
+
* @deprecated Use `connect_webview_customization.webview_primary_button_color` instead. */
|
|
92553
94807
|
webview_primary_button_color?: string | undefined;
|
|
94808
|
+
/**
|
|
94809
|
+
* @deprecated Use `connect_webview_customization.webview_primary_button_text_color` instead. */
|
|
92554
94810
|
webview_primary_button_text_color?: string | undefined;
|
|
94811
|
+
/**
|
|
94812
|
+
* @deprecated Use `connect_webview_customization.webview_logo_shape` instead. */
|
|
92555
94813
|
webview_logo_shape?: ('circle' | 'square') | undefined;
|
|
94814
|
+
/**
|
|
94815
|
+
* @deprecated Use `connect_webview_customization.webview_success_message` instead. */
|
|
92556
94816
|
webview_success_message?: string | undefined;
|
|
94817
|
+
connect_webview_customization?: {
|
|
94818
|
+
primary_button_color?: (string | null) | undefined;
|
|
94819
|
+
primary_button_text_color?: (string | null) | undefined;
|
|
94820
|
+
success_message?: (string | null) | undefined;
|
|
94821
|
+
logo_shape?: (('circle' | 'square') | null) | undefined;
|
|
94822
|
+
} | undefined;
|
|
92557
94823
|
};
|
|
92558
94824
|
commonParams: {};
|
|
92559
94825
|
formData: {};
|
|
@@ -92564,6 +94830,13 @@ interface Routes {
|
|
|
92564
94830
|
name: string;
|
|
92565
94831
|
company_name: string;
|
|
92566
94832
|
is_sandbox: boolean;
|
|
94833
|
+
connect_webview_customization: {
|
|
94834
|
+
primary_button_color?: string | undefined;
|
|
94835
|
+
primary_button_text_color?: string | undefined;
|
|
94836
|
+
success_message?: string | undefined;
|
|
94837
|
+
logo_shape?: ('circle' | 'square') | undefined;
|
|
94838
|
+
inviter_logo_url?: string | undefined;
|
|
94839
|
+
};
|
|
92567
94840
|
/** True if a sandbox workspace has not been accessed in 14 days */
|
|
92568
94841
|
is_suspended: boolean;
|
|
92569
94842
|
/**
|
|
@@ -92586,6 +94859,13 @@ interface Routes {
|
|
|
92586
94859
|
name: string;
|
|
92587
94860
|
company_name: string;
|
|
92588
94861
|
is_sandbox: boolean;
|
|
94862
|
+
connect_webview_customization: {
|
|
94863
|
+
primary_button_color?: string | undefined;
|
|
94864
|
+
primary_button_text_color?: string | undefined;
|
|
94865
|
+
success_message?: string | undefined;
|
|
94866
|
+
logo_shape?: ('circle' | 'square') | undefined;
|
|
94867
|
+
inviter_logo_url?: string | undefined;
|
|
94868
|
+
};
|
|
92589
94869
|
/** True if a sandbox workspace has not been accessed in 14 days */
|
|
92590
94870
|
is_suspended: boolean;
|
|
92591
94871
|
/**
|
|
@@ -92607,6 +94887,13 @@ interface Routes {
|
|
|
92607
94887
|
name: string;
|
|
92608
94888
|
company_name: string;
|
|
92609
94889
|
is_sandbox: boolean;
|
|
94890
|
+
connect_webview_customization: {
|
|
94891
|
+
primary_button_color?: string | undefined;
|
|
94892
|
+
primary_button_text_color?: string | undefined;
|
|
94893
|
+
success_message?: string | undefined;
|
|
94894
|
+
logo_shape?: ('circle' | 'square') | undefined;
|
|
94895
|
+
inviter_logo_url?: string | undefined;
|
|
94896
|
+
};
|
|
92610
94897
|
/** True if a sandbox workspace has not been accessed in 14 days */
|
|
92611
94898
|
is_suspended: boolean;
|
|
92612
94899
|
/**
|
|
@@ -93631,6 +95918,25 @@ interface Routes {
|
|
|
93631
95918
|
};
|
|
93632
95919
|
};
|
|
93633
95920
|
};
|
|
95921
|
+
'/workspaces/update': {
|
|
95922
|
+
route: '/workspaces/update';
|
|
95923
|
+
method: 'POST' | 'PATCH';
|
|
95924
|
+
queryParams: {};
|
|
95925
|
+
jsonBody: {
|
|
95926
|
+
name?: string | undefined;
|
|
95927
|
+
connect_partner_name?: string | undefined;
|
|
95928
|
+
connect_webview_customization?: {
|
|
95929
|
+
primary_button_color?: (string | null) | undefined;
|
|
95930
|
+
primary_button_text_color?: (string | null) | undefined;
|
|
95931
|
+
success_message?: (string | null) | undefined;
|
|
95932
|
+
logo_shape?: (('circle' | 'square') | null) | undefined;
|
|
95933
|
+
} | undefined;
|
|
95934
|
+
is_suspended?: boolean | undefined;
|
|
95935
|
+
};
|
|
95936
|
+
commonParams: {};
|
|
95937
|
+
formData: {};
|
|
95938
|
+
jsonResponse: {};
|
|
95939
|
+
};
|
|
93634
95940
|
}
|
|
93635
95941
|
type RouteResponse<Path extends keyof Routes> = Routes[Path]['jsonResponse'];
|
|
93636
95942
|
type RouteRequestBody<Path extends keyof Routes> = Routes[Path]['jsonBody'] & Routes[Path]['commonParams'];
|