Use params schemas for all methods

Author: gmethvin

src/client/catalogs.ts

@@ -4,7 +4,11 @@ import {
   CatalogFieldMappingsResponseSchema,
   CatalogItemWithProperties,
   CatalogItemWithPropertiesSchema,
+  CreateCatalogParams,
+  DeleteCatalogItemParams,
+  DeleteCatalogParams,
   GetCatalogFieldMappingsParams,
+  GetCatalogItemParams,
   GetCatalogItemsParams,
   GetCatalogItemsResponse,
   GetCatalogItemsResponseSchema,
@@ -28,9 +32,11 @@ import type { BaseIterableClient } from "./base.js";
  */
 export function Catalogs<T extends Constructor<BaseIterableClient>>(Base: T) {
   return class extends Base {
-    async createCatalog(catalogName: string): Promise<IterableSuccessResponse> {
+    async createCatalog(
+      params: CreateCatalogParams
+    ): Promise<IterableSuccessResponse> {
       const response = await this.client.post(
-        `/api/catalogs/${encodeURIComponent(catalogName)}`
+        `/api/catalogs/${encodeURIComponent(params.catalogName)}`
       );
       return this.validateResponse(response, IterableSuccessResponseSchema);
     }
@@ -63,21 +69,19 @@ export function Catalogs<T extends Constructor<BaseIterableClient>>(Base: T) {
     }
 
     async getCatalogItem(
-      catalogName: string,
-      itemId: string
+      params: GetCatalogItemParams
     ): Promise<CatalogItemWithProperties> {
       const response = await this.client.get(
-        `/api/catalogs/${encodeURIComponent(catalogName)}/items/${encodeURIComponent(itemId)}`
+        `/api/catalogs/${encodeURIComponent(params.catalogName)}/items/${encodeURIComponent(params.itemId)}`
       );
       return this.validateResponse(response, CatalogItemWithPropertiesSchema);
     }
 
     async deleteCatalogItem(
-      catalogName: string,
-      itemId: string
+      params: DeleteCatalogItemParams
     ): Promise<IterableSuccessResponse> {
       const response = await this.client.delete(
-        `/api/catalogs/${encodeURIComponent(catalogName)}/items/${encodeURIComponent(itemId)}`
+        `/api/catalogs/${encodeURIComponent(params.catalogName)}/items/${encodeURIComponent(params.itemId)}`
       );
       return this.validateResponse(response, IterableSuccessResponseSchema);
     }
@@ -168,9 +172,11 @@ export function Catalogs<T extends Constructor<BaseIterableClient>>(Base: T) {
     /**
      * Delete a catalog
      */
-    async deleteCatalog(catalogName: string): Promise<IterableSuccessResponse> {
+    async deleteCatalog(
+      params: DeleteCatalogParams
+    ): Promise<IterableSuccessResponse> {
       const response = await this.client.delete(
-        `/api/catalogs/${encodeURIComponent(catalogName)}`
+        `/api/catalogs/${encodeURIComponent(params.catalogName)}`
       );
       return this.validateResponse(response, IterableSuccessResponseSchema);
     }

src/client/lists.ts

@@ -6,6 +6,7 @@ import {
   CreateListParams,
   CreateListResponse,
   CreateListResponseSchema,
+  DeleteListParams,
   GetListPreviewUsersParams,
   GetListPreviewUsersResponse,
   GetListPreviewUsersResponseSchema,
@@ -91,8 +92,8 @@ export function Lists<T extends Constructor<BaseIterableClient>>(Base: T) {
       return this.validateResponse(response, CreateListResponseSchema);
     }
 
-    async deleteList(listId: number): Promise<IterableSuccessResponse> {
-      const response = await this.client.delete(`/api/lists/${listId}`);
+    async deleteList(params: DeleteListParams): Promise<IterableSuccessResponse> {
+      const response = await this.client.delete(`/api/lists/${params.listId}`);
       return this.validateResponse(response, IterableSuccessResponseSchema);
     }
 

src/client/templates.ts

@@ -11,6 +11,7 @@ import {
   BulkDeleteTemplatesResponseSchema,
   EmailTemplate,
   EmailTemplateSchema,
+  GetTemplateByClientIdParams,
   GetTemplateByClientIdResponse,
   GetTemplateByClientIdResponseSchema,
   GetTemplateParams,
@@ -145,12 +146,12 @@ export function Templates<T extends Constructor<BaseIterableClient>>(Base: T) {
     }
 
     async getTemplateByClientId(
-      clientTemplateId: string
+      params: GetTemplateByClientIdParams
     ): Promise<GetTemplateByClientIdResponse> {
       const response = await this.client.get(
         "/api/templates/getByClientTemplateId",
         {
-          params: { clientTemplateId },
+          params: { clientTemplateId: params.clientTemplateId },
         }
       );
       return this.validateResponse(
@@ -174,9 +175,9 @@ export function Templates<T extends Constructor<BaseIterableClient>>(Base: T) {
      * @deprecated Use {@link bulkDeleteTemplates} instead
      */
     async deleteTemplates(
-      templateIds: number[]
+      params: BulkDeleteTemplatesParams
     ): Promise<BulkDeleteTemplatesResponse> {
-      return this.bulkDeleteTemplates({ ids: templateIds });
+      return this.bulkDeleteTemplates(params);
     }
 
     // Email Template Management

src/client/users.ts

@@ -8,9 +8,13 @@ import {
 } from "../types/lists.js";
 import {
   BulkUpdateUsersParams,
+  DeleteUserByEmailParams,
+  DeleteUserByUserIdParams,
   GetSentMessagesParams,
   GetSentMessagesResponse,
   GetSentMessagesResponseSchema,
+  GetUserByEmailParams,
+  GetUserByIdParams,
   GetUserFieldsResponse,
   GetUserFieldsResponseSchema,
   UpdateEmailParams,
@@ -30,12 +34,10 @@ export function Users<T extends Constructor<BaseIterableClient>>(Base: T) {
      * Get a user by email address
      */
     async getUserByEmail(
-      email: string,
-      opts?: { signal?: AbortSignal }
+      params: GetUserByEmailParams
     ): Promise<UserResponse> {
       const response = await this.client.get(
-        `/api/users/${encodeURIComponent(email)}`,
-        opts?.signal ? { signal: opts.signal } : {}
+        `/api/users/${encodeURIComponent(params.email)}`
       );
       return this.validateResponse(response, UserResponseSchema);
     }
@@ -44,12 +46,10 @@ export function Users<T extends Constructor<BaseIterableClient>>(Base: T) {
      * Get a user by userId
      */
     async getUserByUserId(
-      userId: string,
-      opts?: { signal?: AbortSignal }
+      params: GetUserByIdParams
     ): Promise<UserResponse> {
       const response = await this.client.get(
-        `/api/users/byUserId/${encodeURIComponent(userId)}`,
-        opts?.signal ? { signal: opts.signal } : {}
+        `/api/users/byUserId/${encodeURIComponent(params.userId)}`
       );
       return this.validateResponse(response, UserResponseSchema);
     }
@@ -69,9 +69,11 @@ export function Users<T extends Constructor<BaseIterableClient>>(Base: T) {
      * Delete a user by email address
      * Asynchronous operation - does not prevent future data collection
      */
-    async deleteUserByEmail(email: string): Promise<IterableSuccessResponse> {
+    async deleteUserByEmail(
+      params: DeleteUserByEmailParams
+    ): Promise<IterableSuccessResponse> {
       const response = await this.client.delete(
-        `/api/users/${encodeURIComponent(email)}`
+        `/api/users/${encodeURIComponent(params.email)}`
       );
       return this.validateResponse(response, IterableSuccessResponseSchema);
     }
@@ -81,9 +83,11 @@ export function Users<T extends Constructor<BaseIterableClient>>(Base: T) {
      * Asynchronous operation - does not prevent future data collection
      * If multiple users share the same userId, they'll all be deleted
      */
-    async deleteUserByUserId(userId: string): Promise<IterableSuccessResponse> {
+    async deleteUserByUserId(
+      params: DeleteUserByUserIdParams
+    ): Promise<IterableSuccessResponse> {
       const response = await this.client.delete(
-        `/api/users/byUserId/${encodeURIComponent(userId)}`
+        `/api/users/byUserId/${encodeURIComponent(params.userId)}`
       );
       return this.validateResponse(response, IterableSuccessResponseSchema);
     }

src/types/catalogs.ts

@@ -109,6 +109,16 @@ export type GetCatalogFieldMappingsParams = z.infer<
 >;
 export type CreateCatalogParams = z.infer<typeof CreateCatalogParamsSchema>;
 
+export const DeleteCatalogParamsSchema = z.object({
+  catalogName: z
+    .string()
+    .max(255)
+    .regex(/^[a-zA-Z0-9-]+$/)
+    .describe("Name of the catalog to delete"),
+});
+
+export type DeleteCatalogParams = z.infer<typeof DeleteCatalogParamsSchema>;
+
 // Catalog items schemas
 export const CatalogItemWithPropertiesSchema = z.object({
   catalogName: z.string(),

src/types/users.ts

@@ -35,6 +35,8 @@ export const GetUserByEmailParamsSchema = z.object({
   email: z.email().describe("Email address of the user to retrieve"),
 });
 
+export type GetUserByEmailParams = z.infer<typeof GetUserByEmailParamsSchema>;
+
 export const UpdateUserParamsSchema = z
   .object({
     email: z.email().optional().describe("User email address"),
@@ -69,6 +71,8 @@ export const GetUserByIdParamsSchema = z.object({
   userId: z.string().describe("User ID to retrieve"),
 });
 
+export type GetUserByIdParams = z.infer<typeof GetUserByIdParamsSchema>;
+
 export const BulkUpdateUsersParamsSchema = z.object({
   users: z
     .array(
@@ -95,10 +99,18 @@ export const DeleteUserByEmailParamsSchema = z.object({
   email: z.email().describe("Email address of the user to delete"),
 });
 
+export type DeleteUserByEmailParams = z.infer<
+  typeof DeleteUserByEmailParamsSchema
+>;
+
 export const DeleteUserByUserIdParamsSchema = z.object({
   userId: z.string().describe("User ID of the user to delete"),
 });
 
+export type DeleteUserByUserIdParams = z.infer<
+  typeof DeleteUserByUserIdParamsSchema
+>;
+
 export const UserEventsResponseSchema = z.object({
   events: z.array(z.record(z.string(), z.any())),
 });

tests/unit/catalogs.test.ts

@@ -39,7 +39,7 @@ describe("Catalog Operations", () => {
       };
       mockAxiosInstance.post.mockResolvedValue(mockResponse);
 
-      const result = await client.createCatalog("test-catalog");
+      const result = await client.createCatalog({ catalogName: "test-catalog" });
 
       expect(mockAxiosInstance.post).toHaveBeenCalledWith(
         "/api/catalogs/test-catalog"
@@ -56,7 +56,7 @@ describe("Catalog Operations", () => {
       };
       mockAxiosInstance.post.mockResolvedValue(mockResponse);
 
-      await client.createCatalog("test catalog/with+special");
+      await client.createCatalog({ catalogName: "test catalog/with+special" });
 
       expect(mockAxiosInstance.post).toHaveBeenCalledWith(
         "/api/catalogs/test%20catalog%2Fwith%2Bspecial"
@@ -99,7 +99,10 @@ describe("Catalog Operations", () => {
       };
       mockAxiosInstance.get.mockResolvedValue(mockResponse);
 
-      const result = await client.getCatalogItem("products", "item1");
+      const result = await client.getCatalogItem({
+        catalogName: "products",
+        itemId: "item1",
+      });
 
       expect(mockAxiosInstance.get).toHaveBeenCalledWith(
         "/api/catalogs/products/items/item1"
@@ -119,7 +122,10 @@ describe("Catalog Operations", () => {
       };
       mockAxiosInstance.get.mockResolvedValue(mockResponse);
 
-      await client.getCatalogItem("my catalog", "item/1");
+      await client.getCatalogItem({
+        catalogName: "my catalog",
+        itemId: "item/1",
+      });
 
       expect(mockAxiosInstance.get).toHaveBeenCalledWith(
         "/api/catalogs/my%20catalog/items/item%2F1"
@@ -137,7 +143,10 @@ describe("Catalog Operations", () => {
       };
       mockAxiosInstance.delete.mockResolvedValue(mockResponse);
 
-      const result = await client.deleteCatalogItem("products", "item1");
+      const result = await client.deleteCatalogItem({
+        catalogName: "products",
+        itemId: "item1",
+      });
 
       expect(mockAxiosInstance.delete).toHaveBeenCalledWith(
         "/api/catalogs/products/items/item1"
@@ -154,7 +163,10 @@ describe("Catalog Operations", () => {
       };
       mockAxiosInstance.delete.mockResolvedValue(mockResponse);
 
-      await client.deleteCatalogItem("my catalog", "item+1");
+      await client.deleteCatalogItem({
+        catalogName: "my catalog",
+        itemId: "item+1",
+      });
 
       expect(mockAxiosInstance.delete).toHaveBeenCalledWith(
         "/api/catalogs/my%20catalog/items/item%2B1"
@@ -427,7 +439,10 @@ describe("Catalog Operations", () => {
       const expectedError = createIterableError(axiosError);
       mockAxiosInstance.get.mockRejectedValue(expectedError);
 
-      const promise = client.getCatalogItem("nonexistent", "item123");
+      const promise = client.getCatalogItem({
+        catalogName: "nonexistent",
+        itemId: "item123",
+      });
       await expect(promise).rejects.toThrow(IterableApiError);
 
       try {
@@ -452,7 +467,7 @@ describe("Catalog Operations", () => {
       };
       mockAxiosInstance.delete.mockResolvedValue(mockResponse);
 
-      const result = await client.deleteCatalog("test-catalog");
+      const result = await client.deleteCatalog({ catalogName: "test-catalog" });
 
       expect(mockAxiosInstance.delete).toHaveBeenCalledWith(
         "/api/catalogs/test-catalog"
@@ -469,7 +484,7 @@ describe("Catalog Operations", () => {
       };
       mockAxiosInstance.delete.mockResolvedValue(mockResponse);
 
-      await client.deleteCatalog("test catalog with spaces");
+      await client.deleteCatalog({ catalogName: "test catalog with spaces" });
 
       expect(mockAxiosInstance.delete).toHaveBeenCalledWith(
         "/api/catalogs/test%20catalog%20with%20spaces"

tests/unit/templates.test.ts

@@ -132,7 +132,7 @@ describe("Template Management", () => {
       };
       mockAxiosInstance.post.mockResolvedValue(mockResponse);
 
-      const result = await client.deleteTemplates(templateIds);
+      const result = await client.deleteTemplates({ ids: templateIds });
 
       expect(mockAxiosInstance.post).toHaveBeenCalledWith(
         "/api/templates/bulkDelete",