echofi-client
Version:
A TypeScript/Node.js client library for EchoFi services with Level 3 Ultimate API and gRPC-Web clients for music streaming, user management, activity tracking, and authentication.
385 lines • 15.4 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';
/**
* Helper functions for creating requests from JSON objects
* Automatically generated for all services and request types
*/
export declare const Helpers: {
Activity: {
/**
* 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;
userId?: string;
trackId?: number;
}): activityService.ListListeningHistoryRequest;
/**
* 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;
userId?: string;
}): activityService.ListUserFavoritesRequest;
/**
* Create a GetPlaylistRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetPlaylistRequest({ playlistId: 123 });
*/
createGetPlaylistRequest(data: {
playlistId: number;
}): activityService.GetPlaylistRequest;
/**
* Create a ListPlaylistsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListPlaylistsRequest({ offset: 123, limit: 123 });
*/
createListPlaylistsRequest(data?: {
offset?: number;
limit?: number;
createdBy?: string;
isPublic?: boolean;
}): activityService.ListPlaylistsRequest;
/**
* Create a ListPlaylistTracksRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListPlaylistTracksRequest({ playlistId: 123, offset: 123 });
*/
createListPlaylistTracksRequest(data: {
playlistId: number;
offset?: number;
limit?: number;
}): activityService.ListPlaylistTracksRequest;
/**
* Create a GetUserPointRateRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUserPointRateRequest({ userId: "value" });
*/
createGetUserPointRateRequest(data: {
userId: string;
}): activityService.GetUserPointRateRequest;
/**
* Create a ListUserPointRatesRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createListUserPointRatesRequest({ offset: 123, limit: 123 });
*/
createListUserPointRatesRequest(data?: {
offset?: number;
limit?: number;
}): activityService.ListUserPointRatesRequest;
/**
* Create a UpdateUserPointRateRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createUpdateUserPointRateRequest({ userId: "value" });
*/
createUpdateUserPointRateRequest(data: {
userId: string;
}): activityService.UpdateUserPointRateRequest;
/**
* 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;
userId?: string;
status?: string;
}): activityService.ListListeningSessionsRequest;
/**
* Create a GetUserPointsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Activity.createGetUserPointsRequest({ userId: "value" });
*/
createGetUserPointsRequest(data: {
userId: string;
}): 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;
};
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;
};
Stats: {
/**
* Create a GetUserStatisticsRequest from a JSON object
* @param data - Object with request properties
* @example
* const request = Helpers.Stats.createGetUserStatisticsRequest({ userId: "value" });
*/
createGetUserStatisticsRequest(data: {
userId: string;
}): 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;
userId?: string;
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 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;
};
};
export default Helpers;
//# sourceMappingURL=helpers.d.ts.map