@proxima-nexus/sdk-typescript 1.0.0

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

@@ -0,0 +1,506 @@
+/**
+ * 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 { CreateGroupDto } from '../models';
+import type { EntityConnectionDto } from '../models';
+import type { EventEntityConnectionDto } from '../models';
+import type { GetGroupsDto } from '../models';
+import type { GroupDto } from '../models';
+import type { UpdateGroupDto } from '../models';
+import type { UserEntityConnectionDto } from '../models';
+/**
+ * GroupApi - axios parameter creator
+ */
+export declare const GroupApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Add a member to a group
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addMember: (groupId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Create a group
+     * @param {CreateGroupDto} createGroupDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create: (createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get a group by ID
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne: (groupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get a batch of groups by IDs
+     * @param {GetGroupsDto} getGroupsDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch: (getGroupsDto: GetGroupsDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get events of a group
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents: (groupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get members of a group
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMembers: (groupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete a group
+     * @param {string} groupId
+     * @param {string} xProximaNexusRequesterUserId Requester user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove: (groupId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Remove a member from a group
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeMember: (groupId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Search groups
+     * @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 a group
+     * @param {string} groupId
+     * @param {UpdateGroupDto} updateGroupDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update: (groupId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * GroupApi - functional programming interface
+ */
+export declare const GroupApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Add a member to a group
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntityConnectionDto>>;
+    /**
+     *
+     * @summary Create a group
+     * @param {CreateGroupDto} createGroupDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    /**
+     *
+     * @summary Get a group by ID
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupDto>>;
+    /**
+     *
+     * @summary Get a batch of groups by IDs
+     * @param {GetGroupsDto} getGroupsDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getGroupsDto: GetGroupsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupDto>>>;
+    /**
+     *
+     * @summary Get events of a group
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents(groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventEntityConnectionDto>>>;
+    /**
+     *
+     * @summary Get members of a group
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMembers(groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserEntityConnectionDto>>>;
+    /**
+     *
+     * @summary Delete a group
+     * @param {string} groupId
+     * @param {string} xProximaNexusRequesterUserId Requester user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(groupId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Remove a member from a group
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    /**
+     *
+     * @summary Search groups
+     * @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<GroupDto>>>;
+    /**
+     *
+     * @summary Update a group
+     * @param {string} groupId
+     * @param {UpdateGroupDto} updateGroupDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(groupId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+};
+/**
+ * GroupApi - factory interface
+ */
+export declare const GroupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Add a member to a group
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
+    /**
+     *
+     * @summary Create a group
+     * @param {CreateGroupDto} createGroupDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     *
+     * @summary Get a group by ID
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<GroupDto>;
+    /**
+     *
+     * @summary Get a batch of groups by IDs
+     * @param {GetGroupsDto} getGroupsDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getGroupsDto: GetGroupsDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupDto>>;
+    /**
+     *
+     * @summary Get events of a group
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
+    /**
+     *
+     * @summary Get members of a group
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMembers(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
+    /**
+     *
+     * @summary Delete a group
+     * @param {string} groupId
+     * @param {string} xProximaNexusRequesterUserId Requester user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(groupId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Remove a member from a group
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     *
+     * @summary Search groups
+     * @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<GroupDto>>;
+    /**
+     *
+     * @summary Update a group
+     * @param {string} groupId
+     * @param {UpdateGroupDto} updateGroupDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(groupId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+};
+/**
+ * GroupApi - interface
+ */
+export interface GroupApiInterface {
+    /**
+     *
+     * @summary Add a member to a group
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
+    /**
+     *
+     * @summary Create a group
+     * @param {CreateGroupDto} createGroupDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     *
+     * @summary Get a group by ID
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<GroupDto>;
+    /**
+     *
+     * @summary Get a batch of groups by IDs
+     * @param {GetGroupsDto} getGroupsDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getGroupsDto: GetGroupsDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupDto>>;
+    /**
+     *
+     * @summary Get events of a group
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
+    /**
+     *
+     * @summary Get members of a group
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMembers(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
+    /**
+     *
+     * @summary Delete a group
+     * @param {string} groupId
+     * @param {string} xProximaNexusRequesterUserId Requester user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(groupId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Remove a member from a group
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     *
+     * @summary Search groups
+     * @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<GroupDto>>;
+    /**
+     *
+     * @summary Update a group
+     * @param {string} groupId
+     * @param {UpdateGroupDto} updateGroupDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(groupId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+}
+/**
+ * GroupApi - object-oriented interface
+ */
+export declare class GroupApi extends BaseAPI implements GroupApiInterface {
+    /**
+     *
+     * @summary Add a member to a group
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntityConnectionDto, any, {}>>;
+    /**
+     *
+     * @summary Create a group
+     * @param {CreateGroupDto} createGroupDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+    /**
+     *
+     * @summary Get a group by ID
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(groupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupDto, any, {}>>;
+    /**
+     *
+     * @summary Get a batch of groups by IDs
+     * @param {GetGroupsDto} getGroupsDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getGroupsDto: GetGroupsDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupDto[], any, {}>>;
+    /**
+     *
+     * @summary Get events of a group
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents(groupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventEntityConnectionDto[], any, {}>>;
+    /**
+     *
+     * @summary Get members of a group
+     * @param {string} groupId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getMembers(groupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserEntityConnectionDto[], any, {}>>;
+    /**
+     *
+     * @summary Delete a group
+     * @param {string} groupId
+     * @param {string} xProximaNexusRequesterUserId Requester user ID
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(groupId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary Remove a member from a group
+     * @param {string} groupId
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+    /**
+     *
+     * @summary Search groups
+     * @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<GroupDto[], any, {}>>;
+    /**
+     *
+     * @summary Update a group
+     * @param {string} groupId
+     * @param {UpdateGroupDto} updateGroupDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(groupId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+}