/** * Audius API * * The version of the OpenAPI document: 1.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as runtime from '../runtime'; import type { EventFollowStateResponse, EventsResponse, FollowersResponse, RemixContestsResponse, TrackCommentsResponse, UnclaimedIdResponse, WriteResponse } from '../models'; export interface FollowEventRequest { eventId: string; userId: string; } export interface GetAllEventsRequest { offset?: number; limit?: number; userId?: string; sortMethod?: GetAllEventsSortMethodEnum; eventType?: GetAllEventsEventTypeEnum; } export interface GetBulkEventsRequest { userId?: string; id?: Array; eventType?: GetBulkEventsEventTypeEnum; } export interface GetEntityEventsRequest { entityId: Array; offset?: number; limit?: number; userId?: string; entityType?: GetEntityEventsEntityTypeEnum; filterDeleted?: boolean; } export interface GetEventCommentsRequest { eventId: string; offset?: number; limit?: number; userId?: string; sortMethod?: GetEventCommentsSortMethodEnum; } export interface GetEventFollowStateRequest { eventId: string; userId?: string; } export interface GetEventFollowStateAliasRequest { eventId: string; userId?: string; } export interface GetEventFollowersRequest { eventId: string; offset?: number; limit?: number; userId?: string; } export interface GetRemixContestsRequest { offset?: number; limit?: number; status?: GetRemixContestsStatusEnum; } export interface UnfollowEventRequest { eventId: string; userId: string; } /** * */ export declare class EventsApi extends runtime.BaseAPI { /** * @hidden * Subscribe to a remix-contest event. Emits a Subscribe/Event ManageEntity transaction so the indexer records the follow. * Follow event */ followEventRaw(params: FollowEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Subscribe to a remix-contest event. Emits a Subscribe/Event ManageEntity transaction so the indexer records the follow. * Follow event */ followEvent(params: FollowEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * @hidden * Get all events * Get all events */ getAllEventsRaw(params: GetAllEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get all events * Get all events */ getAllEvents(params?: GetAllEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * @hidden * Get a list of events by ID */ getBulkEventsRaw(params: GetBulkEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get a list of events by ID */ getBulkEvents(params?: GetBulkEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * @hidden * Get events for a specific entity * Get events for a specific entity */ getEntityEventsRaw(params: GetEntityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get events for a specific entity * Get events for a specific entity */ getEntityEvents(params: GetEntityEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * @hidden * Paginated stream of top-level comments (with nested replies) for a remix-contest event. Host-authored top-level comments represent \"post updates\"; everything else is a community comment. * Get event comments */ getEventCommentsRaw(params: GetEventCommentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Paginated stream of top-level comments (with nested replies) for a remix-contest event. Host-authored top-level comments represent \"post updates\"; everything else is a community comment. * Get event comments */ getEventComments(params: GetEventCommentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * @hidden * Returns whether the current user is subscribed to (follows) a given remix-contest event, plus the total follower count. Useful for rendering the Follow / Following button. * Get event follow state */ getEventFollowStateRaw(params: GetEventFollowStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns whether the current user is subscribed to (follows) a given remix-contest event, plus the total follower count. Useful for rendering the Follow / Following button. * Get event follow state */ getEventFollowState(params: GetEventFollowStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * @hidden * Hyphenated alias of /events/{eventId}/follow_state. * Get event follow state (hyphenated alias) */ getEventFollowStateAliasRaw(params: GetEventFollowStateAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Hyphenated alias of /events/{eventId}/follow_state. * Get event follow state (hyphenated alias) */ getEventFollowStateAlias(params: GetEventFollowStateAliasRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * @hidden * Returns the list of users subscribed to a given remix-contest event, ordered by each follower\'s own follower count so the most-followed fans surface first. Used by the contest page\'s Followers card (avatar stack + leaderboard). * Get event followers */ getEventFollowersRaw(params: GetEventFollowersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Returns the list of users subscribed to a given remix-contest event, ordered by each follower\'s own follower count so the most-followed fans surface first. Used by the contest page\'s Followers card (avatar stack + leaderboard). * Get event followers */ getEventFollowers(params: GetEventFollowersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * @hidden * Get remix contest events ordered with currently-active contests first (by soonest-ending), followed by ended contests (most-recently-ended first). Active contests are those whose end_date is null or in the future. * Get all remix contests */ getRemixContestsRaw(params: GetRemixContestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Get remix contest events ordered with currently-active contests first (by soonest-ending), followed by ended contests (most-recently-ended first). Active contests are those whose end_date is null or in the future. * Get all remix contests */ getRemixContests(params?: GetRemixContestsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * @hidden * Gets an unclaimed blockchain event ID */ getUnclaimedEventIDRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Gets an unclaimed blockchain event ID */ getUnclaimedEventID(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; /** * @hidden * Unsubscribe from a remix-contest event. Emits an Unsubscribe/Event ManageEntity transaction. * Unfollow event */ unfollowEventRaw(params: UnfollowEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise>; /** * Unsubscribe from a remix-contest event. Emits an Unsubscribe/Event ManageEntity transaction. * Unfollow event */ unfollowEvent(params: UnfollowEventRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise; } /** * @export */ export declare const GetAllEventsSortMethodEnum: { readonly Newest: "newest"; readonly Timestamp: "timestamp"; }; export type GetAllEventsSortMethodEnum = typeof GetAllEventsSortMethodEnum[keyof typeof GetAllEventsSortMethodEnum]; /** * @export */ export declare const GetAllEventsEventTypeEnum: { readonly RemixContest: "remix_contest"; readonly LiveEvent: "live_event"; readonly NewRelease: "new_release"; }; export type GetAllEventsEventTypeEnum = typeof GetAllEventsEventTypeEnum[keyof typeof GetAllEventsEventTypeEnum]; /** * @export */ export declare const GetBulkEventsEventTypeEnum: { readonly RemixContest: "remix_contest"; readonly LiveEvent: "live_event"; readonly NewRelease: "new_release"; }; export type GetBulkEventsEventTypeEnum = typeof GetBulkEventsEventTypeEnum[keyof typeof GetBulkEventsEventTypeEnum]; /** * @export */ export declare const GetEntityEventsEntityTypeEnum: { readonly Track: "track"; readonly Collection: "collection"; readonly User: "user"; }; export type GetEntityEventsEntityTypeEnum = typeof GetEntityEventsEntityTypeEnum[keyof typeof GetEntityEventsEntityTypeEnum]; /** * @export */ export declare const GetEventCommentsSortMethodEnum: { readonly Top: "top"; readonly Newest: "newest"; readonly Timestamp: "timestamp"; }; export type GetEventCommentsSortMethodEnum = typeof GetEventCommentsSortMethodEnum[keyof typeof GetEventCommentsSortMethodEnum]; /** * @export */ export declare const GetRemixContestsStatusEnum: { readonly Active: "active"; readonly Ended: "ended"; readonly All: "all"; }; export type GetRemixContestsStatusEnum = typeof GetRemixContestsStatusEnum[keyof typeof GetRemixContestsStatusEnum];