@seamapi/http 2.4.1 → 2.4.3

package/src/lib/routes/access-codes/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 { UnmanagedAccessCode } from 'lib/resources/unmanaged-access-code.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -169,6 +173,12 @@ export class SeamHttpAccessCodesUnmanaged {
     parameters: AccessCodesUnmanagedConvertToManagedParameters,
     options: AccessCodesUnmanagedConvertToManagedOptions = {},
   ): AccessCodesUnmanagedConvertToManagedRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_codes/unmanaged/convert_to_managed',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/unmanaged/convert_to_managed',
       method: 'PATCH',
@@ -185,10 +195,16 @@ export class SeamHttpAccessCodesUnmanaged {
     parameters: AccessCodesUnmanagedDeleteParameters,
     options: AccessCodesUnmanagedDeleteOptions = {},
   ): AccessCodesUnmanagedDeleteRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_codes/unmanaged/delete',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/unmanaged/delete',
-      method: 'POST',
-      body: parameters,
+      method: 'DELETE',
+      params: parameters,
       responseKey: undefined,
       options,
     })
@@ -200,13 +216,19 @@ export class SeamHttpAccessCodesUnmanaged {
    * You must specify either `access_code_id` or both `device_id` and `code`.
    */
   get(
-    parameters?: AccessCodesUnmanagedGetParameters,
+    parameters: AccessCodesUnmanagedGetParameters,
     options: AccessCodesUnmanagedGetOptions = {},
   ): AccessCodesUnmanagedGetRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_codes/unmanaged/get',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/unmanaged/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'access_code',
       options,
     })
@@ -219,10 +241,16 @@ export class SeamHttpAccessCodesUnmanaged {
     parameters: AccessCodesUnmanagedListParameters,
     options: AccessCodesUnmanagedListOptions = {},
   ): AccessCodesUnmanagedListRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_codes/unmanaged/list',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/unmanaged/list',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'access_codes',
       options,
     })
@@ -235,6 +263,12 @@ export class SeamHttpAccessCodesUnmanaged {
     parameters: AccessCodesUnmanagedUpdateParameters,
     options: AccessCodesUnmanagedUpdateOptions = {},
   ): AccessCodesUnmanagedUpdateRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_codes/unmanaged/update',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_codes/unmanaged/update',
       method: 'PATCH',
@@ -293,7 +327,7 @@ export type AccessCodesUnmanagedDeleteRequest = SeamHttpRequest<void, undefined>
 
 export interface AccessCodesUnmanagedDeleteOptions {}
 
-export type AccessCodesUnmanagedGetParameters = {
+export type AccessCodesUnmanagedGetParameters = RequireAtLeastOne<{
   /**
    * ID of the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
    */
@@ -306,7 +340,7 @@ export type AccessCodesUnmanagedGetParameters = {
    * ID of the device containing the unmanaged access code that you want to get. You must specify either `access_code_id` or both `device_id` and `code`.
    */
   device_id?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use AccessCodesUnmanagedGetRequest instead.
@@ -335,7 +369,7 @@ export type AccessCodesUnmanagedListParameters = {
   /**
    * 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 access codes to include all records that satisfy a partial match using `name`, `code` or `access_code_id`.
    */

package/src/lib/routes/access-grants/access-grants.ts

@@ -28,6 +28,10 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import {
+  assertValidRequestParameters,
+  type RequireAtLeastOne,
+} from 'lib/request-parameters.js'
 import type { AccessGrant } from 'lib/resources/access-grant.js'
 import type { Batch } from 'lib/resources/batch.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
@@ -172,6 +176,8 @@ export class SeamHttpAccessGrants {
     parameters: AccessGrantsCreateParameters,
     options: AccessGrantsCreateOptions = {},
   ): AccessGrantsCreateRequest {
+    assertValidRequestParameters(parameters, '/access_grants/create', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_grants/create',
       method: 'POST',
@@ -188,10 +194,12 @@ export class SeamHttpAccessGrants {
     parameters: AccessGrantsDeleteParameters,
     options: AccessGrantsDeleteOptions = {},
   ): AccessGrantsDeleteRequest {
+    assertValidRequestParameters(parameters, '/access_grants/delete', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_grants/delete',
-      method: 'POST',
-      body: parameters,
+      method: 'DELETE',
+      params: parameters,
       responseKey: undefined,
       options,
     })
@@ -201,9 +209,11 @@ export class SeamHttpAccessGrants {
    * Get an Access Grant.
    */
   get(
-    parameters?: AccessGrantsGetParameters,
+    parameters: AccessGrantsGetParameters,
     options: AccessGrantsGetOptions = {},
   ): AccessGrantsGetRequest {
+    assertValidRequestParameters(parameters, '/access_grants/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_grants/get',
       method: 'GET',
@@ -217,9 +227,11 @@ export class SeamHttpAccessGrants {
    * Gets all related resources for one or more Access Grants.
    */
   getRelated(
-    parameters?: AccessGrantsGetRelatedParameters,
+    parameters: AccessGrantsGetRelatedParameters,
     options: AccessGrantsGetRelatedOptions = {},
   ): AccessGrantsGetRelatedRequest {
+    assertValidRequestParameters(parameters, '/access_grants/get_related', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_grants/get_related',
       method: 'POST',
@@ -236,6 +248,8 @@ export class SeamHttpAccessGrants {
     parameters?: AccessGrantsListParameters,
     options: AccessGrantsListOptions = {},
   ): AccessGrantsListRequest {
+    assertValidRequestParameters(parameters, '/access_grants/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_grants/list',
       method: 'POST',
@@ -252,6 +266,12 @@ export class SeamHttpAccessGrants {
     parameters: AccessGrantsRequestAccessMethodsParameters,
     options: AccessGrantsRequestAccessMethodsOptions = {},
   ): AccessGrantsRequestAccessMethodsRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_grants/request_access_methods',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_grants/request_access_methods',
       method: 'POST',
@@ -265,9 +285,11 @@ export class SeamHttpAccessGrants {
    * Updates an existing Access Grant's time window.
    */
   update(
-    parameters?: AccessGrantsUpdateParameters,
+    parameters: AccessGrantsUpdateParameters,
     options: AccessGrantsUpdateOptions = {},
   ): AccessGrantsUpdateRequest {
+    assertValidRequestParameters(parameters, '/access_grants/update', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_grants/update',
       method: 'PATCH',
@@ -291,19 +313,19 @@ export type AccessGrantsCreateParameters = {
         /**
          * Unique email address for the user identity.
          */
-        email_address?: string | undefined
+        email_address?: string | null | undefined
         /**
          * Full name of the user associated with the user identity.
          */
-        full_name?: string | undefined
+        full_name?: string | null | undefined
         /**
          * Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100).
          */
-        phone_number?: string | undefined
+        phone_number?: string | null | undefined
         /**
          * Unique key for the user identity.
          */
-        user_identity_key?: string | undefined
+        user_identity_key?: string | null | undefined
       }
     | undefined
   /**
@@ -325,7 +347,7 @@ export type AccessGrantsCreateParameters = {
   /**
    * Date and time at which the validity of the new grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
    */
-  ends_at?: string | undefined
+  ends_at?: string | null | undefined
   /**
    * @deprecated Create a space first, then reference it using `space_ids`.
    */
@@ -352,7 +374,7 @@ export type AccessGrantsCreateParameters = {
   /**
    * Name for the access grant.
    */
-  name?: string | undefined
+  name?: string | null | undefined
 
   requested_access_methods: Array<{
     /**
@@ -415,7 +437,7 @@ export type AccessGrantsDeleteRequest = SeamHttpRequest<void, undefined>
 
 export interface AccessGrantsDeleteOptions {}
 
-export type AccessGrantsGetParameters = {
+export type AccessGrantsGetParameters = RequireAtLeastOne<{
   /**
    * ID of Access Grant to get.
    */
@@ -424,7 +446,7 @@ export type AccessGrantsGetParameters = {
    * Unique key of Access Grant to get.
    */
   access_grant_key?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use AccessGrantsGetRequest instead.
@@ -438,7 +460,7 @@ export type AccessGrantsGetRequest = SeamHttpRequest<
 
 export interface AccessGrantsGetOptions {}
 
-export type AccessGrantsGetRelatedParameters = {
+export type AccessGrantsGetRelatedParameters = RequireAtLeastOne<{
   /**
    * IDs of the access grants that you want to get along with their related resources.
    */
@@ -473,7 +495,7 @@ export type AccessGrantsGetRelatedParameters = {
         | 'access_methods'
       >
     | undefined
-}
+}>
 
 /**
  * @deprecated Use AccessGrantsGetRelatedRequest instead.
@@ -510,7 +532,7 @@ export type AccessGrantsListParameters = {
   /**
    * Filter Access Grants by access_grant_key. Use null to filter for Access Grants without an access_grant_key.
    */
-  access_grant_key?: string | undefined
+  access_grant_key?: string | null | undefined
   /**
    * ID of the entrance by which you want to filter the list of Access Grants.
    */
@@ -538,7 +560,7 @@ export type AccessGrantsListParameters = {
   /**
    * 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
   /**
    * Filter Access Grants by reservation_key.
    */
@@ -604,7 +626,7 @@ export type AccessGrantsRequestAccessMethodsRequest = SeamHttpRequest<
 
 export interface AccessGrantsRequestAccessMethodsOptions {}
 
-export type AccessGrantsUpdateParameters = {
+export type AccessGrantsUpdateParameters = RequireAtLeastOne<{
   /**
    * ID of the Access Grant to update. Provide either `access_grant_id` or `access_grant_key`.
    */
@@ -616,16 +638,16 @@ export type AccessGrantsUpdateParameters = {
   /**
    * Date and time at which the validity of the grant ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`.
    */
-  ends_at?: string | undefined
+  ends_at?: string | null | undefined
   /**
    * Display name for the access grant.
    */
-  name?: string | undefined
+  name?: string | null | undefined
   /**
    * Date and time at which the validity of the grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.
    */
   starts_at?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use AccessGrantsUpdateRequest instead.

package/src/lib/routes/access-grants/unmanaged/unmanaged.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { UnmanagedAccessGrant } from 'lib/resources/unmanaged-access-grant.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -165,10 +166,16 @@ export class SeamHttpAccessGrantsUnmanaged {
     parameters: AccessGrantsUnmanagedGetParameters,
     options: AccessGrantsUnmanagedGetOptions = {},
   ): AccessGrantsUnmanagedGetRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_grants/unmanaged/get',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_grants/unmanaged/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'access_grant',
       options,
     })
@@ -181,10 +188,16 @@ export class SeamHttpAccessGrantsUnmanaged {
     parameters?: AccessGrantsUnmanagedListParameters,
     options: AccessGrantsUnmanagedListOptions = {},
   ): AccessGrantsUnmanagedListRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_grants/unmanaged/list',
+      false,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_grants/unmanaged/list',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'access_grants',
       options,
     })
@@ -201,6 +214,12 @@ export class SeamHttpAccessGrantsUnmanaged {
     parameters: AccessGrantsUnmanagedUpdateParameters,
     options: AccessGrantsUnmanagedUpdateOptions = {},
   ): AccessGrantsUnmanagedUpdateRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_grants/unmanaged/update',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_grants/unmanaged/update',
       method: 'PATCH',
@@ -248,7 +267,7 @@ export type AccessGrantsUnmanagedListParameters = {
   /**
    * 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
   /**
    * Filter unmanaged Access Grants by reservation_key.
    */

package/src/lib/routes/access-methods/access-methods.ts

@@ -28,6 +28,10 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import {
+  assertValidRequestParameters,
+  type RequireAtLeastOne,
+} from 'lib/request-parameters.js'
 import type { AccessMethod } from 'lib/resources/access-method.js'
 import type { ActionAttempt } from 'lib/resources/action-attempt.js'
 import type { Batch } from 'lib/resources/batch.js'
@@ -174,6 +178,12 @@ export class SeamHttpAccessMethods {
     parameters: AccessMethodsAssignCardParameters,
     options: AccessMethodsAssignCardOptions = {},
   ): AccessMethodsAssignCardRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_methods/assign_card',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_methods/assign_card',
       method: 'POST',
@@ -191,9 +201,11 @@ export class SeamHttpAccessMethods {
    * Deletes an access method.
    */
   delete(
-    parameters?: AccessMethodsDeleteParameters,
+    parameters: AccessMethodsDeleteParameters,
     options: AccessMethodsDeleteOptions = {},
   ): AccessMethodsDeleteRequest {
+    assertValidRequestParameters(parameters, '/access_methods/delete', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_methods/delete',
       method: 'DELETE',
@@ -210,6 +222,8 @@ export class SeamHttpAccessMethods {
     parameters: AccessMethodsEncodeParameters,
     options: AccessMethodsEncodeOptions = {},
   ): AccessMethodsEncodeRequest {
+    assertValidRequestParameters(parameters, '/access_methods/encode', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_methods/encode',
       method: 'POST',
@@ -230,10 +244,12 @@ export class SeamHttpAccessMethods {
     parameters: AccessMethodsGetParameters,
     options: AccessMethodsGetOptions = {},
   ): AccessMethodsGetRequest {
+    assertValidRequestParameters(parameters, '/access_methods/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_methods/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'access_method',
       options,
     })
@@ -246,6 +262,12 @@ export class SeamHttpAccessMethods {
     parameters: AccessMethodsGetRelatedParameters,
     options: AccessMethodsGetRelatedOptions = {},
   ): AccessMethodsGetRelatedRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_methods/get_related',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_methods/get_related',
       method: 'POST',
@@ -259,13 +281,15 @@ export class SeamHttpAccessMethods {
    * Lists all access methods, usually filtered by Access Grant.
    */
   list(
-    parameters?: AccessMethodsListParameters,
+    parameters: AccessMethodsListParameters,
     options: AccessMethodsListOptions = {},
   ): AccessMethodsListRequest {
+    assertValidRequestParameters(parameters, '/access_methods/list', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/access_methods/list',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'access_methods',
       options,
     })
@@ -278,6 +302,12 @@ export class SeamHttpAccessMethods {
     parameters: AccessMethodsUnlockDoorParameters,
     options: AccessMethodsUnlockDoorOptions = {},
   ): AccessMethodsUnlockDoorRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_methods/unlock_door',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_methods/unlock_door',
       method: 'POST',
@@ -319,7 +349,7 @@ export type AccessMethodsAssignCardOptions = Pick<
   'waitForActionAttempt'
 >
 
-export type AccessMethodsDeleteParameters = {
+export type AccessMethodsDeleteParameters = RequireAtLeastOne<{
   /**
    * ID of access method to delete.
    */
@@ -332,7 +362,7 @@ export type AccessMethodsDeleteParameters = {
    * Reservation key of the access grant whose access methods should be deleted.
    */
   reservation_key?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use AccessMethodsDeleteRequest instead.
@@ -445,7 +475,7 @@ export type AccessMethodsGetRelatedRequest = SeamHttpRequest<
 
 export interface AccessMethodsGetRelatedOptions {}
 
-export type AccessMethodsListParameters = {
+export type AccessMethodsListParameters = RequireAtLeastOne<{
   /**
    * ID of the access code by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
    */
@@ -473,12 +503,12 @@ export type AccessMethodsListParameters = {
   /**
    * 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
   /**
    * ID of the space by which to filter the returned access methods. Must be combined with `access_grant_id`, `access_grant_key`, or `acs_entrance_id`.
    */
   space_id?: string | undefined
-}
+}>
 
 /**
  * @deprecated Use AccessMethodsListRequest instead.

package/src/lib/routes/access-methods/unmanaged/unmanaged.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { UnmanagedAccessMethod } from 'lib/resources/unmanaged-access-method.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -165,10 +166,16 @@ export class SeamHttpAccessMethodsUnmanaged {
     parameters: AccessMethodsUnmanagedGetParameters,
     options: AccessMethodsUnmanagedGetOptions = {},
   ): AccessMethodsUnmanagedGetRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_methods/unmanaged/get',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_methods/unmanaged/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'access_method',
       options,
     })
@@ -181,10 +188,16 @@ export class SeamHttpAccessMethodsUnmanaged {
     parameters: AccessMethodsUnmanagedListParameters,
     options: AccessMethodsUnmanagedListOptions = {},
   ): AccessMethodsUnmanagedListRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/access_methods/unmanaged/list',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/access_methods/unmanaged/list',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'access_methods',
       options,
     })