Skip to content

Commit

Permalink
Update OAS submodule to version 2.4.0 (#256)
Browse files Browse the repository at this point in the history
* Update OAS submodule

* Update generated files

* Update package.json version to 2.4.0

---------

Co-authored-by: GitHub Actions <[email protected]>
  • Loading branch information
manan19 and actions-user authored Dec 18, 2024
1 parent 95f7fdb commit 460b393
Show file tree
Hide file tree
Showing 304 changed files with 572 additions and 300 deletions.
2 changes: 1 addition & 1 deletion oas
Submodule oas updated 1 files
+73 −1 src/v2/spec.yaml
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@neynar/nodejs-sdk",
"version": "2.3.0",
"version": "2.4.0",
"description": "SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)",
"main": "./build/index.js",
"types": "./build/index.d.ts",
Expand Down
2 changes: 2 additions & 0 deletions src/api/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,8 @@ models/channel-user-context.ts
models/channel.ts
models/conflict-error-res.ts
models/conversation-conversation.ts
models/conversation-summary-summary.ts
models/conversation-summary.ts
models/conversation.ts
models/dehydrated-channel.ts
models/dehydrated-follower.ts
Expand Down
2 changes: 1 addition & 1 deletion src/api/api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/action-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/ban-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/block-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
158 changes: 157 additions & 1 deletion src/api/apis/cast-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down Expand Up @@ -40,6 +40,8 @@ import type { CastsSearchResponse } from '../models';
// @ts-ignore
import type { Conversation } from '../models';
// @ts-ignore
import type { ConversationSummary } from '../models';
// @ts-ignore
import type { DeleteCastReqBody } from '../models';
// @ts-ignore
import type { ErrorRes } from '../models';
Expand Down Expand Up @@ -381,6 +383,60 @@ export const CastApiAxiosParamCreator = function (configuration?: Configuration)



setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};

return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL. Summary is generated by an LLM and is intended to be passed as a context to AI agents.
* @summary Conversation summary for a cast
* @param {string} identifier Cast identifier (Its either a url or a hash)
* @param {number} [limit] Number of casts to consider in a summary up to a point of target cast (Default: 20, Maximum: 50)
* @param {string} [prompt] Additional prompt used to generate a summary
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<ConversationSummary>} A promise that resolves to a `ConversationSummary` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-cast-conversation-summary)
*
*/
lookupCastConversationSummary: async (identifier: string, limit?: number, prompt?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
// verify required parameter 'identifier' is not null or undefined
assertParamExists('lookupCastConversationSummary', 'identifier', identifier)
const localVarPath = `/farcaster/cast/conversation/summary`;
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}

const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;

// authentication ApiKeyAuth required
await setApiKeyToObject(localVarHeaderParameter, "x-api-key", configuration)

if (identifier !== undefined) {
localVarQueryParameter['identifier'] = identifier;
}

if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}

if (prompt !== undefined) {
localVarQueryParameter['prompt'] = prompt;
}



setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
Expand Down Expand Up @@ -638,6 +694,25 @@ export const CastApiFp = function(configuration?: Configuration) {
const localVarOperationServerBasePath = operationServerMap['CastApi.lookupCastConversation']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL. Summary is generated by an LLM and is intended to be passed as a context to AI agents.
* @summary Conversation summary for a cast
* @param {string} identifier Cast identifier (Its either a url or a hash)
* @param {number} [limit] Number of casts to consider in a summary up to a point of target cast (Default: 20, Maximum: 50)
* @param {string} [prompt] Additional prompt used to generate a summary
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<ConversationSummary>} A promise that resolves to a `ConversationSummary` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-cast-conversation-summary)
*
*/
async lookupCastConversationSummary(identifier: string, limit?: number, prompt?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConversationSummary>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.lookupCastConversationSummary(identifier, limit, prompt, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CastApi.lookupCastConversationSummary']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || 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
Expand Down Expand Up @@ -773,6 +848,20 @@ export const CastApiFactory = function (configuration?: Configuration, basePath?
lookupCastConversation(requestParameters: CastApiLookupCastConversationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Conversation> {
return localVarFp.lookupCastConversation(requestParameters.identifier, requestParameters.type, requestParameters.replyDepth, requestParameters.includeChronologicalParentCasts, requestParameters.viewerFid, requestParameters.sortType, requestParameters.fold, requestParameters.limit, requestParameters.cursor, options).then((request) => request(axios, basePath));
},
/**
* Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL. Summary is generated by an LLM and is intended to be passed as a context to AI agents.
* @summary Conversation summary for a cast
* @param {CastApiLookupCastConversationSummaryRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<ConversationSummary>} A promise that resolves to a `ConversationSummary` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-cast-conversation-summary)
*
*/
lookupCastConversationSummary(requestParameters: CastApiLookupCastConversationSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConversationSummary> {
return localVarFp.lookupCastConversationSummary(requestParameters.identifier, requestParameters.limit, requestParameters.prompt, 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
Expand Down Expand Up @@ -894,6 +983,20 @@ export interface CastApiInterface {
*/
lookupCastConversation(requestParameters: CastApiLookupCastConversationRequest, options?: RawAxiosRequestConfig): AxiosPromise<Conversation>;

/**
* Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL. Summary is generated by an LLM and is intended to be passed as a context to AI agents.
* @summary Conversation summary for a cast
* @param {CastApiLookupCastConversationSummaryRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CastApiInterface
* @returns {Promise<ConversationSummary>} A promise that resolves to a `ConversationSummary` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-cast-conversation-summary)
*
*/
lookupCastConversationSummary(requestParameters: CastApiLookupCastConversationSummaryRequest, options?: RawAxiosRequestConfig): AxiosPromise<ConversationSummary>;

/**
* 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
Expand Down Expand Up @@ -1166,6 +1269,43 @@ export interface CastApiLookupCastConversationRequest {
readonly cursor?: string
}

/**
* Request parameters for lookupCastConversationSummary operation in CastApi.
* @export
* @interface CastApiLookupCastConversationSummaryRequest
*/
export interface CastApiLookupCastConversationSummaryRequest {
/**
* Cast identifier (Its either a url or a hash)
*
*
*
* @type {string}
* @memberof CastApiLookupCastConversationSummary
*/
readonly identifier: string

/**
* Number of casts to consider in a summary up to a point of target cast (Default: 20, Maximum: 50)
*
*
*
* @type {number}
* @memberof CastApiLookupCastConversationSummary
*/
readonly limit?: number

/**
* Additional prompt used to generate a summary
*
*
*
* @type {string}
* @memberof CastApiLookupCastConversationSummary
*/
readonly prompt?: string
}

/**
* Request parameters for publishCast operation in CastApi.
* @export
Expand Down Expand Up @@ -1373,6 +1513,22 @@ export class CastApi extends BaseAPI implements CastApiInterface {
return CastApiFp(this.configuration).lookupCastConversation(requestParameters.identifier, requestParameters.type, requestParameters.replyDepth, requestParameters.includeChronologicalParentCasts, requestParameters.viewerFid, requestParameters.sortType, requestParameters.fold, requestParameters.limit, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
}

/**
* Generates a summary of all casts related to a conversation surrounding a cast by passing in a cast hash or Warpcast URL. Summary is generated by an LLM and is intended to be passed as a context to AI agents.
* @summary Conversation summary for a cast
* @param {CastApiLookupCastConversationSummaryRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CastApi
* @returns {Promise<ConversationSummary>} A promise that resolves to a `ConversationSummary` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/lookup-cast-conversation-summary)
*
*/
public lookupCastConversationSummary(requestParameters: CastApiLookupCastConversationSummaryRequest, options?: RawAxiosRequestConfig) {
return CastApiFp(this.configuration).lookupCastConversationSummary(requestParameters.identifier, requestParameters.limit, requestParameters.prompt, 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
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/channel-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/feed-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/fname-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/follows-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/frame-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/mute-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/notifications-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/onchain-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/reaction-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/signer-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/storage-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/subscribers-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
2 changes: 1 addition & 1 deletion src/api/apis/user-api.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
* Farcaster API V2
* The Farcaster API allows you to interact with the Farcaster protocol. See the [Neynar docs](https://docs.neynar.com/reference) for more details.
*
* The version of the OpenAPI document: 2.3.0
* The version of the OpenAPI document: 2.4.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
Loading

0 comments on commit 460b393

Please sign in to comment.