Skip to main content

EventApiClientInterface

Methods

addMediaToEventPhotoGallery()

addMediaToEventPhotoGallery(id, config?): Promise<SCMediaType>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCMediaType>


changeEventCover()

changeEventCover(id, data, config?): Promise<SCEventType>

Parameters

ParameterType
idstring | number
dataFormData
config?AxiosRequestConfig

Returns

Promise<SCEventType>


createEvent()

createEvent(data, config?): Promise<SCEventType>

Parameters

ParameterType
dataEventCreateParams | FormData
config?AxiosRequestConfig

Returns

Promise<SCEventType>


deleteEvent()

deleteEvent(id, config?): Promise<any>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


getEventFeed()

getEventFeed(id, params?, config?): Promise<any>

Parameters

ParameterType
idstring | number
params?EventFeedParams
config?AxiosRequestConfig

Returns

Promise<any>


getEventInvitedUsers()

getEventInvitedUsers(id, params?, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

ParameterType
idstring | number
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>


getEventMembers()

getEventMembers(id, params?, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

ParameterType
idstring | number
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>


getEventPhotoGallery()

getEventPhotoGallery(id, params?, config?): Promise<SCPaginatedResponse<SCMediaType>>

Parameters

ParameterType
idstring | number
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCMediaType>>


getEventRelated()

getEventRelated(id, params?, config?): Promise<any>

Parameters

ParameterType
idstring | number
params?EventRelatedParams
config?AxiosRequestConfig

Returns

Promise<any>


getEventsSuggestedUsers()

getEventsSuggestedUsers(search, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

ParameterType
searchstring
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>


getEventSubscriptionStatus()

getEventSubscriptionStatus(id, config?): Promise<any>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


getEventSuggestedUsers()

getEventSuggestedUsers(id, search, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

ParameterType
idstring | number
searchstring
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>


getEventWaitingApprovalSubscribers()

getEventWaitingApprovalSubscribers(id, params?, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

ParameterType
idstring | number
params?BaseGetParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>


getSpecificEventInfo()

getSpecificEventInfo(id, config?): Promise<SCEventType>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCEventType>


getUserCreatedEvents()

getUserCreatedEvents(params?, config?): Promise<SCPaginatedResponse<SCEventType>>

Parameters

ParameterType
params?EventRelatedParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEventType>>


getUserEvents()

getUserEvents(params?, config?): Promise<SCPaginatedResponse<SCEventType>>

Parameters

ParameterType
params?EventUserParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEventType>>


getUsersGoingToEvent()

getUsersGoingToEvent(id, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>


getUsersNotGoingToEvent()

getUsersNotGoingToEvent(id, config?): Promise<SCPaginatedResponse<SCUserType>>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>


getUserSubscribedEvents()

getUserSubscribedEvents(id, params?, config?): Promise<SCPaginatedResponse<SCEventType>>

Parameters

ParameterType
idstring | number
params?BaseSearchParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEventType>>


goToEvent()

goToEvent(id, config?): Promise<any>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


hideEvent()

hideEvent(id, config?): Promise<any>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


inviteOrAcceptEventRequest()

inviteOrAcceptEventRequest(id, data, config?): Promise<any>

Parameters

ParameterType
idstring | number
data{ users: number[]; }
data.usersnumber[]
config?AxiosRequestConfig

Returns

Promise<any>


notGoingToEvent()

notGoingToEvent(id, config?): Promise<any>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


patchEvent()

patchEvent(id, data, config?): Promise<SCEventType>

Parameters

ParameterType
idstring | number
dataSCEventType
config?AxiosRequestConfig

Returns

Promise<SCEventType>


removeGoingToEvent()

removeGoingToEvent(id, config?): Promise<any>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


removeInviteEvent()

removeInviteEvent(id, data, config?): Promise<any>

Parameters

ParameterType
idstring | number
data{ users: number[]; }
data.usersnumber[]
config?AxiosRequestConfig

Returns

Promise<any>


removeMediasFromEventPhotoGallery()

removeMediasFromEventPhotoGallery(id, config?): Promise<void>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<void>


removeNotGoingToEvent()

removeNotGoingToEvent(id, config?): Promise<any>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


searchEvents()

searchEvents(params?, config?): Promise<SCPaginatedResponse<SCEventType>>

Parameters

ParameterType
params?EventSearchParams
config?AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEventType>>


showEvent()

showEvent(id, config?): Promise<any>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


subscribeToEvent()

subscribeToEvent(id, config?): Promise<any>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


unsubscribeFromEvent()

unsubscribeFromEvent(id, config?): Promise<any>

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig

Returns

Promise<any>


updateEvent()

updateEvent(id, data, config?): Promise<SCEventType>

Parameters

ParameterType
idstring | number
dataSCEventType
config?AxiosRequestConfig

Returns

Promise<SCEventType>