@neynar/nodejs-sdk 2.46.0 → 3.18.0

package/build/api/apis/subscribers-api.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Farcaster API V2
- * The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
+ * Neynar API
+ * The Neynar API allows you to interact with the Farcaster protocol among other things. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
  *
- * The version of the OpenAPI document: 2.46.0
+ * The version of the OpenAPI document: 3.18.0
  * Contact: team@neynar.com
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -16,7 +16,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.SubscribersApi = exports.SubscribersApiFactory = exports.SubscribersApiFp = exports.SubscribersApiAxiosParamCreator = void 0;
+exports.FetchSubscriptionsForFidSubscriptionProviderEnum = exports.FetchSubscribersForFidSubscriptionProviderEnum = exports.FetchSubscribedToForFidSubscriptionProviderEnum = exports.SubscribersApi = exports.SubscribersApiFactory = exports.SubscribersApiFp = exports.SubscribersApiAxiosParamCreator = void 0;
 const axios_1 = __importDefault(require("axios"));
 // Some imports not used depending on template conditions
 // @ts-ignore
@@ -32,8 +32,8 @@ const SubscribersApiAxiosParamCreator = function (configuration) {
         /**
          * Fetch what FIDs and contracts a FID is subscribed to.
          * @summary Subscribed to
-         * @param {number} fid
-         * @param {SubscriptionProvider} subscriptionProvider
+         * @param {number} fid The unique identifier of a farcaster user or app (unsigned integer)
+         * @param {FetchSubscribedToForFidSubscriptionProviderEnum} subscriptionProvider The provider of the subscription.
          * @param {number} [viewerFid]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -47,7 +47,7 @@ const SubscribersApiAxiosParamCreator = function (configuration) {
             (0, common_1.assertParamExists)('fetchSubscribedToForFid', 'fid', fid);
             // verify required parameter 'subscriptionProvider' is not null or undefined
             (0, common_1.assertParamExists)('fetchSubscribedToForFid', 'subscriptionProvider', subscriptionProvider);
-            const localVarPath = `/farcaster/user/subscribed_to`;
+            const localVarPath = `/v2/farcaster/user/subscribed_to/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -79,8 +79,8 @@ const SubscribersApiAxiosParamCreator = function (configuration) {
         /**
          * Fetch subscribers for a given FID\'s contracts. Doesn\'t return addresses that don\'t have an FID.
          * @summary Subscribers of a user
-         * @param {number} fid
-         * @param {SubscriptionProviders} subscriptionProvider
+         * @param {number} fid The unique identifier of a farcaster user or app (unsigned integer)
+         * @param {FetchSubscribersForFidSubscriptionProviderEnum} subscriptionProvider The provider of the subscription.
          * @param {number} [viewerFid]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -94,7 +94,7 @@ const SubscribersApiAxiosParamCreator = function (configuration) {
             (0, common_1.assertParamExists)('fetchSubscribersForFid', 'fid', fid);
             // verify required parameter 'subscriptionProvider' is not null or undefined
             (0, common_1.assertParamExists)('fetchSubscribersForFid', 'subscriptionProvider', subscriptionProvider);
-            const localVarPath = `/farcaster/user/subscribers`;
+            const localVarPath = `/v2/farcaster/user/subscribers/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -143,7 +143,7 @@ const SubscribersApiAxiosParamCreator = function (configuration) {
             (0, common_1.assertParamExists)('fetchSubscriptionCheck', 'contractAddress', contractAddress);
             // verify required parameter 'chainId' is not null or undefined
             (0, common_1.assertParamExists)('fetchSubscriptionCheck', 'chainId', chainId);
-            const localVarPath = `/stp/subscription_check`;
+            const localVarPath = `/v2/stp/subscription_check/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -175,8 +175,8 @@ const SubscribersApiAxiosParamCreator = function (configuration) {
         /**
          * Fetch created subscriptions for a given FID\'s.
          * @summary Subscriptions created by FID
-         * @param {number} fid
-         * @param {SubscriptionProvider} subscriptionProvider
+         * @param {number} fid The unique identifier of a farcaster user or app (unsigned integer)
+         * @param {FetchSubscriptionsForFidSubscriptionProviderEnum} subscriptionProvider The provider of the subscription.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<SubscriptionsResponse>} A promise that resolves to a `SubscriptionsResponse` object
@@ -189,7 +189,7 @@ const SubscribersApiAxiosParamCreator = function (configuration) {
             (0, common_1.assertParamExists)('fetchSubscriptionsForFid', 'fid', fid);
             // verify required parameter 'subscriptionProvider' is not null or undefined
             (0, common_1.assertParamExists)('fetchSubscriptionsForFid', 'subscriptionProvider', subscriptionProvider);
-            const localVarPath = `/farcaster/user/subscriptions_created`;
+            const localVarPath = `/v2/farcaster/user/subscriptions_created/`;
             // use dummy base URL string because the URL constructor only accepts absolute URLs.
             const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
             let baseOptions;
@@ -228,8 +228,8 @@ const SubscribersApiFp = function (configuration) {
         /**
          * Fetch what FIDs and contracts a FID is subscribed to.
          * @summary Subscribed to
-         * @param {number} fid
-         * @param {SubscriptionProvider} subscriptionProvider
+         * @param {number} fid The unique identifier of a farcaster user or app (unsigned integer)
+         * @param {FetchSubscribedToForFidSubscriptionProviderEnum} subscriptionProvider The provider of the subscription.
          * @param {number} [viewerFid]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -248,8 +248,8 @@ const SubscribersApiFp = function (configuration) {
         /**
          * Fetch subscribers for a given FID\'s contracts. Doesn\'t return addresses that don\'t have an FID.
          * @summary Subscribers of a user
-         * @param {number} fid
-         * @param {SubscriptionProviders} subscriptionProvider
+         * @param {number} fid The unique identifier of a farcaster user or app (unsigned integer)
+         * @param {FetchSubscribersForFidSubscriptionProviderEnum} subscriptionProvider The provider of the subscription.
          * @param {number} [viewerFid]
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
@@ -288,8 +288,8 @@ const SubscribersApiFp = function (configuration) {
         /**
          * Fetch created subscriptions for a given FID\'s.
          * @summary Subscriptions created by FID
-         * @param {number} fid
-         * @param {SubscriptionProvider} subscriptionProvider
+         * @param {number} fid The unique identifier of a farcaster user or app (unsigned integer)
+         * @param {FetchSubscriptionsForFidSubscriptionProviderEnum} subscriptionProvider The provider of the subscription.
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          * @returns {Promise<SubscriptionsResponse>} A promise that resolves to a `SubscriptionsResponse` object
@@ -442,3 +442,22 @@ class SubscribersApi extends base_1.BaseAPI {
     }
 }
 exports.SubscribersApi = SubscribersApi;
+/**
+ * @export
+ */
+exports.FetchSubscribedToForFidSubscriptionProviderEnum = {
+    FabricStp: 'fabric_stp'
+};
+/**
+ * @export
+ */
+exports.FetchSubscribersForFidSubscriptionProviderEnum = {
+    FabricStp: 'fabric_stp',
+    Paragraph: 'paragraph'
+};
+/**
+ * @export
+ */
+exports.FetchSubscriptionsForFidSubscriptionProviderEnum = {
+    FabricStp: 'fabric_stp'
+};