@seamapi/http 2.11.1 → 2.12.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/README.md +13 -2
- package/lib/client.js +10 -3
- package/lib/client.js.map +1 -1
- 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/event.d.ts +122 -122
- package/lib/resources/phone.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/client.ts +13 -3
- 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/event.ts +187 -122
- package/src/lib/resources/phone.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
|
@@ -15,7 +15,7 @@ export type Phone = {
|
|
|
15
15
|
/**
|
|
16
16
|
* Optional [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
|
|
17
17
|
*/
|
|
18
|
-
custom_metadata: Record<string,
|
|
18
|
+
custom_metadata: Record<string, string | boolean>
|
|
19
19
|
|
|
20
20
|
/**
|
|
21
21
|
* ID of the phone.
|
|
@@ -112,7 +112,7 @@ export type UnmanagedDevice = {
|
|
|
112
112
|
/**
|
|
113
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
|
-
custom_metadata: Record<string,
|
|
115
|
+
custom_metadata: Record<string, string | boolean>
|
|
116
116
|
|
|
117
117
|
/**
|
|
118
118
|
* ID of the device.
|
|
@@ -336,7 +336,7 @@ export type ConnectWebviewsCreateParameters = {
|
|
|
336
336
|
/**
|
|
337
337
|
* Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [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
|
-
custom_metadata?: Record<string,
|
|
339
|
+
custom_metadata?: Record<string, string | boolean> | undefined
|
|
340
340
|
/**
|
|
341
341
|
* Alternative URL that you want to redirect the user to on an error. If you do not set this parameter, the Connect Webview falls back to the `custom_redirect_url`.
|
|
342
342
|
*/
|
|
@@ -424,7 +424,7 @@ export type ConnectWebviewsListParameters = {
|
|
|
424
424
|
/**
|
|
425
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. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.
|
|
426
426
|
*/
|
|
427
|
-
custom_metadata_has?: Record<string,
|
|
427
|
+
custom_metadata_has?: Record<string, string | boolean> | undefined
|
|
428
428
|
/**
|
|
429
429
|
* Customer key for which you want to list connect webviews.
|
|
430
430
|
*/
|
|
@@ -313,7 +313,7 @@ export type ConnectedAccountsListParameters = {
|
|
|
313
313
|
/**
|
|
314
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. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.
|
|
315
315
|
*/
|
|
316
|
-
custom_metadata_has?: Record<string,
|
|
316
|
+
custom_metadata_has?: Record<string, string | boolean> | undefined
|
|
317
317
|
/**
|
|
318
318
|
* Customer key by which you want to filter connected accounts.
|
|
319
319
|
*/
|
|
@@ -391,7 +391,7 @@ export type ConnectedAccountsUpdateParameters = {
|
|
|
391
391
|
/**
|
|
392
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, with key names up to 40 characters long that cannot contain a period (.). [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
|
-
custom_metadata?: Record<string,
|
|
394
|
+
custom_metadata?: Record<string, string | boolean> | undefined
|
|
395
395
|
/**
|
|
396
396
|
* The customer key to associate with this connected account. If provided, the connected account and all resources under the connected account will be moved to this customer. May only be provided if the connected account is not already associated with a customer.
|
|
397
397
|
*/
|
|
@@ -728,7 +728,7 @@ export type CustomersCreatePortalParameters = {
|
|
|
728
728
|
/**
|
|
729
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
|
-
custom_metadata?: Record<string,
|
|
731
|
+
custom_metadata?: Record<string, string | boolean> | undefined
|
|
732
732
|
/**
|
|
733
733
|
* Your display name for this location resource.
|
|
734
734
|
*/
|
|
@@ -755,7 +755,7 @@ export type CustomersCreatePortalParameters = {
|
|
|
755
755
|
/**
|
|
756
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
|
-
custom_metadata?: Record<string,
|
|
758
|
+
custom_metadata?: Record<string, string | boolean> | undefined
|
|
759
759
|
/**
|
|
760
760
|
* Ending date and time for the access grant.
|
|
761
761
|
*/
|
|
@@ -1469,7 +1469,7 @@ export type CustomersPushDataParameters = {
|
|
|
1469
1469
|
/**
|
|
1470
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
|
-
custom_metadata?: Record<string,
|
|
1472
|
+
custom_metadata?: Record<string, string | boolean> | undefined
|
|
1473
1473
|
/**
|
|
1474
1474
|
* Your display name for this location resource.
|
|
1475
1475
|
*/
|
|
@@ -1496,7 +1496,7 @@ export type CustomersPushDataParameters = {
|
|
|
1496
1496
|
/**
|
|
1497
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
|
-
custom_metadata?: Record<string,
|
|
1499
|
+
custom_metadata?: Record<string, string | boolean> | undefined
|
|
1500
1500
|
/**
|
|
1501
1501
|
* Ending date and time for the access grant.
|
|
1502
1502
|
*/
|
|
@@ -315,7 +315,7 @@ export type DevicesListParameters = {
|
|
|
315
315
|
/**
|
|
316
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. Key names cannot contain a period (.). Specify `null` to match a key that is unset. A key given an empty string is omitted from the filter.
|
|
317
317
|
*/
|
|
318
|
-
custom_metadata_has?: Record<string,
|
|
318
|
+
custom_metadata_has?: Record<string, string | boolean> | undefined
|
|
319
319
|
/**
|
|
320
320
|
* Customer key for which you want to list devices.
|
|
321
321
|
*/
|
|
@@ -1899,7 +1899,7 @@ export type DevicesUpdateParameters = {
|
|
|
1899
1899
|
/**
|
|
1900
1900
|
* Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [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
|
-
custom_metadata?: Record<string,
|
|
1902
|
+
custom_metadata?: Record<string, string | boolean> | undefined
|
|
1903
1903
|
/**
|
|
1904
1904
|
* ID of the device that you want to update.
|
|
1905
1905
|
*/
|
|
@@ -458,7 +458,7 @@ export type DevicesUnmanagedUpdateParameters = {
|
|
|
458
458
|
/**
|
|
459
459
|
* Custom metadata that you want to associate with the device. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). Set a key to `null` or to an empty string to remove that key from the custom metadata.
|
|
460
460
|
*/
|
|
461
|
-
custom_metadata?: Record<string,
|
|
461
|
+
custom_metadata?: Record<string, string | boolean> | undefined
|
|
462
462
|
/**
|
|
463
463
|
* ID of the unmanaged device that you want to update.
|
|
464
464
|
*/
|
package/src/lib/version.ts
CHANGED