@seamapi/http - npm Package Compare versions

Comparing version 0.14.0 to 0.14.1

lib/seam/connect/parse-options.js

@@ -65,2 +65,11 @@ import version from '../../../lib/version.js';
 const getEndpointFromEnv = () => {
+    if (globalThis.process?.env?.SEAM_API_URL != null) {
+        // eslint-disable-next-line no-console
+        console.warn('Using the SEAM_API_URL environment variable is deprecated. Support will be remove in a later major version. Use SEAM_ENDPOINT instead.');
+    }
+    if (globalThis.process?.env?.SEAM_API_URL != null &&
+        globalThis.process?.env?.SEAM_ENDPOINT != null) {
+        // eslint-disable-next-line no-console
+        console.warn('Detected both the SEAM_API_URL and SEAM_ENDPOINT environment variables. Using SEAM_ENDPOINT.');
+    }
     return (globalThis.process?.env?.SEAM_ENDPOINT ??
@@ -67,0 +76,0 @@ globalThis.process?.env?.SEAM_API_URL);

lib/seam/connect/routes/connected-accounts.d.ts

@@ -1,2 +0,2 @@
-import type { RouteRequestBody, RouteRequestParams, RouteResponse } from '@seamapi/types/connect';
+import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect';
 import type { SetNonNullable } from 'type-fest';
@@ -17,3 +17,3 @@ import { type Client } from '../../../../lib/seam/connect/client.js';
     get(body?: ConnectedAccountsGetParams): Promise<ConnectedAccountsGetResponse['connected_account']>;
-    list(params?: ConnectedAccountsListParams): Promise<ConnectedAccountsListResponse['connected_accounts']>;
+    list(body?: ConnectedAccountsListParams): Promise<ConnectedAccountsListResponse['connected_accounts']>;
     update(body?: ConnectedAccountsUpdateBody): Promise<ConnectedAccountsUpdateResponse['connected_account']>;
@@ -27,3 +27,3 @@ }
 export type ConnectedAccountsGetOptions = never;
-export type ConnectedAccountsListParams = RouteRequestParams<'/connected_accounts/list'>;
+export type ConnectedAccountsListParams = RouteRequestBody<'/connected_accounts/list'>;
 export type ConnectedAccountsListResponse = SetNonNullable<Required<RouteResponse<'/connected_accounts/list'>>>;
@@ -30,0 +30,0 @@ export type ConnectedAccountsListOptions = never;

lib/seam/connect/routes/connected-accounts.js

@@ -79,7 +79,7 @@ /*
     }
-    async list(params) {
+    async list(body) {
         const { data } = await this.client.request({
             url: '/connected_accounts/list',
-            method: 'get',
-            params,
+            method: 'post',
+            data: body,
         });
@@ -86,0 +86,0 @@ return data.connected_accounts;

lib/seam/connect/routes/noise-sensors-noise-thresholds.d.ts

@@ -15,3 +15,3 @@ import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect';
     static fromPersonalAccessToken(personalAccessToken: SeamHttpOptionsWithPersonalAccessToken['personalAccessToken'], workspaceId: SeamHttpOptionsWithPersonalAccessToken['workspaceId'], options?: Omit<SeamHttpOptionsWithPersonalAccessToken, 'personalAccessToken' | 'workspaceId'>): SeamHttpNoiseSensorsNoiseThresholds;
-    create(body?: NoiseSensorsNoiseThresholdsCreateBody): Promise<void>;
+    create(body?: NoiseSensorsNoiseThresholdsCreateBody): Promise<NoiseSensorsNoiseThresholdsCreateResponse['noise_threshold']>;
     delete(body?: NoiseSensorsNoiseThresholdsDeleteBody): Promise<void>;
@@ -18,0 +18,0 @@ get(body?: NoiseSensorsNoiseThresholdsGetParams): Promise<NoiseSensorsNoiseThresholdsGetResponse['noise_threshold']>;

lib/seam/connect/routes/noise-sensors-noise-thresholds.js

@@ -65,3 +65,3 @@ /*
     async create(body) {
-        await this.client.request({
+        const { data } = await this.client.request({
             url: '/noise_sensors/noise_thresholds/create',
@@ -71,2 +71,3 @@ method: 'post',
         });
+        return data.noise_threshold;
     }
@@ -73,0 +74,0 @@ async delete(body) {

lib/seam/connect/routes/user-identities.d.ts

@@ -1,2 +0,2 @@
-import type { RouteRequestBody, RouteRequestParams, RouteResponse } from '@seamapi/types/connect';
+import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect';
 import type { SetNonNullable } from 'type-fest';
@@ -21,3 +21,3 @@ import { type Client } from '../../../../lib/seam/connect/client.js';
     grantAccessToDevice(body?: UserIdentitiesGrantAccessToDeviceBody): Promise<void>;
-    list(params?: UserIdentitiesListParams): Promise<UserIdentitiesListResponse['user_identities']>;
+    list(body?: UserIdentitiesListParams): Promise<UserIdentitiesListResponse['user_identities']>;
     listAccessibleDevices(body?: UserIdentitiesListAccessibleDevicesParams): Promise<UserIdentitiesListAccessibleDevicesResponse['accessible_devices']>;
@@ -41,3 +41,3 @@ listAcsSystems(body?: UserIdentitiesListAcsSystemsParams): Promise<UserIdentitiesListAcsSystemsResponse['acs_systems']>;
 export type UserIdentitiesGrantAccessToDeviceOptions = never;
-export type UserIdentitiesListParams = RouteRequestParams<'/user_identities/list'>;
+export type UserIdentitiesListParams = RouteRequestBody<'/user_identities/list'>;
 export type UserIdentitiesListResponse = SetNonNullable<Required<RouteResponse<'/user_identities/list'>>>;
@@ -44,0 +44,0 @@ export type UserIdentitiesListOptions = never;

lib/seam/connect/routes/user-identities.js

@@ -98,7 +98,7 @@ /*
     }
-    async list(params) {
+    async list(body) {
         const { data } = await this.client.request({
             url: '/user_identities/list',
-            method: 'get',
-            params,
+            method: 'post',
+            data: body,
         });
@@ -105,0 +105,0 @@ return data.user_identities;

lib/seam/connect/routes/webhooks.d.ts

@@ -1,2 +0,2 @@
-import type { RouteRequestBody, RouteRequestParams, RouteResponse } from '@seamapi/types/connect';
+import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect';
 import type { SetNonNullable } from 'type-fest';
@@ -18,3 +18,3 @@ import { type Client } from '../../../../lib/seam/connect/client.js';
     get(body?: WebhooksGetParams): Promise<WebhooksGetResponse['webhook']>;
-    list(params?: WebhooksListParams): Promise<WebhooksListResponse['webhooks']>;
+    list(body?: WebhooksListParams): Promise<WebhooksListResponse['webhooks']>;
 }
@@ -30,4 +30,4 @@ export type WebhooksCreateBody = RouteRequestBody<'/webhooks/create'>;
 export type WebhooksGetOptions = never;
-export type WebhooksListParams = RouteRequestParams<'/webhooks/list'>;
+export type WebhooksListParams = RouteRequestBody<'/webhooks/list'>;
 export type WebhooksListResponse = SetNonNullable<Required<RouteResponse<'/webhooks/list'>>>;
 export type WebhooksListOptions = never;

lib/seam/connect/routes/webhooks.js

@@ -87,7 +87,7 @@ /*
     }
-    async list(params) {
+    async list(body) {
         const { data } = await this.client.request({
             url: '/webhooks/list',
-            method: 'get',
-            params,
+            method: 'post',
+            data: body,
         });
@@ -94,0 +94,0 @@ return data.webhooks;

lib/seam/connect/routes/workspaces.d.ts

@@ -1,2 +0,2 @@
-import type { RouteRequestBody, RouteRequestParams, RouteResponse } from '@seamapi/types/connect';
+import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect';
 import type { SetNonNullable } from 'type-fest';
@@ -16,4 +16,4 @@ import { type Client } from '../../../../lib/seam/connect/client.js';
     create(body?: WorkspacesCreateBody): Promise<WorkspacesCreateResponse['workspace']>;
-    get(params?: WorkspacesGetParams): Promise<WorkspacesGetResponse['workspace']>;
-    list(params?: WorkspacesListParams): Promise<WorkspacesListResponse['workspaces']>;
+    get(body?: WorkspacesGetParams): Promise<WorkspacesGetResponse['workspace']>;
+    list(body?: WorkspacesListParams): Promise<WorkspacesListResponse['workspaces']>;
     resetSandbox(body?: WorkspacesResetSandboxBody): Promise<void>;
@@ -24,6 +24,6 @@ }
 export type WorkspacesCreateOptions = never;
-export type WorkspacesGetParams = RouteRequestParams<'/workspaces/get'>;
+export type WorkspacesGetParams = RouteRequestBody<'/workspaces/get'>;
 export type WorkspacesGetResponse = SetNonNullable<Required<RouteResponse<'/workspaces/get'>>>;
 export type WorkspacesGetOptions = never;
-export type WorkspacesListParams = RouteRequestParams<'/workspaces/list'>;
+export type WorkspacesListParams = RouteRequestBody<'/workspaces/list'>;
 export type WorkspacesListResponse = SetNonNullable<Required<RouteResponse<'/workspaces/list'>>>;
@@ -30,0 +30,0 @@ export type WorkspacesListOptions = never;

lib/seam/connect/routes/workspaces.js

@@ -72,15 +72,15 @@ /*
     }
-    async get(params) {
+    async get(body) {
         const { data } = await this.client.request({
             url: '/workspaces/get',
-            method: 'get',
-            params,
+            method: 'post',
+            data: body,
         });
         return data.workspace;
     }
-    async list(params) {
+    async list(body) {
         const { data } = await this.client.request({
             url: '/workspaces/list',
-            method: 'get',
-            params,
+            method: 'post',
+            data: body,
         });
@@ -87,0 +87,0 @@ return data.workspaces;

lib/version.d.ts

@@ -1,2 +0,2 @@
-declare const seamapiJavascriptHttpVersion = "0.14.0";
+declare const seamapiJavascriptHttpVersion = "0.14.1";
 export default seamapiJavascriptHttpVersion;

lib/version.js

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

package.json

 {
   "name": "@seamapi/http",
-  "version": "0.14.0",
+  "version": "0.14.1",
   "description": "JavaScript HTTP client for the Seam API written in TypeScript.",
@@ -5,0 +5,0 @@ "type": "module",

README.md

@@ -25,3 +25,2 @@ # Seam HTTP Client
 [Seam Docs]: https://docs.seam.co/latest/
-[seamapi]: https://www.npmjs.com/package/seamapi
 [@seamapi/types]: https://github.com/seamapi/types/
@@ -34,3 +33,3 @@ [Axios]: https://axios-http.com/
 Before using this package, ensure you understand the installation and updating instructions.
-This SDK is entirely contained in the [seamapi] package. Seam recommends using that package instead
+This SDK is entirely contained in the [seam package]. Seam recommends using that package instead
 for simpler dependency management._
@@ -45,2 +44,3 @@
 [npm]: https://www.npmjs.com/
+[seam package]: https://www.npmjs.com/package/seam
 
@@ -74,3 +74,3 @@ ### Optional Peer Dependencies for TypeScript
 ```
-$ npm install -D @seamapi/http@latest
+$ npm install -D @seamapi/types
 ```
@@ -77,0 +77,0 @@

src/lib/seam/connect/parse-options.ts

@@ -100,2 +100,19 @@ import version from 'lib/version.js'
 const getEndpointFromEnv = (): string | null | undefined => {
+  if (globalThis.process?.env?.SEAM_API_URL != null) {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'Using the SEAM_API_URL environment variable is deprecated. Support will be remove in a later major version. Use SEAM_ENDPOINT instead.',
+    )
+  }
+
+  if (
+    globalThis.process?.env?.SEAM_API_URL != null &&
+    globalThis.process?.env?.SEAM_ENDPOINT != null
+  ) {
+    // eslint-disable-next-line no-console
+    console.warn(
+      'Detected both the SEAM_API_URL and SEAM_ENDPOINT environment variables. Using SEAM_ENDPOINT.',
+    )
+  }
+
   return (
@@ -102,0 +119,0 @@ globalThis.process?.env?.SEAM_ENDPOINT ??

src/lib/seam/connect/routes/connected-accounts.ts

@@ -6,7 +6,3 @@ /*
 
-import type {
-  RouteRequestBody,
-  RouteRequestParams,
-  RouteResponse,
-} from '@seamapi/types/connect'
+import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect'
 import type { SetNonNullable } from 'type-fest'
@@ -160,8 +156,8 @@
   async list(
-    params?: ConnectedAccountsListParams,
+    body?: ConnectedAccountsListParams,
   ): Promise<ConnectedAccountsListResponse['connected_accounts']> {
     const { data } = await this.client.request<ConnectedAccountsListResponse>({
       url: '/connected_accounts/list',
-      method: 'get',
-      params,
+      method: 'post',
+      data: body,
     })
@@ -206,3 +202,3 @@
 export type ConnectedAccountsListParams =
-  RouteRequestParams<'/connected_accounts/list'>
+  RouteRequestBody<'/connected_accounts/list'>
 
@@ -209,0 +205,0 @@ export type ConnectedAccountsListResponse = SetNonNullable<

src/lib/seam/connect/routes/noise-sensors-noise-thresholds.ts

@@ -137,8 +137,13 @@ /*
 
-  async create(body?: NoiseSensorsNoiseThresholdsCreateBody): Promise<void> {
-    await this.client.request<NoiseSensorsNoiseThresholdsCreateResponse>({
-      url: '/noise_sensors/noise_thresholds/create',
-      method: 'post',
-      data: body,
-    })
+  async create(
+    body?: NoiseSensorsNoiseThresholdsCreateBody,
+  ): Promise<NoiseSensorsNoiseThresholdsCreateResponse['noise_threshold']> {
+    const { data } =
+      await this.client.request<NoiseSensorsNoiseThresholdsCreateResponse>({
+        url: '/noise_sensors/noise_thresholds/create',
+        method: 'post',
+        data: body,
+      })
+
+    return data.noise_threshold
   }
@@ -145,0 +150,0 @@

src/lib/seam/connect/routes/user-identities.ts

@@ -6,7 +6,3 @@ /*
 
-import type {
-  RouteRequestBody,
-  RouteRequestParams,
-  RouteResponse,
-} from '@seamapi/types/connect'
+import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect'
 import type { SetNonNullable } from 'type-fest'
@@ -190,8 +186,8 @@
   async list(
-    params?: UserIdentitiesListParams,
+    body?: UserIdentitiesListParams,
   ): Promise<UserIdentitiesListResponse['user_identities']> {
     const { data } = await this.client.request<UserIdentitiesListResponse>({
       url: '/user_identities/list',
-      method: 'get',
-      params,
+      method: 'post',
+      data: body,
     })
@@ -297,4 +293,3 @@
 
-export type UserIdentitiesListParams =
-  RouteRequestParams<'/user_identities/list'>
+export type UserIdentitiesListParams = RouteRequestBody<'/user_identities/list'>
 
@@ -301,0 +296,0 @@ export type UserIdentitiesListResponse = SetNonNullable<

src/lib/seam/connect/routes/webhooks.ts

@@ -6,7 +6,3 @@ /*
 
-import type {
-  RouteRequestBody,
-  RouteRequestParams,
-  RouteResponse,
-} from '@seamapi/types/connect'
+import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect'
 import type { SetNonNullable } from 'type-fest'
@@ -170,8 +166,8 @@
   async list(
-    params?: WebhooksListParams,
+    body?: WebhooksListParams,
   ): Promise<WebhooksListResponse['webhooks']> {
     const { data } = await this.client.request<WebhooksListResponse>({
       url: '/webhooks/list',
-      method: 'get',
-      params,
+      method: 'post',
+      data: body,
     })
@@ -207,3 +203,3 @@
 
-export type WebhooksListParams = RouteRequestParams<'/webhooks/list'>
+export type WebhooksListParams = RouteRequestBody<'/webhooks/list'>
 
@@ -210,0 +206,0 @@ export type WebhooksListResponse = SetNonNullable<

src/lib/seam/connect/routes/workspaces.ts

@@ -6,7 +6,3 @@ /*
 
-import type {
-  RouteRequestBody,
-  RouteRequestParams,
-  RouteResponse,
-} from '@seamapi/types/connect'
+import type { RouteRequestBody, RouteResponse } from '@seamapi/types/connect'
 import type { SetNonNullable } from 'type-fest'
@@ -152,8 +148,8 @@
   async get(
-    params?: WorkspacesGetParams,
+    body?: WorkspacesGetParams,
   ): Promise<WorkspacesGetResponse['workspace']> {
     const { data } = await this.client.request<WorkspacesGetResponse>({
       url: '/workspaces/get',
-      method: 'get',
-      params,
+      method: 'post',
+      data: body,
     })
@@ -165,8 +161,8 @@
   async list(
-    params?: WorkspacesListParams,
+    body?: WorkspacesListParams,
   ): Promise<WorkspacesListResponse['workspaces']> {
     const { data } = await this.client.request<WorkspacesListResponse>({
       url: '/workspaces/list',
-      method: 'get',
-      params,
+      method: 'post',
+      data: body,
     })
@@ -194,3 +190,3 @@
 
-export type WorkspacesGetParams = RouteRequestParams<'/workspaces/get'>
+export type WorkspacesGetParams = RouteRequestBody<'/workspaces/get'>
 
@@ -203,3 +199,3 @@ export type WorkspacesGetResponse = SetNonNullable<
 
-export type WorkspacesListParams = RouteRequestParams<'/workspaces/list'>
+export type WorkspacesListParams = RouteRequestBody<'/workspaces/list'>
 
@@ -206,0 +202,0 @@ export type WorkspacesListResponse = SetNonNullable<

src/lib/version.ts

@@ -1,3 +0,3 @@
-const seamapiJavascriptHttpVersion = '0.14.0'
+const seamapiJavascriptHttpVersion = '0.14.1'
 
 export default seamapiJavascriptHttpVersion

No alert changes

Improved metrics

Total package byte prevSize

1245031

increased by0.24%

Lines of code

14777

increased by0.16%

No dependency changes