@proxima-nexus/sdk-typescript 2.1.1 → 2.2.0

package/CHANGELOG.md

@@ -5,6 +5,19 @@ All notable changes to the Proxima Nexus TypeScript SDK are documented in this f
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [2.2.0] - 2026-03-02
+
+### Added
+
+- Support for **event series** (recurring events) via a new `EventSeriesApi` on `ProximaNexusClient` and `EnhancedEventSeriesApi` on `EnhancedProximaNexusClient`.
+- New DTOs for event series: `CreateEventSeriesDto`, `EventSeriesDto`, and `UpdateEventSeriesDto`, plus a `seriesId` field on `EventDto` to link event instances back to their series.
+- Enhanced client helpers to create, update, delete, and list instances in a series (`createSeries`, `getSeries`, `updateSeries`, `deleteSeries`, `getInstances`).
+
+### Changed
+
+- Relaxed `UpdateEventDto`, `UpdateGroupDto`, and `UpdateUserDto` so that most fields are optional, making partial updates easier and better aligned with the underlying API.
+- Clarified `EventApi.update` behavior for series instances: only fields included in the request body are treated as overrides and will no longer be updated by series-level changes.
+
 ## [2.1.1] - 2026-02-04
 
 ### Changed

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

@@ -110,7 +110,7 @@ export declare const EventApiAxiosParamCreator: (configuration?: Configuration)
     search: (displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
     /**
      *
-     * @summary Update an event
+     * @summary Update an event. For series instances, only the fields provided in the request body will be marked as overridden and will no longer be propagated by series-level updates.
      * @param {string} eventId
      * @param {string} xProximaNexusRequesterUserId ID of the user updating the event
      * @param {UpdateEventDto} updateEventDto
@@ -210,7 +210,7 @@ export declare const EventApiFp: (configuration?: Configuration) => {
     search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventDto>>>;
     /**
      *
-     * @summary Update an event
+     * @summary Update an event. For series instances, only the fields provided in the request body will be marked as overridden and will no longer be propagated by series-level updates.
      * @param {string} eventId
      * @param {string} xProximaNexusRequesterUserId ID of the user updating the event
      * @param {UpdateEventDto} updateEventDto
@@ -310,7 +310,7 @@ export declare const EventApiFactory: (configuration?: Configuration, basePath?:
     search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
     /**
      *
-     * @summary Update an event
+     * @summary Update an event. For series instances, only the fields provided in the request body will be marked as overridden and will no longer be propagated by series-level updates.
      * @param {string} eventId
      * @param {string} xProximaNexusRequesterUserId ID of the user updating the event
      * @param {UpdateEventDto} updateEventDto
@@ -410,7 +410,7 @@ export interface EventApiInterface {
     search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
     /**
      *
-     * @summary Update an event
+     * @summary Update an event. For series instances, only the fields provided in the request body will be marked as overridden and will no longer be propagated by series-level updates.
      * @param {string} eventId
      * @param {string} xProximaNexusRequesterUserId ID of the user updating the event
      * @param {UpdateEventDto} updateEventDto
@@ -510,7 +510,7 @@ export declare class EventApi extends BaseAPI implements EventApiInterface {
     search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDto[], any, {}>>;
     /**
      *
-     * @summary Update an event
+     * @summary Update an event. For series instances, only the fields provided in the request body will be marked as overridden and will no longer be propagated by series-level updates.
      * @param {string} eventId
      * @param {string} xProximaNexusRequesterUserId ID of the user updating the event
      * @param {UpdateEventDto} updateEventDto

package/dist/api/event-api.js

@@ -380,7 +380,7 @@ const EventApiAxiosParamCreator = function (configuration) {
         },
         /**
          *
-         * @summary Update an event
+         * @summary Update an event. For series instances, only the fields provided in the request body will be marked as overridden and will no longer be propagated by series-level updates.
          * @param {string} eventId
          * @param {string} xProximaNexusRequesterUserId ID of the user updating the event
          * @param {UpdateEventDto} updateEventDto
@@ -557,7 +557,7 @@ const EventApiFp = function (configuration) {
         },
         /**
          *
-         * @summary Update an event
+         * @summary Update an event. For series instances, only the fields provided in the request body will be marked as overridden and will no longer be propagated by series-level updates.
          * @param {string} eventId
          * @param {string} xProximaNexusRequesterUserId ID of the user updating the event
          * @param {UpdateEventDto} updateEventDto
@@ -682,7 +682,7 @@ const EventApiFactory = function (configuration, basePath, axios) {
         },
         /**
          *
-         * @summary Update an event
+         * @summary Update an event. For series instances, only the fields provided in the request body will be marked as overridden and will no longer be propagated by series-level updates.
          * @param {string} eventId
          * @param {string} xProximaNexusRequesterUserId ID of the user updating the event
          * @param {UpdateEventDto} updateEventDto
@@ -802,7 +802,7 @@ class EventApi extends base_1.BaseAPI {
     }
     /**
      *
-     * @summary Update an event
+     * @summary Update an event. For series instances, only the fields provided in the request body will be marked as overridden and will no longer be propagated by series-level updates.
      * @param {string} eventId
      * @param {string} xProximaNexusRequesterUserId ID of the user updating the event
      * @param {UpdateEventDto} updateEventDto

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

@@ -0,0 +1,263 @@
+/**
+ * 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 { CreateEventSeriesDto } from '../models';
+import type { EventDto } from '../models';
+import type { EventSeriesDto } from '../models';
+import type { UpdateEventSeriesDto } from '../models';
+/**
+ * EventSeriesApi - axios parameter creator
+ */
+export declare const EventSeriesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
+     * @summary Create an event series
+     * @param {string} xProximaNexusRequesterUserId ID of the user creating the series
+     * @param {CreateEventSeriesDto} createEventSeriesDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create: (xProximaNexusRequesterUserId: string, createEventSeriesDto: CreateEventSeriesDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     *
+     * @summary Get an event series by ID
+     * @param {string} seriesId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get: (seriesId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Returns all event instances (past and upcoming) belonging to this series, ordered by start time.
+     * @summary List all event instances in a series
+     * @param {string} seriesId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstances: (seriesId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
+     * @summary Delete an event series
+     * @param {string} seriesId
+     * @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove: (seriesId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Updates the series definition and propagates metadata changes to all upcoming event instances. Fields that were individually overridden on a specific instance will not be overwritten.
+     * @summary Update an event series
+     * @param {string} seriesId
+     * @param {string} xProximaNexusRequesterUserId ID of the user updating the series
+     * @param {UpdateEventSeriesDto} updateEventSeriesDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update: (seriesId: string, xProximaNexusRequesterUserId: string, updateEventSeriesDto: UpdateEventSeriesDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * EventSeriesApi - functional programming interface
+ */
+export declare const EventSeriesApiFp: (configuration?: Configuration) => {
+    /**
+     * Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
+     * @summary Create an event series
+     * @param {string} xProximaNexusRequesterUserId ID of the user creating the series
+     * @param {CreateEventSeriesDto} createEventSeriesDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(xProximaNexusRequesterUserId: string, createEventSeriesDto: CreateEventSeriesDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+    /**
+     *
+     * @summary Get an event series by ID
+     * @param {string} seriesId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get(seriesId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventSeriesDto>>;
+    /**
+     * Returns all event instances (past and upcoming) belonging to this series, ordered by start time.
+     * @summary List all event instances in a series
+     * @param {string} seriesId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstances(seriesId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventDto>>>;
+    /**
+     * Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
+     * @summary Delete an event series
+     * @param {string} seriesId
+     * @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(seriesId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Updates the series definition and propagates metadata changes to all upcoming event instances. Fields that were individually overridden on a specific instance will not be overwritten.
+     * @summary Update an event series
+     * @param {string} seriesId
+     * @param {string} xProximaNexusRequesterUserId ID of the user updating the series
+     * @param {UpdateEventSeriesDto} updateEventSeriesDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(seriesId: string, xProximaNexusRequesterUserId: string, updateEventSeriesDto: UpdateEventSeriesDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
+};
+/**
+ * EventSeriesApi - factory interface
+ */
+export declare const EventSeriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
+     * @summary Create an event series
+     * @param {string} xProximaNexusRequesterUserId ID of the user creating the series
+     * @param {CreateEventSeriesDto} createEventSeriesDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(xProximaNexusRequesterUserId: string, createEventSeriesDto: CreateEventSeriesDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     *
+     * @summary Get an event series by ID
+     * @param {string} seriesId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get(seriesId: string, options?: RawAxiosRequestConfig): AxiosPromise<EventSeriesDto>;
+    /**
+     * Returns all event instances (past and upcoming) belonging to this series, ordered by start time.
+     * @summary List all event instances in a series
+     * @param {string} seriesId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstances(seriesId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
+    /**
+     * Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
+     * @summary Delete an event series
+     * @param {string} seriesId
+     * @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(seriesId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Updates the series definition and propagates metadata changes to all upcoming event instances. Fields that were individually overridden on a specific instance will not be overwritten.
+     * @summary Update an event series
+     * @param {string} seriesId
+     * @param {string} xProximaNexusRequesterUserId ID of the user updating the series
+     * @param {UpdateEventSeriesDto} updateEventSeriesDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(seriesId: string, xProximaNexusRequesterUserId: string, updateEventSeriesDto: UpdateEventSeriesDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+};
+/**
+ * EventSeriesApi - interface
+ */
+export interface EventSeriesApiInterface {
+    /**
+     * Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
+     * @summary Create an event series
+     * @param {string} xProximaNexusRequesterUserId ID of the user creating the series
+     * @param {CreateEventSeriesDto} createEventSeriesDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(xProximaNexusRequesterUserId: string, createEventSeriesDto: CreateEventSeriesDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+    /**
+     *
+     * @summary Get an event series by ID
+     * @param {string} seriesId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get(seriesId: string, options?: RawAxiosRequestConfig): AxiosPromise<EventSeriesDto>;
+    /**
+     * Returns all event instances (past and upcoming) belonging to this series, ordered by start time.
+     * @summary List all event instances in a series
+     * @param {string} seriesId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstances(seriesId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
+    /**
+     * Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
+     * @summary Delete an event series
+     * @param {string} seriesId
+     * @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(seriesId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Updates the series definition and propagates metadata changes to all upcoming event instances. Fields that were individually overridden on a specific instance will not be overwritten.
+     * @summary Update an event series
+     * @param {string} seriesId
+     * @param {string} xProximaNexusRequesterUserId ID of the user updating the series
+     * @param {UpdateEventSeriesDto} updateEventSeriesDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(seriesId: string, xProximaNexusRequesterUserId: string, updateEventSeriesDto: UpdateEventSeriesDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
+}
+/**
+ * EventSeriesApi - object-oriented interface
+ */
+export declare class EventSeriesApi extends BaseAPI implements EventSeriesApiInterface {
+    /**
+     * Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
+     * @summary Create an event series
+     * @param {string} xProximaNexusRequesterUserId ID of the user creating the series
+     * @param {CreateEventSeriesDto} createEventSeriesDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    create(xProximaNexusRequesterUserId: string, createEventSeriesDto: CreateEventSeriesDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+    /**
+     *
+     * @summary Get an event series by ID
+     * @param {string} seriesId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    get(seriesId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventSeriesDto, any, {}>>;
+    /**
+     * Returns all event instances (past and upcoming) belonging to this series, ordered by start time.
+     * @summary List all event instances in a series
+     * @param {string} seriesId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getInstances(seriesId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDto[], any, {}>>;
+    /**
+     * Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
+     * @summary Delete an event series
+     * @param {string} seriesId
+     * @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    remove(seriesId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
+    /**
+     * Updates the series definition and propagates metadata changes to all upcoming event instances. Fields that were individually overridden on a specific instance will not be overwritten.
+     * @summary Update an event series
+     * @param {string} seriesId
+     * @param {string} xProximaNexusRequesterUserId ID of the user updating the series
+     * @param {UpdateEventSeriesDto} updateEventSeriesDto
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    update(seriesId: string, xProximaNexusRequesterUserId: string, updateEventSeriesDto: UpdateEventSeriesDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
+}