@seamapi/types 1.1107.0 → 1.1108.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/customer/customer-portal.d.ts +14 -0
- package/lib/seam/connect/models/customer/customer-portal.js +5 -0
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
- package/lib/seam/connect/openapi.js +134 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +36 -0
- package/package.json +1 -1
- package/src/lib/seam/connect/models/customer/customer-portal.ts +7 -0
- package/src/lib/seam/connect/openapi.ts +142 -0
- package/src/lib/seam/connect/route-types.ts +36 -0
|
@@ -46558,6 +46558,8 @@ export type Routes = {
|
|
|
46558
46558
|
allow_climate_automation_rule_customization?: boolean;
|
|
46559
46559
|
/** Indicates whether the customer can customize the Instant Key profile for their properties. */
|
|
46560
46560
|
allow_instant_key_customization?: boolean;
|
|
46561
|
+
/** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
|
|
46562
|
+
allow_notification_customization?: boolean;
|
|
46561
46563
|
};
|
|
46562
46564
|
};
|
|
46563
46565
|
/** Whether the portal is embedded in another application. */
|
|
@@ -91486,6 +91488,36 @@ export type Routes = {
|
|
|
91486
91488
|
};
|
|
91487
91489
|
maxDuration: undefined;
|
|
91488
91490
|
};
|
|
91491
|
+
'/seam/customer/v1/customers/notifications/get': {
|
|
91492
|
+
route: '/seam/customer/v1/customers/notifications/get';
|
|
91493
|
+
method: 'GET' | 'POST';
|
|
91494
|
+
queryParams: {};
|
|
91495
|
+
jsonBody: {};
|
|
91496
|
+
commonParams: {};
|
|
91497
|
+
formData: {};
|
|
91498
|
+
jsonResponse: {
|
|
91499
|
+
notification_settings: {
|
|
91500
|
+
/** Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. `null` means the workspace or device default applies. */
|
|
91501
|
+
low_battery_alert_threshold: number | null;
|
|
91502
|
+
/** Workspace-level low-battery alert threshold that applies when the customer has not set one. `null` means the device default applies. */
|
|
91503
|
+
workspace_default_low_battery_alert_threshold: number | null;
|
|
91504
|
+
};
|
|
91505
|
+
};
|
|
91506
|
+
maxDuration: undefined;
|
|
91507
|
+
};
|
|
91508
|
+
'/seam/customer/v1/customers/notifications/update': {
|
|
91509
|
+
route: '/seam/customer/v1/customers/notifications/update';
|
|
91510
|
+
method: 'PATCH' | 'POST';
|
|
91511
|
+
queryParams: {};
|
|
91512
|
+
jsonBody: {
|
|
91513
|
+
/** Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. Pass `null` to fall back to the workspace default. */
|
|
91514
|
+
low_battery_alert_threshold?: (number | null) | undefined;
|
|
91515
|
+
};
|
|
91516
|
+
commonParams: {};
|
|
91517
|
+
formData: {};
|
|
91518
|
+
jsonResponse: {};
|
|
91519
|
+
maxDuration: undefined;
|
|
91520
|
+
};
|
|
91489
91521
|
'/seam/customer/v1/customers/open_portal': {
|
|
91490
91522
|
route: '/seam/customer/v1/customers/open_portal';
|
|
91491
91523
|
method: 'POST';
|
|
@@ -95202,6 +95234,8 @@ export type Routes = {
|
|
|
95202
95234
|
allow_climate_automation_rule_customization?: boolean;
|
|
95203
95235
|
/** Indicates whether the customer can customize the Instant Key profile for their properties. */
|
|
95204
95236
|
allow_instant_key_customization?: boolean;
|
|
95237
|
+
/** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
|
|
95238
|
+
allow_notification_customization?: boolean;
|
|
95205
95239
|
};
|
|
95206
95240
|
};
|
|
95207
95241
|
/** Whether the portal is embedded in another application. */
|
|
@@ -95353,6 +95387,8 @@ export type Routes = {
|
|
|
95353
95387
|
allow_climate_automation_rule_customization?: boolean;
|
|
95354
95388
|
/** Indicates whether the customer can customize the Instant Key profile for their properties. */
|
|
95355
95389
|
allow_instant_key_customization?: boolean;
|
|
95390
|
+
/** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
|
|
95391
|
+
allow_notification_customization?: boolean;
|
|
95356
95392
|
};
|
|
95357
95393
|
} | undefined;
|
|
95358
95394
|
/** Whether the portal is embedded in another application. */
|
package/package.json
CHANGED
|
@@ -109,6 +109,12 @@ const base_configure_feature = base_feature.extend({
|
|
|
109
109
|
.describe(
|
|
110
110
|
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
111
111
|
),
|
|
112
|
+
allow_notification_customization: z
|
|
113
|
+
.boolean()
|
|
114
|
+
.default(false)
|
|
115
|
+
.describe(
|
|
116
|
+
'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
117
|
+
),
|
|
112
118
|
})
|
|
113
119
|
|
|
114
120
|
const base_features = z.object({
|
|
@@ -263,6 +269,7 @@ export const portal_configuration = portal_configuration_base
|
|
|
263
269
|
allow_instant_key_customization: false,
|
|
264
270
|
allow_access_automation_rule_customization: false,
|
|
265
271
|
allow_climate_automation_rule_customization: false,
|
|
272
|
+
allow_notification_customization: false,
|
|
266
273
|
},
|
|
267
274
|
},
|
|
268
275
|
is_embedded: false,
|
|
@@ -50778,6 +50778,7 @@ const openapi: OpenAPISpec = {
|
|
|
50778
50778
|
allow_access_automation_rule_customization: false,
|
|
50779
50779
|
allow_climate_automation_rule_customization: false,
|
|
50780
50780
|
allow_instant_key_customization: false,
|
|
50781
|
+
allow_notification_customization: false,
|
|
50781
50782
|
exclude: false,
|
|
50782
50783
|
},
|
|
50783
50784
|
connect: { exclude: false },
|
|
@@ -50920,6 +50921,12 @@ const openapi: OpenAPISpec = {
|
|
|
50920
50921
|
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
50921
50922
|
type: 'boolean',
|
|
50922
50923
|
},
|
|
50924
|
+
allow_notification_customization: {
|
|
50925
|
+
default: false,
|
|
50926
|
+
description:
|
|
50927
|
+
'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
50928
|
+
type: 'boolean',
|
|
50929
|
+
},
|
|
50923
50930
|
exclude: {
|
|
50924
50931
|
default: false,
|
|
50925
50932
|
description:
|
|
@@ -64770,6 +64777,129 @@ const openapi: OpenAPISpec = {
|
|
|
64770
64777
|
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
64771
64778
|
},
|
|
64772
64779
|
},
|
|
64780
|
+
'/seam/customer/v1/customers/notifications/get': {
|
|
64781
|
+
get: {
|
|
64782
|
+
description:
|
|
64783
|
+
'Gets the notification settings for the authenticated customer, along with the workspace defaults they inherit when unset.',
|
|
64784
|
+
operationId: 'seamCustomerV1CustomersNotificationsGetGet',
|
|
64785
|
+
responses: {
|
|
64786
|
+
'200': {
|
|
64787
|
+
content: {
|
|
64788
|
+
'application/json': {
|
|
64789
|
+
schema: {
|
|
64790
|
+
properties: {
|
|
64791
|
+
notification_settings: {
|
|
64792
|
+
properties: {
|
|
64793
|
+
low_battery_alert_threshold: {
|
|
64794
|
+
description:
|
|
64795
|
+
"Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. `null` means the workspace or device default applies.",
|
|
64796
|
+
format: 'float',
|
|
64797
|
+
nullable: true,
|
|
64798
|
+
type: 'number',
|
|
64799
|
+
},
|
|
64800
|
+
workspace_default_low_battery_alert_threshold: {
|
|
64801
|
+
description:
|
|
64802
|
+
'Workspace-level low-battery alert threshold that applies when the customer has not set one. `null` means the device default applies.',
|
|
64803
|
+
format: 'float',
|
|
64804
|
+
nullable: true,
|
|
64805
|
+
type: 'number',
|
|
64806
|
+
},
|
|
64807
|
+
},
|
|
64808
|
+
required: [
|
|
64809
|
+
'low_battery_alert_threshold',
|
|
64810
|
+
'workspace_default_low_battery_alert_threshold',
|
|
64811
|
+
],
|
|
64812
|
+
type: 'object',
|
|
64813
|
+
},
|
|
64814
|
+
ok: { type: 'boolean' },
|
|
64815
|
+
},
|
|
64816
|
+
required: ['notification_settings', 'ok'],
|
|
64817
|
+
type: 'object',
|
|
64818
|
+
},
|
|
64819
|
+
},
|
|
64820
|
+
},
|
|
64821
|
+
description: 'OK',
|
|
64822
|
+
},
|
|
64823
|
+
'400': { description: 'Bad Request' },
|
|
64824
|
+
'401': { description: 'Unauthorized' },
|
|
64825
|
+
},
|
|
64826
|
+
security: [
|
|
64827
|
+
{ client_session_with_customer: [] },
|
|
64828
|
+
{ client_session_with_customer_ro: [] },
|
|
64829
|
+
],
|
|
64830
|
+
summary: '/seam/customer/v1/customers/notifications/get',
|
|
64831
|
+
tags: [],
|
|
64832
|
+
'x-fern-sdk-group-name': [
|
|
64833
|
+
'seam',
|
|
64834
|
+
'customer',
|
|
64835
|
+
'v1',
|
|
64836
|
+
'customers',
|
|
64837
|
+
'notifications',
|
|
64838
|
+
],
|
|
64839
|
+
'x-fern-sdk-method-name': 'get',
|
|
64840
|
+
'x-fern-sdk-return-value': 'notification_settings',
|
|
64841
|
+
'x-response-key': 'notification_settings',
|
|
64842
|
+
'x-title': 'Get Customer Notification Settings',
|
|
64843
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
64844
|
+
},
|
|
64845
|
+
},
|
|
64846
|
+
'/seam/customer/v1/customers/notifications/update': {
|
|
64847
|
+
patch: {
|
|
64848
|
+
description:
|
|
64849
|
+
'Updates the notification settings for the authenticated customer. Requires a customer portal with `features.configure.allow_notification_customization` enabled.',
|
|
64850
|
+
operationId: 'seamCustomerV1CustomersNotificationsUpdatePatch',
|
|
64851
|
+
requestBody: {
|
|
64852
|
+
content: {
|
|
64853
|
+
'application/json': {
|
|
64854
|
+
schema: {
|
|
64855
|
+
properties: {
|
|
64856
|
+
low_battery_alert_threshold: {
|
|
64857
|
+
description:
|
|
64858
|
+
"Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. Pass `null` to fall back to the workspace default.",
|
|
64859
|
+
format: 'float',
|
|
64860
|
+
maximum: 1,
|
|
64861
|
+
minimum: 0,
|
|
64862
|
+
nullable: true,
|
|
64863
|
+
type: 'number',
|
|
64864
|
+
},
|
|
64865
|
+
},
|
|
64866
|
+
type: 'object',
|
|
64867
|
+
},
|
|
64868
|
+
},
|
|
64869
|
+
},
|
|
64870
|
+
},
|
|
64871
|
+
responses: {
|
|
64872
|
+
'200': {
|
|
64873
|
+
content: {
|
|
64874
|
+
'application/json': {
|
|
64875
|
+
schema: {
|
|
64876
|
+
properties: { ok: { type: 'boolean' } },
|
|
64877
|
+
required: ['ok'],
|
|
64878
|
+
type: 'object',
|
|
64879
|
+
},
|
|
64880
|
+
},
|
|
64881
|
+
},
|
|
64882
|
+
description: 'OK',
|
|
64883
|
+
},
|
|
64884
|
+
'400': { description: 'Bad Request' },
|
|
64885
|
+
'401': { description: 'Unauthorized' },
|
|
64886
|
+
},
|
|
64887
|
+
security: [{ client_session_with_customer: [] }],
|
|
64888
|
+
summary: '/seam/customer/v1/customers/notifications/update',
|
|
64889
|
+
tags: [],
|
|
64890
|
+
'x-fern-sdk-group-name': [
|
|
64891
|
+
'seam',
|
|
64892
|
+
'customer',
|
|
64893
|
+
'v1',
|
|
64894
|
+
'customers',
|
|
64895
|
+
'notifications',
|
|
64896
|
+
],
|
|
64897
|
+
'x-fern-sdk-method-name': 'update',
|
|
64898
|
+
'x-response-key': null,
|
|
64899
|
+
'x-title': 'Update Customer Notification Settings',
|
|
64900
|
+
'x-undocumented': 'Internal endpoint for customer portals.',
|
|
64901
|
+
},
|
|
64902
|
+
},
|
|
64773
64903
|
'/seam/customer/v1/customers/open_portal': {
|
|
64774
64904
|
post: {
|
|
64775
64905
|
description:
|
|
@@ -65392,6 +65522,12 @@ const openapi: OpenAPISpec = {
|
|
|
65392
65522
|
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
65393
65523
|
type: 'boolean',
|
|
65394
65524
|
},
|
|
65525
|
+
allow_notification_customization: {
|
|
65526
|
+
default: false,
|
|
65527
|
+
description:
|
|
65528
|
+
'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
65529
|
+
type: 'boolean',
|
|
65530
|
+
},
|
|
65395
65531
|
exclude: {
|
|
65396
65532
|
default: false,
|
|
65397
65533
|
description:
|
|
@@ -65856,6 +65992,12 @@ const openapi: OpenAPISpec = {
|
|
|
65856
65992
|
'Indicates whether the customer can customize the Instant Key profile for their properties.',
|
|
65857
65993
|
type: 'boolean',
|
|
65858
65994
|
},
|
|
65995
|
+
allow_notification_customization: {
|
|
65996
|
+
default: false,
|
|
65997
|
+
description:
|
|
65998
|
+
'Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold.',
|
|
65999
|
+
type: 'boolean',
|
|
66000
|
+
},
|
|
65859
66001
|
exclude: {
|
|
65860
66002
|
default: false,
|
|
65861
66003
|
description:
|
|
@@ -54389,6 +54389,8 @@ export type Routes = {
|
|
|
54389
54389
|
allow_climate_automation_rule_customization?: boolean
|
|
54390
54390
|
/** Indicates whether the customer can customize the Instant Key profile for their properties. */
|
|
54391
54391
|
allow_instant_key_customization?: boolean
|
|
54392
|
+
/** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
|
|
54393
|
+
allow_notification_customization?: boolean
|
|
54392
54394
|
}
|
|
54393
54395
|
}
|
|
54394
54396
|
/** Whether the portal is embedded in another application. */
|
|
@@ -109330,6 +109332,36 @@ export type Routes = {
|
|
|
109330
109332
|
}
|
|
109331
109333
|
maxDuration: undefined
|
|
109332
109334
|
}
|
|
109335
|
+
'/seam/customer/v1/customers/notifications/get': {
|
|
109336
|
+
route: '/seam/customer/v1/customers/notifications/get'
|
|
109337
|
+
method: 'GET' | 'POST'
|
|
109338
|
+
queryParams: {}
|
|
109339
|
+
jsonBody: {}
|
|
109340
|
+
commonParams: {}
|
|
109341
|
+
formData: {}
|
|
109342
|
+
jsonResponse: {
|
|
109343
|
+
notification_settings: {
|
|
109344
|
+
/** Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. `null` means the workspace or device default applies. */
|
|
109345
|
+
low_battery_alert_threshold: number | null
|
|
109346
|
+
/** Workspace-level low-battery alert threshold that applies when the customer has not set one. `null` means the device default applies. */
|
|
109347
|
+
workspace_default_low_battery_alert_threshold: number | null
|
|
109348
|
+
}
|
|
109349
|
+
}
|
|
109350
|
+
maxDuration: undefined
|
|
109351
|
+
}
|
|
109352
|
+
'/seam/customer/v1/customers/notifications/update': {
|
|
109353
|
+
route: '/seam/customer/v1/customers/notifications/update'
|
|
109354
|
+
method: 'PATCH' | 'POST'
|
|
109355
|
+
queryParams: {}
|
|
109356
|
+
jsonBody: {
|
|
109357
|
+
/** Battery level, from 0 to 1, at or below which `device.low_battery` events fire for this customer's devices. Pass `null` to fall back to the workspace default. */
|
|
109358
|
+
low_battery_alert_threshold?: (number | null) | undefined
|
|
109359
|
+
}
|
|
109360
|
+
commonParams: {}
|
|
109361
|
+
formData: {}
|
|
109362
|
+
jsonResponse: {}
|
|
109363
|
+
maxDuration: undefined
|
|
109364
|
+
}
|
|
109333
109365
|
'/seam/customer/v1/customers/open_portal': {
|
|
109334
109366
|
route: '/seam/customer/v1/customers/open_portal'
|
|
109335
109367
|
method: 'POST'
|
|
@@ -113711,6 +113743,8 @@ export type Routes = {
|
|
|
113711
113743
|
allow_climate_automation_rule_customization?: boolean
|
|
113712
113744
|
/** Indicates whether the customer can customize the Instant Key profile for their properties. */
|
|
113713
113745
|
allow_instant_key_customization?: boolean
|
|
113746
|
+
/** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
|
|
113747
|
+
allow_notification_customization?: boolean
|
|
113714
113748
|
}
|
|
113715
113749
|
}
|
|
113716
113750
|
/** Whether the portal is embedded in another application. */
|
|
@@ -113922,6 +113956,8 @@ export type Routes = {
|
|
|
113922
113956
|
allow_climate_automation_rule_customization?: boolean
|
|
113923
113957
|
/** Indicates whether the customer can customize the Instant Key profile for their properties. */
|
|
113924
113958
|
allow_instant_key_customization?: boolean
|
|
113959
|
+
/** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
|
|
113960
|
+
allow_notification_customization?: boolean
|
|
113925
113961
|
}
|
|
113926
113962
|
}
|
|
113927
113963
|
| undefined
|