@seamapi/http 2.11.1 → 2.12.0

package/lib/resources/phone.d.ts

@@ -9,7 +9,7 @@ export type Phone = {
     /**
      * Optional [custom metadata](https://docs.seam.co/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.
      */
-    custom_metadata: Record<string, unknown>;
+    custom_metadata: Record<string, string | boolean>;
     /**
      * ID of the phone.
      */

package/lib/resources/unmanaged-device.d.ts

@@ -97,7 +97,7 @@ export type UnmanagedDevice = {
     /**
      * 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.
      */
-    custom_metadata: Record<string, unknown>;
+    custom_metadata: Record<string, string | boolean>;
     /**
      * ID of the device.
      */

package/lib/routes/connect-webviews/connect-webviews.d.ts

@@ -58,7 +58,7 @@ export type ConnectWebviewsCreateParameters = {
     /**
      * 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.
      */
-    custom_metadata?: Record<string, unknown> | undefined;
+    custom_metadata?: Record<string, string | boolean> | undefined;
     /**
      * 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`.
      */
@@ -125,7 +125,7 @@ export type ConnectWebviewsListParameters = {
     /**
      * 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.
      */
-    custom_metadata_has?: Record<string, unknown> | undefined;
+    custom_metadata_has?: Record<string, string | boolean> | undefined;
     /**
      * Customer key for which you want to list connect webviews.
      */

package/lib/routes/connected-accounts/connected-accounts.d.ts

@@ -79,7 +79,7 @@ export type ConnectedAccountsListParameters = {
     /**
      * 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.
      */
-    custom_metadata_has?: Record<string, unknown> | undefined;
+    custom_metadata_has?: Record<string, string | boolean> | undefined;
     /**
      * Customer key by which you want to filter connected accounts.
      */
@@ -143,7 +143,7 @@ export type ConnectedAccountsUpdateParameters = {
     /**
      * 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.
      */
-    custom_metadata?: Record<string, unknown> | undefined;
+    custom_metadata?: Record<string, string | boolean> | undefined;
     /**
      * 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.
      */

package/lib/routes/customers/customers.d.ts

@@ -471,7 +471,7 @@ export type CustomersCreatePortalParameters = {
             /**
              * 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.
              */
-            custom_metadata?: Record<string, unknown> | undefined;
+            custom_metadata?: Record<string, string | boolean> | undefined;
             /**
              * Your display name for this location resource.
              */
@@ -496,7 +496,7 @@ export type CustomersCreatePortalParameters = {
             /**
              * 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.
              */
-            custom_metadata?: Record<string, unknown> | undefined;
+            custom_metadata?: Record<string, string | boolean> | undefined;
             /**
              * Ending date and time for the access grant.
              */
@@ -1161,7 +1161,7 @@ export type CustomersPushDataParameters = {
         /**
          * 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.
          */
-        custom_metadata?: Record<string, unknown> | undefined;
+        custom_metadata?: Record<string, string | boolean> | undefined;
         /**
          * Your display name for this location resource.
          */
@@ -1186,7 +1186,7 @@ export type CustomersPushDataParameters = {
         /**
          * 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.
          */
-        custom_metadata?: Record<string, unknown> | undefined;
+        custom_metadata?: Record<string, string | boolean> | undefined;
         /**
          * Ending date and time for the access grant.
          */

package/lib/routes/devices/devices.d.ts

@@ -89,7 +89,7 @@ export type DevicesListParameters = {
     /**
      * 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.
      */
-    custom_metadata_has?: Record<string, unknown> | undefined;
+    custom_metadata_has?: Record<string, string | boolean> | undefined;
     /**
      * Customer key for which you want to list devices.
      */
@@ -212,7 +212,7 @@ export type DevicesUpdateParameters = {
     /**
      * 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.
      */
-    custom_metadata?: Record<string, unknown> | undefined;
+    custom_metadata?: Record<string, string | boolean> | undefined;
     /**
      * ID of the device that you want to update.
      */

package/lib/routes/devices/unmanaged/unmanaged.d.ts

@@ -119,7 +119,7 @@ export type DevicesUnmanagedUpdateParameters = {
     /**
      * 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.
      */
-    custom_metadata?: Record<string, unknown> | undefined;
+    custom_metadata?: Record<string, string | boolean> | undefined;
     /**
      * ID of the unmanaged device that you want to update.
      */

package/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const seamapiJavascriptHttpVersion = "2.11.1";
+declare const seamapiJavascriptHttpVersion = "2.12.0";
 export default seamapiJavascriptHttpVersion;

package/lib/version.js

@@ -1,3 +1,3 @@
-const seamapiJavascriptHttpVersion = '2.11.1';
+const seamapiJavascriptHttpVersion = '2.12.0';
 export default seamapiJavascriptHttpVersion;
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/http",
-  "version": "2.11.1",
+  "version": "2.12.0",
   "description": "JavaScript HTTP client for the Seam API written in TypeScript.",
   "type": "module",
   "main": "index.js",
@@ -84,7 +84,7 @@
     "axios-retry": "^4.4.2"
   },
   "devDependencies": {
-    "@seamapi/blueprint": "^1.6.0",
+    "@seamapi/blueprint": "^1.7.0",
     "@seamapi/fake-seam-connect": "^2.0.4",
     "@seamapi/smith": "^1.1.0",
     "@seamapi/types": "1.1019.0",

package/src/lib/client.ts

@@ -20,6 +20,18 @@ export interface ClientOptions {
 
 type AxiosRetryConfig = Parameters<AxiosRetry>[1]
 
+type RequiredAxiosRetryConfig = Required<NonNullable<AxiosRetryConfig>>
+
+const defaultAxiosRetryOptions = {
+  retries: 2,
+  retryCondition: isIdempotentRequestError,
+  retryDelay: exponentialDelay,
+  shouldResetTimeout: true,
+  onRetry: () => undefined,
+  onMaxRetryTimesExceeded: () => undefined,
+  validateResponse: null,
+} satisfies RequiredAxiosRetryConfig
+
 export const createClient = (options: ClientOptions): AxiosInstance => {
   const client = axios.create({
     paramsSerializer: serializeUrlSearchParams,
@@ -29,9 +41,7 @@ export const createClient = (options: ClientOptions): AxiosInstance => {
   })
 
   axiosRetry(client, {
-    retries: 2,
-    retryDelay: exponentialDelay,
-    retryCondition: isIdempotentRequestError,
+    ...defaultAxiosRetryOptions,
     ...options.axiosRetryOptions,
   })
 

package/src/lib/resources/connect-webview.ts

@@ -60,7 +60,7 @@ export type ConnectWebview = {
   /**
    * 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.
    */
-  custom_metadata: Record<string, unknown>
+  custom_metadata: Record<string, string | boolean>
 
   /**
    * URL to which the Connect Webview should redirect when an unexpected error occurs.

package/src/lib/resources/connected-account.ts

@@ -40,7 +40,7 @@ export type ConnectedAccount = {
   /**
    * 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.
    */
-  custom_metadata: Record<string, unknown>
+  custom_metadata: Record<string, string | boolean>
 
   /**
    * Your unique key for the customer associated with this connected account.

package/src/lib/resources/device.ts

@@ -112,7 +112,7 @@ export type Device = {
   /**
    * 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.
    */
-  custom_metadata: Record<string, unknown>
+  custom_metadata: Record<string, string | boolean>
 
   /**
    * ID of the device.