Add ReactionAPI related methods and Combine fetchCastByHash and fetch…

…CastByUrl

Add ReactionAPI related methods and Combine fetchCastByHash and fetchCastByUrl

package.json

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

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

@@ -32,6 +32,7 @@ export class NeynarV2APIClient {
 
   public readonly apis: {
     cast: CastApi;
+    reaction: ReactionApi;
   };
 
   /**
@@ -75,6 +76,7 @@ export class NeynarV2APIClient {
     });
     this.apis = {
       cast: new CastApi(config, undefined, axiosInstance),
+      reaction: new ReactionApi(config, undefined, axiosInstance),
     };
   }
 
@@ -93,39 +95,21 @@ export class NeynarV2APIClient {
     );
   }
 
-  /**
-   * Gets information about an individual cast by cast hash.
-   * See [Neynar documentation](https://docs.neynar.com/reference/cast)
-   *
-   */
-  public async fetchCastByHash(castHash: string): Promise<Cast | null> {
-    try {
-      const response = await this.apis.cast.cast({
-        type: CastParamType.Hash,
-        identifier: castHash,
-      });
-      return response.data.cast;
-    } catch (error) {
-      if (NeynarV2APIClient.isApiErrorResponse(error)) {
-        const status = error.response.status;
-        if (status === 404) {
-          return null;
-        }
-      }
-      throw error;
-    }
-  }
+  // ------------ Cast ------------
 
   /**
-   * Gets information about an individual cast by cast hash.
+   * Gets information about an individual cast.
    * See [Neynar documentation](https://docs.neynar.com/reference/cast)
    *
    */
-  public async fetchCastByUrl(castUrl: string): Promise<Cast | null> {
+  public async fetchCast(
+    castHashOrUrl: string,
+    type: CastParamType
+  ): Promise<Cast | null> {
     try {
       const response = await this.apis.cast.cast({
-        type: CastParamType.Url,
-        identifier: castUrl,
+        type,
+        identifier: castHashOrUrl,
       });
       return response.data.cast;
     } catch (error) {
@@ -209,4 +193,58 @@ export class NeynarV2APIClient {
     });
     return response.data;
   }
+
+  // ------------ Rection ------------
+
+  /**
+   * React to a cast.
+   * See [Neynar documentation](https://docs.neynar.com/reference/post-reaction)
+   *
+   */
+  public async reactToCast(
+    signerUuid: string,
+    reaction: ReactionType,
+    castOrCastHash: Cast | string
+  ): Promise<OperationResponse> {
+    let castHash: string;
+    if (typeof castOrCastHash === "string") {
+      castHash = castOrCastHash;
+    } else {
+      castHash = castOrCastHash.hash;
+    }
+    const body: ReactionReqBody = {
+      signer_uuid: signerUuid,
+      reaction_type: reaction,
+      target: castHash,
+    };
+    const response = await this.apis.reaction.postReaction({
+      reactionReqBody: body,
+    });
+    return response.data;
+  }
+
+  /**
+   * Remove a reaction to a cast. See [Neynar documentation](https://docs.neynar.com/reference/delete-reaction)
+   */
+  public async removeReactionToCast(
+    signerUuid: string,
+    reaction: ReactionType,
+    castOrCastHash: Cast | string
+  ): Promise<OperationResponse> {
+    let castHash: string;
+    if (typeof castOrCastHash === "string") {
+      castHash = castOrCastHash;
+    } else {
+      castHash = castOrCastHash.hash;
+    }
+    const body: ReactionReqBody = {
+      signer_uuid: signerUuid,
+      reaction_type: reaction,
+      target: castHash,
+    };
+    const response = await this.apis.reaction.deleteReaction({
+      reactionReqBody: body,
+    });
+    return response.data;
+  }
 }

src/neynar-api/neynar-v2-api/openapi-farcaster/apis/cast-api.ts

@@ -4,7 +4,7 @@
  * Farcaster API V2
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 1.0
+ * The version of the OpenAPI document: 2.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

src/neynar-api/neynar-v2-api/openapi-farcaster/apis/reaction-api.ts

@@ -4,7 +4,7 @@
  * Farcaster API V2
  * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
  *
- * The version of the OpenAPI document: 2.0
+ * The version of the OpenAPI document: 1.0
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -54,18 +54,14 @@ export const ReactionApiAxiosParamCreator = function (
     /**
      * Delete a reaction (like or recast) to a given cast \\ (In order to delete a reaction `signer_uuid` must be approved)
      * @summary Delete a reaction
-     * @param {string} apiKey API key required for authentication.
      * @param {ReactionReqBody} reactionReqBody
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     deleteReaction: async (
-      apiKey: string,
       reactionReqBody: ReactionReqBody,
       options: AxiosRequestConfig = {}
     ): Promise<RequestArgs> => {
-      // verify required parameter 'apiKey' is not null or undefined
-      assertParamExists("deleteReaction", "apiKey", apiKey);
       // verify required parameter 'reactionReqBody' is not null or undefined
       assertParamExists("deleteReaction", "reactionReqBody", reactionReqBody);
       const localVarPath = `/farcaster/reaction`;
@@ -84,9 +80,12 @@ export const ReactionApiAxiosParamCreator = function (
       const localVarHeaderParameter = {} as any;
       const localVarQueryParameter = {} as any;
 
-      if (apiKey != null) {
-        localVarHeaderParameter["api_key"] = String(apiKey);
-      }
+      // authentication ApiKeyAuth required
+      await setApiKeyToObject(
+        localVarHeaderParameter,
+        "api_key",
+        configuration
+      );
 
       localVarHeaderParameter["Content-Type"] = "application/json";
 
@@ -112,18 +111,14 @@ export const ReactionApiAxiosParamCreator = function (
     /**
      * Post a reaction (like or recast) to a given cast \\ (In order to post a reaction `signer_uuid` must be approved)
      * @summary Posts a reaction
-     * @param {string} apiKey API key required for authentication.
      * @param {ReactionReqBody} reactionReqBody
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     postReaction: async (
-      apiKey: string,
       reactionReqBody: ReactionReqBody,
       options: AxiosRequestConfig = {}
     ): Promise<RequestArgs> => {
-      // verify required parameter 'apiKey' is not null or undefined
-      assertParamExists("postReaction", "apiKey", apiKey);
       // verify required parameter 'reactionReqBody' is not null or undefined
       assertParamExists("postReaction", "reactionReqBody", reactionReqBody);
       const localVarPath = `/farcaster/reaction`;
@@ -142,9 +137,12 @@ export const ReactionApiAxiosParamCreator = function (
       const localVarHeaderParameter = {} as any;
       const localVarQueryParameter = {} as any;
 
-      if (apiKey != null) {
-        localVarHeaderParameter["api_key"] = String(apiKey);
-      }
+      // authentication ApiKeyAuth required
+      await setApiKeyToObject(
+        localVarHeaderParameter,
+        "api_key",
+        configuration
+      );
 
       localVarHeaderParameter["Content-Type"] = "application/json";
 
@@ -180,13 +178,11 @@ export const ReactionApiFp = function (configuration?: Configuration) {
     /**
      * Delete a reaction (like or recast) to a given cast \\ (In order to delete a reaction `signer_uuid` must be approved)
      * @summary Delete a reaction
-     * @param {string} apiKey API key required for authentication.
      * @param {ReactionReqBody} reactionReqBody
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     async deleteReaction(
-      apiKey: string,
       reactionReqBody: ReactionReqBody,
       options?: AxiosRequestConfig
     ): Promise<
@@ -196,7 +192,6 @@ export const ReactionApiFp = function (configuration?: Configuration) {
       ) => AxiosPromise<OperationResponse>
     > {
       const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReaction(
-        apiKey,
         reactionReqBody,
         options
       );
@@ -210,13 +205,11 @@ export const ReactionApiFp = function (configuration?: Configuration) {
     /**
      * Post a reaction (like or recast) to a given cast \\ (In order to post a reaction `signer_uuid` must be approved)
      * @summary Posts a reaction
-     * @param {string} apiKey API key required for authentication.
      * @param {ReactionReqBody} reactionReqBody
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     async postReaction(
-      apiKey: string,
       reactionReqBody: ReactionReqBody,
       options?: AxiosRequestConfig
     ): Promise<
@@ -226,7 +219,6 @@ export const ReactionApiFp = function (configuration?: Configuration) {
       ) => AxiosPromise<OperationResponse>
     > {
       const localVarAxiosArgs = await localVarAxiosParamCreator.postReaction(
-        apiKey,
         reactionReqBody,
         options
       );
@@ -254,40 +246,64 @@ export const ReactionApiFactory = function (
     /**
      * Delete a reaction (like or recast) to a given cast \\ (In order to delete a reaction `signer_uuid` must be approved)
      * @summary Delete a reaction
-     * @param {string} apiKey API key required for authentication.
-     * @param {ReactionReqBody} reactionReqBody
+     * @param {ReactionApiDeleteReactionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     deleteReaction(
-      apiKey: string,
-      reactionReqBody: ReactionReqBody,
-      options?: any
+      requestParameters: ReactionApiDeleteReactionRequest,
+      options?: AxiosRequestConfig
     ): AxiosPromise<OperationResponse> {
       return localVarFp
-        .deleteReaction(apiKey, reactionReqBody, options)
+        .deleteReaction(requestParameters.reactionReqBody, options)
         .then((request) => request(axios, basePath));
     },
     /**
      * Post a reaction (like or recast) to a given cast \\ (In order to post a reaction `signer_uuid` must be approved)
      * @summary Posts a reaction
-     * @param {string} apiKey API key required for authentication.
-     * @param {ReactionReqBody} reactionReqBody
+     * @param {ReactionApiPostReactionRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      */
     postReaction(
-      apiKey: string,
-      reactionReqBody: ReactionReqBody,
-      options?: any
+      requestParameters: ReactionApiPostReactionRequest,
+      options?: AxiosRequestConfig
     ): AxiosPromise<OperationResponse> {
       return localVarFp
-        .postReaction(apiKey, reactionReqBody, options)
+        .postReaction(requestParameters.reactionReqBody, options)
         .then((request) => request(axios, basePath));
     },
   };
 };
 
+/**
+ * Request parameters for deleteReaction operation in ReactionApi.
+ * @export
+ * @interface ReactionApiDeleteReactionRequest
+ */
+export interface ReactionApiDeleteReactionRequest {
+  /**
+   *
+   * @type {ReactionReqBody}
+   * @memberof ReactionApiDeleteReaction
+   */
+  readonly reactionReqBody: ReactionReqBody;
+}
+
+/**
+ * Request parameters for postReaction operation in ReactionApi.
+ * @export
+ * @interface ReactionApiPostReactionRequest
+ */
+export interface ReactionApiPostReactionRequest {
+  /**
+   *
+   * @type {ReactionReqBody}
+   * @memberof ReactionApiPostReaction
+   */
+  readonly reactionReqBody: ReactionReqBody;
+}
+
 /**
  * ReactionApi - object-oriented interface
  * @export
@@ -298,38 +314,34 @@ export class ReactionApi extends BaseAPI {
   /**
    * Delete a reaction (like or recast) to a given cast \\ (In order to delete a reaction `signer_uuid` must be approved)
    * @summary Delete a reaction
-   * @param {string} apiKey API key required for authentication.
-   * @param {ReactionReqBody} reactionReqBody
+   * @param {ReactionApiDeleteReactionRequest} requestParameters Request parameters.
    * @param {*} [options] Override http request option.
    * @throws {RequiredError}
    * @memberof ReactionApi
    */
   public deleteReaction(
-    apiKey: string,
-    reactionReqBody: ReactionReqBody,
+    requestParameters: ReactionApiDeleteReactionRequest,
     options?: AxiosRequestConfig
   ) {
     return ReactionApiFp(this.configuration)
-      .deleteReaction(apiKey, reactionReqBody, options)
+      .deleteReaction(requestParameters.reactionReqBody, options)
       .then((request) => request(this.axios, this.basePath));
   }
 
   /**
    * Post a reaction (like or recast) to a given cast \\ (In order to post a reaction `signer_uuid` must be approved)
    * @summary Posts a reaction
-   * @param {string} apiKey API key required for authentication.
-   * @param {ReactionReqBody} reactionReqBody
+   * @param {ReactionApiPostReactionRequest} requestParameters Request parameters.
    * @param {*} [options] Override http request option.
    * @throws {RequiredError}
    * @memberof ReactionApi
    */
   public postReaction(
-    apiKey: string,
-    reactionReqBody: ReactionReqBody,
+    requestParameters: ReactionApiPostReactionRequest,
     options?: AxiosRequestConfig
   ) {
     return ReactionApiFp(this.configuration)
-      .postReaction(apiKey, reactionReqBody, options)
+      .postReaction(requestParameters.reactionReqBody, options)
       .then((request) => request(this.axios, this.basePath));
   }
 }