@proxima-nexus/sdk-typescript 2.1.1 → 2.3.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -0
- package/dist/api/event-api.d.ts +20 -10
- package/dist/api/event-api.js +25 -11
- package/dist/api/event-series-api.d.ts +273 -0
- package/dist/api/event-series-api.js +431 -0
- package/dist/api/group-api.d.ts +30 -10
- package/dist/api/group-api.js +42 -14
- package/dist/api/user-api.d.ts +30 -10
- package/dist/api/user-api.js +42 -14
- package/dist/enhanced/enhanced-event-api.d.ts +4 -3
- package/dist/enhanced/enhanced-event-api.js +9 -6
- package/dist/enhanced/enhanced-event-series-api.d.ts +11 -0
- package/dist/enhanced/enhanced-event-series-api.js +25 -0
- package/dist/enhanced/enhanced-group-api.d.ts +1 -1
- package/dist/enhanced/enhanced-group-api.js +5 -5
- package/dist/enhanced/enhanced-user-api.d.ts +1 -1
- package/dist/enhanced/enhanced-user-api.js +5 -5
- package/dist/enhanced/index.d.ts +3 -0
- package/dist/enhanced/index.js +6 -1
- package/dist/index.d.ts +4 -2
- package/dist/index.js +5 -1
- package/dist/models/create-event-series-dto.d.ts +75 -0
- package/dist/models/create-event-series-dto.js +22 -0
- package/dist/models/event-dto.d.ts +4 -0
- package/dist/models/event-series-dto.d.ts +87 -0
- package/dist/models/event-series-dto.js +21 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/update-event-dto.d.ts +4 -4
- package/dist/models/update-event-series-dto.d.ts +47 -0
- package/dist/models/update-event-series-dto.js +22 -0
- package/dist/models/update-group-dto.d.ts +1 -1
- package/dist/models/update-user-dto.d.ts +1 -1
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,31 @@ All notable changes to the Proxima Nexus TypeScript SDK are documented in this f
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
|
6
6
|
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
7
7
|
|
|
8
|
+
## [2.3.0] - 2026-03-02
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Time range filters (`from`, `to`) to event, user, group, and series APIs so you can easily query only ongoing or upcoming events.
|
|
13
|
+
- Enhanced client helpers for events now support passing `from`/`to` and include a new `searchByDateRange` method for date-only queries.
|
|
14
|
+
- Enhanced user and group helpers for `getEvents` now accept optional `from`/`to` parameters for consistent time-bounded queries across the SDK.
|
|
15
|
+
|
|
16
|
+
### Changed
|
|
17
|
+
|
|
18
|
+
- Default behavior for series instance listing now returns only ongoing and upcoming events (instead of all past and future instances), matching typical calendar UX expectations.
|
|
19
|
+
|
|
20
|
+
## [2.2.0] - 2026-03-02
|
|
21
|
+
|
|
22
|
+
### Added
|
|
23
|
+
|
|
24
|
+
- Support for **event series** (recurring events) via a new `EventSeriesApi` on `ProximaNexusClient` and `EnhancedEventSeriesApi` on `EnhancedProximaNexusClient`.
|
|
25
|
+
- New DTOs for event series: `CreateEventSeriesDto`, `EventSeriesDto`, and `UpdateEventSeriesDto`, plus a `seriesId` field on `EventDto` to link event instances back to their series.
|
|
26
|
+
- Enhanced client helpers to create, update, delete, and list instances in a series (`createSeries`, `getSeries`, `updateSeries`, `deleteSeries`, `getInstances`).
|
|
27
|
+
|
|
28
|
+
### Changed
|
|
29
|
+
|
|
30
|
+
- Relaxed `UpdateEventDto`, `UpdateGroupDto`, and `UpdateUserDto` so that most fields are optional, making partial updates easier and better aligned with the underlying API.
|
|
31
|
+
- 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.
|
|
32
|
+
|
|
8
33
|
## [2.1.1] - 2026-02-04
|
|
9
34
|
|
|
10
35
|
### Changed
|
package/dist/api/event-api.d.ts
CHANGED
|
@@ -103,14 +103,16 @@ export declare const EventApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
103
103
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
104
104
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
105
105
|
* @param {number} [limit] Limit results (1-1000)
|
|
106
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
107
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
106
108
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for events. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
107
109
|
* @param {*} [options] Override http request option.
|
|
108
110
|
* @throws {RequiredError}
|
|
109
111
|
*/
|
|
110
|
-
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>;
|
|
112
|
+
search: (displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, from?: string, to?: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
111
113
|
/**
|
|
112
114
|
*
|
|
113
|
-
* @summary Update an event
|
|
115
|
+
* @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.
|
|
114
116
|
* @param {string} eventId
|
|
115
117
|
* @param {string} xProximaNexusRequesterUserId ID of the user updating the event
|
|
116
118
|
* @param {UpdateEventDto} updateEventDto
|
|
@@ -203,14 +205,16 @@ export declare const EventApiFp: (configuration?: Configuration) => {
|
|
|
203
205
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
204
206
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
205
207
|
* @param {number} [limit] Limit results (1-1000)
|
|
208
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
209
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
206
210
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for events. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
207
211
|
* @param {*} [options] Override http request option.
|
|
208
212
|
* @throws {RequiredError}
|
|
209
213
|
*/
|
|
210
|
-
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>>>;
|
|
214
|
+
search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, from?: string, to?: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventDto>>>;
|
|
211
215
|
/**
|
|
212
216
|
*
|
|
213
|
-
* @summary Update an event
|
|
217
|
+
* @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.
|
|
214
218
|
* @param {string} eventId
|
|
215
219
|
* @param {string} xProximaNexusRequesterUserId ID of the user updating the event
|
|
216
220
|
* @param {UpdateEventDto} updateEventDto
|
|
@@ -303,14 +307,16 @@ export declare const EventApiFactory: (configuration?: Configuration, basePath?:
|
|
|
303
307
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
304
308
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
305
309
|
* @param {number} [limit] Limit results (1-1000)
|
|
310
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
311
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
306
312
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for events. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
307
313
|
* @param {*} [options] Override http request option.
|
|
308
314
|
* @throws {RequiredError}
|
|
309
315
|
*/
|
|
310
|
-
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>>;
|
|
316
|
+
search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, from?: string, to?: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
|
|
311
317
|
/**
|
|
312
318
|
*
|
|
313
|
-
* @summary Update an event
|
|
319
|
+
* @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.
|
|
314
320
|
* @param {string} eventId
|
|
315
321
|
* @param {string} xProximaNexusRequesterUserId ID of the user updating the event
|
|
316
322
|
* @param {UpdateEventDto} updateEventDto
|
|
@@ -403,14 +409,16 @@ export interface EventApiInterface {
|
|
|
403
409
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
404
410
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
405
411
|
* @param {number} [limit] Limit results (1-1000)
|
|
412
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
413
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
406
414
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for events. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
407
415
|
* @param {*} [options] Override http request option.
|
|
408
416
|
* @throws {RequiredError}
|
|
409
417
|
*/
|
|
410
|
-
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>>;
|
|
418
|
+
search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, from?: string, to?: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
|
|
411
419
|
/**
|
|
412
420
|
*
|
|
413
|
-
* @summary Update an event
|
|
421
|
+
* @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.
|
|
414
422
|
* @param {string} eventId
|
|
415
423
|
* @param {string} xProximaNexusRequesterUserId ID of the user updating the event
|
|
416
424
|
* @param {UpdateEventDto} updateEventDto
|
|
@@ -503,14 +511,16 @@ export declare class EventApi extends BaseAPI implements EventApiInterface {
|
|
|
503
511
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
504
512
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
505
513
|
* @param {number} [limit] Limit results (1-1000)
|
|
514
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
515
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
506
516
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for events. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
507
517
|
* @param {*} [options] Override http request option.
|
|
508
518
|
* @throws {RequiredError}
|
|
509
519
|
*/
|
|
510
|
-
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, {}>>;
|
|
520
|
+
search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, from?: string, to?: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDto[], any, {}>>;
|
|
511
521
|
/**
|
|
512
522
|
*
|
|
513
|
-
* @summary Update an event
|
|
523
|
+
* @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.
|
|
514
524
|
* @param {string} eventId
|
|
515
525
|
* @param {string} xProximaNexusRequesterUserId ID of the user updating the event
|
|
516
526
|
* @param {UpdateEventDto} updateEventDto
|
package/dist/api/event-api.js
CHANGED
|
@@ -322,11 +322,13 @@ const EventApiAxiosParamCreator = function (configuration) {
|
|
|
322
322
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
323
323
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
324
324
|
* @param {number} [limit] Limit results (1-1000)
|
|
325
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
326
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
325
327
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for events. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
326
328
|
* @param {*} [options] Override http request option.
|
|
327
329
|
* @throws {RequiredError}
|
|
328
330
|
*/
|
|
329
|
-
search: async (displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, xProximaNexusRequesterUserId, options = {}) => {
|
|
331
|
+
search: async (displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, from, to, xProximaNexusRequesterUserId, options = {}) => {
|
|
330
332
|
const localVarPath = `/event`;
|
|
331
333
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
332
334
|
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
@@ -366,6 +368,12 @@ const EventApiAxiosParamCreator = function (configuration) {
|
|
|
366
368
|
if (limit !== undefined) {
|
|
367
369
|
localVarQueryParameter['limit'] = limit;
|
|
368
370
|
}
|
|
371
|
+
if (from !== undefined) {
|
|
372
|
+
localVarQueryParameter['from'] = from;
|
|
373
|
+
}
|
|
374
|
+
if (to !== undefined) {
|
|
375
|
+
localVarQueryParameter['to'] = to;
|
|
376
|
+
}
|
|
369
377
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
370
378
|
if (xProximaNexusRequesterUserId != null) {
|
|
371
379
|
localVarHeaderParameter['X-Proxima-Nexus-Requester-User-Id'] = String(xProximaNexusRequesterUserId);
|
|
@@ -380,7 +388,7 @@ const EventApiAxiosParamCreator = function (configuration) {
|
|
|
380
388
|
},
|
|
381
389
|
/**
|
|
382
390
|
*
|
|
383
|
-
* @summary Update an event
|
|
391
|
+
* @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.
|
|
384
392
|
* @param {string} eventId
|
|
385
393
|
* @param {string} xProximaNexusRequesterUserId ID of the user updating the event
|
|
386
394
|
* @param {UpdateEventDto} updateEventDto
|
|
@@ -545,19 +553,21 @@ const EventApiFp = function (configuration) {
|
|
|
545
553
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
546
554
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
547
555
|
* @param {number} [limit] Limit results (1-1000)
|
|
556
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
557
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
548
558
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for events. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
549
559
|
* @param {*} [options] Override http request option.
|
|
550
560
|
* @throws {RequiredError}
|
|
551
561
|
*/
|
|
552
|
-
async search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, xProximaNexusRequesterUserId, options) {
|
|
553
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, xProximaNexusRequesterUserId, options);
|
|
562
|
+
async search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, from, to, xProximaNexusRequesterUserId, options) {
|
|
563
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, from, to, xProximaNexusRequesterUserId, options);
|
|
554
564
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
555
565
|
const localVarOperationServerBasePath = base_1.operationServerMap['EventApi.search']?.[localVarOperationServerIndex]?.url;
|
|
556
566
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
557
567
|
},
|
|
558
568
|
/**
|
|
559
569
|
*
|
|
560
|
-
* @summary Update an event
|
|
570
|
+
* @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.
|
|
561
571
|
* @param {string} eventId
|
|
562
572
|
* @param {string} xProximaNexusRequesterUserId ID of the user updating the event
|
|
563
573
|
* @param {UpdateEventDto} updateEventDto
|
|
@@ -673,16 +683,18 @@ const EventApiFactory = function (configuration, basePath, axios) {
|
|
|
673
683
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
674
684
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
675
685
|
* @param {number} [limit] Limit results (1-1000)
|
|
686
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
687
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
676
688
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for events. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
677
689
|
* @param {*} [options] Override http request option.
|
|
678
690
|
* @throws {RequiredError}
|
|
679
691
|
*/
|
|
680
|
-
search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, xProximaNexusRequesterUserId, options) {
|
|
681
|
-
return localVarFp.search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, xProximaNexusRequesterUserId, options).then((request) => request(axios, basePath));
|
|
692
|
+
search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, from, to, xProximaNexusRequesterUserId, options) {
|
|
693
|
+
return localVarFp.search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, from, to, xProximaNexusRequesterUserId, options).then((request) => request(axios, basePath));
|
|
682
694
|
},
|
|
683
695
|
/**
|
|
684
696
|
*
|
|
685
|
-
* @summary Update an event
|
|
697
|
+
* @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.
|
|
686
698
|
* @param {string} eventId
|
|
687
699
|
* @param {string} xProximaNexusRequesterUserId ID of the user updating the event
|
|
688
700
|
* @param {UpdateEventDto} updateEventDto
|
|
@@ -793,16 +805,18 @@ class EventApi extends base_1.BaseAPI {
|
|
|
793
805
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
794
806
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
795
807
|
* @param {number} [limit] Limit results (1-1000)
|
|
808
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
809
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
796
810
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for events. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
797
811
|
* @param {*} [options] Override http request option.
|
|
798
812
|
* @throws {RequiredError}
|
|
799
813
|
*/
|
|
800
|
-
search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, xProximaNexusRequesterUserId, options) {
|
|
801
|
-
return (0, exports.EventApiFp)(this.configuration).search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, xProximaNexusRequesterUserId, options).then((request) => request(this.axios, this.basePath));
|
|
814
|
+
search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, from, to, xProximaNexusRequesterUserId, options) {
|
|
815
|
+
return (0, exports.EventApiFp)(this.configuration).search(displayName, latitude, longitude, radius, minLatitude, maxLatitude, minLongitude, maxLongitude, limit, from, to, xProximaNexusRequesterUserId, options).then((request) => request(this.axios, this.basePath));
|
|
802
816
|
}
|
|
803
817
|
/**
|
|
804
818
|
*
|
|
805
|
-
* @summary Update an event
|
|
819
|
+
* @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.
|
|
806
820
|
* @param {string} eventId
|
|
807
821
|
* @param {string} xProximaNexusRequesterUserId ID of the user updating the event
|
|
808
822
|
* @param {UpdateEventDto} updateEventDto
|
|
@@ -0,0 +1,273 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* proxima-nexus-data-plane-api
|
|
3
|
+
* Proxima Nexus Data Plane API
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { CreateEventSeriesDto } from '../models';
|
|
16
|
+
import type { EventDto } from '../models';
|
|
17
|
+
import type { EventSeriesDto } from '../models';
|
|
18
|
+
import type { UpdateEventSeriesDto } from '../models';
|
|
19
|
+
/**
|
|
20
|
+
* EventSeriesApi - axios parameter creator
|
|
21
|
+
*/
|
|
22
|
+
export declare const EventSeriesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
23
|
+
/**
|
|
24
|
+
* Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
|
|
25
|
+
* @summary Create an event series
|
|
26
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating the series
|
|
27
|
+
* @param {CreateEventSeriesDto} createEventSeriesDto
|
|
28
|
+
* @param {*} [options] Override http request option.
|
|
29
|
+
* @throws {RequiredError}
|
|
30
|
+
*/
|
|
31
|
+
create: (xProximaNexusRequesterUserId: string, createEventSeriesDto: CreateEventSeriesDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
32
|
+
/**
|
|
33
|
+
*
|
|
34
|
+
* @summary Get an event series by ID
|
|
35
|
+
* @param {string} seriesId
|
|
36
|
+
* @param {*} [options] Override http request option.
|
|
37
|
+
* @throws {RequiredError}
|
|
38
|
+
*/
|
|
39
|
+
get: (seriesId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
|
+
/**
|
|
41
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
42
|
+
* @summary List event instances in a series
|
|
43
|
+
* @param {string} seriesId
|
|
44
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
45
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
46
|
+
* @param {*} [options] Override http request option.
|
|
47
|
+
* @throws {RequiredError}
|
|
48
|
+
*/
|
|
49
|
+
getInstances: (seriesId: string, from?: string, to?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50
|
+
/**
|
|
51
|
+
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
52
|
+
* @summary Delete an event series
|
|
53
|
+
* @param {string} seriesId
|
|
54
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
|
|
55
|
+
* @param {*} [options] Override http request option.
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
remove: (seriesId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
59
|
+
/**
|
|
60
|
+
* 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.
|
|
61
|
+
* @summary Update an event series
|
|
62
|
+
* @param {string} seriesId
|
|
63
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the series
|
|
64
|
+
* @param {UpdateEventSeriesDto} updateEventSeriesDto
|
|
65
|
+
* @param {*} [options] Override http request option.
|
|
66
|
+
* @throws {RequiredError}
|
|
67
|
+
*/
|
|
68
|
+
update: (seriesId: string, xProximaNexusRequesterUserId: string, updateEventSeriesDto: UpdateEventSeriesDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
|
+
};
|
|
70
|
+
/**
|
|
71
|
+
* EventSeriesApi - functional programming interface
|
|
72
|
+
*/
|
|
73
|
+
export declare const EventSeriesApiFp: (configuration?: Configuration) => {
|
|
74
|
+
/**
|
|
75
|
+
* Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
|
|
76
|
+
* @summary Create an event series
|
|
77
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating the series
|
|
78
|
+
* @param {CreateEventSeriesDto} createEventSeriesDto
|
|
79
|
+
* @param {*} [options] Override http request option.
|
|
80
|
+
* @throws {RequiredError}
|
|
81
|
+
*/
|
|
82
|
+
create(xProximaNexusRequesterUserId: string, createEventSeriesDto: CreateEventSeriesDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
83
|
+
/**
|
|
84
|
+
*
|
|
85
|
+
* @summary Get an event series by ID
|
|
86
|
+
* @param {string} seriesId
|
|
87
|
+
* @param {*} [options] Override http request option.
|
|
88
|
+
* @throws {RequiredError}
|
|
89
|
+
*/
|
|
90
|
+
get(seriesId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventSeriesDto>>;
|
|
91
|
+
/**
|
|
92
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
93
|
+
* @summary List event instances in a series
|
|
94
|
+
* @param {string} seriesId
|
|
95
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
96
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
97
|
+
* @param {*} [options] Override http request option.
|
|
98
|
+
* @throws {RequiredError}
|
|
99
|
+
*/
|
|
100
|
+
getInstances(seriesId: string, from?: string, to?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventDto>>>;
|
|
101
|
+
/**
|
|
102
|
+
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
103
|
+
* @summary Delete an event series
|
|
104
|
+
* @param {string} seriesId
|
|
105
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
|
|
106
|
+
* @param {*} [options] Override http request option.
|
|
107
|
+
* @throws {RequiredError}
|
|
108
|
+
*/
|
|
109
|
+
remove(seriesId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
110
|
+
/**
|
|
111
|
+
* 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.
|
|
112
|
+
* @summary Update an event series
|
|
113
|
+
* @param {string} seriesId
|
|
114
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the series
|
|
115
|
+
* @param {UpdateEventSeriesDto} updateEventSeriesDto
|
|
116
|
+
* @param {*} [options] Override http request option.
|
|
117
|
+
* @throws {RequiredError}
|
|
118
|
+
*/
|
|
119
|
+
update(seriesId: string, xProximaNexusRequesterUserId: string, updateEventSeriesDto: UpdateEventSeriesDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
|
|
120
|
+
};
|
|
121
|
+
/**
|
|
122
|
+
* EventSeriesApi - factory interface
|
|
123
|
+
*/
|
|
124
|
+
export declare const EventSeriesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
125
|
+
/**
|
|
126
|
+
* Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
|
|
127
|
+
* @summary Create an event series
|
|
128
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating the series
|
|
129
|
+
* @param {CreateEventSeriesDto} createEventSeriesDto
|
|
130
|
+
* @param {*} [options] Override http request option.
|
|
131
|
+
* @throws {RequiredError}
|
|
132
|
+
*/
|
|
133
|
+
create(xProximaNexusRequesterUserId: string, createEventSeriesDto: CreateEventSeriesDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
134
|
+
/**
|
|
135
|
+
*
|
|
136
|
+
* @summary Get an event series by ID
|
|
137
|
+
* @param {string} seriesId
|
|
138
|
+
* @param {*} [options] Override http request option.
|
|
139
|
+
* @throws {RequiredError}
|
|
140
|
+
*/
|
|
141
|
+
get(seriesId: string, options?: RawAxiosRequestConfig): AxiosPromise<EventSeriesDto>;
|
|
142
|
+
/**
|
|
143
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
144
|
+
* @summary List event instances in a series
|
|
145
|
+
* @param {string} seriesId
|
|
146
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
147
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
getInstances(seriesId: string, from?: string, to?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
|
|
152
|
+
/**
|
|
153
|
+
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
154
|
+
* @summary Delete an event series
|
|
155
|
+
* @param {string} seriesId
|
|
156
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
|
|
157
|
+
* @param {*} [options] Override http request option.
|
|
158
|
+
* @throws {RequiredError}
|
|
159
|
+
*/
|
|
160
|
+
remove(seriesId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
161
|
+
/**
|
|
162
|
+
* 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.
|
|
163
|
+
* @summary Update an event series
|
|
164
|
+
* @param {string} seriesId
|
|
165
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the series
|
|
166
|
+
* @param {UpdateEventSeriesDto} updateEventSeriesDto
|
|
167
|
+
* @param {*} [options] Override http request option.
|
|
168
|
+
* @throws {RequiredError}
|
|
169
|
+
*/
|
|
170
|
+
update(seriesId: string, xProximaNexusRequesterUserId: string, updateEventSeriesDto: UpdateEventSeriesDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
171
|
+
};
|
|
172
|
+
/**
|
|
173
|
+
* EventSeriesApi - interface
|
|
174
|
+
*/
|
|
175
|
+
export interface EventSeriesApiInterface {
|
|
176
|
+
/**
|
|
177
|
+
* Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
|
|
178
|
+
* @summary Create an event series
|
|
179
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating the series
|
|
180
|
+
* @param {CreateEventSeriesDto} createEventSeriesDto
|
|
181
|
+
* @param {*} [options] Override http request option.
|
|
182
|
+
* @throws {RequiredError}
|
|
183
|
+
*/
|
|
184
|
+
create(xProximaNexusRequesterUserId: string, createEventSeriesDto: CreateEventSeriesDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
185
|
+
/**
|
|
186
|
+
*
|
|
187
|
+
* @summary Get an event series by ID
|
|
188
|
+
* @param {string} seriesId
|
|
189
|
+
* @param {*} [options] Override http request option.
|
|
190
|
+
* @throws {RequiredError}
|
|
191
|
+
*/
|
|
192
|
+
get(seriesId: string, options?: RawAxiosRequestConfig): AxiosPromise<EventSeriesDto>;
|
|
193
|
+
/**
|
|
194
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
195
|
+
* @summary List event instances in a series
|
|
196
|
+
* @param {string} seriesId
|
|
197
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
198
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
199
|
+
* @param {*} [options] Override http request option.
|
|
200
|
+
* @throws {RequiredError}
|
|
201
|
+
*/
|
|
202
|
+
getInstances(seriesId: string, from?: string, to?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
|
|
203
|
+
/**
|
|
204
|
+
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
205
|
+
* @summary Delete an event series
|
|
206
|
+
* @param {string} seriesId
|
|
207
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
|
|
208
|
+
* @param {*} [options] Override http request option.
|
|
209
|
+
* @throws {RequiredError}
|
|
210
|
+
*/
|
|
211
|
+
remove(seriesId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
212
|
+
/**
|
|
213
|
+
* 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.
|
|
214
|
+
* @summary Update an event series
|
|
215
|
+
* @param {string} seriesId
|
|
216
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the series
|
|
217
|
+
* @param {UpdateEventSeriesDto} updateEventSeriesDto
|
|
218
|
+
* @param {*} [options] Override http request option.
|
|
219
|
+
* @throws {RequiredError}
|
|
220
|
+
*/
|
|
221
|
+
update(seriesId: string, xProximaNexusRequesterUserId: string, updateEventSeriesDto: UpdateEventSeriesDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
|
|
222
|
+
}
|
|
223
|
+
/**
|
|
224
|
+
* EventSeriesApi - object-oriented interface
|
|
225
|
+
*/
|
|
226
|
+
export declare class EventSeriesApi extends BaseAPI implements EventSeriesApiInterface {
|
|
227
|
+
/**
|
|
228
|
+
* Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
|
|
229
|
+
* @summary Create an event series
|
|
230
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating the series
|
|
231
|
+
* @param {CreateEventSeriesDto} createEventSeriesDto
|
|
232
|
+
* @param {*} [options] Override http request option.
|
|
233
|
+
* @throws {RequiredError}
|
|
234
|
+
*/
|
|
235
|
+
create(xProximaNexusRequesterUserId: string, createEventSeriesDto: CreateEventSeriesDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
236
|
+
/**
|
|
237
|
+
*
|
|
238
|
+
* @summary Get an event series by ID
|
|
239
|
+
* @param {string} seriesId
|
|
240
|
+
* @param {*} [options] Override http request option.
|
|
241
|
+
* @throws {RequiredError}
|
|
242
|
+
*/
|
|
243
|
+
get(seriesId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventSeriesDto, any, {}>>;
|
|
244
|
+
/**
|
|
245
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
246
|
+
* @summary List event instances in a series
|
|
247
|
+
* @param {string} seriesId
|
|
248
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
249
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
250
|
+
* @param {*} [options] Override http request option.
|
|
251
|
+
* @throws {RequiredError}
|
|
252
|
+
*/
|
|
253
|
+
getInstances(seriesId: string, from?: string, to?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDto[], any, {}>>;
|
|
254
|
+
/**
|
|
255
|
+
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
256
|
+
* @summary Delete an event series
|
|
257
|
+
* @param {string} seriesId
|
|
258
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
|
|
259
|
+
* @param {*} [options] Override http request option.
|
|
260
|
+
* @throws {RequiredError}
|
|
261
|
+
*/
|
|
262
|
+
remove(seriesId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
263
|
+
/**
|
|
264
|
+
* 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.
|
|
265
|
+
* @summary Update an event series
|
|
266
|
+
* @param {string} seriesId
|
|
267
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the series
|
|
268
|
+
* @param {UpdateEventSeriesDto} updateEventSeriesDto
|
|
269
|
+
* @param {*} [options] Override http request option.
|
|
270
|
+
* @throws {RequiredError}
|
|
271
|
+
*/
|
|
272
|
+
update(seriesId: string, xProximaNexusRequesterUserId: string, updateEventSeriesDto: UpdateEventSeriesDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
|
|
273
|
+
}
|