@neynar/nodejs-sdk 2.44.0 → 3.18.0

package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner-stats.d.ts

@@ -0,0 +1,72 @@
+/**
+ * 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: 3.18.0
+ * Contact: team@neynar.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats
+ */
+export interface GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats {
+    /**
+     * The total number of notification tokens for intended recipients.
+     * @type {number}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats
+     */
+    'intended_recipient_notification_token_count': number | null;
+    /**
+     * An array of Farcaster FIDs of intended recipient applications.
+     * @type {Array<number>}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats
+     */
+    'intended_recipient_app_fids': Array<number>;
+    /**
+     * The number of notifications successfully sent.
+     * @type {number}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats
+     */
+    'successful_sends': number | null;
+    /**
+     * A record mapping app FIDs (as strings) to the number of successful sends for that app.
+     * @type {{ [key: string]: number; }}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats
+     */
+    'successful_sends_by_app_fid': {
+        [key: string]: number;
+    };
+    /**
+     * The total number of times notifications from this campaign have been opened.
+     * @type {number}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats
+     */
+    'total_opens': number | null;
+    /**
+     * A record mapping app FIDs (as strings) to the number of opens for that app.
+     * @type {{ [key: string]: number; }}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats
+     */
+    'total_opens_by_app_fid': {
+        [key: string]: number;
+    };
+    /**
+     * The number of unique recipients who opened a notification from this campaign.
+     * @type {number}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats
+     */
+    'unique_opens': number | null;
+    /**
+     * A record mapping app FIDs (as strings) to the number of unique opens for that app.
+     * @type {{ [key: string]: number; }}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats
+     */
+    'unique_opens_by_app_fid': {
+        [key: string]: number;
+    };
+}

package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner-stats.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: 3.18.0
+ * Contact: team@neynar.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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: 3.18.0
+ * Contact: team@neynar.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats } from './get-notification-campaign-stats200-response-notification-campaigns-inner-stats';
+/**
+ *
+ * @export
+ * @interface GetNotificationCampaignStats200ResponseNotificationCampaignsInner
+ */
+export interface GetNotificationCampaignStats200ResponseNotificationCampaignsInner {
+    /**
+     * The unique identifier for the notification campaign.
+     * @type {string}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInner
+     */
+    'id': string;
+    /**
+     * The title of the notification campaign.
+     * @type {string}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInner
+     */
+    'title': string;
+    /**
+     * The body text of the notification.
+     * @type {string}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInner
+     */
+    'body': string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInner
+     */
+    'created_at': string;
+    /**
+     *
+     * @type {GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats}
+     * @memberof GetNotificationCampaignStats200ResponseNotificationCampaignsInner
+     */
+    'stats': GetNotificationCampaignStats200ResponseNotificationCampaignsInnerStats;
+}

package/build/api/models/get-notification-campaign-stats200-response-notification-campaigns-inner.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: 3.18.0
+ * Contact: team@neynar.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/api/models/get-notification-campaign-stats200-response.d.ts

@@ -0,0 +1,32 @@
+/**
+ * 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: 3.18.0
+ * Contact: team@neynar.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { GetNotificationCampaignStats200ResponseNotificationCampaignsInner } from './get-notification-campaign-stats200-response-notification-campaigns-inner';
+import type { NextCursor } from './next-cursor';
+/**
+ *
+ * @export
+ * @interface GetNotificationCampaignStats200Response
+ */
+export interface GetNotificationCampaignStats200Response {
+    /**
+     *
+     * @type {Array<GetNotificationCampaignStats200ResponseNotificationCampaignsInner>}
+     * @memberof GetNotificationCampaignStats200Response
+     */
+    'notificationCampaigns': Array<GetNotificationCampaignStats200ResponseNotificationCampaignsInner>;
+    /**
+     *
+     * @type {NextCursor}
+     * @memberof GetNotificationCampaignStats200Response
+     */
+    'next': NextCursor;
+}

package/build/api/models/get-notification-campaign-stats200-response.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: 3.18.0
+ * Contact: team@neynar.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/api/models/{html-metadata-all-of-oembed.d.ts → html-metadata-oembed.d.ts}

@@ -1,8 +1,8 @@
 /**
- * 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.44.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).
@@ -14,10 +14,10 @@ import type { OembedPhotoData } from './oembed-photo-data';
 import type { OembedRichData } from './oembed-rich-data';
 import type { OembedVideoData } from './oembed-video-data';
 /**
- * @type HtmlMetadataAllOfOembed
+ * @type HtmlMetadataOembed
  * @export
  */
-export type HtmlMetadataAllOfOembed = {
+export type HtmlMetadataOembed = {
     type: 'link';
 } & OembedLinkData | {
     type: 'photo';

package/build/api/models/html-metadata-oembed.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * 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: 3.18.0
+ * Contact: team@neynar.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });

package/build/api/models/html-metadata.d.ts

@@ -1,18 +1,321 @@
 /**
- * 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.44.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).
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { HtmlMetadataAllOf } from './html-metadata-all-of';
-import type { OgObject } from './og-object';
+import type { HtmlMetadataOembed } from './html-metadata-oembed';
+import type { ImageObject } from './image-object';
+import type { VideoObject } from './video-object';
 /**
- * @type HtmlMetadata
+ *
  * @export
+ * @interface HtmlMetadata
  */
-export type HtmlMetadata = HtmlMetadataAllOf & OgObject;
+export interface HtmlMetadata {
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'favicon'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'modifiedTime'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogArticleAuthor'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogArticleExpirationTime'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogArticleModifiedTime'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogArticlePublishedTime'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogArticlePublisher'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogArticleSection'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogArticleTag'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogAudio'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogAudioSecureURL'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogAudioType'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogAudioURL'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogAvailability'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogDate'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogDescription'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogDeterminer'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogEpisode'?: string;
+    /**
+     *
+     * @type {Array<ImageObject>}
+     * @memberof HtmlMetadata
+     */
+    'ogImage'?: Array<ImageObject>;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogLocale'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogLocaleAlternate'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogLogo'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogMovie'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogPriceAmount'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogPriceCurrency'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogProductAvailability'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogProductCondition'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogProductPriceAmount'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogProductPriceCurrency'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogProductRetailerItemId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogSiteName'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogTitle'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogType'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogUrl'?: string;
+    /**
+     *
+     * @type {Array<VideoObject>}
+     * @memberof HtmlMetadata
+     */
+    'ogVideo'?: Array<VideoObject>;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoActor'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoActorId'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoActorRole'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoDirector'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoDuration'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoOther'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoReleaseDate'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoSecureURL'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoSeries'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoTag'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoTvShow'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogVideoWriter'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'ogWebsite'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof HtmlMetadata
+     */
+    'updatedTime'?: string;
+    /**
+     *
+     * @type {HtmlMetadataOembed}
+     * @memberof HtmlMetadata
+     */
+    'oembed'?: HtmlMetadataOembed;
+}

package/build/api/models/html-metadata.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.44.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).

package/build/api/models/image-object.d.ts

@@ -1,8 +1,8 @@
 /**
- * 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.44.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).

package/build/api/models/image-object.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.44.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).