echofi-client
Version:
A comprehensive TypeScript/JavaScript client library for EchoFi services with automatic gRPC-Web code generation, unified service access, and real-time WebSocket communication.
653 lines • 27 kB
TypeScript
/**
* Auto-Generated Request Helper Utilities for EchoFi gRPC-Web Client
*
* These utilities provide a simplified way to create protobuf request objects
* from JSON data, reducing the verbosity of the standard setter approach.
*
* Generated automatically from proto files - do not edit manually
* To regenerate: npm run generate-client
*
* Instead of:
* const request = new Messages.Music.Service.ListArtistsRequest();
* request.setOffset(0);
* request.setLimit(20);
*
* You can use:
* const request = Helpers.Music.createListArtistsRequest({ offset: 0, limit: 20 });
*/
import * as activityService from './activity/service_pb';
import * as authService from './auth/service_pb';
import * as musicService from './music/service_pb';
import * as statsService from './stats/service_pb';
import * as userService from './user/service_pb';
import * as web3authService from './web3auth/service_pb';
/**
* Helper functions for creating requests from JSON objects
* Automatically generated for all services and request types
*/
export declare const Helpers: {
Activity: {
/**
* Create a GetUserFavoriteRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUserFavoriteRequest({ favoriteId: 123 });
*/
createGetUserFavoriteRequest(data: {
favoriteId: number;
}): activityService.GetUserFavoriteRequest;
/**
* Create a ListUserFavoritesRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListUserFavoritesRequest({ offset: 123, limit: 123 });
*/
createListUserFavoritesRequest(data?: {
offset?: number;
limit?: number;
itemType?: string;
}): activityService.ListUserFavoritesRequest;
/**
* Create a AddUserFavoriteRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createAddUserFavoriteRequest({ itemType: "value", itemId: 123 });
*/
createAddUserFavoriteRequest(data: {
itemType: string;
itemId: number;
}): activityService.AddUserFavoriteRequest;
/**
* Create a RemoveUserFavoriteRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createRemoveUserFavoriteRequest({ itemType: "value", itemId: 123 });
*/
createRemoveUserFavoriteRequest(data: {
itemType: string;
itemId: number;
}): activityService.RemoveUserFavoriteRequest;
/**
* Create a GetRateParamRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetRateParamRequest({ paramId: 123 });
*/
createGetRateParamRequest(data: {
paramId: number;
}): activityService.GetRateParamRequest;
/**
* Create a ListRateParamsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListRateParamsRequest({ offset: 123, limit: 123 });
*/
createListRateParamsRequest(data?: {
offset?: number;
limit?: number;
isActive?: boolean;
}): activityService.ListRateParamsRequest;
/**
* Create a GetListeningSessionRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetListeningSessionRequest({ id: "value" });
*/
createGetListeningSessionRequest(data: {
id: string;
}): activityService.GetListeningSessionRequest;
/**
* Create a ListListeningSessionsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListListeningSessionsRequest({ offset: 123, limit: 123 });
*/
createListListeningSessionsRequest(data?: {
offset?: number;
limit?: number;
status?: string;
}): activityService.ListListeningSessionsRequest;
/**
* Create a GetListeningHistoryRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetListeningHistoryRequest({ historyId: 123 });
*/
createGetListeningHistoryRequest(data: {
historyId: number;
}): activityService.GetListeningHistoryRequest;
/**
* Create a ListListeningHistoryRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListListeningHistoryRequest({ offset: 123, limit: 123 });
*/
createListListeningHistoryRequest(data?: {
offset?: number;
limit?: number;
trackId?: number;
}): activityService.ListListeningHistoryRequest;
/**
* Create a GetUserPointsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUserPointsRequest({ });
*/
createGetUserPointsRequest(data?: {}): activityService.GetUserPointsRequest;
/**
* Create a ListUserPointsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListUserPointsRequest({ offset: 123, limit: 123 });
*/
createListUserPointsRequest(data?: {
offset?: number;
limit?: number;
status?: string;
}): activityService.ListUserPointsRequest;
/**
* Create a GetUnprocessedListeningRecordsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUnprocessedListeningRecordsRequest({ offset: 123, limit: 123 });
*/
createGetUnprocessedListeningRecordsRequest(data?: {
offset?: number;
limit?: number;
}): activityService.GetUnprocessedListeningRecordsRequest;
/**
* Create a GetUnprocessedListeningDurationRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUnprocessedListeningDurationRequest({ });
*/
createGetUnprocessedListeningDurationRequest(data?: {}): activityService.GetUnprocessedListeningDurationRequest;
/**
* Create a SetReferrerRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createSetReferrerRequest({ referrerId: "value" });
*/
createSetReferrerRequest(data: {
referrerId: string;
}): activityService.SetReferrerRequest;
/**
* Create a GetUserReferralRewardsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUserReferralRewardsRequest({ });
*/
createGetUserReferralRewardsRequest(data?: {}): activityService.GetUserReferralRewardsRequest;
/**
* Create a ListUserRefereesRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListUserRefereesRequest({ offset: 123, limit: 123 });
*/
createListUserRefereesRequest(data?: {
offset?: number;
limit?: number;
}): activityService.ListUserRefereesRequest;
/**
* Create a GetUserRewardsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUserRewardsRequest({ offset: 123, limit: 123 });
*/
createGetUserRewardsRequest(data?: {
offset?: number;
limit?: number;
claimed?: boolean;
}): activityService.GetUserRewardsRequest;
/**
* Create a ListRewardsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListRewardsRequest({ offset: 123, limit: 123 });
*/
createListRewardsRequest(data?: {
offset?: number;
limit?: number;
isActive?: boolean;
rewardType?: string;
}): activityService.ListRewardsRequest;
};
Auth: {
/**
* Create a GetSessionRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Auth.createGetSessionRequest({ sessionToken: "value" });
*/
createGetSessionRequest(data: {
sessionToken: string;
}): authService.GetSessionRequest;
/**
* Create a CreateSessionRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Auth.createCreateSessionRequest({ session: 123 });
*/
createCreateSessionRequest(data: {
session: any;
}): authService.CreateSessionRequest;
/**
* Create a DeleteSessionRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Auth.createDeleteSessionRequest({ sessionToken: "value" });
*/
createDeleteSessionRequest(data: {
sessionToken: string;
}): authService.DeleteSessionRequest;
};
Music: {
/**
* Create a GetArtistRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetArtistRequest({ artistId: 123 });
*/
createGetArtistRequest(data: {
artistId: number;
}): musicService.GetArtistRequest;
/**
* Create a ListArtistsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createListArtistsRequest({ offset: 123, limit: 123 });
*/
createListArtistsRequest(data?: {
offset?: number;
limit?: number;
}): musicService.ListArtistsRequest;
/**
* Create a GetAlbumRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetAlbumRequest({ albumId: 123 });
*/
createGetAlbumRequest(data: {
albumId: number;
}): musicService.GetAlbumRequest;
/**
* Create a ListAlbumsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createListAlbumsRequest({ offset: 123, limit: 123 });
*/
createListAlbumsRequest(data?: {
offset?: number;
limit?: number;
artistId?: number;
}): musicService.ListAlbumsRequest;
/**
* Create a GetTrackRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetTrackRequest({ trackId: 123 });
*/
createGetTrackRequest(data: {
trackId: number;
}): musicService.GetTrackRequest;
/**
* Create a ListTracksRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createListTracksRequest({ offset: 123, limit: 123 });
*/
createListTracksRequest(data?: {
offset?: number;
limit?: number;
artistId?: number;
albumId?: number;
genreId?: number;
}): musicService.ListTracksRequest;
/**
* Create a GetGenreRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetGenreRequest({ genreId: 123 });
*/
createGetGenreRequest(data: {
genreId: number;
}): musicService.GetGenreRequest;
/**
* Create a ListGenresRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createListGenresRequest({ offset: 123, limit: 123 });
*/
createListGenresRequest(data?: {
offset?: number;
limit?: number;
}): musicService.ListGenresRequest;
/**
* Create a GetPlaylistRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetPlaylistRequest({ playlistId: "value" });
*/
createGetPlaylistRequest(data: {
playlistId: string;
}): musicService.GetPlaylistRequest;
/**
* Create a ListPlaylistsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createListPlaylistsRequest({ offset: 123, limit: 123 });
*/
createListPlaylistsRequest(data?: {
offset?: number;
limit?: number;
createdBy?: string;
isPublic?: boolean;
}): musicService.ListPlaylistsRequest;
/**
* Create a GetUserPlaylistsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetUserPlaylistsRequest({ offset: 123, limit: 123 });
*/
createGetUserPlaylistsRequest(data?: {
offset?: number;
limit?: number;
isPublic?: boolean;
}): musicService.GetUserPlaylistsRequest;
/**
* Create a GetPublicPlaylistsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetPublicPlaylistsRequest({ offset: 123, limit: 123 });
*/
createGetPublicPlaylistsRequest(data?: {
offset?: number;
limit?: number;
isFeatured?: boolean;
isOfficial?: boolean;
}): musicService.GetPublicPlaylistsRequest;
/**
* Create a ListPlaylistTracksRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createListPlaylistTracksRequest({ playlistId: "value", offset: 123 });
*/
createListPlaylistTracksRequest(data: {
playlistId: string;
offset?: number;
limit?: number;
}): musicService.ListPlaylistTracksRequest;
/**
* Create a GetPlaylistTracksRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createGetPlaylistTracksRequest({ playlistId: "value", offset: 123 });
*/
createGetPlaylistTracksRequest(data: {
playlistId: string;
offset?: number;
limit?: number;
}): musicService.GetPlaylistTracksRequest;
/**
* Create a CreatePlaylistRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createCreatePlaylistRequest({ title: "value", description: "value" });
*/
createCreatePlaylistRequest(data: {
title: string;
description: string;
imageUrl: string;
isPublic: boolean;
}): musicService.CreatePlaylistRequest;
/**
* Create a UpdatePlaylistRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createUpdatePlaylistRequest({ playlistId: "value", title: "value" });
*/
createUpdatePlaylistRequest(data: {
playlistId: string;
title?: string;
description?: string;
imageUrl?: string;
isPublic?: boolean;
}): musicService.UpdatePlaylistRequest;
/**
* Create a DeletePlaylistRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createDeletePlaylistRequest({ playlistId: "value" });
*/
createDeletePlaylistRequest(data: {
playlistId: string;
}): musicService.DeletePlaylistRequest;
/**
* Create a UpdatePlaylistTracksRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Music.createUpdatePlaylistTracksRequest({ playlistId: "value", trackIds: 123 });
*/
createUpdatePlaylistTracksRequest(data: {
playlistId: string;
trackIds: number[];
}): musicService.UpdatePlaylistTracksRequest;
};
Stats: {
/**
* Create a GetUserStatisticsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Stats.createGetUserStatisticsRequest({ });
*/
createGetUserStatisticsRequest(data?: {}): statsService.GetUserStatisticsRequest;
/**
* Create a ListUserStatisticsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Stats.createListUserStatisticsRequest({ offset: 123, limit: 123 });
*/
createListUserStatisticsRequest(data?: {
offset?: number;
limit?: number;
}): statsService.ListUserStatisticsRequest;
/**
* Create a GetPointBoostRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Stats.createGetPointBoostRequest({ boostId: 123 });
*/
createGetPointBoostRequest(data: {
boostId: number;
}): statsService.GetPointBoostRequest;
/**
* Create a ListPointBoostsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Stats.createListPointBoostsRequest({ offset: 123, limit: 123 });
*/
createListPointBoostsRequest(data?: {
offset?: number;
limit?: number;
isActive?: boolean;
}): statsService.ListPointBoostsRequest;
};
User: {
/**
* Create a GetUserRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.User.createGetUserRequest({ id: "value" });
*/
createGetUserRequest(data?: {
id?: string;
}): userService.GetUserRequest;
/**
* Create a UpdateUserRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.User.createUpdateUserRequest({ id: "value", name: "value" });
*/
createUpdateUserRequest(data?: {
id?: string;
name?: string;
image?: string;
background?: string;
username?: string;
}): userService.UpdateUserRequest;
/**
* Create a ListUsersRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.User.createListUsersRequest({ offset: 123, limit: 123 });
*/
createListUsersRequest(data?: {
offset?: number;
limit?: number;
}): userService.ListUsersRequest;
/**
* Create a CheckWalletLinkingRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.User.createCheckWalletLinkingRequest({ walletAddress: "value" });
*/
createCheckWalletLinkingRequest(data: {
walletAddress: string;
}): userService.CheckWalletLinkingRequest;
/**
* Create a LinkWalletToUserRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.User.createLinkWalletToUserRequest({ walletAddress: "value" });
*/
createLinkWalletToUserRequest(data: {
walletAddress: string;
}): userService.LinkWalletToUserRequest;
/**
* Create a CheckEmailLinkingRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.User.createCheckEmailLinkingRequest({ email: "value" });
*/
createCheckEmailLinkingRequest(data: {
email: string;
}): userService.CheckEmailLinkingRequest;
/**
* Create a LinkEmailToUserRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.User.createLinkEmailToUserRequest({ email: "value", password: "value" });
*/
createLinkEmailToUserRequest(data: {
email: string;
password: string;
}): userService.LinkEmailToUserRequest;
/**
* Create a GetUserAuthStateRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.User.createGetUserAuthStateRequest({ userId: "value" });
*/
createGetUserAuthStateRequest(data?: {
userId?: string;
}): userService.GetUserAuthStateRequest;
};
Web3Auth: {
/**
* Create a GetChallengeRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Web3Auth.createGetChallengeRequest({ walletAddress: "value" });
*/
createGetChallengeRequest(data: {
walletAddress: string;
}): web3authService.GetChallengeRequest;
/**
* Create a AuthWithSignatureRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Web3Auth.createAuthWithSignatureRequest({ walletAddress: "value", challenge: "value" });
*/
createAuthWithSignatureRequest(data: {
walletAddress: string;
challenge: string;
signature: string;
}): web3authService.AuthWithSignatureRequest;
/**
* Create a AuthWithProofRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Web3Auth.createAuthWithProofRequest({ walletAddress: "value", authProof: 123 });
*/
createAuthWithProofRequest(data: {
walletAddress: string;
authProof: any;
}): web3authService.AuthWithProofRequest;
/**
* Create a ConnectWalletToUserRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Web3Auth.createConnectWalletToUserRequest({ walletAddress: "value" });
*/
createConnectWalletToUserRequest(data: {
walletAddress: string;
}): web3authService.ConnectWalletToUserRequest;
/**
* Create a LinkWalletToAccountRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Web3Auth.createLinkWalletToAccountRequest({ walletAddress: "value", sessionToken: "value" });
*/
createLinkWalletToAccountRequest(data: {
walletAddress: string;
sessionToken: string;
emailPassword: any;
}): web3authService.LinkWalletToAccountRequest;
/**
* Create a GetAccountStatusRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Web3Auth.createGetAccountStatusRequest({ });
*/
createGetAccountStatusRequest(data?: {}): web3authService.GetAccountStatusRequest;
/**
* Create a LinkWalletToWeb2AccountRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Web3Auth.createLinkWalletToWeb2AccountRequest({ walletAddress: "value" });
*/
createLinkWalletToWeb2AccountRequest(data: {
walletAddress: string;
}): web3authService.LinkWalletToWeb2AccountRequest;
/**
* Create a CheckWalletLinkingStatusRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Web3Auth.createCheckWalletLinkingStatusRequest({ walletAddress: "value" });
*/
createCheckWalletLinkingStatusRequest(data: {
walletAddress: string;
}): web3authService.CheckWalletLinkingStatusRequest;
/**
* Create a CheckEmailLinkingStatusRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Web3Auth.createCheckEmailLinkingStatusRequest({ email: "value" });
*/
createCheckEmailLinkingStatusRequest(data: {
email: string;
}): web3authService.CheckEmailLinkingStatusRequest;
/**
* Create a LinkEmailToWeb3AccountRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Web3Auth.createLinkEmailToWeb3AccountRequest({ email: "value", password: "value" });
*/
createLinkEmailToWeb3AccountRequest(data: {
email: string;
password: string;
}): web3authService.LinkEmailToWeb3AccountRequest;
};
};
export default Helpers;
//# sourceMappingURL=helpers.d.ts.map