@seamapi/http 2.7.1 → 2.8.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/resources/connect-webview.d.ts +1 -1
- package/lib/resources/connected-account.d.ts +1 -1
- package/lib/resources/device.d.ts +1 -1
- package/lib/resources/unmanaged-device.d.ts +1 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +2 -2
- package/lib/routes/connected-accounts/connected-accounts.d.ts +2 -2
- package/lib/routes/customers/customers.d.ts +4 -4
- package/lib/routes/devices/devices.d.ts +2 -2
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +2 -2
- package/src/lib/resources/connect-webview.ts +1 -1
- package/src/lib/resources/connected-account.ts +1 -1
- package/src/lib/resources/device.ts +1 -1
- package/src/lib/resources/unmanaged-device.ts +1 -1
- package/src/lib/routes/connect-webviews/connect-webviews.ts +2 -2
- package/src/lib/routes/connected-accounts/connected-accounts.ts +2 -2
- package/src/lib/routes/customers/customers.ts +4 -4
- package/src/lib/routes/devices/devices.ts +2 -2
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +1 -1
- package/src/lib/version.ts +1 -1
|
@@ -45,7 +45,7 @@ export type ConnectWebview = {
|
|
|
45
45
|
*/
|
|
46
46
|
created_at: string;
|
|
47
47
|
/**
|
|
48
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
48
|
+
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
49
49
|
*/
|
|
50
50
|
custom_metadata: Record<string, unknown>;
|
|
51
51
|
/**
|
|
@@ -27,7 +27,7 @@ export type ConnectedAccount = {
|
|
|
27
27
|
*/
|
|
28
28
|
created_at?: string | undefined;
|
|
29
29
|
/**
|
|
30
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
30
|
+
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
31
31
|
*/
|
|
32
32
|
custom_metadata: Record<string, unknown>;
|
|
33
33
|
/**
|
|
@@ -95,7 +95,7 @@ export type Device = {
|
|
|
95
95
|
*/
|
|
96
96
|
created_at: string;
|
|
97
97
|
/**
|
|
98
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
98
|
+
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
99
99
|
*/
|
|
100
100
|
custom_metadata: Record<string, unknown>;
|
|
101
101
|
/**
|
|
@@ -95,7 +95,7 @@ export type UnmanagedDevice = {
|
|
|
95
95
|
*/
|
|
96
96
|
created_at: string;
|
|
97
97
|
/**
|
|
98
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
98
|
+
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
99
99
|
*/
|
|
100
100
|
custom_metadata: Record<string, unknown>;
|
|
101
101
|
/**
|
|
@@ -56,7 +56,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
56
56
|
*/
|
|
57
57
|
automatically_manage_new_devices?: boolean | undefined;
|
|
58
58
|
/**
|
|
59
|
-
* Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).
|
|
59
|
+
* Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
60
60
|
*/
|
|
61
61
|
custom_metadata?: Record<string, unknown> | undefined;
|
|
62
62
|
/**
|
|
@@ -123,7 +123,7 @@ export interface ConnectWebviewsGetOptions {
|
|
|
123
123
|
}
|
|
124
124
|
export type ConnectWebviewsListParameters = {
|
|
125
125
|
/**
|
|
126
|
-
* Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.
|
|
126
|
+
* Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Specify an empty string to match a key that is unset or set to an empty string.
|
|
127
127
|
*/
|
|
128
128
|
custom_metadata_has?: Record<string, unknown> | undefined;
|
|
129
129
|
/**
|
|
@@ -77,7 +77,7 @@ export interface ConnectedAccountsGetOptions {
|
|
|
77
77
|
}
|
|
78
78
|
export type ConnectedAccountsListParameters = {
|
|
79
79
|
/**
|
|
80
|
-
* Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.
|
|
80
|
+
* Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Specify an empty string to match a key that is unset or set to an empty string.
|
|
81
81
|
*/
|
|
82
82
|
custom_metadata_has?: Record<string, unknown> | undefined;
|
|
83
83
|
/**
|
|
@@ -141,7 +141,7 @@ export type ConnectedAccountsUpdateParameters = {
|
|
|
141
141
|
*/
|
|
142
142
|
connected_account_id: string;
|
|
143
143
|
/**
|
|
144
|
-
* Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).
|
|
144
|
+
* Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
145
145
|
*/
|
|
146
146
|
custom_metadata?: Record<string, unknown> | undefined;
|
|
147
147
|
/**
|
|
@@ -469,7 +469,7 @@ export type CustomersCreatePortalParameters = {
|
|
|
469
469
|
*/
|
|
470
470
|
property_listings?: Array<{
|
|
471
471
|
/**
|
|
472
|
-
* Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application.
|
|
472
|
+
* Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
473
473
|
*/
|
|
474
474
|
custom_metadata?: Record<string, unknown> | undefined;
|
|
475
475
|
/**
|
|
@@ -494,7 +494,7 @@ export type CustomersCreatePortalParameters = {
|
|
|
494
494
|
*/
|
|
495
495
|
common_area_keys?: Array<string> | undefined;
|
|
496
496
|
/**
|
|
497
|
-
* Set key:value pairs for filtering reservations by custom criteria.
|
|
497
|
+
* Set key:value pairs for filtering reservations by custom criteria. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
498
498
|
*/
|
|
499
499
|
custom_metadata?: Record<string, unknown> | undefined;
|
|
500
500
|
/**
|
|
@@ -1159,7 +1159,7 @@ export type CustomersPushDataParameters = {
|
|
|
1159
1159
|
*/
|
|
1160
1160
|
property_listings?: Array<{
|
|
1161
1161
|
/**
|
|
1162
|
-
* Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application.
|
|
1162
|
+
* Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
1163
1163
|
*/
|
|
1164
1164
|
custom_metadata?: Record<string, unknown> | undefined;
|
|
1165
1165
|
/**
|
|
@@ -1184,7 +1184,7 @@ export type CustomersPushDataParameters = {
|
|
|
1184
1184
|
*/
|
|
1185
1185
|
common_area_keys?: Array<string> | undefined;
|
|
1186
1186
|
/**
|
|
1187
|
-
* Set key:value pairs for filtering reservations by custom criteria.
|
|
1187
|
+
* Set key:value pairs for filtering reservations by custom criteria. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
1188
1188
|
*/
|
|
1189
1189
|
custom_metadata?: Record<string, unknown> | undefined;
|
|
1190
1190
|
/**
|
|
@@ -87,7 +87,7 @@ export type DevicesListParameters = {
|
|
|
87
87
|
*/
|
|
88
88
|
created_before?: string | undefined;
|
|
89
89
|
/**
|
|
90
|
-
* Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.
|
|
90
|
+
* Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Specify an empty string to match a key that is unset or set to an empty string.
|
|
91
91
|
*/
|
|
92
92
|
custom_metadata_has?: Record<string, unknown> | undefined;
|
|
93
93
|
/**
|
|
@@ -210,7 +210,7 @@ export type DevicesUpdateParameters = {
|
|
|
210
210
|
*/
|
|
211
211
|
backup_access_code_pool_enabled?: boolean | undefined;
|
|
212
212
|
/**
|
|
213
|
-
* Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata).
|
|
213
|
+
* Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
214
214
|
*/
|
|
215
215
|
custom_metadata?: Record<string, unknown> | undefined;
|
|
216
216
|
/**
|
|
@@ -117,7 +117,7 @@ export interface DevicesUnmanagedListOptions {
|
|
|
117
117
|
}
|
|
118
118
|
export type DevicesUnmanagedUpdateParameters = {
|
|
119
119
|
/**
|
|
120
|
-
* Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.
|
|
120
|
+
* Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
121
121
|
*/
|
|
122
122
|
custom_metadata?: Record<string, unknown> | undefined;
|
|
123
123
|
/**
|
package/lib/version.d.ts
CHANGED
|
@@ -1,2 +1,2 @@
|
|
|
1
|
-
declare const seamapiJavascriptHttpVersion = "2.
|
|
1
|
+
declare const seamapiJavascriptHttpVersion = "2.8.0";
|
|
2
2
|
export default seamapiJavascriptHttpVersion;
|
package/lib/version.js
CHANGED
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@seamapi/http",
|
|
3
|
-
"version": "2.
|
|
3
|
+
"version": "2.8.0",
|
|
4
4
|
"description": "JavaScript HTTP client for the Seam API written in TypeScript.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "index.js",
|
|
@@ -87,7 +87,7 @@
|
|
|
87
87
|
"@seamapi/blueprint": "^1.5.1",
|
|
88
88
|
"@seamapi/fake-seam-connect": "^2.0.4",
|
|
89
89
|
"@seamapi/smith": "^1.1.0",
|
|
90
|
-
"@seamapi/types": "1.
|
|
90
|
+
"@seamapi/types": "1.1015.0",
|
|
91
91
|
"@types/jsonwebtoken": "^9.0.6",
|
|
92
92
|
"@types/node": "^24.10.9",
|
|
93
93
|
"ava": "^8.0.1",
|
|
@@ -58,7 +58,7 @@ export type ConnectWebview = {
|
|
|
58
58
|
created_at: string
|
|
59
59
|
|
|
60
60
|
/**
|
|
61
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
61
|
+
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
62
62
|
*/
|
|
63
63
|
custom_metadata: Record<string, unknown>
|
|
64
64
|
|
|
@@ -38,7 +38,7 @@ export type ConnectedAccount = {
|
|
|
38
38
|
*/
|
|
39
39
|
created_at?: string | undefined
|
|
40
40
|
/**
|
|
41
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
41
|
+
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
42
42
|
*/
|
|
43
43
|
custom_metadata: Record<string, unknown>
|
|
44
44
|
|
|
@@ -110,7 +110,7 @@ export type Device = {
|
|
|
110
110
|
created_at: string
|
|
111
111
|
|
|
112
112
|
/**
|
|
113
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
113
|
+
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
114
114
|
*/
|
|
115
115
|
custom_metadata: Record<string, unknown>
|
|
116
116
|
|
|
@@ -110,7 +110,7 @@ export type UnmanagedDevice = {
|
|
|
110
110
|
created_at: string
|
|
111
111
|
|
|
112
112
|
/**
|
|
113
|
-
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application.
|
|
113
|
+
* Set of key:value pairs. Adding custom metadata to a resource, such as a [Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview), [connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account), or [device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device), enables you to store custom information, like customer details or internal IDs from your application. Keys set to `null` or to an empty string are omitted.
|
|
114
114
|
*/
|
|
115
115
|
custom_metadata: Record<string, unknown>
|
|
116
116
|
|
|
@@ -334,7 +334,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
334
334
|
*/
|
|
335
335
|
automatically_manage_new_devices?: boolean | undefined
|
|
336
336
|
/**
|
|
337
|
-
* Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata).
|
|
337
|
+
* Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a Connect Webview](https://docs.seam.co/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://docs.seam.co/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://docs.seam.co/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
338
338
|
*/
|
|
339
339
|
custom_metadata?: Record<string, unknown> | undefined
|
|
340
340
|
/**
|
|
@@ -422,7 +422,7 @@ export interface ConnectWebviewsGetOptions {}
|
|
|
422
422
|
|
|
423
423
|
export type ConnectWebviewsListParameters = {
|
|
424
424
|
/**
|
|
425
|
-
* Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.
|
|
425
|
+
* Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs. Specify an empty string to match a key that is unset or set to an empty string.
|
|
426
426
|
*/
|
|
427
427
|
custom_metadata_has?: Record<string, unknown> | undefined
|
|
428
428
|
/**
|
|
@@ -311,7 +311,7 @@ export interface ConnectedAccountsGetOptions {}
|
|
|
311
311
|
|
|
312
312
|
export type ConnectedAccountsListParameters = {
|
|
313
313
|
/**
|
|
314
|
-
* Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs.
|
|
314
|
+
* Custom metadata pairs by which you want to filter connected accounts. Returns connected accounts with `custom_metadata` that contains all of the provided key:value pairs. Specify an empty string to match a key that is unset or set to an empty string.
|
|
315
315
|
*/
|
|
316
316
|
custom_metadata_has?: Record<string, unknown> | undefined
|
|
317
317
|
/**
|
|
@@ -389,7 +389,7 @@ export type ConnectedAccountsUpdateParameters = {
|
|
|
389
389
|
connected_account_id: string
|
|
390
390
|
|
|
391
391
|
/**
|
|
392
|
-
* Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata).
|
|
392
|
+
* Custom metadata that you want to associate with the connected account. Entirely replaces the existing custom metadata object. If a new Connect Webview contains custom metadata and is used to reconnect a connected account, the custom metadata from the Connect Webview will entirely replace the entire custom metadata object on the connected account. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a connected account](https://docs.seam.co/core-concepts/connected-accounts/adding-custom-metadata-to-a-connected-account) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter connected accounts by the desired metadata](https://docs.seam.co/core-concepts/connected-accounts/filtering-connected-accounts-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
393
393
|
*/
|
|
394
394
|
custom_metadata?: Record<string, unknown> | undefined
|
|
395
395
|
/**
|
|
@@ -726,7 +726,7 @@ export type CustomersCreatePortalParameters = {
|
|
|
726
726
|
property_listings?:
|
|
727
727
|
| Array<{
|
|
728
728
|
/**
|
|
729
|
-
* Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application.
|
|
729
|
+
* Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
730
730
|
*/
|
|
731
731
|
custom_metadata?: Record<string, unknown> | undefined
|
|
732
732
|
/**
|
|
@@ -753,7 +753,7 @@ export type CustomersCreatePortalParameters = {
|
|
|
753
753
|
*/
|
|
754
754
|
common_area_keys?: Array<string> | undefined
|
|
755
755
|
/**
|
|
756
|
-
* Set key:value pairs for filtering reservations by custom criteria.
|
|
756
|
+
* Set key:value pairs for filtering reservations by custom criteria. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
757
757
|
*/
|
|
758
758
|
custom_metadata?: Record<string, unknown> | undefined
|
|
759
759
|
/**
|
|
@@ -1467,7 +1467,7 @@ export type CustomersPushDataParameters = {
|
|
|
1467
1467
|
property_listings?:
|
|
1468
1468
|
| Array<{
|
|
1469
1469
|
/**
|
|
1470
|
-
* Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application.
|
|
1470
|
+
* Set key:value pairs. Accepts string or Boolean values. Adding custom metadata to a property listing enables you to store custom information, like customer details or internal IDs from your application. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
1471
1471
|
*/
|
|
1472
1472
|
custom_metadata?: Record<string, unknown> | undefined
|
|
1473
1473
|
/**
|
|
@@ -1494,7 +1494,7 @@ export type CustomersPushDataParameters = {
|
|
|
1494
1494
|
*/
|
|
1495
1495
|
common_area_keys?: Array<string> | undefined
|
|
1496
1496
|
/**
|
|
1497
|
-
* Set key:value pairs for filtering reservations by custom criteria.
|
|
1497
|
+
* Set key:value pairs for filtering reservations by custom criteria. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
1498
1498
|
*/
|
|
1499
1499
|
custom_metadata?: Record<string, unknown> | undefined
|
|
1500
1500
|
/**
|
|
@@ -313,7 +313,7 @@ export type DevicesListParameters = {
|
|
|
313
313
|
*/
|
|
314
314
|
created_before?: string | undefined
|
|
315
315
|
/**
|
|
316
|
-
* Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices.
|
|
316
|
+
* Set of key:value [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) pairs for which you want to list devices. Specify an empty string to match a key that is unset or set to an empty string.
|
|
317
317
|
*/
|
|
318
318
|
custom_metadata_has?: Record<string, unknown> | undefined
|
|
319
319
|
/**
|
|
@@ -1897,7 +1897,7 @@ export type DevicesUpdateParameters = {
|
|
|
1897
1897
|
*/
|
|
1898
1898
|
backup_access_code_pool_enabled?: boolean | undefined
|
|
1899
1899
|
/**
|
|
1900
|
-
* Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata).
|
|
1900
|
+
* Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. [Adding custom metadata to a device](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) enables you to store custom information, like customer details or internal IDs from your application. Then, you can [filter devices by the desired metadata](https://docs.seam.co/core-concepts/devices/filtering-devices-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
1901
1901
|
*/
|
|
1902
1902
|
custom_metadata?: Record<string, unknown> | undefined
|
|
1903
1903
|
/**
|
|
@@ -456,7 +456,7 @@ export interface DevicesUnmanagedListOptions {}
|
|
|
456
456
|
|
|
457
457
|
export type DevicesUnmanagedUpdateParameters = {
|
|
458
458
|
/**
|
|
459
|
-
* Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs.
|
|
459
|
+
* Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs. Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
460
460
|
*/
|
|
461
461
|
custom_metadata?: Record<string, unknown> | undefined
|
|
462
462
|
/**
|
package/src/lib/version.ts
CHANGED