@proxima-nexus/sdk-typescript 1.0.0

package/dist/api/event-api.d.ts

@@ -0,0 +1,420 @@
+/**
+ * proxima-nexus-data-plane-api
+ * Proxima Nexus Data Plane API
+ *
+ * The version of the OpenAPI document: 1.0.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 type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { CreateEventDto } from '../models';
+import type { EntityConnectionDto } from '../models';
+import type { EventDto } from '../models';
+import type { GetEventsDto } from '../models';
+import type { UpdateEventDto } from '../models';
+import type { UserEntityConnectionDto } from '../models';
+/**
+ * EventApi - axios parameter creator
+ */
+export declare const EventApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Add an attendee to an event
+     * @param {string} eventId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addAttendee: (eventId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Create an event
+     * @param {CreateEventDto} createEventDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create: (createEventDto: CreateEventDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get an event by ID
+     * @param {string} eventId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne: (eventId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get attendees of an event
+     * @param {string} eventId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAttendees: (eventId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get a batch of events by IDs
+     * @param {GetEventsDto} getEventsDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch: (getEventsDto: GetEventsDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete an event
+     * @param {string} eventId
+     * @param {string} xProximaNexusRequesterUserId Requester user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove: (eventId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Search events
+     * @param {string} [displayName] Display name search (ILIKE)
+     * @param {number} [latitude] Latitude for radius search
+     * @param {number} [longitude] Longitude for radius search
+     * @param {number} [radius] Radius in meters for radius search
+     * @param {number} [minLatitude] Minimum latitude for bounding box
+     * @param {number} [maxLatitude] Maximum latitude for bounding box
+     * @param {number} [minLongitude] Minimum longitude for bounding box
+     * @param {number} [maxLongitude] Maximum longitude for bounding box
+     * @param {number} [limit] Limit results (1-1000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    search: (displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Update an event
+     * @param {string} eventId
+     * @param {UpdateEventDto} updateEventDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update: (eventId: string, updateEventDto: UpdateEventDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * EventApi - functional programming interface
+ */
+export declare const EventApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Add an attendee to an event
+     * @param {string} eventId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addAttendee(eventId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntityConnectionDto>>;
+    /**
+     *
+     * @summary Create an event
+     * @param {CreateEventDto} createEventDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createEventDto: CreateEventDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    /**
+     *
+     * @summary Get an event by ID
+     * @param {string} eventId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(eventId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventDto>>;
+    /**
+     *
+     * @summary Get attendees of an event
+     * @param {string} eventId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAttendees(eventId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserEntityConnectionDto>>>;
+    /**
+     *
+     * @summary Get a batch of events by IDs
+     * @param {GetEventsDto} getEventsDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getEventsDto: GetEventsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventDto>>>;
+    /**
+     *
+     * @summary Delete an event
+     * @param {string} eventId
+     * @param {string} xProximaNexusRequesterUserId Requester user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(eventId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Search events
+     * @param {string} [displayName] Display name search (ILIKE)
+     * @param {number} [latitude] Latitude for radius search
+     * @param {number} [longitude] Longitude for radius search
+     * @param {number} [radius] Radius in meters for radius search
+     * @param {number} [minLatitude] Minimum latitude for bounding box
+     * @param {number} [maxLatitude] Maximum latitude for bounding box
+     * @param {number} [minLongitude] Minimum longitude for bounding box
+     * @param {number} [maxLongitude] Maximum longitude for bounding box
+     * @param {number} [limit] Limit results (1-1000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventDto>>>;
+    /**
+     *
+     * @summary Update an event
+     * @param {string} eventId
+     * @param {UpdateEventDto} updateEventDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(eventId: string, updateEventDto: UpdateEventDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+};
+/**
+ * EventApi - factory interface
+ */
+export declare const EventApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Add an attendee to an event
+     * @param {string} eventId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addAttendee(eventId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
+    /**
+     *
+     * @summary Create an event
+     * @param {CreateEventDto} createEventDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createEventDto: CreateEventDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     *
+     * @summary Get an event by ID
+     * @param {string} eventId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(eventId: string, options?: RawAxiosRequestConfig): AxiosPromise<EventDto>;
+    /**
+     *
+     * @summary Get attendees of an event
+     * @param {string} eventId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAttendees(eventId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
+    /**
+     *
+     * @summary Get a batch of events by IDs
+     * @param {GetEventsDto} getEventsDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getEventsDto: GetEventsDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
+    /**
+     *
+     * @summary Delete an event
+     * @param {string} eventId
+     * @param {string} xProximaNexusRequesterUserId Requester user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(eventId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Search events
+     * @param {string} [displayName] Display name search (ILIKE)
+     * @param {number} [latitude] Latitude for radius search
+     * @param {number} [longitude] Longitude for radius search
+     * @param {number} [radius] Radius in meters for radius search
+     * @param {number} [minLatitude] Minimum latitude for bounding box
+     * @param {number} [maxLatitude] Maximum latitude for bounding box
+     * @param {number} [minLongitude] Minimum longitude for bounding box
+     * @param {number} [maxLongitude] Maximum longitude for bounding box
+     * @param {number} [limit] Limit results (1-1000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
+    /**
+     *
+     * @summary Update an event
+     * @param {string} eventId
+     * @param {UpdateEventDto} updateEventDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(eventId: string, updateEventDto: UpdateEventDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+};
+/**
+ * EventApi - interface
+ */
+export interface EventApiInterface {
+    /**
+     *
+     * @summary Add an attendee to an event
+     * @param {string} eventId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addAttendee(eventId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
+    /**
+     *
+     * @summary Create an event
+     * @param {CreateEventDto} createEventDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createEventDto: CreateEventDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     *
+     * @summary Get an event by ID
+     * @param {string} eventId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(eventId: string, options?: RawAxiosRequestConfig): AxiosPromise<EventDto>;
+    /**
+     *
+     * @summary Get attendees of an event
+     * @param {string} eventId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAttendees(eventId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
+    /**
+     *
+     * @summary Get a batch of events by IDs
+     * @param {GetEventsDto} getEventsDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getEventsDto: GetEventsDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
+    /**
+     *
+     * @summary Delete an event
+     * @param {string} eventId
+     * @param {string} xProximaNexusRequesterUserId Requester user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(eventId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Search events
+     * @param {string} [displayName] Display name search (ILIKE)
+     * @param {number} [latitude] Latitude for radius search
+     * @param {number} [longitude] Longitude for radius search
+     * @param {number} [radius] Radius in meters for radius search
+     * @param {number} [minLatitude] Minimum latitude for bounding box
+     * @param {number} [maxLatitude] Maximum latitude for bounding box
+     * @param {number} [minLongitude] Minimum longitude for bounding box
+     * @param {number} [maxLongitude] Maximum longitude for bounding box
+     * @param {number} [limit] Limit results (1-1000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
+    /**
+     *
+     * @summary Update an event
+     * @param {string} eventId
+     * @param {UpdateEventDto} updateEventDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(eventId: string, updateEventDto: UpdateEventDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+}
+/**
+ * EventApi - object-oriented interface
+ */
+export declare class EventApi extends BaseAPI implements EventApiInterface {
+    /**
+     *
+     * @summary Add an attendee to an event
+     * @param {string} eventId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addAttendee(eventId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntityConnectionDto, any, {}>>;
+    /**
+     *
+     * @summary Create an event
+     * @param {CreateEventDto} createEventDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createEventDto: CreateEventDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+    /**
+     *
+     * @summary Get an event by ID
+     * @param {string} eventId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(eventId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDto, any, {}>>;
+    /**
+     *
+     * @summary Get attendees of an event
+     * @param {string} eventId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getAttendees(eventId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserEntityConnectionDto[], any, {}>>;
+    /**
+     *
+     * @summary Get a batch of events by IDs
+     * @param {GetEventsDto} getEventsDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getEventsDto: GetEventsDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDto[], any, {}>>;
+    /**
+     *
+     * @summary Delete an event
+     * @param {string} eventId
+     * @param {string} xProximaNexusRequesterUserId Requester user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(eventId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary Search events
+     * @param {string} [displayName] Display name search (ILIKE)
+     * @param {number} [latitude] Latitude for radius search
+     * @param {number} [longitude] Longitude for radius search
+     * @param {number} [radius] Radius in meters for radius search
+     * @param {number} [minLatitude] Minimum latitude for bounding box
+     * @param {number} [maxLatitude] Maximum latitude for bounding box
+     * @param {number} [minLongitude] Minimum longitude for bounding box
+     * @param {number} [maxLongitude] Maximum longitude for bounding box
+     * @param {number} [limit] Limit results (1-1000)
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDto[], any, {}>>;
+    /**
+     *
+     * @summary Update an event
+     * @param {string} eventId
+     * @param {UpdateEventDto} updateEventDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(eventId: string, updateEventDto: UpdateEventDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+}