@seamapi/http 2.4.0 → 2.4.2

package/src/lib/routes/acs/access-groups/access-groups.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { AcsAccessGroup } from 'lib/resources/acs-access-group.js'
 import type { AcsEntrance } from 'lib/resources/acs-entrance.js'
 import type { AcsUser } from 'lib/resources/acs-user.js'
@@ -167,6 +168,12 @@ export class SeamHttpAcsAccessGroups {
     parameters: AcsAccessGroupsAddUserParameters,
     options: AcsAccessGroupsAddUserOptions = {},
   ): AcsAccessGroupsAddUserRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/access_groups/add_user',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/access_groups/add_user',
       method: 'PUT',
@@ -183,10 +190,12 @@ export class SeamHttpAcsAccessGroups {
     parameters: AcsAccessGroupsDeleteParameters,
     options: AcsAccessGroupsDeleteOptions = {},
   ): AcsAccessGroupsDeleteRequest {
+    assertValidRequestParameters(parameters, '/acs/access_groups/delete', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/access_groups/delete',
-      method: 'POST',
-      body: parameters,
+      method: 'DELETE',
+      params: parameters,
       responseKey: undefined,
       options,
     })
@@ -199,10 +208,12 @@ export class SeamHttpAcsAccessGroups {
     parameters: AcsAccessGroupsGetParameters,
     options: AcsAccessGroupsGetOptions = {},
   ): AcsAccessGroupsGetRequest {
+    assertValidRequestParameters(parameters, '/acs/access_groups/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/access_groups/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'acs_access_group',
       options,
     })
@@ -215,10 +226,12 @@ export class SeamHttpAcsAccessGroups {
     parameters?: AcsAccessGroupsListParameters,
     options: AcsAccessGroupsListOptions = {},
   ): AcsAccessGroupsListRequest {
+    assertValidRequestParameters(parameters, '/acs/access_groups/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/access_groups/list',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'acs_access_groups',
       options,
     })
@@ -231,10 +244,16 @@ export class SeamHttpAcsAccessGroups {
     parameters: AcsAccessGroupsListAccessibleEntrancesParameters,
     options: AcsAccessGroupsListAccessibleEntrancesOptions = {},
   ): AcsAccessGroupsListAccessibleEntrancesRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/access_groups/list_accessible_entrances',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/access_groups/list_accessible_entrances',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'acs_entrances',
       options,
     })
@@ -247,10 +266,16 @@ export class SeamHttpAcsAccessGroups {
     parameters: AcsAccessGroupsListUsersParameters,
     options: AcsAccessGroupsListUsersOptions = {},
   ): AcsAccessGroupsListUsersRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/access_groups/list_users',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/access_groups/list_users',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'acs_users',
       options,
     })
@@ -263,10 +288,16 @@ export class SeamHttpAcsAccessGroups {
     parameters: AcsAccessGroupsRemoveUserParameters,
     options: AcsAccessGroupsRemoveUserOptions = {},
   ): AcsAccessGroupsRemoveUserRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/access_groups/remove_user',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/access_groups/remove_user',
-      method: 'POST',
-      body: parameters,
+      method: 'DELETE',
+      params: parameters,
       responseKey: undefined,
       options,
     })

package/src/lib/routes/acs/credentials/credentials.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { AcsCredential } from 'lib/resources/acs-credential.js'
 import type { AcsEntrance } from 'lib/resources/acs-entrance.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
@@ -166,6 +167,8 @@ export class SeamHttpAcsCredentials {
     parameters: AcsCredentialsAssignParameters,
     options: AcsCredentialsAssignOptions = {},
   ): AcsCredentialsAssignRequest {
+    assertValidRequestParameters(parameters, '/acs/credentials/assign', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/credentials/assign',
       method: 'PATCH',
@@ -182,6 +185,8 @@ export class SeamHttpAcsCredentials {
     parameters: AcsCredentialsCreateParameters,
     options: AcsCredentialsCreateOptions = {},
   ): AcsCredentialsCreateRequest {
+    assertValidRequestParameters(parameters, '/acs/credentials/create', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/credentials/create',
       method: 'POST',
@@ -198,10 +203,12 @@ export class SeamHttpAcsCredentials {
     parameters: AcsCredentialsDeleteParameters,
     options: AcsCredentialsDeleteOptions = {},
   ): AcsCredentialsDeleteRequest {
+    assertValidRequestParameters(parameters, '/acs/credentials/delete', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/credentials/delete',
-      method: 'POST',
-      body: parameters,
+      method: 'DELETE',
+      params: parameters,
       responseKey: undefined,
       options,
     })
@@ -214,10 +221,12 @@ export class SeamHttpAcsCredentials {
     parameters: AcsCredentialsGetParameters,
     options: AcsCredentialsGetOptions = {},
   ): AcsCredentialsGetRequest {
+    assertValidRequestParameters(parameters, '/acs/credentials/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/credentials/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'acs_credential',
       options,
     })
@@ -230,6 +239,8 @@ export class SeamHttpAcsCredentials {
     parameters?: AcsCredentialsListParameters,
     options: AcsCredentialsListOptions = {},
   ): AcsCredentialsListRequest {
+    assertValidRequestParameters(parameters, '/acs/credentials/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/credentials/list',
       method: 'GET',
@@ -246,10 +257,16 @@ export class SeamHttpAcsCredentials {
     parameters: AcsCredentialsListAccessibleEntrancesParameters,
     options: AcsCredentialsListAccessibleEntrancesOptions = {},
   ): AcsCredentialsListAccessibleEntrancesRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/credentials/list_accessible_entrances',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/credentials/list_accessible_entrances',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'acs_entrances',
       options,
     })
@@ -262,6 +279,8 @@ export class SeamHttpAcsCredentials {
     parameters: AcsCredentialsUnassignParameters,
     options: AcsCredentialsUnassignOptions = {},
   ): AcsCredentialsUnassignRequest {
+    assertValidRequestParameters(parameters, '/acs/credentials/unassign', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/credentials/unassign',
       method: 'PATCH',
@@ -278,6 +297,8 @@ export class SeamHttpAcsCredentials {
     parameters: AcsCredentialsUpdateParameters,
     options: AcsCredentialsUpdateOptions = {},
   ): AcsCredentialsUpdateRequest {
+    assertValidRequestParameters(parameters, '/acs/credentials/update', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/credentials/update',
       method: 'PATCH',
@@ -473,7 +494,7 @@ export type AcsCredentialsListParameters = {
   /**
    * 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 credentials to include all records that satisfy a partial match using `display_name`, `code`, `card_number`, `acs_user_id` or `acs_credential_id`.
    */

package/src/lib/routes/acs/encoders/encoders.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { AcsEncoder } from 'lib/resources/acs-encoder.js'
 import type { ActionAttempt } from 'lib/resources/action-attempt.js'
 import { SeamHttpActionAttempts } from 'lib/routes/action-attempts/index.js'
@@ -173,6 +174,12 @@ export class SeamHttpAcsEncoders {
     parameters: AcsEncodersEncodeCredentialParameters,
     options: AcsEncodersEncodeCredentialOptions = {},
   ): AcsEncodersEncodeCredentialRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/encoders/encode_credential',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/encoders/encode_credential',
       method: 'POST',
@@ -193,10 +200,12 @@ export class SeamHttpAcsEncoders {
     parameters: AcsEncodersGetParameters,
     options: AcsEncodersGetOptions = {},
   ): AcsEncodersGetRequest {
+    assertValidRequestParameters(parameters, '/acs/encoders/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/encoders/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'acs_encoder',
       options,
     })
@@ -209,10 +218,12 @@ export class SeamHttpAcsEncoders {
     parameters?: AcsEncodersListParameters,
     options: AcsEncodersListOptions = {},
   ): AcsEncodersListRequest {
+    assertValidRequestParameters(parameters, '/acs/encoders/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/encoders/list',
-      method: 'GET',
-      params: parameters,
+      method: 'POST',
+      body: parameters,
       responseKey: 'acs_encoders',
       options,
     })
@@ -225,6 +236,12 @@ export class SeamHttpAcsEncoders {
     parameters: AcsEncodersScanCredentialParameters,
     options: AcsEncodersScanCredentialOptions = {},
   ): AcsEncodersScanCredentialRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/encoders/scan_credential',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/encoders/scan_credential',
       method: 'POST',
@@ -245,6 +262,12 @@ export class SeamHttpAcsEncoders {
     parameters: AcsEncodersScanToAssignCredentialParameters,
     options: AcsEncodersScanToAssignCredentialOptions = {},
   ): AcsEncodersScanToAssignCredentialRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/encoders/scan_to_assign_credential',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/encoders/scan_to_assign_credential',
       method: 'POST',
@@ -330,7 +353,7 @@ export type AcsEncodersListParameters = {
   /**
    * 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
 }
 
 /**

package/src/lib/routes/acs/encoders/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,12 @@ export class SeamHttpAcsEncodersSimulate {
     parameters: AcsEncodersSimulateNextCredentialEncodeWillFailParameters,
     options: AcsEncodersSimulateNextCredentialEncodeWillFailOptions = {},
   ): AcsEncodersSimulateNextCredentialEncodeWillFailRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/encoders/simulate/next_credential_encode_will_fail',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/encoders/simulate/next_credential_encode_will_fail',
       method: 'POST',
@@ -180,6 +187,12 @@ export class SeamHttpAcsEncodersSimulate {
     parameters: AcsEncodersSimulateNextCredentialEncodeWillSucceedParameters,
     options: AcsEncodersSimulateNextCredentialEncodeWillSucceedOptions = {},
   ): AcsEncodersSimulateNextCredentialEncodeWillSucceedRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/encoders/simulate/next_credential_encode_will_succeed',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/encoders/simulate/next_credential_encode_will_succeed',
       method: 'POST',
@@ -196,6 +209,12 @@ export class SeamHttpAcsEncodersSimulate {
     parameters: AcsEncodersSimulateNextCredentialScanWillFailParameters,
     options: AcsEncodersSimulateNextCredentialScanWillFailOptions = {},
   ): AcsEncodersSimulateNextCredentialScanWillFailRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/encoders/simulate/next_credential_scan_will_fail',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/encoders/simulate/next_credential_scan_will_fail',
       method: 'POST',
@@ -212,6 +231,12 @@ export class SeamHttpAcsEncodersSimulate {
     parameters: AcsEncodersSimulateNextCredentialScanWillSucceedParameters,
     options: AcsEncodersSimulateNextCredentialScanWillSucceedOptions = {},
   ): AcsEncodersSimulateNextCredentialScanWillSucceedRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/encoders/simulate/next_credential_scan_will_succeed',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/encoders/simulate/next_credential_scan_will_succeed',
       method: 'POST',

package/src/lib/routes/acs/entrances/entrances.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { AcsCredential } from 'lib/resources/acs-credential.js'
 import type { AcsEntrance } from 'lib/resources/acs-entrance.js'
 import type { ActionAttempt } from 'lib/resources/action-attempt.js'
@@ -168,10 +169,12 @@ export class SeamHttpAcsEntrances {
     parameters: AcsEntrancesGetParameters,
     options: AcsEntrancesGetOptions = {},
   ): AcsEntrancesGetRequest {
+    assertValidRequestParameters(parameters, '/acs/entrances/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/entrances/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'acs_entrance',
       options,
     })
@@ -184,6 +187,12 @@ export class SeamHttpAcsEntrances {
     parameters: AcsEntrancesGrantAccessParameters,
     options: AcsEntrancesGrantAccessOptions = {},
   ): AcsEntrancesGrantAccessRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/entrances/grant_access',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/entrances/grant_access',
       method: 'POST',
@@ -200,6 +209,8 @@ export class SeamHttpAcsEntrances {
     parameters?: AcsEntrancesListParameters,
     options: AcsEntrancesListOptions = {},
   ): AcsEntrancesListRequest {
+    assertValidRequestParameters(parameters, '/acs/entrances/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/entrances/list',
       method: 'POST',
@@ -216,6 +227,12 @@ export class SeamHttpAcsEntrances {
     parameters: AcsEntrancesListCredentialsWithAccessParameters,
     options: AcsEntrancesListCredentialsWithAccessOptions = {},
   ): AcsEntrancesListCredentialsWithAccessRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/entrances/list_credentials_with_access',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/entrances/list_credentials_with_access',
       method: 'POST',
@@ -232,6 +249,8 @@ export class SeamHttpAcsEntrances {
     parameters: AcsEntrancesUnlockParameters,
     options: AcsEntrancesUnlockOptions = {},
   ): AcsEntrancesUnlockRequest {
+    assertValidRequestParameters(parameters, '/acs/entrances/unlock', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/entrances/unlock',
       method: 'POST',
@@ -322,11 +341,11 @@ export type AcsEntrancesListParameters = {
   /**
    * @deprecated Use `space_id`.
    */
-  location_id?: string | undefined
+  location_id?: string | null | 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 entrances to include all records that satisfy a partial match using `display_name`.
    */

package/src/lib/routes/acs/systems/systems.ts

@@ -28,6 +28,7 @@ import {
   limitToSeamHttpRequestOptions,
   parseOptions,
 } from 'lib/parse-options.js'
+import { assertValidRequestParameters } from 'lib/request-parameters.js'
 import type { AcsSystem } from 'lib/resources/acs-system.js'
 import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
 import { SeamHttpRequest } from 'lib/seam-http-request.js'
@@ -165,10 +166,12 @@ export class SeamHttpAcsSystems {
     parameters: AcsSystemsGetParameters,
     options: AcsSystemsGetOptions = {},
   ): AcsSystemsGetRequest {
+    assertValidRequestParameters(parameters, '/acs/systems/get', true)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/systems/get',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'acs_system',
       options,
     })
@@ -183,10 +186,12 @@ export class SeamHttpAcsSystems {
     parameters?: AcsSystemsListParameters,
     options: AcsSystemsListOptions = {},
   ): AcsSystemsListRequest {
+    assertValidRequestParameters(parameters, '/acs/systems/list', false)
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/systems/list',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'acs_systems',
       options,
     })
@@ -201,10 +206,16 @@ export class SeamHttpAcsSystems {
     parameters: AcsSystemsListCompatibleCredentialManagerAcsSystemsParameters,
     options: AcsSystemsListCompatibleCredentialManagerAcsSystemsOptions = {},
   ): AcsSystemsListCompatibleCredentialManagerAcsSystemsRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/systems/list_compatible_credential_manager_acs_systems',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/systems/list_compatible_credential_manager_acs_systems',
-      method: 'POST',
-      body: parameters,
+      method: 'GET',
+      params: parameters,
       responseKey: 'acs_systems',
       options,
     })
@@ -217,6 +228,12 @@ export class SeamHttpAcsSystems {
     parameters: AcsSystemsReportDevicesParameters,
     options: AcsSystemsReportDevicesOptions = {},
   ): AcsSystemsReportDevicesRequest {
+    assertValidRequestParameters(
+      parameters,
+      '/acs/systems/report_devices',
+      true,
+    )
+
     return new SeamHttpRequest(this, {
       pathname: '/acs/systems/report_devices',
       method: 'POST',