@seamapi/types 1.345.1 → 1.345.2
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 +262 -689
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +149 -482
- package/lib/seam/connect/models/devices/device-type.js +3 -1
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/phone-properties.js +7 -3
- package/lib/seam/connect/models/devices/phone-properties.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +29 -2450
- package/lib/seam/connect/models/devices/phone.js +36 -15
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +104 -141
- package/lib/seam/connect/openapi.js +70 -495
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +45 -341
- package/package.json +2 -2
- package/src/lib/seam/connect/models/devices/device-type.ts +3 -3
- package/src/lib/seam/connect/models/devices/phone-properties.ts +36 -32
- package/src/lib/seam/connect/models/devices/phone.ts +53 -15
- package/src/lib/seam/connect/openapi.ts +254 -717
- package/src/lib/seam/connect/route-types.ts +45 -419
package/dist/connect.d.cts
CHANGED
|
@@ -19119,10 +19119,15 @@ declare const _default: {
|
|
|
19119
19119
|
};
|
|
19120
19120
|
device_type: {
|
|
19121
19121
|
description: string;
|
|
19122
|
-
oneOf: {
|
|
19122
|
+
oneOf: ({
|
|
19123
19123
|
enum: string[];
|
|
19124
19124
|
type: string;
|
|
19125
|
-
|
|
19125
|
+
description?: never;
|
|
19126
|
+
} | {
|
|
19127
|
+
description: string;
|
|
19128
|
+
enum: string[];
|
|
19129
|
+
type: string;
|
|
19130
|
+
})[];
|
|
19126
19131
|
};
|
|
19127
19132
|
display_name: {
|
|
19128
19133
|
description: string;
|
|
@@ -19364,7 +19369,9 @@ declare const _default: {
|
|
|
19364
19369
|
};
|
|
19365
19370
|
required: string[];
|
|
19366
19371
|
type: string;
|
|
19372
|
+
description?: never;
|
|
19367
19373
|
} | {
|
|
19374
|
+
description: string;
|
|
19368
19375
|
properties: {
|
|
19369
19376
|
assa_abloy_credential_service_metadata: {
|
|
19370
19377
|
description: string;
|
|
@@ -23370,47 +23377,6 @@ declare const _default: {
|
|
|
23370
23377
|
phone: {
|
|
23371
23378
|
description: string;
|
|
23372
23379
|
properties: {
|
|
23373
|
-
can_hvac_cool: {
|
|
23374
|
-
type: string;
|
|
23375
|
-
};
|
|
23376
|
-
can_hvac_heat: {
|
|
23377
|
-
type: string;
|
|
23378
|
-
};
|
|
23379
|
-
can_hvac_heat_cool: {
|
|
23380
|
-
type: string;
|
|
23381
|
-
};
|
|
23382
|
-
can_program_offline_access_codes: {
|
|
23383
|
-
type: string;
|
|
23384
|
-
};
|
|
23385
|
-
can_program_online_access_codes: {
|
|
23386
|
-
type: string;
|
|
23387
|
-
};
|
|
23388
|
-
can_remotely_lock: {
|
|
23389
|
-
type: string;
|
|
23390
|
-
};
|
|
23391
|
-
can_remotely_unlock: {
|
|
23392
|
-
type: string;
|
|
23393
|
-
};
|
|
23394
|
-
can_simulate_connection: {
|
|
23395
|
-
type: string;
|
|
23396
|
-
};
|
|
23397
|
-
can_simulate_disconnection: {
|
|
23398
|
-
type: string;
|
|
23399
|
-
};
|
|
23400
|
-
can_simulate_removal: {
|
|
23401
|
-
type: string;
|
|
23402
|
-
};
|
|
23403
|
-
can_turn_off_hvac: {
|
|
23404
|
-
type: string;
|
|
23405
|
-
};
|
|
23406
|
-
capabilities_supported: {
|
|
23407
|
-
description: string;
|
|
23408
|
-
items: {
|
|
23409
|
-
enum: string[];
|
|
23410
|
-
type: string;
|
|
23411
|
-
};
|
|
23412
|
-
type: string;
|
|
23413
|
-
};
|
|
23414
23380
|
created_at: {
|
|
23415
23381
|
description: string;
|
|
23416
23382
|
format: string;
|
|
@@ -23422,6 +23388,7 @@ declare const _default: {
|
|
|
23422
23388
|
type: string;
|
|
23423
23389
|
}[];
|
|
23424
23390
|
};
|
|
23391
|
+
description: string;
|
|
23425
23392
|
type: string;
|
|
23426
23393
|
};
|
|
23427
23394
|
device_id: {
|
|
@@ -23441,68 +23408,16 @@ declare const _default: {
|
|
|
23441
23408
|
errors: {
|
|
23442
23409
|
description: string;
|
|
23443
23410
|
items: {
|
|
23444
|
-
|
|
23445
|
-
|
|
23446
|
-
|
|
23447
|
-
oneOf: ({
|
|
23448
|
-
description: string;
|
|
23449
|
-
properties: {
|
|
23450
|
-
error_code: {
|
|
23451
|
-
description: string;
|
|
23452
|
-
enum: string[];
|
|
23453
|
-
type: string;
|
|
23454
|
-
};
|
|
23455
|
-
is_device_error: {
|
|
23456
|
-
enum: boolean[];
|
|
23457
|
-
type: string;
|
|
23458
|
-
};
|
|
23459
|
-
message: {
|
|
23460
|
-
type: string;
|
|
23461
|
-
};
|
|
23462
|
-
is_connected_account_error?: never;
|
|
23411
|
+
properties: {
|
|
23412
|
+
error_code: {
|
|
23413
|
+
type: string;
|
|
23463
23414
|
};
|
|
23464
|
-
|
|
23465
|
-
|
|
23466
|
-
} | {
|
|
23467
|
-
description: string;
|
|
23468
|
-
properties: {
|
|
23469
|
-
error_code: {
|
|
23470
|
-
description: string;
|
|
23471
|
-
enum: string[];
|
|
23472
|
-
type: string;
|
|
23473
|
-
};
|
|
23474
|
-
is_connected_account_error: {
|
|
23475
|
-
enum: boolean[];
|
|
23476
|
-
type: string;
|
|
23477
|
-
};
|
|
23478
|
-
message: {
|
|
23479
|
-
type: string;
|
|
23480
|
-
};
|
|
23481
|
-
is_device_error?: never;
|
|
23415
|
+
message: {
|
|
23416
|
+
type: string;
|
|
23482
23417
|
};
|
|
23483
|
-
required: string[];
|
|
23484
|
-
type: string;
|
|
23485
|
-
})[];
|
|
23486
|
-
};
|
|
23487
|
-
type: string;
|
|
23488
|
-
};
|
|
23489
|
-
is_managed: {
|
|
23490
|
-
description: string;
|
|
23491
|
-
enum: boolean[];
|
|
23492
|
-
type: string;
|
|
23493
|
-
};
|
|
23494
|
-
location: {
|
|
23495
|
-
description: string;
|
|
23496
|
-
nullable: boolean;
|
|
23497
|
-
properties: {
|
|
23498
|
-
location_name: {
|
|
23499
|
-
description: string;
|
|
23500
|
-
type: string;
|
|
23501
|
-
};
|
|
23502
|
-
timezone: {
|
|
23503
|
-
description: string;
|
|
23504
|
-
type: string;
|
|
23505
23418
|
};
|
|
23419
|
+
required: string[];
|
|
23420
|
+
type: string;
|
|
23506
23421
|
};
|
|
23507
23422
|
type: string;
|
|
23508
23423
|
};
|
|
@@ -23511,6 +23426,7 @@ declare const _default: {
|
|
|
23511
23426
|
type: string;
|
|
23512
23427
|
};
|
|
23513
23428
|
properties: {
|
|
23429
|
+
description: string;
|
|
23514
23430
|
properties: {
|
|
23515
23431
|
assa_abloy_credential_service_metadata: {
|
|
23516
23432
|
description: string;
|
|
@@ -23558,24 +23474,16 @@ declare const _default: {
|
|
|
23558
23474
|
warnings: {
|
|
23559
23475
|
description: string;
|
|
23560
23476
|
items: {
|
|
23561
|
-
|
|
23562
|
-
|
|
23563
|
-
|
|
23564
|
-
oneOf: {
|
|
23565
|
-
description: string;
|
|
23566
|
-
properties: {
|
|
23567
|
-
message: {
|
|
23568
|
-
type: string;
|
|
23569
|
-
};
|
|
23570
|
-
warning_code: {
|
|
23571
|
-
description: string;
|
|
23572
|
-
enum: string[];
|
|
23573
|
-
type: string;
|
|
23574
|
-
};
|
|
23477
|
+
properties: {
|
|
23478
|
+
message: {
|
|
23479
|
+
type: string;
|
|
23575
23480
|
};
|
|
23576
|
-
|
|
23577
|
-
|
|
23578
|
-
|
|
23481
|
+
warning_code: {
|
|
23482
|
+
type: string;
|
|
23483
|
+
};
|
|
23484
|
+
};
|
|
23485
|
+
required: string[];
|
|
23486
|
+
type: string;
|
|
23579
23487
|
};
|
|
23580
23488
|
type: string;
|
|
23581
23489
|
};
|
|
@@ -24355,10 +24263,15 @@ declare const _default: {
|
|
|
24355
24263
|
};
|
|
24356
24264
|
device_type: {
|
|
24357
24265
|
description: string;
|
|
24358
|
-
oneOf: {
|
|
24266
|
+
oneOf: ({
|
|
24359
24267
|
enum: string[];
|
|
24360
24268
|
type: string;
|
|
24361
|
-
|
|
24269
|
+
description?: never;
|
|
24270
|
+
} | {
|
|
24271
|
+
description: string;
|
|
24272
|
+
enum: string[];
|
|
24273
|
+
type: string;
|
|
24274
|
+
})[];
|
|
24362
24275
|
};
|
|
24363
24276
|
errors: {
|
|
24364
24277
|
description: string;
|
|
@@ -32947,18 +32860,28 @@ declare const _default: {
|
|
|
32947
32860
|
};
|
|
32948
32861
|
device_type: {
|
|
32949
32862
|
description: string;
|
|
32950
|
-
oneOf: {
|
|
32863
|
+
oneOf: ({
|
|
32864
|
+
enum: string[];
|
|
32865
|
+
type: string;
|
|
32866
|
+
description?: never;
|
|
32867
|
+
} | {
|
|
32868
|
+
description: string;
|
|
32951
32869
|
enum: string[];
|
|
32952
32870
|
type: string;
|
|
32953
|
-
}[];
|
|
32871
|
+
})[];
|
|
32954
32872
|
};
|
|
32955
32873
|
device_types: {
|
|
32956
32874
|
description: string;
|
|
32957
32875
|
items: {
|
|
32958
|
-
oneOf: {
|
|
32876
|
+
oneOf: ({
|
|
32959
32877
|
enum: string[];
|
|
32960
32878
|
type: string;
|
|
32961
|
-
|
|
32879
|
+
description?: never;
|
|
32880
|
+
} | {
|
|
32881
|
+
description: string;
|
|
32882
|
+
enum: string[];
|
|
32883
|
+
type: string;
|
|
32884
|
+
})[];
|
|
32962
32885
|
};
|
|
32963
32886
|
type: string;
|
|
32964
32887
|
};
|
|
@@ -33452,18 +33375,28 @@ declare const _default: {
|
|
|
33452
33375
|
};
|
|
33453
33376
|
device_type: {
|
|
33454
33377
|
description: string;
|
|
33455
|
-
oneOf: {
|
|
33378
|
+
oneOf: ({
|
|
33456
33379
|
enum: string[];
|
|
33457
33380
|
type: string;
|
|
33458
|
-
|
|
33381
|
+
description?: never;
|
|
33382
|
+
} | {
|
|
33383
|
+
description: string;
|
|
33384
|
+
enum: string[];
|
|
33385
|
+
type: string;
|
|
33386
|
+
})[];
|
|
33459
33387
|
};
|
|
33460
33388
|
device_types: {
|
|
33461
33389
|
description: string;
|
|
33462
33390
|
items: {
|
|
33463
|
-
oneOf: {
|
|
33391
|
+
oneOf: ({
|
|
33464
33392
|
enum: string[];
|
|
33465
33393
|
type: string;
|
|
33466
|
-
|
|
33394
|
+
description?: never;
|
|
33395
|
+
} | {
|
|
33396
|
+
description: string;
|
|
33397
|
+
enum: string[];
|
|
33398
|
+
type: string;
|
|
33399
|
+
})[];
|
|
33467
33400
|
};
|
|
33468
33401
|
type: string;
|
|
33469
33402
|
};
|
|
@@ -34251,18 +34184,28 @@ declare const _default: {
|
|
|
34251
34184
|
};
|
|
34252
34185
|
device_type: {
|
|
34253
34186
|
description: string;
|
|
34254
|
-
oneOf: {
|
|
34187
|
+
oneOf: ({
|
|
34188
|
+
enum: string[];
|
|
34189
|
+
type: string;
|
|
34190
|
+
description?: never;
|
|
34191
|
+
} | {
|
|
34192
|
+
description: string;
|
|
34255
34193
|
enum: string[];
|
|
34256
34194
|
type: string;
|
|
34257
|
-
}[];
|
|
34195
|
+
})[];
|
|
34258
34196
|
};
|
|
34259
34197
|
device_types: {
|
|
34260
34198
|
description: string;
|
|
34261
34199
|
items: {
|
|
34262
|
-
oneOf: {
|
|
34200
|
+
oneOf: ({
|
|
34263
34201
|
enum: string[];
|
|
34264
34202
|
type: string;
|
|
34265
|
-
|
|
34203
|
+
description?: never;
|
|
34204
|
+
} | {
|
|
34205
|
+
description: string;
|
|
34206
|
+
enum: string[];
|
|
34207
|
+
type: string;
|
|
34208
|
+
})[];
|
|
34266
34209
|
};
|
|
34267
34210
|
type: string;
|
|
34268
34211
|
};
|
|
@@ -34709,18 +34652,28 @@ declare const _default: {
|
|
|
34709
34652
|
};
|
|
34710
34653
|
device_type: {
|
|
34711
34654
|
description: string;
|
|
34712
|
-
oneOf: {
|
|
34655
|
+
oneOf: ({
|
|
34713
34656
|
enum: string[];
|
|
34714
34657
|
type: string;
|
|
34715
|
-
|
|
34658
|
+
description?: never;
|
|
34659
|
+
} | {
|
|
34660
|
+
description: string;
|
|
34661
|
+
enum: string[];
|
|
34662
|
+
type: string;
|
|
34663
|
+
})[];
|
|
34716
34664
|
};
|
|
34717
34665
|
device_types: {
|
|
34718
34666
|
description: string;
|
|
34719
34667
|
items: {
|
|
34720
|
-
oneOf: {
|
|
34668
|
+
oneOf: ({
|
|
34721
34669
|
enum: string[];
|
|
34722
34670
|
type: string;
|
|
34723
|
-
|
|
34671
|
+
description?: never;
|
|
34672
|
+
} | {
|
|
34673
|
+
description: string;
|
|
34674
|
+
enum: string[];
|
|
34675
|
+
type: string;
|
|
34676
|
+
})[];
|
|
34724
34677
|
};
|
|
34725
34678
|
type: string;
|
|
34726
34679
|
};
|
|
@@ -36448,18 +36401,28 @@ declare const _default: {
|
|
|
36448
36401
|
};
|
|
36449
36402
|
device_type: {
|
|
36450
36403
|
description: string;
|
|
36451
|
-
oneOf: {
|
|
36404
|
+
oneOf: ({
|
|
36405
|
+
enum: string[];
|
|
36406
|
+
type: string;
|
|
36407
|
+
description?: never;
|
|
36408
|
+
} | {
|
|
36409
|
+
description: string;
|
|
36452
36410
|
enum: string[];
|
|
36453
36411
|
type: string;
|
|
36454
|
-
}[];
|
|
36412
|
+
})[];
|
|
36455
36413
|
};
|
|
36456
36414
|
device_types: {
|
|
36457
36415
|
description: string;
|
|
36458
36416
|
items: {
|
|
36459
|
-
oneOf: {
|
|
36417
|
+
oneOf: ({
|
|
36460
36418
|
enum: string[];
|
|
36461
36419
|
type: string;
|
|
36462
|
-
|
|
36420
|
+
description?: never;
|
|
36421
|
+
} | {
|
|
36422
|
+
description: string;
|
|
36423
|
+
enum: string[];
|
|
36424
|
+
type: string;
|
|
36425
|
+
})[];
|
|
36463
36426
|
};
|
|
36464
36427
|
type: string;
|
|
36465
36428
|
};
|
|
@@ -66428,16 +66391,31 @@ interface Routes {
|
|
|
66428
66391
|
formData: {};
|
|
66429
66392
|
jsonResponse: {
|
|
66430
66393
|
phones: Array<{
|
|
66431
|
-
/**
|
|
66394
|
+
/** ID of the `phone`. */
|
|
66432
66395
|
device_id: string;
|
|
66433
|
-
/**
|
|
66434
|
-
device_type: 'android_phone' | 'ios_phone';
|
|
66435
|
-
/** Optional nickname to describe the device, settable through Seam */
|
|
66396
|
+
/** Optional nickname to describe the phone, settable through Seam. */
|
|
66436
66397
|
nickname?: string | undefined;
|
|
66437
|
-
/** Display name of the
|
|
66398
|
+
/** Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. */
|
|
66438
66399
|
display_name: string;
|
|
66439
|
-
/**
|
|
66440
|
-
|
|
66400
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`. */
|
|
66401
|
+
workspace_id: string;
|
|
66402
|
+
/** Date and time at which the `phone` was created. */
|
|
66403
|
+
created_at: string;
|
|
66404
|
+
/** Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. */
|
|
66405
|
+
custom_metadata: Record<string, string | boolean>;
|
|
66406
|
+
/** Errors associated with the `phone`. */
|
|
66407
|
+
errors: Array<{
|
|
66408
|
+
error_code: string;
|
|
66409
|
+
message: string;
|
|
66410
|
+
}>;
|
|
66411
|
+
/** Warnings associated with the `phone`. */
|
|
66412
|
+
warnings: Array<{
|
|
66413
|
+
warning_code: string;
|
|
66414
|
+
message: string;
|
|
66415
|
+
}>;
|
|
66416
|
+
/** Type of phone. */
|
|
66417
|
+
device_type: 'ios_phone' | 'android_phone';
|
|
66418
|
+
/** Properties of the phone. */
|
|
66441
66419
|
properties: {
|
|
66442
66420
|
/** ASSA ABLOY Credential Service metadata for the phone. */
|
|
66443
66421
|
assa_abloy_credential_service_metadata?: {
|
|
@@ -66457,169 +66435,6 @@ interface Routes {
|
|
|
66457
66435
|
has_active_phone: boolean;
|
|
66458
66436
|
} | undefined;
|
|
66459
66437
|
};
|
|
66460
|
-
/** Location information for the device. */
|
|
66461
|
-
location: {
|
|
66462
|
-
/** Name of the device location. */
|
|
66463
|
-
location_name?: string | undefined;
|
|
66464
|
-
/** Time zone of the device location. */
|
|
66465
|
-
timezone?: string | undefined;
|
|
66466
|
-
} | null;
|
|
66467
|
-
/** Unique identifier for the Seam workspace associated with the device. */
|
|
66468
|
-
workspace_id: string;
|
|
66469
|
-
/** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
66470
|
-
errors: Array<{
|
|
66471
|
-
message: string;
|
|
66472
|
-
is_device_error: true;
|
|
66473
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66474
|
-
error_code: 'device_offline';
|
|
66475
|
-
} | {
|
|
66476
|
-
message: string;
|
|
66477
|
-
is_device_error: true;
|
|
66478
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66479
|
-
error_code: 'device_removed';
|
|
66480
|
-
} | {
|
|
66481
|
-
message: string;
|
|
66482
|
-
is_device_error: true;
|
|
66483
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66484
|
-
error_code: 'hub_disconnected';
|
|
66485
|
-
} | {
|
|
66486
|
-
message: string;
|
|
66487
|
-
is_device_error: true;
|
|
66488
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66489
|
-
error_code: 'device_disconnected';
|
|
66490
|
-
} | {
|
|
66491
|
-
message: string;
|
|
66492
|
-
is_device_error: true;
|
|
66493
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66494
|
-
error_code: 'empty_backup_access_code_pool';
|
|
66495
|
-
} | {
|
|
66496
|
-
message: string;
|
|
66497
|
-
is_device_error: true;
|
|
66498
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66499
|
-
error_code: 'august_lock_not_authorized';
|
|
66500
|
-
} | {
|
|
66501
|
-
message: string;
|
|
66502
|
-
is_device_error: true;
|
|
66503
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66504
|
-
error_code: 'august_lock_missing_bridge';
|
|
66505
|
-
} | {
|
|
66506
|
-
message: string;
|
|
66507
|
-
is_device_error: true;
|
|
66508
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66509
|
-
error_code: 'salto_site_user_limit_reached';
|
|
66510
|
-
} | {
|
|
66511
|
-
message: string;
|
|
66512
|
-
is_device_error: true;
|
|
66513
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66514
|
-
error_code: 'ttlock_lock_not_paired_to_gateway';
|
|
66515
|
-
} | {
|
|
66516
|
-
message: string;
|
|
66517
|
-
is_device_error: true;
|
|
66518
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66519
|
-
error_code: 'missing_device_credentials';
|
|
66520
|
-
} | {
|
|
66521
|
-
message: string;
|
|
66522
|
-
is_device_error: true;
|
|
66523
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66524
|
-
error_code: 'auxiliary_heat_running';
|
|
66525
|
-
} | {
|
|
66526
|
-
message: string;
|
|
66527
|
-
is_device_error: true;
|
|
66528
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66529
|
-
error_code: 'subscription_required';
|
|
66530
|
-
} | {
|
|
66531
|
-
message: string;
|
|
66532
|
-
is_connected_account_error: true;
|
|
66533
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66534
|
-
error_code: 'account_disconnected';
|
|
66535
|
-
} | {
|
|
66536
|
-
message: string;
|
|
66537
|
-
is_connected_account_error: true;
|
|
66538
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66539
|
-
error_code: 'invalid_credentials';
|
|
66540
|
-
}>;
|
|
66541
|
-
/** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
|
|
66542
|
-
warnings: Array<{
|
|
66543
|
-
message: string;
|
|
66544
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66545
|
-
warning_code: 'partial_backup_access_code_pool';
|
|
66546
|
-
} | {
|
|
66547
|
-
message: string;
|
|
66548
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66549
|
-
warning_code: 'many_active_backup_codes';
|
|
66550
|
-
} | {
|
|
66551
|
-
message: string;
|
|
66552
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66553
|
-
warning_code: 'salto_unknown_device_type';
|
|
66554
|
-
} | {
|
|
66555
|
-
message: string;
|
|
66556
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66557
|
-
warning_code: 'wyze_device_missing_gateway';
|
|
66558
|
-
} | {
|
|
66559
|
-
message: string;
|
|
66560
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66561
|
-
warning_code: 'functional_offline_device';
|
|
66562
|
-
} | {
|
|
66563
|
-
message: string;
|
|
66564
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66565
|
-
warning_code: 'third_party_integration_detected';
|
|
66566
|
-
} | {
|
|
66567
|
-
message: string;
|
|
66568
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66569
|
-
warning_code: 'nest_thermostat_in_manual_eco_mode';
|
|
66570
|
-
} | {
|
|
66571
|
-
message: string;
|
|
66572
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66573
|
-
warning_code: 'ttlock_lock_gateway_unlocking_not_enabled';
|
|
66574
|
-
} | {
|
|
66575
|
-
message: string;
|
|
66576
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66577
|
-
warning_code: 'ttlock_weak_gateway_signal';
|
|
66578
|
-
} | {
|
|
66579
|
-
message: string;
|
|
66580
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66581
|
-
warning_code: 'temperature_threshold_exceeded';
|
|
66582
|
-
} | {
|
|
66583
|
-
message: string;
|
|
66584
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66585
|
-
warning_code: 'device_communication_degraded';
|
|
66586
|
-
} | {
|
|
66587
|
-
message: string;
|
|
66588
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66589
|
-
warning_code: 'scheduled_maintenance_window';
|
|
66590
|
-
} | {
|
|
66591
|
-
message: string;
|
|
66592
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66593
|
-
warning_code: 'device_has_flaky_connection';
|
|
66594
|
-
} | {
|
|
66595
|
-
message: string;
|
|
66596
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66597
|
-
warning_code: 'salto_office_mode';
|
|
66598
|
-
} | {
|
|
66599
|
-
message: string;
|
|
66600
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66601
|
-
warning_code: 'salto_privacy_mode';
|
|
66602
|
-
} | {
|
|
66603
|
-
message: string;
|
|
66604
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66605
|
-
warning_code: 'unknown_issue_with_phone';
|
|
66606
|
-
}>;
|
|
66607
|
-
/** Date and time at which the device object was created. */
|
|
66608
|
-
created_at: string;
|
|
66609
|
-
/** Indicates whether Seam manages the device. */
|
|
66610
|
-
is_managed: true;
|
|
66611
|
-
custom_metadata: Record<string, string | boolean>;
|
|
66612
|
-
can_remotely_unlock?: boolean | undefined;
|
|
66613
|
-
can_remotely_lock?: boolean | undefined;
|
|
66614
|
-
can_program_offline_access_codes?: boolean | undefined;
|
|
66615
|
-
can_program_online_access_codes?: boolean | undefined;
|
|
66616
|
-
can_hvac_heat?: boolean | undefined;
|
|
66617
|
-
can_hvac_cool?: boolean | undefined;
|
|
66618
|
-
can_hvac_heat_cool?: boolean | undefined;
|
|
66619
|
-
can_turn_off_hvac?: boolean | undefined;
|
|
66620
|
-
can_simulate_removal?: boolean | undefined;
|
|
66621
|
-
can_simulate_connection?: boolean | undefined;
|
|
66622
|
-
can_simulate_disconnection?: boolean | undefined;
|
|
66623
66438
|
}>;
|
|
66624
66439
|
};
|
|
66625
66440
|
};
|
|
@@ -66662,18 +66477,33 @@ interface Routes {
|
|
|
66662
66477
|
commonParams: {};
|
|
66663
66478
|
formData: {};
|
|
66664
66479
|
jsonResponse: {
|
|
66665
|
-
/**
|
|
66480
|
+
/** Represents an app user's mobile phone. */
|
|
66666
66481
|
phone: {
|
|
66667
|
-
/**
|
|
66482
|
+
/** ID of the `phone`. */
|
|
66668
66483
|
device_id: string;
|
|
66669
|
-
/**
|
|
66670
|
-
device_type: 'android_phone' | 'ios_phone';
|
|
66671
|
-
/** Optional nickname to describe the device, settable through Seam */
|
|
66484
|
+
/** Optional nickname to describe the phone, settable through Seam. */
|
|
66672
66485
|
nickname?: string | undefined;
|
|
66673
|
-
/** Display name of the
|
|
66486
|
+
/** Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones. */
|
|
66674
66487
|
display_name: string;
|
|
66675
|
-
/**
|
|
66676
|
-
|
|
66488
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`. */
|
|
66489
|
+
workspace_id: string;
|
|
66490
|
+
/** Date and time at which the `phone` was created. */
|
|
66491
|
+
created_at: string;
|
|
66492
|
+
/** Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone. */
|
|
66493
|
+
custom_metadata: Record<string, string | boolean>;
|
|
66494
|
+
/** Errors associated with the `phone`. */
|
|
66495
|
+
errors: Array<{
|
|
66496
|
+
error_code: string;
|
|
66497
|
+
message: string;
|
|
66498
|
+
}>;
|
|
66499
|
+
/** Warnings associated with the `phone`. */
|
|
66500
|
+
warnings: Array<{
|
|
66501
|
+
warning_code: string;
|
|
66502
|
+
message: string;
|
|
66503
|
+
}>;
|
|
66504
|
+
/** Type of phone. */
|
|
66505
|
+
device_type: 'ios_phone' | 'android_phone';
|
|
66506
|
+
/** Properties of the phone. */
|
|
66677
66507
|
properties: {
|
|
66678
66508
|
/** ASSA ABLOY Credential Service metadata for the phone. */
|
|
66679
66509
|
assa_abloy_credential_service_metadata?: {
|
|
@@ -66693,169 +66523,6 @@ interface Routes {
|
|
|
66693
66523
|
has_active_phone: boolean;
|
|
66694
66524
|
} | undefined;
|
|
66695
66525
|
};
|
|
66696
|
-
/** Location information for the device. */
|
|
66697
|
-
location: {
|
|
66698
|
-
/** Name of the device location. */
|
|
66699
|
-
location_name?: string | undefined;
|
|
66700
|
-
/** Time zone of the device location. */
|
|
66701
|
-
timezone?: string | undefined;
|
|
66702
|
-
} | null;
|
|
66703
|
-
/** Unique identifier for the Seam workspace associated with the device. */
|
|
66704
|
-
workspace_id: string;
|
|
66705
|
-
/** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
66706
|
-
errors: Array<{
|
|
66707
|
-
message: string;
|
|
66708
|
-
is_device_error: true;
|
|
66709
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66710
|
-
error_code: 'device_offline';
|
|
66711
|
-
} | {
|
|
66712
|
-
message: string;
|
|
66713
|
-
is_device_error: true;
|
|
66714
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66715
|
-
error_code: 'device_removed';
|
|
66716
|
-
} | {
|
|
66717
|
-
message: string;
|
|
66718
|
-
is_device_error: true;
|
|
66719
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66720
|
-
error_code: 'hub_disconnected';
|
|
66721
|
-
} | {
|
|
66722
|
-
message: string;
|
|
66723
|
-
is_device_error: true;
|
|
66724
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66725
|
-
error_code: 'device_disconnected';
|
|
66726
|
-
} | {
|
|
66727
|
-
message: string;
|
|
66728
|
-
is_device_error: true;
|
|
66729
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66730
|
-
error_code: 'empty_backup_access_code_pool';
|
|
66731
|
-
} | {
|
|
66732
|
-
message: string;
|
|
66733
|
-
is_device_error: true;
|
|
66734
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66735
|
-
error_code: 'august_lock_not_authorized';
|
|
66736
|
-
} | {
|
|
66737
|
-
message: string;
|
|
66738
|
-
is_device_error: true;
|
|
66739
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66740
|
-
error_code: 'august_lock_missing_bridge';
|
|
66741
|
-
} | {
|
|
66742
|
-
message: string;
|
|
66743
|
-
is_device_error: true;
|
|
66744
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66745
|
-
error_code: 'salto_site_user_limit_reached';
|
|
66746
|
-
} | {
|
|
66747
|
-
message: string;
|
|
66748
|
-
is_device_error: true;
|
|
66749
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66750
|
-
error_code: 'ttlock_lock_not_paired_to_gateway';
|
|
66751
|
-
} | {
|
|
66752
|
-
message: string;
|
|
66753
|
-
is_device_error: true;
|
|
66754
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66755
|
-
error_code: 'missing_device_credentials';
|
|
66756
|
-
} | {
|
|
66757
|
-
message: string;
|
|
66758
|
-
is_device_error: true;
|
|
66759
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66760
|
-
error_code: 'auxiliary_heat_running';
|
|
66761
|
-
} | {
|
|
66762
|
-
message: string;
|
|
66763
|
-
is_device_error: true;
|
|
66764
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66765
|
-
error_code: 'subscription_required';
|
|
66766
|
-
} | {
|
|
66767
|
-
message: string;
|
|
66768
|
-
is_connected_account_error: true;
|
|
66769
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66770
|
-
error_code: 'account_disconnected';
|
|
66771
|
-
} | {
|
|
66772
|
-
message: string;
|
|
66773
|
-
is_connected_account_error: true;
|
|
66774
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66775
|
-
error_code: 'invalid_credentials';
|
|
66776
|
-
}>;
|
|
66777
|
-
/** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
|
|
66778
|
-
warnings: Array<{
|
|
66779
|
-
message: string;
|
|
66780
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66781
|
-
warning_code: 'partial_backup_access_code_pool';
|
|
66782
|
-
} | {
|
|
66783
|
-
message: string;
|
|
66784
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66785
|
-
warning_code: 'many_active_backup_codes';
|
|
66786
|
-
} | {
|
|
66787
|
-
message: string;
|
|
66788
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66789
|
-
warning_code: 'salto_unknown_device_type';
|
|
66790
|
-
} | {
|
|
66791
|
-
message: string;
|
|
66792
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66793
|
-
warning_code: 'wyze_device_missing_gateway';
|
|
66794
|
-
} | {
|
|
66795
|
-
message: string;
|
|
66796
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66797
|
-
warning_code: 'functional_offline_device';
|
|
66798
|
-
} | {
|
|
66799
|
-
message: string;
|
|
66800
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66801
|
-
warning_code: 'third_party_integration_detected';
|
|
66802
|
-
} | {
|
|
66803
|
-
message: string;
|
|
66804
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66805
|
-
warning_code: 'nest_thermostat_in_manual_eco_mode';
|
|
66806
|
-
} | {
|
|
66807
|
-
message: string;
|
|
66808
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66809
|
-
warning_code: 'ttlock_lock_gateway_unlocking_not_enabled';
|
|
66810
|
-
} | {
|
|
66811
|
-
message: string;
|
|
66812
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66813
|
-
warning_code: 'ttlock_weak_gateway_signal';
|
|
66814
|
-
} | {
|
|
66815
|
-
message: string;
|
|
66816
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66817
|
-
warning_code: 'temperature_threshold_exceeded';
|
|
66818
|
-
} | {
|
|
66819
|
-
message: string;
|
|
66820
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66821
|
-
warning_code: 'device_communication_degraded';
|
|
66822
|
-
} | {
|
|
66823
|
-
message: string;
|
|
66824
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66825
|
-
warning_code: 'scheduled_maintenance_window';
|
|
66826
|
-
} | {
|
|
66827
|
-
message: string;
|
|
66828
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66829
|
-
warning_code: 'device_has_flaky_connection';
|
|
66830
|
-
} | {
|
|
66831
|
-
message: string;
|
|
66832
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66833
|
-
warning_code: 'salto_office_mode';
|
|
66834
|
-
} | {
|
|
66835
|
-
message: string;
|
|
66836
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66837
|
-
warning_code: 'salto_privacy_mode';
|
|
66838
|
-
} | {
|
|
66839
|
-
message: string;
|
|
66840
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66841
|
-
warning_code: 'unknown_issue_with_phone';
|
|
66842
|
-
}>;
|
|
66843
|
-
/** Date and time at which the device object was created. */
|
|
66844
|
-
created_at: string;
|
|
66845
|
-
/** Indicates whether Seam manages the device. */
|
|
66846
|
-
is_managed: true;
|
|
66847
|
-
custom_metadata: Record<string, string | boolean>;
|
|
66848
|
-
can_remotely_unlock?: boolean | undefined;
|
|
66849
|
-
can_remotely_lock?: boolean | undefined;
|
|
66850
|
-
can_program_offline_access_codes?: boolean | undefined;
|
|
66851
|
-
can_program_online_access_codes?: boolean | undefined;
|
|
66852
|
-
can_hvac_heat?: boolean | undefined;
|
|
66853
|
-
can_hvac_cool?: boolean | undefined;
|
|
66854
|
-
can_hvac_heat_cool?: boolean | undefined;
|
|
66855
|
-
can_turn_off_hvac?: boolean | undefined;
|
|
66856
|
-
can_simulate_removal?: boolean | undefined;
|
|
66857
|
-
can_simulate_connection?: boolean | undefined;
|
|
66858
|
-
can_simulate_disconnection?: boolean | undefined;
|
|
66859
66526
|
};
|
|
66860
66527
|
};
|
|
66861
66528
|
};
|