@seamapi/types 1.344.3 → 1.345.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +127 -40
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +164 -18
- package/lib/seam/connect/models/devices/phone-properties.js +18 -8
- package/lib/seam/connect/models/devices/phone-properties.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.js +4 -1
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +39 -17
- package/lib/seam/connect/openapi.js +113 -30
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +125 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/phone-properties.ts +24 -10
- package/src/lib/seam/connect/models/devices/phone.ts +4 -1
- package/src/lib/seam/connect/openapi.ts +144 -30
- package/src/lib/seam/connect/route-types.ts +125 -1
|
@@ -2,17 +2,27 @@ import { z } from 'zod';
|
|
|
2
2
|
export const phone_specific_properties = z.object({
|
|
3
3
|
assa_abloy_credential_service_metadata: z
|
|
4
4
|
.object({
|
|
5
|
-
has_active_endpoint: z
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
5
|
+
has_active_endpoint: z
|
|
6
|
+
.boolean()
|
|
7
|
+
.describe('Indicates whether the credential service has active endpoints associated with the phone.'),
|
|
8
|
+
endpoints: z
|
|
9
|
+
.array(z.object({
|
|
10
|
+
endpoint_id: z.string().describe('ID of the associated endpoint.'),
|
|
11
|
+
is_active: z
|
|
12
|
+
.boolean()
|
|
13
|
+
.describe('Indicated whether the endpoint is active.'),
|
|
14
|
+
}))
|
|
15
|
+
.describe('Endpoints associated with the phone.'),
|
|
10
16
|
})
|
|
11
|
-
.optional()
|
|
17
|
+
.optional()
|
|
18
|
+
.describe('ASSA ABLOY Credential Service metadata for the phone.'),
|
|
12
19
|
salto_space_credential_service_metadata: z
|
|
13
20
|
.object({
|
|
14
|
-
has_active_phone: z
|
|
21
|
+
has_active_phone: z
|
|
22
|
+
.boolean()
|
|
23
|
+
.describe('Indicates whether the credential service has an active associated phone.'),
|
|
15
24
|
})
|
|
16
|
-
.optional()
|
|
25
|
+
.optional()
|
|
26
|
+
.describe('Salto Space credential service metadata for the phone.'),
|
|
17
27
|
});
|
|
18
28
|
//# sourceMappingURL=phone-properties.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"phone-properties.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/devices/phone-properties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,sCAAsC,EAAE,CAAC;SACtC,MAAM,CAAC;QACN,mBAAmB,EAAE,CAAC,
|
|
1
|
+
{"version":3,"file":"phone-properties.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/devices/phone-properties.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,MAAM,CAAC,MAAM,yBAAyB,GAAG,CAAC,CAAC,MAAM,CAAC;IAChD,sCAAsC,EAAE,CAAC;SACtC,MAAM,CAAC;QACN,mBAAmB,EAAE,CAAC;aACnB,OAAO,EAAE;aACT,QAAQ,CACP,0FAA0F,CAC3F;QACH,SAAS,EAAE,CAAC;aACT,KAAK,CACJ,CAAC,CAAC,MAAM,CAAC;YACP,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gCAAgC,CAAC;YAClE,SAAS,EAAE,CAAC;iBACT,OAAO,EAAE;iBACT,QAAQ,CAAC,2CAA2C,CAAC;SACzD,CAAC,CACH;aACA,QAAQ,CAAC,sCAAsC,CAAC;KACpD,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CAAC,uDAAuD,CAAC;IAEpE,uCAAuC,EAAE,CAAC;SACvC,MAAM,CAAC;QACN,gBAAgB,EAAE,CAAC;aAChB,OAAO,EAAE;aACT,QAAQ,CACP,0EAA0E,CAC3E;KACJ,CAAC;SACD,QAAQ,EAAE;SACV,QAAQ,CAAC,wDAAwD,CAAC;CACtE,CAAC,CAAA"}
|
|
@@ -7,11 +7,14 @@ export const phone = device
|
|
|
7
7
|
connected_account_id: true,
|
|
8
8
|
})
|
|
9
9
|
.extend({
|
|
10
|
-
device_type: z
|
|
10
|
+
device_type: z
|
|
11
|
+
.enum(['android_phone', 'ios_phone'])
|
|
12
|
+
.describe('Type of phone.'),
|
|
11
13
|
})
|
|
12
14
|
.merge(z.object({ properties: phone_specific_properties })).describe(`
|
|
13
15
|
---
|
|
14
16
|
route_path: /phones
|
|
15
17
|
---
|
|
18
|
+
Properties of the phone.
|
|
16
19
|
`);
|
|
17
20
|
//# sourceMappingURL=phone.js.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"phone.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/devices/phone.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAEjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAEjE,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM;KACxB,IAAI,CAAC;IACJ,oBAAoB,EAAE,IAAI;CAC3B,CAAC;KACD,MAAM,CAAC;IACN,WAAW,EAAE,CAAC,
|
|
1
|
+
{"version":3,"file":"phone.js","sourceRoot":"","sources":["../../../../../src/lib/seam/connect/models/devices/phone.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAA;AACpC,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAEjE,OAAO,EAAE,yBAAyB,EAAE,MAAM,uBAAuB,CAAA;AAEjE,MAAM,CAAC,MAAM,KAAK,GAAG,MAAM;KACxB,IAAI,CAAC;IACJ,oBAAoB,EAAE,IAAI;CAC3B,CAAC;KACD,MAAM,CAAC;IACN,WAAW,EAAE,CAAC;SACX,IAAI,CAAC,CAAC,eAAe,EAAE,WAAW,CAAC,CAAC;SACpC,QAAQ,CAAC,gBAAgB,CAAC;CAC9B,CAAC;KACD,KAAK,CAAC,CAAC,CAAC,MAAM,CAAC,EAAE,UAAU,EAAE,yBAAyB,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;;;;;GAKpE,CAAC,CAAA"}
|
|
@@ -2782,14 +2782,18 @@ declare const _default: {
|
|
|
2782
2782
|
} | {
|
|
2783
2783
|
properties: {
|
|
2784
2784
|
assa_abloy_credential_service_metadata: {
|
|
2785
|
+
description: string;
|
|
2785
2786
|
properties: {
|
|
2786
2787
|
endpoints: {
|
|
2788
|
+
description: string;
|
|
2787
2789
|
items: {
|
|
2788
2790
|
properties: {
|
|
2789
2791
|
endpoint_id: {
|
|
2792
|
+
description: string;
|
|
2790
2793
|
type: string;
|
|
2791
2794
|
};
|
|
2792
2795
|
is_active: {
|
|
2796
|
+
description: string;
|
|
2793
2797
|
type: string;
|
|
2794
2798
|
};
|
|
2795
2799
|
};
|
|
@@ -2799,6 +2803,7 @@ declare const _default: {
|
|
|
2799
2803
|
type: string;
|
|
2800
2804
|
};
|
|
2801
2805
|
has_active_endpoint: {
|
|
2806
|
+
description: string;
|
|
2802
2807
|
type: string;
|
|
2803
2808
|
};
|
|
2804
2809
|
};
|
|
@@ -2806,8 +2811,10 @@ declare const _default: {
|
|
|
2806
2811
|
type: string;
|
|
2807
2812
|
};
|
|
2808
2813
|
salto_space_credential_service_metadata: {
|
|
2814
|
+
description: string;
|
|
2809
2815
|
properties: {
|
|
2810
2816
|
has_active_phone: {
|
|
2817
|
+
description: string;
|
|
2811
2818
|
type: string;
|
|
2812
2819
|
};
|
|
2813
2820
|
};
|
|
@@ -6776,6 +6783,7 @@ declare const _default: {
|
|
|
6776
6783
|
'x-route-path': string;
|
|
6777
6784
|
};
|
|
6778
6785
|
phone: {
|
|
6786
|
+
description: string;
|
|
6779
6787
|
properties: {
|
|
6780
6788
|
can_hvac_cool: {
|
|
6781
6789
|
type: string;
|
|
@@ -6837,6 +6845,7 @@ declare const _default: {
|
|
|
6837
6845
|
type: string;
|
|
6838
6846
|
};
|
|
6839
6847
|
device_type: {
|
|
6848
|
+
description: string;
|
|
6840
6849
|
enum: string[];
|
|
6841
6850
|
type: string;
|
|
6842
6851
|
};
|
|
@@ -6919,14 +6928,18 @@ declare const _default: {
|
|
|
6919
6928
|
properties: {
|
|
6920
6929
|
properties: {
|
|
6921
6930
|
assa_abloy_credential_service_metadata: {
|
|
6931
|
+
description: string;
|
|
6922
6932
|
properties: {
|
|
6923
6933
|
endpoints: {
|
|
6934
|
+
description: string;
|
|
6924
6935
|
items: {
|
|
6925
6936
|
properties: {
|
|
6926
6937
|
endpoint_id: {
|
|
6938
|
+
description: string;
|
|
6927
6939
|
type: string;
|
|
6928
6940
|
};
|
|
6929
6941
|
is_active: {
|
|
6942
|
+
description: string;
|
|
6930
6943
|
type: string;
|
|
6931
6944
|
};
|
|
6932
6945
|
};
|
|
@@ -6936,6 +6949,7 @@ declare const _default: {
|
|
|
6936
6949
|
type: string;
|
|
6937
6950
|
};
|
|
6938
6951
|
has_active_endpoint: {
|
|
6952
|
+
description: string;
|
|
6939
6953
|
type: string;
|
|
6940
6954
|
};
|
|
6941
6955
|
};
|
|
@@ -6943,8 +6957,10 @@ declare const _default: {
|
|
|
6943
6957
|
type: string;
|
|
6944
6958
|
};
|
|
6945
6959
|
salto_space_credential_service_metadata: {
|
|
6960
|
+
description: string;
|
|
6946
6961
|
properties: {
|
|
6947
6962
|
has_active_phone: {
|
|
6963
|
+
description: string;
|
|
6948
6964
|
type: string;
|
|
6949
6965
|
};
|
|
6950
6966
|
};
|
|
@@ -6988,23 +7004,6 @@ declare const _default: {
|
|
|
6988
7004
|
type: string;
|
|
6989
7005
|
'x-route-path': string;
|
|
6990
7006
|
};
|
|
6991
|
-
service_health: {
|
|
6992
|
-
properties: {
|
|
6993
|
-
description: {
|
|
6994
|
-
type: string;
|
|
6995
|
-
};
|
|
6996
|
-
service: {
|
|
6997
|
-
type: string;
|
|
6998
|
-
};
|
|
6999
|
-
status: {
|
|
7000
|
-
enum: string[];
|
|
7001
|
-
type: string;
|
|
7002
|
-
};
|
|
7003
|
-
};
|
|
7004
|
-
required: string[];
|
|
7005
|
-
type: string;
|
|
7006
|
-
'x-route-path': string;
|
|
7007
|
-
};
|
|
7008
7007
|
thermostat_schedule: {
|
|
7009
7008
|
description: string;
|
|
7010
7009
|
properties: {
|
|
@@ -18892,6 +18891,7 @@ declare const _default: {
|
|
|
18892
18891
|
};
|
|
18893
18892
|
'/phones/deactivate': {
|
|
18894
18893
|
post: {
|
|
18894
|
+
description: string;
|
|
18895
18895
|
operationId: string;
|
|
18896
18896
|
requestBody: {
|
|
18897
18897
|
content: {
|
|
@@ -18899,6 +18899,7 @@ declare const _default: {
|
|
|
18899
18899
|
schema: {
|
|
18900
18900
|
properties: {
|
|
18901
18901
|
device_id: {
|
|
18902
|
+
description: string;
|
|
18902
18903
|
type: string;
|
|
18903
18904
|
};
|
|
18904
18905
|
};
|
|
@@ -18958,10 +18959,12 @@ declare const _default: {
|
|
|
18958
18959
|
'x-fern-sdk-group-name': string[];
|
|
18959
18960
|
'x-fern-sdk-method-name': string;
|
|
18960
18961
|
'x-response-key': null;
|
|
18962
|
+
'x-title': string;
|
|
18961
18963
|
};
|
|
18962
18964
|
};
|
|
18963
18965
|
'/phones/list': {
|
|
18964
18966
|
post: {
|
|
18967
|
+
description: string;
|
|
18965
18968
|
operationId: string;
|
|
18966
18969
|
requestBody: {
|
|
18967
18970
|
content: {
|
|
@@ -18969,10 +18972,12 @@ declare const _default: {
|
|
|
18969
18972
|
schema: {
|
|
18970
18973
|
properties: {
|
|
18971
18974
|
acs_credential_id: {
|
|
18975
|
+
description: string;
|
|
18972
18976
|
format: string;
|
|
18973
18977
|
type: string;
|
|
18974
18978
|
};
|
|
18975
18979
|
owner_user_identity_id: {
|
|
18980
|
+
description: string;
|
|
18976
18981
|
format: string;
|
|
18977
18982
|
type: string;
|
|
18978
18983
|
};
|
|
@@ -19031,10 +19036,12 @@ declare const _default: {
|
|
|
19031
19036
|
'x-fern-sdk-method-name': string;
|
|
19032
19037
|
'x-fern-sdk-return-value': string;
|
|
19033
19038
|
'x-response-key': string;
|
|
19039
|
+
'x-title': string;
|
|
19034
19040
|
};
|
|
19035
19041
|
};
|
|
19036
19042
|
'/phones/simulate/create_sandbox_phone': {
|
|
19037
19043
|
post: {
|
|
19044
|
+
description: string;
|
|
19038
19045
|
operationId: string;
|
|
19039
19046
|
requestBody: {
|
|
19040
19047
|
content: {
|
|
@@ -19043,29 +19050,36 @@ declare const _default: {
|
|
|
19043
19050
|
properties: {
|
|
19044
19051
|
assa_abloy_metadata: {
|
|
19045
19052
|
default: {};
|
|
19053
|
+
description: string;
|
|
19046
19054
|
properties: {
|
|
19047
19055
|
application_version: {
|
|
19048
19056
|
default: string;
|
|
19057
|
+
description: string;
|
|
19049
19058
|
type: string;
|
|
19050
19059
|
};
|
|
19051
19060
|
ble_capability: {
|
|
19052
19061
|
default: boolean;
|
|
19062
|
+
description: string;
|
|
19053
19063
|
type: string;
|
|
19054
19064
|
};
|
|
19055
19065
|
hce_capability: {
|
|
19056
19066
|
default: boolean;
|
|
19067
|
+
description: string;
|
|
19057
19068
|
type: string;
|
|
19058
19069
|
};
|
|
19059
19070
|
nfc_capability: {
|
|
19060
19071
|
default: boolean;
|
|
19072
|
+
description: string;
|
|
19061
19073
|
type: string;
|
|
19062
19074
|
};
|
|
19063
19075
|
seos_applet_version: {
|
|
19064
19076
|
default: string;
|
|
19077
|
+
description: string;
|
|
19065
19078
|
type: string;
|
|
19066
19079
|
};
|
|
19067
19080
|
seos_tsm_endpoint_id: {
|
|
19068
19081
|
default: number;
|
|
19082
|
+
description: string;
|
|
19069
19083
|
format: string;
|
|
19070
19084
|
type: string;
|
|
19071
19085
|
};
|
|
@@ -19073,32 +19087,39 @@ declare const _default: {
|
|
|
19073
19087
|
type: string;
|
|
19074
19088
|
};
|
|
19075
19089
|
custom_sdk_installation_id: {
|
|
19090
|
+
description: string;
|
|
19076
19091
|
type: string;
|
|
19077
19092
|
};
|
|
19078
19093
|
phone_metadata: {
|
|
19079
19094
|
default: {};
|
|
19095
|
+
description: string;
|
|
19080
19096
|
properties: {
|
|
19081
19097
|
device_manufacturer: {
|
|
19082
19098
|
default: string;
|
|
19099
|
+
description: string;
|
|
19083
19100
|
type: string;
|
|
19084
19101
|
};
|
|
19085
19102
|
device_model: {
|
|
19086
19103
|
default: string;
|
|
19104
|
+
description: string;
|
|
19087
19105
|
type: string;
|
|
19088
19106
|
};
|
|
19089
19107
|
operating_system: {
|
|
19090
19108
|
default: string;
|
|
19109
|
+
description: string;
|
|
19091
19110
|
enum: string[];
|
|
19092
19111
|
type: string;
|
|
19093
19112
|
};
|
|
19094
19113
|
os_version: {
|
|
19095
19114
|
default: string;
|
|
19115
|
+
description: string;
|
|
19096
19116
|
type: string;
|
|
19097
19117
|
};
|
|
19098
19118
|
};
|
|
19099
19119
|
type: string;
|
|
19100
19120
|
};
|
|
19101
19121
|
user_identity_id: {
|
|
19122
|
+
description: string;
|
|
19102
19123
|
format: string;
|
|
19103
19124
|
type: string;
|
|
19104
19125
|
};
|
|
@@ -19155,6 +19176,7 @@ declare const _default: {
|
|
|
19155
19176
|
'x-fern-sdk-method-name': string;
|
|
19156
19177
|
'x-fern-sdk-return-value': string;
|
|
19157
19178
|
'x-response-key': string;
|
|
19179
|
+
'x-title': string;
|
|
19158
19180
|
};
|
|
19159
19181
|
};
|
|
19160
19182
|
'/thermostats/activate_climate_preset': {
|
|
@@ -5468,26 +5468,41 @@ export default {
|
|
|
5468
5468
|
{
|
|
5469
5469
|
properties: {
|
|
5470
5470
|
assa_abloy_credential_service_metadata: {
|
|
5471
|
+
description: 'ASSA ABLOY Credential Service metadata for the phone.',
|
|
5471
5472
|
properties: {
|
|
5472
5473
|
endpoints: {
|
|
5474
|
+
description: 'Endpoints associated with the phone.',
|
|
5473
5475
|
items: {
|
|
5474
5476
|
properties: {
|
|
5475
|
-
endpoint_id: {
|
|
5476
|
-
|
|
5477
|
+
endpoint_id: {
|
|
5478
|
+
description: 'ID of the associated endpoint.',
|
|
5479
|
+
type: 'string',
|
|
5480
|
+
},
|
|
5481
|
+
is_active: {
|
|
5482
|
+
description: 'Indicated whether the endpoint is active.',
|
|
5483
|
+
type: 'boolean',
|
|
5484
|
+
},
|
|
5477
5485
|
},
|
|
5478
5486
|
required: ['endpoint_id', 'is_active'],
|
|
5479
5487
|
type: 'object',
|
|
5480
5488
|
},
|
|
5481
5489
|
type: 'array',
|
|
5482
5490
|
},
|
|
5483
|
-
has_active_endpoint: {
|
|
5491
|
+
has_active_endpoint: {
|
|
5492
|
+
description: 'Indicates whether the credential service has active endpoints associated with the phone.',
|
|
5493
|
+
type: 'boolean',
|
|
5494
|
+
},
|
|
5484
5495
|
},
|
|
5485
5496
|
required: ['has_active_endpoint', 'endpoints'],
|
|
5486
5497
|
type: 'object',
|
|
5487
5498
|
},
|
|
5488
5499
|
salto_space_credential_service_metadata: {
|
|
5500
|
+
description: 'Salto Space credential service metadata for the phone.',
|
|
5489
5501
|
properties: {
|
|
5490
|
-
has_active_phone: {
|
|
5502
|
+
has_active_phone: {
|
|
5503
|
+
description: 'Indicates whether the credential service has an active associated phone.',
|
|
5504
|
+
type: 'boolean',
|
|
5505
|
+
},
|
|
5491
5506
|
},
|
|
5492
5507
|
required: ['has_active_phone'],
|
|
5493
5508
|
type: 'object',
|
|
@@ -10939,6 +10954,7 @@ export default {
|
|
|
10939
10954
|
'x-route-path': '/noise_sensors/noise_thresholds',
|
|
10940
10955
|
},
|
|
10941
10956
|
phone: {
|
|
10957
|
+
description: 'Properties of the phone.',
|
|
10942
10958
|
properties: {
|
|
10943
10959
|
can_hvac_cool: { type: 'boolean' },
|
|
10944
10960
|
can_hvac_heat: { type: 'boolean' },
|
|
@@ -10982,7 +10998,11 @@ export default {
|
|
|
10982
10998
|
format: 'uuid',
|
|
10983
10999
|
type: 'string',
|
|
10984
11000
|
},
|
|
10985
|
-
device_type: {
|
|
11001
|
+
device_type: {
|
|
11002
|
+
description: 'Type of phone.',
|
|
11003
|
+
enum: ['android_phone', 'ios_phone'],
|
|
11004
|
+
type: 'string',
|
|
11005
|
+
},
|
|
10986
11006
|
display_name: {
|
|
10987
11007
|
description: '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.',
|
|
10988
11008
|
type: 'string',
|
|
@@ -11233,25 +11253,42 @@ export default {
|
|
|
11233
11253
|
properties: {
|
|
11234
11254
|
properties: {
|
|
11235
11255
|
assa_abloy_credential_service_metadata: {
|
|
11256
|
+
description: 'ASSA ABLOY Credential Service metadata for the phone.',
|
|
11236
11257
|
properties: {
|
|
11237
11258
|
endpoints: {
|
|
11259
|
+
description: 'Endpoints associated with the phone.',
|
|
11238
11260
|
items: {
|
|
11239
11261
|
properties: {
|
|
11240
|
-
endpoint_id: {
|
|
11241
|
-
|
|
11262
|
+
endpoint_id: {
|
|
11263
|
+
description: 'ID of the associated endpoint.',
|
|
11264
|
+
type: 'string',
|
|
11265
|
+
},
|
|
11266
|
+
is_active: {
|
|
11267
|
+
description: 'Indicated whether the endpoint is active.',
|
|
11268
|
+
type: 'boolean',
|
|
11269
|
+
},
|
|
11242
11270
|
},
|
|
11243
11271
|
required: ['endpoint_id', 'is_active'],
|
|
11244
11272
|
type: 'object',
|
|
11245
11273
|
},
|
|
11246
11274
|
type: 'array',
|
|
11247
11275
|
},
|
|
11248
|
-
has_active_endpoint: {
|
|
11276
|
+
has_active_endpoint: {
|
|
11277
|
+
description: 'Indicates whether the credential service has active endpoints associated with the phone.',
|
|
11278
|
+
type: 'boolean',
|
|
11279
|
+
},
|
|
11249
11280
|
},
|
|
11250
11281
|
required: ['has_active_endpoint', 'endpoints'],
|
|
11251
11282
|
type: 'object',
|
|
11252
11283
|
},
|
|
11253
11284
|
salto_space_credential_service_metadata: {
|
|
11254
|
-
|
|
11285
|
+
description: 'Salto Space credential service metadata for the phone.',
|
|
11286
|
+
properties: {
|
|
11287
|
+
has_active_phone: {
|
|
11288
|
+
description: 'Indicates whether the credential service has an active associated phone.',
|
|
11289
|
+
type: 'boolean',
|
|
11290
|
+
},
|
|
11291
|
+
},
|
|
11255
11292
|
required: ['has_active_phone'],
|
|
11256
11293
|
type: 'object',
|
|
11257
11294
|
},
|
|
@@ -11498,16 +11535,6 @@ export default {
|
|
|
11498
11535
|
type: 'object',
|
|
11499
11536
|
'x-route-path': '/phones',
|
|
11500
11537
|
},
|
|
11501
|
-
service_health: {
|
|
11502
|
-
properties: {
|
|
11503
|
-
description: { type: 'string' },
|
|
11504
|
-
service: { type: 'string' },
|
|
11505
|
-
status: { enum: ['healthy', 'degraded', 'down'], type: 'string' },
|
|
11506
|
-
},
|
|
11507
|
-
required: ['service', 'status', 'description'],
|
|
11508
|
-
type: 'object',
|
|
11509
|
-
'x-route-path': '/health',
|
|
11510
|
-
},
|
|
11511
11538
|
thermostat_schedule: {
|
|
11512
11539
|
description: 'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.',
|
|
11513
11540
|
properties: {
|
|
@@ -22291,12 +22318,18 @@ export default {
|
|
|
22291
22318
|
},
|
|
22292
22319
|
'/phones/deactivate': {
|
|
22293
22320
|
post: {
|
|
22321
|
+
description: 'Deactivates a phone, which is useful, for example, if a user has lost their phone. For more information, see [App User Lost Phone Process](https://docs.seam.co/latest/capability-guides/mobile-access/managing-phones-for-a-user-identity#app-user-lost-phone-process).',
|
|
22294
22322
|
operationId: 'phonesDeactivatePost',
|
|
22295
22323
|
requestBody: {
|
|
22296
22324
|
content: {
|
|
22297
22325
|
'application/json': {
|
|
22298
22326
|
schema: {
|
|
22299
|
-
properties: {
|
|
22327
|
+
properties: {
|
|
22328
|
+
device_id: {
|
|
22329
|
+
description: 'Device ID of the desired phone.',
|
|
22330
|
+
type: 'string',
|
|
22331
|
+
},
|
|
22332
|
+
},
|
|
22300
22333
|
required: ['device_id'],
|
|
22301
22334
|
type: 'object',
|
|
22302
22335
|
},
|
|
@@ -22330,18 +22363,28 @@ export default {
|
|
|
22330
22363
|
'x-fern-sdk-group-name': ['phones'],
|
|
22331
22364
|
'x-fern-sdk-method-name': 'deactivate',
|
|
22332
22365
|
'x-response-key': null,
|
|
22366
|
+
'x-title': 'Deactivate a Phone',
|
|
22333
22367
|
},
|
|
22334
22368
|
},
|
|
22335
22369
|
'/phones/list': {
|
|
22336
22370
|
post: {
|
|
22371
|
+
description: 'Returns a list of all phones. To filter the list of returned phones by a specific owner user identity or credential, include the `owner_user_identity_id` or `acs_credential_id`, respectively, in the request body.',
|
|
22337
22372
|
operationId: 'phonesListPost',
|
|
22338
22373
|
requestBody: {
|
|
22339
22374
|
content: {
|
|
22340
22375
|
'application/json': {
|
|
22341
22376
|
schema: {
|
|
22342
22377
|
properties: {
|
|
22343
|
-
acs_credential_id: {
|
|
22344
|
-
|
|
22378
|
+
acs_credential_id: {
|
|
22379
|
+
description: 'ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones.',
|
|
22380
|
+
format: 'uuid',
|
|
22381
|
+
type: 'string',
|
|
22382
|
+
},
|
|
22383
|
+
owner_user_identity_id: {
|
|
22384
|
+
description: 'ID of the user identity that represents the owner by which to filter the list of returned phones.',
|
|
22385
|
+
format: 'uuid',
|
|
22386
|
+
type: 'string',
|
|
22387
|
+
},
|
|
22345
22388
|
},
|
|
22346
22389
|
type: 'object',
|
|
22347
22390
|
},
|
|
@@ -22381,10 +22424,12 @@ export default {
|
|
|
22381
22424
|
'x-fern-sdk-method-name': 'list',
|
|
22382
22425
|
'x-fern-sdk-return-value': 'phones',
|
|
22383
22426
|
'x-response-key': 'phones',
|
|
22427
|
+
'x-title': 'List Phones',
|
|
22384
22428
|
},
|
|
22385
22429
|
},
|
|
22386
22430
|
'/phones/simulate/create_sandbox_phone': {
|
|
22387
22431
|
post: {
|
|
22432
|
+
description: 'Creates a new simulated phone in a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). For more information, see [Creating a Simulated Phone for a User Identity](https://docs.seam.co/latest/capability-guides/mobile-access/developing-in-a-sandbox-workspace#creating-a-simulated-phone-for-a-user-identity).',
|
|
22388
22433
|
operationId: 'phonesSimulateCreateSandboxPhonePost',
|
|
22389
22434
|
requestBody: {
|
|
22390
22435
|
content: {
|
|
@@ -22393,42 +22438,79 @@ export default {
|
|
|
22393
22438
|
properties: {
|
|
22394
22439
|
assa_abloy_metadata: {
|
|
22395
22440
|
default: {},
|
|
22441
|
+
description: 'ASSA ABLOY metadata to associate with the simulated phone.',
|
|
22396
22442
|
properties: {
|
|
22397
|
-
application_version: {
|
|
22398
|
-
|
|
22399
|
-
|
|
22400
|
-
|
|
22401
|
-
|
|
22443
|
+
application_version: {
|
|
22444
|
+
default: '1.0.0',
|
|
22445
|
+
description: 'Application version that you want to use for the simulated phone.',
|
|
22446
|
+
type: 'string',
|
|
22447
|
+
},
|
|
22448
|
+
ble_capability: {
|
|
22449
|
+
default: true,
|
|
22450
|
+
description: 'Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability.',
|
|
22451
|
+
type: 'boolean',
|
|
22452
|
+
},
|
|
22453
|
+
hce_capability: {
|
|
22454
|
+
default: false,
|
|
22455
|
+
description: 'Indicates whether the simulated phone should have host card emulation (HCE) capability.',
|
|
22456
|
+
type: 'boolean',
|
|
22457
|
+
},
|
|
22458
|
+
nfc_capability: {
|
|
22459
|
+
default: false,
|
|
22460
|
+
description: 'Indicates whether the simulated phone should have near-field communication (NFC) capability.',
|
|
22461
|
+
type: 'boolean',
|
|
22462
|
+
},
|
|
22463
|
+
seos_applet_version: {
|
|
22464
|
+
default: '1.0.0',
|
|
22465
|
+
description: 'SEOS applet version that you want to use for the simulated phone.',
|
|
22466
|
+
type: 'string',
|
|
22467
|
+
},
|
|
22402
22468
|
seos_tsm_endpoint_id: {
|
|
22403
22469
|
default: 1,
|
|
22470
|
+
description: 'ID of the SEOS trusted service manager (TSM) endpoint that you want to use for the simulated phone.',
|
|
22404
22471
|
format: 'float',
|
|
22405
22472
|
type: 'number',
|
|
22406
22473
|
},
|
|
22407
22474
|
},
|
|
22408
22475
|
type: 'object',
|
|
22409
22476
|
},
|
|
22410
|
-
custom_sdk_installation_id: {
|
|
22477
|
+
custom_sdk_installation_id: {
|
|
22478
|
+
description: 'ID of the custom SDK installation to use for the simulated phone.',
|
|
22479
|
+
type: 'string',
|
|
22480
|
+
},
|
|
22411
22481
|
phone_metadata: {
|
|
22412
22482
|
default: {},
|
|
22483
|
+
description: 'Metadata to associate with the simulated phone.',
|
|
22413
22484
|
properties: {
|
|
22414
22485
|
device_manufacturer: {
|
|
22415
22486
|
default: 'Samsung',
|
|
22487
|
+
description: 'Manufacturer that you want to use for the simulated phone.',
|
|
22416
22488
|
type: 'string',
|
|
22417
22489
|
},
|
|
22418
22490
|
device_model: {
|
|
22419
22491
|
default: 'Samsung Galaxy S10',
|
|
22492
|
+
description: 'Device model that you want to use for the simulated phone.',
|
|
22420
22493
|
type: 'string',
|
|
22421
22494
|
},
|
|
22422
22495
|
operating_system: {
|
|
22423
22496
|
default: 'android',
|
|
22497
|
+
description: 'Mobile operating system that you want to use for the simulated phone.',
|
|
22424
22498
|
enum: ['android', 'ios'],
|
|
22425
22499
|
type: 'string',
|
|
22426
22500
|
},
|
|
22427
|
-
os_version: {
|
|
22501
|
+
os_version: {
|
|
22502
|
+
default: '10',
|
|
22503
|
+
description: 'Mobile operating system version that you want to use for the simulated phone.',
|
|
22504
|
+
type: 'string',
|
|
22505
|
+
},
|
|
22428
22506
|
},
|
|
22429
22507
|
type: 'object',
|
|
22430
22508
|
},
|
|
22431
|
-
user_identity_id: {
|
|
22509
|
+
user_identity_id: {
|
|
22510
|
+
description: 'ID of the user identity to associate with the simulated phone.',
|
|
22511
|
+
format: 'uuid',
|
|
22512
|
+
type: 'string',
|
|
22513
|
+
},
|
|
22432
22514
|
},
|
|
22433
22515
|
required: ['user_identity_id'],
|
|
22434
22516
|
type: 'object',
|
|
@@ -22466,6 +22548,7 @@ export default {
|
|
|
22466
22548
|
'x-fern-sdk-method-name': 'create_sandbox_phone',
|
|
22467
22549
|
'x-fern-sdk-return-value': 'phone',
|
|
22468
22550
|
'x-response-key': 'phone',
|
|
22551
|
+
'x-title': 'Create a Sandbox Phone',
|
|
22469
22552
|
},
|
|
22470
22553
|
},
|
|
22471
22554
|
'/thermostats/activate_climate_preset': {
|