feat: new methods addBlock and deleteBlock (#233)

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neynar/nodejs-sdk",
-  "version": "1.68.0",
+  "version": "1.69.0",
   "description": "SDK to interact with Neynar APIs (https://docs.neynar.com/)",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",

src/neynar-api/common/version.ts

@@ -1 +1 @@
-export const version = "1.68.0";
+export const version = "1.69.0";

src/neynar-api/neynar-api-client.ts

@@ -3834,7 +3834,7 @@ export class NeynarAPIClient {
    *  console.log('Blocked Fids:', response);
    * });
    *
-   * For more information, refer to the [Neynar documentation](https://docs.neynar.com/reference/block-list).
+   * For more information, refer to the [Neynar documentation](https://docs.neynar.com/reference/fetch-block-list).
    */
   public async fetchBlockList(options?: {
     blockerFid: number;
@@ -3845,6 +3845,53 @@ export class NeynarAPIClient {
     return await this.clients.v2.fetchBlockList(options);
   }
 
+  /**
+   * Adds a block for a given fid.
+   * @summary Adds a block for a fid.
+   * @param {string} signerUuid - UUID of the signer who is performing the action.
+   * @param {number} blockedFid The fid of the user being blocked.
+   *
+   * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
+   *
+   * @example
+   * // Example: Block a user
+   * client.publishBlock(3, 19960).then(response => {
+   * console.log('Block Response:', response);
+   * });
+   *
+   * For more information, refer to the [Neynar documentation](https://docs.neynar.com/reference/publish-block).
+   *
+   */
+  public async publishBlock(
+    signerUuid: string,
+    blockedFid: number
+  ): Promise<OperationResponse> {
+    return await this.clients.v2.publishBlock(signerUuid, blockedFid);
+  }
+
+  /**
+   * Deletes a block for a given fid.
+   * @summary Deletes a block for a fid.
+   * @param {string} signerUuid - UUID of the signer who is performing the action.
+   * @param {number} blockedFid The fid of the user being unblocked.
+   *
+   * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
+   *
+   * @example
+   * // Example: Unblock a user
+   * client.deleteBlock(3, 19960).then(response => {
+   * console.log('Block Response:', response);
+   * });
+   *
+   * For more information, refer to the [Neynar documentation](https://docs.neynar.com/reference/delete-block).
+   */
+  public async deleteBlock(
+    signerUuid: string,
+    blockedFid: number
+  ): Promise<OperationResponse> {
+    return await this.clients.v2.deleteBlock(signerUuid, blockedFid);
+  }
+
   // ------------ Ban ------------
 
   /**

src/neynar-api/v2/client.ts

@@ -3876,15 +3876,15 @@ export class NeynarV2APIClient {
    *  console.log('Blocked Fids:', response);
    * });
    *
-   * For more information, refer to the [Neynar documentation](https://docs.neynar.com/reference/block-list).
+   * For more information, refer to the [Neynar documentation](https://docs.neynar.com/reference/fetch-block-list).
    */
   public async fetchBlockList(options?: {
     blockerFid: number;
     blockedFid: number;
     limit?: number;
     cursor: string;
   }): Promise<BlockListResponse> {
-    const response = await this.apis.block.blockList(
+    const response = await this.apis.block.fetchBlockList(
       options?.blockerFid,
       options?.blockedFid,
       options?.limit,
@@ -3893,6 +3893,61 @@ export class NeynarV2APIClient {
     return response.data;
   }
 
+  /**
+   * Adds a block for a given fid.
+   * @summary Adds a block for a fid.
+   * @param {string} signerUuid - A signer uuid for the user blocking another user.
+   * @param {number} blockedFid - The fid of the user being blocked.
+   *
+   * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
+   *
+   * @example
+   * // Example: Block a user
+   * client.publishBlock('aaa-aaa-aaa', 19960).then(response => {
+   * console.log('Block Response:', response);
+   * });
+   * For more information, refer to the [Neynar documentation](https://docs.neynar.com/reference/publish-block).
+   */
+  public async publishBlock(
+    signerUuid: string,
+    blockedFid: number
+  ): Promise<OperationResponse> {
+    const addBlockBody = {
+      signer_uuid: signerUuid,
+      blocked_fid: blockedFid,
+    };
+    const response = await this.apis.block.publishBlock(addBlockBody);
+    return response.data;
+  }
+
+  /**
+   * Deletes a block for a given fid.
+   * @summary Deletes a block for a fid.
+   * @param {string} signerUuid - A signer uuid for the user unblocking another user.
+   * @param {number} blockedFid - The fid of the user being unblocked.
+   *
+   * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
+   *
+   * @example
+   * // Example: Unblock a user
+   * client.deleteBlock('aaa-aaa-aaa', 19960).then(response => {
+   * console.log('Block Response:', response);
+   * });
+   *
+   * For more information, refer to the [Neynar documentation](https://docs.neynar.com/reference/delete-block).
+   */
+  public async deleteBlock(
+    signerUuid: string,
+    blockedFid: number
+  ): Promise<OperationResponse> {
+    const deleteBlockBody = {
+      signer_uuid: signerUuid,
+      blocked_fid: blockedFid,
+    };
+    const response = await this.apis.block.deleteBlock(deleteBlockBody);
+    return response.data;
+  }
+
   // ------------ Ban ------------
 
   /**

src/neynar-api/v2/openapi-farcaster/.openapi-generator/FILES

@@ -33,6 +33,7 @@ models/ban-req-body.ts
 models/ban-response.ts
 models/block-list-response.ts
 models/block-record.ts
+models/block-req-body.ts
 models/bulk-casts-response.ts
 models/bulk-follow-response.ts
 models/bulk-users-response.ts