Skip to main content

EventApiClientInterface

Methods

changeEventCover()

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

Parameters

ParameterType
idstring | number
dataFormData
config?AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:36


createEvent()

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

Parameters

ParameterType
dataEventCreateParams | FormData
config?AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:30


deleteEvent()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:33


getEventFeed()

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

Parameters

ParameterType
idstring | number
params?EventFeedParams
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:27


getEventInvitedUsers()

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

Parameters

ParameterType
idstring | number
params?BaseGetParams
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:55


getEventMembers()

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

Parameters

ParameterType
idstring | number
params?BaseGetParams
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:39


getEventRelated()

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

Parameters

ParameterType
idstring | number
params?EventRelatedParams
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:88


getEventSubscriptionStatus()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:75


getEventSuggestedUsers()

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

Parameters

ParameterType
idstring | number
searchstring
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:49


getEventWaitingApprovalSubscribers()

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

Parameters

ParameterType
idstring | number
params?BaseGetParams
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:42


getEventsSuggestedUsers()

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

Parameters

ParameterType
searchstring
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:52


getSpecificEventInfo()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:24


getUserCreatedEvents()

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

Parameters

ParameterType
params?EventRelatedParams
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:18


getUserEvents()

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

Parameters

ParameterType
params?EventUserParams
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:12


getUserSubscribedEvents()

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

Parameters

ParameterType
idstring | number
params?BaseSearchParams
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:15


getUsersGoingToEvent()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:58


getUsersNotGoingToEvent()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:61


goToEvent()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:78


hideEvent()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:92


inviteOrAcceptEventRequest()

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

Parameters

ParameterType
idstring | number
dataobject
data.usersnumber[]
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:69


notGoingToEvent()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:83


patchEvent()

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

Parameters

ParameterType
idstring | number
dataSCEventType
config?AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:32


removeGoingToEvent()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:80


removeInviteEvent()

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

Parameters

ParameterType
idstring | number
dataobject
data.usersnumber[]
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:72


removeNotGoingToEvent()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:85


searchEvents()

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

Parameters

ParameterType
params?EventSearchParams
config?AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:21


showEvent()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:91


subscribeToEvent()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:64


unsubscribeFromEvent()

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

Parameters

ParameterType
idstring | number
config?AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:65


updateEvent()

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

Parameters

ParameterType
idstring | number
dataSCEventType
config?AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:31