@seamapi/http 0.2.0 → 0.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +21 -0
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +43 -5
- package/lib/seam/connect/client.d.ts +3 -3
- package/lib/seam/connect/client.js.map +1 -1
- package/lib/seam/connect/index.d.ts +1 -0
- package/lib/seam/connect/index.js +1 -0
- package/lib/seam/connect/index.js.map +1 -1
- package/lib/seam/connect/options.d.ts +4 -2
- package/lib/seam/connect/options.js.map +1 -1
- package/package.json +4 -2
- package/src/lib/seam/connect/client.ts +3 -3
- package/src/lib/seam/connect/index.ts +1 -0
- package/src/lib/seam/connect/options.ts +3 -2
package/dist/connect.d.cts
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import {
|
|
1
|
+
import { AxiosInstance, AxiosRequestConfig } from 'axios';
|
|
2
2
|
import { AxiosRetry } from 'axios-retry';
|
|
3
3
|
import { RouteRequestBody, RouteResponse, RouteRequestParams } from '@seamapi/types/connect';
|
|
4
4
|
import { SetNonNullable } from 'type-fest';
|
|
5
5
|
|
|
6
|
-
type Client =
|
|
6
|
+
type Client = AxiosInstance;
|
|
7
7
|
interface ClientOptions {
|
|
8
8
|
axiosOptions?: AxiosRequestConfig;
|
|
9
9
|
axiosRetryOptions?: AxiosRetryConfig;
|
|
@@ -15,8 +15,10 @@ type SeamHttpOptions = SeamHttpOptionsFromEnv | SeamHttpOptionsWithClient | Seam
|
|
|
15
15
|
interface SeamHttpCommonOptions extends ClientOptions {
|
|
16
16
|
endpoint?: string;
|
|
17
17
|
}
|
|
18
|
-
|
|
19
|
-
|
|
18
|
+
interface SeamHttpFromPublishableKeyOptions extends SeamHttpCommonOptions {
|
|
19
|
+
}
|
|
20
|
+
interface SeamHttpOptionsFromEnv extends SeamHttpCommonOptions {
|
|
21
|
+
}
|
|
20
22
|
interface SeamHttpOptionsWithClient {
|
|
21
23
|
client: Client;
|
|
22
24
|
}
|
|
@@ -47,12 +49,15 @@ declare class SeamHttpAccessCodesUnmanaged {
|
|
|
47
49
|
update(body: AccessCodesUnmanagedUpdateBody): Promise<void>;
|
|
48
50
|
}
|
|
49
51
|
type AccessCodesUnmanagedConvertToManagedBody = RouteRequestBody<'/access_codes/unmanaged/convert_to_managed'>;
|
|
52
|
+
type AccessCodesUnmanagedConvertToManagedResponse = SetNonNullable<Required<RouteResponse<'/access_codes/unmanaged/convert_to_managed'>>>;
|
|
50
53
|
type AccessCodesUnmanagedDeleteBody = RouteRequestBody<'/access_codes/unmanaged/delete'>;
|
|
54
|
+
type AccessCodesUnmanagedDeleteResponse = SetNonNullable<Required<RouteResponse<'/access_codes/unmanaged/delete'>>>;
|
|
51
55
|
type AccessCodesUnmanagedGetBody = RouteRequestBody<'/access_codes/unmanaged/get'>;
|
|
52
56
|
type AccessCodesUnmanagedGetResponse = SetNonNullable<Required<RouteResponse<'/access_codes/unmanaged/get'>>>;
|
|
53
57
|
type AccessCodesUnmanagedListBody = RouteRequestBody<'/access_codes/unmanaged/list'>;
|
|
54
58
|
type AccessCodesUnmanagedListResponse = SetNonNullable<Required<RouteResponse<'/access_codes/unmanaged/list'>>>;
|
|
55
59
|
type AccessCodesUnmanagedUpdateBody = RouteRequestBody<'/access_codes/unmanaged/update'>;
|
|
60
|
+
type AccessCodesUnmanagedUpdateResponse = SetNonNullable<Required<RouteResponse<'/access_codes/unmanaged/update'>>>;
|
|
56
61
|
|
|
57
62
|
declare class SeamHttpAccessCodes {
|
|
58
63
|
client: Client;
|
|
@@ -76,6 +81,7 @@ type AccessCodesCreateResponse = SetNonNullable<Required<RouteResponse<'/access_
|
|
|
76
81
|
type AccessCodesCreateMultipleBody = RouteRequestBody<'/access_codes/create_multiple'>;
|
|
77
82
|
type AccessCodesCreateMultipleResponse = SetNonNullable<Required<RouteResponse<'/access_codes/create_multiple'>>>;
|
|
78
83
|
type AccessCodesDeleteBody = RouteRequestBody<'/access_codes/delete'>;
|
|
84
|
+
type AccessCodesDeleteResponse = SetNonNullable<Required<RouteResponse<'/access_codes/delete'>>>;
|
|
79
85
|
type AccessCodesGenerateCodeBody = RouteRequestBody<'/access_codes/generate_code'>;
|
|
80
86
|
type AccessCodesGenerateCodeResponse = SetNonNullable<Required<RouteResponse<'/access_codes/generate_code'>>>;
|
|
81
87
|
type AccessCodesGetBody = RouteRequestBody<'/access_codes/get'>;
|
|
@@ -85,6 +91,7 @@ type AccessCodesListResponse = SetNonNullable<Required<RouteResponse<'/access_co
|
|
|
85
91
|
type AccessCodesPullBackupAccessCodeBody = RouteRequestBody<'/access_codes/pull_backup_access_code'>;
|
|
86
92
|
type AccessCodesPullBackupAccessCodeResponse = SetNonNullable<Required<RouteResponse<'/access_codes/pull_backup_access_code'>>>;
|
|
87
93
|
type AccessCodesUpdateBody = RouteRequestBody<'/access_codes/update'>;
|
|
94
|
+
type AccessCodesUpdateResponse = SetNonNullable<Required<RouteResponse<'/access_codes/update'>>>;
|
|
88
95
|
|
|
89
96
|
declare class SeamHttpAcsAccessGroups {
|
|
90
97
|
client: Client;
|
|
@@ -103,9 +110,11 @@ declare class SeamHttpAcsAccessGroups {
|
|
|
103
110
|
update(body: AcsAccessGroupsUpdateBody): Promise<void>;
|
|
104
111
|
}
|
|
105
112
|
type AcsAccessGroupsAddUserBody = RouteRequestBody<'/acs/access_groups/add_user'>;
|
|
113
|
+
type AcsAccessGroupsAddUserResponse = SetNonNullable<Required<RouteResponse<'/acs/access_groups/add_user'>>>;
|
|
106
114
|
type AcsAccessGroupsCreateBody = RouteRequestBody<'/acs/access_groups/create'>;
|
|
107
115
|
type AcsAccessGroupsCreateResponse = SetNonNullable<Required<RouteResponse<'/acs/access_groups/create'>>>;
|
|
108
116
|
type AcsAccessGroupsDeleteBody = RouteRequestBody<'/acs/access_groups/delete'>;
|
|
117
|
+
type AcsAccessGroupsDeleteResponse = SetNonNullable<Required<RouteResponse<'/acs/access_groups/delete'>>>;
|
|
109
118
|
type AcsAccessGroupsGetBody = RouteRequestBody<'/acs/access_groups/get'>;
|
|
110
119
|
type AcsAccessGroupsGetResponse = SetNonNullable<Required<RouteResponse<'/acs/access_groups/get'>>>;
|
|
111
120
|
type AcsAccessGroupsListBody = RouteRequestBody<'/acs/access_groups/list'>;
|
|
@@ -113,7 +122,9 @@ type AcsAccessGroupsListResponse = SetNonNullable<Required<RouteResponse<'/acs/a
|
|
|
113
122
|
type AcsAccessGroupsListUsersBody = RouteRequestBody<'/acs/access_groups/list_users'>;
|
|
114
123
|
type AcsAccessGroupsListUsersResponse = SetNonNullable<Required<RouteResponse<'/acs/access_groups/list_users'>>>;
|
|
115
124
|
type AcsAccessGroupsRemoveUserBody = RouteRequestBody<'/acs/access_groups/remove_user'>;
|
|
125
|
+
type AcsAccessGroupsRemoveUserResponse = SetNonNullable<Required<RouteResponse<'/acs/access_groups/remove_user'>>>;
|
|
116
126
|
type AcsAccessGroupsUpdateBody = RouteRequestBody<'/acs/access_groups/update'>;
|
|
127
|
+
type AcsAccessGroupsUpdateResponse = SetNonNullable<Required<RouteResponse<'/acs/access_groups/update'>>>;
|
|
117
128
|
|
|
118
129
|
declare class SeamHttpAcsCredentials {
|
|
119
130
|
client: Client;
|
|
@@ -130,6 +141,7 @@ declare class SeamHttpAcsCredentials {
|
|
|
130
141
|
type AcsCredentialsCreateBody = RouteRequestBody<'/acs/credentials/create'>;
|
|
131
142
|
type AcsCredentialsCreateResponse = SetNonNullable<Required<RouteResponse<'/acs/credentials/create'>>>;
|
|
132
143
|
type AcsCredentialsDeleteBody = RouteRequestBody<'/acs/credentials/delete'>;
|
|
144
|
+
type AcsCredentialsDeleteResponse = SetNonNullable<Required<RouteResponse<'/acs/credentials/delete'>>>;
|
|
133
145
|
type AcsCredentialsGetBody = RouteRequestBody<'/acs/credentials/get'>;
|
|
134
146
|
type AcsCredentialsGetResponse = SetNonNullable<Required<RouteResponse<'/acs/credentials/get'>>>;
|
|
135
147
|
type AcsCredentialsListBody = RouteRequestBody<'/acs/credentials/list'>;
|
|
@@ -168,17 +180,23 @@ declare class SeamHttpAcsUsers {
|
|
|
168
180
|
update(body: AcsUsersUpdateBody): Promise<void>;
|
|
169
181
|
}
|
|
170
182
|
type AcsUsersAddToAccessGroupBody = RouteRequestBody<'/acs/users/add_to_access_group'>;
|
|
183
|
+
type AcsUsersAddToAccessGroupResponse = SetNonNullable<Required<RouteResponse<'/acs/users/add_to_access_group'>>>;
|
|
171
184
|
type AcsUsersCreateBody = RouteRequestBody<'/acs/users/create'>;
|
|
172
185
|
type AcsUsersCreateResponse = SetNonNullable<Required<RouteResponse<'/acs/users/create'>>>;
|
|
173
186
|
type AcsUsersDeleteBody = RouteRequestBody<'/acs/users/delete'>;
|
|
187
|
+
type AcsUsersDeleteResponse = SetNonNullable<Required<RouteResponse<'/acs/users/delete'>>>;
|
|
174
188
|
type AcsUsersGetBody = RouteRequestBody<'/acs/users/get'>;
|
|
175
189
|
type AcsUsersGetResponse = SetNonNullable<Required<RouteResponse<'/acs/users/get'>>>;
|
|
176
190
|
type AcsUsersListBody = RouteRequestBody<'/acs/users/list'>;
|
|
177
191
|
type AcsUsersListResponse = SetNonNullable<Required<RouteResponse<'/acs/users/list'>>>;
|
|
178
192
|
type AcsUsersRemoveFromAccessGroupBody = RouteRequestBody<'/acs/users/remove_from_access_group'>;
|
|
193
|
+
type AcsUsersRemoveFromAccessGroupResponse = SetNonNullable<Required<RouteResponse<'/acs/users/remove_from_access_group'>>>;
|
|
179
194
|
type AcsUsersSuspendBody = RouteRequestBody<'/acs/users/suspend'>;
|
|
195
|
+
type AcsUsersSuspendResponse = SetNonNullable<Required<RouteResponse<'/acs/users/suspend'>>>;
|
|
180
196
|
type AcsUsersUnsuspendBody = RouteRequestBody<'/acs/users/unsuspend'>;
|
|
197
|
+
type AcsUsersUnsuspendResponse = SetNonNullable<Required<RouteResponse<'/acs/users/unsuspend'>>>;
|
|
181
198
|
type AcsUsersUpdateBody = RouteRequestBody<'/acs/users/update'>;
|
|
199
|
+
type AcsUsersUpdateResponse = SetNonNullable<Required<RouteResponse<'/acs/users/update'>>>;
|
|
182
200
|
|
|
183
201
|
declare class SeamHttpAcs {
|
|
184
202
|
client: Client;
|
|
@@ -225,6 +243,7 @@ declare class SeamHttpClientSessions {
|
|
|
225
243
|
type ClientSessionsCreateBody = RouteRequestBody<'/client_sessions/create'>;
|
|
226
244
|
type ClientSessionsCreateResponse = SetNonNullable<Required<RouteResponse<'/client_sessions/create'>>>;
|
|
227
245
|
type ClientSessionsDeleteBody = RouteRequestBody<'/client_sessions/delete'>;
|
|
246
|
+
type ClientSessionsDeleteResponse = SetNonNullable<Required<RouteResponse<'/client_sessions/delete'>>>;
|
|
228
247
|
type ClientSessionsGetBody = RouteRequestBody<'/client_sessions/get'>;
|
|
229
248
|
type ClientSessionsGetResponse = SetNonNullable<Required<RouteResponse<'/client_sessions/get'>>>;
|
|
230
249
|
type ClientSessionsGetOrCreateBody = RouteRequestBody<'/client_sessions/get_or_create'>;
|
|
@@ -250,11 +269,13 @@ declare class SeamHttpConnectWebviews {
|
|
|
250
269
|
type ConnectWebviewsCreateBody = RouteRequestBody<'/connect_webviews/create'>;
|
|
251
270
|
type ConnectWebviewsCreateResponse = SetNonNullable<Required<RouteResponse<'/connect_webviews/create'>>>;
|
|
252
271
|
type ConnectWebviewsDeleteBody = RouteRequestBody<'/connect_webviews/delete'>;
|
|
272
|
+
type ConnectWebviewsDeleteResponse = SetNonNullable<Required<RouteResponse<'/connect_webviews/delete'>>>;
|
|
253
273
|
type ConnectWebviewsGetBody = RouteRequestBody<'/connect_webviews/get'>;
|
|
254
274
|
type ConnectWebviewsGetResponse = SetNonNullable<Required<RouteResponse<'/connect_webviews/get'>>>;
|
|
255
275
|
type ConnectWebviewsListBody = RouteRequestBody<'/connect_webviews/list'>;
|
|
256
276
|
type ConnectWebviewsListResponse = SetNonNullable<Required<RouteResponse<'/connect_webviews/list'>>>;
|
|
257
277
|
type ConnectWebviewsViewParams = RouteRequestParams<'/connect_webviews/view'>;
|
|
278
|
+
type ConnectWebviewsViewResponse = SetNonNullable<Required<RouteResponse<'/connect_webviews/view'>>>;
|
|
258
279
|
|
|
259
280
|
declare class SeamHttpConnectedAccounts {
|
|
260
281
|
client: Client;
|
|
@@ -268,6 +289,7 @@ declare class SeamHttpConnectedAccounts {
|
|
|
268
289
|
list(params?: ConnectedAccountsListParams): Promise<ConnectedAccountsListResponse['connected_accounts']>;
|
|
269
290
|
}
|
|
270
291
|
type ConnectedAccountsDeleteBody = RouteRequestBody<'/connected_accounts/delete'>;
|
|
292
|
+
type ConnectedAccountsDeleteResponse = SetNonNullable<Required<RouteResponse<'/connected_accounts/delete'>>>;
|
|
271
293
|
type ConnectedAccountsGetBody = RouteRequestBody<'/connected_accounts/get'>;
|
|
272
294
|
type ConnectedAccountsGetResponse = SetNonNullable<Required<RouteResponse<'/connected_accounts/get'>>>;
|
|
273
295
|
type ConnectedAccountsListParams = RouteRequestParams<'/connected_accounts/list'>;
|
|
@@ -289,6 +311,7 @@ type DevicesUnmanagedGetResponse = SetNonNullable<Required<RouteResponse<'/devic
|
|
|
289
311
|
type DevicesUnmanagedListBody = RouteRequestBody<'/devices/unmanaged/list'>;
|
|
290
312
|
type DevicesUnmanagedListResponse = SetNonNullable<Required<RouteResponse<'/devices/unmanaged/list'>>>;
|
|
291
313
|
type DevicesUnmanagedUpdateBody = RouteRequestBody<'/devices/unmanaged/update'>;
|
|
314
|
+
type DevicesUnmanagedUpdateResponse = SetNonNullable<Required<RouteResponse<'/devices/unmanaged/update'>>>;
|
|
292
315
|
|
|
293
316
|
declare class SeamHttpDevices {
|
|
294
317
|
client: Client;
|
|
@@ -305,6 +328,7 @@ declare class SeamHttpDevices {
|
|
|
305
328
|
update(body: DevicesUpdateBody): Promise<void>;
|
|
306
329
|
}
|
|
307
330
|
type DevicesDeleteBody = RouteRequestBody<'/devices/delete'>;
|
|
331
|
+
type DevicesDeleteResponse = SetNonNullable<Required<RouteResponse<'/devices/delete'>>>;
|
|
308
332
|
type DevicesGetBody = RouteRequestBody<'/devices/get'>;
|
|
309
333
|
type DevicesGetResponse = SetNonNullable<Required<RouteResponse<'/devices/get'>>>;
|
|
310
334
|
type DevicesListBody = RouteRequestBody<'/devices/list'>;
|
|
@@ -312,6 +336,7 @@ type DevicesListResponse = SetNonNullable<Required<RouteResponse<'/devices/list'
|
|
|
312
336
|
type DevicesListDeviceProvidersBody = RouteRequestBody<'/devices/list_device_providers'>;
|
|
313
337
|
type DevicesListDeviceProvidersResponse = SetNonNullable<Required<RouteResponse<'/devices/list_device_providers'>>>;
|
|
314
338
|
type DevicesUpdateBody = RouteRequestBody<'/devices/update'>;
|
|
339
|
+
type DevicesUpdateResponse = SetNonNullable<Required<RouteResponse<'/devices/update'>>>;
|
|
315
340
|
|
|
316
341
|
declare class SeamHttpEvents {
|
|
317
342
|
client: Client;
|
|
@@ -363,12 +388,15 @@ declare class SeamHttpNoiseSensorsNoiseThresholds {
|
|
|
363
388
|
update(body: NoiseSensorsNoiseThresholdsUpdateBody): Promise<void>;
|
|
364
389
|
}
|
|
365
390
|
type NoiseSensorsNoiseThresholdsCreateBody = RouteRequestBody<'/noise_sensors/noise_thresholds/create'>;
|
|
391
|
+
type NoiseSensorsNoiseThresholdsCreateResponse = SetNonNullable<Required<RouteResponse<'/noise_sensors/noise_thresholds/create'>>>;
|
|
366
392
|
type NoiseSensorsNoiseThresholdsDeleteBody = RouteRequestBody<'/noise_sensors/noise_thresholds/delete'>;
|
|
393
|
+
type NoiseSensorsNoiseThresholdsDeleteResponse = SetNonNullable<Required<RouteResponse<'/noise_sensors/noise_thresholds/delete'>>>;
|
|
367
394
|
type NoiseSensorsNoiseThresholdsGetBody = RouteRequestBody<'/noise_sensors/noise_thresholds/get'>;
|
|
368
395
|
type NoiseSensorsNoiseThresholdsGetResponse = SetNonNullable<Required<RouteResponse<'/noise_sensors/noise_thresholds/get'>>>;
|
|
369
396
|
type NoiseSensorsNoiseThresholdsListBody = RouteRequestBody<'/noise_sensors/noise_thresholds/list'>;
|
|
370
397
|
type NoiseSensorsNoiseThresholdsListResponse = SetNonNullable<Required<RouteResponse<'/noise_sensors/noise_thresholds/list'>>>;
|
|
371
398
|
type NoiseSensorsNoiseThresholdsUpdateBody = RouteRequestBody<'/noise_sensors/noise_thresholds/update'>;
|
|
399
|
+
type NoiseSensorsNoiseThresholdsUpdateResponse = SetNonNullable<Required<RouteResponse<'/noise_sensors/noise_thresholds/update'>>>;
|
|
372
400
|
|
|
373
401
|
declare class SeamHttpNoiseSensors {
|
|
374
402
|
client: Client;
|
|
@@ -396,11 +424,13 @@ declare class SeamHttpThermostatsClimateSettingSchedules {
|
|
|
396
424
|
type ThermostatsClimateSettingSchedulesCreateBody = RouteRequestBody<'/thermostats/climate_setting_schedules/create'>;
|
|
397
425
|
type ThermostatsClimateSettingSchedulesCreateResponse = SetNonNullable<Required<RouteResponse<'/thermostats/climate_setting_schedules/create'>>>;
|
|
398
426
|
type ThermostatsClimateSettingSchedulesDeleteBody = RouteRequestBody<'/thermostats/climate_setting_schedules/delete'>;
|
|
427
|
+
type ThermostatsClimateSettingSchedulesDeleteResponse = SetNonNullable<Required<RouteResponse<'/thermostats/climate_setting_schedules/delete'>>>;
|
|
399
428
|
type ThermostatsClimateSettingSchedulesGetBody = RouteRequestBody<'/thermostats/climate_setting_schedules/get'>;
|
|
400
429
|
type ThermostatsClimateSettingSchedulesGetResponse = SetNonNullable<Required<RouteResponse<'/thermostats/climate_setting_schedules/get'>>>;
|
|
401
430
|
type ThermostatsClimateSettingSchedulesListBody = RouteRequestBody<'/thermostats/climate_setting_schedules/list'>;
|
|
402
431
|
type ThermostatsClimateSettingSchedulesListResponse = SetNonNullable<Required<RouteResponse<'/thermostats/climate_setting_schedules/list'>>>;
|
|
403
432
|
type ThermostatsClimateSettingSchedulesUpdateBody = RouteRequestBody<'/thermostats/climate_setting_schedules/update'>;
|
|
433
|
+
type ThermostatsClimateSettingSchedulesUpdateResponse = SetNonNullable<Required<RouteResponse<'/thermostats/climate_setting_schedules/update'>>>;
|
|
404
434
|
|
|
405
435
|
declare class SeamHttpThermostats {
|
|
406
436
|
client: Client;
|
|
@@ -420,15 +450,21 @@ declare class SeamHttpThermostats {
|
|
|
420
450
|
update(body: ThermostatsUpdateBody): Promise<void>;
|
|
421
451
|
}
|
|
422
452
|
type ThermostatsCoolBody = RouteRequestBody<'/thermostats/cool'>;
|
|
453
|
+
type ThermostatsCoolResponse = SetNonNullable<Required<RouteResponse<'/thermostats/cool'>>>;
|
|
423
454
|
type ThermostatsGetBody = RouteRequestBody<'/thermostats/get'>;
|
|
424
455
|
type ThermostatsGetResponse = SetNonNullable<Required<RouteResponse<'/thermostats/get'>>>;
|
|
425
456
|
type ThermostatsHeatBody = RouteRequestBody<'/thermostats/heat'>;
|
|
457
|
+
type ThermostatsHeatResponse = SetNonNullable<Required<RouteResponse<'/thermostats/heat'>>>;
|
|
426
458
|
type ThermostatsHeatCoolBody = RouteRequestBody<'/thermostats/heat_cool'>;
|
|
459
|
+
type ThermostatsHeatCoolResponse = SetNonNullable<Required<RouteResponse<'/thermostats/heat_cool'>>>;
|
|
427
460
|
type ThermostatsListBody = RouteRequestBody<'/thermostats/list'>;
|
|
428
461
|
type ThermostatsListResponse = SetNonNullable<Required<RouteResponse<'/thermostats/list'>>>;
|
|
429
462
|
type ThermostatsOffBody = RouteRequestBody<'/thermostats/off'>;
|
|
463
|
+
type ThermostatsOffResponse = SetNonNullable<Required<RouteResponse<'/thermostats/off'>>>;
|
|
430
464
|
type ThermostatsSetFanModeBody = RouteRequestBody<'/thermostats/set_fan_mode'>;
|
|
465
|
+
type ThermostatsSetFanModeResponse = SetNonNullable<Required<RouteResponse<'/thermostats/set_fan_mode'>>>;
|
|
431
466
|
type ThermostatsUpdateBody = RouteRequestBody<'/thermostats/update'>;
|
|
467
|
+
type ThermostatsUpdateResponse = SetNonNullable<Required<RouteResponse<'/thermostats/update'>>>;
|
|
432
468
|
|
|
433
469
|
declare class SeamHttpWebhooks {
|
|
434
470
|
client: Client;
|
|
@@ -445,6 +481,7 @@ declare class SeamHttpWebhooks {
|
|
|
445
481
|
type WebhooksCreateBody = RouteRequestBody<'/webhooks/create'>;
|
|
446
482
|
type WebhooksCreateResponse = SetNonNullable<Required<RouteResponse<'/webhooks/create'>>>;
|
|
447
483
|
type WebhooksDeleteBody = RouteRequestBody<'/webhooks/delete'>;
|
|
484
|
+
type WebhooksDeleteResponse = SetNonNullable<Required<RouteResponse<'/webhooks/delete'>>>;
|
|
448
485
|
type WebhooksGetBody = RouteRequestBody<'/webhooks/get'>;
|
|
449
486
|
type WebhooksGetResponse = SetNonNullable<Required<RouteResponse<'/webhooks/get'>>>;
|
|
450
487
|
type WebhooksListParams = RouteRequestParams<'/webhooks/list'>;
|
|
@@ -466,6 +503,7 @@ type WorkspacesGetResponse = SetNonNullable<Required<RouteResponse<'/workspaces/
|
|
|
466
503
|
type WorkspacesListParams = RouteRequestParams<'/workspaces/list'>;
|
|
467
504
|
type WorkspacesListResponse = SetNonNullable<Required<RouteResponse<'/workspaces/list'>>>;
|
|
468
505
|
type WorkspacesResetSandboxBody = RouteRequestBody<'/workspaces/reset_sandbox'>;
|
|
506
|
+
type WorkspacesResetSandboxResponse = SetNonNullable<Required<RouteResponse<'/workspaces/reset_sandbox'>>>;
|
|
469
507
|
|
|
470
508
|
declare class SeamHttp {
|
|
471
509
|
client: Client;
|
|
@@ -489,4 +527,4 @@ declare class SeamHttp {
|
|
|
489
527
|
get workspaces(): SeamHttpWorkspaces;
|
|
490
528
|
}
|
|
491
529
|
|
|
492
|
-
export { SeamHttp, SeamHttpFromPublishableKeyOptions, SeamHttpInvalidOptionsError, SeamHttpOptions, SeamHttpOptionsFromEnv, SeamHttpOptionsWithApiKey, SeamHttpOptionsWithClient, SeamHttpOptionsWithClientSessionToken, isSeamHttpOptionsWithApiKey, isSeamHttpOptionsWithClient, isSeamHttpOptionsWithClientSessionToken };
|
|
530
|
+
export { AccessCodesCreateBody, AccessCodesCreateMultipleBody, AccessCodesCreateMultipleResponse, AccessCodesCreateResponse, AccessCodesDeleteBody, AccessCodesDeleteResponse, AccessCodesGenerateCodeBody, AccessCodesGenerateCodeResponse, AccessCodesGetBody, AccessCodesGetResponse, AccessCodesListBody, AccessCodesListResponse, AccessCodesPullBackupAccessCodeBody, AccessCodesPullBackupAccessCodeResponse, AccessCodesUnmanagedConvertToManagedBody, AccessCodesUnmanagedConvertToManagedResponse, AccessCodesUnmanagedDeleteBody, AccessCodesUnmanagedDeleteResponse, AccessCodesUnmanagedGetBody, AccessCodesUnmanagedGetResponse, AccessCodesUnmanagedListBody, AccessCodesUnmanagedListResponse, AccessCodesUnmanagedUpdateBody, AccessCodesUnmanagedUpdateResponse, AccessCodesUpdateBody, AccessCodesUpdateResponse, AcsAccessGroupsAddUserBody, AcsAccessGroupsAddUserResponse, AcsAccessGroupsCreateBody, AcsAccessGroupsCreateResponse, AcsAccessGroupsDeleteBody, AcsAccessGroupsDeleteResponse, AcsAccessGroupsGetBody, AcsAccessGroupsGetResponse, AcsAccessGroupsListBody, AcsAccessGroupsListResponse, AcsAccessGroupsListUsersBody, AcsAccessGroupsListUsersResponse, AcsAccessGroupsRemoveUserBody, AcsAccessGroupsRemoveUserResponse, AcsAccessGroupsUpdateBody, AcsAccessGroupsUpdateResponse, AcsCredentialsCreateBody, AcsCredentialsCreateResponse, AcsCredentialsDeleteBody, AcsCredentialsDeleteResponse, AcsCredentialsGetBody, AcsCredentialsGetResponse, AcsCredentialsListBody, AcsCredentialsListResponse, AcsSystemsGetBody, AcsSystemsGetResponse, AcsSystemsListBody, AcsSystemsListResponse, AcsUsersAddToAccessGroupBody, AcsUsersAddToAccessGroupResponse, AcsUsersCreateBody, AcsUsersCreateResponse, AcsUsersDeleteBody, AcsUsersDeleteResponse, AcsUsersGetBody, AcsUsersGetResponse, AcsUsersListBody, AcsUsersListResponse, AcsUsersRemoveFromAccessGroupBody, AcsUsersRemoveFromAccessGroupResponse, AcsUsersSuspendBody, AcsUsersSuspendResponse, AcsUsersUnsuspendBody, AcsUsersUnsuspendResponse, AcsUsersUpdateBody, AcsUsersUpdateResponse, ActionAttemptsGetBody, ActionAttemptsGetResponse, ActionAttemptsListBody, ActionAttemptsListResponse, ClientSessionsCreateBody, ClientSessionsCreateResponse, ClientSessionsDeleteBody, ClientSessionsDeleteResponse, ClientSessionsGetBody, ClientSessionsGetOrCreateBody, ClientSessionsGetOrCreateResponse, ClientSessionsGetResponse, ClientSessionsGrantAccessBody, ClientSessionsGrantAccessResponse, ClientSessionsListBody, ClientSessionsListResponse, ConnectWebviewsCreateBody, ConnectWebviewsCreateResponse, ConnectWebviewsDeleteBody, ConnectWebviewsDeleteResponse, ConnectWebviewsGetBody, ConnectWebviewsGetResponse, ConnectWebviewsListBody, ConnectWebviewsListResponse, ConnectWebviewsViewParams, ConnectWebviewsViewResponse, ConnectedAccountsDeleteBody, ConnectedAccountsDeleteResponse, ConnectedAccountsGetBody, ConnectedAccountsGetResponse, ConnectedAccountsListParams, ConnectedAccountsListResponse, DevicesDeleteBody, DevicesDeleteResponse, DevicesGetBody, DevicesGetResponse, DevicesListBody, DevicesListDeviceProvidersBody, DevicesListDeviceProvidersResponse, DevicesListResponse, DevicesUnmanagedGetBody, DevicesUnmanagedGetResponse, DevicesUnmanagedListBody, DevicesUnmanagedListResponse, DevicesUnmanagedUpdateBody, DevicesUnmanagedUpdateResponse, DevicesUpdateBody, DevicesUpdateResponse, EventsGetBody, EventsGetResponse, EventsListBody, EventsListResponse, LocksGetBody, LocksGetResponse, LocksListBody, LocksListResponse, LocksLockDoorBody, LocksLockDoorResponse, LocksUnlockDoorBody, LocksUnlockDoorResponse, NoiseSensorsNoiseThresholdsCreateBody, NoiseSensorsNoiseThresholdsCreateResponse, NoiseSensorsNoiseThresholdsDeleteBody, NoiseSensorsNoiseThresholdsDeleteResponse, NoiseSensorsNoiseThresholdsGetBody, NoiseSensorsNoiseThresholdsGetResponse, NoiseSensorsNoiseThresholdsListBody, NoiseSensorsNoiseThresholdsListResponse, NoiseSensorsNoiseThresholdsUpdateBody, NoiseSensorsNoiseThresholdsUpdateResponse, SeamHttp, SeamHttpAccessCodes, SeamHttpAccessCodesUnmanaged, SeamHttpAcs, SeamHttpAcsAccessGroups, SeamHttpAcsCredentials, SeamHttpAcsSystems, SeamHttpAcsUsers, SeamHttpActionAttempts, SeamHttpClientSessions, SeamHttpConnectWebviews, SeamHttpConnectedAccounts, SeamHttpDevices, SeamHttpDevicesUnmanaged, SeamHttpEvents, SeamHttpFromPublishableKeyOptions, SeamHttpInvalidOptionsError, SeamHttpLocks, SeamHttpNoiseSensors, SeamHttpNoiseSensorsNoiseThresholds, SeamHttpOptions, SeamHttpOptionsFromEnv, SeamHttpOptionsWithApiKey, SeamHttpOptionsWithClient, SeamHttpOptionsWithClientSessionToken, SeamHttpThermostats, SeamHttpThermostatsClimateSettingSchedules, SeamHttpWebhooks, SeamHttpWorkspaces, ThermostatsClimateSettingSchedulesCreateBody, ThermostatsClimateSettingSchedulesCreateResponse, ThermostatsClimateSettingSchedulesDeleteBody, ThermostatsClimateSettingSchedulesDeleteResponse, ThermostatsClimateSettingSchedulesGetBody, ThermostatsClimateSettingSchedulesGetResponse, ThermostatsClimateSettingSchedulesListBody, ThermostatsClimateSettingSchedulesListResponse, ThermostatsClimateSettingSchedulesUpdateBody, ThermostatsClimateSettingSchedulesUpdateResponse, ThermostatsCoolBody, ThermostatsCoolResponse, ThermostatsGetBody, ThermostatsGetResponse, ThermostatsHeatBody, ThermostatsHeatCoolBody, ThermostatsHeatCoolResponse, ThermostatsHeatResponse, ThermostatsListBody, ThermostatsListResponse, ThermostatsOffBody, ThermostatsOffResponse, ThermostatsSetFanModeBody, ThermostatsSetFanModeResponse, ThermostatsUpdateBody, ThermostatsUpdateResponse, WebhooksCreateBody, WebhooksCreateResponse, WebhooksDeleteBody, WebhooksDeleteResponse, WebhooksGetBody, WebhooksGetResponse, WebhooksListParams, WebhooksListResponse, WorkspacesGetParams, WorkspacesGetResponse, WorkspacesListParams, WorkspacesListResponse, WorkspacesResetSandboxBody, WorkspacesResetSandboxResponse, isSeamHttpOptionsWithApiKey, isSeamHttpOptionsWithClient, isSeamHttpOptionsWithClientSessionToken };
|
|
@@ -1,11 +1,11 @@
|
|
|
1
|
-
import { type
|
|
1
|
+
import { type AxiosInstance, type AxiosRequestConfig } from 'axios';
|
|
2
2
|
import { type AxiosRetry } from 'axios-retry';
|
|
3
|
-
export type Client =
|
|
3
|
+
export type Client = AxiosInstance;
|
|
4
4
|
export interface ClientOptions {
|
|
5
5
|
axiosOptions?: AxiosRequestConfig;
|
|
6
6
|
axiosRetryOptions?: AxiosRetryConfig;
|
|
7
7
|
client?: Client;
|
|
8
8
|
}
|
|
9
9
|
type AxiosRetryConfig = Parameters<AxiosRetry>[1];
|
|
10
|
-
export declare const createClient: (options: ClientOptions) =>
|
|
10
|
+
export declare const createClient: (options: ClientOptions) => AxiosInstance;
|
|
11
11
|
export {};
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,
|
|
1
|
+
{"version":3,"file":"client.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAA+C,MAAM,OAAO,CAAA;AAC1E,OAAO,UAAU,EAAE,EAAmB,gBAAgB,EAAE,MAAM,aAAa,CAAA;AAE3E,OAAO,EAAE,gBAAgB,EAAE,MAAM,0BAA0B,CAAA;AAY3D,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAsB,EAAiB,EAAE;IACpE,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI;QAAE,OAAO,OAAO,CAAC,MAAM,CAAA;IAEjD,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC1B,gBAAgB;QAChB,GAAG,OAAO,CAAC,YAAY;KACxB,CAAC,CAAA;IAEF,UAAU,CAAC,MAAM,EAAE;QACjB,OAAO,EAAE,CAAC;QACV,UAAU,EAAE,gBAAgB;QAC5B,GAAG,OAAO,CAAC,iBAAiB;KAC7B,CAAC,CAAA;IAEF,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,gBAAgB,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAA;AAC5B,cAAc,oBAAoB,CAAA;AAClC,cAAc,gBAAgB,CAAA"}
|
|
@@ -3,8 +3,10 @@ export type SeamHttpOptions = SeamHttpOptionsFromEnv | SeamHttpOptionsWithClient
|
|
|
3
3
|
interface SeamHttpCommonOptions extends ClientOptions {
|
|
4
4
|
endpoint?: string;
|
|
5
5
|
}
|
|
6
|
-
export
|
|
7
|
-
|
|
6
|
+
export interface SeamHttpFromPublishableKeyOptions extends SeamHttpCommonOptions {
|
|
7
|
+
}
|
|
8
|
+
export interface SeamHttpOptionsFromEnv extends SeamHttpCommonOptions {
|
|
9
|
+
}
|
|
8
10
|
export interface SeamHttpOptionsWithClient {
|
|
9
11
|
client: Client;
|
|
10
12
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/options.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"options.js","sourceRoot":"","sources":["../../../src/lib/seam/connect/options.ts"],"names":[],"mappings":"AAqBA,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,OAAwB,EACc,EAAE;IACxC,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACxC,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAExC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,QAAQ,CAAC,CAAA;IAC/D,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE;QACnB,MAAM,IAAI,2BAA2B,CACnC,yEAAyE,IAAI,CAAC,IAAI,CAChF,IAAI,CACL,EAAE,CACJ,CAAA;KACF;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAMD,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACzC,OAAwB,EACc,EAAE;IACxC,IAAI,CAAC,CAAC,QAAQ,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACxC,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAExC,IAAI,oBAAoB,IAAI,OAAO,IAAI,OAAO,CAAC,kBAAkB,IAAI,IAAI,EAAE;QACzE,MAAM,IAAI,2BAA2B,CACnC,qEAAqE,CACtE,CAAA;KACF;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAOD,MAAM,CAAC,MAAM,uCAAuC,GAAG,CACrD,OAAwB,EAC0B,EAAE;IACpD,IAAI,CAAC,CAAC,oBAAoB,IAAI,OAAO,CAAC;QAAE,OAAO,KAAK,CAAA;IACpD,IAAI,OAAO,CAAC,kBAAkB,IAAI,IAAI;QAAE,OAAO,KAAK,CAAA;IAEpD,IAAI,QAAQ,IAAI,OAAO,IAAI,OAAO,CAAC,MAAM,IAAI,IAAI,EAAE;QACjD,MAAM,IAAI,2BAA2B,CACnC,qEAAqE,CACtE,CAAA;KACF;IAED,OAAO,IAAI,CAAA;AACb,CAAC,CAAA;AAED,MAAM,OAAO,2BAA4B,SAAQ,KAAK;IACpD,YAAY,OAAe;QACzB,KAAK,CAAC,sCAAsC,OAAO,EAAE,CAAC,CAAA;QACtD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,WAAW,CAAC,IAAI,CAAA;QACjC,KAAK,CAAC,iBAAiB,CAAC,IAAI,EAAE,IAAI,CAAC,WAAW,CAAC,CAAA;IACjD,CAAC;CACF"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seamapi/http",
|
|
3
|
-
"version": "0.2.
|
|
3
|
+
"version": "0.2.1",
|
|
4
4
|
"description": "JavaScript HTTP client for the Seam API written in TypeScript.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
@@ -52,6 +52,7 @@
|
|
|
52
52
|
"prebuild:ts": "del 'index.*' 'connect.*' 'lib'",
|
|
53
53
|
"postbuild:ts": "tsc-alias --project tsconfig.build.json",
|
|
54
54
|
"typecheck": "tsc",
|
|
55
|
+
"docs:build": "typedoc",
|
|
55
56
|
"test": "c8 ava",
|
|
56
57
|
"pretest": "tsx src/index.ts",
|
|
57
58
|
"test:update": "ava --update-snapshots",
|
|
@@ -88,7 +89,7 @@
|
|
|
88
89
|
"axios-retry": "^3.8.0"
|
|
89
90
|
},
|
|
90
91
|
"devDependencies": {
|
|
91
|
-
"@seamapi/fake-seam-connect": "^1.
|
|
92
|
+
"@seamapi/fake-seam-connect": "^1.22.0",
|
|
92
93
|
"@seamapi/types": "^1.24.0",
|
|
93
94
|
"@types/eslint": "^8.44.2",
|
|
94
95
|
"@types/node": "^18.11.18",
|
|
@@ -110,6 +111,7 @@
|
|
|
110
111
|
"tsup": "^7.2.0",
|
|
111
112
|
"tsx": "^3.12.1",
|
|
112
113
|
"type-fest": "^4.3.1",
|
|
114
|
+
"typedoc": "^0.25.2",
|
|
113
115
|
"typescript": "^5.1.0"
|
|
114
116
|
}
|
|
115
117
|
}
|
|
@@ -1,9 +1,9 @@
|
|
|
1
|
-
import axios, { type
|
|
1
|
+
import axios, { type AxiosInstance, type AxiosRequestConfig } from 'axios'
|
|
2
2
|
import axiosRetry, { type AxiosRetry, exponentialDelay } from 'axios-retry'
|
|
3
3
|
|
|
4
4
|
import { paramsSerializer } from 'lib/params-serializer.js'
|
|
5
5
|
|
|
6
|
-
export type Client =
|
|
6
|
+
export type Client = AxiosInstance
|
|
7
7
|
|
|
8
8
|
export interface ClientOptions {
|
|
9
9
|
axiosOptions?: AxiosRequestConfig
|
|
@@ -13,7 +13,7 @@ export interface ClientOptions {
|
|
|
13
13
|
|
|
14
14
|
type AxiosRetryConfig = Parameters<AxiosRetry>[1]
|
|
15
15
|
|
|
16
|
-
export const createClient = (options: ClientOptions):
|
|
16
|
+
export const createClient = (options: ClientOptions): AxiosInstance => {
|
|
17
17
|
if (options.client != null) return options.client
|
|
18
18
|
|
|
19
19
|
const client = axios.create({
|
|
@@ -10,9 +10,10 @@ interface SeamHttpCommonOptions extends ClientOptions {
|
|
|
10
10
|
endpoint?: string
|
|
11
11
|
}
|
|
12
12
|
|
|
13
|
-
export
|
|
13
|
+
export interface SeamHttpFromPublishableKeyOptions
|
|
14
|
+
extends SeamHttpCommonOptions {}
|
|
14
15
|
|
|
15
|
-
export
|
|
16
|
+
export interface SeamHttpOptionsFromEnv extends SeamHttpCommonOptions {}
|
|
16
17
|
|
|
17
18
|
export interface SeamHttpOptionsWithClient {
|
|
18
19
|
client: Client
|