@proxima-nexus/sdk-typescript 1.0.0

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

@@ -0,0 +1,543 @@
+/**
+ * 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 { CreateUserDto } from '../models';
+import type { EntityConnectionDto } from '../models';
+import type { EventEntityConnectionDto } from '../models';
+import type { GetUsersDto } from '../models';
+import type { GroupEntityConnectionDto } from '../models';
+import type { MutateUserResponseDto } from '../models';
+import type { UpdateUserDto } from '../models';
+import type { UserDto } from '../models';
+import type { UserEntityConnectionDto } from '../models';
+/**
+ * UserApi - axios parameter creator
+ */
+export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Add a friend to a user
+     * @param {string} userId
+     * @param {string} friendUserId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addFriend: (userId: string, friendUserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Create a user
+     * @param {CreateUserDto} createUserDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create: (createUserDto: CreateUserDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get a user by ID
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get a batch of users by IDs
+     * @param {GetUsersDto} getUsersDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch: (getUsersDto: GetUsersDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get events of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get friends of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFriends: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get groups of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGroups: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Delete a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Remove a friend from a user
+     * @param {string} userId
+     * @param {string} friendUserId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeFriend: (userId: string, friendUserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Search users
+     * @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 user
+     * @param {string} userId
+     * @param {UpdateUserDto} updateUserDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update: (userId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * UserApi - functional programming interface
+ */
+export declare const UserApiFp: (configuration?: Configuration) => {
+    /**
+     *
+     * @summary Add a friend to a user
+     * @param {string} userId
+     * @param {string} friendUserId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addFriend(userId: string, friendUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntityConnectionDto>>;
+    /**
+     *
+     * @summary Create a user
+     * @param {CreateUserDto} createUserDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createUserDto: CreateUserDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MutateUserResponseDto>>;
+    /**
+     *
+     * @summary Get a user by ID
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>;
+    /**
+     *
+     * @summary Get a batch of users by IDs
+     * @param {GetUsersDto} getUsersDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getUsersDto: GetUsersDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserDto>>>;
+    /**
+     *
+     * @summary Get events of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventEntityConnectionDto>>>;
+    /**
+     *
+     * @summary Get friends of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFriends(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserEntityConnectionDto>>>;
+    /**
+     *
+     * @summary Get groups of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGroups(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupEntityConnectionDto>>>;
+    /**
+     *
+     * @summary Delete a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Remove a friend from a user
+     * @param {string} userId
+     * @param {string} friendUserId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeFriend(userId: string, friendUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     *
+     * @summary Search users
+     * @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<UserDto>>>;
+    /**
+     *
+     * @summary Update a user
+     * @param {string} userId
+     * @param {UpdateUserDto} updateUserDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(userId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MutateUserResponseDto>>;
+};
+/**
+ * UserApi - factory interface
+ */
+export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     *
+     * @summary Add a friend to a user
+     * @param {string} userId
+     * @param {string} friendUserId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addFriend(userId: string, friendUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
+    /**
+     *
+     * @summary Create a user
+     * @param {CreateUserDto} createUserDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createUserDto: CreateUserDto, options?: RawAxiosRequestConfig): AxiosPromise<MutateUserResponseDto>;
+    /**
+     *
+     * @summary Get a user by ID
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<UserDto>;
+    /**
+     *
+     * @summary Get a batch of users by IDs
+     * @param {GetUsersDto} getUsersDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getUsersDto: GetUsersDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserDto>>;
+    /**
+     *
+     * @summary Get events of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
+    /**
+     *
+     * @summary Get friends of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFriends(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
+    /**
+     *
+     * @summary Get groups of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGroups(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupEntityConnectionDto>>;
+    /**
+     *
+     * @summary Delete a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Remove a friend from a user
+     * @param {string} userId
+     * @param {string} friendUserId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeFriend(userId: string, friendUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Search users
+     * @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<UserDto>>;
+    /**
+     *
+     * @summary Update a user
+     * @param {string} userId
+     * @param {UpdateUserDto} updateUserDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(userId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): AxiosPromise<MutateUserResponseDto>;
+};
+/**
+ * UserApi - interface
+ */
+export interface UserApiInterface {
+    /**
+     *
+     * @summary Add a friend to a user
+     * @param {string} userId
+     * @param {string} friendUserId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addFriend(userId: string, friendUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
+    /**
+     *
+     * @summary Create a user
+     * @param {CreateUserDto} createUserDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createUserDto: CreateUserDto, options?: RawAxiosRequestConfig): AxiosPromise<MutateUserResponseDto>;
+    /**
+     *
+     * @summary Get a user by ID
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<UserDto>;
+    /**
+     *
+     * @summary Get a batch of users by IDs
+     * @param {GetUsersDto} getUsersDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getUsersDto: GetUsersDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserDto>>;
+    /**
+     *
+     * @summary Get events of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
+    /**
+     *
+     * @summary Get friends of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFriends(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
+    /**
+     *
+     * @summary Get groups of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGroups(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupEntityConnectionDto>>;
+    /**
+     *
+     * @summary Delete a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Remove a friend from a user
+     * @param {string} userId
+     * @param {string} friendUserId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeFriend(userId: string, friendUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     *
+     * @summary Search users
+     * @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<UserDto>>;
+    /**
+     *
+     * @summary Update a user
+     * @param {string} userId
+     * @param {UpdateUserDto} updateUserDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(userId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): AxiosPromise<MutateUserResponseDto>;
+}
+/**
+ * UserApi - object-oriented interface
+ */
+export declare class UserApi extends BaseAPI implements UserApiInterface {
+    /**
+     *
+     * @summary Add a friend to a user
+     * @param {string} userId
+     * @param {string} friendUserId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    addFriend(userId: string, friendUserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntityConnectionDto, any, {}>>;
+    /**
+     *
+     * @summary Create a user
+     * @param {CreateUserDto} createUserDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(createUserDto: CreateUserDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MutateUserResponseDto, any, {}>>;
+    /**
+     *
+     * @summary Get a user by ID
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    findOne(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDto, any, {}>>;
+    /**
+     *
+     * @summary Get a batch of users by IDs
+     * @param {GetUsersDto} getUsersDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getBatch(getUsersDto: GetUsersDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDto[], any, {}>>;
+    /**
+     *
+     * @summary Get events of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getEvents(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventEntityConnectionDto[], any, {}>>;
+    /**
+     *
+     * @summary Get friends of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getFriends(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserEntityConnectionDto[], any, {}>>;
+    /**
+     *
+     * @summary Get groups of a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getGroups(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupEntityConnectionDto[], any, {}>>;
+    /**
+     *
+     * @summary Delete a user
+     * @param {string} userId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary Remove a friend from a user
+     * @param {string} userId
+     * @param {string} friendUserId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    removeFriend(userId: string, friendUserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     *
+     * @summary Search users
+     * @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<UserDto[], any, {}>>;
+    /**
+     *
+     * @summary Update a user
+     * @param {string} userId
+     * @param {UpdateUserDto} updateUserDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(userId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MutateUserResponseDto, any, {}>>;
+}