Skip to content

Commit

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

* Update generated files

* Update package.json version to 2.0.6

---------

Co-authored-by: GitHub Actions <[email protected]>
  • Loading branch information
manan19 and actions-user authored Dec 7, 2024
1 parent 4f0fb35 commit df51b2d
Show file tree
Hide file tree
Showing 295 changed files with 1,015 additions and 300 deletions.
2 changes: 1 addition & 1 deletion oas
Submodule oas updated 1 files
+148 −3 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.0.5",
"version": "2.0.6",
"description": "SDK to interact with Neynar APIs (https://docs.neynar.com/reference/quickstart)",
"main": "./build/index.js",
"types": "./build/index.d.ts",
Expand Down
5 changes: 5 additions & 0 deletions src/api/.openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ models/cast-composer-actions-list-response.ts
models/cast-composer-type.ts
models/cast-conversation-sort-type.ts
models/cast-dehydrated.ts
models/cast-embed-crawl-response.ts
models/cast-embedded-parent-author.ts
models/cast-embedded.ts
models/cast-id.ts
Expand Down Expand Up @@ -97,6 +98,10 @@ models/dehydrated-follower.ts
models/delete-cast-req-body.ts
models/delete-frame-req-body.ts
models/delete-frame-response.ts
models/deploy-fungible-req-body-metadata-media.ts
models/deploy-fungible-response-contract-fungible.ts
models/deploy-fungible-response-contract.ts
models/deploy-fungible-response.ts
models/developer-managed-signer.ts
models/embed-cast-deep.ts
models/embed-cast.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.0.5
* The version of the OpenAPI document: 2.0.6
* 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.0.5
* The version of the OpenAPI document: 2.0.6
* 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.0.5
* The version of the OpenAPI document: 2.0.6
* 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.0.5
* The version of the OpenAPI document: 2.0.6
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
124 changes: 123 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.0.5
* The version of the OpenAPI document: 2.0.6
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand All @@ -28,6 +28,8 @@ import type { CastComposerType } from '../models';
// @ts-ignore
import type { CastConversationSortType } from '../models';
// @ts-ignore
import type { CastEmbedCrawlResponse } from '../models';
// @ts-ignore
import type { CastParamType } from '../models';
// @ts-ignore
import type { CastResponse } from '../models';
Expand Down Expand Up @@ -195,6 +197,48 @@ 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,
};
},
/**
* Crawls the given URL and returns metadata useful when embedding the URL in a cast.
* @summary Embedded URL metadata
* @param {string} [url] URL to crawl metadata of
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<CastEmbedCrawlResponse>} A promise that resolves to a `CastEmbedCrawlResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-embedded-url-metadata)
*
*/
fetchEmbeddedUrlMetadata: async (url?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
const localVarPath = `/farcaster/cast/embed/crawl`;
// 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 (url !== undefined) {
localVarQueryParameter['url'] = url;
}



setSearchParams(localVarUrlObj, localVarQueryParameter);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
Expand Down Expand Up @@ -533,6 +577,23 @@ export const CastApiFp = function(configuration?: Configuration) {
const localVarOperationServerBasePath = operationServerMap['CastApi.fetchComposerActions']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Crawls the given URL and returns metadata useful when embedding the URL in a cast.
* @summary Embedded URL metadata
* @param {string} [url] URL to crawl metadata of
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<CastEmbedCrawlResponse>} A promise that resolves to a `CastEmbedCrawlResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-embedded-url-metadata)
*
*/
async fetchEmbeddedUrlMetadata(url?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CastEmbedCrawlResponse>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.fetchEmbeddedUrlMetadata(url, options);
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
const localVarOperationServerBasePath = operationServerMap['CastApi.fetchEmbeddedUrlMetadata']?.[localVarOperationServerIndex]?.url;
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Gets information about an individual cast by passing in a Warpcast web URL or cast hash
* @summary By hash or URL
Expand Down Expand Up @@ -670,6 +731,20 @@ export const CastApiFactory = function (configuration?: Configuration, basePath?
fetchComposerActions(requestParameters: CastApiFetchComposerActionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CastComposerActionsListResponse> {
return localVarFp.fetchComposerActions(requestParameters.list, requestParameters.limit, requestParameters.cursor, options).then((request) => request(axios, basePath));
},
/**
* Crawls the given URL and returns metadata useful when embedding the URL in a cast.
* @summary Embedded URL metadata
* @param {CastApiFetchEmbeddedUrlMetadataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @returns {Promise<CastEmbedCrawlResponse>} A promise that resolves to a `CastEmbedCrawlResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-embedded-url-metadata)
*
*/
fetchEmbeddedUrlMetadata(requestParameters: CastApiFetchEmbeddedUrlMetadataRequest = {}, options?: RawAxiosRequestConfig): AxiosPromise<CastEmbedCrawlResponse> {
return localVarFp.fetchEmbeddedUrlMetadata(requestParameters.url, options).then((request) => request(axios, basePath));
},
/**
* Gets information about an individual cast by passing in a Warpcast web URL or cast hash
* @summary By hash or URL
Expand Down Expand Up @@ -777,6 +852,20 @@ export interface CastApiInterface {
*/
fetchComposerActions(requestParameters: CastApiFetchComposerActionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<CastComposerActionsListResponse>;

/**
* Crawls the given URL and returns metadata useful when embedding the URL in a cast.
* @summary Embedded URL metadata
* @param {CastApiFetchEmbeddedUrlMetadataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CastApiInterface
* @returns {Promise<CastEmbedCrawlResponse>} A promise that resolves to a `CastEmbedCrawlResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-embedded-url-metadata)
*
*/
fetchEmbeddedUrlMetadata(requestParameters?: CastApiFetchEmbeddedUrlMetadataRequest, options?: RawAxiosRequestConfig): AxiosPromise<CastEmbedCrawlResponse>;

/**
* Gets information about an individual cast by passing in a Warpcast web URL or cast hash
* @summary By hash or URL
Expand Down Expand Up @@ -926,6 +1015,23 @@ export interface CastApiFetchComposerActionsRequest {
readonly cursor?: string
}

/**
* Request parameters for fetchEmbeddedUrlMetadata operation in CastApi.
* @export
* @interface CastApiFetchEmbeddedUrlMetadataRequest
*/
export interface CastApiFetchEmbeddedUrlMetadataRequest {
/**
* URL to crawl metadata of
*
*
*
* @type {string}
* @memberof CastApiFetchEmbeddedUrlMetadata
*/
readonly url?: string
}

/**
* Request parameters for lookupCastByHashOrWarpcastUrl operation in CastApi.
* @export
Expand Down Expand Up @@ -1219,6 +1325,22 @@ export class CastApi extends BaseAPI implements CastApiInterface {
return CastApiFp(this.configuration).fetchComposerActions(requestParameters.list, requestParameters.limit, requestParameters.cursor, options).then((request) => request(this.axios, this.basePath));
}

/**
* Crawls the given URL and returns metadata useful when embedding the URL in a cast.
* @summary Embedded URL metadata
* @param {CastApiFetchEmbeddedUrlMetadataRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof CastApi
* @returns {Promise<CastEmbedCrawlResponse>} A promise that resolves to a `CastEmbedCrawlResponse` object
*
* For more information, refer to the [API documentation](https://docs.neynar.com/reference/fetch-embedded-url-metadata)
*
*/
public fetchEmbeddedUrlMetadata(requestParameters: CastApiFetchEmbeddedUrlMetadataRequest = {}, options?: RawAxiosRequestConfig) {
return CastApiFp(this.configuration).fetchEmbeddedUrlMetadata(requestParameters.url, options).then((request) => request(this.axios, this.basePath));
}

/**
* Gets information about an individual cast by passing in a Warpcast web URL or cast hash
* @summary By hash or URL
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.0.5
* The version of the OpenAPI document: 2.0.6
* 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.0.5
* The version of the OpenAPI document: 2.0.6
* 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.0.5
* The version of the OpenAPI document: 2.0.6
* 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.0.5
* The version of the OpenAPI document: 2.0.6
* 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.0.5
* The version of the OpenAPI document: 2.0.6
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down
22 changes: 11 additions & 11 deletions 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.0.5
* The version of the OpenAPI document: 2.0.6
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
Expand Down Expand Up @@ -36,7 +36,7 @@ import type { MuteResponse } from '../models';
export const MuteApiAxiosParamCreator = function (configuration?: Configuration) {
return {
/**
* Deletes a mute for a given FID. This is a whitelisted API, reach out if you want access.
* Deletes a mute for a given FID. This is an allowlisted API, reach out if you want access.
* @summary Unmute FID
* @param {MuteReqBody} muteReqBody
* @param {*} [options] Override http request option.
Expand Down Expand Up @@ -140,7 +140,7 @@ export const MuteApiAxiosParamCreator = function (configuration?: Configuration)
};
},
/**
* Adds a mute for a given FID. This is a whitelisted API, reach out if you want access.
* Adds a mute for a given FID. This is an allowlisted API, reach out if you want access.
* @summary Mute FID
* @param {MuteReqBody} muteReqBody
* @param {*} [options] Override http request option.
Expand Down Expand Up @@ -193,7 +193,7 @@ export const MuteApiFp = function(configuration?: Configuration) {
const localVarAxiosParamCreator = MuteApiAxiosParamCreator(configuration)
return {
/**
* Deletes a mute for a given FID. This is a whitelisted API, reach out if you want access.
* Deletes a mute for a given FID. This is an allowlisted API, reach out if you want access.
* @summary Unmute FID
* @param {MuteReqBody} muteReqBody
* @param {*} [options] Override http request option.
Expand Down Expand Up @@ -230,7 +230,7 @@ export const MuteApiFp = function(configuration?: Configuration) {
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
},
/**
* Adds a mute for a given FID. This is a whitelisted API, reach out if you want access.
* Adds a mute for a given FID. This is an allowlisted API, reach out if you want access.
* @summary Mute FID
* @param {MuteReqBody} muteReqBody
* @param {*} [options] Override http request option.
Expand All @@ -257,7 +257,7 @@ export const MuteApiFactory = function (configuration?: Configuration, basePath?
const localVarFp = MuteApiFp(configuration)
return {
/**
* Deletes a mute for a given FID. This is a whitelisted API, reach out if you want access.
* Deletes a mute for a given FID. This is an allowlisted API, reach out if you want access.
* @summary Unmute FID
* @param {MuteApiDeleteMuteRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
Expand Down Expand Up @@ -285,7 +285,7 @@ export const MuteApiFactory = function (configuration?: Configuration, basePath?
return localVarFp.fetchMuteList(requestParameters.fid, requestParameters.limit, requestParameters.cursor, requestParameters.xNeynarExperimental, options).then((request) => request(axios, basePath));
},
/**
* Adds a mute for a given FID. This is a whitelisted API, reach out if you want access.
* Adds a mute for a given FID. This is an allowlisted API, reach out if you want access.
* @summary Mute FID
* @param {MuteApiPublishMuteRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
Expand All @@ -308,7 +308,7 @@ export const MuteApiFactory = function (configuration?: Configuration, basePath?
*/
export interface MuteApiInterface {
/**
* Deletes a mute for a given FID. This is a whitelisted API, reach out if you want access.
* Deletes a mute for a given FID. This is an allowlisted API, reach out if you want access.
* @summary Unmute FID
* @param {MuteApiDeleteMuteRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
Expand Down Expand Up @@ -336,7 +336,7 @@ export interface MuteApiInterface {
fetchMuteList(requestParameters: MuteApiFetchMuteListRequest, options?: RawAxiosRequestConfig): AxiosPromise<MuteListResponse>;

/**
* Adds a mute for a given FID. This is a whitelisted API, reach out if you want access.
* Adds a mute for a given FID. This is an allowlisted API, reach out if you want access.
* @summary Mute FID
* @param {MuteApiPublishMuteRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
Expand Down Expand Up @@ -440,7 +440,7 @@ export interface MuteApiPublishMuteRequest {
*/
export class MuteApi extends BaseAPI implements MuteApiInterface {
/**
* Deletes a mute for a given FID. This is a whitelisted API, reach out if you want access.
* Deletes a mute for a given FID. This is an allowlisted API, reach out if you want access.
* @summary Unmute FID
* @param {MuteApiDeleteMuteRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
Expand Down Expand Up @@ -472,7 +472,7 @@ export class MuteApi extends BaseAPI implements MuteApiInterface {
}

/**
* Adds a mute for a given FID. This is a whitelisted API, reach out if you want access.
* Adds a mute for a given FID. This is an allowlisted API, reach out if you want access.
* @summary Mute FID
* @param {MuteApiPublishMuteRequest} requestParameters Request parameters.
* @param {*} [options] Override http request option.
Expand Down
Loading

0 comments on commit df51b2d

Please sign in to comment.