@proxima-nexus/sdk-typescript 2.2.0 → 2.4.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 +20 -0
- package/dist/api/event-api.d.ts +15 -5
- package/dist/api/event-api.js +21 -7
- package/dist/api/event-series-api.d.ts +66 -15
- package/dist/api/event-series-api.js +95 -15
- package/dist/api/group-api.d.ts +71 -10
- package/dist/api/group-api.js +107 -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 +2 -1
- package/dist/enhanced/enhanced-event-series-api.js +5 -2
- package/dist/enhanced/enhanced-group-api.d.ts +3 -2
- package/dist/enhanced/enhanced-group-api.js +8 -5
- package/dist/enhanced/enhanced-user-api.d.ts +1 -1
- package/dist/enhanced/enhanced-user-api.js +5 -5
- package/dist/models/event-series-entity-connection-dto.d.ts +49 -0
- package/dist/models/event-series-entity-connection-dto.js +34 -0
- package/dist/models/get-event-series-dto.d.ts +17 -0
- package/dist/models/get-event-series-dto.js +15 -0
- package/dist/models/index.d.ts +2 -0
- package/dist/models/index.js +2 -0
- package/package.json +1 -1
package/CHANGELOG.md
CHANGED
|
@@ -5,6 +5,26 @@ 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.4.0] - 2026-03-04
|
|
9
|
+
|
|
10
|
+
### Added
|
|
11
|
+
|
|
12
|
+
- Batch lookup for **event series** via a new `getBatch` method on `EventSeriesApi` and a corresponding `getBatch(seriesIds: string[])` helper on `EnhancedEventSeriesApi`.
|
|
13
|
+
- Group-level event series listing through `GroupApi.getEventSeries` and the enhanced helper `getGroupEventSeries` on `EnhancedGroupApi`.
|
|
14
|
+
- New DTOs for series queries and connections: `GetEventSeriesDto` and `EventSeriesEntityConnectionDto` (both exported from the models index).
|
|
15
|
+
|
|
16
|
+
## [2.3.0] - 2026-03-02
|
|
17
|
+
|
|
18
|
+
### Added
|
|
19
|
+
|
|
20
|
+
- Time range filters (`from`, `to`) to event, user, group, and series APIs so you can easily query only ongoing or upcoming events.
|
|
21
|
+
- Enhanced client helpers for events now support passing `from`/`to` and include a new `searchByDateRange` method for date-only queries.
|
|
22
|
+
- Enhanced user and group helpers for `getEvents` now accept optional `from`/`to` parameters for consistent time-bounded queries across the SDK.
|
|
23
|
+
|
|
24
|
+
### Changed
|
|
25
|
+
|
|
26
|
+
- 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.
|
|
27
|
+
|
|
8
28
|
## [2.2.0] - 2026-03-02
|
|
9
29
|
|
|
10
30
|
### Added
|
package/dist/api/event-api.d.ts
CHANGED
|
@@ -103,11 +103,13 @@ 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
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.
|
|
@@ -203,11 +205,13 @@ 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
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.
|
|
@@ -303,11 +307,13 @@ 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
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.
|
|
@@ -403,11 +409,13 @@ 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
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.
|
|
@@ -503,11 +511,13 @@ 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
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.
|
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);
|
|
@@ -545,12 +553,14 @@ 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);
|
|
@@ -673,12 +683,14 @@ 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
|
*
|
|
@@ -793,12 +805,14 @@ 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
|
*
|
|
@@ -15,6 +15,7 @@ import { type RequestArgs, BaseAPI } from '../base';
|
|
|
15
15
|
import type { CreateEventSeriesDto } from '../models';
|
|
16
16
|
import type { EventDto } from '../models';
|
|
17
17
|
import type { EventSeriesDto } from '../models';
|
|
18
|
+
import type { GetEventSeriesDto } from '../models';
|
|
18
19
|
import type { UpdateEventSeriesDto } from '../models';
|
|
19
20
|
/**
|
|
20
21
|
* EventSeriesApi - axios parameter creator
|
|
@@ -38,13 +39,23 @@ export declare const EventSeriesApiAxiosParamCreator: (configuration?: Configura
|
|
|
38
39
|
*/
|
|
39
40
|
get: (seriesId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
40
41
|
/**
|
|
41
|
-
*
|
|
42
|
-
* @summary
|
|
42
|
+
*
|
|
43
|
+
* @summary Get a batch of event series by IDs
|
|
44
|
+
* @param {GetEventSeriesDto} getEventSeriesDto
|
|
45
|
+
* @param {*} [options] Override http request option.
|
|
46
|
+
* @throws {RequiredError}
|
|
47
|
+
*/
|
|
48
|
+
getBatch: (getEventSeriesDto: GetEventSeriesDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
49
|
+
/**
|
|
50
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
51
|
+
* @summary List event instances in a series
|
|
43
52
|
* @param {string} seriesId
|
|
53
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
54
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
44
55
|
* @param {*} [options] Override http request option.
|
|
45
56
|
* @throws {RequiredError}
|
|
46
57
|
*/
|
|
47
|
-
getInstances: (seriesId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
+
getInstances: (seriesId: string, from?: string, to?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
48
59
|
/**
|
|
49
60
|
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
50
61
|
* @summary Delete an event series
|
|
@@ -87,13 +98,23 @@ export declare const EventSeriesApiFp: (configuration?: Configuration) => {
|
|
|
87
98
|
*/
|
|
88
99
|
get(seriesId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EventSeriesDto>>;
|
|
89
100
|
/**
|
|
90
|
-
*
|
|
91
|
-
* @summary
|
|
101
|
+
*
|
|
102
|
+
* @summary Get a batch of event series by IDs
|
|
103
|
+
* @param {GetEventSeriesDto} getEventSeriesDto
|
|
104
|
+
* @param {*} [options] Override http request option.
|
|
105
|
+
* @throws {RequiredError}
|
|
106
|
+
*/
|
|
107
|
+
getBatch(getEventSeriesDto: GetEventSeriesDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventSeriesDto>>>;
|
|
108
|
+
/**
|
|
109
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
110
|
+
* @summary List event instances in a series
|
|
92
111
|
* @param {string} seriesId
|
|
112
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
113
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
93
114
|
* @param {*} [options] Override http request option.
|
|
94
115
|
* @throws {RequiredError}
|
|
95
116
|
*/
|
|
96
|
-
getInstances(seriesId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventDto>>>;
|
|
117
|
+
getInstances(seriesId: string, from?: string, to?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventDto>>>;
|
|
97
118
|
/**
|
|
98
119
|
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
99
120
|
* @summary Delete an event series
|
|
@@ -136,13 +157,23 @@ export declare const EventSeriesApiFactory: (configuration?: Configuration, base
|
|
|
136
157
|
*/
|
|
137
158
|
get(seriesId: string, options?: RawAxiosRequestConfig): AxiosPromise<EventSeriesDto>;
|
|
138
159
|
/**
|
|
139
|
-
*
|
|
140
|
-
* @summary
|
|
160
|
+
*
|
|
161
|
+
* @summary Get a batch of event series by IDs
|
|
162
|
+
* @param {GetEventSeriesDto} getEventSeriesDto
|
|
163
|
+
* @param {*} [options] Override http request option.
|
|
164
|
+
* @throws {RequiredError}
|
|
165
|
+
*/
|
|
166
|
+
getBatch(getEventSeriesDto: GetEventSeriesDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventSeriesDto>>;
|
|
167
|
+
/**
|
|
168
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
169
|
+
* @summary List event instances in a series
|
|
141
170
|
* @param {string} seriesId
|
|
171
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
172
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
142
173
|
* @param {*} [options] Override http request option.
|
|
143
174
|
* @throws {RequiredError}
|
|
144
175
|
*/
|
|
145
|
-
getInstances(seriesId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
|
|
176
|
+
getInstances(seriesId: string, from?: string, to?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
|
|
146
177
|
/**
|
|
147
178
|
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
148
179
|
* @summary Delete an event series
|
|
@@ -185,13 +216,23 @@ export interface EventSeriesApiInterface {
|
|
|
185
216
|
*/
|
|
186
217
|
get(seriesId: string, options?: RawAxiosRequestConfig): AxiosPromise<EventSeriesDto>;
|
|
187
218
|
/**
|
|
188
|
-
*
|
|
189
|
-
* @summary
|
|
219
|
+
*
|
|
220
|
+
* @summary Get a batch of event series by IDs
|
|
221
|
+
* @param {GetEventSeriesDto} getEventSeriesDto
|
|
222
|
+
* @param {*} [options] Override http request option.
|
|
223
|
+
* @throws {RequiredError}
|
|
224
|
+
*/
|
|
225
|
+
getBatch(getEventSeriesDto: GetEventSeriesDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventSeriesDto>>;
|
|
226
|
+
/**
|
|
227
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
228
|
+
* @summary List event instances in a series
|
|
190
229
|
* @param {string} seriesId
|
|
230
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
231
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
191
232
|
* @param {*} [options] Override http request option.
|
|
192
233
|
* @throws {RequiredError}
|
|
193
234
|
*/
|
|
194
|
-
getInstances(seriesId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
|
|
235
|
+
getInstances(seriesId: string, from?: string, to?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventDto>>;
|
|
195
236
|
/**
|
|
196
237
|
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
197
238
|
* @summary Delete an event series
|
|
@@ -234,13 +275,23 @@ export declare class EventSeriesApi extends BaseAPI implements EventSeriesApiInt
|
|
|
234
275
|
*/
|
|
235
276
|
get(seriesId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventSeriesDto, any, {}>>;
|
|
236
277
|
/**
|
|
237
|
-
*
|
|
238
|
-
* @summary
|
|
278
|
+
*
|
|
279
|
+
* @summary Get a batch of event series by IDs
|
|
280
|
+
* @param {GetEventSeriesDto} getEventSeriesDto
|
|
281
|
+
* @param {*} [options] Override http request option.
|
|
282
|
+
* @throws {RequiredError}
|
|
283
|
+
*/
|
|
284
|
+
getBatch(getEventSeriesDto: GetEventSeriesDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventSeriesDto[], any, {}>>;
|
|
285
|
+
/**
|
|
286
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
287
|
+
* @summary List event instances in a series
|
|
239
288
|
* @param {string} seriesId
|
|
289
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
290
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
240
291
|
* @param {*} [options] Override http request option.
|
|
241
292
|
* @throws {RequiredError}
|
|
242
293
|
*/
|
|
243
|
-
getInstances(seriesId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDto[], any, {}>>;
|
|
294
|
+
getInstances(seriesId: string, from?: string, to?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventDto[], any, {}>>;
|
|
244
295
|
/**
|
|
245
296
|
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
246
297
|
* @summary Delete an event series
|
|
@@ -100,13 +100,48 @@ const EventSeriesApiAxiosParamCreator = function (configuration) {
|
|
|
100
100
|
};
|
|
101
101
|
},
|
|
102
102
|
/**
|
|
103
|
-
*
|
|
104
|
-
* @summary
|
|
103
|
+
*
|
|
104
|
+
* @summary Get a batch of event series by IDs
|
|
105
|
+
* @param {GetEventSeriesDto} getEventSeriesDto
|
|
106
|
+
* @param {*} [options] Override http request option.
|
|
107
|
+
* @throws {RequiredError}
|
|
108
|
+
*/
|
|
109
|
+
getBatch: async (getEventSeriesDto, options = {}) => {
|
|
110
|
+
// verify required parameter 'getEventSeriesDto' is not null or undefined
|
|
111
|
+
(0, common_1.assertParamExists)('getBatch', 'getEventSeriesDto', getEventSeriesDto);
|
|
112
|
+
const localVarPath = `/event-series/batch`;
|
|
113
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
114
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
115
|
+
let baseOptions;
|
|
116
|
+
if (configuration) {
|
|
117
|
+
baseOptions = configuration.baseOptions;
|
|
118
|
+
}
|
|
119
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
120
|
+
const localVarHeaderParameter = {};
|
|
121
|
+
const localVarQueryParameter = {};
|
|
122
|
+
// authentication api_key required
|
|
123
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-Proxima-Nexus-Api-Key", configuration);
|
|
124
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
125
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
126
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
127
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
128
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
129
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(getEventSeriesDto, localVarRequestOptions, configuration);
|
|
130
|
+
return {
|
|
131
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
132
|
+
options: localVarRequestOptions,
|
|
133
|
+
};
|
|
134
|
+
},
|
|
135
|
+
/**
|
|
136
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
137
|
+
* @summary List event instances in a series
|
|
105
138
|
* @param {string} seriesId
|
|
139
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
140
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
106
141
|
* @param {*} [options] Override http request option.
|
|
107
142
|
* @throws {RequiredError}
|
|
108
143
|
*/
|
|
109
|
-
getInstances: async (seriesId, options = {}) => {
|
|
144
|
+
getInstances: async (seriesId, from, to, options = {}) => {
|
|
110
145
|
// verify required parameter 'seriesId' is not null or undefined
|
|
111
146
|
(0, common_1.assertParamExists)('getInstances', 'seriesId', seriesId);
|
|
112
147
|
const localVarPath = `/event-series/{seriesId}/events`
|
|
@@ -122,6 +157,12 @@ const EventSeriesApiAxiosParamCreator = function (configuration) {
|
|
|
122
157
|
const localVarQueryParameter = {};
|
|
123
158
|
// authentication api_key required
|
|
124
159
|
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-Proxima-Nexus-Api-Key", configuration);
|
|
160
|
+
if (from !== undefined) {
|
|
161
|
+
localVarQueryParameter['from'] = from;
|
|
162
|
+
}
|
|
163
|
+
if (to !== undefined) {
|
|
164
|
+
localVarQueryParameter['to'] = to;
|
|
165
|
+
}
|
|
125
166
|
localVarHeaderParameter['Accept'] = 'application/json';
|
|
126
167
|
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
127
168
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
@@ -248,14 +289,29 @@ const EventSeriesApiFp = function (configuration) {
|
|
|
248
289
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
249
290
|
},
|
|
250
291
|
/**
|
|
251
|
-
*
|
|
252
|
-
* @summary
|
|
292
|
+
*
|
|
293
|
+
* @summary Get a batch of event series by IDs
|
|
294
|
+
* @param {GetEventSeriesDto} getEventSeriesDto
|
|
295
|
+
* @param {*} [options] Override http request option.
|
|
296
|
+
* @throws {RequiredError}
|
|
297
|
+
*/
|
|
298
|
+
async getBatch(getEventSeriesDto, options) {
|
|
299
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getBatch(getEventSeriesDto, options);
|
|
300
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
301
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['EventSeriesApi.getBatch']?.[localVarOperationServerIndex]?.url;
|
|
302
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
303
|
+
},
|
|
304
|
+
/**
|
|
305
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
306
|
+
* @summary List event instances in a series
|
|
253
307
|
* @param {string} seriesId
|
|
308
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
309
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
254
310
|
* @param {*} [options] Override http request option.
|
|
255
311
|
* @throws {RequiredError}
|
|
256
312
|
*/
|
|
257
|
-
async getInstances(seriesId, options) {
|
|
258
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getInstances(seriesId, options);
|
|
313
|
+
async getInstances(seriesId, from, to, options) {
|
|
314
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getInstances(seriesId, from, to, options);
|
|
259
315
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
260
316
|
const localVarOperationServerBasePath = base_1.operationServerMap['EventSeriesApi.getInstances']?.[localVarOperationServerIndex]?.url;
|
|
261
317
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -320,14 +376,26 @@ const EventSeriesApiFactory = function (configuration, basePath, axios) {
|
|
|
320
376
|
return localVarFp.get(seriesId, options).then((request) => request(axios, basePath));
|
|
321
377
|
},
|
|
322
378
|
/**
|
|
323
|
-
*
|
|
324
|
-
* @summary
|
|
379
|
+
*
|
|
380
|
+
* @summary Get a batch of event series by IDs
|
|
381
|
+
* @param {GetEventSeriesDto} getEventSeriesDto
|
|
382
|
+
* @param {*} [options] Override http request option.
|
|
383
|
+
* @throws {RequiredError}
|
|
384
|
+
*/
|
|
385
|
+
getBatch(getEventSeriesDto, options) {
|
|
386
|
+
return localVarFp.getBatch(getEventSeriesDto, options).then((request) => request(axios, basePath));
|
|
387
|
+
},
|
|
388
|
+
/**
|
|
389
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
390
|
+
* @summary List event instances in a series
|
|
325
391
|
* @param {string} seriesId
|
|
392
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
393
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
326
394
|
* @param {*} [options] Override http request option.
|
|
327
395
|
* @throws {RequiredError}
|
|
328
396
|
*/
|
|
329
|
-
getInstances(seriesId, options) {
|
|
330
|
-
return localVarFp.getInstances(seriesId, options).then((request) => request(axios, basePath));
|
|
397
|
+
getInstances(seriesId, from, to, options) {
|
|
398
|
+
return localVarFp.getInstances(seriesId, from, to, options).then((request) => request(axios, basePath));
|
|
331
399
|
},
|
|
332
400
|
/**
|
|
333
401
|
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
@@ -381,14 +449,26 @@ class EventSeriesApi extends base_1.BaseAPI {
|
|
|
381
449
|
return (0, exports.EventSeriesApiFp)(this.configuration).get(seriesId, options).then((request) => request(this.axios, this.basePath));
|
|
382
450
|
}
|
|
383
451
|
/**
|
|
384
|
-
*
|
|
385
|
-
* @summary
|
|
452
|
+
*
|
|
453
|
+
* @summary Get a batch of event series by IDs
|
|
454
|
+
* @param {GetEventSeriesDto} getEventSeriesDto
|
|
455
|
+
* @param {*} [options] Override http request option.
|
|
456
|
+
* @throws {RequiredError}
|
|
457
|
+
*/
|
|
458
|
+
getBatch(getEventSeriesDto, options) {
|
|
459
|
+
return (0, exports.EventSeriesApiFp)(this.configuration).getBatch(getEventSeriesDto, options).then((request) => request(this.axios, this.basePath));
|
|
460
|
+
}
|
|
461
|
+
/**
|
|
462
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
463
|
+
* @summary List event instances in a series
|
|
386
464
|
* @param {string} seriesId
|
|
465
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
466
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
387
467
|
* @param {*} [options] Override http request option.
|
|
388
468
|
* @throws {RequiredError}
|
|
389
469
|
*/
|
|
390
|
-
getInstances(seriesId, options) {
|
|
391
|
-
return (0, exports.EventSeriesApiFp)(this.configuration).getInstances(seriesId, options).then((request) => request(this.axios, this.basePath));
|
|
470
|
+
getInstances(seriesId, from, to, options) {
|
|
471
|
+
return (0, exports.EventSeriesApiFp)(this.configuration).getInstances(seriesId, from, to, options).then((request) => request(this.axios, this.basePath));
|
|
392
472
|
}
|
|
393
473
|
/**
|
|
394
474
|
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|