@seamapi/http 2.4.1 → 2.4.2

package/src/lib/routes/customers/customers.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { CustomerPortal } from 'lib/resources/customer-portal.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -165,6 +166,8 @@ export class SeamHttpCustomers {
     parameters?: CustomersCreatePortalParameters,
     options: CustomersCreatePortalOptions = {},
   ): CustomersCreatePortalRequest {
+    assertValidRequestParameters(parameters, '/customers/create_portal', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/customers/create_portal',
       method: 'POST',
@@ -182,6 +185,8 @@ export class SeamHttpCustomers {
     parameters?: CustomersDeleteDataParameters,
     options: CustomersDeleteDataOptions = {},
   ): CustomersDeleteDataRequest {
+    assertValidRequestParameters(parameters, '/customers/delete_data', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/customers/delete_data',
       method: 'POST',
@@ -198,6 +203,8 @@ export class SeamHttpCustomers {
     parameters: CustomersPushDataParameters,
     options: CustomersPushDataOptions = {},
   ): CustomersPushDataRequest {
+    assertValidRequestParameters(parameters, '/customers/push_data', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/customers/push_data',
       method: 'POST',
@@ -225,7 +232,7 @@ export type CustomersCreatePortalParameters = {
         /**
          * The value to compare against.
          */
-        value?: {} | undefined
+        value?: string | undefined
       }>
     | undefined
   /**
@@ -883,19 +890,19 @@ export type CustomersCreatePortalParameters = {
                     /**
                      * Postal address for the space.
                      */
-                    address?: string | undefined
+                    address?: string | null | undefined
                     /**
                      * Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.
                      */
-                    default_checkin_time?: string | undefined
+                    default_checkin_time?: string | null | undefined
                     /**
                      * Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.
                      */
-                    default_checkout_time?: string | undefined
+                    default_checkout_time?: string | null | undefined
                     /**
                      * IANA time zone for the space, e.g. America/Los_Angeles.
                      */
-                    time_zone?: string | undefined
+                    time_zone?: string | null | undefined
                   }
                 | undefined
               /**
@@ -1624,19 +1631,19 @@ export type CustomersPushDataParameters = {
               /**
                * Postal address for the space.
                */
-              address?: string | undefined
+              address?: string | null | undefined
               /**
                * Default check-in time for reservations at the space, as HH:mm or HH:mm:ss.
                */
-              default_checkin_time?: string | undefined
+              default_checkin_time?: string | null | undefined
               /**
                * Default check-out time for reservations at the space, as HH:mm or HH:mm:ss.
                */
-              default_checkout_time?: string | undefined
+              default_checkout_time?: string | null | undefined
               /**
                * IANA time zone for the space, e.g. America/Los_Angeles.
                */
-              time_zone?: string | undefined
+              time_zone?: string | null | undefined
             }
           | undefined
         /**

package/src/lib/routes/devices/devices.ts

@@ -28,6 +28,10 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import {
+  assertValidRequestParameters,
+  type RequireAtLeastOne,
+} from 'lib/request-parameters.js'
 import type { Device } from 'lib/resources/device.js'
 import type { DeviceProvider } from 'lib/resources/device-provider.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
@@ -176,13 +180,15 @@ export class SeamHttpDevices {
    * You must specify either `device_id` or `name`.
    */
   get(
-    parameters?: DevicesGetParameters,
+    parameters: DevicesGetParameters,
     options: DevicesGetOptions = {},
   ): DevicesGetRequest {
+    assertValidRequestParameters(parameters, '/devices/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'device',
       options,
     })
@@ -195,6 +201,8 @@ export class SeamHttpDevices {
     parameters?: DevicesListParameters,
     options: DevicesListOptions = {},
   ): DevicesListRequest {
+    assertValidRequestParameters(parameters, '/devices/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/list',
       method: 'POST',
@@ -215,10 +223,16 @@ export class SeamHttpDevices {
     parameters?: DevicesListDeviceProvidersParameters,
     options: DevicesListDeviceProvidersOptions = {},
   ): DevicesListDeviceProvidersRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/devices/list_device_providers',
+      false,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/list_device_providers',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'device_providers',
       options,
     })
@@ -231,6 +245,12 @@ export class SeamHttpDevices {
     parameters: DevicesReportProviderMetadataParameters,
     options: DevicesReportProviderMetadataOptions = {},
   ): DevicesReportProviderMetadataRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/devices/report_provider_metadata',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/report_provider_metadata',
       method: 'POST',
@@ -249,6 +269,8 @@ export class SeamHttpDevices {
     parameters: DevicesUpdateParameters,
     options: DevicesUpdateOptions = {},
   ): DevicesUpdateRequest {
+    assertValidRequestParameters(parameters, '/devices/update', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/update',
       method: 'PATCH',
@@ -259,7 +281,7 @@ export class SeamHttpDevices {
   }
 }
 
-export type DevicesGetParameters = {
+export type DevicesGetParameters = RequireAtLeastOne<{
   /**
    * ID of the device that you want to get.
    */
@@ -268,7 +290,7 @@ export type DevicesGetParameters = {
    * Name of the device that you want to get.
    */
   name?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use DevicesGetRequest instead.
@@ -338,6 +360,7 @@ export type DevicesListParameters = {
     | 'tedee_lock'
     | 'akiles_lock'
     | 'ultraloq_lock'
+    | 'yacan_lock'
     | 'keyincode_lock'
     | 'omnitec_lock'
     | 'kisi_lock'
@@ -386,6 +409,7 @@ export type DevicesListParameters = {
         | 'tedee_lock'
         | 'akiles_lock'
         | 'ultraloq_lock'
+        | 'yacan_lock'
         | 'keyincode_lock'
         | 'omnitec_lock'
         | 'kisi_lock'
@@ -463,11 +487,12 @@ export type DevicesListParameters = {
     | 'omnitec'
     | 'kisi'
     | 'slack'
+    | 'yacan'
     | undefined
   /**
    * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
    */
-  page_cursor?: string | undefined
+  page_cursor?: string | null | undefined
   /**
    * String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.
    */
@@ -479,7 +504,7 @@ export type DevicesListParameters = {
   /**
    * @deprecated Use `space_id`.
    */
-  unstable_location_id?: string | undefined
+  unstable_location_id?: string | null | undefined
   /**
    * Your own internal user ID for the user for which you want to list devices.
    */
@@ -1893,14 +1918,14 @@ export type DevicesUpdateParameters = {
   /**
    * Name for the device.
    */
-  name?: string | undefined
+  name?: string | null | undefined
 
   properties?:
     | {
         /**
          * Name for the device.
          */
-        name?: string | undefined
+        name?: string | null | undefined
       }
     | undefined
 }

package/src/lib/routes/devices/simulate/simulate.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
 import { SeamPaginator } from 'lib/seam-paginator.js'
@@ -164,6 +165,8 @@ export class SeamHttpDevicesSimulate {
     parameters: DevicesSimulateConnectParameters,
     options: DevicesSimulateConnectOptions = {},
   ): DevicesSimulateConnectRequest {
+    assertValidRequestParameters(parameters, '/devices/simulate/connect', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/simulate/connect',
       method: 'POST',
@@ -183,6 +186,12 @@ export class SeamHttpDevicesSimulate {
     parameters: DevicesSimulateConnectToHubParameters,
     options: DevicesSimulateConnectToHubOptions = {},
   ): DevicesSimulateConnectToHubRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/devices/simulate/connect_to_hub',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/simulate/connect_to_hub',
       method: 'POST',
@@ -199,6 +208,12 @@ export class SeamHttpDevicesSimulate {
     parameters: DevicesSimulateDisconnectParameters,
     options: DevicesSimulateDisconnectOptions = {},
   ): DevicesSimulateDisconnectRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/devices/simulate/disconnect',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/simulate/disconnect',
       method: 'POST',
@@ -219,6 +234,12 @@ export class SeamHttpDevicesSimulate {
     parameters: DevicesSimulateDisconnectFromHubParameters,
     options: DevicesSimulateDisconnectFromHubOptions = {},
   ): DevicesSimulateDisconnectFromHubRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/devices/simulate/disconnect_from_hub',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/simulate/disconnect_from_hub',
       method: 'POST',
@@ -237,6 +258,12 @@ export class SeamHttpDevicesSimulate {
     parameters: DevicesSimulatePaidSubscriptionParameters,
     options: DevicesSimulatePaidSubscriptionOptions = {},
   ): DevicesSimulatePaidSubscriptionRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/devices/simulate/paid_subscription',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/simulate/paid_subscription',
       method: 'POST',
@@ -253,6 +280,8 @@ export class SeamHttpDevicesSimulate {
     parameters: DevicesSimulateRemoveParameters,
     options: DevicesSimulateRemoveOptions = {},
   ): DevicesSimulateRemoveRequest {
+    assertValidRequestParameters(parameters, '/devices/simulate/remove', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/simulate/remove',
       method: 'POST',

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

@@ -28,6 +28,10 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import {
+  assertValidRequestParameters,
+  type RequireAtLeastOne,
+} from 'lib/request-parameters.js'
 import type { UnmanagedDevice } from 'lib/resources/unmanaged-device.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -166,13 +170,15 @@ export class SeamHttpDevicesUnmanaged {
    * You must specify either `device_id` or `name`.
    */
   get(
-    parameters?: DevicesUnmanagedGetParameters,
+    parameters: DevicesUnmanagedGetParameters,
     options: DevicesUnmanagedGetOptions = {},
   ): DevicesUnmanagedGetRequest {
+    assertValidRequestParameters(parameters, '/devices/unmanaged/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/unmanaged/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'device',
       options,
     })
@@ -187,6 +193,8 @@ export class SeamHttpDevicesUnmanaged {
     parameters?: DevicesUnmanagedListParameters,
     options: DevicesUnmanagedListOptions = {},
   ): DevicesUnmanagedListRequest {
+    assertValidRequestParameters(parameters, '/devices/unmanaged/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/unmanaged/list',
       method: 'POST',
@@ -205,6 +213,8 @@ export class SeamHttpDevicesUnmanaged {
     parameters: DevicesUnmanagedUpdateParameters,
     options: DevicesUnmanagedUpdateOptions = {},
   ): DevicesUnmanagedUpdateRequest {
+    assertValidRequestParameters(parameters, '/devices/unmanaged/update', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/devices/unmanaged/update',
       method: 'PATCH',
@@ -215,7 +225,7 @@ export class SeamHttpDevicesUnmanaged {
   }
 }
 
-export type DevicesUnmanagedGetParameters = {
+export type DevicesUnmanagedGetParameters = RequireAtLeastOne<{
   /**
    * ID of the unmanaged device that you want to get.
    */
@@ -224,7 +234,7 @@ export type DevicesUnmanagedGetParameters = {
    * Name of the unmanaged device that you want to get.
    */
   name?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use DevicesUnmanagedGetRequest instead.
@@ -255,10 +265,6 @@ export type DevicesUnmanagedListParameters = {
    * Timestamp by which to limit returned devices. Returns devices created before this timestamp.
    */
   created_before?: string | undefined
-  /**
-   * 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.
-   */
-  custom_metadata_has?: Record<string, unknown> | undefined
   /**
    * Customer key for which you want to list devices.
    */
@@ -297,6 +303,7 @@ export type DevicesUnmanagedListParameters = {
     | 'tedee_lock'
     | 'akiles_lock'
     | 'ultraloq_lock'
+    | 'yacan_lock'
     | 'keyincode_lock'
     | 'omnitec_lock'
     | 'kisi_lock'
@@ -345,6 +352,7 @@ export type DevicesUnmanagedListParameters = {
         | 'tedee_lock'
         | 'akiles_lock'
         | 'ultraloq_lock'
+        | 'yacan_lock'
         | 'keyincode_lock'
         | 'omnitec_lock'
         | 'kisi_lock'
@@ -422,27 +430,16 @@ export type DevicesUnmanagedListParameters = {
     | 'omnitec'
     | 'kisi'
     | 'slack'
+    | 'yacan'
     | undefined
   /**
    * Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`.
    */
-  page_cursor?: string | undefined
+  page_cursor?: string | null | undefined
   /**
    * String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`.
    */
   search?: string | undefined
-  /**
-   * ID of the space for which you want to list devices.
-   */
-  space_id?: string | undefined
-  /**
-   * @deprecated Use `space_id`.
-   */
-  unstable_location_id?: string | undefined
-  /**
-   * Your own internal user ID for the user for which you want to list devices.
-   */
-  user_identifier_key?: string | undefined
 }
 
 /**

package/src/lib/routes/events/events.ts

@@ -28,6 +28,10 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import {
+  assertValidRequestParameters,
+  type RequireAtLeastOne,
+} from 'lib/request-parameters.js'
 import type { SeamEvent } from 'lib/resources/event.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -162,13 +166,15 @@ export class SeamHttpEvents {
    * Returns a specified event. This endpoint returns the same event that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to retrieve an event that already took place.
    */
   get(
-    parameters?: EventsGetParameters,
+    parameters: EventsGetParameters,
     options: EventsGetOptions = {},
   ): EventsGetRequest {
+    assertValidRequestParameters(parameters, '/events/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/events/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'event',
       options,
     })
@@ -178,9 +184,11 @@ export class SeamHttpEvents {
    * Returns a list of all events. This endpoint returns the same events that would be sent to a [webhook](https://docs.seam.co/developer-tools/webhooks), but it enables you to filter or see events that already took place.
    */
   list(
-    parameters?: EventsListParameters,
+    parameters: EventsListParameters,
     options: EventsListOptions = {},
   ): EventsListRequest {
+    assertValidRequestParameters(parameters, '/events/list', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/events/list',
       method: 'POST',
@@ -191,7 +199,7 @@ export class SeamHttpEvents {
   }
 }
 
-export type EventsGetParameters = {
+export type EventsGetParameters = RequireAtLeastOne<{
   /**
    * Unique identifier for the device that triggered the event that you want to get.
    */
@@ -204,7 +212,7 @@ export type EventsGetParameters = {
    * Type of the event that you want to get.
    */
   event_type?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use EventsGetRequest instead.
@@ -215,7 +223,7 @@ export type EventsGetRequest = SeamHttpRequest<EventsGetResponse, 'event'>
 
 export interface EventsGetOptions {}
 
-export type EventsListParameters = {
+export type EventsListParameters = RequireAtLeastOne<{
   /**
    * ID of the access code for which you want to list events.
    */
@@ -271,7 +279,7 @@ export type EventsListParameters = {
   /**
    * Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.
    */
-  between?: Array<{}> | undefined
+  between?: Array<string> | undefined
   /**
    * ID of the Connect Webview for which you want to list events.
    */
@@ -550,7 +558,7 @@ export type EventsListParameters = {
    * ID of the user identity for which you want to list events.
    */
   user_identity_id?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use EventsListRequest instead.

package/src/lib/routes/instant-keys/instant-keys.ts

@@ -28,6 +28,10 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import {
+  assertValidRequestParameters,
+  type RequireAtLeastOne,
+} from 'lib/request-parameters.js'
 import type { InstantKey } from 'lib/resources/instant-key.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -165,10 +169,12 @@ export class SeamHttpInstantKeys {
     parameters: InstantKeysDeleteParameters,
     options: InstantKeysDeleteOptions = {},
   ): InstantKeysDeleteRequest {
+    assertValidRequestParameters(parameters, '/instant_keys/delete', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/instant_keys/delete',
-      method: 'POST',
-      body: parameters,
+      method: 'DELETE',
+      params: parameters,
       responseKey: undefined,
       options,
     })
@@ -178,13 +184,15 @@ export class SeamHttpInstantKeys {
    * Gets an [instant key](https://docs.seam.co/capability-guides/instant-keys).
    */
   get(
-    parameters?: InstantKeysGetParameters,
+    parameters: InstantKeysGetParameters,
     options: InstantKeysGetOptions = {},
   ): InstantKeysGetRequest {
+    assertValidRequestParameters(parameters, '/instant_keys/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/instant_keys/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'instant_key',
       options,
     })
@@ -197,10 +205,12 @@ export class SeamHttpInstantKeys {
     parameters?: InstantKeysListParameters,
     options: InstantKeysListOptions = {},
   ): InstantKeysListRequest {
+    assertValidRequestParameters(parameters, '/instant_keys/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/instant_keys/list',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'instant_keys',
       options,
     })
@@ -223,7 +233,7 @@ export type InstantKeysDeleteRequest = SeamHttpRequest<void, undefined>
 
 export interface InstantKeysDeleteOptions {}
 
-export type InstantKeysGetParameters = {
+export type InstantKeysGetParameters = RequireAtLeastOne<{
   /**
    * ID of the instant key to get.
    */
@@ -232,7 +242,7 @@ export type InstantKeysGetParameters = {
    * URL of the instant key to get.
    */
   instant_key_url?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use InstantKeysGetRequest instead.