diff --git a/src/neynar-api/v2/openapi-farcaster/.openapi-generator/FILES b/src/neynar-api/v2/openapi-farcaster/.openapi-generator/FILES index 2374ba5c..006abf85 100644 --- a/src/neynar-api/v2/openapi-farcaster/.openapi-generator/FILES +++ b/src/neynar-api/v2/openapi-farcaster/.openapi-generator/FILES @@ -50,11 +50,8 @@ models/cast-notification-type.ts models/cast-param-type.ts models/cast-response.ts models/cast-viewer-context.ts -models/cast-with-interactions-and-conversations-any-of.ts -models/cast-with-interactions-and-conversations-ref-any-of.ts models/cast-with-interactions-and-conversations-ref.ts models/cast-with-interactions-and-conversations.ts -models/cast-with-interactions-any-of.ts models/cast-with-interactions-reactions.ts models/cast-with-interactions-replies.ts models/cast-with-interactions.ts @@ -95,8 +92,7 @@ models/embed-cast-deep.ts models/embed-cast.ts models/embed-deep.ts models/embed-type.ts -models/embed-url-metadata-html-any-of-oembed.ts -models/embed-url-metadata-html-any-of.ts +models/embed-url-metadata-html-all-of-oembed.ts models/embed-url-metadata-html.ts models/embed-url-metadata-image.ts models/embed-url-metadata-video-stream-inner.ts @@ -170,13 +166,9 @@ models/notification-type.ts models/notification.ts models/notifications-response.ts models/oembed-data.ts -models/oembed-link-data-any-of.ts models/oembed-link-data.ts -models/oembed-photo-data-any-of.ts models/oembed-photo-data.ts -models/oembed-rich-data-any-of.ts models/oembed-rich-data.ts -models/oembed-video-data-any-of.ts models/oembed-video-data.ts models/og-object.ts models/operation-response.ts @@ -212,7 +204,6 @@ models/storage-allocation.ts models/storage-allocations-response.ts models/storage-object.ts models/storage-usage-response.ts -models/subscribed-to-any-of.ts models/subscribed-to-object.ts models/subscribed-to-response.ts models/subscribed-to.ts @@ -260,7 +251,6 @@ models/webhook-delete-req-body.ts models/webhook-list-response.ts models/webhook-patch-req-body.ts models/webhook-post-req-body.ts -models/webhook-put-req-body-any-of.ts models/webhook-put-req-body.ts models/webhook-response.ts models/webhook-secret.ts diff --git a/src/neynar-api/v2/openapi-farcaster/apis/action-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/action-api.ts index 80e874d2..620a7d1c 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/action-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/action-api.ts @@ -32,11 +32,14 @@ export const ActionApiAxiosParamCreator = function (configuration?: Configuratio /** * Securely communicate and perform actions on behalf of users across different apps. It enables an app to send data or trigger actions in another app on behalf of a mutual user by signing messages using the user\'s Farcaster signer. * @summary User actions across apps + * @param {string} apiKey API key required for authentication. * @param {FarcasterActionReqBody} farcasterActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - publishFarcasterAction: async (farcasterActionReqBody: FarcasterActionReqBody, options: RawAxiosRequestConfig = {}): Promise => { + publishFarcasterAction: async (apiKey: string, farcasterActionReqBody: FarcasterActionReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('publishFarcasterAction', 'apiKey', apiKey) // verify required parameter 'farcasterActionReqBody' is not null or undefined assertParamExists('publishFarcasterAction', 'farcasterActionReqBody', farcasterActionReqBody) const localVarPath = `/farcaster/action`; @@ -54,6 +57,10 @@ export const ActionApiAxiosParamCreator = function (configuration?: Configuratio // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -81,12 +88,13 @@ export const ActionApiFp = function(configuration?: Configuration) { /** * Securely communicate and perform actions on behalf of users across different apps. It enables an app to send data or trigger actions in another app on behalf of a mutual user by signing messages using the user\'s Farcaster signer. * @summary User actions across apps + * @param {string} apiKey API key required for authentication. * @param {FarcasterActionReqBody} farcasterActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async publishFarcasterAction(farcasterActionReqBody: FarcasterActionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.publishFarcasterAction(farcasterActionReqBody, options); + async publishFarcasterAction(apiKey: string, farcasterActionReqBody: FarcasterActionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.publishFarcasterAction(apiKey, farcasterActionReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ActionApi.publishFarcasterAction']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -104,12 +112,13 @@ export const ActionApiFactory = function (configuration?: Configuration, basePat /** * Securely communicate and perform actions on behalf of users across different apps. It enables an app to send data or trigger actions in another app on behalf of a mutual user by signing messages using the user\'s Farcaster signer. * @summary User actions across apps + * @param {string} apiKey API key required for authentication. * @param {FarcasterActionReqBody} farcasterActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - publishFarcasterAction(farcasterActionReqBody: FarcasterActionReqBody, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> { - return localVarFp.publishFarcasterAction(farcasterActionReqBody, options).then((request) => request(axios, basePath)); + publishFarcasterAction(apiKey: string, farcasterActionReqBody: FarcasterActionReqBody, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: any; }> { + return localVarFp.publishFarcasterAction(apiKey, farcasterActionReqBody, options).then((request) => request(axios, basePath)); }, }; }; @@ -124,13 +133,14 @@ export class ActionApi extends BaseAPI { /** * Securely communicate and perform actions on behalf of users across different apps. It enables an app to send data or trigger actions in another app on behalf of a mutual user by signing messages using the user\'s Farcaster signer. * @summary User actions across apps + * @param {string} apiKey API key required for authentication. * @param {FarcasterActionReqBody} farcasterActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ActionApi */ - public publishFarcasterAction(farcasterActionReqBody: FarcasterActionReqBody, options?: RawAxiosRequestConfig) { - return ActionApiFp(this.configuration).publishFarcasterAction(farcasterActionReqBody, options).then((request) => request(this.axios, this.basePath)); + public publishFarcasterAction(apiKey: string, farcasterActionReqBody: FarcasterActionReqBody, options?: RawAxiosRequestConfig) { + return ActionApiFp(this.configuration).publishFarcasterAction(apiKey, farcasterActionReqBody, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/ban-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/ban-api.ts index d7d808be..21187d75 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/ban-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/ban-api.ts @@ -38,11 +38,14 @@ export const BanApiAxiosParamCreator = function (configuration?: Configuration) /** * Bans a list of FIDs from the app associated with your API key. Banned users, their casts and reactions will not appear in feeds. * @summary Ban FIDs from app + * @param {string} apiKey API key required for authentication. * @param {BanReqBody} banReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addBan: async (banReqBody: BanReqBody, options: RawAxiosRequestConfig = {}): Promise => { + addBan: async (apiKey: string, banReqBody: BanReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('addBan', 'apiKey', apiKey) // verify required parameter 'banReqBody' is not null or undefined assertParamExists('addBan', 'banReqBody', banReqBody) const localVarPath = `/farcaster/ban`; @@ -60,6 +63,10 @@ export const BanApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -77,12 +84,15 @@ export const BanApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetches all FIDs that your app has banned. * @summary Banned FIDs of app + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - banList: async (limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + banList: async (apiKey: string, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('banList', 'apiKey', apiKey) const localVarPath = `/farcaster/ban/list`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -106,6 +116,10 @@ export const BanApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -120,11 +134,14 @@ export const BanApiAxiosParamCreator = function (configuration?: Configuration) /** * Deletes a list of FIDs from the app associated with your API key. * @summary Unban FIDs from app + * @param {string} apiKey API key required for authentication. * @param {BanReqBody} banReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteBan: async (banReqBody: BanReqBody, options: RawAxiosRequestConfig = {}): Promise => { + deleteBan: async (apiKey: string, banReqBody: BanReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('deleteBan', 'apiKey', apiKey) // verify required parameter 'banReqBody' is not null or undefined assertParamExists('deleteBan', 'banReqBody', banReqBody) const localVarPath = `/farcaster/ban`; @@ -142,6 +159,10 @@ export const BanApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -169,12 +190,13 @@ export const BanApiFp = function(configuration?: Configuration) { /** * Bans a list of FIDs from the app associated with your API key. Banned users, their casts and reactions will not appear in feeds. * @summary Ban FIDs from app + * @param {string} apiKey API key required for authentication. * @param {BanReqBody} banReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async addBan(banReqBody: BanReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addBan(banReqBody, options); + async addBan(apiKey: string, banReqBody: BanReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addBan(apiKey, banReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['BanApi.addBan']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -182,13 +204,14 @@ export const BanApiFp = function(configuration?: Configuration) { /** * Fetches all FIDs that your app has banned. * @summary Banned FIDs of app + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async banList(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.banList(limit, cursor, options); + async banList(apiKey: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.banList(apiKey, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['BanApi.banList']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -196,12 +219,13 @@ export const BanApiFp = function(configuration?: Configuration) { /** * Deletes a list of FIDs from the app associated with your API key. * @summary Unban FIDs from app + * @param {string} apiKey API key required for authentication. * @param {BanReqBody} banReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteBan(banReqBody: BanReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBan(banReqBody, options); + async deleteBan(apiKey: string, banReqBody: BanReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteBan(apiKey, banReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['BanApi.deleteBan']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -219,33 +243,36 @@ export const BanApiFactory = function (configuration?: Configuration, basePath?: /** * Bans a list of FIDs from the app associated with your API key. Banned users, their casts and reactions will not appear in feeds. * @summary Ban FIDs from app + * @param {string} apiKey API key required for authentication. * @param {BanReqBody} banReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addBan(banReqBody: BanReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addBan(banReqBody, options).then((request) => request(axios, basePath)); + addBan(apiKey: string, banReqBody: BanReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.addBan(apiKey, banReqBody, options).then((request) => request(axios, basePath)); }, /** * Fetches all FIDs that your app has banned. * @summary Banned FIDs of app + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - banList(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.banList(limit, cursor, options).then((request) => request(axios, basePath)); + banList(apiKey: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.banList(apiKey, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Deletes a list of FIDs from the app associated with your API key. * @summary Unban FIDs from app + * @param {string} apiKey API key required for authentication. * @param {BanReqBody} banReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteBan(banReqBody: BanReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteBan(banReqBody, options).then((request) => request(axios, basePath)); + deleteBan(apiKey: string, banReqBody: BanReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteBan(apiKey, banReqBody, options).then((request) => request(axios, basePath)); }, }; }; @@ -260,38 +287,41 @@ export class BanApi extends BaseAPI { /** * Bans a list of FIDs from the app associated with your API key. Banned users, their casts and reactions will not appear in feeds. * @summary Ban FIDs from app + * @param {string} apiKey API key required for authentication. * @param {BanReqBody} banReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BanApi */ - public addBan(banReqBody: BanReqBody, options?: RawAxiosRequestConfig) { - return BanApiFp(this.configuration).addBan(banReqBody, options).then((request) => request(this.axios, this.basePath)); + public addBan(apiKey: string, banReqBody: BanReqBody, options?: RawAxiosRequestConfig) { + return BanApiFp(this.configuration).addBan(apiKey, banReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches all FIDs that your app has banned. * @summary Banned FIDs of app + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BanApi */ - public banList(limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return BanApiFp(this.configuration).banList(limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public banList(apiKey: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return BanApiFp(this.configuration).banList(apiKey, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Deletes a list of FIDs from the app associated with your API key. * @summary Unban FIDs from app + * @param {string} apiKey API key required for authentication. * @param {BanReqBody} banReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof BanApi */ - public deleteBan(banReqBody: BanReqBody, options?: RawAxiosRequestConfig) { - return BanApiFp(this.configuration).deleteBan(banReqBody, options).then((request) => request(this.axios, this.basePath)); + public deleteBan(apiKey: string, banReqBody: BanReqBody, options?: RawAxiosRequestConfig) { + return BanApiFp(this.configuration).deleteBan(apiKey, banReqBody, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/block-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/block-api.ts index 8514c92a..9d1aba24 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/block-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/block-api.ts @@ -34,6 +34,7 @@ export const BlockApiAxiosParamCreator = function (configuration?: Configuration /** * Fetches all FIDs that a user has blocked or has been blocked by * @summary Blocked / Blocked by FIDs + * @param {string} apiKey API key required for authentication. * @param {number} [blockerFid] Providing this will return the users that this user has blocked * @param {number} [blockedFid] Providing this will return the users that have blocked this user * @param {number} [limit] Number of results to fetch (default 20, max 100). @@ -41,7 +42,9 @@ export const BlockApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - blockList: async (blockerFid?: number, blockedFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + blockList: async (apiKey: string, blockerFid?: number, blockedFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('blockList', 'apiKey', apiKey) const localVarPath = `/farcaster/block/list`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -73,6 +76,10 @@ export const BlockApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -97,6 +104,7 @@ export const BlockApiFp = function(configuration?: Configuration) { /** * Fetches all FIDs that a user has blocked or has been blocked by * @summary Blocked / Blocked by FIDs + * @param {string} apiKey API key required for authentication. * @param {number} [blockerFid] Providing this will return the users that this user has blocked * @param {number} [blockedFid] Providing this will return the users that have blocked this user * @param {number} [limit] Number of results to fetch (default 20, max 100). @@ -104,8 +112,8 @@ export const BlockApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async blockList(blockerFid?: number, blockedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.blockList(blockerFid, blockedFid, limit, cursor, options); + async blockList(apiKey: string, blockerFid?: number, blockedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.blockList(apiKey, blockerFid, blockedFid, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['BlockApi.blockList']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -123,6 +131,7 @@ export const BlockApiFactory = function (configuration?: Configuration, basePath /** * Fetches all FIDs that a user has blocked or has been blocked by * @summary Blocked / Blocked by FIDs + * @param {string} apiKey API key required for authentication. * @param {number} [blockerFid] Providing this will return the users that this user has blocked * @param {number} [blockedFid] Providing this will return the users that have blocked this user * @param {number} [limit] Number of results to fetch (default 20, max 100). @@ -130,8 +139,8 @@ export const BlockApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - blockList(blockerFid?: number, blockedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.blockList(blockerFid, blockedFid, limit, cursor, options).then((request) => request(axios, basePath)); + blockList(apiKey: string, blockerFid?: number, blockedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.blockList(apiKey, blockerFid, blockedFid, limit, cursor, options).then((request) => request(axios, basePath)); }, }; }; @@ -146,6 +155,7 @@ export class BlockApi extends BaseAPI { /** * Fetches all FIDs that a user has blocked or has been blocked by * @summary Blocked / Blocked by FIDs + * @param {string} apiKey API key required for authentication. * @param {number} [blockerFid] Providing this will return the users that this user has blocked * @param {number} [blockedFid] Providing this will return the users that have blocked this user * @param {number} [limit] Number of results to fetch (default 20, max 100). @@ -154,8 +164,8 @@ export class BlockApi extends BaseAPI { * @throws {RequiredError} * @memberof BlockApi */ - public blockList(blockerFid?: number, blockedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return BlockApiFp(this.configuration).blockList(blockerFid, blockedFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public blockList(apiKey: string, blockerFid?: number, blockedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return BlockApiFp(this.configuration).blockList(apiKey, blockerFid, blockedFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/cast-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/cast-api.ts index 7cc008dc..061d3b12 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/cast-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/cast-api.ts @@ -56,13 +56,16 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) /** * Gets information about an individual cast by passing in a Warpcast web URL or cast hash * @summary By hash or URL + * @param {string} apiKey API key required for authentication. * @param {string} identifier Cast identifier (Its either a url or a hash) * @param {CastParamType} type * @param {number} [viewerFid] adds viewer_context to cast object to show whether viewer has liked or recasted the cast. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cast: async (identifier: string, type: CastParamType, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + cast: async (apiKey: string, identifier: string, type: CastParamType, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('cast', 'apiKey', apiKey) // verify required parameter 'identifier' is not null or undefined assertParamExists('cast', 'identifier', identifier) // verify required parameter 'type' is not null or undefined @@ -94,6 +97,10 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['viewer_fid'] = viewerFid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -108,6 +115,7 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) /** * Gets all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL. Includes all the ancestors of a cast up to the root parent in a chronological order. Includes all direct_replies to the cast up to the reply_depth specified in the query parameter. * @summary Conversation for a cast + * @param {string} apiKey API key required for authentication. * @param {string} identifier Cast identifier (Its either a url or a hash) * @param {CastParamType} type * @param {number} [replyDepth] The depth of replies in the conversation that will be returned (default 2) @@ -120,7 +128,9 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - castConversation: async (identifier: string, type: CastParamType, replyDepth?: number, includeChronologicalParentCasts?: boolean, viewerFid?: number, sortType?: CastConversationSortType, fold?: CastConversationFoldEnum, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + castConversation: async (apiKey: string, identifier: string, type: CastParamType, replyDepth?: number, includeChronologicalParentCasts?: boolean, viewerFid?: number, sortType?: CastConversationSortType, fold?: CastConversationFoldEnum, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('castConversation', 'apiKey', apiKey) // verify required parameter 'identifier' is not null or undefined assertParamExists('castConversation', 'identifier', identifier) // verify required parameter 'type' is not null or undefined @@ -176,6 +186,10 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -190,6 +204,7 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) /** * Search for casts based on a query string, with optional AND filters * @summary Search for casts + * @param {string} apiKey API key required for authentication. * @param {string} q Query string to search for casts * @param {number} [authorFid] Fid of the user whose casts you want to search * @param {number} [viewerFid] Providing this will return search results that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -201,7 +216,9 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - castSearch: async (q: string, authorFid?: number, viewerFid?: number, parentUrl?: string, channelId?: string, priorityMode?: boolean, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + castSearch: async (apiKey: string, q: string, authorFid?: number, viewerFid?: number, parentUrl?: string, channelId?: string, priorityMode?: boolean, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('castSearch', 'apiKey', apiKey) // verify required parameter 'q' is not null or undefined assertParamExists('castSearch', 'q', q) const localVarPath = `/farcaster/cast/search`; @@ -251,6 +268,10 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -265,13 +286,16 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetch multiple casts using their respective hashes. * @summary Bulk fetch casts + * @param {string} apiKey API key required for authentication. * @param {string} casts Hashes of the cast to be retrived (Comma separated, no spaces) * @param {number} [viewerFid] adds viewer_context to cast object to show whether viewer has liked or recasted the cast. * @param {CastsSortTypeEnum} [sortType] Optional parameter to sort the casts based on different criteria * @param {*} [options] Override http request option. * @throws {RequiredError} */ - casts: async (casts: string, viewerFid?: number, sortType?: CastsSortTypeEnum, options: RawAxiosRequestConfig = {}): Promise => { + casts: async (apiKey: string, casts: string, viewerFid?: number, sortType?: CastsSortTypeEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('casts', 'apiKey', apiKey) // verify required parameter 'casts' is not null or undefined assertParamExists('casts', 'casts', casts) const localVarPath = `/farcaster/casts`; @@ -301,6 +325,10 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['sort_type'] = sortType; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -315,13 +343,16 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetches all composer actions on Warpcast. You can filter by top or featured. * @summary Fetch composer actions + * @param {string} apiKey API key required for authentication. * @param {CastComposerType} list Type of list to fetch. * @param {number} [limit] Number of results to fetch (default 25, max 25). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - composerList: async (list: CastComposerType, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + composerList: async (apiKey: string, list: CastComposerType, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('composerList', 'apiKey', apiKey) // verify required parameter 'list' is not null or undefined assertParamExists('composerList', 'list', list) const localVarPath = `/farcaster/cast/composer_actions/list`; @@ -351,6 +382,10 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -365,11 +400,14 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) /** * Delete an existing cast. \\ (In order to delete a cast `signer_uuid` must be approved) * @summary Delete a cast + * @param {string} apiKey API key required for authentication. * @param {DeleteCastReqBody} deleteCastReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteCast: async (deleteCastReqBody: DeleteCastReqBody, options: RawAxiosRequestConfig = {}): Promise => { + deleteCast: async (apiKey: string, deleteCastReqBody: DeleteCastReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('deleteCast', 'apiKey', apiKey) // verify required parameter 'deleteCastReqBody' is not null or undefined assertParamExists('deleteCast', 'deleteCastReqBody', deleteCastReqBody) const localVarPath = `/farcaster/cast`; @@ -387,6 +425,10 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -404,11 +446,14 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) /** * Posts a cast or cast reply. Works with mentions and embeds. (In order to post a cast `signer_uuid` must be approved) * @summary Post a cast + * @param {string} apiKey API key required for authentication. * @param {PostCastReqBody} postCastReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postCast: async (postCastReqBody: PostCastReqBody, options: RawAxiosRequestConfig = {}): Promise => { + postCast: async (apiKey: string, postCastReqBody: PostCastReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('postCast', 'apiKey', apiKey) // verify required parameter 'postCastReqBody' is not null or undefined assertParamExists('postCast', 'postCastReqBody', postCastReqBody) const localVarPath = `/farcaster/cast`; @@ -426,6 +471,10 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -453,14 +502,15 @@ export const CastApiFp = function(configuration?: Configuration) { /** * Gets information about an individual cast by passing in a Warpcast web URL or cast hash * @summary By hash or URL + * @param {string} apiKey API key required for authentication. * @param {string} identifier Cast identifier (Its either a url or a hash) * @param {CastParamType} type * @param {number} [viewerFid] adds viewer_context to cast object to show whether viewer has liked or recasted the cast. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async cast(identifier: string, type: CastParamType, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.cast(identifier, type, viewerFid, options); + async cast(apiKey: string, identifier: string, type: CastParamType, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.cast(apiKey, identifier, type, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CastApi.cast']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -468,6 +518,7 @@ export const CastApiFp = function(configuration?: Configuration) { /** * Gets all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL. Includes all the ancestors of a cast up to the root parent in a chronological order. Includes all direct_replies to the cast up to the reply_depth specified in the query parameter. * @summary Conversation for a cast + * @param {string} apiKey API key required for authentication. * @param {string} identifier Cast identifier (Its either a url or a hash) * @param {CastParamType} type * @param {number} [replyDepth] The depth of replies in the conversation that will be returned (default 2) @@ -480,8 +531,8 @@ export const CastApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async castConversation(identifier: string, type: CastParamType, replyDepth?: number, includeChronologicalParentCasts?: boolean, viewerFid?: number, sortType?: CastConversationSortType, fold?: CastConversationFoldEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.castConversation(identifier, type, replyDepth, includeChronologicalParentCasts, viewerFid, sortType, fold, limit, cursor, options); + async castConversation(apiKey: string, identifier: string, type: CastParamType, replyDepth?: number, includeChronologicalParentCasts?: boolean, viewerFid?: number, sortType?: CastConversationSortType, fold?: CastConversationFoldEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.castConversation(apiKey, identifier, type, replyDepth, includeChronologicalParentCasts, viewerFid, sortType, fold, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CastApi.castConversation']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -489,6 +540,7 @@ export const CastApiFp = function(configuration?: Configuration) { /** * Search for casts based on a query string, with optional AND filters * @summary Search for casts + * @param {string} apiKey API key required for authentication. * @param {string} q Query string to search for casts * @param {number} [authorFid] Fid of the user whose casts you want to search * @param {number} [viewerFid] Providing this will return search results that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -500,8 +552,8 @@ export const CastApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async castSearch(q: string, authorFid?: number, viewerFid?: number, parentUrl?: string, channelId?: string, priorityMode?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.castSearch(q, authorFid, viewerFid, parentUrl, channelId, priorityMode, limit, cursor, options); + async castSearch(apiKey: string, q: string, authorFid?: number, viewerFid?: number, parentUrl?: string, channelId?: string, priorityMode?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.castSearch(apiKey, q, authorFid, viewerFid, parentUrl, channelId, priorityMode, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CastApi.castSearch']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -509,14 +561,15 @@ export const CastApiFp = function(configuration?: Configuration) { /** * Fetch multiple casts using their respective hashes. * @summary Bulk fetch casts + * @param {string} apiKey API key required for authentication. * @param {string} casts Hashes of the cast to be retrived (Comma separated, no spaces) * @param {number} [viewerFid] adds viewer_context to cast object to show whether viewer has liked or recasted the cast. * @param {CastsSortTypeEnum} [sortType] Optional parameter to sort the casts based on different criteria * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async casts(casts: string, viewerFid?: number, sortType?: CastsSortTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.casts(casts, viewerFid, sortType, options); + async casts(apiKey: string, casts: string, viewerFid?: number, sortType?: CastsSortTypeEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.casts(apiKey, casts, viewerFid, sortType, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CastApi.casts']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -524,14 +577,15 @@ export const CastApiFp = function(configuration?: Configuration) { /** * Fetches all composer actions on Warpcast. You can filter by top or featured. * @summary Fetch composer actions + * @param {string} apiKey API key required for authentication. * @param {CastComposerType} list Type of list to fetch. * @param {number} [limit] Number of results to fetch (default 25, max 25). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async composerList(list: CastComposerType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.composerList(list, limit, cursor, options); + async composerList(apiKey: string, list: CastComposerType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.composerList(apiKey, list, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CastApi.composerList']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -539,12 +593,13 @@ export const CastApiFp = function(configuration?: Configuration) { /** * Delete an existing cast. \\ (In order to delete a cast `signer_uuid` must be approved) * @summary Delete a cast + * @param {string} apiKey API key required for authentication. * @param {DeleteCastReqBody} deleteCastReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteCast(deleteCastReqBody: DeleteCastReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCast(deleteCastReqBody, options); + async deleteCast(apiKey: string, deleteCastReqBody: DeleteCastReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteCast(apiKey, deleteCastReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CastApi.deleteCast']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -552,12 +607,13 @@ export const CastApiFp = function(configuration?: Configuration) { /** * Posts a cast or cast reply. Works with mentions and embeds. (In order to post a cast `signer_uuid` must be approved) * @summary Post a cast + * @param {string} apiKey API key required for authentication. * @param {PostCastReqBody} postCastReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async postCast(postCastReqBody: PostCastReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.postCast(postCastReqBody, options); + async postCast(apiKey: string, postCastReqBody: PostCastReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postCast(apiKey, postCastReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['CastApi.postCast']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -575,18 +631,20 @@ export const CastApiFactory = function (configuration?: Configuration, basePath? /** * Gets information about an individual cast by passing in a Warpcast web URL or cast hash * @summary By hash or URL + * @param {string} apiKey API key required for authentication. * @param {string} identifier Cast identifier (Its either a url or a hash) * @param {CastParamType} type * @param {number} [viewerFid] adds viewer_context to cast object to show whether viewer has liked or recasted the cast. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - cast(identifier: string, type: CastParamType, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.cast(identifier, type, viewerFid, options).then((request) => request(axios, basePath)); + cast(apiKey: string, identifier: string, type: CastParamType, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.cast(apiKey, identifier, type, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Gets all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL. Includes all the ancestors of a cast up to the root parent in a chronological order. Includes all direct_replies to the cast up to the reply_depth specified in the query parameter. * @summary Conversation for a cast + * @param {string} apiKey API key required for authentication. * @param {string} identifier Cast identifier (Its either a url or a hash) * @param {CastParamType} type * @param {number} [replyDepth] The depth of replies in the conversation that will be returned (default 2) @@ -599,12 +657,13 @@ export const CastApiFactory = function (configuration?: Configuration, basePath? * @param {*} [options] Override http request option. * @throws {RequiredError} */ - castConversation(identifier: string, type: CastParamType, replyDepth?: number, includeChronologicalParentCasts?: boolean, viewerFid?: number, sortType?: CastConversationSortType, fold?: CastConversationFoldEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.castConversation(identifier, type, replyDepth, includeChronologicalParentCasts, viewerFid, sortType, fold, limit, cursor, options).then((request) => request(axios, basePath)); + castConversation(apiKey: string, identifier: string, type: CastParamType, replyDepth?: number, includeChronologicalParentCasts?: boolean, viewerFid?: number, sortType?: CastConversationSortType, fold?: CastConversationFoldEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.castConversation(apiKey, identifier, type, replyDepth, includeChronologicalParentCasts, viewerFid, sortType, fold, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Search for casts based on a query string, with optional AND filters * @summary Search for casts + * @param {string} apiKey API key required for authentication. * @param {string} q Query string to search for casts * @param {number} [authorFid] Fid of the user whose casts you want to search * @param {number} [viewerFid] Providing this will return search results that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -616,52 +675,56 @@ export const CastApiFactory = function (configuration?: Configuration, basePath? * @param {*} [options] Override http request option. * @throws {RequiredError} */ - castSearch(q: string, authorFid?: number, viewerFid?: number, parentUrl?: string, channelId?: string, priorityMode?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.castSearch(q, authorFid, viewerFid, parentUrl, channelId, priorityMode, limit, cursor, options).then((request) => request(axios, basePath)); + castSearch(apiKey: string, q: string, authorFid?: number, viewerFid?: number, parentUrl?: string, channelId?: string, priorityMode?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.castSearch(apiKey, q, authorFid, viewerFid, parentUrl, channelId, priorityMode, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Fetch multiple casts using their respective hashes. * @summary Bulk fetch casts + * @param {string} apiKey API key required for authentication. * @param {string} casts Hashes of the cast to be retrived (Comma separated, no spaces) * @param {number} [viewerFid] adds viewer_context to cast object to show whether viewer has liked or recasted the cast. * @param {CastsSortTypeEnum} [sortType] Optional parameter to sort the casts based on different criteria * @param {*} [options] Override http request option. * @throws {RequiredError} */ - casts(casts: string, viewerFid?: number, sortType?: CastsSortTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.casts(casts, viewerFid, sortType, options).then((request) => request(axios, basePath)); + casts(apiKey: string, casts: string, viewerFid?: number, sortType?: CastsSortTypeEnum, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.casts(apiKey, casts, viewerFid, sortType, options).then((request) => request(axios, basePath)); }, /** * Fetches all composer actions on Warpcast. You can filter by top or featured. * @summary Fetch composer actions + * @param {string} apiKey API key required for authentication. * @param {CastComposerType} list Type of list to fetch. * @param {number} [limit] Number of results to fetch (default 25, max 25). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - composerList(list: CastComposerType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.composerList(list, limit, cursor, options).then((request) => request(axios, basePath)); + composerList(apiKey: string, list: CastComposerType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.composerList(apiKey, list, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Delete an existing cast. \\ (In order to delete a cast `signer_uuid` must be approved) * @summary Delete a cast + * @param {string} apiKey API key required for authentication. * @param {DeleteCastReqBody} deleteCastReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteCast(deleteCastReqBody: DeleteCastReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteCast(deleteCastReqBody, options).then((request) => request(axios, basePath)); + deleteCast(apiKey: string, deleteCastReqBody: DeleteCastReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteCast(apiKey, deleteCastReqBody, options).then((request) => request(axios, basePath)); }, /** * Posts a cast or cast reply. Works with mentions and embeds. (In order to post a cast `signer_uuid` must be approved) * @summary Post a cast + * @param {string} apiKey API key required for authentication. * @param {PostCastReqBody} postCastReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postCast(postCastReqBody: PostCastReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.postCast(postCastReqBody, options).then((request) => request(axios, basePath)); + postCast(apiKey: string, postCastReqBody: PostCastReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.postCast(apiKey, postCastReqBody, options).then((request) => request(axios, basePath)); }, }; }; @@ -676,6 +739,7 @@ export class CastApi extends BaseAPI { /** * Gets information about an individual cast by passing in a Warpcast web URL or cast hash * @summary By hash or URL + * @param {string} apiKey API key required for authentication. * @param {string} identifier Cast identifier (Its either a url or a hash) * @param {CastParamType} type * @param {number} [viewerFid] adds viewer_context to cast object to show whether viewer has liked or recasted the cast. @@ -683,13 +747,14 @@ export class CastApi extends BaseAPI { * @throws {RequiredError} * @memberof CastApi */ - public cast(identifier: string, type: CastParamType, viewerFid?: number, options?: RawAxiosRequestConfig) { - return CastApiFp(this.configuration).cast(identifier, type, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public cast(apiKey: string, identifier: string, type: CastParamType, viewerFid?: number, options?: RawAxiosRequestConfig) { + return CastApiFp(this.configuration).cast(apiKey, identifier, type, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Gets all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL. Includes all the ancestors of a cast up to the root parent in a chronological order. Includes all direct_replies to the cast up to the reply_depth specified in the query parameter. * @summary Conversation for a cast + * @param {string} apiKey API key required for authentication. * @param {string} identifier Cast identifier (Its either a url or a hash) * @param {CastParamType} type * @param {number} [replyDepth] The depth of replies in the conversation that will be returned (default 2) @@ -703,13 +768,14 @@ export class CastApi extends BaseAPI { * @throws {RequiredError} * @memberof CastApi */ - public castConversation(identifier: string, type: CastParamType, replyDepth?: number, includeChronologicalParentCasts?: boolean, viewerFid?: number, sortType?: CastConversationSortType, fold?: CastConversationFoldEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return CastApiFp(this.configuration).castConversation(identifier, type, replyDepth, includeChronologicalParentCasts, viewerFid, sortType, fold, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public castConversation(apiKey: string, identifier: string, type: CastParamType, replyDepth?: number, includeChronologicalParentCasts?: boolean, viewerFid?: number, sortType?: CastConversationSortType, fold?: CastConversationFoldEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return CastApiFp(this.configuration).castConversation(apiKey, identifier, type, replyDepth, includeChronologicalParentCasts, viewerFid, sortType, fold, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Search for casts based on a query string, with optional AND filters * @summary Search for casts + * @param {string} apiKey API key required for authentication. * @param {string} q Query string to search for casts * @param {number} [authorFid] Fid of the user whose casts you want to search * @param {number} [viewerFid] Providing this will return search results that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -722,13 +788,14 @@ export class CastApi extends BaseAPI { * @throws {RequiredError} * @memberof CastApi */ - public castSearch(q: string, authorFid?: number, viewerFid?: number, parentUrl?: string, channelId?: string, priorityMode?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return CastApiFp(this.configuration).castSearch(q, authorFid, viewerFid, parentUrl, channelId, priorityMode, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public castSearch(apiKey: string, q: string, authorFid?: number, viewerFid?: number, parentUrl?: string, channelId?: string, priorityMode?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return CastApiFp(this.configuration).castSearch(apiKey, q, authorFid, viewerFid, parentUrl, channelId, priorityMode, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch multiple casts using their respective hashes. * @summary Bulk fetch casts + * @param {string} apiKey API key required for authentication. * @param {string} casts Hashes of the cast to be retrived (Comma separated, no spaces) * @param {number} [viewerFid] adds viewer_context to cast object to show whether viewer has liked or recasted the cast. * @param {CastsSortTypeEnum} [sortType] Optional parameter to sort the casts based on different criteria @@ -736,13 +803,14 @@ export class CastApi extends BaseAPI { * @throws {RequiredError} * @memberof CastApi */ - public casts(casts: string, viewerFid?: number, sortType?: CastsSortTypeEnum, options?: RawAxiosRequestConfig) { - return CastApiFp(this.configuration).casts(casts, viewerFid, sortType, options).then((request) => request(this.axios, this.basePath)); + public casts(apiKey: string, casts: string, viewerFid?: number, sortType?: CastsSortTypeEnum, options?: RawAxiosRequestConfig) { + return CastApiFp(this.configuration).casts(apiKey, casts, viewerFid, sortType, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches all composer actions on Warpcast. You can filter by top or featured. * @summary Fetch composer actions + * @param {string} apiKey API key required for authentication. * @param {CastComposerType} list Type of list to fetch. * @param {number} [limit] Number of results to fetch (default 25, max 25). * @param {string} [cursor] Pagination cursor. @@ -750,32 +818,34 @@ export class CastApi extends BaseAPI { * @throws {RequiredError} * @memberof CastApi */ - public composerList(list: CastComposerType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return CastApiFp(this.configuration).composerList(list, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public composerList(apiKey: string, list: CastComposerType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return CastApiFp(this.configuration).composerList(apiKey, list, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Delete an existing cast. \\ (In order to delete a cast `signer_uuid` must be approved) * @summary Delete a cast + * @param {string} apiKey API key required for authentication. * @param {DeleteCastReqBody} deleteCastReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CastApi */ - public deleteCast(deleteCastReqBody: DeleteCastReqBody, options?: RawAxiosRequestConfig) { - return CastApiFp(this.configuration).deleteCast(deleteCastReqBody, options).then((request) => request(this.axios, this.basePath)); + public deleteCast(apiKey: string, deleteCastReqBody: DeleteCastReqBody, options?: RawAxiosRequestConfig) { + return CastApiFp(this.configuration).deleteCast(apiKey, deleteCastReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Posts a cast or cast reply. Works with mentions and embeds. (In order to post a cast `signer_uuid` must be approved) * @summary Post a cast + * @param {string} apiKey API key required for authentication. * @param {PostCastReqBody} postCastReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof CastApi */ - public postCast(postCastReqBody: PostCastReqBody, options?: RawAxiosRequestConfig) { - return CastApiFp(this.configuration).postCast(postCastReqBody, options).then((request) => request(this.axios, this.basePath)); + public postCast(apiKey: string, postCastReqBody: PostCastReqBody, options?: RawAxiosRequestConfig) { + return CastApiFp(this.configuration).postCast(apiKey, postCastReqBody, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/channel-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/channel-api.ts index 6d8e707d..fdd83b1c 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/channel-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/channel-api.ts @@ -62,13 +62,16 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Fetches all channels that a user has casted in, in reverse chronological order. * @summary Fetch channels that user is active in + * @param {string} apiKey API key required for authentication. * @param {number} fid The user\'s FID (identifier) * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - activeChannels: async (fid: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + activeChannels: async (apiKey: string, fid: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('activeChannels', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('activeChannels', 'fid', fid) const localVarPath = `/farcaster/channel/user`; @@ -98,6 +101,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -112,13 +119,16 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Returns details of a channel * @summary By ID or parent_url + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {ChannelType} [type] Type of identifier being used to query the channel. Defaults to ID. * @param {number} [viewerFid] FID of the user viewing the channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - channelDetails: async (id: string, type?: ChannelType, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + channelDetails: async (apiKey: string, id: string, type?: ChannelType, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('channelDetails', 'apiKey', apiKey) // verify required parameter 'id' is not null or undefined assertParamExists('channelDetails', 'id', id) const localVarPath = `/farcaster/channel`; @@ -148,6 +158,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['viewer_fid'] = viewerFid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -162,13 +176,16 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Returns details of multiple channels * @summary Bulk fetch + * @param {string} apiKey API key required for authentication. * @param {string} ids Comma separated list of channel IDs or parent_urls, up to 100 at a time * @param {ChannelType} [type] Type of identifier being used to query the channels. Defaults to ID. * @param {number} [viewerFid] FID of the user viewing the channels. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - channelDetailsBulk: async (ids: string, type?: ChannelType, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + channelDetailsBulk: async (apiKey: string, ids: string, type?: ChannelType, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('channelDetailsBulk', 'apiKey', apiKey) // verify required parameter 'ids' is not null or undefined assertParamExists('channelDetailsBulk', 'ids', ids) const localVarPath = `/farcaster/channel/bulk`; @@ -198,6 +215,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['viewer_fid'] = viewerFid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -212,6 +233,7 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Returns a list of followers for a specific channel. Max limit is 1000. Use cursor for pagination. * @summary For channel + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {number} [viewerFid] Providing this will return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {string} [cursor] Pagination cursor. @@ -219,7 +241,9 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - channelFollowers: async (id: string, viewerFid?: number, cursor?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + channelFollowers: async (apiKey: string, id: string, viewerFid?: number, cursor?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('channelFollowers', 'apiKey', apiKey) // verify required parameter 'id' is not null or undefined assertParamExists('channelFollowers', 'id', id) const localVarPath = `/farcaster/channel/followers`; @@ -253,6 +277,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['limit'] = limit; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -267,6 +295,7 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Returns a list of users who are active in a given channel, ordered by ascending FIDs * @summary Fetch users who are active in a channel + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {boolean} hasRootCastAuthors Include users who posted the root cast in the channel * @param {boolean} [hasCastLikers] Include users who liked a cast in the channel @@ -277,7 +306,9 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - channelUsers: async (id: string, hasRootCastAuthors: boolean, hasCastLikers?: boolean, hasCastRecasters?: boolean, hasReplyAuthors?: boolean, cursor?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + channelUsers: async (apiKey: string, id: string, hasRootCastAuthors: boolean, hasCastLikers?: boolean, hasCastRecasters?: boolean, hasReplyAuthors?: boolean, cursor?: string, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('channelUsers', 'apiKey', apiKey) // verify required parameter 'id' is not null or undefined assertParamExists('channelUsers', 'id', id) // verify required parameter 'hasRootCastAuthors' is not null or undefined @@ -325,6 +356,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['limit'] = limit; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -339,11 +374,14 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Follow a channel * @summary Follow a channel + * @param {string} apiKey API key required for authentication. * @param {ChannelFollowReqBody} channelFollowReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - followChannel: async (channelFollowReqBody: ChannelFollowReqBody, options: RawAxiosRequestConfig = {}): Promise => { + followChannel: async (apiKey: string, channelFollowReqBody: ChannelFollowReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('followChannel', 'apiKey', apiKey) // verify required parameter 'channelFollowReqBody' is not null or undefined assertParamExists('followChannel', 'channelFollowReqBody', channelFollowReqBody) const localVarPath = `/farcaster/channel/follow`; @@ -361,6 +399,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -378,11 +420,14 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Invite a user to a channel * @summary Invite + * @param {string} apiKey API key required for authentication. * @param {RemoveChannelMemberRequest} removeChannelMemberRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - inviteChannelMember: async (removeChannelMemberRequest: RemoveChannelMemberRequest, options: RawAxiosRequestConfig = {}): Promise => { + inviteChannelMember: async (apiKey: string, removeChannelMemberRequest: RemoveChannelMemberRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('inviteChannelMember', 'apiKey', apiKey) // verify required parameter 'removeChannelMemberRequest' is not null or undefined assertParamExists('inviteChannelMember', 'removeChannelMemberRequest', removeChannelMemberRequest) const localVarPath = `/farcaster/channel/member/invite`; @@ -400,6 +445,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -417,12 +466,15 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Returns a list of all channels with their details * @summary Fetch all channels with their details + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listAllChannels: async (limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + listAllChannels: async (apiKey: string, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('listAllChannels', 'apiKey', apiKey) const localVarPath = `/farcaster/channel/list`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -446,6 +498,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -460,6 +516,7 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Fetch a list of invites, either in a channel or for a user. If both are provided, open channel invite for that user is returned. * @summary Open invites + * @param {string} apiKey API key required for authentication. * @param {string} [channelId] Channel ID for the channel being queried * @param {number} [invitedFid] FID of the user being invited * @param {number} [limit] Number of results to fetch @@ -467,7 +524,9 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listChannelInvites: async (channelId?: string, invitedFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + listChannelInvites: async (apiKey: string, channelId?: string, invitedFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('listChannelInvites', 'apiKey', apiKey) const localVarPath = `/farcaster/channel/member/invite/list`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -499,6 +558,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -513,6 +576,7 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Fetch a list of members in a channel * @summary Fetch members + * @param {string} apiKey API key required for authentication. * @param {string} channelId Channel ID for the channel being queried * @param {number} [fid] FID of the user being queried. Specify this to check if a user is a member of the channel without paginating through all members. * @param {number} [limit] Number of results to fetch @@ -520,7 +584,9 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listChannelMembers: async (channelId: string, fid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + listChannelMembers: async (apiKey: string, channelId: string, fid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('listChannelMembers', 'apiKey', apiKey) // verify required parameter 'channelId' is not null or undefined assertParamExists('listChannelMembers', 'channelId', channelId) const localVarPath = `/farcaster/channel/member/list`; @@ -554,6 +620,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -568,12 +638,15 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Returns a list of relevant channel followers for a specific FID. This usually shows on a channel as \"X, Y, Z follow this channel\". * @summary Relevant followers + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID being queried * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - relevantChannelFollowers: async (id: string, viewerFid: number, options: RawAxiosRequestConfig = {}): Promise => { + relevantChannelFollowers: async (apiKey: string, id: string, viewerFid: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('relevantChannelFollowers', 'apiKey', apiKey) // verify required parameter 'id' is not null or undefined assertParamExists('relevantChannelFollowers', 'id', id) // verify required parameter 'viewerFid' is not null or undefined @@ -601,6 +674,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['viewer_fid'] = viewerFid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -615,11 +692,14 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Remove a user from a channel or a user\'s invite to a channel role * @summary Remove user + * @param {string} apiKey API key required for authentication. * @param {RemoveChannelMemberRequest} removeChannelMemberRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - removeChannelMember: async (removeChannelMemberRequest: RemoveChannelMemberRequest, options: RawAxiosRequestConfig = {}): Promise => { + removeChannelMember: async (apiKey: string, removeChannelMemberRequest: RemoveChannelMemberRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('removeChannelMember', 'apiKey', apiKey) // verify required parameter 'removeChannelMemberRequest' is not null or undefined assertParamExists('removeChannelMember', 'removeChannelMemberRequest', removeChannelMemberRequest) const localVarPath = `/farcaster/channel/member`; @@ -637,6 +717,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -654,11 +738,14 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Accept or reject a channel invite * @summary Accept or reject an invite + * @param {string} apiKey API key required for authentication. * @param {RespondChannelInviteRequest} respondChannelInviteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - respondChannelInvite: async (respondChannelInviteRequest: RespondChannelInviteRequest, options: RawAxiosRequestConfig = {}): Promise => { + respondChannelInvite: async (apiKey: string, respondChannelInviteRequest: RespondChannelInviteRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('respondChannelInvite', 'apiKey', apiKey) // verify required parameter 'respondChannelInviteRequest' is not null or undefined assertParamExists('respondChannelInvite', 'respondChannelInviteRequest', respondChannelInviteRequest) const localVarPath = `/farcaster/channel/member/invite`; @@ -676,6 +763,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -693,13 +784,16 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Returns a list of channels based on ID or name * @summary Search by ID or name + * @param {string} apiKey API key required for authentication. * @param {string} q Channel ID or name for the channel being queried * @param {number} [limit] Number of results to fetch * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - searchChannels: async (q: string, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + searchChannels: async (apiKey: string, q: string, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('searchChannels', 'apiKey', apiKey) // verify required parameter 'q' is not null or undefined assertParamExists('searchChannels', 'q', q) const localVarPath = `/farcaster/channel/search`; @@ -729,6 +823,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -743,13 +841,16 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Returns a list of trending channels based on activity * @summary Channels by activity + * @param {string} apiKey API key required for authentication. * @param {TrendingChannelsTimeWindowEnum} [timeWindow] * @param {number} [limit] Number of results to fetch (default 10, max 25) * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - trendingChannels: async (timeWindow?: TrendingChannelsTimeWindowEnum, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + trendingChannels: async (apiKey: string, timeWindow?: TrendingChannelsTimeWindowEnum, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('trendingChannels', 'apiKey', apiKey) const localVarPath = `/farcaster/channel/trending`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -777,6 +878,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -791,11 +896,14 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Unfollow a channel * @summary Unfollow a channel + * @param {string} apiKey API key required for authentication. * @param {ChannelFollowReqBody} channelFollowReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - unfollowChannel: async (channelFollowReqBody: ChannelFollowReqBody, options: RawAxiosRequestConfig = {}): Promise => { + unfollowChannel: async (apiKey: string, channelFollowReqBody: ChannelFollowReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('unfollowChannel', 'apiKey', apiKey) // verify required parameter 'channelFollowReqBody' is not null or undefined assertParamExists('unfollowChannel', 'channelFollowReqBody', channelFollowReqBody) const localVarPath = `/farcaster/channel/follow`; @@ -813,6 +921,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -830,13 +942,16 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Returns a list of all channels with their details that an FID is a member of. Data may have a delay of up to 1 hour. * @summary Member of + * @param {string} apiKey API key required for authentication. * @param {number} fid The FID of the user. * @param {number} [limit] Number of results to fetch (default 20, max 100) * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userChannelMemberships: async (fid: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + userChannelMemberships: async (apiKey: string, fid: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('userChannelMemberships', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('userChannelMemberships', 'fid', fid) const localVarPath = `/farcaster/user/memberships/list`; @@ -866,6 +981,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -880,13 +999,16 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati /** * Returns a list of all channels with their details that a FID follows. * @summary Following + * @param {string} apiKey API key required for authentication. * @param {number} fid The FID of the user. * @param {number} [limit] Number of results to fetch (default 25, max 100) * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userChannels: async (fid: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + userChannels: async (apiKey: string, fid: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('userChannels', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('userChannels', 'fid', fid) const localVarPath = `/farcaster/user/channels`; @@ -916,6 +1038,10 @@ export const ChannelApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -940,14 +1066,15 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Fetches all channels that a user has casted in, in reverse chronological order. * @summary Fetch channels that user is active in + * @param {string} apiKey API key required for authentication. * @param {number} fid The user\'s FID (identifier) * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async activeChannels(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.activeChannels(fid, limit, cursor, options); + async activeChannels(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.activeChannels(apiKey, fid, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.activeChannels']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -955,14 +1082,15 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Returns details of a channel * @summary By ID or parent_url + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {ChannelType} [type] Type of identifier being used to query the channel. Defaults to ID. * @param {number} [viewerFid] FID of the user viewing the channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async channelDetails(id: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.channelDetails(id, type, viewerFid, options); + async channelDetails(apiKey: string, id: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.channelDetails(apiKey, id, type, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.channelDetails']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -970,14 +1098,15 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Returns details of multiple channels * @summary Bulk fetch + * @param {string} apiKey API key required for authentication. * @param {string} ids Comma separated list of channel IDs or parent_urls, up to 100 at a time * @param {ChannelType} [type] Type of identifier being used to query the channels. Defaults to ID. * @param {number} [viewerFid] FID of the user viewing the channels. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async channelDetailsBulk(ids: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.channelDetailsBulk(ids, type, viewerFid, options); + async channelDetailsBulk(apiKey: string, ids: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.channelDetailsBulk(apiKey, ids, type, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.channelDetailsBulk']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -985,6 +1114,7 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Returns a list of followers for a specific channel. Max limit is 1000. Use cursor for pagination. * @summary For channel + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {number} [viewerFid] Providing this will return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {string} [cursor] Pagination cursor. @@ -992,8 +1122,8 @@ export const ChannelApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async channelFollowers(id: string, viewerFid?: number, cursor?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.channelFollowers(id, viewerFid, cursor, limit, options); + async channelFollowers(apiKey: string, id: string, viewerFid?: number, cursor?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.channelFollowers(apiKey, id, viewerFid, cursor, limit, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.channelFollowers']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1001,6 +1131,7 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Returns a list of users who are active in a given channel, ordered by ascending FIDs * @summary Fetch users who are active in a channel + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {boolean} hasRootCastAuthors Include users who posted the root cast in the channel * @param {boolean} [hasCastLikers] Include users who liked a cast in the channel @@ -1011,8 +1142,8 @@ export const ChannelApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async channelUsers(id: string, hasRootCastAuthors: boolean, hasCastLikers?: boolean, hasCastRecasters?: boolean, hasReplyAuthors?: boolean, cursor?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.channelUsers(id, hasRootCastAuthors, hasCastLikers, hasCastRecasters, hasReplyAuthors, cursor, limit, options); + async channelUsers(apiKey: string, id: string, hasRootCastAuthors: boolean, hasCastLikers?: boolean, hasCastRecasters?: boolean, hasReplyAuthors?: boolean, cursor?: string, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.channelUsers(apiKey, id, hasRootCastAuthors, hasCastLikers, hasCastRecasters, hasReplyAuthors, cursor, limit, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.channelUsers']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1020,12 +1151,13 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Follow a channel * @summary Follow a channel + * @param {string} apiKey API key required for authentication. * @param {ChannelFollowReqBody} channelFollowReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async followChannel(channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.followChannel(channelFollowReqBody, options); + async followChannel(apiKey: string, channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.followChannel(apiKey, channelFollowReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.followChannel']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1033,12 +1165,13 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Invite a user to a channel * @summary Invite + * @param {string} apiKey API key required for authentication. * @param {RemoveChannelMemberRequest} removeChannelMemberRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async inviteChannelMember(removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.inviteChannelMember(removeChannelMemberRequest, options); + async inviteChannelMember(apiKey: string, removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.inviteChannelMember(apiKey, removeChannelMemberRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.inviteChannelMember']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1046,13 +1179,14 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Returns a list of all channels with their details * @summary Fetch all channels with their details + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async listAllChannels(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listAllChannels(limit, cursor, options); + async listAllChannels(apiKey: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listAllChannels(apiKey, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.listAllChannels']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1060,6 +1194,7 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Fetch a list of invites, either in a channel or for a user. If both are provided, open channel invite for that user is returned. * @summary Open invites + * @param {string} apiKey API key required for authentication. * @param {string} [channelId] Channel ID for the channel being queried * @param {number} [invitedFid] FID of the user being invited * @param {number} [limit] Number of results to fetch @@ -1067,8 +1202,8 @@ export const ChannelApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async listChannelInvites(channelId?: string, invitedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listChannelInvites(channelId, invitedFid, limit, cursor, options); + async listChannelInvites(apiKey: string, channelId?: string, invitedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listChannelInvites(apiKey, channelId, invitedFid, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.listChannelInvites']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1076,6 +1211,7 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Fetch a list of members in a channel * @summary Fetch members + * @param {string} apiKey API key required for authentication. * @param {string} channelId Channel ID for the channel being queried * @param {number} [fid] FID of the user being queried. Specify this to check if a user is a member of the channel without paginating through all members. * @param {number} [limit] Number of results to fetch @@ -1083,8 +1219,8 @@ export const ChannelApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async listChannelMembers(channelId: string, fid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.listChannelMembers(channelId, fid, limit, cursor, options); + async listChannelMembers(apiKey: string, channelId: string, fid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.listChannelMembers(apiKey, channelId, fid, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.listChannelMembers']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1092,13 +1228,14 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Returns a list of relevant channel followers for a specific FID. This usually shows on a channel as \"X, Y, Z follow this channel\". * @summary Relevant followers + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID being queried * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async relevantChannelFollowers(id: string, viewerFid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.relevantChannelFollowers(id, viewerFid, options); + async relevantChannelFollowers(apiKey: string, id: string, viewerFid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.relevantChannelFollowers(apiKey, id, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.relevantChannelFollowers']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1106,12 +1243,13 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Remove a user from a channel or a user\'s invite to a channel role * @summary Remove user + * @param {string} apiKey API key required for authentication. * @param {RemoveChannelMemberRequest} removeChannelMemberRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async removeChannelMember(removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.removeChannelMember(removeChannelMemberRequest, options); + async removeChannelMember(apiKey: string, removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.removeChannelMember(apiKey, removeChannelMemberRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.removeChannelMember']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1119,12 +1257,13 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Accept or reject a channel invite * @summary Accept or reject an invite + * @param {string} apiKey API key required for authentication. * @param {RespondChannelInviteRequest} respondChannelInviteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async respondChannelInvite(respondChannelInviteRequest: RespondChannelInviteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.respondChannelInvite(respondChannelInviteRequest, options); + async respondChannelInvite(apiKey: string, respondChannelInviteRequest: RespondChannelInviteRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.respondChannelInvite(apiKey, respondChannelInviteRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.respondChannelInvite']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1132,14 +1271,15 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Returns a list of channels based on ID or name * @summary Search by ID or name + * @param {string} apiKey API key required for authentication. * @param {string} q Channel ID or name for the channel being queried * @param {number} [limit] Number of results to fetch * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async searchChannels(q: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.searchChannels(q, limit, cursor, options); + async searchChannels(apiKey: string, q: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.searchChannels(apiKey, q, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.searchChannels']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1147,14 +1287,15 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Returns a list of trending channels based on activity * @summary Channels by activity + * @param {string} apiKey API key required for authentication. * @param {TrendingChannelsTimeWindowEnum} [timeWindow] * @param {number} [limit] Number of results to fetch (default 10, max 25) * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async trendingChannels(timeWindow?: TrendingChannelsTimeWindowEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.trendingChannels(timeWindow, limit, cursor, options); + async trendingChannels(apiKey: string, timeWindow?: TrendingChannelsTimeWindowEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.trendingChannels(apiKey, timeWindow, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.trendingChannels']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1162,12 +1303,13 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Unfollow a channel * @summary Unfollow a channel + * @param {string} apiKey API key required for authentication. * @param {ChannelFollowReqBody} channelFollowReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async unfollowChannel(channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unfollowChannel(channelFollowReqBody, options); + async unfollowChannel(apiKey: string, channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.unfollowChannel(apiKey, channelFollowReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.unfollowChannel']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1175,14 +1317,15 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Returns a list of all channels with their details that an FID is a member of. Data may have a delay of up to 1 hour. * @summary Member of + * @param {string} apiKey API key required for authentication. * @param {number} fid The FID of the user. * @param {number} [limit] Number of results to fetch (default 20, max 100) * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async userChannelMemberships(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userChannelMemberships(fid, limit, cursor, options); + async userChannelMemberships(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.userChannelMemberships(apiKey, fid, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.userChannelMemberships']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1190,14 +1333,15 @@ export const ChannelApiFp = function(configuration?: Configuration) { /** * Returns a list of all channels with their details that a FID follows. * @summary Following + * @param {string} apiKey API key required for authentication. * @param {number} fid The FID of the user. * @param {number} [limit] Number of results to fetch (default 25, max 100) * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async userChannels(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userChannels(fid, limit, cursor, options); + async userChannels(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.userChannels(apiKey, fid, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ChannelApi.userChannels']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -1215,42 +1359,46 @@ export const ChannelApiFactory = function (configuration?: Configuration, basePa /** * Fetches all channels that a user has casted in, in reverse chronological order. * @summary Fetch channels that user is active in + * @param {string} apiKey API key required for authentication. * @param {number} fid The user\'s FID (identifier) * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - activeChannels(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.activeChannels(fid, limit, cursor, options).then((request) => request(axios, basePath)); + activeChannels(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.activeChannels(apiKey, fid, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Returns details of a channel * @summary By ID or parent_url + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {ChannelType} [type] Type of identifier being used to query the channel. Defaults to ID. * @param {number} [viewerFid] FID of the user viewing the channel. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - channelDetails(id: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.channelDetails(id, type, viewerFid, options).then((request) => request(axios, basePath)); + channelDetails(apiKey: string, id: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.channelDetails(apiKey, id, type, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Returns details of multiple channels * @summary Bulk fetch + * @param {string} apiKey API key required for authentication. * @param {string} ids Comma separated list of channel IDs or parent_urls, up to 100 at a time * @param {ChannelType} [type] Type of identifier being used to query the channels. Defaults to ID. * @param {number} [viewerFid] FID of the user viewing the channels. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - channelDetailsBulk(ids: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.channelDetailsBulk(ids, type, viewerFid, options).then((request) => request(axios, basePath)); + channelDetailsBulk(apiKey: string, ids: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.channelDetailsBulk(apiKey, ids, type, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Returns a list of followers for a specific channel. Max limit is 1000. Use cursor for pagination. * @summary For channel + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {number} [viewerFid] Providing this will return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {string} [cursor] Pagination cursor. @@ -1258,12 +1406,13 @@ export const ChannelApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - channelFollowers(id: string, viewerFid?: number, cursor?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.channelFollowers(id, viewerFid, cursor, limit, options).then((request) => request(axios, basePath)); + channelFollowers(apiKey: string, id: string, viewerFid?: number, cursor?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.channelFollowers(apiKey, id, viewerFid, cursor, limit, options).then((request) => request(axios, basePath)); }, /** * Returns a list of users who are active in a given channel, ordered by ascending FIDs * @summary Fetch users who are active in a channel + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {boolean} hasRootCastAuthors Include users who posted the root cast in the channel * @param {boolean} [hasCastLikers] Include users who liked a cast in the channel @@ -1274,43 +1423,47 @@ export const ChannelApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - channelUsers(id: string, hasRootCastAuthors: boolean, hasCastLikers?: boolean, hasCastRecasters?: boolean, hasReplyAuthors?: boolean, cursor?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.channelUsers(id, hasRootCastAuthors, hasCastLikers, hasCastRecasters, hasReplyAuthors, cursor, limit, options).then((request) => request(axios, basePath)); + channelUsers(apiKey: string, id: string, hasRootCastAuthors: boolean, hasCastLikers?: boolean, hasCastRecasters?: boolean, hasReplyAuthors?: boolean, cursor?: string, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.channelUsers(apiKey, id, hasRootCastAuthors, hasCastLikers, hasCastRecasters, hasReplyAuthors, cursor, limit, options).then((request) => request(axios, basePath)); }, /** * Follow a channel * @summary Follow a channel + * @param {string} apiKey API key required for authentication. * @param {ChannelFollowReqBody} channelFollowReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - followChannel(channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.followChannel(channelFollowReqBody, options).then((request) => request(axios, basePath)); + followChannel(apiKey: string, channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.followChannel(apiKey, channelFollowReqBody, options).then((request) => request(axios, basePath)); }, /** * Invite a user to a channel * @summary Invite + * @param {string} apiKey API key required for authentication. * @param {RemoveChannelMemberRequest} removeChannelMemberRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - inviteChannelMember(removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.inviteChannelMember(removeChannelMemberRequest, options).then((request) => request(axios, basePath)); + inviteChannelMember(apiKey: string, removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.inviteChannelMember(apiKey, removeChannelMemberRequest, options).then((request) => request(axios, basePath)); }, /** * Returns a list of all channels with their details * @summary Fetch all channels with their details + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listAllChannels(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.listAllChannels(limit, cursor, options).then((request) => request(axios, basePath)); + listAllChannels(apiKey: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listAllChannels(apiKey, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Fetch a list of invites, either in a channel or for a user. If both are provided, open channel invite for that user is returned. * @summary Open invites + * @param {string} apiKey API key required for authentication. * @param {string} [channelId] Channel ID for the channel being queried * @param {number} [invitedFid] FID of the user being invited * @param {number} [limit] Number of results to fetch @@ -1318,12 +1471,13 @@ export const ChannelApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listChannelInvites(channelId?: string, invitedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.listChannelInvites(channelId, invitedFid, limit, cursor, options).then((request) => request(axios, basePath)); + listChannelInvites(apiKey: string, channelId?: string, invitedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listChannelInvites(apiKey, channelId, invitedFid, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Fetch a list of members in a channel * @summary Fetch members + * @param {string} apiKey API key required for authentication. * @param {string} channelId Channel ID for the channel being queried * @param {number} [fid] FID of the user being queried. Specify this to check if a user is a member of the channel without paginating through all members. * @param {number} [limit] Number of results to fetch @@ -1331,97 +1485,105 @@ export const ChannelApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - listChannelMembers(channelId: string, fid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.listChannelMembers(channelId, fid, limit, cursor, options).then((request) => request(axios, basePath)); + listChannelMembers(apiKey: string, channelId: string, fid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.listChannelMembers(apiKey, channelId, fid, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Returns a list of relevant channel followers for a specific FID. This usually shows on a channel as \"X, Y, Z follow this channel\". * @summary Relevant followers + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID being queried * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - relevantChannelFollowers(id: string, viewerFid: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.relevantChannelFollowers(id, viewerFid, options).then((request) => request(axios, basePath)); + relevantChannelFollowers(apiKey: string, id: string, viewerFid: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.relevantChannelFollowers(apiKey, id, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Remove a user from a channel or a user\'s invite to a channel role * @summary Remove user + * @param {string} apiKey API key required for authentication. * @param {RemoveChannelMemberRequest} removeChannelMemberRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - removeChannelMember(removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.removeChannelMember(removeChannelMemberRequest, options).then((request) => request(axios, basePath)); + removeChannelMember(apiKey: string, removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.removeChannelMember(apiKey, removeChannelMemberRequest, options).then((request) => request(axios, basePath)); }, /** * Accept or reject a channel invite * @summary Accept or reject an invite + * @param {string} apiKey API key required for authentication. * @param {RespondChannelInviteRequest} respondChannelInviteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - respondChannelInvite(respondChannelInviteRequest: RespondChannelInviteRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.respondChannelInvite(respondChannelInviteRequest, options).then((request) => request(axios, basePath)); + respondChannelInvite(apiKey: string, respondChannelInviteRequest: RespondChannelInviteRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.respondChannelInvite(apiKey, respondChannelInviteRequest, options).then((request) => request(axios, basePath)); }, /** * Returns a list of channels based on ID or name * @summary Search by ID or name + * @param {string} apiKey API key required for authentication. * @param {string} q Channel ID or name for the channel being queried * @param {number} [limit] Number of results to fetch * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - searchChannels(q: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.searchChannels(q, limit, cursor, options).then((request) => request(axios, basePath)); + searchChannels(apiKey: string, q: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.searchChannels(apiKey, q, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Returns a list of trending channels based on activity * @summary Channels by activity + * @param {string} apiKey API key required for authentication. * @param {TrendingChannelsTimeWindowEnum} [timeWindow] * @param {number} [limit] Number of results to fetch (default 10, max 25) * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - trendingChannels(timeWindow?: TrendingChannelsTimeWindowEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.trendingChannels(timeWindow, limit, cursor, options).then((request) => request(axios, basePath)); + trendingChannels(apiKey: string, timeWindow?: TrendingChannelsTimeWindowEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.trendingChannels(apiKey, timeWindow, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Unfollow a channel * @summary Unfollow a channel + * @param {string} apiKey API key required for authentication. * @param {ChannelFollowReqBody} channelFollowReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - unfollowChannel(channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unfollowChannel(channelFollowReqBody, options).then((request) => request(axios, basePath)); + unfollowChannel(apiKey: string, channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.unfollowChannel(apiKey, channelFollowReqBody, options).then((request) => request(axios, basePath)); }, /** * Returns a list of all channels with their details that an FID is a member of. Data may have a delay of up to 1 hour. * @summary Member of + * @param {string} apiKey API key required for authentication. * @param {number} fid The FID of the user. * @param {number} [limit] Number of results to fetch (default 20, max 100) * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userChannelMemberships(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userChannelMemberships(fid, limit, cursor, options).then((request) => request(axios, basePath)); + userChannelMemberships(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.userChannelMemberships(apiKey, fid, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Returns a list of all channels with their details that a FID follows. * @summary Following + * @param {string} apiKey API key required for authentication. * @param {number} fid The FID of the user. * @param {number} [limit] Number of results to fetch (default 25, max 100) * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userChannels(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userChannels(fid, limit, cursor, options).then((request) => request(axios, basePath)); + userChannels(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.userChannels(apiKey, fid, limit, cursor, options).then((request) => request(axios, basePath)); }, }; }; @@ -1436,6 +1598,7 @@ export class ChannelApi extends BaseAPI { /** * Fetches all channels that a user has casted in, in reverse chronological order. * @summary Fetch channels that user is active in + * @param {string} apiKey API key required for authentication. * @param {number} fid The user\'s FID (identifier) * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. @@ -1443,13 +1606,14 @@ export class ChannelApi extends BaseAPI { * @throws {RequiredError} * @memberof ChannelApi */ - public activeChannels(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).activeChannels(fid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public activeChannels(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).activeChannels(apiKey, fid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Returns details of a channel * @summary By ID or parent_url + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {ChannelType} [type] Type of identifier being used to query the channel. Defaults to ID. * @param {number} [viewerFid] FID of the user viewing the channel. @@ -1457,13 +1621,14 @@ export class ChannelApi extends BaseAPI { * @throws {RequiredError} * @memberof ChannelApi */ - public channelDetails(id: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).channelDetails(id, type, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public channelDetails(apiKey: string, id: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).channelDetails(apiKey, id, type, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Returns details of multiple channels * @summary Bulk fetch + * @param {string} apiKey API key required for authentication. * @param {string} ids Comma separated list of channel IDs or parent_urls, up to 100 at a time * @param {ChannelType} [type] Type of identifier being used to query the channels. Defaults to ID. * @param {number} [viewerFid] FID of the user viewing the channels. @@ -1471,13 +1636,14 @@ export class ChannelApi extends BaseAPI { * @throws {RequiredError} * @memberof ChannelApi */ - public channelDetailsBulk(ids: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).channelDetailsBulk(ids, type, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public channelDetailsBulk(apiKey: string, ids: string, type?: ChannelType, viewerFid?: number, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).channelDetailsBulk(apiKey, ids, type, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of followers for a specific channel. Max limit is 1000. Use cursor for pagination. * @summary For channel + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {number} [viewerFid] Providing this will return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {string} [cursor] Pagination cursor. @@ -1486,13 +1652,14 @@ export class ChannelApi extends BaseAPI { * @throws {RequiredError} * @memberof ChannelApi */ - public channelFollowers(id: string, viewerFid?: number, cursor?: string, limit?: number, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).channelFollowers(id, viewerFid, cursor, limit, options).then((request) => request(this.axios, this.basePath)); + public channelFollowers(apiKey: string, id: string, viewerFid?: number, cursor?: string, limit?: number, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).channelFollowers(apiKey, id, viewerFid, cursor, limit, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of users who are active in a given channel, ordered by ascending FIDs * @summary Fetch users who are active in a channel + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID for the channel being queried * @param {boolean} hasRootCastAuthors Include users who posted the root cast in the channel * @param {boolean} [hasCastLikers] Include users who liked a cast in the channel @@ -1504,50 +1671,54 @@ export class ChannelApi extends BaseAPI { * @throws {RequiredError} * @memberof ChannelApi */ - public channelUsers(id: string, hasRootCastAuthors: boolean, hasCastLikers?: boolean, hasCastRecasters?: boolean, hasReplyAuthors?: boolean, cursor?: string, limit?: number, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).channelUsers(id, hasRootCastAuthors, hasCastLikers, hasCastRecasters, hasReplyAuthors, cursor, limit, options).then((request) => request(this.axios, this.basePath)); + public channelUsers(apiKey: string, id: string, hasRootCastAuthors: boolean, hasCastLikers?: boolean, hasCastRecasters?: boolean, hasReplyAuthors?: boolean, cursor?: string, limit?: number, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).channelUsers(apiKey, id, hasRootCastAuthors, hasCastLikers, hasCastRecasters, hasReplyAuthors, cursor, limit, options).then((request) => request(this.axios, this.basePath)); } /** * Follow a channel * @summary Follow a channel + * @param {string} apiKey API key required for authentication. * @param {ChannelFollowReqBody} channelFollowReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ - public followChannel(channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).followChannel(channelFollowReqBody, options).then((request) => request(this.axios, this.basePath)); + public followChannel(apiKey: string, channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).followChannel(apiKey, channelFollowReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Invite a user to a channel * @summary Invite + * @param {string} apiKey API key required for authentication. * @param {RemoveChannelMemberRequest} removeChannelMemberRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ - public inviteChannelMember(removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).inviteChannelMember(removeChannelMemberRequest, options).then((request) => request(this.axios, this.basePath)); + public inviteChannelMember(apiKey: string, removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).inviteChannelMember(apiKey, removeChannelMemberRequest, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of all channels with their details * @summary Fetch all channels with their details + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ - public listAllChannels(limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).listAllChannels(limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public listAllChannels(apiKey: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).listAllChannels(apiKey, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch a list of invites, either in a channel or for a user. If both are provided, open channel invite for that user is returned. * @summary Open invites + * @param {string} apiKey API key required for authentication. * @param {string} [channelId] Channel ID for the channel being queried * @param {number} [invitedFid] FID of the user being invited * @param {number} [limit] Number of results to fetch @@ -1556,13 +1727,14 @@ export class ChannelApi extends BaseAPI { * @throws {RequiredError} * @memberof ChannelApi */ - public listChannelInvites(channelId?: string, invitedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).listChannelInvites(channelId, invitedFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public listChannelInvites(apiKey: string, channelId?: string, invitedFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).listChannelInvites(apiKey, channelId, invitedFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch a list of members in a channel * @summary Fetch members + * @param {string} apiKey API key required for authentication. * @param {string} channelId Channel ID for the channel being queried * @param {number} [fid] FID of the user being queried. Specify this to check if a user is a member of the channel without paginating through all members. * @param {number} [limit] Number of results to fetch @@ -1571,50 +1743,54 @@ export class ChannelApi extends BaseAPI { * @throws {RequiredError} * @memberof ChannelApi */ - public listChannelMembers(channelId: string, fid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).listChannelMembers(channelId, fid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public listChannelMembers(apiKey: string, channelId: string, fid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).listChannelMembers(apiKey, channelId, fid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of relevant channel followers for a specific FID. This usually shows on a channel as \"X, Y, Z follow this channel\". * @summary Relevant followers + * @param {string} apiKey API key required for authentication. * @param {string} id Channel ID being queried * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ - public relevantChannelFollowers(id: string, viewerFid: number, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).relevantChannelFollowers(id, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public relevantChannelFollowers(apiKey: string, id: string, viewerFid: number, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).relevantChannelFollowers(apiKey, id, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Remove a user from a channel or a user\'s invite to a channel role * @summary Remove user + * @param {string} apiKey API key required for authentication. * @param {RemoveChannelMemberRequest} removeChannelMemberRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ - public removeChannelMember(removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).removeChannelMember(removeChannelMemberRequest, options).then((request) => request(this.axios, this.basePath)); + public removeChannelMember(apiKey: string, removeChannelMemberRequest: RemoveChannelMemberRequest, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).removeChannelMember(apiKey, removeChannelMemberRequest, options).then((request) => request(this.axios, this.basePath)); } /** * Accept or reject a channel invite * @summary Accept or reject an invite + * @param {string} apiKey API key required for authentication. * @param {RespondChannelInviteRequest} respondChannelInviteRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ - public respondChannelInvite(respondChannelInviteRequest: RespondChannelInviteRequest, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).respondChannelInvite(respondChannelInviteRequest, options).then((request) => request(this.axios, this.basePath)); + public respondChannelInvite(apiKey: string, respondChannelInviteRequest: RespondChannelInviteRequest, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).respondChannelInvite(apiKey, respondChannelInviteRequest, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of channels based on ID or name * @summary Search by ID or name + * @param {string} apiKey API key required for authentication. * @param {string} q Channel ID or name for the channel being queried * @param {number} [limit] Number of results to fetch * @param {string} [cursor] Pagination cursor. @@ -1622,13 +1798,14 @@ export class ChannelApi extends BaseAPI { * @throws {RequiredError} * @memberof ChannelApi */ - public searchChannels(q: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).searchChannels(q, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public searchChannels(apiKey: string, q: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).searchChannels(apiKey, q, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of trending channels based on activity * @summary Channels by activity + * @param {string} apiKey API key required for authentication. * @param {TrendingChannelsTimeWindowEnum} [timeWindow] * @param {number} [limit] Number of results to fetch (default 10, max 25) * @param {string} [cursor] Pagination cursor. @@ -1636,25 +1813,27 @@ export class ChannelApi extends BaseAPI { * @throws {RequiredError} * @memberof ChannelApi */ - public trendingChannels(timeWindow?: TrendingChannelsTimeWindowEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).trendingChannels(timeWindow, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public trendingChannels(apiKey: string, timeWindow?: TrendingChannelsTimeWindowEnum, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).trendingChannels(apiKey, timeWindow, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Unfollow a channel * @summary Unfollow a channel + * @param {string} apiKey API key required for authentication. * @param {ChannelFollowReqBody} channelFollowReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ChannelApi */ - public unfollowChannel(channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).unfollowChannel(channelFollowReqBody, options).then((request) => request(this.axios, this.basePath)); + public unfollowChannel(apiKey: string, channelFollowReqBody: ChannelFollowReqBody, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).unfollowChannel(apiKey, channelFollowReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of all channels with their details that an FID is a member of. Data may have a delay of up to 1 hour. * @summary Member of + * @param {string} apiKey API key required for authentication. * @param {number} fid The FID of the user. * @param {number} [limit] Number of results to fetch (default 20, max 100) * @param {string} [cursor] Pagination cursor. @@ -1662,13 +1841,14 @@ export class ChannelApi extends BaseAPI { * @throws {RequiredError} * @memberof ChannelApi */ - public userChannelMemberships(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).userChannelMemberships(fid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public userChannelMemberships(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).userChannelMemberships(apiKey, fid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of all channels with their details that a FID follows. * @summary Following + * @param {string} apiKey API key required for authentication. * @param {number} fid The FID of the user. * @param {number} [limit] Number of results to fetch (default 25, max 100) * @param {string} [cursor] Pagination cursor. @@ -1676,8 +1856,8 @@ export class ChannelApi extends BaseAPI { * @throws {RequiredError} * @memberof ChannelApi */ - public userChannels(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return ChannelApiFp(this.configuration).userChannels(fid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public userChannels(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return ChannelApiFp(this.configuration).userChannels(apiKey, fid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/feed-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/feed-api.ts index 70149856..0b299b66 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/feed-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/feed-api.ts @@ -48,6 +48,7 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetch casts based on filters. Ensure setting the correct parameters based on the feed_type and filter_type. * @summary By filters + * @param {string} apiKey API key required for authentication. * @param {FeedType} feedType Defaults to following (requires FID or address). If set to filter (requires filter_type) * @param {FilterType} [filterType] Used when feed_type=filter. Can be set to FIDs (requires FIDs) or parent_url (requires parent_url) or channel_id (requires channel_id) * @param {number} [fid] (Optional) FID of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type @@ -64,7 +65,9 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feed: async (feedType: FeedType, filterType?: FilterType, fid?: number, fids?: string, parentUrl?: string, channelId?: string, membersOnly?: boolean, embedUrl?: string, embedTypes?: Array, withRecasts?: boolean, limit?: number, cursor?: string, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + feed: async (apiKey: string, feedType: FeedType, filterType?: FilterType, fid?: number, fids?: string, parentUrl?: string, channelId?: string, membersOnly?: boolean, embedUrl?: string, embedTypes?: Array, withRecasts?: boolean, limit?: number, cursor?: string, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('feed', 'apiKey', apiKey) // verify required parameter 'feedType' is not null or undefined assertParamExists('feed', 'feedType', feedType) const localVarPath = `/farcaster/feed`; @@ -134,6 +137,10 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['viewer_fid'] = viewerFid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -148,6 +155,7 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetch feed based on channel IDs * @summary By channel IDs + * @param {string} apiKey API key required for authentication. * @param {string} channelIds Comma separated list of channel IDs e.g. neynar,farcaster * @param {boolean} [withRecasts] Include recasts in the response, true by default * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -159,7 +167,9 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedChannels: async (channelIds: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, membersOnly?: boolean, limit?: number, cursor?: string, shouldModerate?: boolean, options: RawAxiosRequestConfig = {}): Promise => { + feedChannels: async (apiKey: string, channelIds: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, membersOnly?: boolean, limit?: number, cursor?: string, shouldModerate?: boolean, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('feedChannels', 'apiKey', apiKey) // verify required parameter 'channelIds' is not null or undefined assertParamExists('feedChannels', 'channelIds', channelIds) const localVarPath = `/farcaster/feed/channels`; @@ -209,6 +219,10 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['should_moderate'] = shouldModerate; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -223,6 +237,7 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetch feed based on who a user is following * @summary Following + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {boolean} [withRecasts] Include recasts in the response, true by default @@ -231,7 +246,9 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedFollowing: async (fid: number, viewerFid?: number, withRecasts?: boolean, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + feedFollowing: async (apiKey: string, fid: number, viewerFid?: number, withRecasts?: boolean, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('feedFollowing', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('feedFollowing', 'fid', fid) const localVarPath = `/farcaster/feed/following`; @@ -269,6 +286,10 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -283,6 +304,7 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetch a personalized For You feed for a user * @summary For you + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {ForYouProvider} [provider] @@ -292,7 +314,9 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedForYou: async (fid: number, viewerFid?: number, provider?: ForYouProvider, limit?: number, cursor?: string, providerMetadata?: string, options: RawAxiosRequestConfig = {}): Promise => { + feedForYou: async (apiKey: string, fid: number, viewerFid?: number, provider?: ForYouProvider, limit?: number, cursor?: string, providerMetadata?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('feedForYou', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('feedForYou', 'fid', fid) const localVarPath = `/farcaster/feed/for_you`; @@ -334,6 +358,10 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['provider_metadata'] = providerMetadata; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -348,13 +376,16 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetch feed of casts with Frames, reverse chronological order * @summary Casts with Frames + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (default 25, max 100) * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedFrames: async (limit?: number, viewerFid?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + feedFrames: async (apiKey: string, limit?: number, viewerFid?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('feedFrames', 'apiKey', apiKey) const localVarPath = `/farcaster/feed/frames`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -382,6 +413,10 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -396,6 +431,7 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetch feed based on parent URLs * @summary By parent URLs + * @param {string} apiKey API key required for authentication. * @param {string} parentUrls Comma separated list of parent_urls * @param {boolean} [withRecasts] Include recasts in the response, true by default * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -405,7 +441,9 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedParentUrls: async (parentUrls: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + feedParentUrls: async (apiKey: string, parentUrls: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('feedParentUrls', 'apiKey', apiKey) // verify required parameter 'parentUrls' is not null or undefined assertParamExists('feedParentUrls', 'parentUrls', parentUrls) const localVarPath = `/farcaster/feed/parent_urls`; @@ -447,6 +485,10 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -461,6 +503,7 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetch trending casts or on the global feed or channels feeds. 7d time window available for channel feeds only. * @summary Trending casts + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (max 10) * @param {string} [cursor] Pagination cursor * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -471,7 +514,9 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedTrending: async (limit?: number, cursor?: string, viewerFid?: number, timeWindow?: FeedTrendingTimeWindowEnum, channelId?: string, provider?: FeedTrendingProvider, providerMetadata?: string, options: RawAxiosRequestConfig = {}): Promise => { + feedTrending: async (apiKey: string, limit?: number, cursor?: string, viewerFid?: number, timeWindow?: FeedTrendingTimeWindowEnum, channelId?: string, provider?: FeedTrendingProvider, providerMetadata?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('feedTrending', 'apiKey', apiKey) const localVarPath = `/farcaster/feed/trending`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -515,6 +560,10 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['provider_metadata'] = providerMetadata; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -529,6 +578,7 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetch casts for a given user FID in reverse chronological order. Also allows filtering by parent_url and channel * @summary Chronologically + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose recent casts you want to fetch * @param {number} [viewerFid] FID of the user viewing the feed * @param {number} [limit] Number of results to fetch @@ -539,7 +589,9 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedUserCasts: async (fid: number, viewerFid?: number, limit?: number, cursor?: string, includeReplies?: boolean, parentUrl?: string, channelId?: string, options: RawAxiosRequestConfig = {}): Promise => { + feedUserCasts: async (apiKey: string, fid: number, viewerFid?: number, limit?: number, cursor?: string, includeReplies?: boolean, parentUrl?: string, channelId?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('feedUserCasts', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('feedUserCasts', 'fid', fid) const localVarPath = `/farcaster/feed/user/casts`; @@ -585,6 +637,10 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['channel_id'] = channelId; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -599,12 +655,15 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetch 10 most popular casts for a given user FID; popularity based on replies, likes and recasts; sorted by most popular first * @summary 10 most popular casts + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedUserPopular: async (fid: number, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + feedUserPopular: async (apiKey: string, fid: number, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('feedUserPopular', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('feedUserPopular', 'fid', fid) const localVarPath = `/farcaster/feed/user/popular`; @@ -630,6 +689,10 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['viewer_fid'] = viewerFid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -644,6 +707,7 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetch recent replies and recasts for a given user FID; sorted by most recent first * @summary Replies and recasts + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose replies and recasts you want to fetch * @param {FeedUserRepliesRecastsFilterEnum} [filter] filter to fetch only replies or recasts * @param {number} [limit] Number of results to fetch (default 25, max 100) @@ -652,7 +716,9 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedUserRepliesRecasts: async (fid: number, filter?: FeedUserRepliesRecastsFilterEnum, limit?: number, cursor?: string, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + feedUserRepliesRecasts: async (apiKey: string, fid: number, filter?: FeedUserRepliesRecastsFilterEnum, limit?: number, cursor?: string, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('feedUserRepliesRecasts', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('feedUserRepliesRecasts', 'fid', fid) const localVarPath = `/farcaster/feed/user/replies_and_recasts`; @@ -690,6 +756,10 @@ export const FeedApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['viewer_fid'] = viewerFid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -714,6 +784,7 @@ export const FeedApiFp = function(configuration?: Configuration) { /** * Fetch casts based on filters. Ensure setting the correct parameters based on the feed_type and filter_type. * @summary By filters + * @param {string} apiKey API key required for authentication. * @param {FeedType} feedType Defaults to following (requires FID or address). If set to filter (requires filter_type) * @param {FilterType} [filterType] Used when feed_type=filter. Can be set to FIDs (requires FIDs) or parent_url (requires parent_url) or channel_id (requires channel_id) * @param {number} [fid] (Optional) FID of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type @@ -730,8 +801,8 @@ export const FeedApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async feed(feedType: FeedType, filterType?: FilterType, fid?: number, fids?: string, parentUrl?: string, channelId?: string, membersOnly?: boolean, embedUrl?: string, embedTypes?: Array, withRecasts?: boolean, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.feed(feedType, filterType, fid, fids, parentUrl, channelId, membersOnly, embedUrl, embedTypes, withRecasts, limit, cursor, viewerFid, options); + async feed(apiKey: string, feedType: FeedType, filterType?: FilterType, fid?: number, fids?: string, parentUrl?: string, channelId?: string, membersOnly?: boolean, embedUrl?: string, embedTypes?: Array, withRecasts?: boolean, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.feed(apiKey, feedType, filterType, fid, fids, parentUrl, channelId, membersOnly, embedUrl, embedTypes, withRecasts, limit, cursor, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FeedApi.feed']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -739,6 +810,7 @@ export const FeedApiFp = function(configuration?: Configuration) { /** * Fetch feed based on channel IDs * @summary By channel IDs + * @param {string} apiKey API key required for authentication. * @param {string} channelIds Comma separated list of channel IDs e.g. neynar,farcaster * @param {boolean} [withRecasts] Include recasts in the response, true by default * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -750,8 +822,8 @@ export const FeedApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async feedChannels(channelIds: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, membersOnly?: boolean, limit?: number, cursor?: string, shouldModerate?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.feedChannels(channelIds, withRecasts, viewerFid, withReplies, membersOnly, limit, cursor, shouldModerate, options); + async feedChannels(apiKey: string, channelIds: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, membersOnly?: boolean, limit?: number, cursor?: string, shouldModerate?: boolean, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.feedChannels(apiKey, channelIds, withRecasts, viewerFid, withReplies, membersOnly, limit, cursor, shouldModerate, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FeedApi.feedChannels']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -759,6 +831,7 @@ export const FeedApiFp = function(configuration?: Configuration) { /** * Fetch feed based on who a user is following * @summary Following + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {boolean} [withRecasts] Include recasts in the response, true by default @@ -767,8 +840,8 @@ export const FeedApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async feedFollowing(fid: number, viewerFid?: number, withRecasts?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.feedFollowing(fid, viewerFid, withRecasts, limit, cursor, options); + async feedFollowing(apiKey: string, fid: number, viewerFid?: number, withRecasts?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.feedFollowing(apiKey, fid, viewerFid, withRecasts, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FeedApi.feedFollowing']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -776,6 +849,7 @@ export const FeedApiFp = function(configuration?: Configuration) { /** * Fetch a personalized For You feed for a user * @summary For you + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {ForYouProvider} [provider] @@ -785,8 +859,8 @@ export const FeedApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async feedForYou(fid: number, viewerFid?: number, provider?: ForYouProvider, limit?: number, cursor?: string, providerMetadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.feedForYou(fid, viewerFid, provider, limit, cursor, providerMetadata, options); + async feedForYou(apiKey: string, fid: number, viewerFid?: number, provider?: ForYouProvider, limit?: number, cursor?: string, providerMetadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.feedForYou(apiKey, fid, viewerFid, provider, limit, cursor, providerMetadata, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FeedApi.feedForYou']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -794,14 +868,15 @@ export const FeedApiFp = function(configuration?: Configuration) { /** * Fetch feed of casts with Frames, reverse chronological order * @summary Casts with Frames + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (default 25, max 100) * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async feedFrames(limit?: number, viewerFid?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.feedFrames(limit, viewerFid, cursor, options); + async feedFrames(apiKey: string, limit?: number, viewerFid?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.feedFrames(apiKey, limit, viewerFid, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FeedApi.feedFrames']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -809,6 +884,7 @@ export const FeedApiFp = function(configuration?: Configuration) { /** * Fetch feed based on parent URLs * @summary By parent URLs + * @param {string} apiKey API key required for authentication. * @param {string} parentUrls Comma separated list of parent_urls * @param {boolean} [withRecasts] Include recasts in the response, true by default * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -818,8 +894,8 @@ export const FeedApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async feedParentUrls(parentUrls: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.feedParentUrls(parentUrls, withRecasts, viewerFid, withReplies, limit, cursor, options); + async feedParentUrls(apiKey: string, parentUrls: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.feedParentUrls(apiKey, parentUrls, withRecasts, viewerFid, withReplies, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FeedApi.feedParentUrls']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -827,6 +903,7 @@ export const FeedApiFp = function(configuration?: Configuration) { /** * Fetch trending casts or on the global feed or channels feeds. 7d time window available for channel feeds only. * @summary Trending casts + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (max 10) * @param {string} [cursor] Pagination cursor * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -837,8 +914,8 @@ export const FeedApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async feedTrending(limit?: number, cursor?: string, viewerFid?: number, timeWindow?: FeedTrendingTimeWindowEnum, channelId?: string, provider?: FeedTrendingProvider, providerMetadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.feedTrending(limit, cursor, viewerFid, timeWindow, channelId, provider, providerMetadata, options); + async feedTrending(apiKey: string, limit?: number, cursor?: string, viewerFid?: number, timeWindow?: FeedTrendingTimeWindowEnum, channelId?: string, provider?: FeedTrendingProvider, providerMetadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.feedTrending(apiKey, limit, cursor, viewerFid, timeWindow, channelId, provider, providerMetadata, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FeedApi.feedTrending']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -846,6 +923,7 @@ export const FeedApiFp = function(configuration?: Configuration) { /** * Fetch casts for a given user FID in reverse chronological order. Also allows filtering by parent_url and channel * @summary Chronologically + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose recent casts you want to fetch * @param {number} [viewerFid] FID of the user viewing the feed * @param {number} [limit] Number of results to fetch @@ -856,8 +934,8 @@ export const FeedApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async feedUserCasts(fid: number, viewerFid?: number, limit?: number, cursor?: string, includeReplies?: boolean, parentUrl?: string, channelId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.feedUserCasts(fid, viewerFid, limit, cursor, includeReplies, parentUrl, channelId, options); + async feedUserCasts(apiKey: string, fid: number, viewerFid?: number, limit?: number, cursor?: string, includeReplies?: boolean, parentUrl?: string, channelId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.feedUserCasts(apiKey, fid, viewerFid, limit, cursor, includeReplies, parentUrl, channelId, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FeedApi.feedUserCasts']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -865,13 +943,14 @@ export const FeedApiFp = function(configuration?: Configuration) { /** * Fetch 10 most popular casts for a given user FID; popularity based on replies, likes and recasts; sorted by most popular first * @summary 10 most popular casts + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async feedUserPopular(fid: number, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.feedUserPopular(fid, viewerFid, options); + async feedUserPopular(apiKey: string, fid: number, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.feedUserPopular(apiKey, fid, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FeedApi.feedUserPopular']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -879,6 +958,7 @@ export const FeedApiFp = function(configuration?: Configuration) { /** * Fetch recent replies and recasts for a given user FID; sorted by most recent first * @summary Replies and recasts + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose replies and recasts you want to fetch * @param {FeedUserRepliesRecastsFilterEnum} [filter] filter to fetch only replies or recasts * @param {number} [limit] Number of results to fetch (default 25, max 100) @@ -887,8 +967,8 @@ export const FeedApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async feedUserRepliesRecasts(fid: number, filter?: FeedUserRepliesRecastsFilterEnum, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.feedUserRepliesRecasts(fid, filter, limit, cursor, viewerFid, options); + async feedUserRepliesRecasts(apiKey: string, fid: number, filter?: FeedUserRepliesRecastsFilterEnum, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.feedUserRepliesRecasts(apiKey, fid, filter, limit, cursor, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FeedApi.feedUserRepliesRecasts']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -906,6 +986,7 @@ export const FeedApiFactory = function (configuration?: Configuration, basePath? /** * Fetch casts based on filters. Ensure setting the correct parameters based on the feed_type and filter_type. * @summary By filters + * @param {string} apiKey API key required for authentication. * @param {FeedType} feedType Defaults to following (requires FID or address). If set to filter (requires filter_type) * @param {FilterType} [filterType] Used when feed_type=filter. Can be set to FIDs (requires FIDs) or parent_url (requires parent_url) or channel_id (requires channel_id) * @param {number} [fid] (Optional) FID of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type @@ -922,12 +1003,13 @@ export const FeedApiFactory = function (configuration?: Configuration, basePath? * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feed(feedType: FeedType, filterType?: FilterType, fid?: number, fids?: string, parentUrl?: string, channelId?: string, membersOnly?: boolean, embedUrl?: string, embedTypes?: Array, withRecasts?: boolean, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.feed(feedType, filterType, fid, fids, parentUrl, channelId, membersOnly, embedUrl, embedTypes, withRecasts, limit, cursor, viewerFid, options).then((request) => request(axios, basePath)); + feed(apiKey: string, feedType: FeedType, filterType?: FilterType, fid?: number, fids?: string, parentUrl?: string, channelId?: string, membersOnly?: boolean, embedUrl?: string, embedTypes?: Array, withRecasts?: boolean, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.feed(apiKey, feedType, filterType, fid, fids, parentUrl, channelId, membersOnly, embedUrl, embedTypes, withRecasts, limit, cursor, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Fetch feed based on channel IDs * @summary By channel IDs + * @param {string} apiKey API key required for authentication. * @param {string} channelIds Comma separated list of channel IDs e.g. neynar,farcaster * @param {boolean} [withRecasts] Include recasts in the response, true by default * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -939,12 +1021,13 @@ export const FeedApiFactory = function (configuration?: Configuration, basePath? * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedChannels(channelIds: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, membersOnly?: boolean, limit?: number, cursor?: string, shouldModerate?: boolean, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.feedChannels(channelIds, withRecasts, viewerFid, withReplies, membersOnly, limit, cursor, shouldModerate, options).then((request) => request(axios, basePath)); + feedChannels(apiKey: string, channelIds: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, membersOnly?: boolean, limit?: number, cursor?: string, shouldModerate?: boolean, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.feedChannels(apiKey, channelIds, withRecasts, viewerFid, withReplies, membersOnly, limit, cursor, shouldModerate, options).then((request) => request(axios, basePath)); }, /** * Fetch feed based on who a user is following * @summary Following + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {boolean} [withRecasts] Include recasts in the response, true by default @@ -953,12 +1036,13 @@ export const FeedApiFactory = function (configuration?: Configuration, basePath? * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedFollowing(fid: number, viewerFid?: number, withRecasts?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.feedFollowing(fid, viewerFid, withRecasts, limit, cursor, options).then((request) => request(axios, basePath)); + feedFollowing(apiKey: string, fid: number, viewerFid?: number, withRecasts?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.feedFollowing(apiKey, fid, viewerFid, withRecasts, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Fetch a personalized For You feed for a user * @summary For you + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {ForYouProvider} [provider] @@ -968,24 +1052,26 @@ export const FeedApiFactory = function (configuration?: Configuration, basePath? * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedForYou(fid: number, viewerFid?: number, provider?: ForYouProvider, limit?: number, cursor?: string, providerMetadata?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.feedForYou(fid, viewerFid, provider, limit, cursor, providerMetadata, options).then((request) => request(axios, basePath)); + feedForYou(apiKey: string, fid: number, viewerFid?: number, provider?: ForYouProvider, limit?: number, cursor?: string, providerMetadata?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.feedForYou(apiKey, fid, viewerFid, provider, limit, cursor, providerMetadata, options).then((request) => request(axios, basePath)); }, /** * Fetch feed of casts with Frames, reverse chronological order * @summary Casts with Frames + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (default 25, max 100) * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedFrames(limit?: number, viewerFid?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.feedFrames(limit, viewerFid, cursor, options).then((request) => request(axios, basePath)); + feedFrames(apiKey: string, limit?: number, viewerFid?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.feedFrames(apiKey, limit, viewerFid, cursor, options).then((request) => request(axios, basePath)); }, /** * Fetch feed based on parent URLs * @summary By parent URLs + * @param {string} apiKey API key required for authentication. * @param {string} parentUrls Comma separated list of parent_urls * @param {boolean} [withRecasts] Include recasts in the response, true by default * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -995,12 +1081,13 @@ export const FeedApiFactory = function (configuration?: Configuration, basePath? * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedParentUrls(parentUrls: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.feedParentUrls(parentUrls, withRecasts, viewerFid, withReplies, limit, cursor, options).then((request) => request(axios, basePath)); + feedParentUrls(apiKey: string, parentUrls: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.feedParentUrls(apiKey, parentUrls, withRecasts, viewerFid, withReplies, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Fetch trending casts or on the global feed or channels feeds. 7d time window available for channel feeds only. * @summary Trending casts + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (max 10) * @param {string} [cursor] Pagination cursor * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -1011,12 +1098,13 @@ export const FeedApiFactory = function (configuration?: Configuration, basePath? * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedTrending(limit?: number, cursor?: string, viewerFid?: number, timeWindow?: FeedTrendingTimeWindowEnum, channelId?: string, provider?: FeedTrendingProvider, providerMetadata?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.feedTrending(limit, cursor, viewerFid, timeWindow, channelId, provider, providerMetadata, options).then((request) => request(axios, basePath)); + feedTrending(apiKey: string, limit?: number, cursor?: string, viewerFid?: number, timeWindow?: FeedTrendingTimeWindowEnum, channelId?: string, provider?: FeedTrendingProvider, providerMetadata?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.feedTrending(apiKey, limit, cursor, viewerFid, timeWindow, channelId, provider, providerMetadata, options).then((request) => request(axios, basePath)); }, /** * Fetch casts for a given user FID in reverse chronological order. Also allows filtering by parent_url and channel * @summary Chronologically + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose recent casts you want to fetch * @param {number} [viewerFid] FID of the user viewing the feed * @param {number} [limit] Number of results to fetch @@ -1027,23 +1115,25 @@ export const FeedApiFactory = function (configuration?: Configuration, basePath? * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedUserCasts(fid: number, viewerFid?: number, limit?: number, cursor?: string, includeReplies?: boolean, parentUrl?: string, channelId?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.feedUserCasts(fid, viewerFid, limit, cursor, includeReplies, parentUrl, channelId, options).then((request) => request(axios, basePath)); + feedUserCasts(apiKey: string, fid: number, viewerFid?: number, limit?: number, cursor?: string, includeReplies?: boolean, parentUrl?: string, channelId?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.feedUserCasts(apiKey, fid, viewerFid, limit, cursor, includeReplies, parentUrl, channelId, options).then((request) => request(axios, basePath)); }, /** * Fetch 10 most popular casts for a given user FID; popularity based on replies, likes and recasts; sorted by most popular first * @summary 10 most popular casts + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedUserPopular(fid: number, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.feedUserPopular(fid, viewerFid, options).then((request) => request(axios, basePath)); + feedUserPopular(apiKey: string, fid: number, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.feedUserPopular(apiKey, fid, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Fetch recent replies and recasts for a given user FID; sorted by most recent first * @summary Replies and recasts + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose replies and recasts you want to fetch * @param {FeedUserRepliesRecastsFilterEnum} [filter] filter to fetch only replies or recasts * @param {number} [limit] Number of results to fetch (default 25, max 100) @@ -1052,8 +1142,8 @@ export const FeedApiFactory = function (configuration?: Configuration, basePath? * @param {*} [options] Override http request option. * @throws {RequiredError} */ - feedUserRepliesRecasts(fid: number, filter?: FeedUserRepliesRecastsFilterEnum, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.feedUserRepliesRecasts(fid, filter, limit, cursor, viewerFid, options).then((request) => request(axios, basePath)); + feedUserRepliesRecasts(apiKey: string, fid: number, filter?: FeedUserRepliesRecastsFilterEnum, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.feedUserRepliesRecasts(apiKey, fid, filter, limit, cursor, viewerFid, options).then((request) => request(axios, basePath)); }, }; }; @@ -1068,6 +1158,7 @@ export class FeedApi extends BaseAPI { /** * Fetch casts based on filters. Ensure setting the correct parameters based on the feed_type and filter_type. * @summary By filters + * @param {string} apiKey API key required for authentication. * @param {FeedType} feedType Defaults to following (requires FID or address). If set to filter (requires filter_type) * @param {FilterType} [filterType] Used when feed_type=filter. Can be set to FIDs (requires FIDs) or parent_url (requires parent_url) or channel_id (requires channel_id) * @param {number} [fid] (Optional) FID of user whose feed you want to create. By default, the API expects this field, except if you pass a filter_type @@ -1085,13 +1176,14 @@ export class FeedApi extends BaseAPI { * @throws {RequiredError} * @memberof FeedApi */ - public feed(feedType: FeedType, filterType?: FilterType, fid?: number, fids?: string, parentUrl?: string, channelId?: string, membersOnly?: boolean, embedUrl?: string, embedTypes?: Array, withRecasts?: boolean, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig) { - return FeedApiFp(this.configuration).feed(feedType, filterType, fid, fids, parentUrl, channelId, membersOnly, embedUrl, embedTypes, withRecasts, limit, cursor, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public feed(apiKey: string, feedType: FeedType, filterType?: FilterType, fid?: number, fids?: string, parentUrl?: string, channelId?: string, membersOnly?: boolean, embedUrl?: string, embedTypes?: Array, withRecasts?: boolean, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig) { + return FeedApiFp(this.configuration).feed(apiKey, feedType, filterType, fid, fids, parentUrl, channelId, membersOnly, embedUrl, embedTypes, withRecasts, limit, cursor, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch feed based on channel IDs * @summary By channel IDs + * @param {string} apiKey API key required for authentication. * @param {string} channelIds Comma separated list of channel IDs e.g. neynar,farcaster * @param {boolean} [withRecasts] Include recasts in the response, true by default * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -1104,13 +1196,14 @@ export class FeedApi extends BaseAPI { * @throws {RequiredError} * @memberof FeedApi */ - public feedChannels(channelIds: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, membersOnly?: boolean, limit?: number, cursor?: string, shouldModerate?: boolean, options?: RawAxiosRequestConfig) { - return FeedApiFp(this.configuration).feedChannels(channelIds, withRecasts, viewerFid, withReplies, membersOnly, limit, cursor, shouldModerate, options).then((request) => request(this.axios, this.basePath)); + public feedChannels(apiKey: string, channelIds: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, membersOnly?: boolean, limit?: number, cursor?: string, shouldModerate?: boolean, options?: RawAxiosRequestConfig) { + return FeedApiFp(this.configuration).feedChannels(apiKey, channelIds, withRecasts, viewerFid, withReplies, membersOnly, limit, cursor, shouldModerate, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch feed based on who a user is following * @summary Following + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {boolean} [withRecasts] Include recasts in the response, true by default @@ -1120,13 +1213,14 @@ export class FeedApi extends BaseAPI { * @throws {RequiredError} * @memberof FeedApi */ - public feedFollowing(fid: number, viewerFid?: number, withRecasts?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return FeedApiFp(this.configuration).feedFollowing(fid, viewerFid, withRecasts, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public feedFollowing(apiKey: string, fid: number, viewerFid?: number, withRecasts?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return FeedApiFp(this.configuration).feedFollowing(apiKey, fid, viewerFid, withRecasts, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch a personalized For You feed for a user * @summary For you + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {ForYouProvider} [provider] @@ -1137,13 +1231,14 @@ export class FeedApi extends BaseAPI { * @throws {RequiredError} * @memberof FeedApi */ - public feedForYou(fid: number, viewerFid?: number, provider?: ForYouProvider, limit?: number, cursor?: string, providerMetadata?: string, options?: RawAxiosRequestConfig) { - return FeedApiFp(this.configuration).feedForYou(fid, viewerFid, provider, limit, cursor, providerMetadata, options).then((request) => request(this.axios, this.basePath)); + public feedForYou(apiKey: string, fid: number, viewerFid?: number, provider?: ForYouProvider, limit?: number, cursor?: string, providerMetadata?: string, options?: RawAxiosRequestConfig) { + return FeedApiFp(this.configuration).feedForYou(apiKey, fid, viewerFid, provider, limit, cursor, providerMetadata, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch feed of casts with Frames, reverse chronological order * @summary Casts with Frames + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (default 25, max 100) * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {string} [cursor] Pagination cursor. @@ -1151,13 +1246,14 @@ export class FeedApi extends BaseAPI { * @throws {RequiredError} * @memberof FeedApi */ - public feedFrames(limit?: number, viewerFid?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return FeedApiFp(this.configuration).feedFrames(limit, viewerFid, cursor, options).then((request) => request(this.axios, this.basePath)); + public feedFrames(apiKey: string, limit?: number, viewerFid?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return FeedApiFp(this.configuration).feedFrames(apiKey, limit, viewerFid, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch feed based on parent URLs * @summary By parent URLs + * @param {string} apiKey API key required for authentication. * @param {string} parentUrls Comma separated list of parent_urls * @param {boolean} [withRecasts] Include recasts in the response, true by default * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -1168,13 +1264,14 @@ export class FeedApi extends BaseAPI { * @throws {RequiredError} * @memberof FeedApi */ - public feedParentUrls(parentUrls: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return FeedApiFp(this.configuration).feedParentUrls(parentUrls, withRecasts, viewerFid, withReplies, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public feedParentUrls(apiKey: string, parentUrls: string, withRecasts?: boolean, viewerFid?: number, withReplies?: boolean, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return FeedApiFp(this.configuration).feedParentUrls(apiKey, parentUrls, withRecasts, viewerFid, withReplies, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch trending casts or on the global feed or channels feeds. 7d time window available for channel feeds only. * @summary Trending casts + * @param {string} apiKey API key required for authentication. * @param {number} [limit] Number of results to fetch (max 10) * @param {string} [cursor] Pagination cursor * @param {number} [viewerFid] Providing this will return a feed that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -1186,13 +1283,14 @@ export class FeedApi extends BaseAPI { * @throws {RequiredError} * @memberof FeedApi */ - public feedTrending(limit?: number, cursor?: string, viewerFid?: number, timeWindow?: FeedTrendingTimeWindowEnum, channelId?: string, provider?: FeedTrendingProvider, providerMetadata?: string, options?: RawAxiosRequestConfig) { - return FeedApiFp(this.configuration).feedTrending(limit, cursor, viewerFid, timeWindow, channelId, provider, providerMetadata, options).then((request) => request(this.axios, this.basePath)); + public feedTrending(apiKey: string, limit?: number, cursor?: string, viewerFid?: number, timeWindow?: FeedTrendingTimeWindowEnum, channelId?: string, provider?: FeedTrendingProvider, providerMetadata?: string, options?: RawAxiosRequestConfig) { + return FeedApiFp(this.configuration).feedTrending(apiKey, limit, cursor, viewerFid, timeWindow, channelId, provider, providerMetadata, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch casts for a given user FID in reverse chronological order. Also allows filtering by parent_url and channel * @summary Chronologically + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose recent casts you want to fetch * @param {number} [viewerFid] FID of the user viewing the feed * @param {number} [limit] Number of results to fetch @@ -1204,26 +1302,28 @@ export class FeedApi extends BaseAPI { * @throws {RequiredError} * @memberof FeedApi */ - public feedUserCasts(fid: number, viewerFid?: number, limit?: number, cursor?: string, includeReplies?: boolean, parentUrl?: string, channelId?: string, options?: RawAxiosRequestConfig) { - return FeedApiFp(this.configuration).feedUserCasts(fid, viewerFid, limit, cursor, includeReplies, parentUrl, channelId, options).then((request) => request(this.axios, this.basePath)); + public feedUserCasts(apiKey: string, fid: number, viewerFid?: number, limit?: number, cursor?: string, includeReplies?: boolean, parentUrl?: string, channelId?: string, options?: RawAxiosRequestConfig) { + return FeedApiFp(this.configuration).feedUserCasts(apiKey, fid, viewerFid, limit, cursor, includeReplies, parentUrl, channelId, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch 10 most popular casts for a given user FID; popularity based on replies, likes and recasts; sorted by most popular first * @summary 10 most popular casts + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose feed you want to create * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FeedApi */ - public feedUserPopular(fid: number, viewerFid?: number, options?: RawAxiosRequestConfig) { - return FeedApiFp(this.configuration).feedUserPopular(fid, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public feedUserPopular(apiKey: string, fid: number, viewerFid?: number, options?: RawAxiosRequestConfig) { + return FeedApiFp(this.configuration).feedUserPopular(apiKey, fid, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch recent replies and recasts for a given user FID; sorted by most recent first * @summary Replies and recasts + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of user whose replies and recasts you want to fetch * @param {FeedUserRepliesRecastsFilterEnum} [filter] filter to fetch only replies or recasts * @param {number} [limit] Number of results to fetch (default 25, max 100) @@ -1233,8 +1333,8 @@ export class FeedApi extends BaseAPI { * @throws {RequiredError} * @memberof FeedApi */ - public feedUserRepliesRecasts(fid: number, filter?: FeedUserRepliesRecastsFilterEnum, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig) { - return FeedApiFp(this.configuration).feedUserRepliesRecasts(fid, filter, limit, cursor, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public feedUserRepliesRecasts(apiKey: string, fid: number, filter?: FeedUserRepliesRecastsFilterEnum, limit?: number, cursor?: string, viewerFid?: number, options?: RawAxiosRequestConfig) { + return FeedApiFp(this.configuration).feedUserRepliesRecasts(apiKey, fid, filter, limit, cursor, viewerFid, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/fname-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/fname-api.ts index 88dc4acc..b7b564bd 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/fname-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/fname-api.ts @@ -34,11 +34,14 @@ export const FnameApiAxiosParamCreator = function (configuration?: Configuration /** * Check if a given fname is available * @summary Check fname availability + * @param {string} apiKey API key required for authentication. * @param {string} fname * @param {*} [options] Override http request option. * @throws {RequiredError} */ - fnameAvailability: async (fname: string, options: RawAxiosRequestConfig = {}): Promise => { + fnameAvailability: async (apiKey: string, fname: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('fnameAvailability', 'apiKey', apiKey) // verify required parameter 'fname' is not null or undefined assertParamExists('fnameAvailability', 'fname', fname) const localVarPath = `/farcaster/fname/availability`; @@ -60,6 +63,10 @@ export const FnameApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['fname'] = fname; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -84,12 +91,13 @@ export const FnameApiFp = function(configuration?: Configuration) { /** * Check if a given fname is available * @summary Check fname availability + * @param {string} apiKey API key required for authentication. * @param {string} fname * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async fnameAvailability(fname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.fnameAvailability(fname, options); + async fnameAvailability(apiKey: string, fname: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.fnameAvailability(apiKey, fname, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FnameApi.fnameAvailability']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -107,12 +115,13 @@ export const FnameApiFactory = function (configuration?: Configuration, basePath /** * Check if a given fname is available * @summary Check fname availability + * @param {string} apiKey API key required for authentication. * @param {string} fname * @param {*} [options] Override http request option. * @throws {RequiredError} */ - fnameAvailability(fname: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.fnameAvailability(fname, options).then((request) => request(axios, basePath)); + fnameAvailability(apiKey: string, fname: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.fnameAvailability(apiKey, fname, options).then((request) => request(axios, basePath)); }, }; }; @@ -127,13 +136,14 @@ export class FnameApi extends BaseAPI { /** * Check if a given fname is available * @summary Check fname availability + * @param {string} apiKey API key required for authentication. * @param {string} fname * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FnameApi */ - public fnameAvailability(fname: string, options?: RawAxiosRequestConfig) { - return FnameApiFp(this.configuration).fnameAvailability(fname, options).then((request) => request(this.axios, this.basePath)); + public fnameAvailability(apiKey: string, fname: string, options?: RawAxiosRequestConfig) { + return FnameApiFp(this.configuration).fnameAvailability(apiKey, fname, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/follows-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/follows-api.ts index 87aba065..aff176f3 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/follows-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/follows-api.ts @@ -40,6 +40,7 @@ export const FollowsApiAxiosParamCreator = function (configuration?: Configurati /** * Returns a list of followers for a specific FID. * @summary Followers + * @param {string} apiKey API key required for authentication. * @param {number} fid User who\'s profile you are looking at * @param {number} [viewerFid] Providing this will return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {FollowSortType} [sortType] Sort type for fetch followers. Default is `desc_chron` @@ -48,7 +49,9 @@ export const FollowsApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - followersV2: async (fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + followersV2: async (apiKey: string, fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('followersV2', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('followersV2', 'fid', fid) const localVarPath = `/farcaster/followers`; @@ -86,6 +89,10 @@ export const FollowsApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -100,6 +107,7 @@ export const FollowsApiAxiosParamCreator = function (configuration?: Configurati /** * Fetch a list of users followed by a user. Can optionally include a viewer_fid and sort_type. * @summary Followed by + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user whose following you want to fetch. * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {FollowSortType} [sortType] Optional parameter to sort the users based on different criteria. @@ -108,7 +116,9 @@ export const FollowsApiAxiosParamCreator = function (configuration?: Configurati * @param {*} [options] Override http request option. * @throws {RequiredError} */ - followingV2: async (fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + followingV2: async (apiKey: string, fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('followingV2', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('followingV2', 'fid', fid) const localVarPath = `/farcaster/following`; @@ -146,6 +156,10 @@ export const FollowsApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -160,12 +174,15 @@ export const FollowsApiAxiosParamCreator = function (configuration?: Configurati /** * Returns a list of relevant followers for a specific FID. This usually shows on a profile as \"X, Y and Z follow this user\". * @summary Relevant followers + * @param {string} apiKey API key required for authentication. * @param {number} targetFid User who\'s profile you are looking at * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - relevantFollowers: async (targetFid: number, viewerFid: number, options: RawAxiosRequestConfig = {}): Promise => { + relevantFollowers: async (apiKey: string, targetFid: number, viewerFid: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('relevantFollowers', 'apiKey', apiKey) // verify required parameter 'targetFid' is not null or undefined assertParamExists('relevantFollowers', 'targetFid', targetFid) // verify required parameter 'viewerFid' is not null or undefined @@ -193,6 +210,10 @@ export const FollowsApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['viewer_fid'] = viewerFid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -207,13 +228,16 @@ export const FollowsApiAxiosParamCreator = function (configuration?: Configurati /** * Fetch a list of suggested users to follow. Used to help users discover new users to follow * @summary Suggest Follows + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user whose following you want to fetch. * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {number} [limit] Number of results to fetch (default 25, max 100) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - suggestedFollows: async (fid: number, viewerFid?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + suggestedFollows: async (apiKey: string, fid: number, viewerFid?: number, limit?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('suggestedFollows', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('suggestedFollows', 'fid', fid) const localVarPath = `/farcaster/following/suggested`; @@ -243,6 +267,10 @@ export const FollowsApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['limit'] = limit; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -267,6 +295,7 @@ export const FollowsApiFp = function(configuration?: Configuration) { /** * Returns a list of followers for a specific FID. * @summary Followers + * @param {string} apiKey API key required for authentication. * @param {number} fid User who\'s profile you are looking at * @param {number} [viewerFid] Providing this will return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {FollowSortType} [sortType] Sort type for fetch followers. Default is `desc_chron` @@ -275,8 +304,8 @@ export const FollowsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async followersV2(fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.followersV2(fid, viewerFid, sortType, limit, cursor, options); + async followersV2(apiKey: string, fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.followersV2(apiKey, fid, viewerFid, sortType, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FollowsApi.followersV2']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -284,6 +313,7 @@ export const FollowsApiFp = function(configuration?: Configuration) { /** * Fetch a list of users followed by a user. Can optionally include a viewer_fid and sort_type. * @summary Followed by + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user whose following you want to fetch. * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {FollowSortType} [sortType] Optional parameter to sort the users based on different criteria. @@ -292,8 +322,8 @@ export const FollowsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async followingV2(fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.followingV2(fid, viewerFid, sortType, limit, cursor, options); + async followingV2(apiKey: string, fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.followingV2(apiKey, fid, viewerFid, sortType, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FollowsApi.followingV2']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -301,13 +331,14 @@ export const FollowsApiFp = function(configuration?: Configuration) { /** * Returns a list of relevant followers for a specific FID. This usually shows on a profile as \"X, Y and Z follow this user\". * @summary Relevant followers + * @param {string} apiKey API key required for authentication. * @param {number} targetFid User who\'s profile you are looking at * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async relevantFollowers(targetFid: number, viewerFid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.relevantFollowers(targetFid, viewerFid, options); + async relevantFollowers(apiKey: string, targetFid: number, viewerFid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.relevantFollowers(apiKey, targetFid, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FollowsApi.relevantFollowers']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -315,14 +346,15 @@ export const FollowsApiFp = function(configuration?: Configuration) { /** * Fetch a list of suggested users to follow. Used to help users discover new users to follow * @summary Suggest Follows + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user whose following you want to fetch. * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {number} [limit] Number of results to fetch (default 25, max 100) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async suggestedFollows(fid: number, viewerFid?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.suggestedFollows(fid, viewerFid, limit, options); + async suggestedFollows(apiKey: string, fid: number, viewerFid?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.suggestedFollows(apiKey, fid, viewerFid, limit, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FollowsApi.suggestedFollows']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -340,6 +372,7 @@ export const FollowsApiFactory = function (configuration?: Configuration, basePa /** * Returns a list of followers for a specific FID. * @summary Followers + * @param {string} apiKey API key required for authentication. * @param {number} fid User who\'s profile you are looking at * @param {number} [viewerFid] Providing this will return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {FollowSortType} [sortType] Sort type for fetch followers. Default is `desc_chron` @@ -348,12 +381,13 @@ export const FollowsApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - followersV2(fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.followersV2(fid, viewerFid, sortType, limit, cursor, options).then((request) => request(axios, basePath)); + followersV2(apiKey: string, fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.followersV2(apiKey, fid, viewerFid, sortType, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Fetch a list of users followed by a user. Can optionally include a viewer_fid and sort_type. * @summary Followed by + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user whose following you want to fetch. * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {FollowSortType} [sortType] Optional parameter to sort the users based on different criteria. @@ -362,31 +396,33 @@ export const FollowsApiFactory = function (configuration?: Configuration, basePa * @param {*} [options] Override http request option. * @throws {RequiredError} */ - followingV2(fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.followingV2(fid, viewerFid, sortType, limit, cursor, options).then((request) => request(axios, basePath)); + followingV2(apiKey: string, fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.followingV2(apiKey, fid, viewerFid, sortType, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Returns a list of relevant followers for a specific FID. This usually shows on a profile as \"X, Y and Z follow this user\". * @summary Relevant followers + * @param {string} apiKey API key required for authentication. * @param {number} targetFid User who\'s profile you are looking at * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - relevantFollowers(targetFid: number, viewerFid: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.relevantFollowers(targetFid, viewerFid, options).then((request) => request(axios, basePath)); + relevantFollowers(apiKey: string, targetFid: number, viewerFid: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.relevantFollowers(apiKey, targetFid, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Fetch a list of suggested users to follow. Used to help users discover new users to follow * @summary Suggest Follows + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user whose following you want to fetch. * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {number} [limit] Number of results to fetch (default 25, max 100) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - suggestedFollows(fid: number, viewerFid?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.suggestedFollows(fid, viewerFid, limit, options).then((request) => request(axios, basePath)); + suggestedFollows(apiKey: string, fid: number, viewerFid?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.suggestedFollows(apiKey, fid, viewerFid, limit, options).then((request) => request(axios, basePath)); }, }; }; @@ -401,6 +437,7 @@ export class FollowsApi extends BaseAPI { /** * Returns a list of followers for a specific FID. * @summary Followers + * @param {string} apiKey API key required for authentication. * @param {number} fid User who\'s profile you are looking at * @param {number} [viewerFid] Providing this will return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {FollowSortType} [sortType] Sort type for fetch followers. Default is `desc_chron` @@ -410,13 +447,14 @@ export class FollowsApi extends BaseAPI { * @throws {RequiredError} * @memberof FollowsApi */ - public followersV2(fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return FollowsApiFp(this.configuration).followersV2(fid, viewerFid, sortType, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public followersV2(apiKey: string, fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return FollowsApiFp(this.configuration).followersV2(apiKey, fid, viewerFid, sortType, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch a list of users followed by a user. Can optionally include a viewer_fid and sort_type. * @summary Followed by + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user whose following you want to fetch. * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {FollowSortType} [sortType] Optional parameter to sort the users based on different criteria. @@ -426,26 +464,28 @@ export class FollowsApi extends BaseAPI { * @throws {RequiredError} * @memberof FollowsApi */ - public followingV2(fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return FollowsApiFp(this.configuration).followingV2(fid, viewerFid, sortType, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public followingV2(apiKey: string, fid: number, viewerFid?: number, sortType?: FollowSortType, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return FollowsApiFp(this.configuration).followingV2(apiKey, fid, viewerFid, sortType, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of relevant followers for a specific FID. This usually shows on a profile as \"X, Y and Z follow this user\". * @summary Relevant followers + * @param {string} apiKey API key required for authentication. * @param {number} targetFid User who\'s profile you are looking at * @param {number} viewerFid The FID of the user to customize this response for. Providing this will also return a list of followers that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FollowsApi */ - public relevantFollowers(targetFid: number, viewerFid: number, options?: RawAxiosRequestConfig) { - return FollowsApiFp(this.configuration).relevantFollowers(targetFid, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public relevantFollowers(apiKey: string, targetFid: number, viewerFid: number, options?: RawAxiosRequestConfig) { + return FollowsApiFp(this.configuration).relevantFollowers(apiKey, targetFid, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch a list of suggested users to follow. Used to help users discover new users to follow * @summary Suggest Follows + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user whose following you want to fetch. * @param {number} [viewerFid] Providing this will return a list of users that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {number} [limit] Number of results to fetch (default 25, max 100) @@ -453,8 +493,8 @@ export class FollowsApi extends BaseAPI { * @throws {RequiredError} * @memberof FollowsApi */ - public suggestedFollows(fid: number, viewerFid?: number, limit?: number, options?: RawAxiosRequestConfig) { - return FollowsApiFp(this.configuration).suggestedFollows(fid, viewerFid, limit, options).then((request) => request(this.axios, this.basePath)); + public suggestedFollows(apiKey: string, fid: number, viewerFid?: number, limit?: number, options?: RawAxiosRequestConfig) { + return FollowsApiFp(this.configuration).suggestedFollows(apiKey, fid, viewerFid, limit, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/frame-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/frame-api.ts index b7dcb797..dc533335 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/frame-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/frame-api.ts @@ -62,11 +62,14 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration /** * Delete an existing frame, if it was made by the developer (identified by API key) * @summary Delete frame + * @param {string} apiKey API key required for authentication. * @param {DeleteNeynarFrameRequest} deleteNeynarFrameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteNeynarFrame: async (deleteNeynarFrameRequest: DeleteNeynarFrameRequest, options: RawAxiosRequestConfig = {}): Promise => { + deleteNeynarFrame: async (apiKey: string, deleteNeynarFrameRequest: DeleteNeynarFrameRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('deleteNeynarFrame', 'apiKey', apiKey) // verify required parameter 'deleteNeynarFrameRequest' is not null or undefined assertParamExists('deleteNeynarFrame', 'deleteNeynarFrameRequest', deleteNeynarFrameRequest) const localVarPath = `/farcaster/frame`; @@ -84,6 +87,10 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -101,10 +108,13 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration /** * Fetch a list of frames made by the developer (identified by API key) * @summary List of frames + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - fetchNeynarFrames: async (options: RawAxiosRequestConfig = {}): Promise => { + fetchNeynarFrames: async (apiKey: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('fetchNeynarFrames', 'apiKey', apiKey) const localVarPath = `/farcaster/frame/list`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -120,6 +130,10 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -134,11 +148,14 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration /** * Fetches the frame meta tags from the URL * @summary Meta tags from URL + * @param {string} apiKey API key required for authentication. * @param {string} url The frame URL to crawl * @param {*} [options] Override http request option. * @throws {RequiredError} */ - frameFromUrl: async (url: string, options: RawAxiosRequestConfig = {}): Promise => { + frameFromUrl: async (apiKey: string, url: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('frameFromUrl', 'apiKey', apiKey) // verify required parameter 'url' is not null or undefined assertParamExists('frameFromUrl', 'url', url) const localVarPath = `/farcaster/frame/crawl`; @@ -160,6 +177,10 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['url'] = url; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -174,13 +195,16 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration /** * Fetch a frame either by UUID or Neynar URL * @summary Frame by UUID or URL + * @param {string} apiKey API key required for authentication. * @param {FrameType} type * @param {string} [uuid] UUID of the frame to fetch * @param {string} [url] URL of the Neynar frame to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ - lookupNeynarFrame: async (type: FrameType, uuid?: string, url?: string, options: RawAxiosRequestConfig = {}): Promise => { + lookupNeynarFrame: async (apiKey: string, type: FrameType, uuid?: string, url?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('lookupNeynarFrame', 'apiKey', apiKey) // verify required parameter 'type' is not null or undefined assertParamExists('lookupNeynarFrame', 'type', type) const localVarPath = `/farcaster/frame`; @@ -210,6 +234,10 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['url'] = url; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -224,11 +252,14 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration /** * Post frame actions, cast actions or cast composer actions to the server \\ (In order to post any of these actions, you need to have an approved `signer_uuid`) The POST request to the post_url has a timeout of 5 seconds for frames. * @summary Post a frame action, cast action or a cast composer action + * @param {string} apiKey API key required for authentication. * @param {FrameActionReqBody} frameActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postFrameAction: async (frameActionReqBody: FrameActionReqBody, options: RawAxiosRequestConfig = {}): Promise => { + postFrameAction: async (apiKey: string, frameActionReqBody: FrameActionReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('postFrameAction', 'apiKey', apiKey) // verify required parameter 'frameActionReqBody' is not null or undefined assertParamExists('postFrameAction', 'frameActionReqBody', frameActionReqBody) const localVarPath = `/farcaster/frame/action`; @@ -246,6 +277,10 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -263,11 +298,14 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration /** * Post a frame action that has been signed with a developer managed signer The POST request to the post_url has a timeout of 5 seconds. * @summary Signature packet + * @param {string} apiKey API key required for authentication. * @param {FrameDeveloperManagedActionReqBody} frameDeveloperManagedActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postFrameDeveloperManagedAction: async (frameDeveloperManagedActionReqBody: FrameDeveloperManagedActionReqBody, options: RawAxiosRequestConfig = {}): Promise => { + postFrameDeveloperManagedAction: async (apiKey: string, frameDeveloperManagedActionReqBody: FrameDeveloperManagedActionReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('postFrameDeveloperManagedAction', 'apiKey', apiKey) // verify required parameter 'frameDeveloperManagedActionReqBody' is not null or undefined assertParamExists('postFrameDeveloperManagedAction', 'frameDeveloperManagedActionReqBody', frameDeveloperManagedActionReqBody) const localVarPath = `/farcaster/frame/developer_managed/action`; @@ -285,6 +323,10 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -302,11 +344,14 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration /** * Create a new frame with a list of pages. * @summary Create frame + * @param {string} apiKey API key required for authentication. * @param {NeynarFrameCreationRequest} neynarFrameCreationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - publishNeynarFrame: async (neynarFrameCreationRequest: NeynarFrameCreationRequest, options: RawAxiosRequestConfig = {}): Promise => { + publishNeynarFrame: async (apiKey: string, neynarFrameCreationRequest: NeynarFrameCreationRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('publishNeynarFrame', 'apiKey', apiKey) // verify required parameter 'neynarFrameCreationRequest' is not null or undefined assertParamExists('publishNeynarFrame', 'neynarFrameCreationRequest', neynarFrameCreationRequest) const localVarPath = `/farcaster/frame`; @@ -324,6 +369,10 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -341,11 +390,14 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration /** * Update an existing frame with a list of pages, if it was made by the developer (identified by API key) * @summary Update frame + * @param {string} apiKey API key required for authentication. * @param {NeynarFrameUpdateRequest} neynarFrameUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateNeynarFrame: async (neynarFrameUpdateRequest: NeynarFrameUpdateRequest, options: RawAxiosRequestConfig = {}): Promise => { + updateNeynarFrame: async (apiKey: string, neynarFrameUpdateRequest: NeynarFrameUpdateRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('updateNeynarFrame', 'apiKey', apiKey) // verify required parameter 'neynarFrameUpdateRequest' is not null or undefined assertParamExists('updateNeynarFrame', 'neynarFrameUpdateRequest', neynarFrameUpdateRequest) const localVarPath = `/farcaster/frame`; @@ -363,6 +415,10 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -380,11 +436,14 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration /** * Validates a frame against by an interacting user against a Farcaster Hub \\ (In order to validate a frame, message bytes from Frame Action must be provided in hex) * @summary Validate frame action + * @param {string} apiKey API key required for authentication. * @param {ValidateFrameRequest} validateFrameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - validateFrame: async (validateFrameRequest: ValidateFrameRequest, options: RawAxiosRequestConfig = {}): Promise => { + validateFrame: async (apiKey: string, validateFrameRequest: ValidateFrameRequest, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('validateFrame', 'apiKey', apiKey) // verify required parameter 'validateFrameRequest' is not null or undefined assertParamExists('validateFrame', 'validateFrameRequest', validateFrameRequest) const localVarPath = `/farcaster/frame/validate`; @@ -402,6 +461,10 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -419,6 +482,7 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration /** * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text. * @summary Analytics for the frame + * @param {string} apiKey API key required for authentication. * @param {string} frameUrl * @param {ValidateFrameAnalyticsType} analyticsType * @param {string} start @@ -427,7 +491,9 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration * @param {*} [options] Override http request option. * @throws {RequiredError} */ - validateFrameAnalytics: async (frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAnalyticsAggregateWindowEnum, options: RawAxiosRequestConfig = {}): Promise => { + validateFrameAnalytics: async (apiKey: string, frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAnalyticsAggregateWindowEnum, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('validateFrameAnalytics', 'apiKey', apiKey) // verify required parameter 'frameUrl' is not null or undefined assertParamExists('validateFrameAnalytics', 'frameUrl', frameUrl) // verify required parameter 'analyticsType' is not null or undefined @@ -475,6 +541,10 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration localVarQueryParameter['aggregate_window'] = aggregateWindow; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -489,10 +559,13 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration /** * Fetch a list of all the frames validated by a user * @summary All frames validated by user + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - validateFrameList: async (options: RawAxiosRequestConfig = {}): Promise => { + validateFrameList: async (apiKey: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('validateFrameList', 'apiKey', apiKey) const localVarPath = `/farcaster/frame/validate/list`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -508,6 +581,10 @@ export const FrameApiAxiosParamCreator = function (configuration?: Configuration // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -532,12 +609,13 @@ export const FrameApiFp = function(configuration?: Configuration) { /** * Delete an existing frame, if it was made by the developer (identified by API key) * @summary Delete frame + * @param {string} apiKey API key required for authentication. * @param {DeleteNeynarFrameRequest} deleteNeynarFrameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteNeynarFrame(deleteNeynarFrameRequest: DeleteNeynarFrameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNeynarFrame(deleteNeynarFrameRequest, options); + async deleteNeynarFrame(apiKey: string, deleteNeynarFrameRequest: DeleteNeynarFrameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteNeynarFrame(apiKey, deleteNeynarFrameRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FrameApi.deleteNeynarFrame']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -545,11 +623,12 @@ export const FrameApiFp = function(configuration?: Configuration) { /** * Fetch a list of frames made by the developer (identified by API key) * @summary List of frames + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async fetchNeynarFrames(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.fetchNeynarFrames(options); + async fetchNeynarFrames(apiKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.fetchNeynarFrames(apiKey, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FrameApi.fetchNeynarFrames']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -557,12 +636,13 @@ export const FrameApiFp = function(configuration?: Configuration) { /** * Fetches the frame meta tags from the URL * @summary Meta tags from URL + * @param {string} apiKey API key required for authentication. * @param {string} url The frame URL to crawl * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async frameFromUrl(url: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.frameFromUrl(url, options); + async frameFromUrl(apiKey: string, url: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.frameFromUrl(apiKey, url, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FrameApi.frameFromUrl']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -570,14 +650,15 @@ export const FrameApiFp = function(configuration?: Configuration) { /** * Fetch a frame either by UUID or Neynar URL * @summary Frame by UUID or URL + * @param {string} apiKey API key required for authentication. * @param {FrameType} type * @param {string} [uuid] UUID of the frame to fetch * @param {string} [url] URL of the Neynar frame to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async lookupNeynarFrame(type: FrameType, uuid?: string, url?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.lookupNeynarFrame(type, uuid, url, options); + async lookupNeynarFrame(apiKey: string, type: FrameType, uuid?: string, url?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.lookupNeynarFrame(apiKey, type, uuid, url, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FrameApi.lookupNeynarFrame']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -585,12 +666,13 @@ export const FrameApiFp = function(configuration?: Configuration) { /** * Post frame actions, cast actions or cast composer actions to the server \\ (In order to post any of these actions, you need to have an approved `signer_uuid`) The POST request to the post_url has a timeout of 5 seconds for frames. * @summary Post a frame action, cast action or a cast composer action + * @param {string} apiKey API key required for authentication. * @param {FrameActionReqBody} frameActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async postFrameAction(frameActionReqBody: FrameActionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.postFrameAction(frameActionReqBody, options); + async postFrameAction(apiKey: string, frameActionReqBody: FrameActionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postFrameAction(apiKey, frameActionReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FrameApi.postFrameAction']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -598,12 +680,13 @@ export const FrameApiFp = function(configuration?: Configuration) { /** * Post a frame action that has been signed with a developer managed signer The POST request to the post_url has a timeout of 5 seconds. * @summary Signature packet + * @param {string} apiKey API key required for authentication. * @param {FrameDeveloperManagedActionReqBody} frameDeveloperManagedActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async postFrameDeveloperManagedAction(frameDeveloperManagedActionReqBody: FrameDeveloperManagedActionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.postFrameDeveloperManagedAction(frameDeveloperManagedActionReqBody, options); + async postFrameDeveloperManagedAction(apiKey: string, frameDeveloperManagedActionReqBody: FrameDeveloperManagedActionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postFrameDeveloperManagedAction(apiKey, frameDeveloperManagedActionReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FrameApi.postFrameDeveloperManagedAction']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -611,12 +694,13 @@ export const FrameApiFp = function(configuration?: Configuration) { /** * Create a new frame with a list of pages. * @summary Create frame + * @param {string} apiKey API key required for authentication. * @param {NeynarFrameCreationRequest} neynarFrameCreationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async publishNeynarFrame(neynarFrameCreationRequest: NeynarFrameCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.publishNeynarFrame(neynarFrameCreationRequest, options); + async publishNeynarFrame(apiKey: string, neynarFrameCreationRequest: NeynarFrameCreationRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.publishNeynarFrame(apiKey, neynarFrameCreationRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FrameApi.publishNeynarFrame']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -624,12 +708,13 @@ export const FrameApiFp = function(configuration?: Configuration) { /** * Update an existing frame with a list of pages, if it was made by the developer (identified by API key) * @summary Update frame + * @param {string} apiKey API key required for authentication. * @param {NeynarFrameUpdateRequest} neynarFrameUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateNeynarFrame(neynarFrameUpdateRequest: NeynarFrameUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateNeynarFrame(neynarFrameUpdateRequest, options); + async updateNeynarFrame(apiKey: string, neynarFrameUpdateRequest: NeynarFrameUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateNeynarFrame(apiKey, neynarFrameUpdateRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FrameApi.updateNeynarFrame']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -637,12 +722,13 @@ export const FrameApiFp = function(configuration?: Configuration) { /** * Validates a frame against by an interacting user against a Farcaster Hub \\ (In order to validate a frame, message bytes from Frame Action must be provided in hex) * @summary Validate frame action + * @param {string} apiKey API key required for authentication. * @param {ValidateFrameRequest} validateFrameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async validateFrame(validateFrameRequest: ValidateFrameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.validateFrame(validateFrameRequest, options); + async validateFrame(apiKey: string, validateFrameRequest: ValidateFrameRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.validateFrame(apiKey, validateFrameRequest, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FrameApi.validateFrame']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -650,6 +736,7 @@ export const FrameApiFp = function(configuration?: Configuration) { /** * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text. * @summary Analytics for the frame + * @param {string} apiKey API key required for authentication. * @param {string} frameUrl * @param {ValidateFrameAnalyticsType} analyticsType * @param {string} start @@ -658,8 +745,8 @@ export const FrameApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async validateFrameAnalytics(frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAnalyticsAggregateWindowEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.validateFrameAnalytics(frameUrl, analyticsType, start, stop, aggregateWindow, options); + async validateFrameAnalytics(apiKey: string, frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAnalyticsAggregateWindowEnum, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.validateFrameAnalytics(apiKey, frameUrl, analyticsType, start, stop, aggregateWindow, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FrameApi.validateFrameAnalytics']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -667,11 +754,12 @@ export const FrameApiFp = function(configuration?: Configuration) { /** * Fetch a list of all the frames validated by a user * @summary All frames validated by user + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async validateFrameList(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.validateFrameList(options); + async validateFrameList(apiKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.validateFrameList(apiKey, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['FrameApi.validateFrameList']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -689,97 +777,107 @@ export const FrameApiFactory = function (configuration?: Configuration, basePath /** * Delete an existing frame, if it was made by the developer (identified by API key) * @summary Delete frame + * @param {string} apiKey API key required for authentication. * @param {DeleteNeynarFrameRequest} deleteNeynarFrameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteNeynarFrame(deleteNeynarFrameRequest: DeleteNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteNeynarFrame(deleteNeynarFrameRequest, options).then((request) => request(axios, basePath)); + deleteNeynarFrame(apiKey: string, deleteNeynarFrameRequest: DeleteNeynarFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteNeynarFrame(apiKey, deleteNeynarFrameRequest, options).then((request) => request(axios, basePath)); }, /** * Fetch a list of frames made by the developer (identified by API key) * @summary List of frames + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - fetchNeynarFrames(options?: RawAxiosRequestConfig): AxiosPromise> { - return localVarFp.fetchNeynarFrames(options).then((request) => request(axios, basePath)); + fetchNeynarFrames(apiKey: string, options?: RawAxiosRequestConfig): AxiosPromise> { + return localVarFp.fetchNeynarFrames(apiKey, options).then((request) => request(axios, basePath)); }, /** * Fetches the frame meta tags from the URL * @summary Meta tags from URL + * @param {string} apiKey API key required for authentication. * @param {string} url The frame URL to crawl * @param {*} [options] Override http request option. * @throws {RequiredError} */ - frameFromUrl(url: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.frameFromUrl(url, options).then((request) => request(axios, basePath)); + frameFromUrl(apiKey: string, url: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.frameFromUrl(apiKey, url, options).then((request) => request(axios, basePath)); }, /** * Fetch a frame either by UUID or Neynar URL * @summary Frame by UUID or URL + * @param {string} apiKey API key required for authentication. * @param {FrameType} type * @param {string} [uuid] UUID of the frame to fetch * @param {string} [url] URL of the Neynar frame to fetch * @param {*} [options] Override http request option. * @throws {RequiredError} */ - lookupNeynarFrame(type: FrameType, uuid?: string, url?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.lookupNeynarFrame(type, uuid, url, options).then((request) => request(axios, basePath)); + lookupNeynarFrame(apiKey: string, type: FrameType, uuid?: string, url?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.lookupNeynarFrame(apiKey, type, uuid, url, options).then((request) => request(axios, basePath)); }, /** * Post frame actions, cast actions or cast composer actions to the server \\ (In order to post any of these actions, you need to have an approved `signer_uuid`) The POST request to the post_url has a timeout of 5 seconds for frames. * @summary Post a frame action, cast action or a cast composer action + * @param {string} apiKey API key required for authentication. * @param {FrameActionReqBody} frameActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postFrameAction(frameActionReqBody: FrameActionReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.postFrameAction(frameActionReqBody, options).then((request) => request(axios, basePath)); + postFrameAction(apiKey: string, frameActionReqBody: FrameActionReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.postFrameAction(apiKey, frameActionReqBody, options).then((request) => request(axios, basePath)); }, /** * Post a frame action that has been signed with a developer managed signer The POST request to the post_url has a timeout of 5 seconds. * @summary Signature packet + * @param {string} apiKey API key required for authentication. * @param {FrameDeveloperManagedActionReqBody} frameDeveloperManagedActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postFrameDeveloperManagedAction(frameDeveloperManagedActionReqBody: FrameDeveloperManagedActionReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.postFrameDeveloperManagedAction(frameDeveloperManagedActionReqBody, options).then((request) => request(axios, basePath)); + postFrameDeveloperManagedAction(apiKey: string, frameDeveloperManagedActionReqBody: FrameDeveloperManagedActionReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.postFrameDeveloperManagedAction(apiKey, frameDeveloperManagedActionReqBody, options).then((request) => request(axios, basePath)); }, /** * Create a new frame with a list of pages. * @summary Create frame + * @param {string} apiKey API key required for authentication. * @param {NeynarFrameCreationRequest} neynarFrameCreationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - publishNeynarFrame(neynarFrameCreationRequest: NeynarFrameCreationRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.publishNeynarFrame(neynarFrameCreationRequest, options).then((request) => request(axios, basePath)); + publishNeynarFrame(apiKey: string, neynarFrameCreationRequest: NeynarFrameCreationRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.publishNeynarFrame(apiKey, neynarFrameCreationRequest, options).then((request) => request(axios, basePath)); }, /** * Update an existing frame with a list of pages, if it was made by the developer (identified by API key) * @summary Update frame + * @param {string} apiKey API key required for authentication. * @param {NeynarFrameUpdateRequest} neynarFrameUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateNeynarFrame(neynarFrameUpdateRequest: NeynarFrameUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateNeynarFrame(neynarFrameUpdateRequest, options).then((request) => request(axios, basePath)); + updateNeynarFrame(apiKey: string, neynarFrameUpdateRequest: NeynarFrameUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateNeynarFrame(apiKey, neynarFrameUpdateRequest, options).then((request) => request(axios, basePath)); }, /** * Validates a frame against by an interacting user against a Farcaster Hub \\ (In order to validate a frame, message bytes from Frame Action must be provided in hex) * @summary Validate frame action + * @param {string} apiKey API key required for authentication. * @param {ValidateFrameRequest} validateFrameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ - validateFrame(validateFrameRequest: ValidateFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.validateFrame(validateFrameRequest, options).then((request) => request(axios, basePath)); + validateFrame(apiKey: string, validateFrameRequest: ValidateFrameRequest, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.validateFrame(apiKey, validateFrameRequest, options).then((request) => request(axios, basePath)); }, /** * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text. * @summary Analytics for the frame + * @param {string} apiKey API key required for authentication. * @param {string} frameUrl * @param {ValidateFrameAnalyticsType} analyticsType * @param {string} start @@ -788,17 +886,18 @@ export const FrameApiFactory = function (configuration?: Configuration, basePath * @param {*} [options] Override http request option. * @throws {RequiredError} */ - validateFrameAnalytics(frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAnalyticsAggregateWindowEnum, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.validateFrameAnalytics(frameUrl, analyticsType, start, stop, aggregateWindow, options).then((request) => request(axios, basePath)); + validateFrameAnalytics(apiKey: string, frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAnalyticsAggregateWindowEnum, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.validateFrameAnalytics(apiKey, frameUrl, analyticsType, start, stop, aggregateWindow, options).then((request) => request(axios, basePath)); }, /** * Fetch a list of all the frames validated by a user * @summary All frames validated by user + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - validateFrameList(options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.validateFrameList(options).then((request) => request(axios, basePath)); + validateFrameList(apiKey: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.validateFrameList(apiKey, options).then((request) => request(axios, basePath)); }, }; }; @@ -813,41 +912,45 @@ export class FrameApi extends BaseAPI { /** * Delete an existing frame, if it was made by the developer (identified by API key) * @summary Delete frame + * @param {string} apiKey API key required for authentication. * @param {DeleteNeynarFrameRequest} deleteNeynarFrameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FrameApi */ - public deleteNeynarFrame(deleteNeynarFrameRequest: DeleteNeynarFrameRequest, options?: RawAxiosRequestConfig) { - return FrameApiFp(this.configuration).deleteNeynarFrame(deleteNeynarFrameRequest, options).then((request) => request(this.axios, this.basePath)); + public deleteNeynarFrame(apiKey: string, deleteNeynarFrameRequest: DeleteNeynarFrameRequest, options?: RawAxiosRequestConfig) { + return FrameApiFp(this.configuration).deleteNeynarFrame(apiKey, deleteNeynarFrameRequest, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch a list of frames made by the developer (identified by API key) * @summary List of frames + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FrameApi */ - public fetchNeynarFrames(options?: RawAxiosRequestConfig) { - return FrameApiFp(this.configuration).fetchNeynarFrames(options).then((request) => request(this.axios, this.basePath)); + public fetchNeynarFrames(apiKey: string, options?: RawAxiosRequestConfig) { + return FrameApiFp(this.configuration).fetchNeynarFrames(apiKey, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches the frame meta tags from the URL * @summary Meta tags from URL + * @param {string} apiKey API key required for authentication. * @param {string} url The frame URL to crawl * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FrameApi */ - public frameFromUrl(url: string, options?: RawAxiosRequestConfig) { - return FrameApiFp(this.configuration).frameFromUrl(url, options).then((request) => request(this.axios, this.basePath)); + public frameFromUrl(apiKey: string, url: string, options?: RawAxiosRequestConfig) { + return FrameApiFp(this.configuration).frameFromUrl(apiKey, url, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch a frame either by UUID or Neynar URL * @summary Frame by UUID or URL + * @param {string} apiKey API key required for authentication. * @param {FrameType} type * @param {string} [uuid] UUID of the frame to fetch * @param {string} [url] URL of the Neynar frame to fetch @@ -855,73 +958,79 @@ export class FrameApi extends BaseAPI { * @throws {RequiredError} * @memberof FrameApi */ - public lookupNeynarFrame(type: FrameType, uuid?: string, url?: string, options?: RawAxiosRequestConfig) { - return FrameApiFp(this.configuration).lookupNeynarFrame(type, uuid, url, options).then((request) => request(this.axios, this.basePath)); + public lookupNeynarFrame(apiKey: string, type: FrameType, uuid?: string, url?: string, options?: RawAxiosRequestConfig) { + return FrameApiFp(this.configuration).lookupNeynarFrame(apiKey, type, uuid, url, options).then((request) => request(this.axios, this.basePath)); } /** * Post frame actions, cast actions or cast composer actions to the server \\ (In order to post any of these actions, you need to have an approved `signer_uuid`) The POST request to the post_url has a timeout of 5 seconds for frames. * @summary Post a frame action, cast action or a cast composer action + * @param {string} apiKey API key required for authentication. * @param {FrameActionReqBody} frameActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FrameApi */ - public postFrameAction(frameActionReqBody: FrameActionReqBody, options?: RawAxiosRequestConfig) { - return FrameApiFp(this.configuration).postFrameAction(frameActionReqBody, options).then((request) => request(this.axios, this.basePath)); + public postFrameAction(apiKey: string, frameActionReqBody: FrameActionReqBody, options?: RawAxiosRequestConfig) { + return FrameApiFp(this.configuration).postFrameAction(apiKey, frameActionReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Post a frame action that has been signed with a developer managed signer The POST request to the post_url has a timeout of 5 seconds. * @summary Signature packet + * @param {string} apiKey API key required for authentication. * @param {FrameDeveloperManagedActionReqBody} frameDeveloperManagedActionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FrameApi */ - public postFrameDeveloperManagedAction(frameDeveloperManagedActionReqBody: FrameDeveloperManagedActionReqBody, options?: RawAxiosRequestConfig) { - return FrameApiFp(this.configuration).postFrameDeveloperManagedAction(frameDeveloperManagedActionReqBody, options).then((request) => request(this.axios, this.basePath)); + public postFrameDeveloperManagedAction(apiKey: string, frameDeveloperManagedActionReqBody: FrameDeveloperManagedActionReqBody, options?: RawAxiosRequestConfig) { + return FrameApiFp(this.configuration).postFrameDeveloperManagedAction(apiKey, frameDeveloperManagedActionReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Create a new frame with a list of pages. * @summary Create frame + * @param {string} apiKey API key required for authentication. * @param {NeynarFrameCreationRequest} neynarFrameCreationRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FrameApi */ - public publishNeynarFrame(neynarFrameCreationRequest: NeynarFrameCreationRequest, options?: RawAxiosRequestConfig) { - return FrameApiFp(this.configuration).publishNeynarFrame(neynarFrameCreationRequest, options).then((request) => request(this.axios, this.basePath)); + public publishNeynarFrame(apiKey: string, neynarFrameCreationRequest: NeynarFrameCreationRequest, options?: RawAxiosRequestConfig) { + return FrameApiFp(this.configuration).publishNeynarFrame(apiKey, neynarFrameCreationRequest, options).then((request) => request(this.axios, this.basePath)); } /** * Update an existing frame with a list of pages, if it was made by the developer (identified by API key) * @summary Update frame + * @param {string} apiKey API key required for authentication. * @param {NeynarFrameUpdateRequest} neynarFrameUpdateRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FrameApi */ - public updateNeynarFrame(neynarFrameUpdateRequest: NeynarFrameUpdateRequest, options?: RawAxiosRequestConfig) { - return FrameApiFp(this.configuration).updateNeynarFrame(neynarFrameUpdateRequest, options).then((request) => request(this.axios, this.basePath)); + public updateNeynarFrame(apiKey: string, neynarFrameUpdateRequest: NeynarFrameUpdateRequest, options?: RawAxiosRequestConfig) { + return FrameApiFp(this.configuration).updateNeynarFrame(apiKey, neynarFrameUpdateRequest, options).then((request) => request(this.axios, this.basePath)); } /** * Validates a frame against by an interacting user against a Farcaster Hub \\ (In order to validate a frame, message bytes from Frame Action must be provided in hex) * @summary Validate frame action + * @param {string} apiKey API key required for authentication. * @param {ValidateFrameRequest} validateFrameRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FrameApi */ - public validateFrame(validateFrameRequest: ValidateFrameRequest, options?: RawAxiosRequestConfig) { - return FrameApiFp(this.configuration).validateFrame(validateFrameRequest, options).then((request) => request(this.axios, this.basePath)); + public validateFrame(apiKey: string, validateFrameRequest: ValidateFrameRequest, options?: RawAxiosRequestConfig) { + return FrameApiFp(this.configuration).validateFrame(apiKey, validateFrameRequest, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch analytics for total-interactors, interactors, nteractions-per-cast and input-text. * @summary Analytics for the frame + * @param {string} apiKey API key required for authentication. * @param {string} frameUrl * @param {ValidateFrameAnalyticsType} analyticsType * @param {string} start @@ -931,19 +1040,20 @@ export class FrameApi extends BaseAPI { * @throws {RequiredError} * @memberof FrameApi */ - public validateFrameAnalytics(frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAnalyticsAggregateWindowEnum, options?: RawAxiosRequestConfig) { - return FrameApiFp(this.configuration).validateFrameAnalytics(frameUrl, analyticsType, start, stop, aggregateWindow, options).then((request) => request(this.axios, this.basePath)); + public validateFrameAnalytics(apiKey: string, frameUrl: string, analyticsType: ValidateFrameAnalyticsType, start: string, stop: string, aggregateWindow?: ValidateFrameAnalyticsAggregateWindowEnum, options?: RawAxiosRequestConfig) { + return FrameApiFp(this.configuration).validateFrameAnalytics(apiKey, frameUrl, analyticsType, start, stop, aggregateWindow, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch a list of all the frames validated by a user * @summary All frames validated by user + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof FrameApi */ - public validateFrameList(options?: RawAxiosRequestConfig) { - return FrameApiFp(this.configuration).validateFrameList(options).then((request) => request(this.axios, this.basePath)); + public validateFrameList(apiKey: string, options?: RawAxiosRequestConfig) { + return FrameApiFp(this.configuration).validateFrameList(apiKey, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/mute-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/mute-api.ts index 55eb74b4..d7badc23 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/mute-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/mute-api.ts @@ -38,11 +38,14 @@ export const MuteApiAxiosParamCreator = function (configuration?: Configuration) /** * Adds a mute for a given FID. This is a whitelisted API, reach out if you want access. * @summary Mute FID + * @param {string} apiKey API key required for authentication. * @param {MuteReqBody} muteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addMute: async (muteReqBody: MuteReqBody, options: RawAxiosRequestConfig = {}): Promise => { + addMute: async (apiKey: string, muteReqBody: MuteReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('addMute', 'apiKey', apiKey) // verify required parameter 'muteReqBody' is not null or undefined assertParamExists('addMute', 'muteReqBody', muteReqBody) const localVarPath = `/farcaster/mute`; @@ -60,6 +63,10 @@ export const MuteApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -77,11 +84,14 @@ export const MuteApiAxiosParamCreator = function (configuration?: Configuration) /** * Deletes a mute for a given FID. This is a whitelisted API, reach out if you want access. * @summary Unmute FID + * @param {string} apiKey API key required for authentication. * @param {MuteReqBody} muteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteMute: async (muteReqBody: MuteReqBody, options: RawAxiosRequestConfig = {}): Promise => { + deleteMute: async (apiKey: string, muteReqBody: MuteReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('deleteMute', 'apiKey', apiKey) // verify required parameter 'muteReqBody' is not null or undefined assertParamExists('deleteMute', 'muteReqBody', muteReqBody) const localVarPath = `/farcaster/mute`; @@ -99,6 +109,10 @@ export const MuteApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -116,13 +130,16 @@ export const MuteApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetches all FIDs that a user has muted. * @summary Muted FIDs of user + * @param {string} apiKey API key required for authentication. * @param {number} fid The user\'s FID (identifier) * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - muteList: async (fid: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + muteList: async (apiKey: string, fid: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('muteList', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('muteList', 'fid', fid) const localVarPath = `/farcaster/mute/list`; @@ -152,6 +169,10 @@ export const MuteApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -176,12 +197,13 @@ export const MuteApiFp = function(configuration?: Configuration) { /** * Adds a mute for a given FID. This is a whitelisted API, reach out if you want access. * @summary Mute FID + * @param {string} apiKey API key required for authentication. * @param {MuteReqBody} muteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async addMute(muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.addMute(muteReqBody, options); + async addMute(apiKey: string, muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.addMute(apiKey, muteReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MuteApi.addMute']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -189,12 +211,13 @@ export const MuteApiFp = function(configuration?: Configuration) { /** * Deletes a mute for a given FID. This is a whitelisted API, reach out if you want access. * @summary Unmute FID + * @param {string} apiKey API key required for authentication. * @param {MuteReqBody} muteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteMute(muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMute(muteReqBody, options); + async deleteMute(apiKey: string, muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteMute(apiKey, muteReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MuteApi.deleteMute']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -202,14 +225,15 @@ export const MuteApiFp = function(configuration?: Configuration) { /** * Fetches all FIDs that a user has muted. * @summary Muted FIDs of user + * @param {string} apiKey API key required for authentication. * @param {number} fid The user\'s FID (identifier) * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async muteList(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.muteList(fid, limit, cursor, options); + async muteList(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.muteList(apiKey, fid, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['MuteApi.muteList']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -227,34 +251,37 @@ export const MuteApiFactory = function (configuration?: Configuration, basePath? /** * Adds a mute for a given FID. This is a whitelisted API, reach out if you want access. * @summary Mute FID + * @param {string} apiKey API key required for authentication. * @param {MuteReqBody} muteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - addMute(muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.addMute(muteReqBody, options).then((request) => request(axios, basePath)); + addMute(apiKey: string, muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.addMute(apiKey, muteReqBody, options).then((request) => request(axios, basePath)); }, /** * Deletes a mute for a given FID. This is a whitelisted API, reach out if you want access. * @summary Unmute FID + * @param {string} apiKey API key required for authentication. * @param {MuteReqBody} muteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteMute(muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteMute(muteReqBody, options).then((request) => request(axios, basePath)); + deleteMute(apiKey: string, muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteMute(apiKey, muteReqBody, options).then((request) => request(axios, basePath)); }, /** * Fetches all FIDs that a user has muted. * @summary Muted FIDs of user + * @param {string} apiKey API key required for authentication. * @param {number} fid The user\'s FID (identifier) * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - muteList(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.muteList(fid, limit, cursor, options).then((request) => request(axios, basePath)); + muteList(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.muteList(apiKey, fid, limit, cursor, options).then((request) => request(axios, basePath)); }, }; }; @@ -269,30 +296,33 @@ export class MuteApi extends BaseAPI { /** * Adds a mute for a given FID. This is a whitelisted API, reach out if you want access. * @summary Mute FID + * @param {string} apiKey API key required for authentication. * @param {MuteReqBody} muteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MuteApi */ - public addMute(muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig) { - return MuteApiFp(this.configuration).addMute(muteReqBody, options).then((request) => request(this.axios, this.basePath)); + public addMute(apiKey: string, muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig) { + return MuteApiFp(this.configuration).addMute(apiKey, muteReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Deletes a mute for a given FID. This is a whitelisted API, reach out if you want access. * @summary Unmute FID + * @param {string} apiKey API key required for authentication. * @param {MuteReqBody} muteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof MuteApi */ - public deleteMute(muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig) { - return MuteApiFp(this.configuration).deleteMute(muteReqBody, options).then((request) => request(this.axios, this.basePath)); + public deleteMute(apiKey: string, muteReqBody: MuteReqBody, options?: RawAxiosRequestConfig) { + return MuteApiFp(this.configuration).deleteMute(apiKey, muteReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches all FIDs that a user has muted. * @summary Muted FIDs of user + * @param {string} apiKey API key required for authentication. * @param {number} fid The user\'s FID (identifier) * @param {number} [limit] Number of results to fetch (default 20, max 100). * @param {string} [cursor] Pagination cursor. @@ -300,8 +330,8 @@ export class MuteApi extends BaseAPI { * @throws {RequiredError} * @memberof MuteApi */ - public muteList(fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return MuteApiFp(this.configuration).muteList(fid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public muteList(apiKey: string, fid: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return MuteApiFp(this.configuration).muteList(apiKey, fid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/notifications-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/notifications-api.ts index 5eab7793..6e0f52b1 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/notifications-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/notifications-api.ts @@ -40,11 +40,14 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi /** * Mark notifications as seen * @summary Mark as seen + * @param {string} apiKey API key required for authentication. * @param {MarkNotificationsAsSeenReqBody} markNotificationsAsSeenReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - markNotificationsAsSeen: async (markNotificationsAsSeenReqBody: MarkNotificationsAsSeenReqBody, options: RawAxiosRequestConfig = {}): Promise => { + markNotificationsAsSeen: async (apiKey: string, markNotificationsAsSeenReqBody: MarkNotificationsAsSeenReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('markNotificationsAsSeen', 'apiKey', apiKey) // verify required parameter 'markNotificationsAsSeenReqBody' is not null or undefined assertParamExists('markNotificationsAsSeen', 'markNotificationsAsSeenReqBody', markNotificationsAsSeenReqBody) const localVarPath = `/farcaster/notifications/seen`; @@ -62,6 +65,10 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -79,6 +86,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi /** * Returns a list of notifications for a specific FID. * @summary For user + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {NotificationType} [type] Notification type to fetch. * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -86,7 +94,9 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi * @param {*} [options] Override http request option. * @throws {RequiredError} */ - notifications: async (fid: number, type?: NotificationType, priorityMode?: boolean, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + notifications: async (apiKey: string, fid: number, type?: NotificationType, priorityMode?: boolean, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('notifications', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('notifications', 'fid', fid) const localVarPath = `/farcaster/notifications`; @@ -120,6 +130,10 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -134,6 +148,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi /** * Returns a list of notifications for a user in specific channels * @summary For user by channel + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {string} channelIds Comma separated channel_ids (find list of all channels here - https://docs.neynar.com/reference/list-all-channels) * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -141,7 +156,9 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi * @param {*} [options] Override http request option. * @throws {RequiredError} */ - notificationsChannel: async (fid: number, channelIds: string, priorityMode?: boolean, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + notificationsChannel: async (apiKey: string, fid: number, channelIds: string, priorityMode?: boolean, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('notificationsChannel', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('notificationsChannel', 'fid', fid) // verify required parameter 'channelIds' is not null or undefined @@ -177,6 +194,10 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -191,6 +212,7 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi /** * Returns a list of notifications for a user in specific parent_urls * @summary For user by parent_urls + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {string} parentUrls Comma separated parent_urls * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -198,7 +220,9 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi * @param {*} [options] Override http request option. * @throws {RequiredError} */ - notificationsParentUrl: async (fid: number, parentUrls: string, priorityMode?: boolean, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + notificationsParentUrl: async (apiKey: string, fid: number, parentUrls: string, priorityMode?: boolean, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('notificationsParentUrl', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('notificationsParentUrl', 'fid', fid) // verify required parameter 'parentUrls' is not null or undefined @@ -234,6 +258,10 @@ export const NotificationsApiAxiosParamCreator = function (configuration?: Confi localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -258,12 +286,13 @@ export const NotificationsApiFp = function(configuration?: Configuration) { /** * Mark notifications as seen * @summary Mark as seen + * @param {string} apiKey API key required for authentication. * @param {MarkNotificationsAsSeenReqBody} markNotificationsAsSeenReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async markNotificationsAsSeen(markNotificationsAsSeenReqBody: MarkNotificationsAsSeenReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.markNotificationsAsSeen(markNotificationsAsSeenReqBody, options); + async markNotificationsAsSeen(apiKey: string, markNotificationsAsSeenReqBody: MarkNotificationsAsSeenReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.markNotificationsAsSeen(apiKey, markNotificationsAsSeenReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.markNotificationsAsSeen']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -271,6 +300,7 @@ export const NotificationsApiFp = function(configuration?: Configuration) { /** * Returns a list of notifications for a specific FID. * @summary For user + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {NotificationType} [type] Notification type to fetch. * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -278,8 +308,8 @@ export const NotificationsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async notifications(fid: number, type?: NotificationType, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.notifications(fid, type, priorityMode, cursor, options); + async notifications(apiKey: string, fid: number, type?: NotificationType, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.notifications(apiKey, fid, type, priorityMode, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.notifications']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -287,6 +317,7 @@ export const NotificationsApiFp = function(configuration?: Configuration) { /** * Returns a list of notifications for a user in specific channels * @summary For user by channel + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {string} channelIds Comma separated channel_ids (find list of all channels here - https://docs.neynar.com/reference/list-all-channels) * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -294,8 +325,8 @@ export const NotificationsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async notificationsChannel(fid: number, channelIds: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.notificationsChannel(fid, channelIds, priorityMode, cursor, options); + async notificationsChannel(apiKey: string, fid: number, channelIds: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.notificationsChannel(apiKey, fid, channelIds, priorityMode, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.notificationsChannel']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -303,6 +334,7 @@ export const NotificationsApiFp = function(configuration?: Configuration) { /** * Returns a list of notifications for a user in specific parent_urls * @summary For user by parent_urls + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {string} parentUrls Comma separated parent_urls * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -310,8 +342,8 @@ export const NotificationsApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async notificationsParentUrl(fid: number, parentUrls: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.notificationsParentUrl(fid, parentUrls, priorityMode, cursor, options); + async notificationsParentUrl(apiKey: string, fid: number, parentUrls: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.notificationsParentUrl(apiKey, fid, parentUrls, priorityMode, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['NotificationsApi.notificationsParentUrl']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -329,16 +361,18 @@ export const NotificationsApiFactory = function (configuration?: Configuration, /** * Mark notifications as seen * @summary Mark as seen + * @param {string} apiKey API key required for authentication. * @param {MarkNotificationsAsSeenReqBody} markNotificationsAsSeenReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - markNotificationsAsSeen(markNotificationsAsSeenReqBody: MarkNotificationsAsSeenReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.markNotificationsAsSeen(markNotificationsAsSeenReqBody, options).then((request) => request(axios, basePath)); + markNotificationsAsSeen(apiKey: string, markNotificationsAsSeenReqBody: MarkNotificationsAsSeenReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.markNotificationsAsSeen(apiKey, markNotificationsAsSeenReqBody, options).then((request) => request(axios, basePath)); }, /** * Returns a list of notifications for a specific FID. * @summary For user + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {NotificationType} [type] Notification type to fetch. * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -346,12 +380,13 @@ export const NotificationsApiFactory = function (configuration?: Configuration, * @param {*} [options] Override http request option. * @throws {RequiredError} */ - notifications(fid: number, type?: NotificationType, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.notifications(fid, type, priorityMode, cursor, options).then((request) => request(axios, basePath)); + notifications(apiKey: string, fid: number, type?: NotificationType, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.notifications(apiKey, fid, type, priorityMode, cursor, options).then((request) => request(axios, basePath)); }, /** * Returns a list of notifications for a user in specific channels * @summary For user by channel + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {string} channelIds Comma separated channel_ids (find list of all channels here - https://docs.neynar.com/reference/list-all-channels) * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -359,12 +394,13 @@ export const NotificationsApiFactory = function (configuration?: Configuration, * @param {*} [options] Override http request option. * @throws {RequiredError} */ - notificationsChannel(fid: number, channelIds: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.notificationsChannel(fid, channelIds, priorityMode, cursor, options).then((request) => request(axios, basePath)); + notificationsChannel(apiKey: string, fid: number, channelIds: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.notificationsChannel(apiKey, fid, channelIds, priorityMode, cursor, options).then((request) => request(axios, basePath)); }, /** * Returns a list of notifications for a user in specific parent_urls * @summary For user by parent_urls + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {string} parentUrls Comma separated parent_urls * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -372,8 +408,8 @@ export const NotificationsApiFactory = function (configuration?: Configuration, * @param {*} [options] Override http request option. * @throws {RequiredError} */ - notificationsParentUrl(fid: number, parentUrls: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.notificationsParentUrl(fid, parentUrls, priorityMode, cursor, options).then((request) => request(axios, basePath)); + notificationsParentUrl(apiKey: string, fid: number, parentUrls: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.notificationsParentUrl(apiKey, fid, parentUrls, priorityMode, cursor, options).then((request) => request(axios, basePath)); }, }; }; @@ -388,18 +424,20 @@ export class NotificationsApi extends BaseAPI { /** * Mark notifications as seen * @summary Mark as seen + * @param {string} apiKey API key required for authentication. * @param {MarkNotificationsAsSeenReqBody} markNotificationsAsSeenReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof NotificationsApi */ - public markNotificationsAsSeen(markNotificationsAsSeenReqBody: MarkNotificationsAsSeenReqBody, options?: RawAxiosRequestConfig) { - return NotificationsApiFp(this.configuration).markNotificationsAsSeen(markNotificationsAsSeenReqBody, options).then((request) => request(this.axios, this.basePath)); + public markNotificationsAsSeen(apiKey: string, markNotificationsAsSeenReqBody: MarkNotificationsAsSeenReqBody, options?: RawAxiosRequestConfig) { + return NotificationsApiFp(this.configuration).markNotificationsAsSeen(apiKey, markNotificationsAsSeenReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of notifications for a specific FID. * @summary For user + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {NotificationType} [type] Notification type to fetch. * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -408,13 +446,14 @@ export class NotificationsApi extends BaseAPI { * @throws {RequiredError} * @memberof NotificationsApi */ - public notifications(fid: number, type?: NotificationType, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig) { - return NotificationsApiFp(this.configuration).notifications(fid, type, priorityMode, cursor, options).then((request) => request(this.axios, this.basePath)); + public notifications(apiKey: string, fid: number, type?: NotificationType, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig) { + return NotificationsApiFp(this.configuration).notifications(apiKey, fid, type, priorityMode, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of notifications for a user in specific channels * @summary For user by channel + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {string} channelIds Comma separated channel_ids (find list of all channels here - https://docs.neynar.com/reference/list-all-channels) * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -423,13 +462,14 @@ export class NotificationsApi extends BaseAPI { * @throws {RequiredError} * @memberof NotificationsApi */ - public notificationsChannel(fid: number, channelIds: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig) { - return NotificationsApiFp(this.configuration).notificationsChannel(fid, channelIds, priorityMode, cursor, options).then((request) => request(this.axios, this.basePath)); + public notificationsChannel(apiKey: string, fid: number, channelIds: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig) { + return NotificationsApiFp(this.configuration).notificationsChannel(apiKey, fid, channelIds, priorityMode, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Returns a list of notifications for a user in specific parent_urls * @summary For user by parent_urls + * @param {string} apiKey API key required for authentication. * @param {number} fid FID of the user you you want to fetch notifications for. The response will respect this user\'s mutes and blocks. * @param {string} parentUrls Comma separated parent_urls * @param {boolean} [priorityMode] When true, only returns notifications from power badge users and users that the viewer follows (if viewer_fid is provided). @@ -438,8 +478,8 @@ export class NotificationsApi extends BaseAPI { * @throws {RequiredError} * @memberof NotificationsApi */ - public notificationsParentUrl(fid: number, parentUrls: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig) { - return NotificationsApiFp(this.configuration).notificationsParentUrl(fid, parentUrls, priorityMode, cursor, options).then((request) => request(this.axios, this.basePath)); + public notificationsParentUrl(apiKey: string, fid: number, parentUrls: string, priorityMode?: boolean, cursor?: string, options?: RawAxiosRequestConfig) { + return NotificationsApiFp(this.configuration).notificationsParentUrl(apiKey, fid, parentUrls, priorityMode, cursor, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/reaction-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/reaction-api.ts index b9efcc6d..382e4dc3 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/reaction-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/reaction-api.ts @@ -42,11 +42,14 @@ export const ReactionApiAxiosParamCreator = function (configuration?: Configurat /** * Delete a reaction (like or recast) to a cast \\ (In order to delete a reaction `signer_uuid` must be approved) * @summary Delete reaction + * @param {string} apiKey API key required for authentication. * @param {ReactionReqBody} reactionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteReaction: async (reactionReqBody: ReactionReqBody, options: RawAxiosRequestConfig = {}): Promise => { + deleteReaction: async (apiKey: string, reactionReqBody: ReactionReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // 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`; @@ -64,6 +67,10 @@ export const ReactionApiAxiosParamCreator = function (configuration?: Configurat // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -81,11 +88,14 @@ export const ReactionApiAxiosParamCreator = function (configuration?: Configurat /** * Post a reaction (like or recast) to a given cast \\ (In order to post a reaction `signer_uuid` must be approved) * @summary Post a reaction + * @param {string} apiKey API key required for authentication. * @param {ReactionReqBody} reactionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postReaction: async (reactionReqBody: ReactionReqBody, options: RawAxiosRequestConfig = {}): Promise => { + postReaction: async (apiKey: string, reactionReqBody: ReactionReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // 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`; @@ -103,6 +113,10 @@ export const ReactionApiAxiosParamCreator = function (configuration?: Configurat // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -120,6 +134,7 @@ export const ReactionApiAxiosParamCreator = function (configuration?: Configurat /** * Fetches reactions for a given cast * @summary Reactions for cast + * @param {string} apiKey API key required for authentication. * @param {string} hash * @param {string} types Customize which reaction types the request should search for. This is a comma-separated string that can include the following values: \'likes\' and \'recasts\'. By default api returns both. To select multiple types, use a comma-separated list of these values. * @param {number} [viewerFid] Providing this will return a list of reactions that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -128,7 +143,9 @@ export const ReactionApiAxiosParamCreator = function (configuration?: Configurat * @param {*} [options] Override http request option. * @throws {RequiredError} */ - reactionsCast: async (hash: string, types: string, viewerFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + reactionsCast: async (apiKey: string, hash: string, types: string, viewerFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('reactionsCast', 'apiKey', apiKey) // verify required parameter 'hash' is not null or undefined assertParamExists('reactionsCast', 'hash', hash) // verify required parameter 'types' is not null or undefined @@ -168,6 +185,10 @@ export const ReactionApiAxiosParamCreator = function (configuration?: Configurat localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -182,6 +203,7 @@ export const ReactionApiAxiosParamCreator = function (configuration?: Configurat /** * Fetches reactions for a given user * @summary Reactions for user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {ReactionsType} type Type of reaction to fetch (likes or recasts or all) * @param {number} [viewerFid] Providing this will return a list of reactions that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -190,7 +212,9 @@ export const ReactionApiAxiosParamCreator = function (configuration?: Configurat * @param {*} [options] Override http request option. * @throws {RequiredError} */ - reactionsUser: async (fid: number, type: ReactionsType, viewerFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + reactionsUser: async (apiKey: string, fid: number, type: ReactionsType, viewerFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('reactionsUser', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('reactionsUser', 'fid', fid) // verify required parameter 'type' is not null or undefined @@ -230,6 +254,10 @@ export const ReactionApiAxiosParamCreator = function (configuration?: Configurat localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -254,12 +282,13 @@ export const ReactionApiFp = function(configuration?: Configuration) { /** * Delete a reaction (like or recast) to a cast \\ (In order to delete a reaction `signer_uuid` must be approved) * @summary Delete reaction + * @param {string} apiKey API key required for authentication. * @param {ReactionReqBody} reactionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteReaction(reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReaction(reactionReqBody, options); + async deleteReaction(apiKey: string, reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteReaction(apiKey, reactionReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ReactionApi.deleteReaction']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -267,12 +296,13 @@ 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 Post a reaction + * @param {string} apiKey API key required for authentication. * @param {ReactionReqBody} reactionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async postReaction(reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.postReaction(reactionReqBody, options); + async postReaction(apiKey: string, reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.postReaction(apiKey, reactionReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ReactionApi.postReaction']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -280,6 +310,7 @@ export const ReactionApiFp = function(configuration?: Configuration) { /** * Fetches reactions for a given cast * @summary Reactions for cast + * @param {string} apiKey API key required for authentication. * @param {string} hash * @param {string} types Customize which reaction types the request should search for. This is a comma-separated string that can include the following values: \'likes\' and \'recasts\'. By default api returns both. To select multiple types, use a comma-separated list of these values. * @param {number} [viewerFid] Providing this will return a list of reactions that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -288,8 +319,8 @@ export const ReactionApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async reactionsCast(hash: string, types: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.reactionsCast(hash, types, viewerFid, limit, cursor, options); + async reactionsCast(apiKey: string, hash: string, types: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.reactionsCast(apiKey, hash, types, viewerFid, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ReactionApi.reactionsCast']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -297,6 +328,7 @@ export const ReactionApiFp = function(configuration?: Configuration) { /** * Fetches reactions for a given user * @summary Reactions for user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {ReactionsType} type Type of reaction to fetch (likes or recasts or all) * @param {number} [viewerFid] Providing this will return a list of reactions that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -305,8 +337,8 @@ export const ReactionApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async reactionsUser(fid: number, type: ReactionsType, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.reactionsUser(fid, type, viewerFid, limit, cursor, options); + async reactionsUser(apiKey: string, fid: number, type: ReactionsType, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.reactionsUser(apiKey, fid, type, viewerFid, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['ReactionApi.reactionsUser']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -324,26 +356,29 @@ export const ReactionApiFactory = function (configuration?: Configuration, baseP /** * Delete a reaction (like or recast) to a cast \\ (In order to delete a reaction `signer_uuid` must be approved) * @summary Delete reaction + * @param {string} apiKey API key required for authentication. * @param {ReactionReqBody} reactionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteReaction(reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteReaction(reactionReqBody, options).then((request) => request(axios, basePath)); + deleteReaction(apiKey: string, reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteReaction(apiKey, 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 Post a reaction + * @param {string} apiKey API key required for authentication. * @param {ReactionReqBody} reactionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - postReaction(reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.postReaction(reactionReqBody, options).then((request) => request(axios, basePath)); + postReaction(apiKey: string, reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.postReaction(apiKey, reactionReqBody, options).then((request) => request(axios, basePath)); }, /** * Fetches reactions for a given cast * @summary Reactions for cast + * @param {string} apiKey API key required for authentication. * @param {string} hash * @param {string} types Customize which reaction types the request should search for. This is a comma-separated string that can include the following values: \'likes\' and \'recasts\'. By default api returns both. To select multiple types, use a comma-separated list of these values. * @param {number} [viewerFid] Providing this will return a list of reactions that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -352,12 +387,13 @@ export const ReactionApiFactory = function (configuration?: Configuration, baseP * @param {*} [options] Override http request option. * @throws {RequiredError} */ - reactionsCast(hash: string, types: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.reactionsCast(hash, types, viewerFid, limit, cursor, options).then((request) => request(axios, basePath)); + reactionsCast(apiKey: string, hash: string, types: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.reactionsCast(apiKey, hash, types, viewerFid, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Fetches reactions for a given user * @summary Reactions for user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {ReactionsType} type Type of reaction to fetch (likes or recasts or all) * @param {number} [viewerFid] Providing this will return a list of reactions that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -366,8 +402,8 @@ export const ReactionApiFactory = function (configuration?: Configuration, baseP * @param {*} [options] Override http request option. * @throws {RequiredError} */ - reactionsUser(fid: number, type: ReactionsType, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.reactionsUser(fid, type, viewerFid, limit, cursor, options).then((request) => request(axios, basePath)); + reactionsUser(apiKey: string, fid: number, type: ReactionsType, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.reactionsUser(apiKey, fid, type, viewerFid, limit, cursor, options).then((request) => request(axios, basePath)); }, }; }; @@ -382,30 +418,33 @@ export class ReactionApi extends BaseAPI { /** * Delete a reaction (like or recast) to a cast \\ (In order to delete a reaction `signer_uuid` must be approved) * @summary Delete reaction + * @param {string} apiKey API key required for authentication. * @param {ReactionReqBody} reactionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReactionApi */ - public deleteReaction(reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig) { - return ReactionApiFp(this.configuration).deleteReaction(reactionReqBody, options).then((request) => request(this.axios, this.basePath)); + public deleteReaction(apiKey: string, reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig) { + return ReactionApiFp(this.configuration).deleteReaction(apiKey, 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 Post a reaction + * @param {string} apiKey API key required for authentication. * @param {ReactionReqBody} reactionReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof ReactionApi */ - public postReaction(reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig) { - return ReactionApiFp(this.configuration).postReaction(reactionReqBody, options).then((request) => request(this.axios, this.basePath)); + public postReaction(apiKey: string, reactionReqBody: ReactionReqBody, options?: RawAxiosRequestConfig) { + return ReactionApiFp(this.configuration).postReaction(apiKey, reactionReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches reactions for a given cast * @summary Reactions for cast + * @param {string} apiKey API key required for authentication. * @param {string} hash * @param {string} types Customize which reaction types the request should search for. This is a comma-separated string that can include the following values: \'likes\' and \'recasts\'. By default api returns both. To select multiple types, use a comma-separated list of these values. * @param {number} [viewerFid] Providing this will return a list of reactions that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -415,13 +454,14 @@ export class ReactionApi extends BaseAPI { * @throws {RequiredError} * @memberof ReactionApi */ - public reactionsCast(hash: string, types: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return ReactionApiFp(this.configuration).reactionsCast(hash, types, viewerFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public reactionsCast(apiKey: string, hash: string, types: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return ReactionApiFp(this.configuration).reactionsCast(apiKey, hash, types, viewerFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches reactions for a given user * @summary Reactions for user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {ReactionsType} type Type of reaction to fetch (likes or recasts or all) * @param {number} [viewerFid] Providing this will return a list of reactions that respects this user\'s mutes and blocks and includes `viewer_context`. @@ -431,8 +471,8 @@ export class ReactionApi extends BaseAPI { * @throws {RequiredError} * @memberof ReactionApi */ - public reactionsUser(fid: number, type: ReactionsType, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return ReactionApiFp(this.configuration).reactionsUser(fid, type, viewerFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public reactionsUser(apiKey: string, fid: number, type: ReactionsType, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return ReactionApiFp(this.configuration).reactionsUser(apiKey, fid, type, viewerFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/signer-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/signer-api.ts index 83508178..4ecf37d0 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/signer-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/signer-api.ts @@ -44,10 +44,13 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio /** * Creates a signer and returns the signer status. \\ **Note**: While tesing please reuse the signer, it costs money to approve a signer. * @summary Create signer + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createSigner: async (options: RawAxiosRequestConfig = {}): Promise => { + createSigner: async (apiKey: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('createSigner', 'apiKey', apiKey) const localVarPath = `/farcaster/signer`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -63,6 +66,10 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -77,11 +84,14 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio /** * Fetches the status of a developer managed signer by public key * @summary Status by public key + * @param {string} apiKey API key required for authentication. * @param {string} publicKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ - developerManagedSigner: async (publicKey: string, options: RawAxiosRequestConfig = {}): Promise => { + developerManagedSigner: async (apiKey: string, publicKey: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('developerManagedSigner', 'apiKey', apiKey) // verify required parameter 'publicKey' is not null or undefined assertParamExists('developerManagedSigner', 'publicKey', publicKey) const localVarPath = `/farcaster/signer/developer_managed`; @@ -103,6 +113,10 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio localVarQueryParameter['public_key'] = publicKey; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -117,12 +131,15 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio /** * Fetch authorization url (Fetched authorized url useful for SIWN login operation) * @summary Fetch authorization url + * @param {string} apiKey API key required for authentication. * @param {string} clientId * @param {AuthorizationUrlResponseType} responseType * @param {*} [options] Override http request option. * @throws {RequiredError} */ - fetchAuthorizationUrl: async (clientId: string, responseType: AuthorizationUrlResponseType, options: RawAxiosRequestConfig = {}): Promise => { + fetchAuthorizationUrl: async (apiKey: string, clientId: string, responseType: AuthorizationUrlResponseType, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('fetchAuthorizationUrl', 'apiKey', apiKey) // verify required parameter 'clientId' is not null or undefined assertParamExists('fetchAuthorizationUrl', 'clientId', clientId) // verify required parameter 'responseType' is not null or undefined @@ -150,6 +167,10 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio localVarQueryParameter['response_type'] = responseType; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -164,11 +185,14 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio /** * Publish a message to farcaster. The message must be signed by a signer managed by the developer. Use the @farcaster/core library to construct and sign the message. Use the Message.toJSON method on the signed message and pass the JSON in the body of this POST request. * @summary Publish message + * @param {string} apiKey API key required for authentication. * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ - publishMessage: async (body: object, options: RawAxiosRequestConfig = {}): Promise => { + publishMessage: async (apiKey: string, body: object, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('publishMessage', 'apiKey', apiKey) // verify required parameter 'body' is not null or undefined assertParamExists('publishMessage', 'body', body) const localVarPath = `/farcaster/message`; @@ -186,6 +210,10 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -203,11 +231,14 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio /** * Registers an app FID, deadline and a signature. Returns the signer status with an approval url. * @summary Register Signed Key + * @param {string} apiKey API key required for authentication. * @param {RegisterSignerKeyReqBody} registerSignerKeyReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - registerSignedKey: async (registerSignerKeyReqBody: RegisterSignerKeyReqBody, options: RawAxiosRequestConfig = {}): Promise => { + registerSignedKey: async (apiKey: string, registerSignerKeyReqBody: RegisterSignerKeyReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('registerSignedKey', 'apiKey', apiKey) // verify required parameter 'registerSignerKeyReqBody' is not null or undefined assertParamExists('registerSignedKey', 'registerSignerKeyReqBody', registerSignerKeyReqBody) const localVarPath = `/farcaster/signer/signed_key`; @@ -225,6 +256,10 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -242,11 +277,14 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio /** * Registers an signed key and returns the developer managed signer status with an approval url. * @summary Register Signed Key + * @param {string} apiKey API key required for authentication. * @param {RegisterDeveloperManagedSignedKeyReqBody} registerDeveloperManagedSignedKeyReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - registerSignedKeyForDeveloperManagedSigner: async (registerDeveloperManagedSignedKeyReqBody: RegisterDeveloperManagedSignedKeyReqBody, options: RawAxiosRequestConfig = {}): Promise => { + registerSignedKeyForDeveloperManagedSigner: async (apiKey: string, registerDeveloperManagedSignedKeyReqBody: RegisterDeveloperManagedSignedKeyReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('registerSignedKeyForDeveloperManagedSigner', 'apiKey', apiKey) // verify required parameter 'registerDeveloperManagedSignedKeyReqBody' is not null or undefined assertParamExists('registerSignedKeyForDeveloperManagedSigner', 'registerDeveloperManagedSignedKeyReqBody', registerDeveloperManagedSignedKeyReqBody) const localVarPath = `/farcaster/signer/developer_managed/signed_key`; @@ -264,6 +302,10 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -281,11 +323,14 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio /** * Gets information status of a signer by passing in a signer_uuid (Use post API to generate a signer) * @summary Status + * @param {string} apiKey API key required for authentication. * @param {string} signerUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ - signer: async (signerUuid: string, options: RawAxiosRequestConfig = {}): Promise => { + signer: async (apiKey: string, signerUuid: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('signer', 'apiKey', apiKey) // verify required parameter 'signerUuid' is not null or undefined assertParamExists('signer', 'signerUuid', signerUuid) const localVarPath = `/farcaster/signer`; @@ -307,6 +352,10 @@ export const SignerApiAxiosParamCreator = function (configuration?: Configuratio localVarQueryParameter['signer_uuid'] = signerUuid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -331,11 +380,12 @@ export const SignerApiFp = function(configuration?: Configuration) { /** * Creates a signer and returns the signer status. \\ **Note**: While tesing please reuse the signer, it costs money to approve a signer. * @summary Create signer + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async createSigner(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.createSigner(options); + async createSigner(apiKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.createSigner(apiKey, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SignerApi.createSigner']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -343,12 +393,13 @@ export const SignerApiFp = function(configuration?: Configuration) { /** * Fetches the status of a developer managed signer by public key * @summary Status by public key + * @param {string} apiKey API key required for authentication. * @param {string} publicKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async developerManagedSigner(publicKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.developerManagedSigner(publicKey, options); + async developerManagedSigner(apiKey: string, publicKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.developerManagedSigner(apiKey, publicKey, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SignerApi.developerManagedSigner']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -356,13 +407,14 @@ export const SignerApiFp = function(configuration?: Configuration) { /** * Fetch authorization url (Fetched authorized url useful for SIWN login operation) * @summary Fetch authorization url + * @param {string} apiKey API key required for authentication. * @param {string} clientId * @param {AuthorizationUrlResponseType} responseType * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async fetchAuthorizationUrl(clientId: string, responseType: AuthorizationUrlResponseType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.fetchAuthorizationUrl(clientId, responseType, options); + async fetchAuthorizationUrl(apiKey: string, clientId: string, responseType: AuthorizationUrlResponseType, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.fetchAuthorizationUrl(apiKey, clientId, responseType, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SignerApi.fetchAuthorizationUrl']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -370,12 +422,13 @@ export const SignerApiFp = function(configuration?: Configuration) { /** * Publish a message to farcaster. The message must be signed by a signer managed by the developer. Use the @farcaster/core library to construct and sign the message. Use the Message.toJSON method on the signed message and pass the JSON in the body of this POST request. * @summary Publish message + * @param {string} apiKey API key required for authentication. * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async publishMessage(body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.publishMessage(body, options); + async publishMessage(apiKey: string, body: object, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.publishMessage(apiKey, body, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SignerApi.publishMessage']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -383,12 +436,13 @@ export const SignerApiFp = function(configuration?: Configuration) { /** * Registers an app FID, deadline and a signature. Returns the signer status with an approval url. * @summary Register Signed Key + * @param {string} apiKey API key required for authentication. * @param {RegisterSignerKeyReqBody} registerSignerKeyReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async registerSignedKey(registerSignerKeyReqBody: RegisterSignerKeyReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.registerSignedKey(registerSignerKeyReqBody, options); + async registerSignedKey(apiKey: string, registerSignerKeyReqBody: RegisterSignerKeyReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.registerSignedKey(apiKey, registerSignerKeyReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SignerApi.registerSignedKey']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -396,12 +450,13 @@ export const SignerApiFp = function(configuration?: Configuration) { /** * Registers an signed key and returns the developer managed signer status with an approval url. * @summary Register Signed Key + * @param {string} apiKey API key required for authentication. * @param {RegisterDeveloperManagedSignedKeyReqBody} registerDeveloperManagedSignedKeyReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async registerSignedKeyForDeveloperManagedSigner(registerDeveloperManagedSignedKeyReqBody: RegisterDeveloperManagedSignedKeyReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.registerSignedKeyForDeveloperManagedSigner(registerDeveloperManagedSignedKeyReqBody, options); + async registerSignedKeyForDeveloperManagedSigner(apiKey: string, registerDeveloperManagedSignedKeyReqBody: RegisterDeveloperManagedSignedKeyReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.registerSignedKeyForDeveloperManagedSigner(apiKey, registerDeveloperManagedSignedKeyReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SignerApi.registerSignedKeyForDeveloperManagedSigner']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -409,12 +464,13 @@ export const SignerApiFp = function(configuration?: Configuration) { /** * Gets information status of a signer by passing in a signer_uuid (Use post API to generate a signer) * @summary Status + * @param {string} apiKey API key required for authentication. * @param {string} signerUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async signer(signerUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.signer(signerUuid, options); + async signer(apiKey: string, signerUuid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.signer(apiKey, signerUuid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SignerApi.signer']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -432,72 +488,79 @@ export const SignerApiFactory = function (configuration?: Configuration, basePat /** * Creates a signer and returns the signer status. \\ **Note**: While tesing please reuse the signer, it costs money to approve a signer. * @summary Create signer + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - createSigner(options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.createSigner(options).then((request) => request(axios, basePath)); + createSigner(apiKey: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.createSigner(apiKey, options).then((request) => request(axios, basePath)); }, /** * Fetches the status of a developer managed signer by public key * @summary Status by public key + * @param {string} apiKey API key required for authentication. * @param {string} publicKey * @param {*} [options] Override http request option. * @throws {RequiredError} */ - developerManagedSigner(publicKey: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.developerManagedSigner(publicKey, options).then((request) => request(axios, basePath)); + developerManagedSigner(apiKey: string, publicKey: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.developerManagedSigner(apiKey, publicKey, options).then((request) => request(axios, basePath)); }, /** * Fetch authorization url (Fetched authorized url useful for SIWN login operation) * @summary Fetch authorization url + * @param {string} apiKey API key required for authentication. * @param {string} clientId * @param {AuthorizationUrlResponseType} responseType * @param {*} [options] Override http request option. * @throws {RequiredError} */ - fetchAuthorizationUrl(clientId: string, responseType: AuthorizationUrlResponseType, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.fetchAuthorizationUrl(clientId, responseType, options).then((request) => request(axios, basePath)); + fetchAuthorizationUrl(apiKey: string, clientId: string, responseType: AuthorizationUrlResponseType, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.fetchAuthorizationUrl(apiKey, clientId, responseType, options).then((request) => request(axios, basePath)); }, /** * Publish a message to farcaster. The message must be signed by a signer managed by the developer. Use the @farcaster/core library to construct and sign the message. Use the Message.toJSON method on the signed message and pass the JSON in the body of this POST request. * @summary Publish message + * @param {string} apiKey API key required for authentication. * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} */ - publishMessage(body: object, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.publishMessage(body, options).then((request) => request(axios, basePath)); + publishMessage(apiKey: string, body: object, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.publishMessage(apiKey, body, options).then((request) => request(axios, basePath)); }, /** * Registers an app FID, deadline and a signature. Returns the signer status with an approval url. * @summary Register Signed Key + * @param {string} apiKey API key required for authentication. * @param {RegisterSignerKeyReqBody} registerSignerKeyReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - registerSignedKey(registerSignerKeyReqBody: RegisterSignerKeyReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.registerSignedKey(registerSignerKeyReqBody, options).then((request) => request(axios, basePath)); + registerSignedKey(apiKey: string, registerSignerKeyReqBody: RegisterSignerKeyReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.registerSignedKey(apiKey, registerSignerKeyReqBody, options).then((request) => request(axios, basePath)); }, /** * Registers an signed key and returns the developer managed signer status with an approval url. * @summary Register Signed Key + * @param {string} apiKey API key required for authentication. * @param {RegisterDeveloperManagedSignedKeyReqBody} registerDeveloperManagedSignedKeyReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - registerSignedKeyForDeveloperManagedSigner(registerDeveloperManagedSignedKeyReqBody: RegisterDeveloperManagedSignedKeyReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.registerSignedKeyForDeveloperManagedSigner(registerDeveloperManagedSignedKeyReqBody, options).then((request) => request(axios, basePath)); + registerSignedKeyForDeveloperManagedSigner(apiKey: string, registerDeveloperManagedSignedKeyReqBody: RegisterDeveloperManagedSignedKeyReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.registerSignedKeyForDeveloperManagedSigner(apiKey, registerDeveloperManagedSignedKeyReqBody, options).then((request) => request(axios, basePath)); }, /** * Gets information status of a signer by passing in a signer_uuid (Use post API to generate a signer) * @summary Status + * @param {string} apiKey API key required for authentication. * @param {string} signerUuid * @param {*} [options] Override http request option. * @throws {RequiredError} */ - signer(signerUuid: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.signer(signerUuid, options).then((request) => request(axios, basePath)); + signer(apiKey: string, signerUuid: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.signer(apiKey, signerUuid, options).then((request) => request(axios, basePath)); }, }; }; @@ -512,85 +575,92 @@ export class SignerApi extends BaseAPI { /** * Creates a signer and returns the signer status. \\ **Note**: While tesing please reuse the signer, it costs money to approve a signer. * @summary Create signer + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SignerApi */ - public createSigner(options?: RawAxiosRequestConfig) { - return SignerApiFp(this.configuration).createSigner(options).then((request) => request(this.axios, this.basePath)); + public createSigner(apiKey: string, options?: RawAxiosRequestConfig) { + return SignerApiFp(this.configuration).createSigner(apiKey, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches the status of a developer managed signer by public key * @summary Status by public key + * @param {string} apiKey API key required for authentication. * @param {string} publicKey * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SignerApi */ - public developerManagedSigner(publicKey: string, options?: RawAxiosRequestConfig) { - return SignerApiFp(this.configuration).developerManagedSigner(publicKey, options).then((request) => request(this.axios, this.basePath)); + public developerManagedSigner(apiKey: string, publicKey: string, options?: RawAxiosRequestConfig) { + return SignerApiFp(this.configuration).developerManagedSigner(apiKey, publicKey, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch authorization url (Fetched authorized url useful for SIWN login operation) * @summary Fetch authorization url + * @param {string} apiKey API key required for authentication. * @param {string} clientId * @param {AuthorizationUrlResponseType} responseType * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SignerApi */ - public fetchAuthorizationUrl(clientId: string, responseType: AuthorizationUrlResponseType, options?: RawAxiosRequestConfig) { - return SignerApiFp(this.configuration).fetchAuthorizationUrl(clientId, responseType, options).then((request) => request(this.axios, this.basePath)); + public fetchAuthorizationUrl(apiKey: string, clientId: string, responseType: AuthorizationUrlResponseType, options?: RawAxiosRequestConfig) { + return SignerApiFp(this.configuration).fetchAuthorizationUrl(apiKey, clientId, responseType, options).then((request) => request(this.axios, this.basePath)); } /** * Publish a message to farcaster. The message must be signed by a signer managed by the developer. Use the @farcaster/core library to construct and sign the message. Use the Message.toJSON method on the signed message and pass the JSON in the body of this POST request. * @summary Publish message + * @param {string} apiKey API key required for authentication. * @param {object} body * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SignerApi */ - public publishMessage(body: object, options?: RawAxiosRequestConfig) { - return SignerApiFp(this.configuration).publishMessage(body, options).then((request) => request(this.axios, this.basePath)); + public publishMessage(apiKey: string, body: object, options?: RawAxiosRequestConfig) { + return SignerApiFp(this.configuration).publishMessage(apiKey, body, options).then((request) => request(this.axios, this.basePath)); } /** * Registers an app FID, deadline and a signature. Returns the signer status with an approval url. * @summary Register Signed Key + * @param {string} apiKey API key required for authentication. * @param {RegisterSignerKeyReqBody} registerSignerKeyReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SignerApi */ - public registerSignedKey(registerSignerKeyReqBody: RegisterSignerKeyReqBody, options?: RawAxiosRequestConfig) { - return SignerApiFp(this.configuration).registerSignedKey(registerSignerKeyReqBody, options).then((request) => request(this.axios, this.basePath)); + public registerSignedKey(apiKey: string, registerSignerKeyReqBody: RegisterSignerKeyReqBody, options?: RawAxiosRequestConfig) { + return SignerApiFp(this.configuration).registerSignedKey(apiKey, registerSignerKeyReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Registers an signed key and returns the developer managed signer status with an approval url. * @summary Register Signed Key + * @param {string} apiKey API key required for authentication. * @param {RegisterDeveloperManagedSignedKeyReqBody} registerDeveloperManagedSignedKeyReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SignerApi */ - public registerSignedKeyForDeveloperManagedSigner(registerDeveloperManagedSignedKeyReqBody: RegisterDeveloperManagedSignedKeyReqBody, options?: RawAxiosRequestConfig) { - return SignerApiFp(this.configuration).registerSignedKeyForDeveloperManagedSigner(registerDeveloperManagedSignedKeyReqBody, options).then((request) => request(this.axios, this.basePath)); + public registerSignedKeyForDeveloperManagedSigner(apiKey: string, registerDeveloperManagedSignedKeyReqBody: RegisterDeveloperManagedSignedKeyReqBody, options?: RawAxiosRequestConfig) { + return SignerApiFp(this.configuration).registerSignedKeyForDeveloperManagedSigner(apiKey, registerDeveloperManagedSignedKeyReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Gets information status of a signer by passing in a signer_uuid (Use post API to generate a signer) * @summary Status + * @param {string} apiKey API key required for authentication. * @param {string} signerUuid * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SignerApi */ - public signer(signerUuid: string, options?: RawAxiosRequestConfig) { - return SignerApiFp(this.configuration).signer(signerUuid, options).then((request) => request(this.axios, this.basePath)); + public signer(apiKey: string, signerUuid: string, options?: RawAxiosRequestConfig) { + return SignerApiFp(this.configuration).signer(apiKey, signerUuid, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/storage-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/storage-api.ts index 2c57449f..5e8deb51 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/storage-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/storage-api.ts @@ -42,11 +42,14 @@ export const StorageApiAxiosParamCreator = function (configuration?: Configurati /** * This api will help you rent units of storage for an year for a specific FID. A storage unit lets you store 5000 casts, 2500 reactions and 2500 links. * @summary Buy storage + * @param {string} apiKey API key required for authentication. * @param {BuyStorageReqBody} buyStorageReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - buyStorage: async (buyStorageReqBody: BuyStorageReqBody, options: RawAxiosRequestConfig = {}): Promise => { + buyStorage: async (apiKey: string, buyStorageReqBody: BuyStorageReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('buyStorage', 'apiKey', apiKey) // verify required parameter 'buyStorageReqBody' is not null or undefined assertParamExists('buyStorage', 'buyStorageReqBody', buyStorageReqBody) const localVarPath = `/farcaster/storage/buy`; @@ -64,6 +67,10 @@ export const StorageApiAxiosParamCreator = function (configuration?: Configurati // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -81,11 +88,14 @@ export const StorageApiAxiosParamCreator = function (configuration?: Configurati /** * Fetches storage allocations for a given user * @summary Allocation of user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {*} [options] Override http request option. * @throws {RequiredError} */ - storageAllocations: async (fid: number, options: RawAxiosRequestConfig = {}): Promise => { + storageAllocations: async (apiKey: string, fid: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('storageAllocations', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('storageAllocations', 'fid', fid) const localVarPath = `/farcaster/storage/allocations`; @@ -107,6 +117,10 @@ export const StorageApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['fid'] = fid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -121,11 +135,14 @@ export const StorageApiAxiosParamCreator = function (configuration?: Configurati /** * Fetches storage usage for a given user * @summary Usage of user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {*} [options] Override http request option. * @throws {RequiredError} */ - storageUsage: async (fid: number, options: RawAxiosRequestConfig = {}): Promise => { + storageUsage: async (apiKey: string, fid: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('storageUsage', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('storageUsage', 'fid', fid) const localVarPath = `/farcaster/storage/usage`; @@ -147,6 +164,10 @@ export const StorageApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['fid'] = fid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -171,12 +192,13 @@ export const StorageApiFp = function(configuration?: Configuration) { /** * This api will help you rent units of storage for an year for a specific FID. A storage unit lets you store 5000 casts, 2500 reactions and 2500 links. * @summary Buy storage + * @param {string} apiKey API key required for authentication. * @param {BuyStorageReqBody} buyStorageReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async buyStorage(buyStorageReqBody: BuyStorageReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.buyStorage(buyStorageReqBody, options); + async buyStorage(apiKey: string, buyStorageReqBody: BuyStorageReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.buyStorage(apiKey, buyStorageReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['StorageApi.buyStorage']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -184,12 +206,13 @@ export const StorageApiFp = function(configuration?: Configuration) { /** * Fetches storage allocations for a given user * @summary Allocation of user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async storageAllocations(fid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.storageAllocations(fid, options); + async storageAllocations(apiKey: string, fid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.storageAllocations(apiKey, fid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['StorageApi.storageAllocations']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -197,12 +220,13 @@ export const StorageApiFp = function(configuration?: Configuration) { /** * Fetches storage usage for a given user * @summary Usage of user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async storageUsage(fid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.storageUsage(fid, options); + async storageUsage(apiKey: string, fid: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.storageUsage(apiKey, fid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['StorageApi.storageUsage']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -220,32 +244,35 @@ export const StorageApiFactory = function (configuration?: Configuration, basePa /** * This api will help you rent units of storage for an year for a specific FID. A storage unit lets you store 5000 casts, 2500 reactions and 2500 links. * @summary Buy storage + * @param {string} apiKey API key required for authentication. * @param {BuyStorageReqBody} buyStorageReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - buyStorage(buyStorageReqBody: BuyStorageReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.buyStorage(buyStorageReqBody, options).then((request) => request(axios, basePath)); + buyStorage(apiKey: string, buyStorageReqBody: BuyStorageReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.buyStorage(apiKey, buyStorageReqBody, options).then((request) => request(axios, basePath)); }, /** * Fetches storage allocations for a given user * @summary Allocation of user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {*} [options] Override http request option. * @throws {RequiredError} */ - storageAllocations(fid: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.storageAllocations(fid, options).then((request) => request(axios, basePath)); + storageAllocations(apiKey: string, fid: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.storageAllocations(apiKey, fid, options).then((request) => request(axios, basePath)); }, /** * Fetches storage usage for a given user * @summary Usage of user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {*} [options] Override http request option. * @throws {RequiredError} */ - storageUsage(fid: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.storageUsage(fid, options).then((request) => request(axios, basePath)); + storageUsage(apiKey: string, fid: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.storageUsage(apiKey, fid, options).then((request) => request(axios, basePath)); }, }; }; @@ -260,37 +287,40 @@ export class StorageApi extends BaseAPI { /** * This api will help you rent units of storage for an year for a specific FID. A storage unit lets you store 5000 casts, 2500 reactions and 2500 links. * @summary Buy storage + * @param {string} apiKey API key required for authentication. * @param {BuyStorageReqBody} buyStorageReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StorageApi */ - public buyStorage(buyStorageReqBody: BuyStorageReqBody, options?: RawAxiosRequestConfig) { - return StorageApiFp(this.configuration).buyStorage(buyStorageReqBody, options).then((request) => request(this.axios, this.basePath)); + public buyStorage(apiKey: string, buyStorageReqBody: BuyStorageReqBody, options?: RawAxiosRequestConfig) { + return StorageApiFp(this.configuration).buyStorage(apiKey, buyStorageReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches storage allocations for a given user * @summary Allocation of user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StorageApi */ - public storageAllocations(fid: number, options?: RawAxiosRequestConfig) { - return StorageApiFp(this.configuration).storageAllocations(fid, options).then((request) => request(this.axios, this.basePath)); + public storageAllocations(apiKey: string, fid: number, options?: RawAxiosRequestConfig) { + return StorageApiFp(this.configuration).storageAllocations(apiKey, fid, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches storage usage for a given user * @summary Usage of user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof StorageApi */ - public storageUsage(fid: number, options?: RawAxiosRequestConfig) { - return StorageApiFp(this.configuration).storageUsage(fid, options).then((request) => request(this.axios, this.basePath)); + public storageUsage(apiKey: string, fid: number, options?: RawAxiosRequestConfig) { + return StorageApiFp(this.configuration).storageUsage(apiKey, fid, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/subscribers-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/subscribers-api.ts index 1b78f249..ed81331e 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/subscribers-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/subscribers-api.ts @@ -42,13 +42,16 @@ export const SubscribersApiAxiosParamCreator = function (configuration?: Configu /** * Fetch what FIDs and contracts a FID is subscribed to. * @summary Subscribed to + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProvider} subscriptionProvider * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - subscribedTo: async (fid: number, subscriptionProvider: SubscriptionProvider, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + subscribedTo: async (apiKey: string, fid: number, subscriptionProvider: SubscriptionProvider, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('subscribedTo', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('subscribedTo', 'fid', fid) // verify required parameter 'subscriptionProvider' is not null or undefined @@ -80,6 +83,10 @@ export const SubscribersApiAxiosParamCreator = function (configuration?: Configu localVarQueryParameter['subscription_provider'] = subscriptionProvider; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -94,13 +101,16 @@ export const SubscribersApiAxiosParamCreator = function (configuration?: Configu /** * Fetch subscribers for a given FID\'s contracts. Doesn\'t return addresses that don\'t have an FID. * @summary Subscribers of a user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProviders} subscriptionProvider * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - subscribers: async (fid: number, subscriptionProvider: SubscriptionProviders, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + subscribers: async (apiKey: string, fid: number, subscriptionProvider: SubscriptionProviders, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('subscribers', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('subscribers', 'fid', fid) // verify required parameter 'subscriptionProvider' is not null or undefined @@ -132,6 +142,10 @@ export const SubscribersApiAxiosParamCreator = function (configuration?: Configu localVarQueryParameter['subscription_provider'] = subscriptionProvider; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -146,12 +160,15 @@ export const SubscribersApiAxiosParamCreator = function (configuration?: Configu /** * Fetch created subscriptions for a given FID\'s. * @summary Subscriptions created by FID + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProvider} subscriptionProvider * @param {*} [options] Override http request option. * @throws {RequiredError} */ - subscriptionsCreated: async (fid: number, subscriptionProvider: SubscriptionProvider, options: RawAxiosRequestConfig = {}): Promise => { + subscriptionsCreated: async (apiKey: string, fid: number, subscriptionProvider: SubscriptionProvider, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('subscriptionsCreated', 'apiKey', apiKey) // verify required parameter 'fid' is not null or undefined assertParamExists('subscriptionsCreated', 'fid', fid) // verify required parameter 'subscriptionProvider' is not null or undefined @@ -179,6 +196,10 @@ export const SubscribersApiAxiosParamCreator = function (configuration?: Configu localVarQueryParameter['subscription_provider'] = subscriptionProvider; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -203,14 +224,15 @@ export const SubscribersApiFp = function(configuration?: Configuration) { /** * Fetch what FIDs and contracts a FID is subscribed to. * @summary Subscribed to + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProvider} subscriptionProvider * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async subscribedTo(fid: number, subscriptionProvider: SubscriptionProvider, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.subscribedTo(fid, subscriptionProvider, viewerFid, options); + async subscribedTo(apiKey: string, fid: number, subscriptionProvider: SubscriptionProvider, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.subscribedTo(apiKey, fid, subscriptionProvider, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SubscribersApi.subscribedTo']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -218,14 +240,15 @@ export const SubscribersApiFp = function(configuration?: 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 {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProviders} subscriptionProvider * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async subscribers(fid: number, subscriptionProvider: SubscriptionProviders, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.subscribers(fid, subscriptionProvider, viewerFid, options); + async subscribers(apiKey: string, fid: number, subscriptionProvider: SubscriptionProviders, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.subscribers(apiKey, fid, subscriptionProvider, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SubscribersApi.subscribers']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -233,13 +256,14 @@ export const SubscribersApiFp = function(configuration?: Configuration) { /** * Fetch created subscriptions for a given FID\'s. * @summary Subscriptions created by FID + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProvider} subscriptionProvider * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async subscriptionsCreated(fid: number, subscriptionProvider: SubscriptionProvider, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.subscriptionsCreated(fid, subscriptionProvider, options); + async subscriptionsCreated(apiKey: string, fid: number, subscriptionProvider: SubscriptionProvider, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.subscriptionsCreated(apiKey, fid, subscriptionProvider, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['SubscribersApi.subscriptionsCreated']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -257,37 +281,40 @@ export const SubscribersApiFactory = function (configuration?: Configuration, ba /** * Fetch what FIDs and contracts a FID is subscribed to. * @summary Subscribed to + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProvider} subscriptionProvider * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - subscribedTo(fid: number, subscriptionProvider: SubscriptionProvider, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.subscribedTo(fid, subscriptionProvider, viewerFid, options).then((request) => request(axios, basePath)); + subscribedTo(apiKey: string, fid: number, subscriptionProvider: SubscriptionProvider, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.subscribedTo(apiKey, fid, subscriptionProvider, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Fetch subscribers for a given FID\'s contracts. Doesn\'t return addresses that don\'t have an FID. * @summary Subscribers of a user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProviders} subscriptionProvider * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - subscribers(fid: number, subscriptionProvider: SubscriptionProviders, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.subscribers(fid, subscriptionProvider, viewerFid, options).then((request) => request(axios, basePath)); + subscribers(apiKey: string, fid: number, subscriptionProvider: SubscriptionProviders, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.subscribers(apiKey, fid, subscriptionProvider, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Fetch created subscriptions for a given FID\'s. * @summary Subscriptions created by FID + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProvider} subscriptionProvider * @param {*} [options] Override http request option. * @throws {RequiredError} */ - subscriptionsCreated(fid: number, subscriptionProvider: SubscriptionProvider, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.subscriptionsCreated(fid, subscriptionProvider, options).then((request) => request(axios, basePath)); + subscriptionsCreated(apiKey: string, fid: number, subscriptionProvider: SubscriptionProvider, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.subscriptionsCreated(apiKey, fid, subscriptionProvider, options).then((request) => request(axios, basePath)); }, }; }; @@ -302,6 +329,7 @@ export class SubscribersApi extends BaseAPI { /** * Fetch what FIDs and contracts a FID is subscribed to. * @summary Subscribed to + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProvider} subscriptionProvider * @param {number} [viewerFid] @@ -309,13 +337,14 @@ export class SubscribersApi extends BaseAPI { * @throws {RequiredError} * @memberof SubscribersApi */ - public subscribedTo(fid: number, subscriptionProvider: SubscriptionProvider, viewerFid?: number, options?: RawAxiosRequestConfig) { - return SubscribersApiFp(this.configuration).subscribedTo(fid, subscriptionProvider, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public subscribedTo(apiKey: string, fid: number, subscriptionProvider: SubscriptionProvider, viewerFid?: number, options?: RawAxiosRequestConfig) { + return SubscribersApiFp(this.configuration).subscribedTo(apiKey, fid, subscriptionProvider, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch subscribers for a given FID\'s contracts. Doesn\'t return addresses that don\'t have an FID. * @summary Subscribers of a user + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProviders} subscriptionProvider * @param {number} [viewerFid] @@ -323,21 +352,22 @@ export class SubscribersApi extends BaseAPI { * @throws {RequiredError} * @memberof SubscribersApi */ - public subscribers(fid: number, subscriptionProvider: SubscriptionProviders, viewerFid?: number, options?: RawAxiosRequestConfig) { - return SubscribersApiFp(this.configuration).subscribers(fid, subscriptionProvider, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public subscribers(apiKey: string, fid: number, subscriptionProvider: SubscriptionProviders, viewerFid?: number, options?: RawAxiosRequestConfig) { + return SubscribersApiFp(this.configuration).subscribers(apiKey, fid, subscriptionProvider, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch created subscriptions for a given FID\'s. * @summary Subscriptions created by FID + * @param {string} apiKey API key required for authentication. * @param {number} fid * @param {SubscriptionProvider} subscriptionProvider * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof SubscribersApi */ - public subscriptionsCreated(fid: number, subscriptionProvider: SubscriptionProvider, options?: RawAxiosRequestConfig) { - return SubscribersApiFp(this.configuration).subscriptionsCreated(fid, subscriptionProvider, options).then((request) => request(this.axios, this.basePath)); + public subscriptionsCreated(apiKey: string, fid: number, subscriptionProvider: SubscriptionProvider, options?: RawAxiosRequestConfig) { + return SubscribersApiFp(this.configuration).subscriptionsCreated(apiKey, fid, subscriptionProvider, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/user-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/user-api.ts index 3d321898..cb7a1240 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/user-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/user-api.ts @@ -64,13 +64,16 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Warpcast has deprecated the active badge. Use user/power endpoint instead. * @summary Fetch active users + * @param {string} apiKey API key required for authentication. * @param {number} [limit] * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ - activeUsers: async (limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + activeUsers: async (apiKey: string, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('activeUsers', 'apiKey', apiKey) const localVarPath = `/farcaster/user/active`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -94,6 +97,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -108,11 +115,14 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Removes verification for an eth address for the user \\ (In order to delete verification `signer_uuid` must be approved) * @summary Delete verification + * @param {string} apiKey API key required for authentication. * @param {RemoveVerificationReqBody} removeVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - farcasterUserVerificationDelete: async (removeVerificationReqBody: RemoveVerificationReqBody, options: RawAxiosRequestConfig = {}): Promise => { + farcasterUserVerificationDelete: async (apiKey: string, removeVerificationReqBody: RemoveVerificationReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('farcasterUserVerificationDelete', 'apiKey', apiKey) // verify required parameter 'removeVerificationReqBody' is not null or undefined assertParamExists('farcasterUserVerificationDelete', 'removeVerificationReqBody', removeVerificationReqBody) const localVarPath = `/farcaster/user/verification`; @@ -130,6 +140,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -147,11 +161,14 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Add verification + * @param {string} apiKey API key required for authentication. * @param {AddVerificationReqBody} addVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - farcasterUserVerificationPost: async (addVerificationReqBody: AddVerificationReqBody, options: RawAxiosRequestConfig = {}): Promise => { + farcasterUserVerificationPost: async (apiKey: string, addVerificationReqBody: AddVerificationReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('farcasterUserVerificationPost', 'apiKey', apiKey) // verify required parameter 'addVerificationReqBody' is not null or undefined assertParamExists('farcasterUserVerificationPost', 'addVerificationReqBody', addVerificationReqBody) const localVarPath = `/farcaster/user/verification`; @@ -169,6 +186,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -186,11 +207,14 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Follow a user \\ (In order to follow a user `signer_uuid` must be approved) * @summary Follow user + * @param {string} apiKey API key required for authentication. * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - followUser: async (followReqBody: FollowReqBody, options: RawAxiosRequestConfig = {}): Promise => { + followUser: async (apiKey: string, followReqBody: FollowReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('followUser', 'apiKey', apiKey) // verify required parameter 'followReqBody' is not null or undefined assertParamExists('followUser', 'followReqBody', followReqBody) const localVarPath = `/farcaster/user/follow`; @@ -208,6 +232,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -225,10 +253,13 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetches FID to [assign it to new user](https://docs.neynar.com/reference/register-user) * @summary Fetch fresh FID + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFreshFid: async (options: RawAxiosRequestConfig = {}): Promise => { + getFreshFid: async (apiKey: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('getFreshFid', 'apiKey', apiKey) const localVarPath = `/farcaster/user/fid`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -244,6 +275,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -258,11 +293,14 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Lookup a user by custody-address * @summary By custody-address + * @param {string} apiKey API key required for authentication. * @param {string} custodyAddress Custody Address associated with mnemonic * @param {*} [options] Override http request option. * @throws {RequiredError} */ - lookupUserByCustodyAddress: async (custodyAddress: string, options: RawAxiosRequestConfig = {}): Promise => { + lookupUserByCustodyAddress: async (apiKey: string, custodyAddress: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('lookupUserByCustodyAddress', 'apiKey', apiKey) // verify required parameter 'custodyAddress' is not null or undefined assertParamExists('lookupUserByCustodyAddress', 'custodyAddress', custodyAddress) const localVarPath = `/farcaster/user/custody-address`; @@ -284,6 +322,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['custody_address'] = custodyAddress; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -298,13 +340,16 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetches power users based on Warpcast power badges. Information is updated once a day. * @summary Power users + * @param {string} apiKey API key required for authentication. * @param {number} [viewerFid] * @param {number} [limit] Number of power users to fetch, max 100 * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - powerUsers: async (viewerFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + powerUsers: async (apiKey: string, viewerFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('powerUsers', 'apiKey', apiKey) const localVarPath = `/farcaster/user/power`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -332,6 +377,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -346,11 +395,14 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Register account on farcaster. **Note:** This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user. * @summary Register new account + * @param {string} apiKey API key required for authentication. * @param {RegisterUserReqBody} registerUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - registerUser: async (registerUserReqBody: RegisterUserReqBody, options: RawAxiosRequestConfig = {}): Promise => { + registerUser: async (apiKey: string, registerUserReqBody: RegisterUserReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('registerUser', 'apiKey', apiKey) // verify required parameter 'registerUserReqBody' is not null or undefined assertParamExists('registerUser', 'registerUserReqBody', registerUserReqBody) const localVarPath = `/farcaster/user`; @@ -368,6 +420,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -385,11 +441,14 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Unfollow a user \\ (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow user + * @param {string} apiKey API key required for authentication. * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - unfollowUser: async (followReqBody: FollowReqBody, options: RawAxiosRequestConfig = {}): Promise => { + unfollowUser: async (apiKey: string, followReqBody: FollowReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('unfollowUser', 'apiKey', apiKey) // verify required parameter 'followReqBody' is not null or undefined assertParamExists('unfollowUser', 'followReqBody', followReqBody) const localVarPath = `/farcaster/user/follow`; @@ -407,6 +466,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -424,11 +487,14 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Update user profile \\ (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile + * @param {string} apiKey API key required for authentication. * @param {UpdateUserReqBody} updateUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateUser: async (updateUserReqBody: UpdateUserReqBody, options: RawAxiosRequestConfig = {}): Promise => { + updateUser: async (apiKey: string, updateUserReqBody: UpdateUserReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('updateUser', 'apiKey', apiKey) // verify required parameter 'updateUserReqBody' is not null or undefined assertParamExists('updateUser', 'updateUserReqBody', updateUserReqBody) const localVarPath = `/farcaster/user`; @@ -446,6 +512,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -463,12 +533,15 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetches information about multiple users based on FIDs * @summary By FIDs + * @param {string} apiKey API key required for authentication. * @param {string} fids Comma separated list of FIDs, up to 100 at a time * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userBulk: async (fids: string, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + userBulk: async (apiKey: string, fids: string, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('userBulk', 'apiKey', apiKey) // verify required parameter 'fids' is not null or undefined assertParamExists('userBulk', 'fids', fids) const localVarPath = `/farcaster/user/bulk`; @@ -494,6 +567,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['viewer_fid'] = viewerFid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -508,13 +585,16 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetches all users based on multiple Ethereum or Solana addresses. Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses. A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users. You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses. * @summary By Eth or Sol addresses + * @param {string} apiKey API key required for authentication. * @param {string} addresses Comma separated list of Ethereum addresses, up to 350 at a time * @param {string} [addressTypes] Customize which address types the request should search for. This is a comma-separated string that can include the following values: \'custody_address\' and \'verified_address\'. By default api returns both. To select multiple types, use a comma-separated list of these values. * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userBulkByAddress: async (addresses: string, addressTypes?: string, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + userBulkByAddress: async (apiKey: string, addresses: string, addressTypes?: string, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('userBulkByAddress', 'apiKey', apiKey) // verify required parameter 'addresses' is not null or undefined assertParamExists('userBulkByAddress', 'addresses', addresses) const localVarPath = `/farcaster/user/bulk-by-address`; @@ -544,6 +624,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['viewer_fid'] = viewerFid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -558,12 +642,15 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetches a single hydrated user object given a username * @summary By username + * @param {string} apiKey API key required for authentication. * @param {string} username Username of the user to fetch * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userByUsernameV2: async (username: string, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + userByUsernameV2: async (apiKey: string, username: string, viewerFid?: number, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('userByUsernameV2', 'apiKey', apiKey) // verify required parameter 'username' is not null or undefined assertParamExists('userByUsernameV2', 'username', username) const localVarPath = `/farcaster/user/by_username`; @@ -589,6 +676,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['viewer_fid'] = viewerFid; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -603,10 +694,13 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Fetches power users and respond in a backwards compatible format to Warpcast\'s deprecated power badge endpoint. * @summary Power user FIDs + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userPowerLite: async (options: RawAxiosRequestConfig = {}): Promise => { + userPowerLite: async (apiKey: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('userPowerLite', 'apiKey', apiKey) const localVarPath = `/farcaster/user/power_lite`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -622,6 +716,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -636,6 +734,7 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) /** * Search for Usernames * @summary Search for Usernames + * @param {string} apiKey API key required for authentication. * @param {string} q * @param {number} [viewerFid] Providing this will return search results that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {number} [limit] @@ -643,7 +742,9 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userSearch: async (q: string, viewerFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + userSearch: async (apiKey: string, q: string, viewerFid?: number, limit?: number, cursor?: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('userSearch', 'apiKey', apiKey) // verify required parameter 'q' is not null or undefined assertParamExists('userSearch', 'q', q) const localVarPath = `/farcaster/user/search`; @@ -677,6 +778,10 @@ export const UserApiAxiosParamCreator = function (configuration?: Configuration) localVarQueryParameter['cursor'] = cursor; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -701,14 +806,15 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Warpcast has deprecated the active badge. Use user/power endpoint instead. * @summary Fetch active users + * @param {string} apiKey API key required for authentication. * @param {number} [limit] * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ - async activeUsers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.activeUsers(limit, cursor, options); + async activeUsers(apiKey: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.activeUsers(apiKey, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.activeUsers']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -716,12 +822,13 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Removes verification for an eth address for the user \\ (In order to delete verification `signer_uuid` must be approved) * @summary Delete verification + * @param {string} apiKey API key required for authentication. * @param {RemoveVerificationReqBody} removeVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async farcasterUserVerificationDelete(removeVerificationReqBody: RemoveVerificationReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.farcasterUserVerificationDelete(removeVerificationReqBody, options); + async farcasterUserVerificationDelete(apiKey: string, removeVerificationReqBody: RemoveVerificationReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.farcasterUserVerificationDelete(apiKey, removeVerificationReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.farcasterUserVerificationDelete']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -729,12 +836,13 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Add verification + * @param {string} apiKey API key required for authentication. * @param {AddVerificationReqBody} addVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async farcasterUserVerificationPost(addVerificationReqBody: AddVerificationReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.farcasterUserVerificationPost(addVerificationReqBody, options); + async farcasterUserVerificationPost(apiKey: string, addVerificationReqBody: AddVerificationReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.farcasterUserVerificationPost(apiKey, addVerificationReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.farcasterUserVerificationPost']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -742,12 +850,13 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Follow a user \\ (In order to follow a user `signer_uuid` must be approved) * @summary Follow user + * @param {string} apiKey API key required for authentication. * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async followUser(followReqBody: FollowReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.followUser(followReqBody, options); + async followUser(apiKey: string, followReqBody: FollowReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.followUser(apiKey, followReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.followUser']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -755,11 +864,12 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Fetches FID to [assign it to new user](https://docs.neynar.com/reference/register-user) * @summary Fetch fresh FID + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async getFreshFid(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.getFreshFid(options); + async getFreshFid(apiKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.getFreshFid(apiKey, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.getFreshFid']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -767,12 +877,13 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Lookup a user by custody-address * @summary By custody-address + * @param {string} apiKey API key required for authentication. * @param {string} custodyAddress Custody Address associated with mnemonic * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async lookupUserByCustodyAddress(custodyAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.lookupUserByCustodyAddress(custodyAddress, options); + async lookupUserByCustodyAddress(apiKey: string, custodyAddress: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.lookupUserByCustodyAddress(apiKey, custodyAddress, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.lookupUserByCustodyAddress']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -780,14 +891,15 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Fetches power users based on Warpcast power badges. Information is updated once a day. * @summary Power users + * @param {string} apiKey API key required for authentication. * @param {number} [viewerFid] * @param {number} [limit] Number of power users to fetch, max 100 * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async powerUsers(viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.powerUsers(viewerFid, limit, cursor, options); + async powerUsers(apiKey: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.powerUsers(apiKey, viewerFid, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.powerUsers']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -795,12 +907,13 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Register account on farcaster. **Note:** This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user. * @summary Register new account + * @param {string} apiKey API key required for authentication. * @param {RegisterUserReqBody} registerUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async registerUser(registerUserReqBody: RegisterUserReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.registerUser(registerUserReqBody, options); + async registerUser(apiKey: string, registerUserReqBody: RegisterUserReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.registerUser(apiKey, registerUserReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.registerUser']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -808,12 +921,13 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Unfollow a user \\ (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow user + * @param {string} apiKey API key required for authentication. * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async unfollowUser(followReqBody: FollowReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.unfollowUser(followReqBody, options); + async unfollowUser(apiKey: string, followReqBody: FollowReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.unfollowUser(apiKey, followReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.unfollowUser']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -821,12 +935,13 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Update user profile \\ (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile + * @param {string} apiKey API key required for authentication. * @param {UpdateUserReqBody} updateUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateUser(updateUserReqBody: UpdateUserReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateUser(updateUserReqBody, options); + async updateUser(apiKey: string, updateUserReqBody: UpdateUserReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateUser(apiKey, updateUserReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.updateUser']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -834,13 +949,14 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Fetches information about multiple users based on FIDs * @summary By FIDs + * @param {string} apiKey API key required for authentication. * @param {string} fids Comma separated list of FIDs, up to 100 at a time * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async userBulk(fids: string, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userBulk(fids, viewerFid, options); + async userBulk(apiKey: string, fids: string, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.userBulk(apiKey, fids, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.userBulk']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -848,14 +964,15 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Fetches all users based on multiple Ethereum or Solana addresses. Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses. A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users. You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses. * @summary By Eth or Sol addresses + * @param {string} apiKey API key required for authentication. * @param {string} addresses Comma separated list of Ethereum addresses, up to 350 at a time * @param {string} [addressTypes] Customize which address types the request should search for. This is a comma-separated string that can include the following values: \'custody_address\' and \'verified_address\'. By default api returns both. To select multiple types, use a comma-separated list of these values. * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async userBulkByAddress(addresses: string, addressTypes?: string, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: Array; }>> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userBulkByAddress(addresses, addressTypes, viewerFid, options); + async userBulkByAddress(apiKey: string, addresses: string, addressTypes?: string, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: Array; }>> { + const localVarAxiosArgs = await localVarAxiosParamCreator.userBulkByAddress(apiKey, addresses, addressTypes, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.userBulkByAddress']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -863,13 +980,14 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Fetches a single hydrated user object given a username * @summary By username + * @param {string} apiKey API key required for authentication. * @param {string} username Username of the user to fetch * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async userByUsernameV2(username: string, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userByUsernameV2(username, viewerFid, options); + async userByUsernameV2(apiKey: string, username: string, viewerFid?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.userByUsernameV2(apiKey, username, viewerFid, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.userByUsernameV2']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -877,11 +995,12 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Fetches power users and respond in a backwards compatible format to Warpcast\'s deprecated power badge endpoint. * @summary Power user FIDs + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async userPowerLite(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userPowerLite(options); + async userPowerLite(apiKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.userPowerLite(apiKey, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.userPowerLite']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -889,6 +1008,7 @@ export const UserApiFp = function(configuration?: Configuration) { /** * Search for Usernames * @summary Search for Usernames + * @param {string} apiKey API key required for authentication. * @param {string} q * @param {number} [viewerFid] Providing this will return search results that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {number} [limit] @@ -896,8 +1016,8 @@ export const UserApiFp = function(configuration?: Configuration) { * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async userSearch(q: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.userSearch(q, viewerFid, limit, cursor, options); + async userSearch(apiKey: string, q: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.userSearch(apiKey, q, viewerFid, limit, cursor, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['UserApi.userSearch']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -915,152 +1035,167 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? /** * Warpcast has deprecated the active badge. Use user/power endpoint instead. * @summary Fetch active users + * @param {string} apiKey API key required for authentication. * @param {number} [limit] * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ - activeUsers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.activeUsers(limit, cursor, options).then((request) => request(axios, basePath)); + activeUsers(apiKey: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.activeUsers(apiKey, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Removes verification for an eth address for the user \\ (In order to delete verification `signer_uuid` must be approved) * @summary Delete verification + * @param {string} apiKey API key required for authentication. * @param {RemoveVerificationReqBody} removeVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - farcasterUserVerificationDelete(removeVerificationReqBody: RemoveVerificationReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.farcasterUserVerificationDelete(removeVerificationReqBody, options).then((request) => request(axios, basePath)); + farcasterUserVerificationDelete(apiKey: string, removeVerificationReqBody: RemoveVerificationReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.farcasterUserVerificationDelete(apiKey, removeVerificationReqBody, options).then((request) => request(axios, basePath)); }, /** * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Add verification + * @param {string} apiKey API key required for authentication. * @param {AddVerificationReqBody} addVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - farcasterUserVerificationPost(addVerificationReqBody: AddVerificationReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.farcasterUserVerificationPost(addVerificationReqBody, options).then((request) => request(axios, basePath)); + farcasterUserVerificationPost(apiKey: string, addVerificationReqBody: AddVerificationReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.farcasterUserVerificationPost(apiKey, addVerificationReqBody, options).then((request) => request(axios, basePath)); }, /** * Follow a user \\ (In order to follow a user `signer_uuid` must be approved) * @summary Follow user + * @param {string} apiKey API key required for authentication. * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - followUser(followReqBody: FollowReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.followUser(followReqBody, options).then((request) => request(axios, basePath)); + followUser(apiKey: string, followReqBody: FollowReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.followUser(apiKey, followReqBody, options).then((request) => request(axios, basePath)); }, /** * Fetches FID to [assign it to new user](https://docs.neynar.com/reference/register-user) * @summary Fetch fresh FID + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - getFreshFid(options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.getFreshFid(options).then((request) => request(axios, basePath)); + getFreshFid(apiKey: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.getFreshFid(apiKey, options).then((request) => request(axios, basePath)); }, /** * Lookup a user by custody-address * @summary By custody-address + * @param {string} apiKey API key required for authentication. * @param {string} custodyAddress Custody Address associated with mnemonic * @param {*} [options] Override http request option. * @throws {RequiredError} */ - lookupUserByCustodyAddress(custodyAddress: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.lookupUserByCustodyAddress(custodyAddress, options).then((request) => request(axios, basePath)); + lookupUserByCustodyAddress(apiKey: string, custodyAddress: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.lookupUserByCustodyAddress(apiKey, custodyAddress, options).then((request) => request(axios, basePath)); }, /** * Fetches power users based on Warpcast power badges. Information is updated once a day. * @summary Power users + * @param {string} apiKey API key required for authentication. * @param {number} [viewerFid] * @param {number} [limit] Number of power users to fetch, max 100 * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - powerUsers(viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.powerUsers(viewerFid, limit, cursor, options).then((request) => request(axios, basePath)); + powerUsers(apiKey: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.powerUsers(apiKey, viewerFid, limit, cursor, options).then((request) => request(axios, basePath)); }, /** * Register account on farcaster. **Note:** This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user. * @summary Register new account + * @param {string} apiKey API key required for authentication. * @param {RegisterUserReqBody} registerUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - registerUser(registerUserReqBody: RegisterUserReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.registerUser(registerUserReqBody, options).then((request) => request(axios, basePath)); + registerUser(apiKey: string, registerUserReqBody: RegisterUserReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.registerUser(apiKey, registerUserReqBody, options).then((request) => request(axios, basePath)); }, /** * Unfollow a user \\ (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow user + * @param {string} apiKey API key required for authentication. * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - unfollowUser(followReqBody: FollowReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.unfollowUser(followReqBody, options).then((request) => request(axios, basePath)); + unfollowUser(apiKey: string, followReqBody: FollowReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.unfollowUser(apiKey, followReqBody, options).then((request) => request(axios, basePath)); }, /** * Update user profile \\ (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile + * @param {string} apiKey API key required for authentication. * @param {UpdateUserReqBody} updateUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateUser(updateUserReqBody: UpdateUserReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateUser(updateUserReqBody, options).then((request) => request(axios, basePath)); + updateUser(apiKey: string, updateUserReqBody: UpdateUserReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateUser(apiKey, updateUserReqBody, options).then((request) => request(axios, basePath)); }, /** * Fetches information about multiple users based on FIDs * @summary By FIDs + * @param {string} apiKey API key required for authentication. * @param {string} fids Comma separated list of FIDs, up to 100 at a time * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userBulk(fids: string, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userBulk(fids, viewerFid, options).then((request) => request(axios, basePath)); + userBulk(apiKey: string, fids: string, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.userBulk(apiKey, fids, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Fetches all users based on multiple Ethereum or Solana addresses. Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses. A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users. You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses. * @summary By Eth or Sol addresses + * @param {string} apiKey API key required for authentication. * @param {string} addresses Comma separated list of Ethereum addresses, up to 350 at a time * @param {string} [addressTypes] Customize which address types the request should search for. This is a comma-separated string that can include the following values: \'custody_address\' and \'verified_address\'. By default api returns both. To select multiple types, use a comma-separated list of these values. * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userBulkByAddress(addresses: string, addressTypes?: string, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: Array; }> { - return localVarFp.userBulkByAddress(addresses, addressTypes, viewerFid, options).then((request) => request(axios, basePath)); + userBulkByAddress(apiKey: string, addresses: string, addressTypes?: string, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise<{ [key: string]: Array; }> { + return localVarFp.userBulkByAddress(apiKey, addresses, addressTypes, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Fetches a single hydrated user object given a username * @summary By username + * @param {string} apiKey API key required for authentication. * @param {string} username Username of the user to fetch * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userByUsernameV2(username: string, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userByUsernameV2(username, viewerFid, options).then((request) => request(axios, basePath)); + userByUsernameV2(apiKey: string, username: string, viewerFid?: number, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.userByUsernameV2(apiKey, username, viewerFid, options).then((request) => request(axios, basePath)); }, /** * Fetches power users and respond in a backwards compatible format to Warpcast\'s deprecated power badge endpoint. * @summary Power user FIDs + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userPowerLite(options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userPowerLite(options).then((request) => request(axios, basePath)); + userPowerLite(apiKey: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.userPowerLite(apiKey, options).then((request) => request(axios, basePath)); }, /** * Search for Usernames * @summary Search for Usernames + * @param {string} apiKey API key required for authentication. * @param {string} q * @param {number} [viewerFid] Providing this will return search results that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {number} [limit] @@ -1068,8 +1203,8 @@ export const UserApiFactory = function (configuration?: Configuration, basePath? * @param {*} [options] Override http request option. * @throws {RequiredError} */ - userSearch(q: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.userSearch(q, viewerFid, limit, cursor, options).then((request) => request(axios, basePath)); + userSearch(apiKey: string, q: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.userSearch(apiKey, q, viewerFid, limit, cursor, options).then((request) => request(axios, basePath)); }, }; }; @@ -1084,6 +1219,7 @@ export class UserApi extends BaseAPI { /** * Warpcast has deprecated the active badge. Use user/power endpoint instead. * @summary Fetch active users + * @param {string} apiKey API key required for authentication. * @param {number} [limit] * @param {string} [cursor] Pagination cursor. * @param {*} [options] Override http request option. @@ -1091,72 +1227,78 @@ export class UserApi extends BaseAPI { * @throws {RequiredError} * @memberof UserApi */ - public activeUsers(limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).activeUsers(limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public activeUsers(apiKey: string, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).activeUsers(apiKey, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Removes verification for an eth address for the user \\ (In order to delete verification `signer_uuid` must be approved) * @summary Delete verification + * @param {string} apiKey API key required for authentication. * @param {RemoveVerificationReqBody} removeVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ - public farcasterUserVerificationDelete(removeVerificationReqBody: RemoveVerificationReqBody, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).farcasterUserVerificationDelete(removeVerificationReqBody, options).then((request) => request(this.axios, this.basePath)); + public farcasterUserVerificationDelete(apiKey: string, removeVerificationReqBody: RemoveVerificationReqBody, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).farcasterUserVerificationDelete(apiKey, removeVerificationReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Adds verification for an eth address or contract for the user \\ (In order to add verification `signer_uuid` must be approved) * @summary Add verification + * @param {string} apiKey API key required for authentication. * @param {AddVerificationReqBody} addVerificationReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ - public farcasterUserVerificationPost(addVerificationReqBody: AddVerificationReqBody, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).farcasterUserVerificationPost(addVerificationReqBody, options).then((request) => request(this.axios, this.basePath)); + public farcasterUserVerificationPost(apiKey: string, addVerificationReqBody: AddVerificationReqBody, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).farcasterUserVerificationPost(apiKey, addVerificationReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Follow a user \\ (In order to follow a user `signer_uuid` must be approved) * @summary Follow user + * @param {string} apiKey API key required for authentication. * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ - public followUser(followReqBody: FollowReqBody, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).followUser(followReqBody, options).then((request) => request(this.axios, this.basePath)); + public followUser(apiKey: string, followReqBody: FollowReqBody, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).followUser(apiKey, followReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches FID to [assign it to new user](https://docs.neynar.com/reference/register-user) * @summary Fetch fresh FID + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ - public getFreshFid(options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).getFreshFid(options).then((request) => request(this.axios, this.basePath)); + public getFreshFid(apiKey: string, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).getFreshFid(apiKey, options).then((request) => request(this.axios, this.basePath)); } /** * Lookup a user by custody-address * @summary By custody-address + * @param {string} apiKey API key required for authentication. * @param {string} custodyAddress Custody Address associated with mnemonic * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ - public lookupUserByCustodyAddress(custodyAddress: string, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).lookupUserByCustodyAddress(custodyAddress, options).then((request) => request(this.axios, this.basePath)); + public lookupUserByCustodyAddress(apiKey: string, custodyAddress: string, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).lookupUserByCustodyAddress(apiKey, custodyAddress, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches power users based on Warpcast power badges. Information is updated once a day. * @summary Power users + * @param {string} apiKey API key required for authentication. * @param {number} [viewerFid] * @param {number} [limit] Number of power users to fetch, max 100 * @param {string} [cursor] Pagination cursor. @@ -1164,62 +1306,67 @@ export class UserApi extends BaseAPI { * @throws {RequiredError} * @memberof UserApi */ - public powerUsers(viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).powerUsers(viewerFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public powerUsers(apiKey: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).powerUsers(apiKey, viewerFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } /** * Register account on farcaster. **Note:** This API must be called within 10 minutes of the fetch FID API call (i.e., /v2/farcaster/user/fid). Otherwise, Neynar will assign this FID to another available user. * @summary Register new account + * @param {string} apiKey API key required for authentication. * @param {RegisterUserReqBody} registerUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ - public registerUser(registerUserReqBody: RegisterUserReqBody, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).registerUser(registerUserReqBody, options).then((request) => request(this.axios, this.basePath)); + public registerUser(apiKey: string, registerUserReqBody: RegisterUserReqBody, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).registerUser(apiKey, registerUserReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Unfollow a user \\ (In order to unfollow a user `signer_uuid` must be approved) * @summary Unfollow user + * @param {string} apiKey API key required for authentication. * @param {FollowReqBody} followReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ - public unfollowUser(followReqBody: FollowReqBody, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).unfollowUser(followReqBody, options).then((request) => request(this.axios, this.basePath)); + public unfollowUser(apiKey: string, followReqBody: FollowReqBody, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).unfollowUser(apiKey, followReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Update user profile \\ (In order to update user\'s profile `signer_uuid` must be approved) * @summary Update user profile + * @param {string} apiKey API key required for authentication. * @param {UpdateUserReqBody} updateUserReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ - public updateUser(updateUserReqBody: UpdateUserReqBody, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).updateUser(updateUserReqBody, options).then((request) => request(this.axios, this.basePath)); + public updateUser(apiKey: string, updateUserReqBody: UpdateUserReqBody, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).updateUser(apiKey, updateUserReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches information about multiple users based on FIDs * @summary By FIDs + * @param {string} apiKey API key required for authentication. * @param {string} fids Comma separated list of FIDs, up to 100 at a time * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ - public userBulk(fids: string, viewerFid?: number, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).userBulk(fids, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public userBulk(apiKey: string, fids: string, viewerFid?: number, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).userBulk(apiKey, fids, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches all users based on multiple Ethereum or Solana addresses. Each farcaster user has a custody Ethereum address and optionally verified Ethereum or Solana addresses. This endpoint returns all users that have any of the given addresses as their custody or verified Ethereum or Solana addresses. A custody address can be associated with only 1 farcaster user at a time but a verified address can be associated with multiple users. You can pass in Ethereum and Solana addresses, comma separated, in the same request. The response will contain users associated with the given addresses. * @summary By Eth or Sol addresses + * @param {string} apiKey API key required for authentication. * @param {string} addresses Comma separated list of Ethereum addresses, up to 350 at a time * @param {string} [addressTypes] Customize which address types the request should search for. This is a comma-separated string that can include the following values: \'custody_address\' and \'verified_address\'. By default api returns both. To select multiple types, use a comma-separated list of these values. * @param {number} [viewerFid] @@ -1227,37 +1374,40 @@ export class UserApi extends BaseAPI { * @throws {RequiredError} * @memberof UserApi */ - public userBulkByAddress(addresses: string, addressTypes?: string, viewerFid?: number, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).userBulkByAddress(addresses, addressTypes, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public userBulkByAddress(apiKey: string, addresses: string, addressTypes?: string, viewerFid?: number, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).userBulkByAddress(apiKey, addresses, addressTypes, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches a single hydrated user object given a username * @summary By username + * @param {string} apiKey API key required for authentication. * @param {string} username Username of the user to fetch * @param {number} [viewerFid] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ - public userByUsernameV2(username: string, viewerFid?: number, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).userByUsernameV2(username, viewerFid, options).then((request) => request(this.axios, this.basePath)); + public userByUsernameV2(apiKey: string, username: string, viewerFid?: number, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).userByUsernameV2(apiKey, username, viewerFid, options).then((request) => request(this.axios, this.basePath)); } /** * Fetches power users and respond in a backwards compatible format to Warpcast\'s deprecated power badge endpoint. * @summary Power user FIDs + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof UserApi */ - public userPowerLite(options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).userPowerLite(options).then((request) => request(this.axios, this.basePath)); + public userPowerLite(apiKey: string, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).userPowerLite(apiKey, options).then((request) => request(this.axios, this.basePath)); } /** * Search for Usernames * @summary Search for Usernames + * @param {string} apiKey API key required for authentication. * @param {string} q * @param {number} [viewerFid] Providing this will return search results that respects this user\'s mutes and blocks and includes `viewer_context`. * @param {number} [limit] @@ -1266,8 +1416,8 @@ export class UserApi extends BaseAPI { * @throws {RequiredError} * @memberof UserApi */ - public userSearch(q: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { - return UserApiFp(this.configuration).userSearch(q, viewerFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); + public userSearch(apiKey: string, q: string, viewerFid?: number, limit?: number, cursor?: string, options?: RawAxiosRequestConfig) { + return UserApiFp(this.configuration).userSearch(apiKey, q, viewerFid, limit, cursor, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/apis/webhook-api.ts b/src/neynar-api/v2/openapi-farcaster/apis/webhook-api.ts index 0f69fb04..ce70a1c8 100644 --- a/src/neynar-api/v2/openapi-farcaster/apis/webhook-api.ts +++ b/src/neynar-api/v2/openapi-farcaster/apis/webhook-api.ts @@ -44,11 +44,14 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati /** * Delete a webhook * @summary Delete a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookDeleteReqBody} webhookDeleteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteWebhook: async (webhookDeleteReqBody: WebhookDeleteReqBody, options: RawAxiosRequestConfig = {}): Promise => { + deleteWebhook: async (apiKey: string, webhookDeleteReqBody: WebhookDeleteReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('deleteWebhook', 'apiKey', apiKey) // verify required parameter 'webhookDeleteReqBody' is not null or undefined assertParamExists('deleteWebhook', 'webhookDeleteReqBody', webhookDeleteReqBody) const localVarPath = `/farcaster/webhook`; @@ -66,6 +69,10 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -83,10 +90,13 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati /** * Fetch a list of webhooks associated to a user * @summary Associated webhooks of user + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - fetchWebhooks: async (options: RawAxiosRequestConfig = {}): Promise => { + fetchWebhooks: async (apiKey: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('fetchWebhooks', 'apiKey', apiKey) const localVarPath = `/farcaster/webhook/list`; // use dummy base URL string because the URL constructor only accepts absolute URLs. const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL); @@ -102,6 +112,10 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -116,11 +130,14 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati /** * Fetch a webhook * @summary Fetch a webhook + * @param {string} apiKey API key required for authentication. * @param {string} webhookId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - lookupWebhook: async (webhookId: string, options: RawAxiosRequestConfig = {}): Promise => { + lookupWebhook: async (apiKey: string, webhookId: string, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('lookupWebhook', 'apiKey', apiKey) // verify required parameter 'webhookId' is not null or undefined assertParamExists('lookupWebhook', 'webhookId', webhookId) const localVarPath = `/farcaster/webhook`; @@ -142,6 +159,10 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati localVarQueryParameter['webhook_id'] = webhookId; } + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + setSearchParams(localVarUrlObj, localVarQueryParameter); @@ -156,11 +177,14 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati /** * Create a webhook * @summary Create a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookPostReqBody} webhookPostReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - publishWebhook: async (webhookPostReqBody: WebhookPostReqBody, options: RawAxiosRequestConfig = {}): Promise => { + publishWebhook: async (apiKey: string, webhookPostReqBody: WebhookPostReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('publishWebhook', 'apiKey', apiKey) // verify required parameter 'webhookPostReqBody' is not null or undefined assertParamExists('publishWebhook', 'webhookPostReqBody', webhookPostReqBody) const localVarPath = `/farcaster/webhook`; @@ -178,6 +202,10 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -195,11 +223,14 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati /** * Update a webhook * @summary Update a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookPutReqBody} webhookPutReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateWebhook: async (webhookPutReqBody: WebhookPutReqBody, options: RawAxiosRequestConfig = {}): Promise => { + updateWebhook: async (apiKey: string, webhookPutReqBody: WebhookPutReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('updateWebhook', 'apiKey', apiKey) // verify required parameter 'webhookPutReqBody' is not null or undefined assertParamExists('updateWebhook', 'webhookPutReqBody', webhookPutReqBody) const localVarPath = `/farcaster/webhook`; @@ -217,6 +248,10 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -234,11 +269,14 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati /** * Update webhook active status * @summary Update webhook status + * @param {string} apiKey API key required for authentication. * @param {WebhookPatchReqBody} webhookPatchReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateWebhookActiveStatus: async (webhookPatchReqBody: WebhookPatchReqBody, options: RawAxiosRequestConfig = {}): Promise => { + updateWebhookActiveStatus: async (apiKey: string, webhookPatchReqBody: WebhookPatchReqBody, options: RawAxiosRequestConfig = {}): Promise => { + // verify required parameter 'apiKey' is not null or undefined + assertParamExists('updateWebhookActiveStatus', 'apiKey', apiKey) // verify required parameter 'webhookPatchReqBody' is not null or undefined assertParamExists('updateWebhookActiveStatus', 'webhookPatchReqBody', webhookPatchReqBody) const localVarPath = `/farcaster/webhook`; @@ -256,6 +294,10 @@ export const WebhookApiAxiosParamCreator = function (configuration?: Configurati // authentication ApiKeyAuth required await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration) + if (apiKey != null) { + localVarHeaderParameter['api_key'] = String(apiKey); + } + localVarHeaderParameter['Content-Type'] = 'application/json'; @@ -283,12 +325,13 @@ export const WebhookApiFp = function(configuration?: Configuration) { /** * Delete a webhook * @summary Delete a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookDeleteReqBody} webhookDeleteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async deleteWebhook(webhookDeleteReqBody: WebhookDeleteReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWebhook(webhookDeleteReqBody, options); + async deleteWebhook(apiKey: string, webhookDeleteReqBody: WebhookDeleteReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.deleteWebhook(apiKey, webhookDeleteReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['WebhookApi.deleteWebhook']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -296,11 +339,12 @@ export const WebhookApiFp = function(configuration?: Configuration) { /** * Fetch a list of webhooks associated to a user * @summary Associated webhooks of user + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async fetchWebhooks(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.fetchWebhooks(options); + async fetchWebhooks(apiKey: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.fetchWebhooks(apiKey, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['WebhookApi.fetchWebhooks']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -308,12 +352,13 @@ export const WebhookApiFp = function(configuration?: Configuration) { /** * Fetch a webhook * @summary Fetch a webhook + * @param {string} apiKey API key required for authentication. * @param {string} webhookId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async lookupWebhook(webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.lookupWebhook(webhookId, options); + async lookupWebhook(apiKey: string, webhookId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.lookupWebhook(apiKey, webhookId, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['WebhookApi.lookupWebhook']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -321,12 +366,13 @@ export const WebhookApiFp = function(configuration?: Configuration) { /** * Create a webhook * @summary Create a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookPostReqBody} webhookPostReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async publishWebhook(webhookPostReqBody: WebhookPostReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.publishWebhook(webhookPostReqBody, options); + async publishWebhook(apiKey: string, webhookPostReqBody: WebhookPostReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.publishWebhook(apiKey, webhookPostReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['WebhookApi.publishWebhook']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -334,12 +380,13 @@ export const WebhookApiFp = function(configuration?: Configuration) { /** * Update a webhook * @summary Update a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookPutReqBody} webhookPutReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateWebhook(webhookPutReqBody: WebhookPutReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateWebhook(webhookPutReqBody, options); + async updateWebhook(apiKey: string, webhookPutReqBody: WebhookPutReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateWebhook(apiKey, webhookPutReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['WebhookApi.updateWebhook']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -347,12 +394,13 @@ export const WebhookApiFp = function(configuration?: Configuration) { /** * Update webhook active status * @summary Update webhook status + * @param {string} apiKey API key required for authentication. * @param {WebhookPatchReqBody} webhookPatchReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - async updateWebhookActiveStatus(webhookPatchReqBody: WebhookPatchReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { - const localVarAxiosArgs = await localVarAxiosParamCreator.updateWebhookActiveStatus(webhookPatchReqBody, options); + async updateWebhookActiveStatus(apiKey: string, webhookPatchReqBody: WebhookPatchReqBody, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise> { + const localVarAxiosArgs = await localVarAxiosParamCreator.updateWebhookActiveStatus(apiKey, webhookPatchReqBody, options); const localVarOperationServerIndex = configuration?.serverIndex ?? 0; const localVarOperationServerBasePath = operationServerMap['WebhookApi.updateWebhookActiveStatus']?.[localVarOperationServerIndex]?.url; return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath); @@ -370,61 +418,67 @@ export const WebhookApiFactory = function (configuration?: Configuration, basePa /** * Delete a webhook * @summary Delete a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookDeleteReqBody} webhookDeleteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - deleteWebhook(webhookDeleteReqBody: WebhookDeleteReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.deleteWebhook(webhookDeleteReqBody, options).then((request) => request(axios, basePath)); + deleteWebhook(apiKey: string, webhookDeleteReqBody: WebhookDeleteReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.deleteWebhook(apiKey, webhookDeleteReqBody, options).then((request) => request(axios, basePath)); }, /** * Fetch a list of webhooks associated to a user * @summary Associated webhooks of user + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} */ - fetchWebhooks(options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.fetchWebhooks(options).then((request) => request(axios, basePath)); + fetchWebhooks(apiKey: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.fetchWebhooks(apiKey, options).then((request) => request(axios, basePath)); }, /** * Fetch a webhook * @summary Fetch a webhook + * @param {string} apiKey API key required for authentication. * @param {string} webhookId * @param {*} [options] Override http request option. * @throws {RequiredError} */ - lookupWebhook(webhookId: string, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.lookupWebhook(webhookId, options).then((request) => request(axios, basePath)); + lookupWebhook(apiKey: string, webhookId: string, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.lookupWebhook(apiKey, webhookId, options).then((request) => request(axios, basePath)); }, /** * Create a webhook * @summary Create a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookPostReqBody} webhookPostReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - publishWebhook(webhookPostReqBody: WebhookPostReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.publishWebhook(webhookPostReqBody, options).then((request) => request(axios, basePath)); + publishWebhook(apiKey: string, webhookPostReqBody: WebhookPostReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.publishWebhook(apiKey, webhookPostReqBody, options).then((request) => request(axios, basePath)); }, /** * Update a webhook * @summary Update a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookPutReqBody} webhookPutReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateWebhook(webhookPutReqBody: WebhookPutReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateWebhook(webhookPutReqBody, options).then((request) => request(axios, basePath)); + updateWebhook(apiKey: string, webhookPutReqBody: WebhookPutReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateWebhook(apiKey, webhookPutReqBody, options).then((request) => request(axios, basePath)); }, /** * Update webhook active status * @summary Update webhook status + * @param {string} apiKey API key required for authentication. * @param {WebhookPatchReqBody} webhookPatchReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ - updateWebhookActiveStatus(webhookPatchReqBody: WebhookPatchReqBody, options?: RawAxiosRequestConfig): AxiosPromise { - return localVarFp.updateWebhookActiveStatus(webhookPatchReqBody, options).then((request) => request(axios, basePath)); + updateWebhookActiveStatus(apiKey: string, webhookPatchReqBody: WebhookPatchReqBody, options?: RawAxiosRequestConfig): AxiosPromise { + return localVarFp.updateWebhookActiveStatus(apiKey, webhookPatchReqBody, options).then((request) => request(axios, basePath)); }, }; }; @@ -439,72 +493,78 @@ export class WebhookApi extends BaseAPI { /** * Delete a webhook * @summary Delete a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookDeleteReqBody} webhookDeleteReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ - public deleteWebhook(webhookDeleteReqBody: WebhookDeleteReqBody, options?: RawAxiosRequestConfig) { - return WebhookApiFp(this.configuration).deleteWebhook(webhookDeleteReqBody, options).then((request) => request(this.axios, this.basePath)); + public deleteWebhook(apiKey: string, webhookDeleteReqBody: WebhookDeleteReqBody, options?: RawAxiosRequestConfig) { + return WebhookApiFp(this.configuration).deleteWebhook(apiKey, webhookDeleteReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch a list of webhooks associated to a user * @summary Associated webhooks of user + * @param {string} apiKey API key required for authentication. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ - public fetchWebhooks(options?: RawAxiosRequestConfig) { - return WebhookApiFp(this.configuration).fetchWebhooks(options).then((request) => request(this.axios, this.basePath)); + public fetchWebhooks(apiKey: string, options?: RawAxiosRequestConfig) { + return WebhookApiFp(this.configuration).fetchWebhooks(apiKey, options).then((request) => request(this.axios, this.basePath)); } /** * Fetch a webhook * @summary Fetch a webhook + * @param {string} apiKey API key required for authentication. * @param {string} webhookId * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ - public lookupWebhook(webhookId: string, options?: RawAxiosRequestConfig) { - return WebhookApiFp(this.configuration).lookupWebhook(webhookId, options).then((request) => request(this.axios, this.basePath)); + public lookupWebhook(apiKey: string, webhookId: string, options?: RawAxiosRequestConfig) { + return WebhookApiFp(this.configuration).lookupWebhook(apiKey, webhookId, options).then((request) => request(this.axios, this.basePath)); } /** * Create a webhook * @summary Create a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookPostReqBody} webhookPostReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ - public publishWebhook(webhookPostReqBody: WebhookPostReqBody, options?: RawAxiosRequestConfig) { - return WebhookApiFp(this.configuration).publishWebhook(webhookPostReqBody, options).then((request) => request(this.axios, this.basePath)); + public publishWebhook(apiKey: string, webhookPostReqBody: WebhookPostReqBody, options?: RawAxiosRequestConfig) { + return WebhookApiFp(this.configuration).publishWebhook(apiKey, webhookPostReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Update a webhook * @summary Update a webhook + * @param {string} apiKey API key required for authentication. * @param {WebhookPutReqBody} webhookPutReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ - public updateWebhook(webhookPutReqBody: WebhookPutReqBody, options?: RawAxiosRequestConfig) { - return WebhookApiFp(this.configuration).updateWebhook(webhookPutReqBody, options).then((request) => request(this.axios, this.basePath)); + public updateWebhook(apiKey: string, webhookPutReqBody: WebhookPutReqBody, options?: RawAxiosRequestConfig) { + return WebhookApiFp(this.configuration).updateWebhook(apiKey, webhookPutReqBody, options).then((request) => request(this.axios, this.basePath)); } /** * Update webhook active status * @summary Update webhook status + * @param {string} apiKey API key required for authentication. * @param {WebhookPatchReqBody} webhookPatchReqBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof WebhookApi */ - public updateWebhookActiveStatus(webhookPatchReqBody: WebhookPatchReqBody, options?: RawAxiosRequestConfig) { - return WebhookApiFp(this.configuration).updateWebhookActiveStatus(webhookPatchReqBody, options).then((request) => request(this.axios, this.basePath)); + public updateWebhookActiveStatus(apiKey: string, webhookPatchReqBody: WebhookPatchReqBody, options?: RawAxiosRequestConfig) { + return WebhookApiFp(this.configuration).updateWebhookActiveStatus(apiKey, webhookPatchReqBody, options).then((request) => request(this.axios, this.basePath)); } } diff --git a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations-any-of.ts b/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations-any-of.ts deleted file mode 100644 index 3bb62de9..00000000 --- a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations-any-of.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Farcaster API V2 - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 2.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import type { CastWithInteractionsAndConversationsRef } from './cast-with-interactions-and-conversations-ref'; - -/** - * - * @export - * @interface CastWithInteractionsAndConversationsAnyOf - */ -export interface CastWithInteractionsAndConversationsAnyOf { - /** - * note: This is recursive. It contains the direct replies to the cast and their direct replies up to n reply_depth. - * @type {Array} - * @memberof CastWithInteractionsAndConversationsAnyOf - */ - 'direct_replies': Array; -} - diff --git a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations-ref-any-of.ts b/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations-ref-any-of.ts deleted file mode 100644 index 9c063a7b..00000000 --- a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations-ref-any-of.ts +++ /dev/null @@ -1,30 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Farcaster API V2 - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 2.0 - * - * - * 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 CastWithInteractionsAndConversationsRefAnyOf - */ -export interface CastWithInteractionsAndConversationsRefAnyOf { - /** - * note: This is recursive. It contains the direct replies to the cast and their direct replies up to n reply_depth. - * @type {Array} - * @memberof CastWithInteractionsAndConversationsRefAnyOf - */ - 'direct_replies': Array; -} - diff --git a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations-ref.ts b/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations-ref.ts index 21b05737..6e893b7e 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations-ref.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations-ref.ts @@ -27,9 +27,6 @@ import type { CastViewerContext } from './cast-viewer-context'; import type { CastWithInteractions } from './cast-with-interactions'; // May contain unused imports in some cases // @ts-ignore -import type { CastWithInteractionsAndConversationsRefAnyOf } from './cast-with-interactions-and-conversations-ref-any-of'; -// May contain unused imports in some cases -// @ts-ignore import type { CastWithInteractionsReactions } from './cast-with-interactions-reactions'; // May contain unused imports in some cases // @ts-ignore @@ -51,126 +48,10 @@ import type { Frame } from './frame'; import type { User } from './user'; /** + * @type CastWithInteractionsAndConversationsRef * Reference to CastWithInteractionsAndConversations to avoid circular reference * @export - * @interface CastWithInteractionsAndConversationsRef */ -export interface CastWithInteractionsAndConversationsRef { - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'hash': string; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'parent_hash': string; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'parent_url': string; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'root_parent_url': string; - /** - * - * @type {CastEmbeddedParentAuthor} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'parent_author': CastEmbeddedParentAuthor; - /** - * - * @type {User} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'author': User; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'text': string; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'timestamp': string; - /** - * - * @type {Array} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'embeds': Array; - /** - * - * @type {CastNotificationType} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'type'?: CastNotificationType; - /** - * - * @type {Array} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'frames'?: Array; - /** - * - * @type {CastWithInteractionsReactions} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'reactions': CastWithInteractionsReactions; - /** - * - * @type {CastWithInteractionsReplies} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'replies': CastWithInteractionsReplies; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'thread_hash': string; - /** - * - * @type {Array} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'mentioned_profiles': Array; - /** - * - * @type {ChannelOrDehydratedChannel} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'channel': ChannelOrDehydratedChannel; - /** - * - * @type {CastViewerContext} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'viewer_context'?: CastViewerContext; - /** - * - * @type {ChannelUserContext} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'author_channel_context'?: ChannelUserContext; - /** - * note: This is recursive. It contains the direct replies to the cast and their direct replies up to n reply_depth. - * @type {Array} - * @memberof CastWithInteractionsAndConversationsRef - */ - 'direct_replies': Array; -} - +export type CastWithInteractionsAndConversationsRef = CastWithInteractions; diff --git a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations.ts b/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations.ts index deef42c7..ad430c35 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-and-conversations.ts @@ -27,9 +27,6 @@ import type { CastViewerContext } from './cast-viewer-context'; import type { CastWithInteractions } from './cast-with-interactions'; // May contain unused imports in some cases // @ts-ignore -import type { CastWithInteractionsAndConversationsAnyOf } from './cast-with-interactions-and-conversations-any-of'; -// May contain unused imports in some cases -// @ts-ignore import type { CastWithInteractionsAndConversationsRef } from './cast-with-interactions-and-conversations-ref'; // May contain unused imports in some cases // @ts-ignore @@ -54,126 +51,9 @@ import type { Frame } from './frame'; import type { User } from './user'; /** - * + * @type CastWithInteractionsAndConversations * @export - * @interface CastWithInteractionsAndConversations */ -export interface CastWithInteractionsAndConversations { - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversations - */ - 'hash': string; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversations - */ - 'parent_hash': string; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversations - */ - 'parent_url': string; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversations - */ - 'root_parent_url': string; - /** - * - * @type {CastEmbeddedParentAuthor} - * @memberof CastWithInteractionsAndConversations - */ - 'parent_author': CastEmbeddedParentAuthor; - /** - * - * @type {User} - * @memberof CastWithInteractionsAndConversations - */ - 'author': User; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversations - */ - 'text': string; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversations - */ - 'timestamp': string; - /** - * - * @type {Array} - * @memberof CastWithInteractionsAndConversations - */ - 'embeds': Array; - /** - * - * @type {CastNotificationType} - * @memberof CastWithInteractionsAndConversations - */ - 'type'?: CastNotificationType; - /** - * - * @type {Array} - * @memberof CastWithInteractionsAndConversations - */ - 'frames'?: Array; - /** - * - * @type {CastWithInteractionsReactions} - * @memberof CastWithInteractionsAndConversations - */ - 'reactions': CastWithInteractionsReactions; - /** - * - * @type {CastWithInteractionsReplies} - * @memberof CastWithInteractionsAndConversations - */ - 'replies': CastWithInteractionsReplies; - /** - * - * @type {string} - * @memberof CastWithInteractionsAndConversations - */ - 'thread_hash': string; - /** - * - * @type {Array} - * @memberof CastWithInteractionsAndConversations - */ - 'mentioned_profiles': Array; - /** - * - * @type {ChannelOrDehydratedChannel} - * @memberof CastWithInteractionsAndConversations - */ - 'channel': ChannelOrDehydratedChannel; - /** - * - * @type {CastViewerContext} - * @memberof CastWithInteractionsAndConversations - */ - 'viewer_context'?: CastViewerContext; - /** - * - * @type {ChannelUserContext} - * @memberof CastWithInteractionsAndConversations - */ - 'author_channel_context'?: ChannelUserContext; - /** - * note: This is recursive. It contains the direct replies to the cast and their direct replies up to n reply_depth. - * @type {Array} - * @memberof CastWithInteractionsAndConversations - */ - 'direct_replies': Array; -} - +export type CastWithInteractionsAndConversations = CastWithInteractions; diff --git a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-any-of.ts b/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-any-of.ts deleted file mode 100644 index 14669a52..00000000 --- a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions-any-of.ts +++ /dev/null @@ -1,93 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Farcaster API V2 - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 2.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import type { CastViewerContext } from './cast-viewer-context'; -// May contain unused imports in some cases -// @ts-ignore -import type { CastWithInteractionsReactions } from './cast-with-interactions-reactions'; -// May contain unused imports in some cases -// @ts-ignore -import type { CastWithInteractionsReplies } from './cast-with-interactions-replies'; -// May contain unused imports in some cases -// @ts-ignore -import type { ChannelOrDehydratedChannel } from './channel-or-dehydrated-channel'; -// May contain unused imports in some cases -// @ts-ignore -import type { ChannelUserContext } from './channel-user-context'; -// May contain unused imports in some cases -// @ts-ignore -import type { Frame } from './frame'; -// May contain unused imports in some cases -// @ts-ignore -import type { User } from './user'; - -/** - * - * @export - * @interface CastWithInteractionsAnyOf - */ -export interface CastWithInteractionsAnyOf { - /** - * - * @type {Array} - * @memberof CastWithInteractionsAnyOf - */ - 'frames'?: Array; - /** - * - * @type {CastWithInteractionsReactions} - * @memberof CastWithInteractionsAnyOf - */ - 'reactions': CastWithInteractionsReactions; - /** - * - * @type {CastWithInteractionsReplies} - * @memberof CastWithInteractionsAnyOf - */ - 'replies': CastWithInteractionsReplies; - /** - * - * @type {string} - * @memberof CastWithInteractionsAnyOf - */ - 'thread_hash': string | null; - /** - * - * @type {Array} - * @memberof CastWithInteractionsAnyOf - */ - 'mentioned_profiles': Array; - /** - * - * @type {ChannelOrDehydratedChannel} - * @memberof CastWithInteractionsAnyOf - */ - 'channel': ChannelOrDehydratedChannel | null; - /** - * - * @type {CastViewerContext} - * @memberof CastWithInteractionsAnyOf - */ - 'viewer_context'?: CastViewerContext; - /** - * - * @type {ChannelUserContext} - * @memberof CastWithInteractionsAnyOf - */ - 'author_channel_context'?: ChannelUserContext; -} - diff --git a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions.ts b/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions.ts index 8ba4a00c..3e3fc41c 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/cast-with-interactions.ts @@ -27,9 +27,6 @@ import type { CastNotificationType } from './cast-notification-type'; import type { CastViewerContext } from './cast-viewer-context'; // May contain unused imports in some cases // @ts-ignore -import type { CastWithInteractionsAnyOf } from './cast-with-interactions-any-of'; -// May contain unused imports in some cases -// @ts-ignore import type { CastWithInteractionsReactions } from './cast-with-interactions-reactions'; // May contain unused imports in some cases // @ts-ignore @@ -51,120 +48,9 @@ import type { Frame } from './frame'; import type { User } from './user'; /** - * + * @type CastWithInteractions * @export - * @interface CastWithInteractions */ -export interface CastWithInteractions { - /** - * - * @type {string} - * @memberof CastWithInteractions - */ - 'hash': string; - /** - * - * @type {string} - * @memberof CastWithInteractions - */ - 'parent_hash': string; - /** - * - * @type {string} - * @memberof CastWithInteractions - */ - 'parent_url': string; - /** - * - * @type {string} - * @memberof CastWithInteractions - */ - 'root_parent_url': string; - /** - * - * @type {CastEmbeddedParentAuthor} - * @memberof CastWithInteractions - */ - 'parent_author': CastEmbeddedParentAuthor; - /** - * - * @type {User} - * @memberof CastWithInteractions - */ - 'author': User; - /** - * - * @type {string} - * @memberof CastWithInteractions - */ - 'text': string; - /** - * - * @type {string} - * @memberof CastWithInteractions - */ - 'timestamp': string; - /** - * - * @type {Array} - * @memberof CastWithInteractions - */ - 'embeds': Array; - /** - * - * @type {CastNotificationType} - * @memberof CastWithInteractions - */ - 'type'?: CastNotificationType; - /** - * - * @type {Array} - * @memberof CastWithInteractions - */ - 'frames'?: Array; - /** - * - * @type {CastWithInteractionsReactions} - * @memberof CastWithInteractions - */ - 'reactions': CastWithInteractionsReactions; - /** - * - * @type {CastWithInteractionsReplies} - * @memberof CastWithInteractions - */ - 'replies': CastWithInteractionsReplies; - /** - * - * @type {string} - * @memberof CastWithInteractions - */ - 'thread_hash': string; - /** - * - * @type {Array} - * @memberof CastWithInteractions - */ - 'mentioned_profiles': Array; - /** - * - * @type {ChannelOrDehydratedChannel} - * @memberof CastWithInteractions - */ - 'channel': ChannelOrDehydratedChannel; - /** - * - * @type {CastViewerContext} - * @memberof CastWithInteractions - */ - 'viewer_context'?: CastViewerContext; - /** - * - * @type {ChannelUserContext} - * @memberof CastWithInteractions - */ - 'author_channel_context'?: ChannelUserContext; -} - +export type CastWithInteractions = Cast; diff --git a/src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html-any-of-oembed.ts b/src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html-all-of-oembed.ts similarity index 90% rename from src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html-any-of-oembed.ts rename to src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html-all-of-oembed.ts index 562aee45..3676ee37 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html-any-of-oembed.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html-all-of-oembed.ts @@ -27,9 +27,9 @@ import type { OembedRichData } from './oembed-rich-data'; import type { OembedVideoData } from './oembed-video-data'; /** - * @type EmbedUrlMetadataHtmlAnyOfOembed + * @type EmbedUrlMetadataHtmlAllOfOembed * @export */ -export type EmbedUrlMetadataHtmlAnyOfOembed = { type: 'link' } & OembedLinkData | { type: 'photo' } & OembedPhotoData | { type: 'rich' } & OembedRichData | { type: 'video' } & OembedVideoData; +export type EmbedUrlMetadataHtmlAllOfOembed = { type: 'link' } & OembedLinkData | { type: 'photo' } & OembedPhotoData | { type: 'rich' } & OembedRichData | { type: 'video' } & OembedVideoData; diff --git a/src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html-any-of.ts b/src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html-any-of.ts deleted file mode 100644 index f8d09115..00000000 --- a/src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html-any-of.ts +++ /dev/null @@ -1,33 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Farcaster API V2 - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 2.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import type { EmbedUrlMetadataHtmlAnyOfOembed } from './embed-url-metadata-html-any-of-oembed'; - -/** - * - * @export - * @interface EmbedUrlMetadataHtmlAnyOf - */ -export interface EmbedUrlMetadataHtmlAnyOf { - /** - * - * @type {EmbedUrlMetadataHtmlAnyOfOembed} - * @memberof EmbedUrlMetadataHtmlAnyOf - */ - 'oembed'?: EmbedUrlMetadataHtmlAnyOfOembed; -} - diff --git a/src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html.ts b/src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html.ts index 20a64654..0937f94a 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/embed-url-metadata-html.ts @@ -15,10 +15,7 @@ // May contain unused imports in some cases // @ts-ignore -import type { EmbedUrlMetadataHtmlAnyOf } from './embed-url-metadata-html-any-of'; -// May contain unused imports in some cases -// @ts-ignore -import type { EmbedUrlMetadataHtmlAnyOfOembed } from './embed-url-metadata-html-any-of-oembed'; +import type { EmbedUrlMetadataHtmlAllOfOembed } from './embed-url-metadata-html-all-of-oembed'; // May contain unused imports in some cases // @ts-ignore import type { ImageObject } from './image-object'; @@ -30,310 +27,9 @@ import type { OgObject } from './og-object'; import type { VideoObject } from './video-object'; /** - * + * @type EmbedUrlMetadataHtml * @export - * @interface EmbedUrlMetadataHtml */ -export interface EmbedUrlMetadataHtml { - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'favicon'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'modifiedTime'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogArticleAuthor'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogArticleExpirationTime'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogArticleModifiedTime'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogArticlePublishedTime'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogArticlePublisher'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogArticleSection'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogArticleTag'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogAudio'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogAudioSecureURL'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogAudioType'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogAudioURL'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogAvailability'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogDate'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogDescription'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogDeterminer'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogEpisode'?: string; - /** - * - * @type {Array} - * @memberof EmbedUrlMetadataHtml - */ - 'ogImage'?: Array; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogLocale'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogLocaleAlternate'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogLogo'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogMovie'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogPriceAmount'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogPriceCurrency'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogProductAvailability'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogProductCondition'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogProductPriceAmount'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogProductPriceCurrency'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogProductRetailerItemId'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogSiteName'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogTitle'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogType'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogUrl'?: string; - /** - * - * @type {Array} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideo'?: Array; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoActor'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoActorId'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoActorRole'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoDirector'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoDuration'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoOther'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoReleaseDate'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoSecureURL'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoSeries'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoTag'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoTvShow'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogVideoWriter'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'ogWebsite'?: string; - /** - * - * @type {string} - * @memberof EmbedUrlMetadataHtml - */ - 'updatedTime'?: string; - /** - * - * @type {EmbedUrlMetadataHtmlAnyOfOembed} - * @memberof EmbedUrlMetadataHtml - */ - 'oembed'?: EmbedUrlMetadataHtmlAnyOfOembed; -} +export type EmbedUrlMetadataHtml = OgObject; + diff --git a/src/neynar-api/v2/openapi-farcaster/models/index.ts b/src/neynar-api/v2/openapi-farcaster/models/index.ts index 34785fec..430cf921 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/index.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/index.ts @@ -27,10 +27,7 @@ export * from './cast-response'; export * from './cast-viewer-context'; export * from './cast-with-interactions'; export * from './cast-with-interactions-and-conversations'; -export * from './cast-with-interactions-and-conversations-any-of'; export * from './cast-with-interactions-and-conversations-ref'; -export * from './cast-with-interactions-and-conversations-ref-any-of'; -export * from './cast-with-interactions-any-of'; export * from './cast-with-interactions-reactions'; export * from './cast-with-interactions-replies'; export * from './casts-response'; @@ -73,8 +70,7 @@ export * from './embed-type'; export * from './embed-url'; export * from './embed-url-metadata'; export * from './embed-url-metadata-html'; -export * from './embed-url-metadata-html-any-of'; -export * from './embed-url-metadata-html-any-of-oembed'; +export * from './embed-url-metadata-html-all-of-oembed'; export * from './embed-url-metadata-image'; export * from './embed-url-metadata-video'; export * from './embed-url-metadata-video-stream-inner'; @@ -144,13 +140,9 @@ export * from './notification-type'; export * from './notifications-response'; export * from './oembed-data'; export * from './oembed-link-data'; -export * from './oembed-link-data-any-of'; export * from './oembed-photo-data'; -export * from './oembed-photo-data-any-of'; export * from './oembed-rich-data'; -export * from './oembed-rich-data-any-of'; export * from './oembed-video-data'; -export * from './oembed-video-data-any-of'; export * from './og-object'; export * from './operation-response'; export * from './post-cast-req-body'; @@ -186,7 +178,6 @@ export * from './storage-allocations-response'; export * from './storage-object'; export * from './storage-usage-response'; export * from './subscribed-to'; -export * from './subscribed-to-any-of'; export * from './subscribed-to-object'; export * from './subscribed-to-response'; export * from './subscriber'; @@ -235,7 +226,6 @@ export * from './webhook-list-response'; export * from './webhook-patch-req-body'; export * from './webhook-post-req-body'; export * from './webhook-put-req-body'; -export * from './webhook-put-req-body-any-of'; export * from './webhook-response'; export * from './webhook-secret'; export * from './webhook-subscription'; diff --git a/src/neynar-api/v2/openapi-farcaster/models/oembed-link-data-any-of.ts b/src/neynar-api/v2/openapi-farcaster/models/oembed-link-data-any-of.ts deleted file mode 100644 index ec3f6ba6..00000000 --- a/src/neynar-api/v2/openapi-farcaster/models/oembed-link-data-any-of.ts +++ /dev/null @@ -1,37 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Farcaster API V2 - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 2.0 - * - * - * 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 OembedLinkDataAnyOf - */ -export interface OembedLinkDataAnyOf { - /** - * - * @type {string} - * @memberof OembedLinkDataAnyOf - */ - 'type'?: OembedLinkDataAnyOfTypeEnum; -} - -export const OembedLinkDataAnyOfTypeEnum = { - Link: 'link' -} as const; - -export type OembedLinkDataAnyOfTypeEnum = typeof OembedLinkDataAnyOfTypeEnum[keyof typeof OembedLinkDataAnyOfTypeEnum]; - - diff --git a/src/neynar-api/v2/openapi-farcaster/models/oembed-link-data.ts b/src/neynar-api/v2/openapi-farcaster/models/oembed-link-data.ts index c8bed3ee..57e7dda7 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/oembed-link-data.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/oembed-link-data.ts @@ -16,81 +16,11 @@ // May contain unused imports in some cases // @ts-ignore import type { OembedData } from './oembed-data'; -// May contain unused imports in some cases -// @ts-ignore -import type { OembedLinkDataAnyOf } from './oembed-link-data-any-of'; /** - * + * @type OembedLinkData * @export - * @interface OembedLinkData */ -export interface OembedLinkData { - /** - * - * @type {string} - * @memberof OembedLinkData - */ - 'type': string; - /** - * - * @type {string} - * @memberof OembedLinkData - */ - 'version': string; - /** - * A text title, describing the resource. - * @type {string} - * @memberof OembedLinkData - */ - 'title'?: string; - /** - * The name of the author/owner of the resource. - * @type {string} - * @memberof OembedLinkData - */ - 'author_name'?: string; - /** - * A URL for the author/owner of the resource. - * @type {string} - * @memberof OembedLinkData - */ - 'author_url'?: string; - /** - * The name of the resource provider. - * @type {string} - * @memberof OembedLinkData - */ - 'provider_name'?: string; - /** - * The url of the resource provider. - * @type {string} - * @memberof OembedLinkData - */ - 'provider_url'?: string; - /** - * The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not. - * @type {string} - * @memberof OembedLinkData - */ - 'cache_age'?: string; - /** - * A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present. - * @type {string} - * @memberof OembedLinkData - */ - 'thumbnail_url'?: string; - /** - * The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present. - * @type {number} - * @memberof OembedLinkData - */ - 'thumbnail_width'?: number; - /** - * The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present. - * @type {number} - * @memberof OembedLinkData - */ - 'thumbnail_height'?: number; -} +export type OembedLinkData = OembedData; + diff --git a/src/neynar-api/v2/openapi-farcaster/models/oembed-photo-data-any-of.ts b/src/neynar-api/v2/openapi-farcaster/models/oembed-photo-data-any-of.ts deleted file mode 100644 index 3064ef3e..00000000 --- a/src/neynar-api/v2/openapi-farcaster/models/oembed-photo-data-any-of.ts +++ /dev/null @@ -1,55 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Farcaster API V2 - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 2.0 - * - * - * 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 OembedPhotoDataAnyOf - */ -export interface OembedPhotoDataAnyOf { - /** - * - * @type {string} - * @memberof OembedPhotoDataAnyOf - */ - 'type'?: OembedPhotoDataAnyOfTypeEnum; - /** - * The source URL of the image. Consumers should be able to insert this URL into an element. Only HTTP and HTTPS URLs are valid. - * @type {string} - * @memberof OembedPhotoDataAnyOf - */ - 'url': string | null; - /** - * The width in pixels of the image specified in the url parameter. - * @type {number} - * @memberof OembedPhotoDataAnyOf - */ - 'width': number | null; - /** - * The height in pixels of the image specified in the url parameter. - * @type {number} - * @memberof OembedPhotoDataAnyOf - */ - 'height': number | null; -} - -export const OembedPhotoDataAnyOfTypeEnum = { - Photo: 'photo' -} as const; - -export type OembedPhotoDataAnyOfTypeEnum = typeof OembedPhotoDataAnyOfTypeEnum[keyof typeof OembedPhotoDataAnyOfTypeEnum]; - - diff --git a/src/neynar-api/v2/openapi-farcaster/models/oembed-photo-data.ts b/src/neynar-api/v2/openapi-farcaster/models/oembed-photo-data.ts index b03afc2e..cb7a633a 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/oembed-photo-data.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/oembed-photo-data.ts @@ -16,99 +16,11 @@ // May contain unused imports in some cases // @ts-ignore import type { OembedData } from './oembed-data'; -// May contain unused imports in some cases -// @ts-ignore -import type { OembedPhotoDataAnyOf } from './oembed-photo-data-any-of'; /** - * + * @type OembedPhotoData * @export - * @interface OembedPhotoData */ -export interface OembedPhotoData { - /** - * - * @type {string} - * @memberof OembedPhotoData - */ - 'type': string; - /** - * - * @type {string} - * @memberof OembedPhotoData - */ - 'version': string; - /** - * A text title, describing the resource. - * @type {string} - * @memberof OembedPhotoData - */ - 'title'?: string; - /** - * The name of the author/owner of the resource. - * @type {string} - * @memberof OembedPhotoData - */ - 'author_name'?: string; - /** - * A URL for the author/owner of the resource. - * @type {string} - * @memberof OembedPhotoData - */ - 'author_url'?: string; - /** - * The name of the resource provider. - * @type {string} - * @memberof OembedPhotoData - */ - 'provider_name'?: string; - /** - * The url of the resource provider. - * @type {string} - * @memberof OembedPhotoData - */ - 'provider_url'?: string; - /** - * The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not. - * @type {string} - * @memberof OembedPhotoData - */ - 'cache_age'?: string; - /** - * A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present. - * @type {string} - * @memberof OembedPhotoData - */ - 'thumbnail_url'?: string; - /** - * The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present. - * @type {number} - * @memberof OembedPhotoData - */ - 'thumbnail_width'?: number; - /** - * The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present. - * @type {number} - * @memberof OembedPhotoData - */ - 'thumbnail_height'?: number; - /** - * The source URL of the image. Consumers should be able to insert this URL into an element. Only HTTP and HTTPS URLs are valid. - * @type {string} - * @memberof OembedPhotoData - */ - 'url': string; - /** - * The width in pixels of the image specified in the url parameter. - * @type {number} - * @memberof OembedPhotoData - */ - 'width': number; - /** - * The height in pixels of the image specified in the url parameter. - * @type {number} - * @memberof OembedPhotoData - */ - 'height': number; -} +export type OembedPhotoData = OembedData; + diff --git a/src/neynar-api/v2/openapi-farcaster/models/oembed-rich-data-any-of.ts b/src/neynar-api/v2/openapi-farcaster/models/oembed-rich-data-any-of.ts deleted file mode 100644 index 42bd48c9..00000000 --- a/src/neynar-api/v2/openapi-farcaster/models/oembed-rich-data-any-of.ts +++ /dev/null @@ -1,55 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Farcaster API V2 - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 2.0 - * - * - * 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 OembedRichDataAnyOf - */ -export interface OembedRichDataAnyOf { - /** - * - * @type {string} - * @memberof OembedRichDataAnyOf - */ - 'type'?: OembedRichDataAnyOfTypeEnum; - /** - * The HTML required to display the resource. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. The markup should be valid XHTML 1.0 Basic. - * @type {string} - * @memberof OembedRichDataAnyOf - */ - 'html': string | null; - /** - * The width in pixels required to display the HTML. - * @type {number} - * @memberof OembedRichDataAnyOf - */ - 'width': number | null; - /** - * The height in pixels required to display the HTML. - * @type {number} - * @memberof OembedRichDataAnyOf - */ - 'height': number | null; -} - -export const OembedRichDataAnyOfTypeEnum = { - Rich: 'rich' -} as const; - -export type OembedRichDataAnyOfTypeEnum = typeof OembedRichDataAnyOfTypeEnum[keyof typeof OembedRichDataAnyOfTypeEnum]; - - diff --git a/src/neynar-api/v2/openapi-farcaster/models/oembed-rich-data.ts b/src/neynar-api/v2/openapi-farcaster/models/oembed-rich-data.ts index 4e3e8487..bb2016d6 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/oembed-rich-data.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/oembed-rich-data.ts @@ -16,99 +16,11 @@ // May contain unused imports in some cases // @ts-ignore import type { OembedData } from './oembed-data'; -// May contain unused imports in some cases -// @ts-ignore -import type { OembedRichDataAnyOf } from './oembed-rich-data-any-of'; /** - * + * @type OembedRichData * @export - * @interface OembedRichData */ -export interface OembedRichData { - /** - * - * @type {string} - * @memberof OembedRichData - */ - 'type': string; - /** - * - * @type {string} - * @memberof OembedRichData - */ - 'version': string; - /** - * A text title, describing the resource. - * @type {string} - * @memberof OembedRichData - */ - 'title'?: string; - /** - * The name of the author/owner of the resource. - * @type {string} - * @memberof OembedRichData - */ - 'author_name'?: string; - /** - * A URL for the author/owner of the resource. - * @type {string} - * @memberof OembedRichData - */ - 'author_url'?: string; - /** - * The name of the resource provider. - * @type {string} - * @memberof OembedRichData - */ - 'provider_name'?: string; - /** - * The url of the resource provider. - * @type {string} - * @memberof OembedRichData - */ - 'provider_url'?: string; - /** - * The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not. - * @type {string} - * @memberof OembedRichData - */ - 'cache_age'?: string; - /** - * A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present. - * @type {string} - * @memberof OembedRichData - */ - 'thumbnail_url'?: string; - /** - * The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present. - * @type {number} - * @memberof OembedRichData - */ - 'thumbnail_width'?: number; - /** - * The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present. - * @type {number} - * @memberof OembedRichData - */ - 'thumbnail_height'?: number; - /** - * The HTML required to display the resource. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. The markup should be valid XHTML 1.0 Basic. - * @type {string} - * @memberof OembedRichData - */ - 'html': string; - /** - * The width in pixels required to display the HTML. - * @type {number} - * @memberof OembedRichData - */ - 'width': number; - /** - * The height in pixels required to display the HTML. - * @type {number} - * @memberof OembedRichData - */ - 'height': number; -} +export type OembedRichData = OembedData; + diff --git a/src/neynar-api/v2/openapi-farcaster/models/oembed-video-data-any-of.ts b/src/neynar-api/v2/openapi-farcaster/models/oembed-video-data-any-of.ts deleted file mode 100644 index 49875cb7..00000000 --- a/src/neynar-api/v2/openapi-farcaster/models/oembed-video-data-any-of.ts +++ /dev/null @@ -1,55 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Farcaster API V2 - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 2.0 - * - * - * 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 OembedVideoDataAnyOf - */ -export interface OembedVideoDataAnyOf { - /** - * - * @type {string} - * @memberof OembedVideoDataAnyOf - */ - 'type'?: OembedVideoDataAnyOfTypeEnum; - /** - * The HTML required to embed a video player. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. - * @type {string} - * @memberof OembedVideoDataAnyOf - */ - 'html': string | null; - /** - * The width in pixels required to display the HTML. - * @type {number} - * @memberof OembedVideoDataAnyOf - */ - 'width': number | null; - /** - * The height in pixels required to display the HTML. - * @type {number} - * @memberof OembedVideoDataAnyOf - */ - 'height': number | null; -} - -export const OembedVideoDataAnyOfTypeEnum = { - Video: 'video' -} as const; - -export type OembedVideoDataAnyOfTypeEnum = typeof OembedVideoDataAnyOfTypeEnum[keyof typeof OembedVideoDataAnyOfTypeEnum]; - - diff --git a/src/neynar-api/v2/openapi-farcaster/models/oembed-video-data.ts b/src/neynar-api/v2/openapi-farcaster/models/oembed-video-data.ts index 82979eb1..7530a236 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/oembed-video-data.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/oembed-video-data.ts @@ -16,99 +16,11 @@ // May contain unused imports in some cases // @ts-ignore import type { OembedData } from './oembed-data'; -// May contain unused imports in some cases -// @ts-ignore -import type { OembedVideoDataAnyOf } from './oembed-video-data-any-of'; /** - * + * @type OembedVideoData * @export - * @interface OembedVideoData */ -export interface OembedVideoData { - /** - * - * @type {string} - * @memberof OembedVideoData - */ - 'type': string; - /** - * - * @type {string} - * @memberof OembedVideoData - */ - 'version': string; - /** - * A text title, describing the resource. - * @type {string} - * @memberof OembedVideoData - */ - 'title'?: string; - /** - * The name of the author/owner of the resource. - * @type {string} - * @memberof OembedVideoData - */ - 'author_name'?: string; - /** - * A URL for the author/owner of the resource. - * @type {string} - * @memberof OembedVideoData - */ - 'author_url'?: string; - /** - * The name of the resource provider. - * @type {string} - * @memberof OembedVideoData - */ - 'provider_name'?: string; - /** - * The url of the resource provider. - * @type {string} - * @memberof OembedVideoData - */ - 'provider_url'?: string; - /** - * The suggested cache lifetime for this resource, in seconds. Consumers may choose to use this value or not. - * @type {string} - * @memberof OembedVideoData - */ - 'cache_age'?: string; - /** - * A URL to a thumbnail image representing the resource. The thumbnail must respect any maxwidth and maxheight parameters. If this parameter is present, thumbnail_width and thumbnail_height must also be present. - * @type {string} - * @memberof OembedVideoData - */ - 'thumbnail_url'?: string; - /** - * The width of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_height must also be present. - * @type {number} - * @memberof OembedVideoData - */ - 'thumbnail_width'?: number; - /** - * The height of the optional thumbnail. If this parameter is present, thumbnail_url and thumbnail_width must also be present. - * @type {number} - * @memberof OembedVideoData - */ - 'thumbnail_height'?: number; - /** - * The HTML required to embed a video player. The HTML should have no padding or margins. Consumers may wish to load the HTML in an off-domain iframe to avoid XSS vulnerabilities. - * @type {string} - * @memberof OembedVideoData - */ - 'html': string; - /** - * The width in pixels required to display the HTML. - * @type {number} - * @memberof OembedVideoData - */ - 'width': number; - /** - * The height in pixels required to display the HTML. - * @type {number} - * @memberof OembedVideoData - */ - 'height': number; -} +export type OembedVideoData = OembedData; + diff --git a/src/neynar-api/v2/openapi-farcaster/models/subscribed-to-any-of.ts b/src/neynar-api/v2/openapi-farcaster/models/subscribed-to-any-of.ts deleted file mode 100644 index 74ebf7c4..00000000 --- a/src/neynar-api/v2/openapi-farcaster/models/subscribed-to-any-of.ts +++ /dev/null @@ -1,54 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Farcaster API V2 - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 2.0 - * - * - * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). - * https://openapi-generator.tech - * Do not edit the class manually. - */ - - -// May contain unused imports in some cases -// @ts-ignore -import type { SubscriptionTier } from './subscription-tier'; -// May contain unused imports in some cases -// @ts-ignore -import type { User } from './user'; - -/** - * - * @export - * @interface SubscribedToAnyOf - */ -export interface SubscribedToAnyOf { - /** - * - * @type {string} - * @memberof SubscribedToAnyOf - */ - 'expires_at': string; - /** - * - * @type {string} - * @memberof SubscribedToAnyOf - */ - 'subscribed_at': string; - /** - * - * @type {SubscriptionTier} - * @memberof SubscribedToAnyOf - */ - 'tier': SubscriptionTier; - /** - * - * @type {User} - * @memberof SubscribedToAnyOf - */ - 'creator': User; -} - diff --git a/src/neynar-api/v2/openapi-farcaster/models/subscribed-to.ts b/src/neynar-api/v2/openapi-farcaster/models/subscribed-to.ts index 582d74aa..54434c33 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/subscribed-to.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/subscribed-to.ts @@ -13,9 +13,6 @@ */ -// May contain unused imports in some cases -// @ts-ignore -import type { SubscribedToAnyOf } from './subscribed-to-any-of'; // May contain unused imports in some cases // @ts-ignore import type { Subscription } from './subscription'; @@ -36,94 +33,9 @@ import type { SubscriptionToken } from './subscription-token'; import type { User } from './user'; /** - * + * @type SubscribedTo * @export - * @interface SubscribedTo */ -export interface SubscribedTo { - /** - * - * @type {string} - * @memberof SubscribedTo - */ - 'object': string; - /** - * - * @type {string} - * @memberof SubscribedTo - */ - 'provider_name'?: string; - /** - * - * @type {string} - * @memberof SubscribedTo - */ - 'contract_address': string; - /** - * - * @type {number} - * @memberof SubscribedTo - */ - 'chain': number; - /** - * - * @type {SubscriptionMetadata} - * @memberof SubscribedTo - */ - 'metadata': SubscriptionMetadata; - /** - * - * @type {string} - * @memberof SubscribedTo - */ - 'owner_address': string; - /** - * - * @type {SubscriptionPrice} - * @memberof SubscribedTo - */ - 'price': SubscriptionPrice; - /** - * - * @type {Array} - * @memberof SubscribedTo - */ - 'tiers'?: Array; - /** - * - * @type {number} - * @memberof SubscribedTo - */ - 'protocol_version': number; - /** - * - * @type {SubscriptionToken} - * @memberof SubscribedTo - */ - 'token': SubscriptionToken; - /** - * - * @type {string} - * @memberof SubscribedTo - */ - 'expires_at': string; - /** - * - * @type {string} - * @memberof SubscribedTo - */ - 'subscribed_at': string; - /** - * - * @type {SubscriptionTier} - * @memberof SubscribedTo - */ - 'tier': SubscriptionTier; - /** - * - * @type {User} - * @memberof SubscribedTo - */ - 'creator': User; -} +export type SubscribedTo = Subscription; + diff --git a/src/neynar-api/v2/openapi-farcaster/models/webhook-put-req-body-any-of.ts b/src/neynar-api/v2/openapi-farcaster/models/webhook-put-req-body-any-of.ts deleted file mode 100644 index e12dea5d..00000000 --- a/src/neynar-api/v2/openapi-farcaster/models/webhook-put-req-body-any-of.ts +++ /dev/null @@ -1,30 +0,0 @@ -/* tslint:disable */ -/* eslint-disable */ -/** - * Farcaster API V2 - * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) - * - * The version of the OpenAPI document: 2.0 - * - * - * 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 WebhookPutReqBodyAnyOf - */ -export interface WebhookPutReqBodyAnyOf { - /** - * - * @type {string} - * @memberof WebhookPutReqBodyAnyOf - */ - 'webhook_id': string; -} - diff --git a/src/neynar-api/v2/openapi-farcaster/models/webhook-put-req-body.ts b/src/neynar-api/v2/openapi-farcaster/models/webhook-put-req-body.ts index 0f8d7c01..b4d40914 100644 --- a/src/neynar-api/v2/openapi-farcaster/models/webhook-put-req-body.ts +++ b/src/neynar-api/v2/openapi-farcaster/models/webhook-put-req-body.ts @@ -18,40 +18,12 @@ import type { WebhookPostReqBody } from './webhook-post-req-body'; // May contain unused imports in some cases // @ts-ignore -import type { WebhookPutReqBodyAnyOf } from './webhook-put-req-body-any-of'; -// May contain unused imports in some cases -// @ts-ignore import type { WebhookSubscriptionFilters } from './webhook-subscription-filters'; /** - * + * @type WebhookPutReqBody * @export - * @interface WebhookPutReqBody */ -export interface WebhookPutReqBody { - /** - * - * @type {string} - * @memberof WebhookPutReqBody - */ - 'name': string; - /** - * - * @type {string} - * @memberof WebhookPutReqBody - */ - 'url': string; - /** - * - * @type {WebhookSubscriptionFilters} - * @memberof WebhookPutReqBody - */ - 'subscription'?: WebhookSubscriptionFilters; - /** - * - * @type {string} - * @memberof WebhookPutReqBody - */ - 'webhook_id': string; -} +export type WebhookPutReqBody = WebhookPostReqBody; + diff --git a/src/oas b/src/oas index 14b7a43f..adf38398 160000 --- a/src/oas +++ b/src/oas @@ -1 +1 @@ -Subproject commit 14b7a43f1599b7f81de2e6c7ad08fa395595a492 +Subproject commit adf383984bcf4831435762d53b9b79efcaa9d213