/
v1.ts
203 lines (169 loc) · 4.81 KB
/
v1.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
/**
* Copyright 2018 Google Inc. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/* tslint:disable:no-any written like auto generated types from protobufs */
import {ApiClientObjectMap} from '../../../common';
// See https://developers.google.com/actions/smarthome/
export type SmartHomeV1Intents =
| 'action.devices.SYNC'
| 'action.devices.QUERY'
| 'action.devices.EXECUTE'
| 'action.devices.DISCONNECT';
export type SmartHomeV1ExecuteStatus =
| 'SUCCESS'
| 'PENDING'
| 'OFFLINE'
| 'ERROR';
// See an extensive list of error codes at
// https://developers.google.com/actions/reference/smarthome/errors-exceptions
export type SmartHomeV1ExecuteErrors = string;
export interface SmartHomeV1SyncRequestInputs {
intent: SmartHomeV1Intents;
}
export interface SmartHomeV1SyncRequest {
requestId: string;
inputs: SmartHomeV1SyncRequestInputs[];
}
export interface SmartHomeV1QueryRequestDevices {
id: string;
customData?: ApiClientObjectMap<any>;
}
export interface SmartHomeV1QueryRequestPayload {
devices: SmartHomeV1QueryRequestDevices[];
}
export interface SmartHomeV1QueryRequestInputs {
intent: SmartHomeV1Intents;
payload: SmartHomeV1QueryRequestPayload;
}
export interface SmartHomeV1QueryRequest {
requestId: string;
inputs: SmartHomeV1QueryRequestInputs[];
}
export interface SmartHomeV1ExecuteRequestExecution {
command: string;
params?: ApiClientObjectMap<any>;
challenge?: {
pin?: string;
ack?: boolean;
};
}
export interface SmartHomeV1ExecuteRequestCommands {
devices: SmartHomeV1QueryRequestDevices[];
execution: SmartHomeV1ExecuteRequestExecution[];
}
export interface SmartHomeV1ExecuteRequestPayload {
commands: SmartHomeV1ExecuteRequestCommands[];
}
export interface SmartHomeV1ExecuteRequestInputs {
intent: SmartHomeV1Intents;
payload: SmartHomeV1ExecuteRequestPayload;
}
export interface SmartHomeV1ExecuteRequest {
requestId: string;
inputs: SmartHomeV1ExecuteRequestInputs[];
}
export interface SmartHomeV1DisconnectRequest {
requestId: string;
inputs: {
intent: 'action.devices.DISCONNECT';
}[];
}
export type SmartHomeV1Request =
| SmartHomeV1SyncRequest
| SmartHomeV1QueryRequest
| SmartHomeV1ExecuteRequest
| SmartHomeV1DisconnectRequest;
export interface SmartHomeV1SyncName {
defaultNames: string[];
name: string;
nicknames: string[];
}
export interface SmartHomeV1SyncDeviceInfo {
manufacturer: string;
model: string;
hwVersion: string;
swVersion: string;
}
export interface SmartHomeV1SyncOtherDeviceIds {
agentId?: string;
deviceId: string;
}
export interface SmartHomeV1SyncDevices {
id: string;
type: string;
traits: string[];
name: SmartHomeV1SyncName;
willReportState: boolean;
deviceInfo?: SmartHomeV1SyncDeviceInfo;
attributes?: ApiClientObjectMap<any>;
customData?: ApiClientObjectMap<any>;
roomHint?: string;
otherDeviceIds?: SmartHomeV1SyncOtherDeviceIds[];
}
export interface SmartHomeV1SyncPayload {
agentUserId?: string;
errorCode?: string;
debugString?: string;
devices: SmartHomeV1SyncDevices[];
}
export interface SmartHomeV1SyncResponse {
requestId: string;
payload: SmartHomeV1SyncPayload;
}
export interface SmartHomeV1QueryPayload {
devices: ApiClientObjectMap<any>;
}
export interface SmartHomeV1QueryResponse {
requestId: string;
payload: SmartHomeV1QueryPayload;
}
export interface SmartHomeV1ExecuteResponseCommands {
ids: string[];
status: SmartHomeV1ExecuteStatus;
errorCode?: SmartHomeV1ExecuteErrors;
debugString?: string;
states?: ApiClientObjectMap<any>;
challengeNeeded?: {
type: challengeType;
};
}
export type challengeType =
| 'ackNeeded'
| 'pinNeeded'
| 'challengeFailedPinNeeded';
export interface SmartHomeV1ExecutePayload {
commands: SmartHomeV1ExecuteResponseCommands[];
errorCode?: SmartHomeV1ExecuteErrors;
debugString?: string;
}
export interface SmartHomeV1ExecuteResponse {
requestId: string;
payload: SmartHomeV1ExecutePayload;
}
export interface SmartHomeV1DisconnectResponse {}
export type SmartHomeV1Response =
| SmartHomeV1SyncResponse
| SmartHomeV1QueryResponse
| SmartHomeV1ExecuteResponse
| SmartHomeV1DisconnectResponse;
export interface SmartHomeV1ReportStateRequest {
requestId: string;
agentUserId: string;
payload: {
devices: {
states: ApiClientObjectMap<any>;
};
};
}