EventApiClient

Contains all the endpoints needed to manage events.

Constructors

new EventApiClient()

new EventApiClient(): EventApiClient

Returns

EventApiClient

Methods

changeEventCover()

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

This endpoint changes the event avatar

Parameters

Parameter	Type	Description
id	string | number
data	FormData
config?	AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:211

---

createEvent()

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

This endpoint creates an event.

Parameters

Parameter	Type	Description
data	EventCreateParams | FormData
config?	AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:173

---

deleteEvent()

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

This endpoint deletes an event.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:201

---

getEventFeed()

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

This endpoint performs events search

Parameters

Parameter	Type	Description
id	string | number
params?	EventFeedParams
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:163

---

getEventInvitedUsers()

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

This endpoint returns a list of invited users.

Parameters

Parameter	Type	Description
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:275

---

getEventMembers()

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

This endpoint returns all subscribers of a specific event.

Parameters

Parameter	Type	Description
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:220

---

getEventRelated()

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

This endpoint returns all events related of a specific event.

Parameters

Parameter	Type	Description
id	string | number
params?	EventRelatedParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:398

---

getEventSubscriptionStatus()

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

This endpoint retrieves the event subscription status.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:357

---

getEventSuggestedUsers()

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

This endpoint returns a list of suggested users to invite to the event.

Parameters

Parameter	Type	Description
id	string | number
search	string
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:248

---

getEventWaitingApprovalSubscribers()

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

This endpoint returns all waiting approval subscribers

Parameters

Parameter	Type	Description
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:230

---

getEventsSuggestedUsers()

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

This endpoint returns a list of suggested users to invite to the events.

Parameters

Parameter	Type	Description
search	string
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:261

---

getSpecificEventInfo()

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

This endpoint retrieves a specific event.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:153

---

getUserCreatedEvents()

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

This endpoint returns all events cretaed by a specific event.

Parameters

Parameter	Type	Description
params?	EventRelatedParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:133

---

getUserEvents()

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

This endpoint retrieves all the events of the logged-in user.

Parameters

Parameter	Type	Description
params?	EventUserParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:103

---

getUserSubscribedEvents()

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

This endpoint retrieves a specific user events.

Parameters

Parameter	Type	Description
id	string | number
params?	BaseSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:114

---

getUsersGoingToEvent()

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

This endpoint returns a list of users attending the event.

Parameters

Parameter	Type	Description
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:286

---

getUsersNotGoingToEvent()

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

This endpoint returns a list of users not attending the event.

Parameters

Parameter	Type	Description
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCUserType>>

Source

services/event/index.ts:297

---

goToEvent()

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

This endpoint allows to attend an event

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:365

---

hideEvent()

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

This endpoint hide a specific event.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:415

---

inviteOrAcceptEventRequest()

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

This endpoint allows to invite or accept an event invite.

Parameters

Parameter	Type	Description
id	string | number
data	object
data.users	number[]	-
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:330

---

notGoingToEvent()

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

This endpoint allows to not attend an event

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:381

---

patchEvent()

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

This endpoint patches an event.

Parameters

Parameter	Type	Description
id	string | number
data	SCEventType
config?	AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:193

---

removeGoingToEvent()

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

This endpoint allows to remove an event participation

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:373

---

removeInviteEvent()

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

This endpoint allows to remove invites.

Parameters

Parameter	Type	Description
id	string | number
data	object
data.users	number[]	-
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:344

---

removeNotGoingToEvent()

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

This endpoint allows to remove the event not attending

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:389

---

searchEvents()

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

This endpoint performs events search

Parameters

Parameter	Type	Description
params?	EventSearchParams
config?	AxiosRequestConfig<any>

Returns

Promise <SCPaginatedResponse<SCEventType>>

Source

services/event/index.ts:143

---

showEvent()

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

This endpoint show a specific event.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:407

---

subscribeToEvent()

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

This endpoint subscribes to an event.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:311

---

unsubscribeFromEvent()

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

This endpoint unsubscribes from an event.

Parameters

Parameter	Type	Description
id	string | number
config?	AxiosRequestConfig<any>

Returns

Promise<any>

Source

services/event/index.ts:320

---

updateEvent()

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

This endpoint updates an event.

Parameters

Parameter	Type	Description
id	string | number
data	SCEventType
config?	AxiosRequestConfig<any>

Returns

Promise<SCEventType>

Source

services/event/index.ts:183