@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
|
@@ -0,0 +1,431 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* proxima-nexus-data-plane-api
|
|
6
|
+
* Proxima Nexus Data Plane API
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
16
|
+
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
17
|
+
};
|
|
18
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
19
|
+
exports.EventSeriesApi = exports.EventSeriesApiFactory = exports.EventSeriesApiFp = exports.EventSeriesApiAxiosParamCreator = void 0;
|
|
20
|
+
const axios_1 = __importDefault(require("axios"));
|
|
21
|
+
// Some imports not used depending on template conditions
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
const common_1 = require("../common");
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
const base_1 = require("../base");
|
|
26
|
+
/**
|
|
27
|
+
* EventSeriesApi - axios parameter creator
|
|
28
|
+
*/
|
|
29
|
+
const EventSeriesApiAxiosParamCreator = function (configuration) {
|
|
30
|
+
return {
|
|
31
|
+
/**
|
|
32
|
+
* Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
|
|
33
|
+
* @summary Create an event series
|
|
34
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating the series
|
|
35
|
+
* @param {CreateEventSeriesDto} createEventSeriesDto
|
|
36
|
+
* @param {*} [options] Override http request option.
|
|
37
|
+
* @throws {RequiredError}
|
|
38
|
+
*/
|
|
39
|
+
create: async (xProximaNexusRequesterUserId, createEventSeriesDto, options = {}) => {
|
|
40
|
+
// verify required parameter 'xProximaNexusRequesterUserId' is not null or undefined
|
|
41
|
+
(0, common_1.assertParamExists)('create', 'xProximaNexusRequesterUserId', xProximaNexusRequesterUserId);
|
|
42
|
+
// verify required parameter 'createEventSeriesDto' is not null or undefined
|
|
43
|
+
(0, common_1.assertParamExists)('create', 'createEventSeriesDto', createEventSeriesDto);
|
|
44
|
+
const localVarPath = `/event-series`;
|
|
45
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
46
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
47
|
+
let baseOptions;
|
|
48
|
+
if (configuration) {
|
|
49
|
+
baseOptions = configuration.baseOptions;
|
|
50
|
+
}
|
|
51
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options };
|
|
52
|
+
const localVarHeaderParameter = {};
|
|
53
|
+
const localVarQueryParameter = {};
|
|
54
|
+
// authentication api_key required
|
|
55
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-Proxima-Nexus-Api-Key", configuration);
|
|
56
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
57
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
58
|
+
if (xProximaNexusRequesterUserId != null) {
|
|
59
|
+
localVarHeaderParameter['X-Proxima-Nexus-Requester-User-Id'] = String(xProximaNexusRequesterUserId);
|
|
60
|
+
}
|
|
61
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
62
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
63
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
64
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(createEventSeriesDto, localVarRequestOptions, configuration);
|
|
65
|
+
return {
|
|
66
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
67
|
+
options: localVarRequestOptions,
|
|
68
|
+
};
|
|
69
|
+
},
|
|
70
|
+
/**
|
|
71
|
+
*
|
|
72
|
+
* @summary Get an event series by ID
|
|
73
|
+
* @param {string} seriesId
|
|
74
|
+
* @param {*} [options] Override http request option.
|
|
75
|
+
* @throws {RequiredError}
|
|
76
|
+
*/
|
|
77
|
+
get: async (seriesId, options = {}) => {
|
|
78
|
+
// verify required parameter 'seriesId' is not null or undefined
|
|
79
|
+
(0, common_1.assertParamExists)('get', 'seriesId', seriesId);
|
|
80
|
+
const localVarPath = `/event-series/{seriesId}`
|
|
81
|
+
.replace(`{${"seriesId"}}`, encodeURIComponent(String(seriesId)));
|
|
82
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
83
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
84
|
+
let baseOptions;
|
|
85
|
+
if (configuration) {
|
|
86
|
+
baseOptions = configuration.baseOptions;
|
|
87
|
+
}
|
|
88
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
89
|
+
const localVarHeaderParameter = {};
|
|
90
|
+
const localVarQueryParameter = {};
|
|
91
|
+
// authentication api_key required
|
|
92
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-Proxima-Nexus-Api-Key", configuration);
|
|
93
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
94
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
95
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
96
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
97
|
+
return {
|
|
98
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
99
|
+
options: localVarRequestOptions,
|
|
100
|
+
};
|
|
101
|
+
},
|
|
102
|
+
/**
|
|
103
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
104
|
+
* @summary List event instances in a series
|
|
105
|
+
* @param {string} seriesId
|
|
106
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
107
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
108
|
+
* @param {*} [options] Override http request option.
|
|
109
|
+
* @throws {RequiredError}
|
|
110
|
+
*/
|
|
111
|
+
getInstances: async (seriesId, from, to, options = {}) => {
|
|
112
|
+
// verify required parameter 'seriesId' is not null or undefined
|
|
113
|
+
(0, common_1.assertParamExists)('getInstances', 'seriesId', seriesId);
|
|
114
|
+
const localVarPath = `/event-series/{seriesId}/events`
|
|
115
|
+
.replace(`{${"seriesId"}}`, encodeURIComponent(String(seriesId)));
|
|
116
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
117
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
118
|
+
let baseOptions;
|
|
119
|
+
if (configuration) {
|
|
120
|
+
baseOptions = configuration.baseOptions;
|
|
121
|
+
}
|
|
122
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
|
|
123
|
+
const localVarHeaderParameter = {};
|
|
124
|
+
const localVarQueryParameter = {};
|
|
125
|
+
// authentication api_key required
|
|
126
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-Proxima-Nexus-Api-Key", configuration);
|
|
127
|
+
if (from !== undefined) {
|
|
128
|
+
localVarQueryParameter['from'] = from;
|
|
129
|
+
}
|
|
130
|
+
if (to !== undefined) {
|
|
131
|
+
localVarQueryParameter['to'] = to;
|
|
132
|
+
}
|
|
133
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
134
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
135
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
136
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
137
|
+
return {
|
|
138
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
139
|
+
options: localVarRequestOptions,
|
|
140
|
+
};
|
|
141
|
+
},
|
|
142
|
+
/**
|
|
143
|
+
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
144
|
+
* @summary Delete an event series
|
|
145
|
+
* @param {string} seriesId
|
|
146
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
|
|
147
|
+
* @param {*} [options] Override http request option.
|
|
148
|
+
* @throws {RequiredError}
|
|
149
|
+
*/
|
|
150
|
+
remove: async (seriesId, xProximaNexusRequesterUserId, options = {}) => {
|
|
151
|
+
// verify required parameter 'seriesId' is not null or undefined
|
|
152
|
+
(0, common_1.assertParamExists)('remove', 'seriesId', seriesId);
|
|
153
|
+
// verify required parameter 'xProximaNexusRequesterUserId' is not null or undefined
|
|
154
|
+
(0, common_1.assertParamExists)('remove', 'xProximaNexusRequesterUserId', xProximaNexusRequesterUserId);
|
|
155
|
+
const localVarPath = `/event-series/{seriesId}`
|
|
156
|
+
.replace(`{${"seriesId"}}`, encodeURIComponent(String(seriesId)));
|
|
157
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
158
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
159
|
+
let baseOptions;
|
|
160
|
+
if (configuration) {
|
|
161
|
+
baseOptions = configuration.baseOptions;
|
|
162
|
+
}
|
|
163
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options };
|
|
164
|
+
const localVarHeaderParameter = {};
|
|
165
|
+
const localVarQueryParameter = {};
|
|
166
|
+
// authentication api_key required
|
|
167
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-Proxima-Nexus-Api-Key", configuration);
|
|
168
|
+
if (xProximaNexusRequesterUserId != null) {
|
|
169
|
+
localVarHeaderParameter['X-Proxima-Nexus-Requester-User-Id'] = String(xProximaNexusRequesterUserId);
|
|
170
|
+
}
|
|
171
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
172
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
173
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
174
|
+
return {
|
|
175
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
176
|
+
options: localVarRequestOptions,
|
|
177
|
+
};
|
|
178
|
+
},
|
|
179
|
+
/**
|
|
180
|
+
* 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.
|
|
181
|
+
* @summary Update an event series
|
|
182
|
+
* @param {string} seriesId
|
|
183
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the series
|
|
184
|
+
* @param {UpdateEventSeriesDto} updateEventSeriesDto
|
|
185
|
+
* @param {*} [options] Override http request option.
|
|
186
|
+
* @throws {RequiredError}
|
|
187
|
+
*/
|
|
188
|
+
update: async (seriesId, xProximaNexusRequesterUserId, updateEventSeriesDto, options = {}) => {
|
|
189
|
+
// verify required parameter 'seriesId' is not null or undefined
|
|
190
|
+
(0, common_1.assertParamExists)('update', 'seriesId', seriesId);
|
|
191
|
+
// verify required parameter 'xProximaNexusRequesterUserId' is not null or undefined
|
|
192
|
+
(0, common_1.assertParamExists)('update', 'xProximaNexusRequesterUserId', xProximaNexusRequesterUserId);
|
|
193
|
+
// verify required parameter 'updateEventSeriesDto' is not null or undefined
|
|
194
|
+
(0, common_1.assertParamExists)('update', 'updateEventSeriesDto', updateEventSeriesDto);
|
|
195
|
+
const localVarPath = `/event-series/{seriesId}`
|
|
196
|
+
.replace(`{${"seriesId"}}`, encodeURIComponent(String(seriesId)));
|
|
197
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
198
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
199
|
+
let baseOptions;
|
|
200
|
+
if (configuration) {
|
|
201
|
+
baseOptions = configuration.baseOptions;
|
|
202
|
+
}
|
|
203
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options };
|
|
204
|
+
const localVarHeaderParameter = {};
|
|
205
|
+
const localVarQueryParameter = {};
|
|
206
|
+
// authentication api_key required
|
|
207
|
+
await (0, common_1.setApiKeyToObject)(localVarHeaderParameter, "X-Proxima-Nexus-Api-Key", configuration);
|
|
208
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
209
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
210
|
+
if (xProximaNexusRequesterUserId != null) {
|
|
211
|
+
localVarHeaderParameter['X-Proxima-Nexus-Requester-User-Id'] = String(xProximaNexusRequesterUserId);
|
|
212
|
+
}
|
|
213
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
214
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
215
|
+
localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
|
|
216
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(updateEventSeriesDto, localVarRequestOptions, configuration);
|
|
217
|
+
return {
|
|
218
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
219
|
+
options: localVarRequestOptions,
|
|
220
|
+
};
|
|
221
|
+
},
|
|
222
|
+
};
|
|
223
|
+
};
|
|
224
|
+
exports.EventSeriesApiAxiosParamCreator = EventSeriesApiAxiosParamCreator;
|
|
225
|
+
/**
|
|
226
|
+
* EventSeriesApi - functional programming interface
|
|
227
|
+
*/
|
|
228
|
+
const EventSeriesApiFp = function (configuration) {
|
|
229
|
+
const localVarAxiosParamCreator = (0, exports.EventSeriesApiAxiosParamCreator)(configuration);
|
|
230
|
+
return {
|
|
231
|
+
/**
|
|
232
|
+
* Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
|
|
233
|
+
* @summary Create an event series
|
|
234
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating the series
|
|
235
|
+
* @param {CreateEventSeriesDto} createEventSeriesDto
|
|
236
|
+
* @param {*} [options] Override http request option.
|
|
237
|
+
* @throws {RequiredError}
|
|
238
|
+
*/
|
|
239
|
+
async create(xProximaNexusRequesterUserId, createEventSeriesDto, options) {
|
|
240
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.create(xProximaNexusRequesterUserId, createEventSeriesDto, options);
|
|
241
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
242
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['EventSeriesApi.create']?.[localVarOperationServerIndex]?.url;
|
|
243
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
244
|
+
},
|
|
245
|
+
/**
|
|
246
|
+
*
|
|
247
|
+
* @summary Get an event series by ID
|
|
248
|
+
* @param {string} seriesId
|
|
249
|
+
* @param {*} [options] Override http request option.
|
|
250
|
+
* @throws {RequiredError}
|
|
251
|
+
*/
|
|
252
|
+
async get(seriesId, options) {
|
|
253
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.get(seriesId, options);
|
|
254
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
255
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['EventSeriesApi.get']?.[localVarOperationServerIndex]?.url;
|
|
256
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
257
|
+
},
|
|
258
|
+
/**
|
|
259
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
260
|
+
* @summary List event instances in a series
|
|
261
|
+
* @param {string} seriesId
|
|
262
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
263
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
264
|
+
* @param {*} [options] Override http request option.
|
|
265
|
+
* @throws {RequiredError}
|
|
266
|
+
*/
|
|
267
|
+
async getInstances(seriesId, from, to, options) {
|
|
268
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getInstances(seriesId, from, to, options);
|
|
269
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
270
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['EventSeriesApi.getInstances']?.[localVarOperationServerIndex]?.url;
|
|
271
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
272
|
+
},
|
|
273
|
+
/**
|
|
274
|
+
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
275
|
+
* @summary Delete an event series
|
|
276
|
+
* @param {string} seriesId
|
|
277
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
|
|
278
|
+
* @param {*} [options] Override http request option.
|
|
279
|
+
* @throws {RequiredError}
|
|
280
|
+
*/
|
|
281
|
+
async remove(seriesId, xProximaNexusRequesterUserId, options) {
|
|
282
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.remove(seriesId, xProximaNexusRequesterUserId, options);
|
|
283
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
284
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['EventSeriesApi.remove']?.[localVarOperationServerIndex]?.url;
|
|
285
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
286
|
+
},
|
|
287
|
+
/**
|
|
288
|
+
* 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.
|
|
289
|
+
* @summary Update an event series
|
|
290
|
+
* @param {string} seriesId
|
|
291
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the series
|
|
292
|
+
* @param {UpdateEventSeriesDto} updateEventSeriesDto
|
|
293
|
+
* @param {*} [options] Override http request option.
|
|
294
|
+
* @throws {RequiredError}
|
|
295
|
+
*/
|
|
296
|
+
async update(seriesId, xProximaNexusRequesterUserId, updateEventSeriesDto, options) {
|
|
297
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.update(seriesId, xProximaNexusRequesterUserId, updateEventSeriesDto, options);
|
|
298
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
299
|
+
const localVarOperationServerBasePath = base_1.operationServerMap['EventSeriesApi.update']?.[localVarOperationServerIndex]?.url;
|
|
300
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
301
|
+
},
|
|
302
|
+
};
|
|
303
|
+
};
|
|
304
|
+
exports.EventSeriesApiFp = EventSeriesApiFp;
|
|
305
|
+
/**
|
|
306
|
+
* EventSeriesApi - factory interface
|
|
307
|
+
*/
|
|
308
|
+
const EventSeriesApiFactory = function (configuration, basePath, axios) {
|
|
309
|
+
const localVarFp = (0, exports.EventSeriesApiFp)(configuration);
|
|
310
|
+
return {
|
|
311
|
+
/**
|
|
312
|
+
* Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
|
|
313
|
+
* @summary Create an event series
|
|
314
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating the series
|
|
315
|
+
* @param {CreateEventSeriesDto} createEventSeriesDto
|
|
316
|
+
* @param {*} [options] Override http request option.
|
|
317
|
+
* @throws {RequiredError}
|
|
318
|
+
*/
|
|
319
|
+
create(xProximaNexusRequesterUserId, createEventSeriesDto, options) {
|
|
320
|
+
return localVarFp.create(xProximaNexusRequesterUserId, createEventSeriesDto, options).then((request) => request(axios, basePath));
|
|
321
|
+
},
|
|
322
|
+
/**
|
|
323
|
+
*
|
|
324
|
+
* @summary Get an event series by ID
|
|
325
|
+
* @param {string} seriesId
|
|
326
|
+
* @param {*} [options] Override http request option.
|
|
327
|
+
* @throws {RequiredError}
|
|
328
|
+
*/
|
|
329
|
+
get(seriesId, options) {
|
|
330
|
+
return localVarFp.get(seriesId, options).then((request) => request(axios, basePath));
|
|
331
|
+
},
|
|
332
|
+
/**
|
|
333
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
334
|
+
* @summary List event instances in a series
|
|
335
|
+
* @param {string} seriesId
|
|
336
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
337
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
338
|
+
* @param {*} [options] Override http request option.
|
|
339
|
+
* @throws {RequiredError}
|
|
340
|
+
*/
|
|
341
|
+
getInstances(seriesId, from, to, options) {
|
|
342
|
+
return localVarFp.getInstances(seriesId, from, to, options).then((request) => request(axios, basePath));
|
|
343
|
+
},
|
|
344
|
+
/**
|
|
345
|
+
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
346
|
+
* @summary Delete an event series
|
|
347
|
+
* @param {string} seriesId
|
|
348
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
|
|
349
|
+
* @param {*} [options] Override http request option.
|
|
350
|
+
* @throws {RequiredError}
|
|
351
|
+
*/
|
|
352
|
+
remove(seriesId, xProximaNexusRequesterUserId, options) {
|
|
353
|
+
return localVarFp.remove(seriesId, xProximaNexusRequesterUserId, options).then((request) => request(axios, basePath));
|
|
354
|
+
},
|
|
355
|
+
/**
|
|
356
|
+
* 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.
|
|
357
|
+
* @summary Update an event series
|
|
358
|
+
* @param {string} seriesId
|
|
359
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the series
|
|
360
|
+
* @param {UpdateEventSeriesDto} updateEventSeriesDto
|
|
361
|
+
* @param {*} [options] Override http request option.
|
|
362
|
+
* @throws {RequiredError}
|
|
363
|
+
*/
|
|
364
|
+
update(seriesId, xProximaNexusRequesterUserId, updateEventSeriesDto, options) {
|
|
365
|
+
return localVarFp.update(seriesId, xProximaNexusRequesterUserId, updateEventSeriesDto, options).then((request) => request(axios, basePath));
|
|
366
|
+
},
|
|
367
|
+
};
|
|
368
|
+
};
|
|
369
|
+
exports.EventSeriesApiFactory = EventSeriesApiFactory;
|
|
370
|
+
/**
|
|
371
|
+
* EventSeriesApi - object-oriented interface
|
|
372
|
+
*/
|
|
373
|
+
class EventSeriesApi extends base_1.BaseAPI {
|
|
374
|
+
/**
|
|
375
|
+
* Creates a series definition and pre-generates all event instances based on the RRULE. The creating user (or associated group) becomes the OWNER.
|
|
376
|
+
* @summary Create an event series
|
|
377
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating the series
|
|
378
|
+
* @param {CreateEventSeriesDto} createEventSeriesDto
|
|
379
|
+
* @param {*} [options] Override http request option.
|
|
380
|
+
* @throws {RequiredError}
|
|
381
|
+
*/
|
|
382
|
+
create(xProximaNexusRequesterUserId, createEventSeriesDto, options) {
|
|
383
|
+
return (0, exports.EventSeriesApiFp)(this.configuration).create(xProximaNexusRequesterUserId, createEventSeriesDto, options).then((request) => request(this.axios, this.basePath));
|
|
384
|
+
}
|
|
385
|
+
/**
|
|
386
|
+
*
|
|
387
|
+
* @summary Get an event series by ID
|
|
388
|
+
* @param {string} seriesId
|
|
389
|
+
* @param {*} [options] Override http request option.
|
|
390
|
+
* @throws {RequiredError}
|
|
391
|
+
*/
|
|
392
|
+
get(seriesId, options) {
|
|
393
|
+
return (0, exports.EventSeriesApiFp)(this.configuration).get(seriesId, options).then((request) => request(this.axios, this.basePath));
|
|
394
|
+
}
|
|
395
|
+
/**
|
|
396
|
+
* Returns event instances belonging to this series, ordered by start time. Defaults to only ongoing/upcoming instances.
|
|
397
|
+
* @summary List event instances in a series
|
|
398
|
+
* @param {string} seriesId
|
|
399
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
400
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
401
|
+
* @param {*} [options] Override http request option.
|
|
402
|
+
* @throws {RequiredError}
|
|
403
|
+
*/
|
|
404
|
+
getInstances(seriesId, from, to, options) {
|
|
405
|
+
return (0, exports.EventSeriesApiFp)(this.configuration).getInstances(seriesId, from, to, options).then((request) => request(this.axios, this.basePath));
|
|
406
|
+
}
|
|
407
|
+
/**
|
|
408
|
+
* Deletes the series and all upcoming event instances. Past instances (already started) are preserved.
|
|
409
|
+
* @summary Delete an event series
|
|
410
|
+
* @param {string} seriesId
|
|
411
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the series
|
|
412
|
+
* @param {*} [options] Override http request option.
|
|
413
|
+
* @throws {RequiredError}
|
|
414
|
+
*/
|
|
415
|
+
remove(seriesId, xProximaNexusRequesterUserId, options) {
|
|
416
|
+
return (0, exports.EventSeriesApiFp)(this.configuration).remove(seriesId, xProximaNexusRequesterUserId, options).then((request) => request(this.axios, this.basePath));
|
|
417
|
+
}
|
|
418
|
+
/**
|
|
419
|
+
* 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.
|
|
420
|
+
* @summary Update an event series
|
|
421
|
+
* @param {string} seriesId
|
|
422
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the series
|
|
423
|
+
* @param {UpdateEventSeriesDto} updateEventSeriesDto
|
|
424
|
+
* @param {*} [options] Override http request option.
|
|
425
|
+
* @throws {RequiredError}
|
|
426
|
+
*/
|
|
427
|
+
update(seriesId, xProximaNexusRequesterUserId, updateEventSeriesDto, options) {
|
|
428
|
+
return (0, exports.EventSeriesApiFp)(this.configuration).update(seriesId, xProximaNexusRequesterUserId, updateEventSeriesDto, options).then((request) => request(this.axios, this.basePath));
|
|
429
|
+
}
|
|
430
|
+
}
|
|
431
|
+
exports.EventSeriesApi = EventSeriesApi;
|
package/dist/api/group-api.d.ts
CHANGED
|
@@ -77,11 +77,13 @@ export declare const GroupApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
77
77
|
*
|
|
78
78
|
* @summary Get events of a group
|
|
79
79
|
* @param {string} groupId
|
|
80
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
81
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
80
82
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of the group. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
81
83
|
* @param {*} [options] Override http request option.
|
|
82
84
|
* @throws {RequiredError}
|
|
83
85
|
*/
|
|
84
|
-
getEvents: (groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
86
|
+
getEvents: (groupId: string, from?: string, to?: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
85
87
|
/**
|
|
86
88
|
*
|
|
87
89
|
* @summary Delete a group
|
|
@@ -114,11 +116,13 @@ export declare const GroupApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
114
116
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
115
117
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
116
118
|
* @param {number} [limit] Limit results (1-1000)
|
|
119
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
120
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
117
121
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
|
|
118
122
|
* @param {*} [options] Override http request option.
|
|
119
123
|
* @throws {RequiredError}
|
|
120
124
|
*/
|
|
121
|
-
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>;
|
|
125
|
+
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>;
|
|
122
126
|
/**
|
|
123
127
|
*
|
|
124
128
|
* @summary Update a group
|
|
@@ -187,11 +191,13 @@ export declare const GroupApiFp: (configuration?: Configuration) => {
|
|
|
187
191
|
*
|
|
188
192
|
* @summary Get events of a group
|
|
189
193
|
* @param {string} groupId
|
|
194
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
195
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
190
196
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of the group. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
191
197
|
* @param {*} [options] Override http request option.
|
|
192
198
|
* @throws {RequiredError}
|
|
193
199
|
*/
|
|
194
|
-
getEvents(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventEntityConnectionDto>>>;
|
|
200
|
+
getEvents(groupId: string, from?: string, to?: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventEntityConnectionDto>>>;
|
|
195
201
|
/**
|
|
196
202
|
*
|
|
197
203
|
* @summary Delete a group
|
|
@@ -224,11 +230,13 @@ export declare const GroupApiFp: (configuration?: Configuration) => {
|
|
|
224
230
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
225
231
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
226
232
|
* @param {number} [limit] Limit results (1-1000)
|
|
233
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
234
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
227
235
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
|
|
228
236
|
* @param {*} [options] Override http request option.
|
|
229
237
|
* @throws {RequiredError}
|
|
230
238
|
*/
|
|
231
|
-
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<GroupDto>>>;
|
|
239
|
+
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<GroupDto>>>;
|
|
232
240
|
/**
|
|
233
241
|
*
|
|
234
242
|
* @summary Update a group
|
|
@@ -297,11 +305,13 @@ export declare const GroupApiFactory: (configuration?: Configuration, basePath?:
|
|
|
297
305
|
*
|
|
298
306
|
* @summary Get events of a group
|
|
299
307
|
* @param {string} groupId
|
|
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)
|
|
300
310
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of the group. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
301
311
|
* @param {*} [options] Override http request option.
|
|
302
312
|
* @throws {RequiredError}
|
|
303
313
|
*/
|
|
304
|
-
getEvents(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
|
|
314
|
+
getEvents(groupId: string, from?: string, to?: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
|
|
305
315
|
/**
|
|
306
316
|
*
|
|
307
317
|
* @summary Delete a group
|
|
@@ -334,11 +344,13 @@ export declare const GroupApiFactory: (configuration?: Configuration, basePath?:
|
|
|
334
344
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
335
345
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
336
346
|
* @param {number} [limit] Limit results (1-1000)
|
|
347
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
348
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
337
349
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
|
|
338
350
|
* @param {*} [options] Override http request option.
|
|
339
351
|
* @throws {RequiredError}
|
|
340
352
|
*/
|
|
341
|
-
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<GroupDto>>;
|
|
353
|
+
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<GroupDto>>;
|
|
342
354
|
/**
|
|
343
355
|
*
|
|
344
356
|
* @summary Update a group
|
|
@@ -407,11 +419,13 @@ export interface GroupApiInterface {
|
|
|
407
419
|
*
|
|
408
420
|
* @summary Get events of a group
|
|
409
421
|
* @param {string} groupId
|
|
422
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
423
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
410
424
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of the group. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
411
425
|
* @param {*} [options] Override http request option.
|
|
412
426
|
* @throws {RequiredError}
|
|
413
427
|
*/
|
|
414
|
-
getEvents(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
|
|
428
|
+
getEvents(groupId: string, from?: string, to?: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
|
|
415
429
|
/**
|
|
416
430
|
*
|
|
417
431
|
* @summary Delete a group
|
|
@@ -444,11 +458,13 @@ export interface GroupApiInterface {
|
|
|
444
458
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
445
459
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
446
460
|
* @param {number} [limit] Limit results (1-1000)
|
|
461
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
462
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
447
463
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
|
|
448
464
|
* @param {*} [options] Override http request option.
|
|
449
465
|
* @throws {RequiredError}
|
|
450
466
|
*/
|
|
451
|
-
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<GroupDto>>;
|
|
467
|
+
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<GroupDto>>;
|
|
452
468
|
/**
|
|
453
469
|
*
|
|
454
470
|
* @summary Update a group
|
|
@@ -517,11 +533,13 @@ export declare class GroupApi extends BaseAPI implements GroupApiInterface {
|
|
|
517
533
|
*
|
|
518
534
|
* @summary Get events of a group
|
|
519
535
|
* @param {string} groupId
|
|
536
|
+
* @param {string} [from] ISO 8601 start of range (events ending after this time). Default: NOW()
|
|
537
|
+
* @param {string} [to] ISO 8601 end of range (events starting before this time)
|
|
520
538
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of the group. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
521
539
|
* @param {*} [options] Override http request option.
|
|
522
540
|
* @throws {RequiredError}
|
|
523
541
|
*/
|
|
524
|
-
getEvents(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventEntityConnectionDto[], any, {}>>;
|
|
542
|
+
getEvents(groupId: string, from?: string, to?: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventEntityConnectionDto[], any, {}>>;
|
|
525
543
|
/**
|
|
526
544
|
*
|
|
527
545
|
* @summary Delete a group
|
|
@@ -554,11 +572,13 @@ export declare class GroupApi extends BaseAPI implements GroupApiInterface {
|
|
|
554
572
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
555
573
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
556
574
|
* @param {number} [limit] Limit results (1-1000)
|
|
575
|
+
* @param {string} [from] ISO 8601 date — filter events ending after this time
|
|
576
|
+
* @param {string} [to] ISO 8601 date — filter events starting before this time
|
|
557
577
|
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
|
|
558
578
|
* @param {*} [options] Override http request option.
|
|
559
579
|
* @throws {RequiredError}
|
|
560
580
|
*/
|
|
561
|
-
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<GroupDto[], any, {}>>;
|
|
581
|
+
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<GroupDto[], any, {}>>;
|
|
562
582
|
/**
|
|
563
583
|
*
|
|
564
584
|
* @summary Update a group
|