EventService

Incubator service can be used in the following way:

1. Import the service from our library:

import {EventService} from "@selfcommunity/api-services";

2. Create a function and put the service inside it!
The async function `searchEvents` will return the events matching the search query.

async searchEvents() {
        return await EventService.searchEvents();
       }

In case of required `params`, just add them inside the brackets.

async getSpecificEventInfo(eventId) {
        return await EventService.getSpecificEventInfo(eventId);
      }

If you need to customize the request, you can add optional config params (`AxiosRequestConfig` type).

1. Declare it(or declare them, it is possible to add multiple params)

const headers = headers: {Authorization: `Bearer ${yourToken}`}

2. Add it inside the brackets and pass it to the function, as shown in the previous example!

Constructors

Constructor

new EventService(): EventService

Returns

EventService

Methods

addMediaToEventPhotoGallery()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCMediaType>

---

changeEventCover()

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

Parameters

Parameter	Type
id	string | number
data	FormData
config?	AxiosRequestConfig

Returns

Promise<SCEventType>

---

createEvent()

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

Parameters

Parameter	Type
data	EventCreateParams | FormData
config?	AxiosRequestConfig

Returns

Promise<SCEventType>

---

deleteEvent()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

getEventFeed()

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

Parameters

Parameter	Type
id	string | number
params?	EventFeedParams
config?	AxiosRequestConfig

Returns

Promise<any>

---

getEventInvitedUsers()

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

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getEventMembers()

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

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getEventPhotoGallery()

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

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCMediaType>>

---

getEventRelated()

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

Parameters

Parameter	Type
id	string | number
params?	EventRelatedParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEventType>>

---

getEventsSuggestedUsers()

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

Parameters

Parameter	Type
search	string
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getEventSubscriptionStatus()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<any>>

---

getEventSuggestedUsers()

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

Parameters

Parameter	Type
id	string | number
search	string
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getEventWaitingApprovalSubscribers()

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

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getSpecificEventInfo()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCEventType>

---

getUserCretaedEvents()

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

Parameters

Parameter	Type
params?	EventRelatedParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEventType>>

---

getUserEvents()

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

Parameters

Parameter	Type
params?	EventUserParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEventType>>

---

getUsersGoingToEvent()

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

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getUsersNotGoingToEvent()

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

Parameters

Parameter	Type
id	string | number
params?	BaseGetParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCUserType>>

---

getUserSubscribedEvents()

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

Parameters

Parameter	Type
id	string | number
params?	BaseSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEventType>>

---

goToEvent()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<any>>

---

hideEvent()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

inviteOrAcceptEventRequest()

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

Parameters

Parameter	Type
id	string | number
data	{ users: number[]; }
data.users	number[]
config?	AxiosRequestConfig

Returns

Promise<any>

---

notGoingToEvent()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<any>>

---

patchEvent()

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

Parameters

Parameter	Type
id	string | number
data	SCEventType
config?	AxiosRequestConfig

Returns

Promise<SCEventType>

---

removeGoingToEvent()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<any>>

---

removeInviteEvent()

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

Parameters

Parameter	Type
id	string | number
data	{ users: number[]; }
data.users	number[]
config?	AxiosRequestConfig

Returns

Promise<any>

---

removeMediasFromEventPhotoGallery()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<void>

---

removeNotGoingToEvent()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<any>>

---

searchEvents()

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

Parameters

Parameter	Type
params?	EventSearchParams
config?	AxiosRequestConfig

Returns

Promise<SCPaginatedResponse<SCEventType>>

---

showEvent()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

subscribeToEvent()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

unsubscribeFromEvent()

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

Parameters

Parameter	Type
id	string | number
config?	AxiosRequestConfig

Returns

Promise<any>

---

updateEvent()

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

Parameters

Parameter	Type
id	string | number
data	SCEventType
config?	AxiosRequestConfig

Returns

Promise<SCEventType>