@neynar/nodejs-sdk 3.169.0 → 3.171.0

package/build/clients/NeynarAPIClient.js

@@ -197,20 +197,20 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary User actions across apps
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - The signer_uuid of the user on behalf of whom the action is being performed.
-     * @param {string} params.baseUrl  - The base URL of the app on which the action is being performed.
      * @param {FarcasterActionReqBodyAction} params.action
+     * @param {string} params.baseUrl  - The base URL of the app on which the action is being performed.
+     * @param {string} params.signerUuid  - The signer_uuid of the user on behalf of whom the action is being performed.
      *
      * @returns {Promise<{ [key: string]: any; }>} A promise that resolves to a `{ [key: string]: any; }` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
-     * const baseUrl =
      * const action =
+     * const baseUrl =
+     * const signerUuid =
      *
-     * client.publishFarcasterAction({signerUuid, baseUrl, action}).then(response => {
+     * client.publishFarcasterAction({action, baseUrl, signerUuid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -230,20 +230,20 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Create transaction pay mini app
      *
      * @param {object} params
-     * @param {FramePayTransactionReqBodyTransaction} params.transaction
      * @param {TransactionFrameConfig} params.config
      * @param {string} params.idem [optional]  - An Idempotency key is a unique identifier for the request. **Note:**  1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
+     * @param {FramePayTransactionReqBodyTransaction} params.transaction
      *
      * @returns {Promise<TransactionFrameResponse>} A promise that resolves to a `TransactionFrameResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const transaction =
      * const config =
      * const idem =
+     * const transaction =
      *
-     * client.createTransactionPayFrame({transaction, config, idem}).then(response => {
+     * client.createTransactionPayFrame({config, idem, transaction}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -391,24 +391,24 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Send event
      *
      * @param {object} params
-     * @param {SignedMessageBodySignedMessage} params.signedMessage
      * @param {string} params.appDomain  - Domain of the mini app
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
-     * @param {number} params.fid  - The unique identifier of a farcaster user or app (unsigned integer)
+     * @param {SignedMessageBodySignedMessage} params.signedMessage
      * @param {AppHostPostEventReqBodyEventEnum} params.event  - Types of events that can occur between a user and an app host: - frame_added: User adds a mini app to their account - frame_removed: User removes a mini app from their account - notifications_enabled: User enables notifications for a mini app - notifications_disabled: User disables notifications for a mini app
+     * @param {number} params.fid  - The unique identifier of a farcaster user or app (unsigned integer)
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      *
      * @returns {Promise<AppHostPostEventResponse>} A promise that resolves to a `AppHostPostEventResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signedMessage =
      * const appDomain =
-     * const signerUuid =
-     * const fid =
+     * const signedMessage =
      * const event =
+     * const fid =
+     * const signerUuid =
      *
-     * client.appHostPostEvent({signedMessage, appDomain, signerUuid, fid, event}).then(response => {
+     * client.appHostPostEvent({appDomain, signedMessage, event, fid, signerUuid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -430,7 +430,7 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {object} params
      * @param {string} params.address  - Ethereum address
      *
-     * @returns {Promise<RegisterSignedKeyForDeveloperManagedAuthAddress200Response>} A promise that resolves to a `RegisterSignedKeyForDeveloperManagedAuthAddress200Response` object.
+     * @returns {Promise<LookupDeveloperManagedAuthAddress200Response>} A promise that resolves to a `LookupDeveloperManagedAuthAddress200Response` object.
      *
      * @example
      *
@@ -459,11 +459,11 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {string} params.address  - Ethereum address
      * @param {number} params.appFid  - The unique identifier of a farcaster user or app (unsigned integer)
      * @param {number} params.deadline  - unix timestamp in seconds that controls how long the signed key request is valid for. (24 hours from now is recommended)
-     * @param {string} params.signature  - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, 32 bytes padded auth address. [Refer guide for more details.](https://docs.neynar.com/docs/auth-address-signature-generation)
      * @param {string} params.redirectUrl [optional]  - Url to redirect to after the signer is approved. **Note** : This should only be used when requesting a signer from a native mobile application.
+     * @param {string} params.signature  - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, 32 bytes padded auth address. [Refer guide for more details.](https://docs.neynar.com/docs/auth-address-signature-generation)
      * @param {SignedKeyRequestSponsor} params.sponsor [optional]
      *
-     * @returns {Promise<RegisterSignedKeyForDeveloperManagedAuthAddress200Response>} A promise that resolves to a `RegisterSignedKeyForDeveloperManagedAuthAddress200Response` object.
+     * @returns {Promise<LookupDeveloperManagedAuthAddress200Response>} A promise that resolves to a `LookupDeveloperManagedAuthAddress200Response` object.
      *
      * @example
      *
@@ -471,11 +471,11 @@ const client = new NeynarAPIClient(config);\n`);
      * const address =
      * const appFid =
      * const deadline =
-     * const signature =
      * const redirectUrl =
+     * const signature =
      * const sponsor =
      *
-     * client.registerSignedKeyForDeveloperManagedAuthAddress({address, appFid, deadline, signature, redirectUrl, sponsor}).then(response => {
+     * client.registerSignedKeyForDeveloperManagedAuthAddress({address, appFid, deadline, redirectUrl, signature, sponsor}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -584,18 +584,18 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Unblock FID
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {number} params.blockedFid  - The unique identifier of a farcaster user or app (unsigned integer)
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
      * const blockedFid =
+     * const signerUuid =
      *
-     * client.deleteBlock({signerUuid, blockedFid}).then(response => {
+     * client.deleteBlock({blockedFid, signerUuid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -650,18 +650,18 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Block FID
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {number} params.blockedFid  - The unique identifier of a farcaster user or app (unsigned integer)
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
      * const blockedFid =
+     * const signerUuid =
      *
-     * client.publishBlock({signerUuid, blockedFid}).then(response => {
+     * client.publishBlock({blockedFid, signerUuid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -893,28 +893,28 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Post a cast
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
-     * @param {string} params.text [optional]
-     * @param {Array<PostCastReqBodyEmbeds>} params.embeds [optional]
-     * @param {string} params.parent [optional]  - parent_url of the channel the cast is in, or hash of the cast
      * @param {string} params.channelId [optional]  - Channel ID of the channel where the cast is to be posted. e.g. neynar, farcaster, warpcast
+     * @param {Array<PostCastReqBodyEmbeds>} params.embeds [optional]
      * @param {string} params.idem [optional]  - An Idempotency key is a unique identifier for the request. **Note:**  1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
+     * @param {string} params.parent [optional]  - parent_url of the channel the cast is in, or hash of the cast
      * @param {number} params.parentAuthorFid [optional]  - The unique identifier of a farcaster user or app (unsigned integer)
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
+     * @param {string} params.text [optional]
      *
      * @returns {Promise<PostCastResponse>} A promise that resolves to a `PostCastResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
-     * const text =
-     * const embeds =
-     * const parent =
      * const channelId =
+     * const embeds =
      * const idem =
+     * const parent =
      * const parentAuthorFid =
+     * const signerUuid =
+     * const text =
      *
-     * client.publishCast({signerUuid, text, embeds, parent, channelId, idem, parentAuthorFid}).then(response => {
+     * client.publishCast({channelId, embeds, idem, parent, parentAuthorFid, signerUuid, text}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -1302,18 +1302,18 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Follow a channel
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {string} params.channelId  - The unique identifier of a farcaster channel
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
      * const channelId =
+     * const signerUuid =
      *
-     * client.followChannel({signerUuid, channelId}).then(response => {
+     * client.followChannel({channelId, signerUuid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -1333,22 +1333,22 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Invite
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {string} params.channelId  - The unique identifier of a farcaster channel
      * @param {number} params.fid  - The unique identifier of a farcaster user or app (unsigned integer)
      * @param {ChannelMemberRole} params.role
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
      * const channelId =
      * const fid =
      * const role =
+     * const signerUuid =
      *
-     * client.inviteChannelMember({signerUuid, channelId, fid, role}).then(response => {
+     * client.inviteChannelMember({channelId, fid, role, signerUuid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -1400,22 +1400,22 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Remove user
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {string} params.channelId  - The unique identifier of a farcaster channel
      * @param {number} params.fid  - The unique identifier of a farcaster user or app (unsigned integer)
      * @param {ChannelMemberRole} params.role
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
      * const channelId =
      * const fid =
      * const role =
+     * const signerUuid =
      *
-     * client.removeChannelMember({signerUuid, channelId, fid, role}).then(response => {
+     * client.removeChannelMember({channelId, fid, role, signerUuid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -1435,22 +1435,22 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Accept or reject an invite
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
+     * @param {boolean} params.accept  - Accept or reject the invite
      * @param {string} params.channelId  - The unique identifier of a farcaster channel
      * @param {ChannelMemberRole} params.role
-     * @param {boolean} params.accept  - Accept or reject the invite
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
+     * const accept =
      * const channelId =
      * const role =
-     * const accept =
+     * const signerUuid =
      *
-     * client.respondChannelInvite({signerUuid, channelId, role, accept}).then(response => {
+     * client.respondChannelInvite({accept, channelId, role, signerUuid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -1503,18 +1503,18 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Unfollow a channel
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {string} params.channelId  - The unique identifier of a farcaster channel
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
      * const channelId =
+     * const signerUuid =
      *
-     * client.unfollowChannel({signerUuid, channelId}).then(response => {
+     * client.unfollowChannel({channelId, signerUuid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -2317,20 +2317,20 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Send notifications
      *
      * @param {object} params
-     * @param {Array<number>} params.targetFids [optional]  - An array of target FIDs to whom the notifications should be sent. Each FID must be a positive integer. Pass an empty array to send notifications to all FIDs with notifications enabled for the mini app.
      * @param {SendFrameNotificationsReqBodyFilters} params.filters [optional]
      * @param {SendFrameNotificationsReqBodyNotification} params.notification
+     * @param {Array<number>} params.targetFids [optional]  - An array of target FIDs to whom the notifications should be sent. Each FID must be a positive integer. Pass an empty array to send notifications to all FIDs with notifications enabled for the mini app.
      *
      * @returns {Promise<SendFrameNotificationsResponse>} A promise that resolves to a `SendFrameNotificationsResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const targetFids =
      * const filters =
      * const notification =
+     * const targetFids =
      *
-     * client.publishFrameNotifications({targetFids, filters, notification}).then(response => {
+     * client.publishFrameNotifications({filters, notification, targetFids}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -2777,38 +2777,38 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Deploy fungible
      *
      * @param {object} params
+     * @param {string} params.name  - Name of the token
      * @param {string} params.owner  - Ethereum address of the one who is creating the token
      * @param {string} params.symbol  - Symbol/Ticker for the token
-     * @param {string} params.name  - Name of the token
-     * @param {File} params.metadataMedia [optional]  - Media file associated with the token.  Supported formats are image/jpeg, image/gif and image/png
+     * @param {DeployFungibleFactoryEnum} params.factory [optional]  - Factory name - wow -> [wow.xyz](https://wow.xyz) - clanker -> [clanker.world](https://www.clanker.world)
      * @param {string} params.metadataDescription [optional]  - Description of the token
-     * @param {DeployFungibleMetadataNsfwEnum} params.metadataNsfw [optional]  - Indicates if the token is NSFW (Not Safe For Work).
-     * @param {string} params.metadataWebsiteLink [optional]  - Website link related to the token
-     * @param {string} params.metadataTwitter [optional]  - Twitter profile link
      * @param {string} params.metadataDiscord [optional]  - Discord server link
+     * @param {File | null} params.metadataMedia [optional]  - Media file associated with the token.  Supported formats are image/jpeg, image/gif and image/png
+     * @param {DeployFungibleMetadataNsfwEnum} params.metadataNsfw [optional]  - Indicates if the token is NSFW (Not Safe For Work).
      * @param {string} params.metadataTelegram [optional]  - Telegram link
+     * @param {string} params.metadataTwitter [optional]  - Twitter profile link
+     * @param {string} params.metadataWebsiteLink [optional]  - Website link related to the token
      * @param {DeployFungibleNetworkEnum} params.network [optional]  - Network/Chain name
-     * @param {DeployFungibleFactoryEnum} params.factory [optional]  - Factory name - wow -> [wow.xyz](https://wow.xyz) - clanker -> [clanker.world](https://www.clanker.world)
      *
      * @returns {Promise<DeployFungibleResponse>} A promise that resolves to a `DeployFungibleResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
+     * const name =
      * const owner =
      * const symbol =
-     * const name =
-     * const metadataMedia =
+     * const factory =
      * const metadataDescription =
-     * const metadataNsfw =
-     * const metadataWebsiteLink =
-     * const metadataTwitter =
      * const metadataDiscord =
+     * const metadataMedia =
+     * const metadataNsfw =
      * const metadataTelegram =
+     * const metadataTwitter =
+     * const metadataWebsiteLink =
      * const network =
-     * const factory =
      *
-     * client.deployFungible({ owner, symbol, name, metadataMedia, metadataDescription, metadataNsfw, metadataWebsiteLink, metadataTwitter, metadataDiscord, metadataTelegram, network, factory }).then(response => {
+     * client.deployFungible({ name, owner, symbol, factory, metadataDescription, metadataDiscord, metadataMedia, metadataNsfw, metadataTelegram, metadataTwitter, metadataWebsiteLink, network }).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3155,8 +3155,8 @@ const client = new NeynarAPIClient(config);\n`);
      * @param {string} params.idem [optional]  - An Idempotency key is a unique identifier for the request. **Note:**  1) Pre-registration calls must be idempotent when using idempotency keys. 2) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 3) This should be a unique identifier for each request. 4) Recommended format is a 16-character string generated by the developer at the time of making this request.
      * @param {Array<RegisterUserOnChainReqBodyPreRegistrationCallsInner>} params.preRegistrationCalls [optional]
      * @param {RegisterUserOnChainReqBodyRegistration} params.registration
-     * @param {number} params.storageUnits [optional]
      * @param {Array<RegisterUserOnChainReqBodySignersInner>} params.signers [optional]
+     * @param {number} params.storageUnits [optional]
      *
      * @returns {Promise<RegisterUserOnChainResponse>} A promise that resolves to a `RegisterUserOnChainResponse` object.
      *
@@ -3166,10 +3166,10 @@ const client = new NeynarAPIClient(config);\n`);
      * const idem =
      * const preRegistrationCalls =
      * const registration =
-     * const storageUnits =
      * const signers =
+     * const storageUnits =
      *
-     * client.registerAccountOnchain({idem, preRegistrationCalls, registration, storageUnits, signers}).then(response => {
+     * client.registerAccountOnchain({idem, preRegistrationCalls, registration, signers, storageUnits}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3191,8 +3191,8 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Send fungibles
      *
      * @param {object} params
-     * @param {TransactionSendFungiblesReqBodyNetworkEnum} params.network
      * @param {string} params.fungibleContractAddress [optional]  - Contract address of the fungible token to send. If not provided, the default is the native token of the network.
+     * @param {TransactionSendFungiblesReqBodyNetworkEnum} params.network
      * @param {Array<TransactionSendFungiblesRecipient>} params.recipients
      *
      * @returns {Promise<TransactionSendFungiblesResponse>} A promise that resolves to a `TransactionSendFungiblesResponse` object.
@@ -3200,11 +3200,11 @@ const client = new NeynarAPIClient(config);\n`);
      * @example
      *
      * // Fill in the appropriate values
-     * const network =
      * const fungibleContractAddress =
+     * const network =
      * const recipients =
      *
-     * client.sendFungiblesToUsers({network, fungibleContractAddress, recipients}).then(response => {
+     * client.sendFungiblesToUsers({fungibleContractAddress, network, recipients}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3283,6 +3283,8 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
+     * Retrieves billing and subscription details for the current organization, including plan status, product category, billing email, and effective plan.
+     *
      * @summary Get billing information for the current organization
      *
      *
@@ -3302,6 +3304,8 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
+     * Applies a subscription plan change for the current organization and returns the applied credit, charge amount, and whether the change takes effect immediately.
+     *
      * @summary Process subscription upgrade with credit
      *
      * @param {object} params
@@ -3328,6 +3332,8 @@ const client = new NeynarAPIClient(config);\n`);
         return response.data;
     }
     /**
+     * Calculates the billing impact of changing to a new subscription plan, including available credit, charge amount, and whether the billing date or usage carryover changes.
+     *
      * @summary Get upgrade preview with credit calculation
      *
      * @param {object} params
@@ -3361,24 +3367,24 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Delete reaction
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
+     * @param {string} params.idem [optional]  - An Idempotency key is a unique identifier for the request. **Note:**  1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
      * @param {ReactionType} params.reactionType
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {string} params.target  - Target cast hash (hex string starting with 0x) OR a valid URL.
      * @param {number} params.targetAuthorFid [optional]  - The unique identifier of a farcaster user or app (unsigned integer)
-     * @param {string} params.idem [optional]  - An Idempotency key is a unique identifier for the request. **Note:**  1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
+     * const idem =
      * const reactionType =
+     * const signerUuid =
      * const target =
      * const targetAuthorFid =
-     * const idem =
      *
-     * client.deleteReaction({signerUuid, reactionType, target, targetAuthorFid, idem}).then(response => {
+     * client.deleteReaction({idem, reactionType, signerUuid, target, targetAuthorFid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3468,24 +3474,24 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Post a reaction
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
+     * @param {string} params.idem [optional]  - An Idempotency key is a unique identifier for the request. **Note:**  1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
      * @param {ReactionType} params.reactionType
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {string} params.target  - Target cast hash (hex string starting with 0x) OR a valid URL.
      * @param {number} params.targetAuthorFid [optional]  - The unique identifier of a farcaster user or app (unsigned integer)
-     * @param {string} params.idem [optional]  - An Idempotency key is a unique identifier for the request. **Note:**  1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
+     * const idem =
      * const reactionType =
+     * const signerUuid =
      * const target =
      * const targetAuthorFid =
-     * const idem =
      *
-     * client.publishReaction({signerUuid, reactionType, target, targetAuthorFid, idem}).then(response => {
+     * client.publishReaction({idem, reactionType, signerUuid, target, targetAuthorFid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3670,11 +3676,11 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Register Signed Key
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
-     * @param {string} params.signature  - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer\'s public key
      * @param {number} params.appFid  - The unique identifier of a farcaster user or app (unsigned integer)
      * @param {number} params.deadline  - unix timestamp in seconds that controls how long the signed key request is valid for. (24 hours from now is recommended)
      * @param {string} params.redirectUrl [optional]  - Url to redirect to after the signer is approved. **Note** : This should only be used when requesting a signer from a native mobile application.
+     * @param {string} params.signature  - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer\'s public key
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {SignedKeyRequestSponsor} params.sponsor [optional]
      *
      * @returns {Promise<Signer>} A promise that resolves to a `Signer` object.
@@ -3682,14 +3688,14 @@ const client = new NeynarAPIClient(config);\n`);
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
-     * const signature =
      * const appFid =
      * const deadline =
      * const redirectUrl =
+     * const signature =
+     * const signerUuid =
      * const sponsor =
      *
-     * client.registerSignedKey({signerUuid, signature, appFid, deadline, redirectUrl, sponsor}).then(response => {
+     * client.registerSignedKey({appFid, deadline, redirectUrl, signature, signerUuid, sponsor}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3709,11 +3715,11 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Register Signed Key
      *
      * @param {object} params
-     * @param {string} params.publicKey  - Ed25519 public key
-     * @param {string} params.signature  - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer\'s public key
      * @param {number} params.appFid  - The unique identifier of a farcaster user or app (unsigned integer)
      * @param {number} params.deadline  - unix timestamp in seconds that controls how long the signed key request is valid for. (24 hours from now is recommended)
+     * @param {string} params.publicKey  - Ed25519 public key
      * @param {string} params.redirectUrl [optional]  - Url to redirect to after the signer is approved. **Note** : This should only be used when requesting a signer from a native mobile application.
+     * @param {string} params.signature  - Signature generated by the custody address of the app. Signed data includes app_fid, deadline, signer\'s public key
      * @param {SignedKeyRequestSponsor} params.sponsor [optional]
      *
      * @returns {Promise<DeveloperManagedSigner>} A promise that resolves to a `DeveloperManagedSigner` object.
@@ -3721,14 +3727,14 @@ const client = new NeynarAPIClient(config);\n`);
      * @example
      *
      * // Fill in the appropriate values
-     * const publicKey =
-     * const signature =
      * const appFid =
      * const deadline =
+     * const publicKey =
      * const redirectUrl =
+     * const signature =
      * const sponsor =
      *
-     * client.registerSignedKeyForDeveloperManagedSigner({publicKey, signature, appFid, deadline, redirectUrl, sponsor}).then(response => {
+     * client.registerSignedKeyForDeveloperManagedSigner({appFid, deadline, publicKey, redirectUrl, signature, sponsor}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -3749,8 +3755,8 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * @param {object} params
      * @param {number} params.fid  - The unique identifier of a farcaster user or app (unsigned integer)
-     * @param {number} params.units [optional]  - Number of storage units to buy. A storage unit lets you store 5000 casts, 2500 reactions and 2500 links.
      * @param {string} params.idem [optional]  - An Idempotency key is a unique identifier for the request. **Note:**  1) This is used to prevent duplicate requests. Use the same idem key on retry attempts. 2) This should be a unique identifier for each request. 3) Recommended format is a 16-character string generated by the developer at the time of making this request.
+     * @param {number} params.units [optional]  - Number of storage units to buy. A storage unit lets you store 5000 casts, 2500 reactions and 2500 links.
      *
      * @returns {Promise<StorageAllocationsResponse>} A promise that resolves to a `StorageAllocationsResponse` object.
      *
@@ -3758,10 +3764,10 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * // Fill in the appropriate values
      * const fid =
-     * const units =
      * const idem =
+     * const units =
      *
-     * client.buyStorage({fid, units, idem}).then(response => {
+     * client.buyStorage({fid, idem, units}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -5158,22 +5164,22 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Delete verification
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {string} params.address  - Ethereum address
      * @param {string} params.blockHash
      * @param {string} params.ethSignature
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
      * const address =
      * const blockHash =
      * const ethSignature =
+     * const signerUuid =
      *
-     * client.deleteVerification({signerUuid, address, blockHash, ethSignature}).then(response => {
+     * client.deleteVerification({address, blockHash, ethSignature, signerUuid}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -5515,26 +5521,26 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Add verification
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {string} params.address  - Ethereum address
      * @param {string} params.blockHash
+     * @param {VerificationChainId} params.chainId [optional]
      * @param {string} params.ethSignature
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
      * @param {VerificationType} params.verificationType [optional]
-     * @param {VerificationChainId} params.chainId [optional]
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
      * const address =
      * const blockHash =
+     * const chainId =
      * const ethSignature =
+     * const signerUuid =
      * const verificationType =
-     * const chainId =
      *
-     * client.publishVerification({signerUuid, address, blockHash, ethSignature, verificationType, chainId}).then(response => {
+     * client.publishVerification({address, blockHash, chainId, ethSignature, signerUuid, verificationType}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -5554,28 +5560,28 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Register new account
      *
      * @param {object} params
-     * @param {RegisterUserReqBodySigner} params.signer [optional]
-     * @param {string} params.signature
-     * @param {number} params.fid
-     * @param {string} params.requestedUserCustodyAddress
      * @param {number} params.deadline
+     * @param {number} params.fid
      * @param {string} params.fname [optional]
      * @param {RegisterUserReqBodyMetadata} params.metadata [optional]
+     * @param {string} params.requestedUserCustodyAddress
+     * @param {string} params.signature
+     * @param {RegisterUserReqBodySigner} params.signer [optional]
      *
      * @returns {Promise<RegisterUserResponse>} A promise that resolves to a `RegisterUserResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signer =
-     * const signature =
-     * const fid =
-     * const requestedUserCustodyAddress =
      * const deadline =
+     * const fid =
      * const fname =
      * const metadata =
+     * const requestedUserCustodyAddress =
+     * const signature =
+     * const signer =
      *
-     * client.registerAccount({signer, signature, fid, requestedUserCustodyAddress, deadline, fname, metadata}).then(response => {
+     * client.registerAccount({deadline, fid, fname, metadata, requestedUserCustodyAddress, signature, signer}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -5663,36 +5669,36 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Update user profile
      *
      * @param {object} params
-     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
+     * @param {string} params.banner [optional]  - Requires pro subscription.
      * @param {string} params.bio [optional]
-     * @param {string} params.pfpUrl [optional]
-     * @param {string} params.url [optional]
-     * @param {string} params.username [optional]
      * @param {string} params.displayName [optional]
-     * @param {UpdateUserReqBodyLocation} params.location [optional]
-     * @param {string} params.banner [optional]  - Requires pro subscription.
+     * @param {RegisterUserReqBodyMetadataLocation} params.location [optional]
+     * @param {string} params.pfpUrl [optional]
      * @param {string} params.primaryEthAddress [optional]  - Must be one of the verified addresses.
      * @param {string} params.primarySolAddress [optional]  - Must be one of the verified addresses.
-     * @param {UpdateUserReqBodyVerifiedAccounts} params.verifiedAccounts [optional]
+     * @param {string} params.signerUuid  - UUID of the signer. `signer_uuid` is paired with API key, can\'t use a `uuid` made with a different API key.
+     * @param {string} params.url [optional]
+     * @param {string} params.username [optional]
+     * @param {RegisterUserReqBodyMetadataVerifiedAccounts} params.verifiedAccounts [optional]
      *
      * @returns {Promise<OperationResponse>} A promise that resolves to a `OperationResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const signerUuid =
+     * const banner =
      * const bio =
-     * const pfpUrl =
-     * const url =
-     * const username =
      * const displayName =
      * const location =
-     * const banner =
+     * const pfpUrl =
      * const primaryEthAddress =
      * const primarySolAddress =
+     * const signerUuid =
+     * const url =
+     * const username =
      * const verifiedAccounts =
      *
-     * client.updateUser({signerUuid, bio, pfpUrl, url, username, displayName, location, banner, primaryEthAddress, primarySolAddress, verifiedAccounts}).then(response => {
+     * client.updateUser({banner, bio, displayName, location, pfpUrl, primaryEthAddress, primarySolAddress, signerUuid, url, username, verifiedAccounts}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -5791,8 +5797,8 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * @param {object} params
      * @param {string} params.name
-     * @param {string} params.url
      * @param {WebhookSubscriptionFilters} params.subscription [optional]
+     * @param {string} params.url
      *
      * @returns {Promise<WebhookResponse>} A promise that resolves to a `WebhookResponse` object.
      *
@@ -5800,10 +5806,10 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * // Fill in the appropriate values
      * const name =
-     * const url =
      * const subscription =
+     * const url =
      *
-     * client.publishWebhook({name, url, subscription}).then(response => {
+     * client.publishWebhook({name, subscription, url}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -5824,8 +5830,8 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * @param {object} params
      * @param {string} params.name
-     * @param {string} params.url
      * @param {WebhookSubscriptionFilters} params.subscription [optional]
+     * @param {string} params.url
      * @param {string} params.webhookId
      *
      * @returns {Promise<WebhookResponse>} A promise that resolves to a `WebhookResponse` object.
@@ -5834,11 +5840,11 @@ const client = new NeynarAPIClient(config);\n`);
      *
      * // Fill in the appropriate values
      * const name =
-     * const url =
      * const subscription =
+     * const url =
      * const webhookId =
      *
-     * client.updateWebhook({name, url, subscription, webhookId}).then(response => {
+     * client.updateWebhook({name, subscription, url, webhookId}).then(response => {
      *   console.log('response:', response);
      * });
      *
@@ -5858,18 +5864,18 @@ const client = new NeynarAPIClient(config);\n`);
      * @summary Update webhook status
      *
      * @param {object} params
-     * @param {string} params.webhookId
      * @param {WebhookPatchReqBodyActiveEnum} params.active
+     * @param {string} params.webhookId
      *
      * @returns {Promise<WebhookResponse>} A promise that resolves to a `WebhookResponse` object.
      *
      * @example
      *
      * // Fill in the appropriate values
-     * const webhookId =
      * const active =
+     * const webhookId =
      *
-     * client.updateWebhookActiveStatus({webhookId, active}).then(response => {
+     * client.updateWebhookActiveStatus({active, webhookId}).then(response => {
      *   console.log('response:', response);
      * });
      *