@seamapi/types 1.345.0 → 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 -699
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +149 -499
- 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 -158
- package/lib/seam/connect/openapi.js +68 -503
- 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 +250 -723
- 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
|
};
|
|
@@ -23589,23 +23497,6 @@ declare const _default: {
|
|
|
23589
23497
|
type: string;
|
|
23590
23498
|
'x-route-path': string;
|
|
23591
23499
|
};
|
|
23592
|
-
service_health: {
|
|
23593
|
-
properties: {
|
|
23594
|
-
description: {
|
|
23595
|
-
type: string;
|
|
23596
|
-
};
|
|
23597
|
-
service: {
|
|
23598
|
-
type: string;
|
|
23599
|
-
};
|
|
23600
|
-
status: {
|
|
23601
|
-
enum: string[];
|
|
23602
|
-
type: string;
|
|
23603
|
-
};
|
|
23604
|
-
};
|
|
23605
|
-
required: string[];
|
|
23606
|
-
type: string;
|
|
23607
|
-
'x-route-path': string;
|
|
23608
|
-
};
|
|
23609
23500
|
thermostat_schedule: {
|
|
23610
23501
|
description: string;
|
|
23611
23502
|
properties: {
|
|
@@ -24372,10 +24263,15 @@ declare const _default: {
|
|
|
24372
24263
|
};
|
|
24373
24264
|
device_type: {
|
|
24374
24265
|
description: string;
|
|
24375
|
-
oneOf: {
|
|
24266
|
+
oneOf: ({
|
|
24376
24267
|
enum: string[];
|
|
24377
24268
|
type: string;
|
|
24378
|
-
|
|
24269
|
+
description?: never;
|
|
24270
|
+
} | {
|
|
24271
|
+
description: string;
|
|
24272
|
+
enum: string[];
|
|
24273
|
+
type: string;
|
|
24274
|
+
})[];
|
|
24379
24275
|
};
|
|
24380
24276
|
errors: {
|
|
24381
24277
|
description: string;
|
|
@@ -32964,18 +32860,28 @@ declare const _default: {
|
|
|
32964
32860
|
};
|
|
32965
32861
|
device_type: {
|
|
32966
32862
|
description: string;
|
|
32967
|
-
oneOf: {
|
|
32863
|
+
oneOf: ({
|
|
32864
|
+
enum: string[];
|
|
32865
|
+
type: string;
|
|
32866
|
+
description?: never;
|
|
32867
|
+
} | {
|
|
32868
|
+
description: string;
|
|
32968
32869
|
enum: string[];
|
|
32969
32870
|
type: string;
|
|
32970
|
-
}[];
|
|
32871
|
+
})[];
|
|
32971
32872
|
};
|
|
32972
32873
|
device_types: {
|
|
32973
32874
|
description: string;
|
|
32974
32875
|
items: {
|
|
32975
|
-
oneOf: {
|
|
32876
|
+
oneOf: ({
|
|
32976
32877
|
enum: string[];
|
|
32977
32878
|
type: string;
|
|
32978
|
-
|
|
32879
|
+
description?: never;
|
|
32880
|
+
} | {
|
|
32881
|
+
description: string;
|
|
32882
|
+
enum: string[];
|
|
32883
|
+
type: string;
|
|
32884
|
+
})[];
|
|
32979
32885
|
};
|
|
32980
32886
|
type: string;
|
|
32981
32887
|
};
|
|
@@ -33469,18 +33375,28 @@ declare const _default: {
|
|
|
33469
33375
|
};
|
|
33470
33376
|
device_type: {
|
|
33471
33377
|
description: string;
|
|
33472
|
-
oneOf: {
|
|
33378
|
+
oneOf: ({
|
|
33473
33379
|
enum: string[];
|
|
33474
33380
|
type: string;
|
|
33475
|
-
|
|
33381
|
+
description?: never;
|
|
33382
|
+
} | {
|
|
33383
|
+
description: string;
|
|
33384
|
+
enum: string[];
|
|
33385
|
+
type: string;
|
|
33386
|
+
})[];
|
|
33476
33387
|
};
|
|
33477
33388
|
device_types: {
|
|
33478
33389
|
description: string;
|
|
33479
33390
|
items: {
|
|
33480
|
-
oneOf: {
|
|
33391
|
+
oneOf: ({
|
|
33481
33392
|
enum: string[];
|
|
33482
33393
|
type: string;
|
|
33483
|
-
|
|
33394
|
+
description?: never;
|
|
33395
|
+
} | {
|
|
33396
|
+
description: string;
|
|
33397
|
+
enum: string[];
|
|
33398
|
+
type: string;
|
|
33399
|
+
})[];
|
|
33484
33400
|
};
|
|
33485
33401
|
type: string;
|
|
33486
33402
|
};
|
|
@@ -34268,18 +34184,28 @@ declare const _default: {
|
|
|
34268
34184
|
};
|
|
34269
34185
|
device_type: {
|
|
34270
34186
|
description: string;
|
|
34271
|
-
oneOf: {
|
|
34187
|
+
oneOf: ({
|
|
34272
34188
|
enum: string[];
|
|
34273
34189
|
type: string;
|
|
34274
|
-
|
|
34190
|
+
description?: never;
|
|
34191
|
+
} | {
|
|
34192
|
+
description: string;
|
|
34193
|
+
enum: string[];
|
|
34194
|
+
type: string;
|
|
34195
|
+
})[];
|
|
34275
34196
|
};
|
|
34276
34197
|
device_types: {
|
|
34277
34198
|
description: string;
|
|
34278
34199
|
items: {
|
|
34279
|
-
oneOf: {
|
|
34200
|
+
oneOf: ({
|
|
34280
34201
|
enum: string[];
|
|
34281
34202
|
type: string;
|
|
34282
|
-
|
|
34203
|
+
description?: never;
|
|
34204
|
+
} | {
|
|
34205
|
+
description: string;
|
|
34206
|
+
enum: string[];
|
|
34207
|
+
type: string;
|
|
34208
|
+
})[];
|
|
34283
34209
|
};
|
|
34284
34210
|
type: string;
|
|
34285
34211
|
};
|
|
@@ -34726,18 +34652,28 @@ declare const _default: {
|
|
|
34726
34652
|
};
|
|
34727
34653
|
device_type: {
|
|
34728
34654
|
description: string;
|
|
34729
|
-
oneOf: {
|
|
34655
|
+
oneOf: ({
|
|
34730
34656
|
enum: string[];
|
|
34731
34657
|
type: string;
|
|
34732
|
-
|
|
34658
|
+
description?: never;
|
|
34659
|
+
} | {
|
|
34660
|
+
description: string;
|
|
34661
|
+
enum: string[];
|
|
34662
|
+
type: string;
|
|
34663
|
+
})[];
|
|
34733
34664
|
};
|
|
34734
34665
|
device_types: {
|
|
34735
34666
|
description: string;
|
|
34736
34667
|
items: {
|
|
34737
|
-
oneOf: {
|
|
34668
|
+
oneOf: ({
|
|
34738
34669
|
enum: string[];
|
|
34739
34670
|
type: string;
|
|
34740
|
-
|
|
34671
|
+
description?: never;
|
|
34672
|
+
} | {
|
|
34673
|
+
description: string;
|
|
34674
|
+
enum: string[];
|
|
34675
|
+
type: string;
|
|
34676
|
+
})[];
|
|
34741
34677
|
};
|
|
34742
34678
|
type: string;
|
|
34743
34679
|
};
|
|
@@ -36465,18 +36401,28 @@ declare const _default: {
|
|
|
36465
36401
|
};
|
|
36466
36402
|
device_type: {
|
|
36467
36403
|
description: string;
|
|
36468
|
-
oneOf: {
|
|
36404
|
+
oneOf: ({
|
|
36405
|
+
enum: string[];
|
|
36406
|
+
type: string;
|
|
36407
|
+
description?: never;
|
|
36408
|
+
} | {
|
|
36409
|
+
description: string;
|
|
36469
36410
|
enum: string[];
|
|
36470
36411
|
type: string;
|
|
36471
|
-
}[];
|
|
36412
|
+
})[];
|
|
36472
36413
|
};
|
|
36473
36414
|
device_types: {
|
|
36474
36415
|
description: string;
|
|
36475
36416
|
items: {
|
|
36476
|
-
oneOf: {
|
|
36417
|
+
oneOf: ({
|
|
36477
36418
|
enum: string[];
|
|
36478
36419
|
type: string;
|
|
36479
|
-
|
|
36420
|
+
description?: never;
|
|
36421
|
+
} | {
|
|
36422
|
+
description: string;
|
|
36423
|
+
enum: string[];
|
|
36424
|
+
type: string;
|
|
36425
|
+
})[];
|
|
36480
36426
|
};
|
|
36481
36427
|
type: string;
|
|
36482
36428
|
};
|
|
@@ -66445,16 +66391,31 @@ interface Routes {
|
|
|
66445
66391
|
formData: {};
|
|
66446
66392
|
jsonResponse: {
|
|
66447
66393
|
phones: Array<{
|
|
66448
|
-
/**
|
|
66394
|
+
/** ID of the `phone`. */
|
|
66449
66395
|
device_id: string;
|
|
66450
|
-
/**
|
|
66451
|
-
device_type: 'android_phone' | 'ios_phone';
|
|
66452
|
-
/** Optional nickname to describe the device, settable through Seam */
|
|
66396
|
+
/** Optional nickname to describe the phone, settable through Seam. */
|
|
66453
66397
|
nickname?: string | undefined;
|
|
66454
|
-
/** 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. */
|
|
66455
66399
|
display_name: string;
|
|
66456
|
-
/**
|
|
66457
|
-
|
|
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. */
|
|
66458
66419
|
properties: {
|
|
66459
66420
|
/** ASSA ABLOY Credential Service metadata for the phone. */
|
|
66460
66421
|
assa_abloy_credential_service_metadata?: {
|
|
@@ -66474,169 +66435,6 @@ interface Routes {
|
|
|
66474
66435
|
has_active_phone: boolean;
|
|
66475
66436
|
} | undefined;
|
|
66476
66437
|
};
|
|
66477
|
-
/** Location information for the device. */
|
|
66478
|
-
location: {
|
|
66479
|
-
/** Name of the device location. */
|
|
66480
|
-
location_name?: string | undefined;
|
|
66481
|
-
/** Time zone of the device location. */
|
|
66482
|
-
timezone?: string | undefined;
|
|
66483
|
-
} | null;
|
|
66484
|
-
/** Unique identifier for the Seam workspace associated with the device. */
|
|
66485
|
-
workspace_id: string;
|
|
66486
|
-
/** 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. */
|
|
66487
|
-
errors: Array<{
|
|
66488
|
-
message: string;
|
|
66489
|
-
is_device_error: true;
|
|
66490
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66491
|
-
error_code: 'device_offline';
|
|
66492
|
-
} | {
|
|
66493
|
-
message: string;
|
|
66494
|
-
is_device_error: true;
|
|
66495
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66496
|
-
error_code: 'device_removed';
|
|
66497
|
-
} | {
|
|
66498
|
-
message: string;
|
|
66499
|
-
is_device_error: true;
|
|
66500
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66501
|
-
error_code: 'hub_disconnected';
|
|
66502
|
-
} | {
|
|
66503
|
-
message: string;
|
|
66504
|
-
is_device_error: true;
|
|
66505
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66506
|
-
error_code: 'device_disconnected';
|
|
66507
|
-
} | {
|
|
66508
|
-
message: string;
|
|
66509
|
-
is_device_error: true;
|
|
66510
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66511
|
-
error_code: 'empty_backup_access_code_pool';
|
|
66512
|
-
} | {
|
|
66513
|
-
message: string;
|
|
66514
|
-
is_device_error: true;
|
|
66515
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66516
|
-
error_code: 'august_lock_not_authorized';
|
|
66517
|
-
} | {
|
|
66518
|
-
message: string;
|
|
66519
|
-
is_device_error: true;
|
|
66520
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66521
|
-
error_code: 'august_lock_missing_bridge';
|
|
66522
|
-
} | {
|
|
66523
|
-
message: string;
|
|
66524
|
-
is_device_error: true;
|
|
66525
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66526
|
-
error_code: 'salto_site_user_limit_reached';
|
|
66527
|
-
} | {
|
|
66528
|
-
message: string;
|
|
66529
|
-
is_device_error: true;
|
|
66530
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66531
|
-
error_code: 'ttlock_lock_not_paired_to_gateway';
|
|
66532
|
-
} | {
|
|
66533
|
-
message: string;
|
|
66534
|
-
is_device_error: true;
|
|
66535
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66536
|
-
error_code: 'missing_device_credentials';
|
|
66537
|
-
} | {
|
|
66538
|
-
message: string;
|
|
66539
|
-
is_device_error: true;
|
|
66540
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66541
|
-
error_code: 'auxiliary_heat_running';
|
|
66542
|
-
} | {
|
|
66543
|
-
message: string;
|
|
66544
|
-
is_device_error: true;
|
|
66545
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66546
|
-
error_code: 'subscription_required';
|
|
66547
|
-
} | {
|
|
66548
|
-
message: string;
|
|
66549
|
-
is_connected_account_error: true;
|
|
66550
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66551
|
-
error_code: 'account_disconnected';
|
|
66552
|
-
} | {
|
|
66553
|
-
message: string;
|
|
66554
|
-
is_connected_account_error: true;
|
|
66555
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66556
|
-
error_code: 'invalid_credentials';
|
|
66557
|
-
}>;
|
|
66558
|
-
/** 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. */
|
|
66559
|
-
warnings: Array<{
|
|
66560
|
-
message: string;
|
|
66561
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66562
|
-
warning_code: 'partial_backup_access_code_pool';
|
|
66563
|
-
} | {
|
|
66564
|
-
message: string;
|
|
66565
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66566
|
-
warning_code: 'many_active_backup_codes';
|
|
66567
|
-
} | {
|
|
66568
|
-
message: string;
|
|
66569
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66570
|
-
warning_code: 'salto_unknown_device_type';
|
|
66571
|
-
} | {
|
|
66572
|
-
message: string;
|
|
66573
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66574
|
-
warning_code: 'wyze_device_missing_gateway';
|
|
66575
|
-
} | {
|
|
66576
|
-
message: string;
|
|
66577
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66578
|
-
warning_code: 'functional_offline_device';
|
|
66579
|
-
} | {
|
|
66580
|
-
message: string;
|
|
66581
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66582
|
-
warning_code: 'third_party_integration_detected';
|
|
66583
|
-
} | {
|
|
66584
|
-
message: string;
|
|
66585
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66586
|
-
warning_code: 'nest_thermostat_in_manual_eco_mode';
|
|
66587
|
-
} | {
|
|
66588
|
-
message: string;
|
|
66589
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66590
|
-
warning_code: 'ttlock_lock_gateway_unlocking_not_enabled';
|
|
66591
|
-
} | {
|
|
66592
|
-
message: string;
|
|
66593
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66594
|
-
warning_code: 'ttlock_weak_gateway_signal';
|
|
66595
|
-
} | {
|
|
66596
|
-
message: string;
|
|
66597
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66598
|
-
warning_code: 'temperature_threshold_exceeded';
|
|
66599
|
-
} | {
|
|
66600
|
-
message: string;
|
|
66601
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66602
|
-
warning_code: 'device_communication_degraded';
|
|
66603
|
-
} | {
|
|
66604
|
-
message: string;
|
|
66605
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66606
|
-
warning_code: 'scheduled_maintenance_window';
|
|
66607
|
-
} | {
|
|
66608
|
-
message: string;
|
|
66609
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66610
|
-
warning_code: 'device_has_flaky_connection';
|
|
66611
|
-
} | {
|
|
66612
|
-
message: string;
|
|
66613
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66614
|
-
warning_code: 'salto_office_mode';
|
|
66615
|
-
} | {
|
|
66616
|
-
message: string;
|
|
66617
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66618
|
-
warning_code: 'salto_privacy_mode';
|
|
66619
|
-
} | {
|
|
66620
|
-
message: string;
|
|
66621
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66622
|
-
warning_code: 'unknown_issue_with_phone';
|
|
66623
|
-
}>;
|
|
66624
|
-
/** Date and time at which the device object was created. */
|
|
66625
|
-
created_at: string;
|
|
66626
|
-
/** Indicates whether Seam manages the device. */
|
|
66627
|
-
is_managed: true;
|
|
66628
|
-
custom_metadata: Record<string, string | boolean>;
|
|
66629
|
-
can_remotely_unlock?: boolean | undefined;
|
|
66630
|
-
can_remotely_lock?: boolean | undefined;
|
|
66631
|
-
can_program_offline_access_codes?: boolean | undefined;
|
|
66632
|
-
can_program_online_access_codes?: boolean | undefined;
|
|
66633
|
-
can_hvac_heat?: boolean | undefined;
|
|
66634
|
-
can_hvac_cool?: boolean | undefined;
|
|
66635
|
-
can_hvac_heat_cool?: boolean | undefined;
|
|
66636
|
-
can_turn_off_hvac?: boolean | undefined;
|
|
66637
|
-
can_simulate_removal?: boolean | undefined;
|
|
66638
|
-
can_simulate_connection?: boolean | undefined;
|
|
66639
|
-
can_simulate_disconnection?: boolean | undefined;
|
|
66640
66438
|
}>;
|
|
66641
66439
|
};
|
|
66642
66440
|
};
|
|
@@ -66679,18 +66477,33 @@ interface Routes {
|
|
|
66679
66477
|
commonParams: {};
|
|
66680
66478
|
formData: {};
|
|
66681
66479
|
jsonResponse: {
|
|
66682
|
-
/**
|
|
66480
|
+
/** Represents an app user's mobile phone. */
|
|
66683
66481
|
phone: {
|
|
66684
|
-
/**
|
|
66482
|
+
/** ID of the `phone`. */
|
|
66685
66483
|
device_id: string;
|
|
66686
|
-
/**
|
|
66687
|
-
device_type: 'android_phone' | 'ios_phone';
|
|
66688
|
-
/** Optional nickname to describe the device, settable through Seam */
|
|
66484
|
+
/** Optional nickname to describe the phone, settable through Seam. */
|
|
66689
66485
|
nickname?: string | undefined;
|
|
66690
|
-
/** 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. */
|
|
66691
66487
|
display_name: string;
|
|
66692
|
-
/**
|
|
66693
|
-
|
|
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. */
|
|
66694
66507
|
properties: {
|
|
66695
66508
|
/** ASSA ABLOY Credential Service metadata for the phone. */
|
|
66696
66509
|
assa_abloy_credential_service_metadata?: {
|
|
@@ -66710,169 +66523,6 @@ interface Routes {
|
|
|
66710
66523
|
has_active_phone: boolean;
|
|
66711
66524
|
} | undefined;
|
|
66712
66525
|
};
|
|
66713
|
-
/** Location information for the device. */
|
|
66714
|
-
location: {
|
|
66715
|
-
/** Name of the device location. */
|
|
66716
|
-
location_name?: string | undefined;
|
|
66717
|
-
/** Time zone of the device location. */
|
|
66718
|
-
timezone?: string | undefined;
|
|
66719
|
-
} | null;
|
|
66720
|
-
/** Unique identifier for the Seam workspace associated with the device. */
|
|
66721
|
-
workspace_id: string;
|
|
66722
|
-
/** 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. */
|
|
66723
|
-
errors: Array<{
|
|
66724
|
-
message: string;
|
|
66725
|
-
is_device_error: true;
|
|
66726
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66727
|
-
error_code: 'device_offline';
|
|
66728
|
-
} | {
|
|
66729
|
-
message: string;
|
|
66730
|
-
is_device_error: true;
|
|
66731
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66732
|
-
error_code: 'device_removed';
|
|
66733
|
-
} | {
|
|
66734
|
-
message: string;
|
|
66735
|
-
is_device_error: true;
|
|
66736
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66737
|
-
error_code: 'hub_disconnected';
|
|
66738
|
-
} | {
|
|
66739
|
-
message: string;
|
|
66740
|
-
is_device_error: true;
|
|
66741
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66742
|
-
error_code: 'device_disconnected';
|
|
66743
|
-
} | {
|
|
66744
|
-
message: string;
|
|
66745
|
-
is_device_error: true;
|
|
66746
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66747
|
-
error_code: 'empty_backup_access_code_pool';
|
|
66748
|
-
} | {
|
|
66749
|
-
message: string;
|
|
66750
|
-
is_device_error: true;
|
|
66751
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66752
|
-
error_code: 'august_lock_not_authorized';
|
|
66753
|
-
} | {
|
|
66754
|
-
message: string;
|
|
66755
|
-
is_device_error: true;
|
|
66756
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66757
|
-
error_code: 'august_lock_missing_bridge';
|
|
66758
|
-
} | {
|
|
66759
|
-
message: string;
|
|
66760
|
-
is_device_error: true;
|
|
66761
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66762
|
-
error_code: 'salto_site_user_limit_reached';
|
|
66763
|
-
} | {
|
|
66764
|
-
message: string;
|
|
66765
|
-
is_device_error: true;
|
|
66766
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66767
|
-
error_code: 'ttlock_lock_not_paired_to_gateway';
|
|
66768
|
-
} | {
|
|
66769
|
-
message: string;
|
|
66770
|
-
is_device_error: true;
|
|
66771
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66772
|
-
error_code: 'missing_device_credentials';
|
|
66773
|
-
} | {
|
|
66774
|
-
message: string;
|
|
66775
|
-
is_device_error: true;
|
|
66776
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66777
|
-
error_code: 'auxiliary_heat_running';
|
|
66778
|
-
} | {
|
|
66779
|
-
message: string;
|
|
66780
|
-
is_device_error: true;
|
|
66781
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66782
|
-
error_code: 'subscription_required';
|
|
66783
|
-
} | {
|
|
66784
|
-
message: string;
|
|
66785
|
-
is_connected_account_error: true;
|
|
66786
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66787
|
-
error_code: 'account_disconnected';
|
|
66788
|
-
} | {
|
|
66789
|
-
message: string;
|
|
66790
|
-
is_connected_account_error: true;
|
|
66791
|
-
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
66792
|
-
error_code: 'invalid_credentials';
|
|
66793
|
-
}>;
|
|
66794
|
-
/** 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. */
|
|
66795
|
-
warnings: Array<{
|
|
66796
|
-
message: string;
|
|
66797
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66798
|
-
warning_code: 'partial_backup_access_code_pool';
|
|
66799
|
-
} | {
|
|
66800
|
-
message: string;
|
|
66801
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66802
|
-
warning_code: 'many_active_backup_codes';
|
|
66803
|
-
} | {
|
|
66804
|
-
message: string;
|
|
66805
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66806
|
-
warning_code: 'salto_unknown_device_type';
|
|
66807
|
-
} | {
|
|
66808
|
-
message: string;
|
|
66809
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66810
|
-
warning_code: 'wyze_device_missing_gateway';
|
|
66811
|
-
} | {
|
|
66812
|
-
message: string;
|
|
66813
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66814
|
-
warning_code: 'functional_offline_device';
|
|
66815
|
-
} | {
|
|
66816
|
-
message: string;
|
|
66817
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66818
|
-
warning_code: 'third_party_integration_detected';
|
|
66819
|
-
} | {
|
|
66820
|
-
message: string;
|
|
66821
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66822
|
-
warning_code: 'nest_thermostat_in_manual_eco_mode';
|
|
66823
|
-
} | {
|
|
66824
|
-
message: string;
|
|
66825
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66826
|
-
warning_code: 'ttlock_lock_gateway_unlocking_not_enabled';
|
|
66827
|
-
} | {
|
|
66828
|
-
message: string;
|
|
66829
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66830
|
-
warning_code: 'ttlock_weak_gateway_signal';
|
|
66831
|
-
} | {
|
|
66832
|
-
message: string;
|
|
66833
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66834
|
-
warning_code: 'temperature_threshold_exceeded';
|
|
66835
|
-
} | {
|
|
66836
|
-
message: string;
|
|
66837
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66838
|
-
warning_code: 'device_communication_degraded';
|
|
66839
|
-
} | {
|
|
66840
|
-
message: string;
|
|
66841
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66842
|
-
warning_code: 'scheduled_maintenance_window';
|
|
66843
|
-
} | {
|
|
66844
|
-
message: string;
|
|
66845
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66846
|
-
warning_code: 'device_has_flaky_connection';
|
|
66847
|
-
} | {
|
|
66848
|
-
message: string;
|
|
66849
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66850
|
-
warning_code: 'salto_office_mode';
|
|
66851
|
-
} | {
|
|
66852
|
-
message: string;
|
|
66853
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66854
|
-
warning_code: 'salto_privacy_mode';
|
|
66855
|
-
} | {
|
|
66856
|
-
message: string;
|
|
66857
|
-
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
66858
|
-
warning_code: 'unknown_issue_with_phone';
|
|
66859
|
-
}>;
|
|
66860
|
-
/** Date and time at which the device object was created. */
|
|
66861
|
-
created_at: string;
|
|
66862
|
-
/** Indicates whether Seam manages the device. */
|
|
66863
|
-
is_managed: true;
|
|
66864
|
-
custom_metadata: Record<string, string | boolean>;
|
|
66865
|
-
can_remotely_unlock?: boolean | undefined;
|
|
66866
|
-
can_remotely_lock?: boolean | undefined;
|
|
66867
|
-
can_program_offline_access_codes?: boolean | undefined;
|
|
66868
|
-
can_program_online_access_codes?: boolean | undefined;
|
|
66869
|
-
can_hvac_heat?: boolean | undefined;
|
|
66870
|
-
can_hvac_cool?: boolean | undefined;
|
|
66871
|
-
can_hvac_heat_cool?: boolean | undefined;
|
|
66872
|
-
can_turn_off_hvac?: boolean | undefined;
|
|
66873
|
-
can_simulate_removal?: boolean | undefined;
|
|
66874
|
-
can_simulate_connection?: boolean | undefined;
|
|
66875
|
-
can_simulate_disconnection?: boolean | undefined;
|
|
66876
66526
|
};
|
|
66877
66527
|
};
|
|
66878
66528
|
};
|