@seamapi/types 1.1102.0 → 1.1104.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/seam/connect/models/access-grants/access-grant.d.ts +37 -21
- package/lib/seam/connect/models/access-grants/access-grant.js +4 -3
- package/lib/seam/connect/models/access-grants/access-grant.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-access-group.js +2 -2
- package/lib/seam/connect/models/acs/acs-access-group.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-entrance.d.ts +38 -8
- package/lib/seam/connect/models/acs/acs-entrance.js +22 -9
- package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
- package/lib/seam/connect/models/acs/acs-users/acs-user.d.ts +75 -4
- package/lib/seam/connect/models/acs/acs-users/acs-user.js +32 -30
- package/lib/seam/connect/models/acs/acs-users/acs-user.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +395 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +10 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/pause-speaker-playback.d.ts +87 -0
- package/lib/seam/connect/models/action-attempts/pause-speaker-playback.js +37 -0
- package/lib/seam/connect/models/action-attempts/pause-speaker-playback.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-chime.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-chime.js +31 -0
- package/lib/seam/connect/models/action-attempts/play-speaker-chime.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/resume-speaker-playback.d.ts +87 -0
- package/lib/seam/connect/models/action-attempts/resume-speaker-playback.js +37 -0
- package/lib/seam/connect/models/action-attempts/resume-speaker-playback.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-mute.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-mute.js +31 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-mute.js.map +1 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-volume.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-volume.js +31 -0
- package/lib/seam/connect/models/action-attempts/set-speaker-volume.js.map +1 -0
- package/lib/seam/connect/models/connect-webviews/connect-webview.d.ts +3 -3
- package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +3 -3
- package/lib/seam/connect/models/devices/capability-properties/index.d.ts +95 -1
- package/lib/seam/connect/models/devices/capability-properties/index.js +4 -2
- package/lib/seam/connect/models/devices/capability-properties/index.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/speaker.d.ts +98 -0
- package/lib/seam/connect/models/devices/capability-properties/speaker.js +61 -0
- package/lib/seam/connect/models/devices/capability-properties/speaker.js.map +1 -0
- package/lib/seam/connect/models/devices/device-metadata.d.ts +33 -0
- package/lib/seam/connect/models/devices/device-metadata.js +26 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +12 -0
- package/lib/seam/connect/models/devices/device-provider.js +1 -0
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device-type.d.ts +7 -1
- package/lib/seam/connect/models/devices/device-type.js +8 -0
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +200 -3
- package/lib/seam/connect/models/devices/device.js +16 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +1126 -22
- package/lib/seam/connect/models/devices/phone.js +4 -19
- package/lib/seam/connect/models/devices/phone.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +144 -3
- package/lib/seam/connect/models/phones/phone-session.d.ts +28 -26
- package/lib/seam/connect/models/provider-capability.d.ts +1 -1
- package/lib/seam/connect/models/provider-capability.js +1 -0
- package/lib/seam/connect/models/provider-capability.js.map +1 -1
- package/lib/seam/connect/models/user-identities/user-identity.js +4 -4
- package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
- package/lib/seam/connect/openapi.js +2006 -136
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +8195 -142
- package/package.json +1 -1
- package/src/lib/seam/connect/internal/enums.ts +2 -0
- package/src/lib/seam/connect/internal/schemas.ts +1 -0
- package/src/lib/seam/connect/models/access-grants/access-grant.ts +13 -5
- package/src/lib/seam/connect/models/acs/acs-access-group.ts +2 -2
- package/src/lib/seam/connect/models/acs/acs-entrance.ts +36 -17
- package/src/lib/seam/connect/models/acs/acs-users/acs-user.ts +44 -34
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +10 -0
- package/src/lib/seam/connect/models/action-attempts/pause-speaker-playback.ts +54 -0
- package/src/lib/seam/connect/models/action-attempts/play-speaker-chime.ts +46 -0
- package/src/lib/seam/connect/models/action-attempts/resume-speaker-playback.ts +54 -0
- package/src/lib/seam/connect/models/action-attempts/set-speaker-mute.ts +43 -0
- package/src/lib/seam/connect/models/action-attempts/set-speaker-volume.ts +46 -0
- package/src/lib/seam/connect/models/devices/capability-properties/index.ts +9 -1
- package/src/lib/seam/connect/models/devices/capability-properties/speaker.ts +76 -0
- package/src/lib/seam/connect/models/devices/device-metadata.ts +29 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +1 -0
- package/src/lib/seam/connect/models/devices/device-type.ts +16 -0
- package/src/lib/seam/connect/models/devices/device.ts +18 -0
- package/src/lib/seam/connect/models/devices/phone.ts +4 -27
- package/src/lib/seam/connect/models/provider-capability.ts +1 -0
- package/src/lib/seam/connect/models/user-identities/user-identity.ts +4 -4
- package/src/lib/seam/connect/openapi.ts +2537 -407
- package/src/lib/seam/connect/route-types.ts +9097 -128
|
@@ -2220,7 +2220,8 @@ const openapi: OpenAPISpec = {
|
|
|
2220
2220
|
},
|
|
2221
2221
|
error_code: {
|
|
2222
2222
|
description:
|
|
2223
|
-
'Reason the access code could not be revoked
|
|
2223
|
+
'Reason the access code could not be revoked.',
|
|
2224
|
+
enum: ['offline_access_code_not_revocable'],
|
|
2224
2225
|
type: 'string',
|
|
2225
2226
|
},
|
|
2226
2227
|
message: {
|
|
@@ -4413,25 +4414,37 @@ const openapi: OpenAPISpec = {
|
|
|
4413
4414
|
description:
|
|
4414
4415
|
'Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
4415
4416
|
items: {
|
|
4416
|
-
|
|
4417
|
-
|
|
4418
|
-
|
|
4419
|
-
|
|
4420
|
-
|
|
4421
|
-
},
|
|
4422
|
-
error_code: {
|
|
4423
|
-
description:
|
|
4424
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
4425
|
-
type: 'string',
|
|
4426
|
-
},
|
|
4427
|
-
message: {
|
|
4417
|
+
description:
|
|
4418
|
+
'Error associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
4419
|
+
discriminator: { propertyName: 'error_code' },
|
|
4420
|
+
oneOf: [
|
|
4421
|
+
{
|
|
4428
4422
|
description:
|
|
4429
|
-
'
|
|
4430
|
-
|
|
4423
|
+
'Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.',
|
|
4424
|
+
properties: {
|
|
4425
|
+
created_at: {
|
|
4426
|
+
description:
|
|
4427
|
+
'Date and time at which Seam created the error.',
|
|
4428
|
+
format: 'date-time',
|
|
4429
|
+
type: 'string',
|
|
4430
|
+
},
|
|
4431
|
+
error_code: {
|
|
4432
|
+
description:
|
|
4433
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
4434
|
+
enum: ['entrance_removed'],
|
|
4435
|
+
type: 'string',
|
|
4436
|
+
},
|
|
4437
|
+
message: {
|
|
4438
|
+
description:
|
|
4439
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
4440
|
+
type: 'string',
|
|
4441
|
+
},
|
|
4442
|
+
},
|
|
4443
|
+
required: ['created_at', 'message', 'error_code'],
|
|
4444
|
+
type: 'object',
|
|
4445
|
+
'x-resource-type': 'acs_entrance',
|
|
4431
4446
|
},
|
|
4432
|
-
|
|
4433
|
-
required: ['error_code', 'message', 'created_at'],
|
|
4434
|
-
type: 'object',
|
|
4447
|
+
],
|
|
4435
4448
|
},
|
|
4436
4449
|
type: 'array',
|
|
4437
4450
|
},
|
|
@@ -11732,6 +11745,7 @@ const openapi: OpenAPISpec = {
|
|
|
11732
11745
|
type: 'object',
|
|
11733
11746
|
},
|
|
11734
11747
|
{
|
|
11748
|
+
description: 'Setting the speaker volume is pending.',
|
|
11735
11749
|
properties: {
|
|
11736
11750
|
action_attempt_id: {
|
|
11737
11751
|
description: 'ID of the action attempt.',
|
|
@@ -11739,115 +11753,9 @@ const openapi: OpenAPISpec = {
|
|
|
11739
11753
|
type: 'string',
|
|
11740
11754
|
},
|
|
11741
11755
|
action_type: {
|
|
11742
|
-
description: 'Syncing access codes is pending.',
|
|
11743
|
-
enum: ['SYNC_ACCESS_CODES'],
|
|
11744
|
-
type: 'string',
|
|
11745
|
-
},
|
|
11746
|
-
error: {
|
|
11747
11756
|
description:
|
|
11748
|
-
'
|
|
11749
|
-
|
|
11750
|
-
},
|
|
11751
|
-
result: {
|
|
11752
|
-
description:
|
|
11753
|
-
'Result of the action attempt. Null for pending action attempts.',
|
|
11754
|
-
nullable: true,
|
|
11755
|
-
},
|
|
11756
|
-
status: { enum: ['pending'], type: 'string' },
|
|
11757
|
-
},
|
|
11758
|
-
required: [
|
|
11759
|
-
'action_attempt_id',
|
|
11760
|
-
'status',
|
|
11761
|
-
'result',
|
|
11762
|
-
'error',
|
|
11763
|
-
'action_type',
|
|
11764
|
-
],
|
|
11765
|
-
type: 'object',
|
|
11766
|
-
},
|
|
11767
|
-
{
|
|
11768
|
-
properties: {
|
|
11769
|
-
action_attempt_id: {
|
|
11770
|
-
description: 'ID of the action attempt.',
|
|
11771
|
-
format: 'uuid',
|
|
11772
|
-
type: 'string',
|
|
11773
|
-
},
|
|
11774
|
-
action_type: {
|
|
11775
|
-
description: 'Syncing access codes succeeded.',
|
|
11776
|
-
enum: ['SYNC_ACCESS_CODES'],
|
|
11777
|
-
type: 'string',
|
|
11778
|
-
},
|
|
11779
|
-
error: {
|
|
11780
|
-
description:
|
|
11781
|
-
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
11782
|
-
nullable: true,
|
|
11783
|
-
},
|
|
11784
|
-
result: {
|
|
11785
|
-
description: 'Result of the action.',
|
|
11786
|
-
properties: {},
|
|
11787
|
-
type: 'object',
|
|
11788
|
-
},
|
|
11789
|
-
status: { enum: ['success'], type: 'string' },
|
|
11790
|
-
},
|
|
11791
|
-
required: [
|
|
11792
|
-
'action_attempt_id',
|
|
11793
|
-
'status',
|
|
11794
|
-
'error',
|
|
11795
|
-
'action_type',
|
|
11796
|
-
'result',
|
|
11797
|
-
],
|
|
11798
|
-
type: 'object',
|
|
11799
|
-
},
|
|
11800
|
-
{
|
|
11801
|
-
properties: {
|
|
11802
|
-
action_attempt_id: {
|
|
11803
|
-
description: 'ID of the action attempt.',
|
|
11804
|
-
format: 'uuid',
|
|
11805
|
-
type: 'string',
|
|
11806
|
-
},
|
|
11807
|
-
action_type: {
|
|
11808
|
-
description: 'Syncing access codes failed.',
|
|
11809
|
-
enum: ['SYNC_ACCESS_CODES'],
|
|
11810
|
-
type: 'string',
|
|
11811
|
-
},
|
|
11812
|
-
error: {
|
|
11813
|
-
description: 'Error associated with the action.',
|
|
11814
|
-
properties: {
|
|
11815
|
-
message: {
|
|
11816
|
-
description:
|
|
11817
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
11818
|
-
type: 'string',
|
|
11819
|
-
},
|
|
11820
|
-
type: { description: 'Type of the error.', type: 'string' },
|
|
11821
|
-
},
|
|
11822
|
-
required: ['type', 'message'],
|
|
11823
|
-
type: 'object',
|
|
11824
|
-
},
|
|
11825
|
-
result: {
|
|
11826
|
-
description:
|
|
11827
|
-
'Result of the action attempt. Null for failed action attempts.',
|
|
11828
|
-
nullable: true,
|
|
11829
|
-
},
|
|
11830
|
-
status: { enum: ['error'], type: 'string' },
|
|
11831
|
-
},
|
|
11832
|
-
required: [
|
|
11833
|
-
'action_attempt_id',
|
|
11834
|
-
'status',
|
|
11835
|
-
'result',
|
|
11836
|
-
'action_type',
|
|
11837
|
-
'error',
|
|
11838
|
-
],
|
|
11839
|
-
type: 'object',
|
|
11840
|
-
},
|
|
11841
|
-
{
|
|
11842
|
-
properties: {
|
|
11843
|
-
action_attempt_id: {
|
|
11844
|
-
description: 'ID of the action attempt.',
|
|
11845
|
-
format: 'uuid',
|
|
11846
|
-
type: 'string',
|
|
11847
|
-
},
|
|
11848
|
-
action_type: {
|
|
11849
|
-
description: 'Creating an access code is pending.',
|
|
11850
|
-
enum: ['CREATE_ACCESS_CODE'],
|
|
11757
|
+
'Action attempt to track the status of setting the volume on a speaker.',
|
|
11758
|
+
enum: ['SET_SPEAKER_VOLUME'],
|
|
11851
11759
|
type: 'string',
|
|
11852
11760
|
},
|
|
11853
11761
|
error: {
|
|
@@ -11872,6 +11780,7 @@ const openapi: OpenAPISpec = {
|
|
|
11872
11780
|
type: 'object',
|
|
11873
11781
|
},
|
|
11874
11782
|
{
|
|
11783
|
+
description: 'Setting the speaker volume succeeded.',
|
|
11875
11784
|
properties: {
|
|
11876
11785
|
action_attempt_id: {
|
|
11877
11786
|
description: 'ID of the action attempt.',
|
|
@@ -11879,122 +11788,9 @@ const openapi: OpenAPISpec = {
|
|
|
11879
11788
|
type: 'string',
|
|
11880
11789
|
},
|
|
11881
11790
|
action_type: {
|
|
11882
|
-
description: 'Creating an access code succeeded.',
|
|
11883
|
-
enum: ['CREATE_ACCESS_CODE'],
|
|
11884
|
-
type: 'string',
|
|
11885
|
-
},
|
|
11886
|
-
error: {
|
|
11887
|
-
description:
|
|
11888
|
-
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
11889
|
-
nullable: true,
|
|
11890
|
-
},
|
|
11891
|
-
result: {
|
|
11892
|
-
description: 'Result of the action.',
|
|
11893
|
-
properties: {
|
|
11894
|
-
access_code: {
|
|
11895
|
-
additionalProperties: {},
|
|
11896
|
-
description: 'Created access code.',
|
|
11897
|
-
type: 'object',
|
|
11898
|
-
},
|
|
11899
|
-
},
|
|
11900
|
-
required: ['access_code'],
|
|
11901
|
-
type: 'object',
|
|
11902
|
-
},
|
|
11903
|
-
status: { enum: ['success'], type: 'string' },
|
|
11904
|
-
},
|
|
11905
|
-
required: [
|
|
11906
|
-
'action_attempt_id',
|
|
11907
|
-
'status',
|
|
11908
|
-
'error',
|
|
11909
|
-
'action_type',
|
|
11910
|
-
'result',
|
|
11911
|
-
],
|
|
11912
|
-
type: 'object',
|
|
11913
|
-
},
|
|
11914
|
-
{
|
|
11915
|
-
properties: {
|
|
11916
|
-
action_attempt_id: {
|
|
11917
|
-
description: 'ID of the action attempt.',
|
|
11918
|
-
format: 'uuid',
|
|
11919
|
-
type: 'string',
|
|
11920
|
-
},
|
|
11921
|
-
action_type: {
|
|
11922
|
-
description: 'Creating an access code failed.',
|
|
11923
|
-
enum: ['CREATE_ACCESS_CODE'],
|
|
11924
|
-
type: 'string',
|
|
11925
|
-
},
|
|
11926
|
-
error: {
|
|
11927
|
-
description: 'Error associated with the action.',
|
|
11928
|
-
properties: {
|
|
11929
|
-
message: {
|
|
11930
|
-
description:
|
|
11931
|
-
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
11932
|
-
type: 'string',
|
|
11933
|
-
},
|
|
11934
|
-
type: { description: 'Type of the error.', type: 'string' },
|
|
11935
|
-
},
|
|
11936
|
-
required: ['type', 'message'],
|
|
11937
|
-
type: 'object',
|
|
11938
|
-
},
|
|
11939
|
-
result: {
|
|
11940
|
-
description:
|
|
11941
|
-
'Result of the action attempt. Null for failed action attempts.',
|
|
11942
|
-
nullable: true,
|
|
11943
|
-
},
|
|
11944
|
-
status: { enum: ['error'], type: 'string' },
|
|
11945
|
-
},
|
|
11946
|
-
required: [
|
|
11947
|
-
'action_attempt_id',
|
|
11948
|
-
'status',
|
|
11949
|
-
'result',
|
|
11950
|
-
'action_type',
|
|
11951
|
-
'error',
|
|
11952
|
-
],
|
|
11953
|
-
type: 'object',
|
|
11954
|
-
},
|
|
11955
|
-
{
|
|
11956
|
-
properties: {
|
|
11957
|
-
action_attempt_id: {
|
|
11958
|
-
description: 'ID of the action attempt.',
|
|
11959
|
-
format: 'uuid',
|
|
11960
|
-
type: 'string',
|
|
11961
|
-
},
|
|
11962
|
-
action_type: {
|
|
11963
|
-
description: 'Deleting an access code is pending.',
|
|
11964
|
-
enum: ['DELETE_ACCESS_CODE'],
|
|
11965
|
-
type: 'string',
|
|
11966
|
-
},
|
|
11967
|
-
error: {
|
|
11968
|
-
description:
|
|
11969
|
-
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
11970
|
-
nullable: true,
|
|
11971
|
-
},
|
|
11972
|
-
result: {
|
|
11973
11791
|
description:
|
|
11974
|
-
'
|
|
11975
|
-
|
|
11976
|
-
},
|
|
11977
|
-
status: { enum: ['pending'], type: 'string' },
|
|
11978
|
-
},
|
|
11979
|
-
required: [
|
|
11980
|
-
'action_attempt_id',
|
|
11981
|
-
'status',
|
|
11982
|
-
'result',
|
|
11983
|
-
'error',
|
|
11984
|
-
'action_type',
|
|
11985
|
-
],
|
|
11986
|
-
type: 'object',
|
|
11987
|
-
},
|
|
11988
|
-
{
|
|
11989
|
-
properties: {
|
|
11990
|
-
action_attempt_id: {
|
|
11991
|
-
description: 'ID of the action attempt.',
|
|
11992
|
-
format: 'uuid',
|
|
11993
|
-
type: 'string',
|
|
11994
|
-
},
|
|
11995
|
-
action_type: {
|
|
11996
|
-
description: 'Deleting an access code succeeded.',
|
|
11997
|
-
enum: ['DELETE_ACCESS_CODE'],
|
|
11792
|
+
'Action attempt to track the status of setting the volume on a speaker.',
|
|
11793
|
+
enum: ['SET_SPEAKER_VOLUME'],
|
|
11998
11794
|
type: 'string',
|
|
11999
11795
|
},
|
|
12000
11796
|
error: {
|
|
@@ -12019,6 +11815,7 @@ const openapi: OpenAPISpec = {
|
|
|
12019
11815
|
type: 'object',
|
|
12020
11816
|
},
|
|
12021
11817
|
{
|
|
11818
|
+
description: 'Setting the speaker volume failed.',
|
|
12022
11819
|
properties: {
|
|
12023
11820
|
action_attempt_id: {
|
|
12024
11821
|
description: 'ID of the action attempt.',
|
|
@@ -12026,8 +11823,9 @@ const openapi: OpenAPISpec = {
|
|
|
12026
11823
|
type: 'string',
|
|
12027
11824
|
},
|
|
12028
11825
|
action_type: {
|
|
12029
|
-
description:
|
|
12030
|
-
|
|
11826
|
+
description:
|
|
11827
|
+
'Action attempt to track the status of setting the volume on a speaker.',
|
|
11828
|
+
enum: ['SET_SPEAKER_VOLUME'],
|
|
12031
11829
|
type: 'string',
|
|
12032
11830
|
},
|
|
12033
11831
|
error: {
|
|
@@ -12060,6 +11858,7 @@ const openapi: OpenAPISpec = {
|
|
|
12060
11858
|
type: 'object',
|
|
12061
11859
|
},
|
|
12062
11860
|
{
|
|
11861
|
+
description: 'Muting or unmuting the speaker is pending.',
|
|
12063
11862
|
properties: {
|
|
12064
11863
|
action_attempt_id: {
|
|
12065
11864
|
description: 'ID of the action attempt.',
|
|
@@ -12067,8 +11866,9 @@ const openapi: OpenAPISpec = {
|
|
|
12067
11866
|
type: 'string',
|
|
12068
11867
|
},
|
|
12069
11868
|
action_type: {
|
|
12070
|
-
description:
|
|
12071
|
-
|
|
11869
|
+
description:
|
|
11870
|
+
'Action attempt to track the status of muting or unmuting a speaker.',
|
|
11871
|
+
enum: ['SET_SPEAKER_MUTE'],
|
|
12072
11872
|
type: 'string',
|
|
12073
11873
|
},
|
|
12074
11874
|
error: {
|
|
@@ -12093,6 +11893,7 @@ const openapi: OpenAPISpec = {
|
|
|
12093
11893
|
type: 'object',
|
|
12094
11894
|
},
|
|
12095
11895
|
{
|
|
11896
|
+
description: 'Muting or unmuting the speaker succeeded.',
|
|
12096
11897
|
properties: {
|
|
12097
11898
|
action_attempt_id: {
|
|
12098
11899
|
description: 'ID of the action attempt.',
|
|
@@ -12100,8 +11901,9 @@ const openapi: OpenAPISpec = {
|
|
|
12100
11901
|
type: 'string',
|
|
12101
11902
|
},
|
|
12102
11903
|
action_type: {
|
|
12103
|
-
description:
|
|
12104
|
-
|
|
11904
|
+
description:
|
|
11905
|
+
'Action attempt to track the status of muting or unmuting a speaker.',
|
|
11906
|
+
enum: ['SET_SPEAKER_MUTE'],
|
|
12105
11907
|
type: 'string',
|
|
12106
11908
|
},
|
|
12107
11909
|
error: {
|
|
@@ -12111,13 +11913,128 @@ const openapi: OpenAPISpec = {
|
|
|
12111
11913
|
},
|
|
12112
11914
|
result: {
|
|
12113
11915
|
description: 'Result of the action.',
|
|
11916
|
+
properties: {},
|
|
11917
|
+
type: 'object',
|
|
11918
|
+
},
|
|
11919
|
+
status: { enum: ['success'], type: 'string' },
|
|
11920
|
+
},
|
|
11921
|
+
required: [
|
|
11922
|
+
'action_attempt_id',
|
|
11923
|
+
'status',
|
|
11924
|
+
'error',
|
|
11925
|
+
'action_type',
|
|
11926
|
+
'result',
|
|
11927
|
+
],
|
|
11928
|
+
type: 'object',
|
|
11929
|
+
},
|
|
11930
|
+
{
|
|
11931
|
+
description: 'Muting or unmuting the speaker failed.',
|
|
11932
|
+
properties: {
|
|
11933
|
+
action_attempt_id: {
|
|
11934
|
+
description: 'ID of the action attempt.',
|
|
11935
|
+
format: 'uuid',
|
|
11936
|
+
type: 'string',
|
|
11937
|
+
},
|
|
11938
|
+
action_type: {
|
|
11939
|
+
description:
|
|
11940
|
+
'Action attempt to track the status of muting or unmuting a speaker.',
|
|
11941
|
+
enum: ['SET_SPEAKER_MUTE'],
|
|
11942
|
+
type: 'string',
|
|
11943
|
+
},
|
|
11944
|
+
error: {
|
|
11945
|
+
description: 'Error associated with the action.',
|
|
12114
11946
|
properties: {
|
|
12115
|
-
|
|
12116
|
-
|
|
12117
|
-
|
|
12118
|
-
type: '
|
|
11947
|
+
message: {
|
|
11948
|
+
description:
|
|
11949
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
11950
|
+
type: 'string',
|
|
11951
|
+
},
|
|
11952
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
11953
|
+
},
|
|
11954
|
+
required: ['type', 'message'],
|
|
11955
|
+
type: 'object',
|
|
11956
|
+
},
|
|
11957
|
+
result: {
|
|
11958
|
+
description:
|
|
11959
|
+
'Result of the action attempt. Null for failed action attempts.',
|
|
11960
|
+
nullable: true,
|
|
11961
|
+
},
|
|
11962
|
+
status: { enum: ['error'], type: 'string' },
|
|
11963
|
+
},
|
|
11964
|
+
required: [
|
|
11965
|
+
'action_attempt_id',
|
|
11966
|
+
'status',
|
|
11967
|
+
'result',
|
|
11968
|
+
'action_type',
|
|
11969
|
+
'error',
|
|
11970
|
+
],
|
|
11971
|
+
type: 'object',
|
|
11972
|
+
},
|
|
11973
|
+
{
|
|
11974
|
+
description: 'Pausing playback on the speaker is pending.',
|
|
11975
|
+
properties: {
|
|
11976
|
+
action_attempt_id: {
|
|
11977
|
+
description: 'ID of the action attempt.',
|
|
11978
|
+
format: 'uuid',
|
|
11979
|
+
type: 'string',
|
|
11980
|
+
},
|
|
11981
|
+
action_type: {
|
|
11982
|
+
description:
|
|
11983
|
+
'Action attempt to track the status of pausing playback on a speaker.',
|
|
11984
|
+
enum: ['PAUSE_SPEAKER_PLAYBACK'],
|
|
11985
|
+
type: 'string',
|
|
11986
|
+
},
|
|
11987
|
+
error: {
|
|
11988
|
+
description:
|
|
11989
|
+
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
11990
|
+
nullable: true,
|
|
11991
|
+
},
|
|
11992
|
+
result: {
|
|
11993
|
+
description:
|
|
11994
|
+
'Result of the action attempt. Null for pending action attempts.',
|
|
11995
|
+
nullable: true,
|
|
11996
|
+
},
|
|
11997
|
+
status: { enum: ['pending'], type: 'string' },
|
|
11998
|
+
},
|
|
11999
|
+
required: [
|
|
12000
|
+
'action_attempt_id',
|
|
12001
|
+
'status',
|
|
12002
|
+
'result',
|
|
12003
|
+
'error',
|
|
12004
|
+
'action_type',
|
|
12005
|
+
],
|
|
12006
|
+
type: 'object',
|
|
12007
|
+
},
|
|
12008
|
+
{
|
|
12009
|
+
description: 'Pausing playback on the speaker succeeded.',
|
|
12010
|
+
properties: {
|
|
12011
|
+
action_attempt_id: {
|
|
12012
|
+
description: 'ID of the action attempt.',
|
|
12013
|
+
format: 'uuid',
|
|
12014
|
+
type: 'string',
|
|
12015
|
+
},
|
|
12016
|
+
action_type: {
|
|
12017
|
+
description:
|
|
12018
|
+
'Action attempt to track the status of pausing playback on a speaker.',
|
|
12019
|
+
enum: ['PAUSE_SPEAKER_PLAYBACK'],
|
|
12020
|
+
type: 'string',
|
|
12021
|
+
},
|
|
12022
|
+
error: {
|
|
12023
|
+
description:
|
|
12024
|
+
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
12025
|
+
nullable: true,
|
|
12026
|
+
},
|
|
12027
|
+
result: {
|
|
12028
|
+
description: 'Result of the action.',
|
|
12029
|
+
properties: {
|
|
12030
|
+
affected_device_ids: {
|
|
12031
|
+
description:
|
|
12032
|
+
'IDs of the speakers whose playback was paused, including speakers grouped with the requested speaker.',
|
|
12033
|
+
items: { format: 'uuid', type: 'string' },
|
|
12034
|
+
type: 'array',
|
|
12119
12035
|
},
|
|
12120
12036
|
},
|
|
12037
|
+
required: ['affected_device_ids'],
|
|
12121
12038
|
type: 'object',
|
|
12122
12039
|
},
|
|
12123
12040
|
status: { enum: ['success'], type: 'string' },
|
|
@@ -12132,6 +12049,7 @@ const openapi: OpenAPISpec = {
|
|
|
12132
12049
|
type: 'object',
|
|
12133
12050
|
},
|
|
12134
12051
|
{
|
|
12052
|
+
description: 'Pausing playback on the speaker failed.',
|
|
12135
12053
|
properties: {
|
|
12136
12054
|
action_attempt_id: {
|
|
12137
12055
|
description: 'ID of the action attempt.',
|
|
@@ -12139,8 +12057,9 @@ const openapi: OpenAPISpec = {
|
|
|
12139
12057
|
type: 'string',
|
|
12140
12058
|
},
|
|
12141
12059
|
action_type: {
|
|
12142
|
-
description:
|
|
12143
|
-
|
|
12060
|
+
description:
|
|
12061
|
+
'Action attempt to track the status of pausing playback on a speaker.',
|
|
12062
|
+
enum: ['PAUSE_SPEAKER_PLAYBACK'],
|
|
12144
12063
|
type: 'string',
|
|
12145
12064
|
},
|
|
12146
12065
|
error: {
|
|
@@ -12173,6 +12092,7 @@ const openapi: OpenAPISpec = {
|
|
|
12173
12092
|
type: 'object',
|
|
12174
12093
|
},
|
|
12175
12094
|
{
|
|
12095
|
+
description: 'Resuming playback on the speaker is pending.',
|
|
12176
12096
|
properties: {
|
|
12177
12097
|
action_attempt_id: {
|
|
12178
12098
|
description: 'ID of the action attempt.',
|
|
@@ -12180,8 +12100,9 @@ const openapi: OpenAPISpec = {
|
|
|
12180
12100
|
type: 'string',
|
|
12181
12101
|
},
|
|
12182
12102
|
action_type: {
|
|
12183
|
-
description:
|
|
12184
|
-
|
|
12103
|
+
description:
|
|
12104
|
+
'Action attempt to track the status of resuming playback on a speaker.',
|
|
12105
|
+
enum: ['RESUME_SPEAKER_PLAYBACK'],
|
|
12185
12106
|
type: 'string',
|
|
12186
12107
|
},
|
|
12187
12108
|
error: {
|
|
@@ -12206,6 +12127,7 @@ const openapi: OpenAPISpec = {
|
|
|
12206
12127
|
type: 'object',
|
|
12207
12128
|
},
|
|
12208
12129
|
{
|
|
12130
|
+
description: 'Resuming playback on the speaker succeeded.',
|
|
12209
12131
|
properties: {
|
|
12210
12132
|
action_attempt_id: {
|
|
12211
12133
|
description: 'ID of the action attempt.',
|
|
@@ -12213,8 +12135,9 @@ const openapi: OpenAPISpec = {
|
|
|
12213
12135
|
type: 'string',
|
|
12214
12136
|
},
|
|
12215
12137
|
action_type: {
|
|
12216
|
-
description:
|
|
12217
|
-
|
|
12138
|
+
description:
|
|
12139
|
+
'Action attempt to track the status of resuming playback on a speaker.',
|
|
12140
|
+
enum: ['RESUME_SPEAKER_PLAYBACK'],
|
|
12218
12141
|
type: 'string',
|
|
12219
12142
|
},
|
|
12220
12143
|
error: {
|
|
@@ -12225,13 +12148,14 @@ const openapi: OpenAPISpec = {
|
|
|
12225
12148
|
result: {
|
|
12226
12149
|
description: 'Result of the action.',
|
|
12227
12150
|
properties: {
|
|
12228
|
-
|
|
12229
|
-
|
|
12230
|
-
|
|
12231
|
-
type: '
|
|
12151
|
+
affected_device_ids: {
|
|
12152
|
+
description:
|
|
12153
|
+
'IDs of the speakers whose playback was resumed, including speakers grouped with the requested speaker.',
|
|
12154
|
+
items: { format: 'uuid', type: 'string' },
|
|
12155
|
+
type: 'array',
|
|
12232
12156
|
},
|
|
12233
12157
|
},
|
|
12234
|
-
required: ['
|
|
12158
|
+
required: ['affected_device_ids'],
|
|
12235
12159
|
type: 'object',
|
|
12236
12160
|
},
|
|
12237
12161
|
status: { enum: ['success'], type: 'string' },
|
|
@@ -12246,6 +12170,7 @@ const openapi: OpenAPISpec = {
|
|
|
12246
12170
|
type: 'object',
|
|
12247
12171
|
},
|
|
12248
12172
|
{
|
|
12173
|
+
description: 'Resuming playback on the speaker failed.',
|
|
12249
12174
|
properties: {
|
|
12250
12175
|
action_attempt_id: {
|
|
12251
12176
|
description: 'ID of the action attempt.',
|
|
@@ -12253,8 +12178,9 @@ const openapi: OpenAPISpec = {
|
|
|
12253
12178
|
type: 'string',
|
|
12254
12179
|
},
|
|
12255
12180
|
action_type: {
|
|
12256
|
-
description:
|
|
12257
|
-
|
|
12181
|
+
description:
|
|
12182
|
+
'Action attempt to track the status of resuming playback on a speaker.',
|
|
12183
|
+
enum: ['RESUME_SPEAKER_PLAYBACK'],
|
|
12258
12184
|
type: 'string',
|
|
12259
12185
|
},
|
|
12260
12186
|
error: {
|
|
@@ -12287,6 +12213,7 @@ const openapi: OpenAPISpec = {
|
|
|
12287
12213
|
type: 'object',
|
|
12288
12214
|
},
|
|
12289
12215
|
{
|
|
12216
|
+
description: 'Playing a chime on the speaker is pending.',
|
|
12290
12217
|
properties: {
|
|
12291
12218
|
action_attempt_id: {
|
|
12292
12219
|
description: 'ID of the action attempt.',
|
|
@@ -12294,8 +12221,9 @@ const openapi: OpenAPISpec = {
|
|
|
12294
12221
|
type: 'string',
|
|
12295
12222
|
},
|
|
12296
12223
|
action_type: {
|
|
12297
|
-
description:
|
|
12298
|
-
|
|
12224
|
+
description:
|
|
12225
|
+
'Action attempt to track the status of playing a chime on a speaker.',
|
|
12226
|
+
enum: ['PLAY_SPEAKER_CHIME'],
|
|
12299
12227
|
type: 'string',
|
|
12300
12228
|
},
|
|
12301
12229
|
error: {
|
|
@@ -12320,6 +12248,7 @@ const openapi: OpenAPISpec = {
|
|
|
12320
12248
|
type: 'object',
|
|
12321
12249
|
},
|
|
12322
12250
|
{
|
|
12251
|
+
description: 'Playing a chime on the speaker succeeded.',
|
|
12323
12252
|
properties: {
|
|
12324
12253
|
action_attempt_id: {
|
|
12325
12254
|
description: 'ID of the action attempt.',
|
|
@@ -12327,8 +12256,9 @@ const openapi: OpenAPISpec = {
|
|
|
12327
12256
|
type: 'string',
|
|
12328
12257
|
},
|
|
12329
12258
|
action_type: {
|
|
12330
|
-
description:
|
|
12331
|
-
|
|
12259
|
+
description:
|
|
12260
|
+
'Action attempt to track the status of playing a chime on a speaker.',
|
|
12261
|
+
enum: ['PLAY_SPEAKER_CHIME'],
|
|
12332
12262
|
type: 'string',
|
|
12333
12263
|
},
|
|
12334
12264
|
error: {
|
|
@@ -12353,6 +12283,7 @@ const openapi: OpenAPISpec = {
|
|
|
12353
12283
|
type: 'object',
|
|
12354
12284
|
},
|
|
12355
12285
|
{
|
|
12286
|
+
description: 'Playing a chime on the speaker failed.',
|
|
12356
12287
|
properties: {
|
|
12357
12288
|
action_attempt_id: {
|
|
12358
12289
|
description: 'ID of the action attempt.',
|
|
@@ -12360,8 +12291,9 @@ const openapi: OpenAPISpec = {
|
|
|
12360
12291
|
type: 'string',
|
|
12361
12292
|
},
|
|
12362
12293
|
action_type: {
|
|
12363
|
-
description:
|
|
12364
|
-
|
|
12294
|
+
description:
|
|
12295
|
+
'Action attempt to track the status of playing a chime on a speaker.',
|
|
12296
|
+
enum: ['PLAY_SPEAKER_CHIME'],
|
|
12365
12297
|
type: 'string',
|
|
12366
12298
|
},
|
|
12367
12299
|
error: {
|
|
@@ -12401,8 +12333,8 @@ const openapi: OpenAPISpec = {
|
|
|
12401
12333
|
type: 'string',
|
|
12402
12334
|
},
|
|
12403
12335
|
action_type: {
|
|
12404
|
-
description: '
|
|
12405
|
-
enum: ['
|
|
12336
|
+
description: 'Syncing access codes is pending.',
|
|
12337
|
+
enum: ['SYNC_ACCESS_CODES'],
|
|
12406
12338
|
type: 'string',
|
|
12407
12339
|
},
|
|
12408
12340
|
error: {
|
|
@@ -12434,8 +12366,8 @@ const openapi: OpenAPISpec = {
|
|
|
12434
12366
|
type: 'string',
|
|
12435
12367
|
},
|
|
12436
12368
|
action_type: {
|
|
12437
|
-
description: '
|
|
12438
|
-
enum: ['
|
|
12369
|
+
description: 'Syncing access codes succeeded.',
|
|
12370
|
+
enum: ['SYNC_ACCESS_CODES'],
|
|
12439
12371
|
type: 'string',
|
|
12440
12372
|
},
|
|
12441
12373
|
error: {
|
|
@@ -12445,14 +12377,121 @@ const openapi: OpenAPISpec = {
|
|
|
12445
12377
|
},
|
|
12446
12378
|
result: {
|
|
12447
12379
|
description: 'Result of the action.',
|
|
12380
|
+
properties: {},
|
|
12381
|
+
type: 'object',
|
|
12382
|
+
},
|
|
12383
|
+
status: { enum: ['success'], type: 'string' },
|
|
12384
|
+
},
|
|
12385
|
+
required: [
|
|
12386
|
+
'action_attempt_id',
|
|
12387
|
+
'status',
|
|
12388
|
+
'error',
|
|
12389
|
+
'action_type',
|
|
12390
|
+
'result',
|
|
12391
|
+
],
|
|
12392
|
+
type: 'object',
|
|
12393
|
+
},
|
|
12394
|
+
{
|
|
12395
|
+
properties: {
|
|
12396
|
+
action_attempt_id: {
|
|
12397
|
+
description: 'ID of the action attempt.',
|
|
12398
|
+
format: 'uuid',
|
|
12399
|
+
type: 'string',
|
|
12400
|
+
},
|
|
12401
|
+
action_type: {
|
|
12402
|
+
description: 'Syncing access codes failed.',
|
|
12403
|
+
enum: ['SYNC_ACCESS_CODES'],
|
|
12404
|
+
type: 'string',
|
|
12405
|
+
},
|
|
12406
|
+
error: {
|
|
12407
|
+
description: 'Error associated with the action.',
|
|
12448
12408
|
properties: {
|
|
12449
|
-
|
|
12409
|
+
message: {
|
|
12410
|
+
description:
|
|
12411
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12412
|
+
type: 'string',
|
|
12413
|
+
},
|
|
12414
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
12415
|
+
},
|
|
12416
|
+
required: ['type', 'message'],
|
|
12417
|
+
type: 'object',
|
|
12418
|
+
},
|
|
12419
|
+
result: {
|
|
12420
|
+
description:
|
|
12421
|
+
'Result of the action attempt. Null for failed action attempts.',
|
|
12422
|
+
nullable: true,
|
|
12423
|
+
},
|
|
12424
|
+
status: { enum: ['error'], type: 'string' },
|
|
12425
|
+
},
|
|
12426
|
+
required: [
|
|
12427
|
+
'action_attempt_id',
|
|
12428
|
+
'status',
|
|
12429
|
+
'result',
|
|
12430
|
+
'action_type',
|
|
12431
|
+
'error',
|
|
12432
|
+
],
|
|
12433
|
+
type: 'object',
|
|
12434
|
+
},
|
|
12435
|
+
{
|
|
12436
|
+
properties: {
|
|
12437
|
+
action_attempt_id: {
|
|
12438
|
+
description: 'ID of the action attempt.',
|
|
12439
|
+
format: 'uuid',
|
|
12440
|
+
type: 'string',
|
|
12441
|
+
},
|
|
12442
|
+
action_type: {
|
|
12443
|
+
description: 'Creating an access code is pending.',
|
|
12444
|
+
enum: ['CREATE_ACCESS_CODE'],
|
|
12445
|
+
type: 'string',
|
|
12446
|
+
},
|
|
12447
|
+
error: {
|
|
12448
|
+
description:
|
|
12449
|
+
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
12450
|
+
nullable: true,
|
|
12451
|
+
},
|
|
12452
|
+
result: {
|
|
12453
|
+
description:
|
|
12454
|
+
'Result of the action attempt. Null for pending action attempts.',
|
|
12455
|
+
nullable: true,
|
|
12456
|
+
},
|
|
12457
|
+
status: { enum: ['pending'], type: 'string' },
|
|
12458
|
+
},
|
|
12459
|
+
required: [
|
|
12460
|
+
'action_attempt_id',
|
|
12461
|
+
'status',
|
|
12462
|
+
'result',
|
|
12463
|
+
'error',
|
|
12464
|
+
'action_type',
|
|
12465
|
+
],
|
|
12466
|
+
type: 'object',
|
|
12467
|
+
},
|
|
12468
|
+
{
|
|
12469
|
+
properties: {
|
|
12470
|
+
action_attempt_id: {
|
|
12471
|
+
description: 'ID of the action attempt.',
|
|
12472
|
+
format: 'uuid',
|
|
12473
|
+
type: 'string',
|
|
12474
|
+
},
|
|
12475
|
+
action_type: {
|
|
12476
|
+
description: 'Creating an access code succeeded.',
|
|
12477
|
+
enum: ['CREATE_ACCESS_CODE'],
|
|
12478
|
+
type: 'string',
|
|
12479
|
+
},
|
|
12480
|
+
error: {
|
|
12481
|
+
description:
|
|
12482
|
+
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
12483
|
+
nullable: true,
|
|
12484
|
+
},
|
|
12485
|
+
result: {
|
|
12486
|
+
description: 'Result of the action.',
|
|
12487
|
+
properties: {
|
|
12488
|
+
access_code: {
|
|
12450
12489
|
additionalProperties: {},
|
|
12451
|
-
description: '
|
|
12490
|
+
description: 'Created access code.',
|
|
12452
12491
|
type: 'object',
|
|
12453
12492
|
},
|
|
12454
12493
|
},
|
|
12455
|
-
required: ['
|
|
12494
|
+
required: ['access_code'],
|
|
12456
12495
|
type: 'object',
|
|
12457
12496
|
},
|
|
12458
12497
|
status: { enum: ['success'], type: 'string' },
|
|
@@ -12474,8 +12513,8 @@ const openapi: OpenAPISpec = {
|
|
|
12474
12513
|
type: 'string',
|
|
12475
12514
|
},
|
|
12476
12515
|
action_type: {
|
|
12477
|
-
description: '
|
|
12478
|
-
enum: ['
|
|
12516
|
+
description: 'Creating an access code failed.',
|
|
12517
|
+
enum: ['CREATE_ACCESS_CODE'],
|
|
12479
12518
|
type: 'string',
|
|
12480
12519
|
},
|
|
12481
12520
|
error: {
|
|
@@ -12507,35 +12546,590 @@ const openapi: OpenAPISpec = {
|
|
|
12507
12546
|
],
|
|
12508
12547
|
type: 'object',
|
|
12509
12548
|
},
|
|
12510
|
-
|
|
12511
|
-
|
|
12512
|
-
|
|
12513
|
-
|
|
12514
|
-
|
|
12515
|
-
|
|
12516
|
-
|
|
12517
|
-
|
|
12518
|
-
|
|
12549
|
+
{
|
|
12550
|
+
properties: {
|
|
12551
|
+
action_attempt_id: {
|
|
12552
|
+
description: 'ID of the action attempt.',
|
|
12553
|
+
format: 'uuid',
|
|
12554
|
+
type: 'string',
|
|
12555
|
+
},
|
|
12556
|
+
action_type: {
|
|
12557
|
+
description: 'Deleting an access code is pending.',
|
|
12558
|
+
enum: ['DELETE_ACCESS_CODE'],
|
|
12559
|
+
type: 'string',
|
|
12560
|
+
},
|
|
12561
|
+
error: {
|
|
12562
|
+
description:
|
|
12563
|
+
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
12564
|
+
nullable: true,
|
|
12565
|
+
},
|
|
12566
|
+
result: {
|
|
12567
|
+
description:
|
|
12568
|
+
'Result of the action attempt. Null for pending action attempts.',
|
|
12569
|
+
nullable: true,
|
|
12570
|
+
},
|
|
12571
|
+
status: { enum: ['pending'], type: 'string' },
|
|
12572
|
+
},
|
|
12573
|
+
required: [
|
|
12574
|
+
'action_attempt_id',
|
|
12575
|
+
'status',
|
|
12576
|
+
'result',
|
|
12577
|
+
'error',
|
|
12578
|
+
'action_type',
|
|
12579
|
+
],
|
|
12580
|
+
type: 'object',
|
|
12519
12581
|
},
|
|
12520
|
-
|
|
12521
|
-
|
|
12522
|
-
|
|
12582
|
+
{
|
|
12583
|
+
properties: {
|
|
12584
|
+
action_attempt_id: {
|
|
12585
|
+
description: 'ID of the action attempt.',
|
|
12586
|
+
format: 'uuid',
|
|
12587
|
+
type: 'string',
|
|
12588
|
+
},
|
|
12589
|
+
action_type: {
|
|
12590
|
+
description: 'Deleting an access code succeeded.',
|
|
12591
|
+
enum: ['DELETE_ACCESS_CODE'],
|
|
12592
|
+
type: 'string',
|
|
12593
|
+
},
|
|
12594
|
+
error: {
|
|
12595
|
+
description:
|
|
12596
|
+
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
12597
|
+
nullable: true,
|
|
12598
|
+
},
|
|
12599
|
+
result: {
|
|
12600
|
+
description: 'Result of the action.',
|
|
12601
|
+
properties: {},
|
|
12602
|
+
type: 'object',
|
|
12603
|
+
},
|
|
12604
|
+
status: { enum: ['success'], type: 'string' },
|
|
12605
|
+
},
|
|
12606
|
+
required: [
|
|
12607
|
+
'action_attempt_id',
|
|
12608
|
+
'status',
|
|
12609
|
+
'error',
|
|
12610
|
+
'action_type',
|
|
12611
|
+
'result',
|
|
12612
|
+
],
|
|
12613
|
+
type: 'object',
|
|
12523
12614
|
},
|
|
12524
|
-
|
|
12525
|
-
|
|
12526
|
-
|
|
12615
|
+
{
|
|
12616
|
+
properties: {
|
|
12617
|
+
action_attempt_id: {
|
|
12618
|
+
description: 'ID of the action attempt.',
|
|
12619
|
+
format: 'uuid',
|
|
12620
|
+
type: 'string',
|
|
12621
|
+
},
|
|
12622
|
+
action_type: {
|
|
12623
|
+
description: 'Deleting an access code failed.',
|
|
12624
|
+
enum: ['DELETE_ACCESS_CODE'],
|
|
12625
|
+
type: 'string',
|
|
12626
|
+
},
|
|
12627
|
+
error: {
|
|
12628
|
+
description: 'Error associated with the action.',
|
|
12629
|
+
properties: {
|
|
12630
|
+
message: {
|
|
12631
|
+
description:
|
|
12632
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12633
|
+
type: 'string',
|
|
12634
|
+
},
|
|
12635
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
12636
|
+
},
|
|
12637
|
+
required: ['type', 'message'],
|
|
12638
|
+
type: 'object',
|
|
12639
|
+
},
|
|
12640
|
+
result: {
|
|
12641
|
+
description:
|
|
12642
|
+
'Result of the action attempt. Null for failed action attempts.',
|
|
12643
|
+
nullable: true,
|
|
12644
|
+
},
|
|
12645
|
+
status: { enum: ['error'], type: 'string' },
|
|
12646
|
+
},
|
|
12647
|
+
required: [
|
|
12648
|
+
'action_attempt_id',
|
|
12649
|
+
'status',
|
|
12650
|
+
'result',
|
|
12651
|
+
'action_type',
|
|
12652
|
+
'error',
|
|
12653
|
+
],
|
|
12654
|
+
type: 'object',
|
|
12527
12655
|
},
|
|
12528
|
-
|
|
12529
|
-
|
|
12530
|
-
|
|
12656
|
+
{
|
|
12657
|
+
properties: {
|
|
12658
|
+
action_attempt_id: {
|
|
12659
|
+
description: 'ID of the action attempt.',
|
|
12660
|
+
format: 'uuid',
|
|
12661
|
+
type: 'string',
|
|
12662
|
+
},
|
|
12663
|
+
action_type: {
|
|
12664
|
+
description: 'Updating an access code is pending.',
|
|
12665
|
+
enum: ['UPDATE_ACCESS_CODE'],
|
|
12666
|
+
type: 'string',
|
|
12667
|
+
},
|
|
12668
|
+
error: {
|
|
12669
|
+
description:
|
|
12670
|
+
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
12671
|
+
nullable: true,
|
|
12672
|
+
},
|
|
12673
|
+
result: {
|
|
12674
|
+
description:
|
|
12675
|
+
'Result of the action attempt. Null for pending action attempts.',
|
|
12676
|
+
nullable: true,
|
|
12677
|
+
},
|
|
12678
|
+
status: { enum: ['pending'], type: 'string' },
|
|
12679
|
+
},
|
|
12680
|
+
required: [
|
|
12681
|
+
'action_attempt_id',
|
|
12682
|
+
'status',
|
|
12683
|
+
'result',
|
|
12684
|
+
'error',
|
|
12685
|
+
'action_type',
|
|
12686
|
+
],
|
|
12687
|
+
type: 'object',
|
|
12531
12688
|
},
|
|
12532
|
-
|
|
12533
|
-
|
|
12534
|
-
|
|
12689
|
+
{
|
|
12690
|
+
properties: {
|
|
12691
|
+
action_attempt_id: {
|
|
12692
|
+
description: 'ID of the action attempt.',
|
|
12693
|
+
format: 'uuid',
|
|
12694
|
+
type: 'string',
|
|
12695
|
+
},
|
|
12696
|
+
action_type: {
|
|
12697
|
+
description: 'Updating an access code succeeded.',
|
|
12698
|
+
enum: ['UPDATE_ACCESS_CODE'],
|
|
12699
|
+
type: 'string',
|
|
12700
|
+
},
|
|
12701
|
+
error: {
|
|
12702
|
+
description:
|
|
12703
|
+
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
12704
|
+
nullable: true,
|
|
12705
|
+
},
|
|
12706
|
+
result: {
|
|
12707
|
+
description: 'Result of the action.',
|
|
12708
|
+
properties: {
|
|
12709
|
+
access_code: {
|
|
12710
|
+
additionalProperties: {},
|
|
12711
|
+
description: 'Updated access code.',
|
|
12712
|
+
type: 'object',
|
|
12713
|
+
},
|
|
12714
|
+
},
|
|
12715
|
+
type: 'object',
|
|
12716
|
+
},
|
|
12717
|
+
status: { enum: ['success'], type: 'string' },
|
|
12718
|
+
},
|
|
12719
|
+
required: [
|
|
12720
|
+
'action_attempt_id',
|
|
12721
|
+
'status',
|
|
12722
|
+
'error',
|
|
12723
|
+
'action_type',
|
|
12724
|
+
'result',
|
|
12725
|
+
],
|
|
12726
|
+
type: 'object',
|
|
12535
12727
|
},
|
|
12536
|
-
|
|
12537
|
-
|
|
12538
|
-
|
|
12728
|
+
{
|
|
12729
|
+
properties: {
|
|
12730
|
+
action_attempt_id: {
|
|
12731
|
+
description: 'ID of the action attempt.',
|
|
12732
|
+
format: 'uuid',
|
|
12733
|
+
type: 'string',
|
|
12734
|
+
},
|
|
12735
|
+
action_type: {
|
|
12736
|
+
description: 'Updating an access code failed.',
|
|
12737
|
+
enum: ['UPDATE_ACCESS_CODE'],
|
|
12738
|
+
type: 'string',
|
|
12739
|
+
},
|
|
12740
|
+
error: {
|
|
12741
|
+
description: 'Error associated with the action.',
|
|
12742
|
+
properties: {
|
|
12743
|
+
message: {
|
|
12744
|
+
description:
|
|
12745
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12746
|
+
type: 'string',
|
|
12747
|
+
},
|
|
12748
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
12749
|
+
},
|
|
12750
|
+
required: ['type', 'message'],
|
|
12751
|
+
type: 'object',
|
|
12752
|
+
},
|
|
12753
|
+
result: {
|
|
12754
|
+
description:
|
|
12755
|
+
'Result of the action attempt. Null for failed action attempts.',
|
|
12756
|
+
nullable: true,
|
|
12757
|
+
},
|
|
12758
|
+
status: { enum: ['error'], type: 'string' },
|
|
12759
|
+
},
|
|
12760
|
+
required: [
|
|
12761
|
+
'action_attempt_id',
|
|
12762
|
+
'status',
|
|
12763
|
+
'result',
|
|
12764
|
+
'action_type',
|
|
12765
|
+
'error',
|
|
12766
|
+
],
|
|
12767
|
+
type: 'object',
|
|
12768
|
+
},
|
|
12769
|
+
{
|
|
12770
|
+
properties: {
|
|
12771
|
+
action_attempt_id: {
|
|
12772
|
+
description: 'ID of the action attempt.',
|
|
12773
|
+
format: 'uuid',
|
|
12774
|
+
type: 'string',
|
|
12775
|
+
},
|
|
12776
|
+
action_type: {
|
|
12777
|
+
description: 'Creating a noise threshold is pending.',
|
|
12778
|
+
enum: ['CREATE_NOISE_THRESHOLD'],
|
|
12779
|
+
type: 'string',
|
|
12780
|
+
},
|
|
12781
|
+
error: {
|
|
12782
|
+
description:
|
|
12783
|
+
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
12784
|
+
nullable: true,
|
|
12785
|
+
},
|
|
12786
|
+
result: {
|
|
12787
|
+
description:
|
|
12788
|
+
'Result of the action attempt. Null for pending action attempts.',
|
|
12789
|
+
nullable: true,
|
|
12790
|
+
},
|
|
12791
|
+
status: { enum: ['pending'], type: 'string' },
|
|
12792
|
+
},
|
|
12793
|
+
required: [
|
|
12794
|
+
'action_attempt_id',
|
|
12795
|
+
'status',
|
|
12796
|
+
'result',
|
|
12797
|
+
'error',
|
|
12798
|
+
'action_type',
|
|
12799
|
+
],
|
|
12800
|
+
type: 'object',
|
|
12801
|
+
},
|
|
12802
|
+
{
|
|
12803
|
+
properties: {
|
|
12804
|
+
action_attempt_id: {
|
|
12805
|
+
description: 'ID of the action attempt.',
|
|
12806
|
+
format: 'uuid',
|
|
12807
|
+
type: 'string',
|
|
12808
|
+
},
|
|
12809
|
+
action_type: {
|
|
12810
|
+
description: 'Creating a noise threshold succeeded.',
|
|
12811
|
+
enum: ['CREATE_NOISE_THRESHOLD'],
|
|
12812
|
+
type: 'string',
|
|
12813
|
+
},
|
|
12814
|
+
error: {
|
|
12815
|
+
description:
|
|
12816
|
+
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
12817
|
+
nullable: true,
|
|
12818
|
+
},
|
|
12819
|
+
result: {
|
|
12820
|
+
description: 'Result of the action.',
|
|
12821
|
+
properties: {
|
|
12822
|
+
noise_threshold: {
|
|
12823
|
+
additionalProperties: {},
|
|
12824
|
+
description: 'Created noise threshold.',
|
|
12825
|
+
type: 'object',
|
|
12826
|
+
},
|
|
12827
|
+
},
|
|
12828
|
+
required: ['noise_threshold'],
|
|
12829
|
+
type: 'object',
|
|
12830
|
+
},
|
|
12831
|
+
status: { enum: ['success'], type: 'string' },
|
|
12832
|
+
},
|
|
12833
|
+
required: [
|
|
12834
|
+
'action_attempt_id',
|
|
12835
|
+
'status',
|
|
12836
|
+
'error',
|
|
12837
|
+
'action_type',
|
|
12838
|
+
'result',
|
|
12839
|
+
],
|
|
12840
|
+
type: 'object',
|
|
12841
|
+
},
|
|
12842
|
+
{
|
|
12843
|
+
properties: {
|
|
12844
|
+
action_attempt_id: {
|
|
12845
|
+
description: 'ID of the action attempt.',
|
|
12846
|
+
format: 'uuid',
|
|
12847
|
+
type: 'string',
|
|
12848
|
+
},
|
|
12849
|
+
action_type: {
|
|
12850
|
+
description: 'Creating a noise threshold failed.',
|
|
12851
|
+
enum: ['CREATE_NOISE_THRESHOLD'],
|
|
12852
|
+
type: 'string',
|
|
12853
|
+
},
|
|
12854
|
+
error: {
|
|
12855
|
+
description: 'Error associated with the action.',
|
|
12856
|
+
properties: {
|
|
12857
|
+
message: {
|
|
12858
|
+
description:
|
|
12859
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12860
|
+
type: 'string',
|
|
12861
|
+
},
|
|
12862
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
12863
|
+
},
|
|
12864
|
+
required: ['type', 'message'],
|
|
12865
|
+
type: 'object',
|
|
12866
|
+
},
|
|
12867
|
+
result: {
|
|
12868
|
+
description:
|
|
12869
|
+
'Result of the action attempt. Null for failed action attempts.',
|
|
12870
|
+
nullable: true,
|
|
12871
|
+
},
|
|
12872
|
+
status: { enum: ['error'], type: 'string' },
|
|
12873
|
+
},
|
|
12874
|
+
required: [
|
|
12875
|
+
'action_attempt_id',
|
|
12876
|
+
'status',
|
|
12877
|
+
'result',
|
|
12878
|
+
'action_type',
|
|
12879
|
+
'error',
|
|
12880
|
+
],
|
|
12881
|
+
type: 'object',
|
|
12882
|
+
},
|
|
12883
|
+
{
|
|
12884
|
+
properties: {
|
|
12885
|
+
action_attempt_id: {
|
|
12886
|
+
description: 'ID of the action attempt.',
|
|
12887
|
+
format: 'uuid',
|
|
12888
|
+
type: 'string',
|
|
12889
|
+
},
|
|
12890
|
+
action_type: {
|
|
12891
|
+
description: 'Deleting a noise threshold is pending.',
|
|
12892
|
+
enum: ['DELETE_NOISE_THRESHOLD'],
|
|
12893
|
+
type: 'string',
|
|
12894
|
+
},
|
|
12895
|
+
error: {
|
|
12896
|
+
description:
|
|
12897
|
+
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
12898
|
+
nullable: true,
|
|
12899
|
+
},
|
|
12900
|
+
result: {
|
|
12901
|
+
description:
|
|
12902
|
+
'Result of the action attempt. Null for pending action attempts.',
|
|
12903
|
+
nullable: true,
|
|
12904
|
+
},
|
|
12905
|
+
status: { enum: ['pending'], type: 'string' },
|
|
12906
|
+
},
|
|
12907
|
+
required: [
|
|
12908
|
+
'action_attempt_id',
|
|
12909
|
+
'status',
|
|
12910
|
+
'result',
|
|
12911
|
+
'error',
|
|
12912
|
+
'action_type',
|
|
12913
|
+
],
|
|
12914
|
+
type: 'object',
|
|
12915
|
+
},
|
|
12916
|
+
{
|
|
12917
|
+
properties: {
|
|
12918
|
+
action_attempt_id: {
|
|
12919
|
+
description: 'ID of the action attempt.',
|
|
12920
|
+
format: 'uuid',
|
|
12921
|
+
type: 'string',
|
|
12922
|
+
},
|
|
12923
|
+
action_type: {
|
|
12924
|
+
description: 'Deleting a noise threshold succeeded.',
|
|
12925
|
+
enum: ['DELETE_NOISE_THRESHOLD'],
|
|
12926
|
+
type: 'string',
|
|
12927
|
+
},
|
|
12928
|
+
error: {
|
|
12929
|
+
description:
|
|
12930
|
+
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
12931
|
+
nullable: true,
|
|
12932
|
+
},
|
|
12933
|
+
result: {
|
|
12934
|
+
description: 'Result of the action.',
|
|
12935
|
+
properties: {},
|
|
12936
|
+
type: 'object',
|
|
12937
|
+
},
|
|
12938
|
+
status: { enum: ['success'], type: 'string' },
|
|
12939
|
+
},
|
|
12940
|
+
required: [
|
|
12941
|
+
'action_attempt_id',
|
|
12942
|
+
'status',
|
|
12943
|
+
'error',
|
|
12944
|
+
'action_type',
|
|
12945
|
+
'result',
|
|
12946
|
+
],
|
|
12947
|
+
type: 'object',
|
|
12948
|
+
},
|
|
12949
|
+
{
|
|
12950
|
+
properties: {
|
|
12951
|
+
action_attempt_id: {
|
|
12952
|
+
description: 'ID of the action attempt.',
|
|
12953
|
+
format: 'uuid',
|
|
12954
|
+
type: 'string',
|
|
12955
|
+
},
|
|
12956
|
+
action_type: {
|
|
12957
|
+
description: 'Deleting a noise threshold failed.',
|
|
12958
|
+
enum: ['DELETE_NOISE_THRESHOLD'],
|
|
12959
|
+
type: 'string',
|
|
12960
|
+
},
|
|
12961
|
+
error: {
|
|
12962
|
+
description: 'Error associated with the action.',
|
|
12963
|
+
properties: {
|
|
12964
|
+
message: {
|
|
12965
|
+
description:
|
|
12966
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
12967
|
+
type: 'string',
|
|
12968
|
+
},
|
|
12969
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
12970
|
+
},
|
|
12971
|
+
required: ['type', 'message'],
|
|
12972
|
+
type: 'object',
|
|
12973
|
+
},
|
|
12974
|
+
result: {
|
|
12975
|
+
description:
|
|
12976
|
+
'Result of the action attempt. Null for failed action attempts.',
|
|
12977
|
+
nullable: true,
|
|
12978
|
+
},
|
|
12979
|
+
status: { enum: ['error'], type: 'string' },
|
|
12980
|
+
},
|
|
12981
|
+
required: [
|
|
12982
|
+
'action_attempt_id',
|
|
12983
|
+
'status',
|
|
12984
|
+
'result',
|
|
12985
|
+
'action_type',
|
|
12986
|
+
'error',
|
|
12987
|
+
],
|
|
12988
|
+
type: 'object',
|
|
12989
|
+
},
|
|
12990
|
+
{
|
|
12991
|
+
properties: {
|
|
12992
|
+
action_attempt_id: {
|
|
12993
|
+
description: 'ID of the action attempt.',
|
|
12994
|
+
format: 'uuid',
|
|
12995
|
+
type: 'string',
|
|
12996
|
+
},
|
|
12997
|
+
action_type: {
|
|
12998
|
+
description: 'Updating a noise threshold is pending.',
|
|
12999
|
+
enum: ['UPDATE_NOISE_THRESHOLD'],
|
|
13000
|
+
type: 'string',
|
|
13001
|
+
},
|
|
13002
|
+
error: {
|
|
13003
|
+
description:
|
|
13004
|
+
'Errors associated with the action attempt. Null for pending action attempts.',
|
|
13005
|
+
nullable: true,
|
|
13006
|
+
},
|
|
13007
|
+
result: {
|
|
13008
|
+
description:
|
|
13009
|
+
'Result of the action attempt. Null for pending action attempts.',
|
|
13010
|
+
nullable: true,
|
|
13011
|
+
},
|
|
13012
|
+
status: { enum: ['pending'], type: 'string' },
|
|
13013
|
+
},
|
|
13014
|
+
required: [
|
|
13015
|
+
'action_attempt_id',
|
|
13016
|
+
'status',
|
|
13017
|
+
'result',
|
|
13018
|
+
'error',
|
|
13019
|
+
'action_type',
|
|
13020
|
+
],
|
|
13021
|
+
type: 'object',
|
|
13022
|
+
},
|
|
13023
|
+
{
|
|
13024
|
+
properties: {
|
|
13025
|
+
action_attempt_id: {
|
|
13026
|
+
description: 'ID of the action attempt.',
|
|
13027
|
+
format: 'uuid',
|
|
13028
|
+
type: 'string',
|
|
13029
|
+
},
|
|
13030
|
+
action_type: {
|
|
13031
|
+
description: 'Updating a noise threshold succeeded.',
|
|
13032
|
+
enum: ['UPDATE_NOISE_THRESHOLD'],
|
|
13033
|
+
type: 'string',
|
|
13034
|
+
},
|
|
13035
|
+
error: {
|
|
13036
|
+
description:
|
|
13037
|
+
'Errors associated with the action attempt. Null for successful action attempts.',
|
|
13038
|
+
nullable: true,
|
|
13039
|
+
},
|
|
13040
|
+
result: {
|
|
13041
|
+
description: 'Result of the action.',
|
|
13042
|
+
properties: {
|
|
13043
|
+
noise_threshold: {
|
|
13044
|
+
additionalProperties: {},
|
|
13045
|
+
description: 'Updated noise threshold.',
|
|
13046
|
+
type: 'object',
|
|
13047
|
+
},
|
|
13048
|
+
},
|
|
13049
|
+
required: ['noise_threshold'],
|
|
13050
|
+
type: 'object',
|
|
13051
|
+
},
|
|
13052
|
+
status: { enum: ['success'], type: 'string' },
|
|
13053
|
+
},
|
|
13054
|
+
required: [
|
|
13055
|
+
'action_attempt_id',
|
|
13056
|
+
'status',
|
|
13057
|
+
'error',
|
|
13058
|
+
'action_type',
|
|
13059
|
+
'result',
|
|
13060
|
+
],
|
|
13061
|
+
type: 'object',
|
|
13062
|
+
},
|
|
13063
|
+
{
|
|
13064
|
+
properties: {
|
|
13065
|
+
action_attempt_id: {
|
|
13066
|
+
description: 'ID of the action attempt.',
|
|
13067
|
+
format: 'uuid',
|
|
13068
|
+
type: 'string',
|
|
13069
|
+
},
|
|
13070
|
+
action_type: {
|
|
13071
|
+
description: 'Updating a noise threshold failed.',
|
|
13072
|
+
enum: ['UPDATE_NOISE_THRESHOLD'],
|
|
13073
|
+
type: 'string',
|
|
13074
|
+
},
|
|
13075
|
+
error: {
|
|
13076
|
+
description: 'Error associated with the action.',
|
|
13077
|
+
properties: {
|
|
13078
|
+
message: {
|
|
13079
|
+
description:
|
|
13080
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
13081
|
+
type: 'string',
|
|
13082
|
+
},
|
|
13083
|
+
type: { description: 'Type of the error.', type: 'string' },
|
|
13084
|
+
},
|
|
13085
|
+
required: ['type', 'message'],
|
|
13086
|
+
type: 'object',
|
|
13087
|
+
},
|
|
13088
|
+
result: {
|
|
13089
|
+
description:
|
|
13090
|
+
'Result of the action attempt. Null for failed action attempts.',
|
|
13091
|
+
nullable: true,
|
|
13092
|
+
},
|
|
13093
|
+
status: { enum: ['error'], type: 'string' },
|
|
13094
|
+
},
|
|
13095
|
+
required: [
|
|
13096
|
+
'action_attempt_id',
|
|
13097
|
+
'status',
|
|
13098
|
+
'result',
|
|
13099
|
+
'action_type',
|
|
13100
|
+
'error',
|
|
13101
|
+
],
|
|
13102
|
+
type: 'object',
|
|
13103
|
+
},
|
|
13104
|
+
],
|
|
13105
|
+
'x-route-path': '/action_attempts',
|
|
13106
|
+
},
|
|
13107
|
+
batch: {
|
|
13108
|
+
description: 'A batch of workspace resources.',
|
|
13109
|
+
properties: {
|
|
13110
|
+
access_codes: {
|
|
13111
|
+
items: { $ref: '#/components/schemas/access_code' },
|
|
13112
|
+
type: 'array',
|
|
13113
|
+
},
|
|
13114
|
+
access_grants: {
|
|
13115
|
+
items: { $ref: '#/components/schemas/access_grant' },
|
|
13116
|
+
type: 'array',
|
|
13117
|
+
},
|
|
13118
|
+
access_methods: {
|
|
13119
|
+
items: { $ref: '#/components/schemas/access_method' },
|
|
13120
|
+
type: 'array',
|
|
13121
|
+
},
|
|
13122
|
+
acs_access_groups: {
|
|
13123
|
+
items: { $ref: '#/components/schemas/acs_access_group' },
|
|
13124
|
+
type: 'array',
|
|
13125
|
+
},
|
|
13126
|
+
acs_credentials: {
|
|
13127
|
+
items: { $ref: '#/components/schemas/acs_credential' },
|
|
13128
|
+
type: 'array',
|
|
13129
|
+
},
|
|
13130
|
+
acs_encoders: {
|
|
13131
|
+
items: { $ref: '#/components/schemas/acs_encoder' },
|
|
13132
|
+
type: 'array',
|
|
12539
13133
|
},
|
|
12540
13134
|
acs_entrances: {
|
|
12541
13135
|
items: { $ref: '#/components/schemas/acs_entrance' },
|
|
@@ -13045,6 +13639,7 @@ const openapi: OpenAPISpec = {
|
|
|
13045
13639
|
'noise_sensor',
|
|
13046
13640
|
'access_control',
|
|
13047
13641
|
'camera',
|
|
13642
|
+
'speaker',
|
|
13048
13643
|
],
|
|
13049
13644
|
type: 'string',
|
|
13050
13645
|
},
|
|
@@ -13212,6 +13807,7 @@ const openapi: OpenAPISpec = {
|
|
|
13212
13807
|
'noise_sensor',
|
|
13213
13808
|
'access_control',
|
|
13214
13809
|
'camera',
|
|
13810
|
+
'speaker',
|
|
13215
13811
|
],
|
|
13216
13812
|
type: 'string',
|
|
13217
13813
|
},
|
|
@@ -13942,6 +14538,21 @@ const openapi: OpenAPISpec = {
|
|
|
13942
14538
|
'Indicates whether the thermostat supports simultaneous heating and cooling.',
|
|
13943
14539
|
type: 'boolean',
|
|
13944
14540
|
},
|
|
14541
|
+
can_mute_speaker: {
|
|
14542
|
+
description:
|
|
14543
|
+
'Indicates whether the speaker supports muting and unmuting.',
|
|
14544
|
+
type: 'boolean',
|
|
14545
|
+
},
|
|
14546
|
+
can_pause_speaker_playback: {
|
|
14547
|
+
description:
|
|
14548
|
+
'Indicates whether the speaker supports pausing and resuming playback.',
|
|
14549
|
+
type: 'boolean',
|
|
14550
|
+
},
|
|
14551
|
+
can_play_speaker_chime: {
|
|
14552
|
+
description:
|
|
14553
|
+
'Indicates whether the speaker supports playing a chime.',
|
|
14554
|
+
type: 'boolean',
|
|
14555
|
+
},
|
|
13945
14556
|
can_program_offline_access_codes: {
|
|
13946
14557
|
description:
|
|
13947
14558
|
'Indicates whether the device supports programming offline access codes.',
|
|
@@ -13982,6 +14593,11 @@ const openapi: OpenAPISpec = {
|
|
|
13982
14593
|
'Indicates whether the thermostat supports running climate programs.',
|
|
13983
14594
|
type: 'boolean',
|
|
13984
14595
|
},
|
|
14596
|
+
can_set_speaker_volume: {
|
|
14597
|
+
description:
|
|
14598
|
+
'Indicates whether the speaker supports setting its volume.',
|
|
14599
|
+
type: 'boolean',
|
|
14600
|
+
},
|
|
13985
14601
|
can_simulate_connection: {
|
|
13986
14602
|
description:
|
|
13987
14603
|
'Indicates whether the device supports simulating connection in a sandbox.',
|
|
@@ -14202,6 +14818,11 @@ const openapi: OpenAPISpec = {
|
|
|
14202
14818
|
],
|
|
14203
14819
|
type: 'string',
|
|
14204
14820
|
},
|
|
14821
|
+
{
|
|
14822
|
+
description: 'Device type for speakers.',
|
|
14823
|
+
enum: ['sonos_speaker'],
|
|
14824
|
+
type: 'string',
|
|
14825
|
+
},
|
|
14205
14826
|
],
|
|
14206
14827
|
},
|
|
14207
14828
|
display_name: {
|
|
@@ -16243,6 +16864,38 @@ const openapi: OpenAPISpec = {
|
|
|
16243
16864
|
},
|
|
16244
16865
|
type: 'object',
|
|
16245
16866
|
},
|
|
16867
|
+
sonos_metadata: {
|
|
16868
|
+
description: 'Metadata for a Sonos speaker.',
|
|
16869
|
+
properties: {
|
|
16870
|
+
bonded_member_models: {
|
|
16871
|
+
description:
|
|
16872
|
+
'Models of the speakers bonded to this speaker, such as surrounds or a subwoofer.',
|
|
16873
|
+
items: { type: 'string' },
|
|
16874
|
+
type: 'array',
|
|
16875
|
+
},
|
|
16876
|
+
household_id: {
|
|
16877
|
+
description:
|
|
16878
|
+
'ID of the Sonos household that the speaker belongs to.',
|
|
16879
|
+
type: 'string',
|
|
16880
|
+
},
|
|
16881
|
+
model_display_name: {
|
|
16882
|
+
description:
|
|
16883
|
+
'Model name of the speaker, as reported by Sonos.',
|
|
16884
|
+
type: 'string',
|
|
16885
|
+
},
|
|
16886
|
+
player_id: {
|
|
16887
|
+
description:
|
|
16888
|
+
'ID of the Sonos player for the speaker.',
|
|
16889
|
+
type: 'string',
|
|
16890
|
+
},
|
|
16891
|
+
software_version: {
|
|
16892
|
+
description:
|
|
16893
|
+
'Software version running on the speaker.',
|
|
16894
|
+
type: 'string',
|
|
16895
|
+
},
|
|
16896
|
+
},
|
|
16897
|
+
type: 'object',
|
|
16898
|
+
},
|
|
16246
16899
|
tado_metadata: {
|
|
16247
16900
|
description: 'Metadata for a tado° device.',
|
|
16248
16901
|
properties: {
|
|
@@ -16811,6 +17464,109 @@ const openapi: OpenAPISpec = {
|
|
|
16811
17464
|
type: 'array',
|
|
16812
17465
|
'x-property-group-key': 'access_codes',
|
|
16813
17466
|
},
|
|
17467
|
+
speaker: {
|
|
17468
|
+
description:
|
|
17469
|
+
'Audio state and capabilities of the speaker.',
|
|
17470
|
+
properties: {
|
|
17471
|
+
grouped_with_device_ids: {
|
|
17472
|
+
description:
|
|
17473
|
+
'IDs of the other speakers that are currently grouped with this speaker. Pausing or resuming playback on a speaker also affects the speakers in its group.',
|
|
17474
|
+
items: { format: 'uuid', type: 'string' },
|
|
17475
|
+
type: 'array',
|
|
17476
|
+
},
|
|
17477
|
+
has_fixed_volume: {
|
|
17478
|
+
description:
|
|
17479
|
+
"Indicates whether the speaker's volume is fixed, for example, because the speaker's line-out level is controlled by an external amplifier. A speaker with a fixed volume cannot have its volume set through Seam.",
|
|
17480
|
+
type: 'boolean',
|
|
17481
|
+
},
|
|
17482
|
+
is_muted: {
|
|
17483
|
+
description:
|
|
17484
|
+
'Indicates whether the speaker is muted.',
|
|
17485
|
+
type: 'boolean',
|
|
17486
|
+
},
|
|
17487
|
+
max_volume: {
|
|
17488
|
+
description:
|
|
17489
|
+
"Maximum volume that you can set on the speaker. This is the ceiling of the speaker's native volume scale, not a limit configured for guests.",
|
|
17490
|
+
format: 'float',
|
|
17491
|
+
type: 'number',
|
|
17492
|
+
},
|
|
17493
|
+
min_volume: {
|
|
17494
|
+
description:
|
|
17495
|
+
'Minimum volume that you can set on the speaker.',
|
|
17496
|
+
format: 'float',
|
|
17497
|
+
type: 'number',
|
|
17498
|
+
},
|
|
17499
|
+
now_playing: {
|
|
17500
|
+
description:
|
|
17501
|
+
'Content that is currently playing on the speaker.',
|
|
17502
|
+
properties: {
|
|
17503
|
+
album: {
|
|
17504
|
+
description:
|
|
17505
|
+
'Album of the content that is currently playing.',
|
|
17506
|
+
type: 'string',
|
|
17507
|
+
},
|
|
17508
|
+
artist: {
|
|
17509
|
+
description:
|
|
17510
|
+
'Artist of the content that is currently playing.',
|
|
17511
|
+
type: 'string',
|
|
17512
|
+
},
|
|
17513
|
+
title: {
|
|
17514
|
+
description:
|
|
17515
|
+
'Title of the content that is currently playing.',
|
|
17516
|
+
type: 'string',
|
|
17517
|
+
},
|
|
17518
|
+
},
|
|
17519
|
+
type: 'object',
|
|
17520
|
+
},
|
|
17521
|
+
playback_state: {
|
|
17522
|
+
description: 'Playback state of the speaker.',
|
|
17523
|
+
enum: [
|
|
17524
|
+
'playing',
|
|
17525
|
+
'paused',
|
|
17526
|
+
'idle',
|
|
17527
|
+
'buffering',
|
|
17528
|
+
'unknown',
|
|
17529
|
+
],
|
|
17530
|
+
type: 'string',
|
|
17531
|
+
},
|
|
17532
|
+
supports_chime: {
|
|
17533
|
+
description:
|
|
17534
|
+
'Indicates whether the speaker can play a chime.',
|
|
17535
|
+
type: 'boolean',
|
|
17536
|
+
},
|
|
17537
|
+
volume: {
|
|
17538
|
+
description:
|
|
17539
|
+
"Current volume of the speaker, on the speaker's native volume scale from `min_volume` to `max_volume`. This is the native volume setting, not a decibel level.",
|
|
17540
|
+
format: 'float',
|
|
17541
|
+
type: 'number',
|
|
17542
|
+
},
|
|
17543
|
+
volume_reported_at: {
|
|
17544
|
+
description:
|
|
17545
|
+
'Date and time at which the speaker last reported its volume.',
|
|
17546
|
+
format: 'date-time',
|
|
17547
|
+
type: 'string',
|
|
17548
|
+
},
|
|
17549
|
+
volume_step: {
|
|
17550
|
+
description:
|
|
17551
|
+
'Increment between the volume values that you can set on the speaker.',
|
|
17552
|
+
format: 'float',
|
|
17553
|
+
type: 'number',
|
|
17554
|
+
},
|
|
17555
|
+
},
|
|
17556
|
+
required: [
|
|
17557
|
+
'volume',
|
|
17558
|
+
'is_muted',
|
|
17559
|
+
'has_fixed_volume',
|
|
17560
|
+
'min_volume',
|
|
17561
|
+
'max_volume',
|
|
17562
|
+
'volume_step',
|
|
17563
|
+
'playback_state',
|
|
17564
|
+
'grouped_with_device_ids',
|
|
17565
|
+
'supports_chime',
|
|
17566
|
+
],
|
|
17567
|
+
type: 'object',
|
|
17568
|
+
'x-property-group-key': 'speakers',
|
|
17569
|
+
},
|
|
16814
17570
|
supported_code_lengths: {
|
|
16815
17571
|
description: 'Supported code lengths for access codes.',
|
|
16816
17572
|
items: { format: 'float', type: 'number' },
|
|
@@ -17725,6 +18481,7 @@ const openapi: OpenAPISpec = {
|
|
|
17725
18481
|
noise_sensors: { name: 'Noise Sensors' },
|
|
17726
18482
|
phones: { name: 'Phones' },
|
|
17727
18483
|
provider_metadata: { name: 'Provider Metadata' },
|
|
18484
|
+
speakers: { name: 'Speakers' },
|
|
17728
18485
|
thermostats: { name: 'Thermostats' },
|
|
17729
18486
|
},
|
|
17730
18487
|
},
|
|
@@ -18523,6 +19280,7 @@ const openapi: OpenAPISpec = {
|
|
|
18523
19280
|
noise_sensors: { name: 'Noise Sensors' },
|
|
18524
19281
|
phones: { name: 'Phones' },
|
|
18525
19282
|
provider_metadata: { name: 'Provider Metadata' },
|
|
19283
|
+
speakers: { name: 'Speakers' },
|
|
18526
19284
|
thermostats: { name: 'Thermostats' },
|
|
18527
19285
|
},
|
|
18528
19286
|
'x-route-path': '/devices',
|
|
@@ -18552,6 +19310,21 @@ const openapi: OpenAPISpec = {
|
|
|
18552
19310
|
'Indicates whether the thermostat supports simultaneous heating and cooling.',
|
|
18553
19311
|
type: 'boolean',
|
|
18554
19312
|
},
|
|
19313
|
+
can_mute_speaker: {
|
|
19314
|
+
description:
|
|
19315
|
+
'Indicates whether the speaker supports muting and unmuting.',
|
|
19316
|
+
type: 'boolean',
|
|
19317
|
+
},
|
|
19318
|
+
can_pause_speaker_playback: {
|
|
19319
|
+
description:
|
|
19320
|
+
'Indicates whether the speaker supports pausing and resuming playback.',
|
|
19321
|
+
type: 'boolean',
|
|
19322
|
+
},
|
|
19323
|
+
can_play_speaker_chime: {
|
|
19324
|
+
description:
|
|
19325
|
+
'Indicates whether the speaker supports playing a chime.',
|
|
19326
|
+
type: 'boolean',
|
|
19327
|
+
},
|
|
18555
19328
|
can_program_offline_access_codes: {
|
|
18556
19329
|
description:
|
|
18557
19330
|
'Indicates whether the device supports programming offline access codes.',
|
|
@@ -18592,6 +19365,11 @@ const openapi: OpenAPISpec = {
|
|
|
18592
19365
|
'Indicates whether the thermostat supports running climate programs.',
|
|
18593
19366
|
type: 'boolean',
|
|
18594
19367
|
},
|
|
19368
|
+
can_set_speaker_volume: {
|
|
19369
|
+
description:
|
|
19370
|
+
'Indicates whether the speaker supports setting its volume.',
|
|
19371
|
+
type: 'boolean',
|
|
19372
|
+
},
|
|
18595
19373
|
can_simulate_connection: {
|
|
18596
19374
|
description:
|
|
18597
19375
|
'Indicates whether the device supports simulating connection in a sandbox.',
|
|
@@ -30217,104 +30995,1381 @@ const openapi: OpenAPISpec = {
|
|
|
30217
30995
|
type: 'string',
|
|
30218
30996
|
},
|
|
30219
30997
|
errors: {
|
|
30220
|
-
description:
|
|
30998
|
+
description:
|
|
30999
|
+
'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.',
|
|
30221
31000
|
items: {
|
|
30222
|
-
|
|
30223
|
-
|
|
30224
|
-
|
|
30225
|
-
|
|
30226
|
-
|
|
31001
|
+
discriminator: { propertyName: 'error_code' },
|
|
31002
|
+
oneOf: [
|
|
31003
|
+
{
|
|
31004
|
+
description: 'Indicates that the account is disconnected.',
|
|
31005
|
+
properties: {
|
|
31006
|
+
created_at: {
|
|
31007
|
+
description:
|
|
31008
|
+
'Date and time at which Seam created the error.',
|
|
31009
|
+
format: 'date-time',
|
|
31010
|
+
type: 'string',
|
|
31011
|
+
},
|
|
31012
|
+
error_code: {
|
|
31013
|
+
description:
|
|
31014
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31015
|
+
enum: ['account_disconnected'],
|
|
31016
|
+
type: 'string',
|
|
31017
|
+
},
|
|
31018
|
+
is_connected_account_error: {
|
|
31019
|
+
description:
|
|
31020
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
31021
|
+
enum: [true],
|
|
31022
|
+
type: 'boolean',
|
|
31023
|
+
},
|
|
31024
|
+
is_device_error: {
|
|
31025
|
+
description:
|
|
31026
|
+
'Indicates that the error is not a device error.',
|
|
31027
|
+
enum: [false],
|
|
31028
|
+
type: 'boolean',
|
|
31029
|
+
},
|
|
31030
|
+
message: {
|
|
31031
|
+
description:
|
|
31032
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31033
|
+
type: 'string',
|
|
31034
|
+
},
|
|
31035
|
+
},
|
|
31036
|
+
required: [
|
|
31037
|
+
'message',
|
|
31038
|
+
'is_device_error',
|
|
31039
|
+
'created_at',
|
|
31040
|
+
'error_code',
|
|
31041
|
+
'is_connected_account_error',
|
|
31042
|
+
],
|
|
31043
|
+
type: 'object',
|
|
31044
|
+
'x-resource-type': 'connected_account',
|
|
31045
|
+
},
|
|
31046
|
+
{
|
|
31047
|
+
description:
|
|
31048
|
+
'Indicates that the Salto site user limit has been reached.',
|
|
31049
|
+
properties: {
|
|
31050
|
+
created_at: {
|
|
31051
|
+
description:
|
|
31052
|
+
'Date and time at which Seam created the error.',
|
|
31053
|
+
format: 'date-time',
|
|
31054
|
+
type: 'string',
|
|
31055
|
+
},
|
|
31056
|
+
error_code: {
|
|
31057
|
+
description:
|
|
31058
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31059
|
+
enum: ['salto_ks_subscription_limit_exceeded'],
|
|
31060
|
+
type: 'string',
|
|
31061
|
+
},
|
|
31062
|
+
is_connected_account_error: {
|
|
31063
|
+
description:
|
|
31064
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
31065
|
+
enum: [true],
|
|
31066
|
+
type: 'boolean',
|
|
31067
|
+
},
|
|
31068
|
+
is_device_error: {
|
|
31069
|
+
description:
|
|
31070
|
+
'Indicates that the error is not a device error.',
|
|
31071
|
+
enum: [false],
|
|
31072
|
+
type: 'boolean',
|
|
31073
|
+
},
|
|
31074
|
+
message: {
|
|
31075
|
+
description:
|
|
31076
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31077
|
+
type: 'string',
|
|
31078
|
+
},
|
|
31079
|
+
},
|
|
31080
|
+
required: [
|
|
31081
|
+
'message',
|
|
31082
|
+
'is_device_error',
|
|
31083
|
+
'created_at',
|
|
31084
|
+
'error_code',
|
|
31085
|
+
'is_connected_account_error',
|
|
31086
|
+
],
|
|
31087
|
+
type: 'object',
|
|
31088
|
+
'x-resource-type': 'connected_account',
|
|
31089
|
+
'x-variant-group-key': 'locks',
|
|
31090
|
+
},
|
|
31091
|
+
{
|
|
31092
|
+
description:
|
|
31093
|
+
"Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.",
|
|
31094
|
+
properties: {
|
|
31095
|
+
created_at: {
|
|
31096
|
+
description:
|
|
31097
|
+
'Date and time at which Seam created the error.',
|
|
31098
|
+
format: 'date-time',
|
|
31099
|
+
type: 'string',
|
|
31100
|
+
},
|
|
31101
|
+
error_code: {
|
|
31102
|
+
description:
|
|
31103
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31104
|
+
enum: ['insufficient_permissions'],
|
|
31105
|
+
type: 'string',
|
|
31106
|
+
},
|
|
31107
|
+
is_connected_account_error: {
|
|
31108
|
+
description:
|
|
31109
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
31110
|
+
enum: [true],
|
|
31111
|
+
type: 'boolean',
|
|
31112
|
+
},
|
|
31113
|
+
is_device_error: {
|
|
31114
|
+
description:
|
|
31115
|
+
'Indicates that the error is not a device error.',
|
|
31116
|
+
enum: [false],
|
|
31117
|
+
type: 'boolean',
|
|
31118
|
+
},
|
|
31119
|
+
message: {
|
|
31120
|
+
description:
|
|
31121
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31122
|
+
type: 'string',
|
|
31123
|
+
},
|
|
31124
|
+
},
|
|
31125
|
+
required: [
|
|
31126
|
+
'message',
|
|
31127
|
+
'is_device_error',
|
|
31128
|
+
'created_at',
|
|
31129
|
+
'error_code',
|
|
31130
|
+
'is_connected_account_error',
|
|
31131
|
+
],
|
|
31132
|
+
type: 'object',
|
|
31133
|
+
'x-resource-type': 'connected_account',
|
|
31134
|
+
},
|
|
31135
|
+
{
|
|
31136
|
+
description:
|
|
31137
|
+
'Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.',
|
|
31138
|
+
properties: {
|
|
31139
|
+
created_at: {
|
|
31140
|
+
description:
|
|
31141
|
+
'Date and time at which Seam created the error.',
|
|
31142
|
+
format: 'date-time',
|
|
31143
|
+
type: 'string',
|
|
31144
|
+
},
|
|
31145
|
+
error_code: {
|
|
31146
|
+
description:
|
|
31147
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31148
|
+
enum: ['dormakaba_sites_disconnected'],
|
|
31149
|
+
type: 'string',
|
|
31150
|
+
},
|
|
31151
|
+
is_connected_account_error: {
|
|
31152
|
+
description:
|
|
31153
|
+
'Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.',
|
|
31154
|
+
enum: [true],
|
|
31155
|
+
type: 'boolean',
|
|
31156
|
+
},
|
|
31157
|
+
is_device_error: {
|
|
31158
|
+
description:
|
|
31159
|
+
'Indicates that the error is not a device error.',
|
|
31160
|
+
enum: [false],
|
|
31161
|
+
type: 'boolean',
|
|
31162
|
+
},
|
|
31163
|
+
message: {
|
|
31164
|
+
description:
|
|
31165
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31166
|
+
type: 'string',
|
|
31167
|
+
},
|
|
31168
|
+
},
|
|
31169
|
+
required: [
|
|
31170
|
+
'message',
|
|
31171
|
+
'is_device_error',
|
|
31172
|
+
'created_at',
|
|
31173
|
+
'error_code',
|
|
31174
|
+
'is_connected_account_error',
|
|
31175
|
+
],
|
|
31176
|
+
type: 'object',
|
|
31177
|
+
'x-resource-type': 'connected_account',
|
|
31178
|
+
'x-variant-group-key': 'locks',
|
|
31179
|
+
},
|
|
31180
|
+
{
|
|
31181
|
+
deprecated: true,
|
|
31182
|
+
description: 'Indicates that the device is offline.',
|
|
31183
|
+
properties: {
|
|
31184
|
+
created_at: {
|
|
31185
|
+
description:
|
|
31186
|
+
'Date and time at which Seam created the error.',
|
|
31187
|
+
format: 'date-time',
|
|
31188
|
+
type: 'string',
|
|
31189
|
+
},
|
|
31190
|
+
error_code: {
|
|
31191
|
+
description:
|
|
31192
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31193
|
+
enum: ['device_offline'],
|
|
31194
|
+
type: 'string',
|
|
31195
|
+
},
|
|
31196
|
+
is_device_error: {
|
|
31197
|
+
description:
|
|
31198
|
+
'Indicates that the error is a device error.',
|
|
31199
|
+
enum: [true],
|
|
31200
|
+
type: 'boolean',
|
|
31201
|
+
},
|
|
31202
|
+
message: {
|
|
31203
|
+
description:
|
|
31204
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31205
|
+
type: 'string',
|
|
31206
|
+
},
|
|
31207
|
+
},
|
|
31208
|
+
required: [
|
|
31209
|
+
'message',
|
|
31210
|
+
'is_device_error',
|
|
31211
|
+
'created_at',
|
|
31212
|
+
'error_code',
|
|
31213
|
+
],
|
|
31214
|
+
type: 'object',
|
|
31215
|
+
'x-deprecated': 'Use `device_disconnected` instead.',
|
|
31216
|
+
'x-resource-type': 'device',
|
|
31217
|
+
},
|
|
31218
|
+
{
|
|
31219
|
+
description: 'Indicates that the device has been removed.',
|
|
31220
|
+
properties: {
|
|
31221
|
+
created_at: {
|
|
31222
|
+
description:
|
|
31223
|
+
'Date and time at which Seam created the error.',
|
|
31224
|
+
format: 'date-time',
|
|
31225
|
+
type: 'string',
|
|
31226
|
+
},
|
|
31227
|
+
error_code: {
|
|
31228
|
+
description:
|
|
31229
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31230
|
+
enum: ['device_removed'],
|
|
31231
|
+
type: 'string',
|
|
31232
|
+
},
|
|
31233
|
+
is_device_error: {
|
|
31234
|
+
description:
|
|
31235
|
+
'Indicates that the error is a device error.',
|
|
31236
|
+
enum: [true],
|
|
31237
|
+
type: 'boolean',
|
|
31238
|
+
},
|
|
31239
|
+
message: {
|
|
31240
|
+
description:
|
|
31241
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31242
|
+
type: 'string',
|
|
31243
|
+
},
|
|
31244
|
+
},
|
|
31245
|
+
required: [
|
|
31246
|
+
'message',
|
|
31247
|
+
'is_device_error',
|
|
31248
|
+
'created_at',
|
|
31249
|
+
'error_code',
|
|
31250
|
+
],
|
|
31251
|
+
type: 'object',
|
|
31252
|
+
'x-resource-type': 'device',
|
|
31253
|
+
},
|
|
31254
|
+
{
|
|
31255
|
+
description: 'Indicates that the hub is disconnected.',
|
|
31256
|
+
properties: {
|
|
31257
|
+
created_at: {
|
|
31258
|
+
description:
|
|
31259
|
+
'Date and time at which Seam created the error.',
|
|
31260
|
+
format: 'date-time',
|
|
31261
|
+
type: 'string',
|
|
31262
|
+
},
|
|
31263
|
+
error_code: {
|
|
31264
|
+
description:
|
|
31265
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31266
|
+
enum: ['hub_disconnected'],
|
|
31267
|
+
type: 'string',
|
|
31268
|
+
},
|
|
31269
|
+
is_device_error: {
|
|
31270
|
+
description:
|
|
31271
|
+
'Indicates that the error is a device error.',
|
|
31272
|
+
enum: [true],
|
|
31273
|
+
type: 'boolean',
|
|
31274
|
+
},
|
|
31275
|
+
message: {
|
|
31276
|
+
description:
|
|
31277
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31278
|
+
type: 'string',
|
|
31279
|
+
},
|
|
31280
|
+
},
|
|
31281
|
+
required: [
|
|
31282
|
+
'message',
|
|
31283
|
+
'is_device_error',
|
|
31284
|
+
'created_at',
|
|
31285
|
+
'error_code',
|
|
31286
|
+
],
|
|
31287
|
+
type: 'object',
|
|
31288
|
+
'x-resource-type': 'device',
|
|
31289
|
+
},
|
|
31290
|
+
{
|
|
31291
|
+
description: 'Indicates that the device is disconnected.',
|
|
31292
|
+
properties: {
|
|
31293
|
+
created_at: {
|
|
31294
|
+
description:
|
|
31295
|
+
'Date and time at which Seam created the error.',
|
|
31296
|
+
format: 'date-time',
|
|
31297
|
+
type: 'string',
|
|
31298
|
+
},
|
|
31299
|
+
error_code: {
|
|
31300
|
+
description:
|
|
31301
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31302
|
+
enum: ['device_disconnected'],
|
|
31303
|
+
type: 'string',
|
|
31304
|
+
},
|
|
31305
|
+
is_device_error: {
|
|
31306
|
+
description:
|
|
31307
|
+
'Indicates that the error is a device error.',
|
|
31308
|
+
enum: [true],
|
|
31309
|
+
type: 'boolean',
|
|
31310
|
+
},
|
|
31311
|
+
message: {
|
|
31312
|
+
description:
|
|
31313
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31314
|
+
type: 'string',
|
|
31315
|
+
},
|
|
31316
|
+
},
|
|
31317
|
+
required: [
|
|
31318
|
+
'message',
|
|
31319
|
+
'is_device_error',
|
|
31320
|
+
'created_at',
|
|
31321
|
+
'error_code',
|
|
31322
|
+
],
|
|
31323
|
+
type: 'object',
|
|
31324
|
+
'x-resource-type': 'device',
|
|
31325
|
+
},
|
|
31326
|
+
{
|
|
31327
|
+
description:
|
|
31328
|
+
'Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.',
|
|
31329
|
+
properties: {
|
|
31330
|
+
created_at: {
|
|
31331
|
+
description:
|
|
31332
|
+
'Date and time at which Seam created the error.',
|
|
31333
|
+
format: 'date-time',
|
|
31334
|
+
type: 'string',
|
|
31335
|
+
},
|
|
31336
|
+
error_code: {
|
|
31337
|
+
description:
|
|
31338
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31339
|
+
enum: ['empty_backup_access_code_pool'],
|
|
31340
|
+
type: 'string',
|
|
31341
|
+
},
|
|
31342
|
+
is_device_error: {
|
|
31343
|
+
description:
|
|
31344
|
+
'Indicates that the error is a device error.',
|
|
31345
|
+
enum: [true],
|
|
31346
|
+
type: 'boolean',
|
|
31347
|
+
},
|
|
31348
|
+
message: {
|
|
31349
|
+
description:
|
|
31350
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31351
|
+
type: 'string',
|
|
31352
|
+
},
|
|
31353
|
+
},
|
|
31354
|
+
required: [
|
|
31355
|
+
'message',
|
|
31356
|
+
'is_device_error',
|
|
31357
|
+
'created_at',
|
|
31358
|
+
'error_code',
|
|
31359
|
+
],
|
|
31360
|
+
type: 'object',
|
|
31361
|
+
'x-resource-type': 'device',
|
|
31362
|
+
'x-variant-group-key': 'access_codes',
|
|
31363
|
+
},
|
|
31364
|
+
{
|
|
31365
|
+
description:
|
|
31366
|
+
'Indicates that the user is not authorized to use the August lock.',
|
|
31367
|
+
properties: {
|
|
31368
|
+
created_at: {
|
|
31369
|
+
description:
|
|
31370
|
+
'Date and time at which Seam created the error.',
|
|
31371
|
+
format: 'date-time',
|
|
31372
|
+
type: 'string',
|
|
31373
|
+
},
|
|
31374
|
+
error_code: {
|
|
31375
|
+
description:
|
|
31376
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31377
|
+
enum: ['august_lock_not_authorized'],
|
|
31378
|
+
type: 'string',
|
|
31379
|
+
},
|
|
31380
|
+
is_device_error: {
|
|
31381
|
+
description:
|
|
31382
|
+
'Indicates that the error is a device error.',
|
|
31383
|
+
enum: [true],
|
|
31384
|
+
type: 'boolean',
|
|
31385
|
+
},
|
|
31386
|
+
message: {
|
|
31387
|
+
description:
|
|
31388
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31389
|
+
type: 'string',
|
|
31390
|
+
},
|
|
31391
|
+
},
|
|
31392
|
+
required: [
|
|
31393
|
+
'message',
|
|
31394
|
+
'is_device_error',
|
|
31395
|
+
'created_at',
|
|
31396
|
+
'error_code',
|
|
31397
|
+
],
|
|
31398
|
+
type: 'object',
|
|
31399
|
+
'x-resource-type': 'device',
|
|
31400
|
+
'x-variant-group-key': 'locks',
|
|
31401
|
+
},
|
|
31402
|
+
{
|
|
31403
|
+
description: 'Indicates that device credentials are missing.',
|
|
31404
|
+
properties: {
|
|
31405
|
+
created_at: {
|
|
31406
|
+
description:
|
|
31407
|
+
'Date and time at which Seam created the error.',
|
|
31408
|
+
format: 'date-time',
|
|
31409
|
+
type: 'string',
|
|
31410
|
+
},
|
|
31411
|
+
error_code: {
|
|
31412
|
+
description:
|
|
31413
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31414
|
+
enum: ['missing_device_credentials'],
|
|
31415
|
+
type: 'string',
|
|
31416
|
+
},
|
|
31417
|
+
is_device_error: {
|
|
31418
|
+
description:
|
|
31419
|
+
'Indicates that the error is a device error.',
|
|
31420
|
+
enum: [true],
|
|
31421
|
+
type: 'boolean',
|
|
31422
|
+
},
|
|
31423
|
+
message: {
|
|
31424
|
+
description:
|
|
31425
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31426
|
+
type: 'string',
|
|
31427
|
+
},
|
|
31428
|
+
},
|
|
31429
|
+
required: [
|
|
31430
|
+
'message',
|
|
31431
|
+
'is_device_error',
|
|
31432
|
+
'created_at',
|
|
31433
|
+
'error_code',
|
|
31434
|
+
],
|
|
31435
|
+
type: 'object',
|
|
31436
|
+
'x-resource-type': 'device',
|
|
31437
|
+
},
|
|
31438
|
+
{
|
|
31439
|
+
description: 'Indicates that the auxiliary heat is running.',
|
|
31440
|
+
properties: {
|
|
31441
|
+
created_at: {
|
|
31442
|
+
description:
|
|
31443
|
+
'Date and time at which Seam created the error.',
|
|
31444
|
+
format: 'date-time',
|
|
31445
|
+
type: 'string',
|
|
31446
|
+
},
|
|
31447
|
+
error_code: {
|
|
31448
|
+
description:
|
|
31449
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31450
|
+
enum: ['auxiliary_heat_running'],
|
|
31451
|
+
type: 'string',
|
|
31452
|
+
},
|
|
31453
|
+
is_device_error: {
|
|
31454
|
+
description:
|
|
31455
|
+
'Indicates that the error is a device error.',
|
|
31456
|
+
enum: [true],
|
|
31457
|
+
type: 'boolean',
|
|
31458
|
+
},
|
|
31459
|
+
message: {
|
|
31460
|
+
description:
|
|
31461
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31462
|
+
type: 'string',
|
|
31463
|
+
},
|
|
31464
|
+
},
|
|
31465
|
+
required: [
|
|
31466
|
+
'message',
|
|
31467
|
+
'is_device_error',
|
|
31468
|
+
'created_at',
|
|
31469
|
+
'error_code',
|
|
31470
|
+
],
|
|
31471
|
+
type: 'object',
|
|
31472
|
+
'x-resource-type': 'device',
|
|
31473
|
+
'x-variant-group-key': 'thermostats',
|
|
31474
|
+
},
|
|
31475
|
+
{
|
|
31476
|
+
description:
|
|
31477
|
+
'Indicates that a subscription is required to connect.',
|
|
31478
|
+
properties: {
|
|
31479
|
+
created_at: {
|
|
31480
|
+
description:
|
|
31481
|
+
'Date and time at which Seam created the error.',
|
|
31482
|
+
format: 'date-time',
|
|
31483
|
+
type: 'string',
|
|
31484
|
+
},
|
|
31485
|
+
error_code: {
|
|
31486
|
+
description:
|
|
31487
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31488
|
+
enum: ['subscription_required'],
|
|
31489
|
+
type: 'string',
|
|
31490
|
+
},
|
|
31491
|
+
is_device_error: {
|
|
31492
|
+
description:
|
|
31493
|
+
'Indicates that the error is a device error.',
|
|
31494
|
+
enum: [true],
|
|
31495
|
+
type: 'boolean',
|
|
31496
|
+
},
|
|
31497
|
+
message: {
|
|
31498
|
+
description:
|
|
31499
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31500
|
+
type: 'string',
|
|
31501
|
+
},
|
|
31502
|
+
},
|
|
31503
|
+
required: [
|
|
31504
|
+
'message',
|
|
31505
|
+
'is_device_error',
|
|
31506
|
+
'created_at',
|
|
31507
|
+
'error_code',
|
|
31508
|
+
],
|
|
31509
|
+
type: 'object',
|
|
31510
|
+
'x-resource-type': 'device',
|
|
31511
|
+
},
|
|
31512
|
+
{
|
|
31513
|
+
description:
|
|
31514
|
+
'Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).',
|
|
31515
|
+
properties: {
|
|
31516
|
+
created_at: {
|
|
31517
|
+
description:
|
|
31518
|
+
'Date and time at which Seam created the error.',
|
|
31519
|
+
format: 'date-time',
|
|
31520
|
+
type: 'string',
|
|
31521
|
+
},
|
|
31522
|
+
error_code: {
|
|
31523
|
+
description:
|
|
31524
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
31525
|
+
enum: ['bridge_disconnected'],
|
|
31526
|
+
type: 'string',
|
|
31527
|
+
},
|
|
31528
|
+
is_bridge_error: {
|
|
31529
|
+
description:
|
|
31530
|
+
'Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).',
|
|
31531
|
+
type: 'boolean',
|
|
31532
|
+
},
|
|
31533
|
+
is_connected_account_error: {
|
|
31534
|
+
description:
|
|
31535
|
+
'Indicates whether the error is related specifically to the connected account.',
|
|
31536
|
+
type: 'boolean',
|
|
31537
|
+
},
|
|
31538
|
+
message: {
|
|
31539
|
+
description:
|
|
31540
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
31541
|
+
type: 'string',
|
|
31542
|
+
},
|
|
31543
|
+
},
|
|
31544
|
+
required: ['created_at', 'message', 'error_code'],
|
|
31545
|
+
type: 'object',
|
|
31546
|
+
'x-resource-type': 'connected_account',
|
|
31547
|
+
},
|
|
31548
|
+
],
|
|
31549
|
+
},
|
|
31550
|
+
type: 'array',
|
|
31551
|
+
'x-variant-groups': {
|
|
31552
|
+
access_codes: { name: 'Access Codes' },
|
|
31553
|
+
hardware: { name: 'Hardware' },
|
|
31554
|
+
locks: { name: 'Locks' },
|
|
31555
|
+
noise_sensors: { name: 'Noise Sensors' },
|
|
31556
|
+
phones: { name: 'Phones' },
|
|
31557
|
+
provider_metadata: { name: 'Provider Metadata' },
|
|
31558
|
+
thermostats: { name: 'Thermostats' },
|
|
31559
|
+
},
|
|
31560
|
+
},
|
|
31561
|
+
nickname: {
|
|
31562
|
+
description:
|
|
31563
|
+
'Optional nickname to describe the phone, settable through Seam.\n ',
|
|
31564
|
+
type: 'string',
|
|
31565
|
+
},
|
|
31566
|
+
properties: {
|
|
31567
|
+
description: 'Properties of the phone.',
|
|
31568
|
+
properties: {
|
|
31569
|
+
assa_abloy_credential_service_metadata: {
|
|
31570
|
+
description:
|
|
31571
|
+
'ASSA ABLOY Credential Service metadata for the phone.',
|
|
31572
|
+
properties: {
|
|
31573
|
+
endpoints: {
|
|
31574
|
+
description: 'Endpoints associated with the phone.',
|
|
31575
|
+
items: {
|
|
31576
|
+
properties: {
|
|
31577
|
+
endpoint_id: {
|
|
31578
|
+
description: 'ID of the associated endpoint.',
|
|
31579
|
+
type: 'string',
|
|
31580
|
+
},
|
|
31581
|
+
is_active: {
|
|
31582
|
+
description:
|
|
31583
|
+
'Indicated whether the endpoint is active.',
|
|
31584
|
+
type: 'boolean',
|
|
31585
|
+
},
|
|
31586
|
+
},
|
|
31587
|
+
type: 'object',
|
|
31588
|
+
},
|
|
31589
|
+
type: 'array',
|
|
31590
|
+
},
|
|
31591
|
+
has_active_endpoint: {
|
|
31592
|
+
description:
|
|
31593
|
+
'Indicates whether the credential service has active endpoints associated with the phone.',
|
|
31594
|
+
type: 'boolean',
|
|
31595
|
+
},
|
|
31596
|
+
},
|
|
31597
|
+
type: 'object',
|
|
31598
|
+
},
|
|
31599
|
+
salto_space_credential_service_metadata: {
|
|
31600
|
+
description:
|
|
31601
|
+
'Salto Space credential service metadata for the phone.',
|
|
31602
|
+
properties: {
|
|
31603
|
+
has_active_phone: {
|
|
31604
|
+
description:
|
|
31605
|
+
'Indicates whether the credential service has an active associated phone.',
|
|
31606
|
+
type: 'boolean',
|
|
31607
|
+
},
|
|
31608
|
+
},
|
|
31609
|
+
type: 'object',
|
|
31610
|
+
},
|
|
31611
|
+
},
|
|
31612
|
+
type: 'object',
|
|
31613
|
+
},
|
|
31614
|
+
warnings: {
|
|
31615
|
+
description:
|
|
31616
|
+
'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.',
|
|
31617
|
+
items: {
|
|
31618
|
+
discriminator: { propertyName: 'warning_code' },
|
|
31619
|
+
oneOf: [
|
|
31620
|
+
{
|
|
31621
|
+
description:
|
|
31622
|
+
'Indicates that the backup access code is unhealthy.',
|
|
31623
|
+
properties: {
|
|
31624
|
+
created_at: {
|
|
31625
|
+
description:
|
|
31626
|
+
'Date and time at which Seam created the warning.',
|
|
31627
|
+
format: 'date-time',
|
|
31628
|
+
type: 'string',
|
|
31629
|
+
},
|
|
31630
|
+
message: {
|
|
31631
|
+
description:
|
|
31632
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31633
|
+
type: 'string',
|
|
31634
|
+
},
|
|
31635
|
+
warning_code: {
|
|
31636
|
+
description:
|
|
31637
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31638
|
+
enum: ['partial_backup_access_code_pool'],
|
|
31639
|
+
type: 'string',
|
|
31640
|
+
},
|
|
31641
|
+
},
|
|
31642
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31643
|
+
type: 'object',
|
|
31644
|
+
'x-variant-group-key': 'access_codes',
|
|
31645
|
+
},
|
|
31646
|
+
{
|
|
31647
|
+
description:
|
|
31648
|
+
'Indicates that there are too many backup codes.',
|
|
31649
|
+
properties: {
|
|
31650
|
+
created_at: {
|
|
31651
|
+
description:
|
|
31652
|
+
'Date and time at which Seam created the warning.',
|
|
31653
|
+
format: 'date-time',
|
|
31654
|
+
type: 'string',
|
|
31655
|
+
},
|
|
31656
|
+
message: {
|
|
31657
|
+
description:
|
|
31658
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31659
|
+
type: 'string',
|
|
31660
|
+
},
|
|
31661
|
+
warning_code: {
|
|
31662
|
+
description:
|
|
31663
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31664
|
+
enum: ['many_active_backup_codes'],
|
|
31665
|
+
type: 'string',
|
|
31666
|
+
},
|
|
31667
|
+
},
|
|
31668
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31669
|
+
type: 'object',
|
|
31670
|
+
'x-variant-group-key': 'access_codes',
|
|
31671
|
+
},
|
|
31672
|
+
{
|
|
31673
|
+
description:
|
|
31674
|
+
'Indicates that a third-party integration has been detected.',
|
|
31675
|
+
properties: {
|
|
31676
|
+
created_at: {
|
|
31677
|
+
description:
|
|
31678
|
+
'Date and time at which Seam created the warning.',
|
|
31679
|
+
format: 'date-time',
|
|
31680
|
+
type: 'string',
|
|
31681
|
+
},
|
|
31682
|
+
message: {
|
|
31683
|
+
description:
|
|
31684
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31685
|
+
type: 'string',
|
|
31686
|
+
},
|
|
31687
|
+
warning_code: {
|
|
31688
|
+
description:
|
|
31689
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31690
|
+
enum: ['third_party_integration_detected'],
|
|
31691
|
+
type: 'string',
|
|
31692
|
+
},
|
|
31693
|
+
},
|
|
31694
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31695
|
+
type: 'object',
|
|
31696
|
+
},
|
|
31697
|
+
{
|
|
31698
|
+
description:
|
|
31699
|
+
'Indicates that the Remote Unlock feature is not enabled in the settings."',
|
|
31700
|
+
properties: {
|
|
31701
|
+
created_at: {
|
|
31702
|
+
description:
|
|
31703
|
+
'Date and time at which Seam created the warning.',
|
|
31704
|
+
format: 'date-time',
|
|
31705
|
+
type: 'string',
|
|
31706
|
+
},
|
|
31707
|
+
message: {
|
|
31708
|
+
description:
|
|
31709
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31710
|
+
type: 'string',
|
|
31711
|
+
},
|
|
31712
|
+
warning_code: {
|
|
31713
|
+
description:
|
|
31714
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31715
|
+
enum: ['ttlock_lock_gateway_unlocking_not_enabled'],
|
|
31716
|
+
type: 'string',
|
|
31717
|
+
},
|
|
31718
|
+
},
|
|
31719
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31720
|
+
type: 'object',
|
|
31721
|
+
'x-variant-group-key': 'locks',
|
|
31722
|
+
},
|
|
31723
|
+
{
|
|
31724
|
+
description: 'Indicates that the gateway signal is weak.',
|
|
31725
|
+
properties: {
|
|
31726
|
+
created_at: {
|
|
31727
|
+
description:
|
|
31728
|
+
'Date and time at which Seam created the warning.',
|
|
31729
|
+
format: 'date-time',
|
|
31730
|
+
type: 'string',
|
|
31731
|
+
},
|
|
31732
|
+
message: {
|
|
31733
|
+
description:
|
|
31734
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31735
|
+
type: 'string',
|
|
31736
|
+
},
|
|
31737
|
+
warning_code: {
|
|
31738
|
+
description:
|
|
31739
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31740
|
+
enum: ['ttlock_weak_gateway_signal'],
|
|
31741
|
+
type: 'string',
|
|
31742
|
+
},
|
|
31743
|
+
},
|
|
31744
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31745
|
+
type: 'object',
|
|
31746
|
+
'x-variant-group-key': 'locks',
|
|
31747
|
+
},
|
|
31748
|
+
{
|
|
31749
|
+
description:
|
|
31750
|
+
'Indicates that the device is in power saving mode and may have limited functionality.',
|
|
31751
|
+
properties: {
|
|
31752
|
+
created_at: {
|
|
31753
|
+
description:
|
|
31754
|
+
'Date and time at which Seam created the warning.',
|
|
31755
|
+
format: 'date-time',
|
|
31756
|
+
type: 'string',
|
|
31757
|
+
},
|
|
31758
|
+
message: {
|
|
31759
|
+
description:
|
|
31760
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31761
|
+
type: 'string',
|
|
31762
|
+
},
|
|
31763
|
+
warning_code: {
|
|
31764
|
+
description:
|
|
31765
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31766
|
+
enum: ['power_saving_mode'],
|
|
31767
|
+
type: 'string',
|
|
31768
|
+
},
|
|
31769
|
+
},
|
|
31770
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31771
|
+
type: 'object',
|
|
31772
|
+
'x-variant-group-key': 'locks',
|
|
31773
|
+
},
|
|
31774
|
+
{
|
|
31775
|
+
description:
|
|
31776
|
+
'Indicates that the temperature threshold has been exceeded.',
|
|
31777
|
+
properties: {
|
|
31778
|
+
created_at: {
|
|
31779
|
+
description:
|
|
31780
|
+
'Date and time at which Seam created the warning.',
|
|
31781
|
+
format: 'date-time',
|
|
31782
|
+
type: 'string',
|
|
31783
|
+
},
|
|
31784
|
+
message: {
|
|
31785
|
+
description:
|
|
31786
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31787
|
+
type: 'string',
|
|
31788
|
+
},
|
|
31789
|
+
warning_code: {
|
|
31790
|
+
description:
|
|
31791
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31792
|
+
enum: ['temperature_threshold_exceeded'],
|
|
31793
|
+
type: 'string',
|
|
31794
|
+
},
|
|
31795
|
+
},
|
|
31796
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31797
|
+
type: 'object',
|
|
31798
|
+
'x-variant-group-key': 'thermostats',
|
|
31799
|
+
},
|
|
31800
|
+
{
|
|
31801
|
+
description:
|
|
31802
|
+
'Indicates that the device appears to be unresponsive.',
|
|
31803
|
+
properties: {
|
|
31804
|
+
created_at: {
|
|
31805
|
+
description:
|
|
31806
|
+
'Date and time at which Seam created the warning.',
|
|
31807
|
+
format: 'date-time',
|
|
31808
|
+
type: 'string',
|
|
31809
|
+
},
|
|
31810
|
+
message: {
|
|
31811
|
+
description:
|
|
31812
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31813
|
+
type: 'string',
|
|
31814
|
+
},
|
|
31815
|
+
warning_code: {
|
|
31816
|
+
description:
|
|
31817
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31818
|
+
enum: ['device_communication_degraded'],
|
|
31819
|
+
type: 'string',
|
|
31820
|
+
},
|
|
31821
|
+
},
|
|
31822
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31823
|
+
type: 'object',
|
|
31824
|
+
},
|
|
31825
|
+
{
|
|
31826
|
+
description:
|
|
31827
|
+
'Indicates that a scheduled maintenance window has been detected.',
|
|
31828
|
+
properties: {
|
|
31829
|
+
created_at: {
|
|
31830
|
+
description:
|
|
31831
|
+
'Date and time at which Seam created the warning.',
|
|
31832
|
+
format: 'date-time',
|
|
31833
|
+
type: 'string',
|
|
31834
|
+
},
|
|
31835
|
+
message: {
|
|
31836
|
+
description:
|
|
31837
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31838
|
+
type: 'string',
|
|
31839
|
+
},
|
|
31840
|
+
warning_code: {
|
|
31841
|
+
description:
|
|
31842
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31843
|
+
enum: ['scheduled_maintenance_window'],
|
|
31844
|
+
type: 'string',
|
|
31845
|
+
},
|
|
31846
|
+
},
|
|
31847
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31848
|
+
type: 'object',
|
|
31849
|
+
},
|
|
31850
|
+
{
|
|
31851
|
+
description:
|
|
31852
|
+
'Indicates that the device has a flaky connection.',
|
|
31853
|
+
properties: {
|
|
31854
|
+
created_at: {
|
|
31855
|
+
description:
|
|
31856
|
+
'Date and time at which Seam created the warning.',
|
|
31857
|
+
format: 'date-time',
|
|
31858
|
+
type: 'string',
|
|
31859
|
+
},
|
|
31860
|
+
message: {
|
|
31861
|
+
description:
|
|
31862
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31863
|
+
type: 'string',
|
|
31864
|
+
},
|
|
31865
|
+
warning_code: {
|
|
31866
|
+
description:
|
|
31867
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31868
|
+
enum: ['device_has_flaky_connection'],
|
|
31869
|
+
type: 'string',
|
|
31870
|
+
},
|
|
31871
|
+
},
|
|
31872
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31873
|
+
type: 'object',
|
|
31874
|
+
},
|
|
31875
|
+
{
|
|
31876
|
+
description:
|
|
31877
|
+
'Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.',
|
|
31878
|
+
properties: {
|
|
31879
|
+
created_at: {
|
|
31880
|
+
description:
|
|
31881
|
+
'Date and time at which Seam created the warning.',
|
|
31882
|
+
format: 'date-time',
|
|
31883
|
+
type: 'string',
|
|
31884
|
+
},
|
|
31885
|
+
message: {
|
|
31886
|
+
description:
|
|
31887
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31888
|
+
type: 'string',
|
|
31889
|
+
},
|
|
31890
|
+
warning_code: {
|
|
31891
|
+
description:
|
|
31892
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31893
|
+
enum: ['salto_ks_office_mode'],
|
|
31894
|
+
type: 'string',
|
|
31895
|
+
},
|
|
31896
|
+
},
|
|
31897
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31898
|
+
type: 'object',
|
|
31899
|
+
'x-variant-group-key': 'access_codes',
|
|
31900
|
+
},
|
|
31901
|
+
{
|
|
31902
|
+
deprecated: true,
|
|
31903
|
+
description:
|
|
31904
|
+
'Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.',
|
|
31905
|
+
properties: {
|
|
31906
|
+
created_at: {
|
|
31907
|
+
description:
|
|
31908
|
+
'Date and time at which Seam created the warning.',
|
|
31909
|
+
format: 'date-time',
|
|
31910
|
+
type: 'string',
|
|
31911
|
+
},
|
|
31912
|
+
message: {
|
|
31913
|
+
description:
|
|
31914
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31915
|
+
type: 'string',
|
|
31916
|
+
},
|
|
31917
|
+
warning_code: {
|
|
31918
|
+
description:
|
|
31919
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31920
|
+
enum: ['salto_ks_privacy_mode'],
|
|
31921
|
+
type: 'string',
|
|
31922
|
+
},
|
|
31923
|
+
},
|
|
31924
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31925
|
+
type: 'object',
|
|
31926
|
+
'x-deprecated': 'Use `privacy_mode` instead.',
|
|
31927
|
+
'x-variant-group-key': 'access_codes',
|
|
31928
|
+
},
|
|
31929
|
+
{
|
|
31930
|
+
description:
|
|
31931
|
+
'Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled.',
|
|
31932
|
+
properties: {
|
|
31933
|
+
created_at: {
|
|
31934
|
+
description:
|
|
31935
|
+
'Date and time at which Seam created the warning.',
|
|
31936
|
+
format: 'date-time',
|
|
31937
|
+
type: 'string',
|
|
31938
|
+
},
|
|
31939
|
+
message: {
|
|
31940
|
+
description:
|
|
31941
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31942
|
+
type: 'string',
|
|
31943
|
+
},
|
|
31944
|
+
warning_code: {
|
|
31945
|
+
description:
|
|
31946
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31947
|
+
enum: ['privacy_mode'],
|
|
31948
|
+
type: 'string',
|
|
31949
|
+
},
|
|
31950
|
+
},
|
|
31951
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31952
|
+
type: 'object',
|
|
31953
|
+
'x-variant-group-key': 'access_codes',
|
|
31954
|
+
},
|
|
31955
|
+
{
|
|
31956
|
+
description:
|
|
31957
|
+
'Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.',
|
|
31958
|
+
properties: {
|
|
31959
|
+
created_at: {
|
|
31960
|
+
description:
|
|
31961
|
+
'Date and time at which Seam created the warning.',
|
|
31962
|
+
format: 'date-time',
|
|
31963
|
+
type: 'string',
|
|
31964
|
+
},
|
|
31965
|
+
message: {
|
|
31966
|
+
description:
|
|
31967
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31968
|
+
type: 'string',
|
|
31969
|
+
},
|
|
31970
|
+
warning_code: {
|
|
31971
|
+
description:
|
|
31972
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31973
|
+
enum: ['salto_ks_subscription_limit_almost_reached'],
|
|
31974
|
+
type: 'string',
|
|
31975
|
+
},
|
|
31976
|
+
},
|
|
31977
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
31978
|
+
type: 'object',
|
|
31979
|
+
'x-variant-group-key': 'locks',
|
|
30227
31980
|
},
|
|
30228
|
-
|
|
30229
|
-
description:
|
|
30230
|
-
|
|
31981
|
+
{
|
|
31982
|
+
description:
|
|
31983
|
+
'Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.',
|
|
31984
|
+
properties: {
|
|
31985
|
+
created_at: {
|
|
31986
|
+
description:
|
|
31987
|
+
'Date and time at which Seam created the warning.',
|
|
31988
|
+
format: 'date-time',
|
|
31989
|
+
type: 'string',
|
|
31990
|
+
},
|
|
31991
|
+
message: {
|
|
31992
|
+
description:
|
|
31993
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
31994
|
+
type: 'string',
|
|
31995
|
+
},
|
|
31996
|
+
warning_code: {
|
|
31997
|
+
description:
|
|
31998
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
31999
|
+
enum: ['salto_ks_lock_access_code_support_removed'],
|
|
32000
|
+
type: 'string',
|
|
32001
|
+
},
|
|
32002
|
+
},
|
|
32003
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32004
|
+
type: 'object',
|
|
32005
|
+
'x-variant-group-key': 'access_codes',
|
|
30231
32006
|
},
|
|
30232
|
-
|
|
30233
|
-
description:
|
|
30234
|
-
|
|
32007
|
+
{
|
|
32008
|
+
description:
|
|
32009
|
+
'Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.',
|
|
32010
|
+
properties: {
|
|
32011
|
+
created_at: {
|
|
32012
|
+
description:
|
|
32013
|
+
'Date and time at which Seam created the warning.',
|
|
32014
|
+
format: 'date-time',
|
|
32015
|
+
type: 'string',
|
|
32016
|
+
},
|
|
32017
|
+
message: {
|
|
32018
|
+
description:
|
|
32019
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32020
|
+
type: 'string',
|
|
32021
|
+
},
|
|
32022
|
+
warning_code: {
|
|
32023
|
+
description:
|
|
32024
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32025
|
+
enum: ['unknown_issue_with_phone'],
|
|
32026
|
+
type: 'string',
|
|
32027
|
+
},
|
|
32028
|
+
},
|
|
32029
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32030
|
+
type: 'object',
|
|
32031
|
+
'x-variant-group-key': 'phones',
|
|
30235
32032
|
},
|
|
30236
|
-
|
|
30237
|
-
|
|
30238
|
-
|
|
30239
|
-
|
|
30240
|
-
|
|
30241
|
-
|
|
30242
|
-
|
|
30243
|
-
|
|
30244
|
-
|
|
30245
|
-
|
|
30246
|
-
|
|
30247
|
-
|
|
30248
|
-
|
|
30249
|
-
|
|
30250
|
-
|
|
30251
|
-
|
|
30252
|
-
|
|
30253
|
-
|
|
30254
|
-
|
|
30255
|
-
|
|
30256
|
-
items: {
|
|
30257
|
-
properties: {
|
|
30258
|
-
endpoint_id: {
|
|
30259
|
-
description: 'ID of the associated endpoint.',
|
|
30260
|
-
type: 'string',
|
|
30261
|
-
},
|
|
30262
|
-
is_active: {
|
|
30263
|
-
description:
|
|
30264
|
-
'Indicated whether the endpoint is active.',
|
|
30265
|
-
type: 'boolean',
|
|
30266
|
-
},
|
|
30267
|
-
},
|
|
30268
|
-
type: 'object',
|
|
32033
|
+
{
|
|
32034
|
+
description:
|
|
32035
|
+
'Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.',
|
|
32036
|
+
properties: {
|
|
32037
|
+
created_at: {
|
|
32038
|
+
description:
|
|
32039
|
+
'Date and time at which Seam created the warning.',
|
|
32040
|
+
format: 'date-time',
|
|
32041
|
+
type: 'string',
|
|
32042
|
+
},
|
|
32043
|
+
message: {
|
|
32044
|
+
description:
|
|
32045
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32046
|
+
type: 'string',
|
|
32047
|
+
},
|
|
32048
|
+
warning_code: {
|
|
32049
|
+
description:
|
|
32050
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32051
|
+
enum: ['lockly_time_zone_not_configured'],
|
|
32052
|
+
type: 'string',
|
|
30269
32053
|
},
|
|
30270
|
-
type: 'array',
|
|
30271
32054
|
},
|
|
30272
|
-
|
|
30273
|
-
|
|
30274
|
-
|
|
30275
|
-
|
|
32055
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32056
|
+
type: 'object',
|
|
32057
|
+
'x-variant-group-key': 'locks',
|
|
32058
|
+
},
|
|
32059
|
+
{
|
|
32060
|
+
description:
|
|
32061
|
+
'Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.',
|
|
32062
|
+
properties: {
|
|
32063
|
+
created_at: {
|
|
32064
|
+
description:
|
|
32065
|
+
'Date and time at which Seam created the warning.',
|
|
32066
|
+
format: 'date-time',
|
|
32067
|
+
type: 'string',
|
|
32068
|
+
},
|
|
32069
|
+
message: {
|
|
32070
|
+
description:
|
|
32071
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32072
|
+
type: 'string',
|
|
32073
|
+
},
|
|
32074
|
+
warning_code: {
|
|
32075
|
+
description:
|
|
32076
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32077
|
+
enum: ['ultraloq_time_zone_unknown'],
|
|
32078
|
+
type: 'string',
|
|
32079
|
+
},
|
|
30276
32080
|
},
|
|
32081
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32082
|
+
type: 'object',
|
|
32083
|
+
'x-variant-group-key': 'locks',
|
|
30277
32084
|
},
|
|
30278
|
-
|
|
30279
|
-
|
|
30280
|
-
|
|
30281
|
-
|
|
30282
|
-
|
|
30283
|
-
|
|
30284
|
-
|
|
30285
|
-
|
|
30286
|
-
|
|
30287
|
-
|
|
32085
|
+
{
|
|
32086
|
+
description:
|
|
32087
|
+
"Indicates that Seam does not know the device's time zone. Set a time zone to enable time-bound access codes.",
|
|
32088
|
+
properties: {
|
|
32089
|
+
created_at: {
|
|
32090
|
+
description:
|
|
32091
|
+
'Date and time at which Seam created the warning.',
|
|
32092
|
+
format: 'date-time',
|
|
32093
|
+
type: 'string',
|
|
32094
|
+
},
|
|
32095
|
+
message: {
|
|
32096
|
+
description:
|
|
32097
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32098
|
+
type: 'string',
|
|
32099
|
+
},
|
|
32100
|
+
warning_code: {
|
|
32101
|
+
description:
|
|
32102
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32103
|
+
enum: ['time_zone_unknown'],
|
|
32104
|
+
type: 'string',
|
|
32105
|
+
},
|
|
30288
32106
|
},
|
|
32107
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32108
|
+
type: 'object',
|
|
32109
|
+
'x-variant-group-key': 'locks',
|
|
30289
32110
|
},
|
|
30290
|
-
|
|
30291
|
-
},
|
|
30292
|
-
},
|
|
30293
|
-
type: 'object',
|
|
30294
|
-
},
|
|
30295
|
-
warnings: {
|
|
30296
|
-
description: 'Warnings associated with the phone.',
|
|
30297
|
-
items: {
|
|
30298
|
-
properties: {
|
|
30299
|
-
created_at: {
|
|
32111
|
+
{
|
|
30300
32112
|
description:
|
|
30301
|
-
'
|
|
30302
|
-
|
|
30303
|
-
|
|
32113
|
+
"Indicates that the device's configured time zone does not match its hardware UTC offset. Time-bound access codes may activate at the wrong local time.",
|
|
32114
|
+
properties: {
|
|
32115
|
+
created_at: {
|
|
32116
|
+
description:
|
|
32117
|
+
'Date and time at which Seam created the warning.',
|
|
32118
|
+
format: 'date-time',
|
|
32119
|
+
type: 'string',
|
|
32120
|
+
},
|
|
32121
|
+
message: {
|
|
32122
|
+
description:
|
|
32123
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32124
|
+
type: 'string',
|
|
32125
|
+
},
|
|
32126
|
+
warning_code: {
|
|
32127
|
+
description:
|
|
32128
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32129
|
+
enum: ['time_zone_mismatch'],
|
|
32130
|
+
type: 'string',
|
|
32131
|
+
},
|
|
32132
|
+
},
|
|
32133
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32134
|
+
type: 'object',
|
|
32135
|
+
'x-variant-group-key': 'locks',
|
|
30304
32136
|
},
|
|
30305
|
-
|
|
30306
|
-
description:
|
|
30307
|
-
|
|
32137
|
+
{
|
|
32138
|
+
description:
|
|
32139
|
+
'Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.',
|
|
32140
|
+
properties: {
|
|
32141
|
+
created_at: {
|
|
32142
|
+
description:
|
|
32143
|
+
'Date and time at which Seam created the warning.',
|
|
32144
|
+
format: 'date-time',
|
|
32145
|
+
type: 'string',
|
|
32146
|
+
},
|
|
32147
|
+
message: {
|
|
32148
|
+
description:
|
|
32149
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32150
|
+
type: 'string',
|
|
32151
|
+
},
|
|
32152
|
+
warning_code: {
|
|
32153
|
+
description:
|
|
32154
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32155
|
+
enum: ['two_n_device_missing_timezone'],
|
|
32156
|
+
type: 'string',
|
|
32157
|
+
},
|
|
32158
|
+
},
|
|
32159
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32160
|
+
type: 'object',
|
|
32161
|
+
'x-variant-group-key': 'locks',
|
|
30308
32162
|
},
|
|
30309
|
-
|
|
30310
|
-
description:
|
|
30311
|
-
|
|
32163
|
+
{
|
|
32164
|
+
description:
|
|
32165
|
+
'Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.',
|
|
32166
|
+
properties: {
|
|
32167
|
+
created_at: {
|
|
32168
|
+
description:
|
|
32169
|
+
'Date and time at which Seam created the warning.',
|
|
32170
|
+
format: 'date-time',
|
|
32171
|
+
type: 'string',
|
|
32172
|
+
},
|
|
32173
|
+
message: {
|
|
32174
|
+
description:
|
|
32175
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32176
|
+
type: 'string',
|
|
32177
|
+
},
|
|
32178
|
+
warning_code: {
|
|
32179
|
+
description:
|
|
32180
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32181
|
+
enum: ['hub_required_for_additional_capabilities'],
|
|
32182
|
+
type: 'string',
|
|
32183
|
+
},
|
|
32184
|
+
},
|
|
32185
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32186
|
+
type: 'object',
|
|
32187
|
+
'x-variant-group-key': 'locks',
|
|
30312
32188
|
},
|
|
30313
|
-
|
|
30314
|
-
|
|
30315
|
-
|
|
32189
|
+
{
|
|
32190
|
+
description:
|
|
32191
|
+
'Indicates a provider-specific issue that may affect device functionality.',
|
|
32192
|
+
properties: {
|
|
32193
|
+
created_at: {
|
|
32194
|
+
description:
|
|
32195
|
+
'Date and time at which Seam created the warning.',
|
|
32196
|
+
format: 'date-time',
|
|
32197
|
+
type: 'string',
|
|
32198
|
+
},
|
|
32199
|
+
message: {
|
|
32200
|
+
description:
|
|
32201
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32202
|
+
type: 'string',
|
|
32203
|
+
},
|
|
32204
|
+
warning_code: {
|
|
32205
|
+
description:
|
|
32206
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32207
|
+
enum: ['provider_issue'],
|
|
32208
|
+
type: 'string',
|
|
32209
|
+
},
|
|
32210
|
+
},
|
|
32211
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32212
|
+
type: 'object',
|
|
32213
|
+
'x-variant-group-key': 'access_codes',
|
|
32214
|
+
},
|
|
32215
|
+
{
|
|
32216
|
+
description:
|
|
32217
|
+
'Indicates that the key is in a locker that does not support the access codes API.',
|
|
32218
|
+
properties: {
|
|
32219
|
+
created_at: {
|
|
32220
|
+
description:
|
|
32221
|
+
'Date and time at which Seam created the warning.',
|
|
32222
|
+
format: 'date-time',
|
|
32223
|
+
type: 'string',
|
|
32224
|
+
},
|
|
32225
|
+
message: {
|
|
32226
|
+
description:
|
|
32227
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32228
|
+
type: 'string',
|
|
32229
|
+
},
|
|
32230
|
+
warning_code: {
|
|
32231
|
+
description:
|
|
32232
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32233
|
+
enum: ['keynest_unsupported_locker'],
|
|
32234
|
+
type: 'string',
|
|
32235
|
+
},
|
|
32236
|
+
},
|
|
32237
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32238
|
+
type: 'object',
|
|
32239
|
+
'x-variant-group-key': 'locks',
|
|
32240
|
+
},
|
|
32241
|
+
{
|
|
32242
|
+
description:
|
|
32243
|
+
'Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.',
|
|
32244
|
+
properties: {
|
|
32245
|
+
created_at: {
|
|
32246
|
+
description:
|
|
32247
|
+
'Date and time at which Seam created the warning.',
|
|
32248
|
+
format: 'date-time',
|
|
32249
|
+
type: 'string',
|
|
32250
|
+
},
|
|
32251
|
+
message: {
|
|
32252
|
+
description:
|
|
32253
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32254
|
+
type: 'string',
|
|
32255
|
+
},
|
|
32256
|
+
warning_code: {
|
|
32257
|
+
description:
|
|
32258
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32259
|
+
enum: ['accessory_keypad_setup_required'],
|
|
32260
|
+
type: 'string',
|
|
32261
|
+
},
|
|
32262
|
+
},
|
|
32263
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32264
|
+
type: 'object',
|
|
32265
|
+
'x-variant-group-key': 'locks',
|
|
32266
|
+
},
|
|
32267
|
+
{
|
|
32268
|
+
description:
|
|
32269
|
+
'Indicates that the accessory keypad paired with this lock has a low or critically low battery. Replace its batteries so guests can keep entering their access codes.',
|
|
32270
|
+
properties: {
|
|
32271
|
+
created_at: {
|
|
32272
|
+
description:
|
|
32273
|
+
'Date and time at which Seam created the warning.',
|
|
32274
|
+
format: 'date-time',
|
|
32275
|
+
type: 'string',
|
|
32276
|
+
},
|
|
32277
|
+
message: {
|
|
32278
|
+
description:
|
|
32279
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32280
|
+
type: 'string',
|
|
32281
|
+
},
|
|
32282
|
+
warning_code: {
|
|
32283
|
+
description:
|
|
32284
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32285
|
+
enum: ['accessory_keypad_low_battery'],
|
|
32286
|
+
type: 'string',
|
|
32287
|
+
},
|
|
32288
|
+
},
|
|
32289
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32290
|
+
type: 'object',
|
|
32291
|
+
'x-variant-group-key': 'locks',
|
|
32292
|
+
},
|
|
32293
|
+
{
|
|
32294
|
+
description:
|
|
32295
|
+
'Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.',
|
|
32296
|
+
properties: {
|
|
32297
|
+
created_at: {
|
|
32298
|
+
description:
|
|
32299
|
+
'Date and time at which Seam created the warning.',
|
|
32300
|
+
format: 'date-time',
|
|
32301
|
+
type: 'string',
|
|
32302
|
+
},
|
|
32303
|
+
message: {
|
|
32304
|
+
description:
|
|
32305
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32306
|
+
type: 'string',
|
|
32307
|
+
},
|
|
32308
|
+
warning_code: {
|
|
32309
|
+
description:
|
|
32310
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32311
|
+
enum: ['unreliable_online_status'],
|
|
32312
|
+
type: 'string',
|
|
32313
|
+
},
|
|
32314
|
+
},
|
|
32315
|
+
required: ['message', 'created_at', 'warning_code'],
|
|
32316
|
+
type: 'object',
|
|
32317
|
+
'x-variant-group-key': 'locks',
|
|
32318
|
+
},
|
|
32319
|
+
{
|
|
32320
|
+
description:
|
|
32321
|
+
'Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.',
|
|
32322
|
+
properties: {
|
|
32323
|
+
active_access_code_count: {
|
|
32324
|
+
description:
|
|
32325
|
+
'Number of active access codes on the device when the warning was set.',
|
|
32326
|
+
type: 'integer',
|
|
32327
|
+
},
|
|
32328
|
+
created_at: {
|
|
32329
|
+
description:
|
|
32330
|
+
'Date and time at which Seam created the warning.',
|
|
32331
|
+
format: 'date-time',
|
|
32332
|
+
type: 'string',
|
|
32333
|
+
},
|
|
32334
|
+
max_active_access_code_count: {
|
|
32335
|
+
description:
|
|
32336
|
+
'Maximum number of active access codes supported by the device.',
|
|
32337
|
+
type: 'integer',
|
|
32338
|
+
},
|
|
32339
|
+
message: {
|
|
32340
|
+
description:
|
|
32341
|
+
'Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.',
|
|
32342
|
+
type: 'string',
|
|
32343
|
+
},
|
|
32344
|
+
warning_code: {
|
|
32345
|
+
description:
|
|
32346
|
+
'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
32347
|
+
enum: ['max_access_codes_reached'],
|
|
32348
|
+
type: 'string',
|
|
32349
|
+
},
|
|
32350
|
+
},
|
|
32351
|
+
required: [
|
|
32352
|
+
'message',
|
|
32353
|
+
'created_at',
|
|
32354
|
+
'warning_code',
|
|
32355
|
+
'active_access_code_count',
|
|
32356
|
+
'max_active_access_code_count',
|
|
32357
|
+
],
|
|
32358
|
+
type: 'object',
|
|
32359
|
+
'x-variant-group-key': 'access_codes',
|
|
32360
|
+
},
|
|
32361
|
+
],
|
|
30316
32362
|
},
|
|
30317
32363
|
type: 'array',
|
|
32364
|
+
'x-variant-groups': {
|
|
32365
|
+
access_codes: { name: 'Access Codes' },
|
|
32366
|
+
hardware: { name: 'Hardware' },
|
|
32367
|
+
locks: { name: 'Locks' },
|
|
32368
|
+
noise_sensors: { name: 'Noise Sensors' },
|
|
32369
|
+
phones: { name: 'Phones' },
|
|
32370
|
+
provider_metadata: { name: 'Provider Metadata' },
|
|
32371
|
+
thermostats: { name: 'Thermostats' },
|
|
32372
|
+
},
|
|
30318
32373
|
},
|
|
30319
32374
|
workspace_id: {
|
|
30320
32375
|
description: 'ID of the workspace that contains the phone.\n ',
|
|
@@ -30636,30 +32691,41 @@ const openapi: OpenAPISpec = {
|
|
|
30636
32691
|
description:
|
|
30637
32692
|
'Errors associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
30638
32693
|
items: {
|
|
30639
|
-
|
|
30640
|
-
|
|
30641
|
-
|
|
30642
|
-
|
|
30643
|
-
|
|
30644
|
-
type: 'string',
|
|
30645
|
-
},
|
|
30646
|
-
error_code: {
|
|
30647
|
-
description:
|
|
30648
|
-
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
30649
|
-
type: 'string',
|
|
30650
|
-
},
|
|
30651
|
-
message: {
|
|
32694
|
+
description:
|
|
32695
|
+
'Error associated with the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details).',
|
|
32696
|
+
discriminator: { propertyName: 'error_code' },
|
|
32697
|
+
oneOf: [
|
|
32698
|
+
{
|
|
30652
32699
|
description:
|
|
30653
|
-
'
|
|
30654
|
-
|
|
32700
|
+
'Indicates that the [entrance](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) was removed from the connected account, so Seam can no longer sync it.',
|
|
32701
|
+
properties: {
|
|
32702
|
+
created_at: {
|
|
32703
|
+
description:
|
|
32704
|
+
'Date and time at which Seam created the error.',
|
|
32705
|
+
format: 'date-time',
|
|
32706
|
+
type: 'string',
|
|
32707
|
+
},
|
|
32708
|
+
error_code: {
|
|
32709
|
+
description:
|
|
32710
|
+
'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
|
|
32711
|
+
enum: ['entrance_removed'],
|
|
32712
|
+
type: 'string',
|
|
32713
|
+
},
|
|
32714
|
+
message: {
|
|
32715
|
+
description:
|
|
32716
|
+
'Detailed description of the error. Provides insights into the issue and potentially how to rectify it.',
|
|
32717
|
+
type: 'string',
|
|
32718
|
+
},
|
|
32719
|
+
},
|
|
32720
|
+
required: [
|
|
32721
|
+
'created_at',
|
|
32722
|
+
'message',
|
|
32723
|
+
'error_code',
|
|
32724
|
+
],
|
|
32725
|
+
type: 'object',
|
|
32726
|
+
'x-resource-type': 'acs_entrance',
|
|
30655
32727
|
},
|
|
30656
|
-
},
|
|
30657
|
-
required: [
|
|
30658
|
-
'error_code',
|
|
30659
|
-
'message',
|
|
30660
|
-
'created_at',
|
|
30661
32728
|
],
|
|
30662
|
-
type: 'object',
|
|
30663
32729
|
},
|
|
30664
32730
|
type: 'array',
|
|
30665
32731
|
},
|
|
@@ -34075,7 +36141,8 @@ const openapi: OpenAPISpec = {
|
|
|
34075
36141
|
},
|
|
34076
36142
|
error_code: {
|
|
34077
36143
|
description:
|
|
34078
|
-
'Reason the access code could not be revoked
|
|
36144
|
+
'Reason the access code could not be revoked.',
|
|
36145
|
+
enum: ['offline_access_code_not_revocable'],
|
|
34079
36146
|
type: 'string',
|
|
34080
36147
|
},
|
|
34081
36148
|
message: {
|
|
@@ -36825,6 +38892,21 @@ const openapi: OpenAPISpec = {
|
|
|
36825
38892
|
'Indicates whether the thermostat supports simultaneous heating and cooling.',
|
|
36826
38893
|
type: 'boolean',
|
|
36827
38894
|
},
|
|
38895
|
+
can_mute_speaker: {
|
|
38896
|
+
description:
|
|
38897
|
+
'Indicates whether the speaker supports muting and unmuting.',
|
|
38898
|
+
type: 'boolean',
|
|
38899
|
+
},
|
|
38900
|
+
can_pause_speaker_playback: {
|
|
38901
|
+
description:
|
|
38902
|
+
'Indicates whether the speaker supports pausing and resuming playback.',
|
|
38903
|
+
type: 'boolean',
|
|
38904
|
+
},
|
|
38905
|
+
can_play_speaker_chime: {
|
|
38906
|
+
description:
|
|
38907
|
+
'Indicates whether the speaker supports playing a chime.',
|
|
38908
|
+
type: 'boolean',
|
|
38909
|
+
},
|
|
36828
38910
|
can_program_offline_access_codes: {
|
|
36829
38911
|
description:
|
|
36830
38912
|
'Indicates whether the device supports programming offline access codes.',
|
|
@@ -36865,6 +38947,11 @@ const openapi: OpenAPISpec = {
|
|
|
36865
38947
|
'Indicates whether the thermostat supports running climate programs.',
|
|
36866
38948
|
type: 'boolean',
|
|
36867
38949
|
},
|
|
38950
|
+
can_set_speaker_volume: {
|
|
38951
|
+
description:
|
|
38952
|
+
'Indicates whether the speaker supports setting its volume.',
|
|
38953
|
+
type: 'boolean',
|
|
38954
|
+
},
|
|
36868
38955
|
can_simulate_connection: {
|
|
36869
38956
|
description:
|
|
36870
38957
|
'Indicates whether the device supports simulating connection in a sandbox.',
|
|
@@ -37029,6 +39116,11 @@ const openapi: OpenAPISpec = {
|
|
|
37029
39116
|
],
|
|
37030
39117
|
type: 'string',
|
|
37031
39118
|
},
|
|
39119
|
+
{
|
|
39120
|
+
description: 'Device type for speakers.',
|
|
39121
|
+
enum: ['sonos_speaker'],
|
|
39122
|
+
type: 'string',
|
|
39123
|
+
},
|
|
37032
39124
|
],
|
|
37033
39125
|
},
|
|
37034
39126
|
display_name: {
|
|
@@ -47795,6 +49887,7 @@ const openapi: OpenAPISpec = {
|
|
|
47795
49887
|
'noise_sensor',
|
|
47796
49888
|
'access_control',
|
|
47797
49889
|
'camera',
|
|
49890
|
+
'speaker',
|
|
47798
49891
|
],
|
|
47799
49892
|
type: 'string',
|
|
47800
49893
|
},
|
|
@@ -48576,6 +50669,7 @@ const openapi: OpenAPISpec = {
|
|
|
48576
50669
|
'noise_sensor',
|
|
48577
50670
|
'access_control',
|
|
48578
50671
|
'camera',
|
|
50672
|
+
'speaker',
|
|
48579
50673
|
],
|
|
48580
50674
|
type: 'string',
|
|
48581
50675
|
},
|
|
@@ -51564,6 +53658,11 @@ const openapi: OpenAPISpec = {
|
|
|
51564
53658
|
],
|
|
51565
53659
|
type: 'string',
|
|
51566
53660
|
},
|
|
53661
|
+
{
|
|
53662
|
+
description: 'Device type for speakers.',
|
|
53663
|
+
enum: ['sonos_speaker'],
|
|
53664
|
+
type: 'string',
|
|
53665
|
+
},
|
|
51567
53666
|
],
|
|
51568
53667
|
},
|
|
51569
53668
|
},
|
|
@@ -51649,6 +53748,11 @@ const openapi: OpenAPISpec = {
|
|
|
51649
53748
|
],
|
|
51650
53749
|
type: 'string',
|
|
51651
53750
|
},
|
|
53751
|
+
{
|
|
53752
|
+
description: 'Device type for speakers.',
|
|
53753
|
+
enum: ['sonos_speaker'],
|
|
53754
|
+
type: 'string',
|
|
53755
|
+
},
|
|
51652
53756
|
],
|
|
51653
53757
|
},
|
|
51654
53758
|
type: 'array',
|
|
@@ -51813,6 +53917,10 @@ const openapi: OpenAPISpec = {
|
|
|
51813
53917
|
'can_simulate_paid_subscription',
|
|
51814
53918
|
'can_configure_auto_lock',
|
|
51815
53919
|
'can_stream_live_video',
|
|
53920
|
+
'can_set_speaker_volume',
|
|
53921
|
+
'can_mute_speaker',
|
|
53922
|
+
'can_pause_speaker_playback',
|
|
53923
|
+
'can_play_speaker_chime',
|
|
51816
53924
|
],
|
|
51817
53925
|
type: 'string',
|
|
51818
53926
|
},
|
|
@@ -51848,6 +53956,10 @@ const openapi: OpenAPISpec = {
|
|
|
51848
53956
|
'can_simulate_paid_subscription',
|
|
51849
53957
|
'can_configure_auto_lock',
|
|
51850
53958
|
'can_stream_live_video',
|
|
53959
|
+
'can_set_speaker_volume',
|
|
53960
|
+
'can_mute_speaker',
|
|
53961
|
+
'can_pause_speaker_playback',
|
|
53962
|
+
'can_play_speaker_chime',
|
|
51851
53963
|
],
|
|
51852
53964
|
type: 'string',
|
|
51853
53965
|
},
|
|
@@ -53882,6 +55994,11 @@ const openapi: OpenAPISpec = {
|
|
|
53882
55994
|
],
|
|
53883
55995
|
type: 'string',
|
|
53884
55996
|
},
|
|
55997
|
+
{
|
|
55998
|
+
description: 'Device type for speakers.',
|
|
55999
|
+
enum: ['sonos_speaker'],
|
|
56000
|
+
type: 'string',
|
|
56001
|
+
},
|
|
53885
56002
|
],
|
|
53886
56003
|
},
|
|
53887
56004
|
},
|
|
@@ -53967,6 +56084,11 @@ const openapi: OpenAPISpec = {
|
|
|
53967
56084
|
],
|
|
53968
56085
|
type: 'string',
|
|
53969
56086
|
},
|
|
56087
|
+
{
|
|
56088
|
+
description: 'Device type for speakers.',
|
|
56089
|
+
enum: ['sonos_speaker'],
|
|
56090
|
+
type: 'string',
|
|
56091
|
+
},
|
|
53970
56092
|
],
|
|
53971
56093
|
},
|
|
53972
56094
|
type: 'array',
|
|
@@ -54097,6 +56219,10 @@ const openapi: OpenAPISpec = {
|
|
|
54097
56219
|
'can_simulate_paid_subscription',
|
|
54098
56220
|
'can_configure_auto_lock',
|
|
54099
56221
|
'can_stream_live_video',
|
|
56222
|
+
'can_set_speaker_volume',
|
|
56223
|
+
'can_mute_speaker',
|
|
56224
|
+
'can_pause_speaker_playback',
|
|
56225
|
+
'can_play_speaker_chime',
|
|
54100
56226
|
],
|
|
54101
56227
|
type: 'string',
|
|
54102
56228
|
},
|
|
@@ -54132,6 +56258,10 @@ const openapi: OpenAPISpec = {
|
|
|
54132
56258
|
'can_simulate_paid_subscription',
|
|
54133
56259
|
'can_configure_auto_lock',
|
|
54134
56260
|
'can_stream_live_video',
|
|
56261
|
+
'can_set_speaker_volume',
|
|
56262
|
+
'can_mute_speaker',
|
|
56263
|
+
'can_pause_speaker_playback',
|
|
56264
|
+
'can_play_speaker_chime',
|
|
54135
56265
|
],
|
|
54136
56266
|
type: 'string',
|
|
54137
56267
|
},
|