@mitodl/ol-analytics-dashboard-api-axios 0.0.0-stage → 2026.10.20-1

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.
Files changed (43) hide show
  1. package/LICENSE +29 -0
  2. package/dist/cjs/api.d.ts +1868 -0
  3. package/dist/cjs/api.d.ts.map +1 -0
  4. package/dist/cjs/api.js +1536 -0
  5. package/dist/cjs/api.js.map +1 -0
  6. package/dist/cjs/base.d.ts +43 -0
  7. package/dist/cjs/base.d.ts.map +1 -0
  8. package/dist/cjs/base.js +50 -0
  9. package/dist/cjs/base.js.map +1 -0
  10. package/dist/cjs/common.d.ts +35 -0
  11. package/dist/cjs/common.d.ts.map +1 -0
  12. package/dist/cjs/common.js +140 -0
  13. package/dist/cjs/common.js.map +1 -0
  14. package/dist/cjs/configuration.d.ts +99 -0
  15. package/dist/cjs/configuration.d.ts.map +1 -0
  16. package/dist/cjs/configuration.js +45 -0
  17. package/dist/cjs/configuration.js.map +1 -0
  18. package/dist/cjs/index.d.ts +14 -0
  19. package/dist/cjs/index.d.ts.map +1 -0
  20. package/dist/cjs/index.js +32 -0
  21. package/dist/cjs/index.js.map +1 -0
  22. package/dist/esm/api.d.ts +1868 -0
  23. package/dist/esm/api.d.ts.map +1 -0
  24. package/dist/esm/api.js +1510 -0
  25. package/dist/esm/api.js.map +1 -0
  26. package/dist/esm/base.d.ts +43 -0
  27. package/dist/esm/base.d.ts.map +1 -0
  28. package/dist/esm/base.js +42 -0
  29. package/dist/esm/base.js.map +1 -0
  30. package/dist/esm/common.d.ts +35 -0
  31. package/dist/esm/common.d.ts.map +1 -0
  32. package/dist/esm/common.js +127 -0
  33. package/dist/esm/common.js.map +1 -0
  34. package/dist/esm/configuration.d.ts +99 -0
  35. package/dist/esm/configuration.d.ts.map +1 -0
  36. package/dist/esm/configuration.js +41 -0
  37. package/dist/esm/configuration.js.map +1 -0
  38. package/dist/esm/index.d.ts +14 -0
  39. package/dist/esm/index.d.ts.map +1 -0
  40. package/dist/esm/index.js +16 -0
  41. package/dist/esm/index.js.map +1 -0
  42. package/package.json +37 -3
  43. package/README.md +0 -3
@@ -0,0 +1,1510 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * B2B Analytics Dashboard
5
+ * B2B site-license analytics for org managers and MIT contract admins. Aggregate endpoints apply a k-anonymity floor. The contract-scoped learner-progress endpoint returns individual learners on the organization\'s own seats, with outcome fields consent-gated.
6
+ *
7
+ * The version of the OpenAPI document: 0.0.1
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import globalAxios from 'axios';
24
+ // Some imports not used depending on template conditions
25
+ // @ts-ignore
26
+ import { DUMMY_BASE_URL, assertParamExists, setSearchParams, toPathString, createRequestFunction } from './common';
27
+ // @ts-ignore
28
+ import { BASE_PATH, BaseAPI, operationServerMap } from './base';
29
+ /**
30
+ * ``passed`` without ``certified`` is normal: certificates are issued on a schedule after grading, and audit-mode enrollments never certify.
31
+ */
32
+ export const CompletionStatus = {
33
+ NotStarted: 'not_started',
34
+ InProgress: 'in_progress',
35
+ Passed: 'passed',
36
+ Certified: 'certified',
37
+ };
38
+ export const CompletionStatusFilter = {
39
+ NotStarted: 'not_started',
40
+ InProgress: 'in_progress',
41
+ Passed: 'passed',
42
+ Certified: 'certified',
43
+ Unknown: 'unknown',
44
+ };
45
+ /**
46
+ * ``not_recorded`` = the learner has not answered. ``declined`` covers a learner who answered no and one who consented and later withdrew: MITx Online keeps one nullable boolean per (learner, contract).
47
+ */
48
+ export const ConsentStatus = {
49
+ Consented: 'consented',
50
+ Declined: 'declined',
51
+ NotRecorded: 'not_recorded',
52
+ };
53
+ export const SortKey = {
54
+ FullName: 'full_name',
55
+ Email: 'email',
56
+ EnrolledOn: 'enrolled_on',
57
+ CourserunReadableId: 'courserun_readable_id',
58
+ };
59
+ /**
60
+ * AdminApi - axios parameter creator
61
+ */
62
+ export const AdminApiAxiosParamCreator = function (configuration) {
63
+ return {
64
+ /**
65
+ *
66
+ * @summary Contract Health
67
+ * @param {number} [limit]
68
+ * @param {number} [offset]
69
+ * @param {*} [options] Override http request option.
70
+ * @throws {RequiredError}
71
+ */
72
+ adminContractHealthRetrieve: (limit_1, offset_1, ...args_1) => __awaiter(this, [limit_1, offset_1, ...args_1], void 0, function* (limit, offset, options = {}) {
73
+ const localVarPath = `/api/v1/analytics/admin/contract-health`;
74
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
75
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
76
+ let baseOptions;
77
+ if (configuration) {
78
+ baseOptions = configuration.baseOptions;
79
+ }
80
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
81
+ const localVarHeaderParameter = {};
82
+ const localVarQueryParameter = {};
83
+ if (limit !== undefined) {
84
+ localVarQueryParameter['limit'] = limit;
85
+ }
86
+ if (offset !== undefined) {
87
+ localVarQueryParameter['offset'] = offset;
88
+ }
89
+ localVarHeaderParameter['Accept'] = 'application/json';
90
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
91
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
92
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
93
+ return {
94
+ url: toPathString(localVarUrlObj),
95
+ options: localVarRequestOptions,
96
+ };
97
+ }),
98
+ };
99
+ };
100
+ /**
101
+ * AdminApi - functional programming interface
102
+ */
103
+ export const AdminApiFp = function (configuration) {
104
+ const localVarAxiosParamCreator = AdminApiAxiosParamCreator(configuration);
105
+ return {
106
+ /**
107
+ *
108
+ * @summary Contract Health
109
+ * @param {number} [limit]
110
+ * @param {number} [offset]
111
+ * @param {*} [options] Override http request option.
112
+ * @throws {RequiredError}
113
+ */
114
+ adminContractHealthRetrieve(limit, offset, options) {
115
+ return __awaiter(this, void 0, void 0, function* () {
116
+ var _a, _b, _c;
117
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.adminContractHealthRetrieve(limit, offset, options);
118
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
119
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AdminApi.adminContractHealthRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
120
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
121
+ });
122
+ },
123
+ };
124
+ };
125
+ /**
126
+ * AdminApi - factory interface
127
+ */
128
+ export const AdminApiFactory = function (configuration, basePath, axios) {
129
+ const localVarFp = AdminApiFp(configuration);
130
+ return {
131
+ /**
132
+ *
133
+ * @summary Contract Health
134
+ * @param {AdminApiAdminContractHealthRetrieveRequest} requestParameters Request parameters.
135
+ * @param {*} [options] Override http request option.
136
+ * @throws {RequiredError}
137
+ */
138
+ adminContractHealthRetrieve(requestParameters = {}, options) {
139
+ return localVarFp.adminContractHealthRetrieve(requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
140
+ },
141
+ };
142
+ };
143
+ /**
144
+ * AdminApi - object-oriented interface
145
+ */
146
+ export class AdminApi extends BaseAPI {
147
+ /**
148
+ *
149
+ * @summary Contract Health
150
+ * @param {AdminApiAdminContractHealthRetrieveRequest} requestParameters Request parameters.
151
+ * @param {*} [options] Override http request option.
152
+ * @throws {RequiredError}
153
+ */
154
+ adminContractHealthRetrieve(requestParameters = {}, options) {
155
+ return AdminApiFp(this.configuration).adminContractHealthRetrieve(requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
156
+ }
157
+ }
158
+ /**
159
+ * ContractsApi - axios parameter creator
160
+ */
161
+ export const ContractsApiAxiosParamCreator = function (configuration) {
162
+ return {
163
+ /**
164
+ *
165
+ * @summary Content Engagement
166
+ * @param {string} organization_id
167
+ * @param {number} contract_id
168
+ * @param {number} [limit]
169
+ * @param {number} [offset]
170
+ * @param {*} [options] Override http request option.
171
+ * @throws {RequiredError}
172
+ */
173
+ contractsContentEngagementRetrieve: (organization_id_1, contract_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, contract_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, contract_id, limit, offset, options = {}) {
174
+ // verify required parameter 'organization_id' is not null or undefined
175
+ assertParamExists('contractsContentEngagementRetrieve', 'organization_id', organization_id);
176
+ // verify required parameter 'contract_id' is not null or undefined
177
+ assertParamExists('contractsContentEngagementRetrieve', 'contract_id', contract_id);
178
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/contracts/{contract_id}/content-engagement`
179
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)))
180
+ .replace('{contract_id}', encodeURIComponent(String(contract_id)));
181
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
182
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
183
+ let baseOptions;
184
+ if (configuration) {
185
+ baseOptions = configuration.baseOptions;
186
+ }
187
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
188
+ const localVarHeaderParameter = {};
189
+ const localVarQueryParameter = {};
190
+ if (limit !== undefined) {
191
+ localVarQueryParameter['limit'] = limit;
192
+ }
193
+ if (offset !== undefined) {
194
+ localVarQueryParameter['offset'] = offset;
195
+ }
196
+ localVarHeaderParameter['Accept'] = 'application/json';
197
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
198
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
199
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
200
+ return {
201
+ url: toPathString(localVarUrlObj),
202
+ options: localVarRequestOptions,
203
+ };
204
+ }),
205
+ /**
206
+ *
207
+ * @summary Contract Utilization
208
+ * @param {string} organization_id
209
+ * @param {number} contract_id
210
+ * @param {number} [limit]
211
+ * @param {number} [offset]
212
+ * @param {*} [options] Override http request option.
213
+ * @throws {RequiredError}
214
+ */
215
+ contractsContractUtilizationRetrieve: (organization_id_1, contract_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, contract_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, contract_id, limit, offset, options = {}) {
216
+ // verify required parameter 'organization_id' is not null or undefined
217
+ assertParamExists('contractsContractUtilizationRetrieve', 'organization_id', organization_id);
218
+ // verify required parameter 'contract_id' is not null or undefined
219
+ assertParamExists('contractsContractUtilizationRetrieve', 'contract_id', contract_id);
220
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/contracts/{contract_id}/contract-utilization`
221
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)))
222
+ .replace('{contract_id}', encodeURIComponent(String(contract_id)));
223
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
224
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
225
+ let baseOptions;
226
+ if (configuration) {
227
+ baseOptions = configuration.baseOptions;
228
+ }
229
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
230
+ const localVarHeaderParameter = {};
231
+ const localVarQueryParameter = {};
232
+ if (limit !== undefined) {
233
+ localVarQueryParameter['limit'] = limit;
234
+ }
235
+ if (offset !== undefined) {
236
+ localVarQueryParameter['offset'] = offset;
237
+ }
238
+ localVarHeaderParameter['Accept'] = 'application/json';
239
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
240
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
241
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
242
+ return {
243
+ url: toPathString(localVarUrlObj),
244
+ options: localVarRequestOptions,
245
+ };
246
+ }),
247
+ /**
248
+ *
249
+ * @summary Engagement Trend
250
+ * @param {string} organization_id
251
+ * @param {number} contract_id
252
+ * @param {number} [limit]
253
+ * @param {number} [offset]
254
+ * @param {*} [options] Override http request option.
255
+ * @throws {RequiredError}
256
+ */
257
+ contractsEngagementTrendRetrieve: (organization_id_1, contract_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, contract_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, contract_id, limit, offset, options = {}) {
258
+ // verify required parameter 'organization_id' is not null or undefined
259
+ assertParamExists('contractsEngagementTrendRetrieve', 'organization_id', organization_id);
260
+ // verify required parameter 'contract_id' is not null or undefined
261
+ assertParamExists('contractsEngagementTrendRetrieve', 'contract_id', contract_id);
262
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/contracts/{contract_id}/engagement-trend`
263
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)))
264
+ .replace('{contract_id}', encodeURIComponent(String(contract_id)));
265
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
266
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
267
+ let baseOptions;
268
+ if (configuration) {
269
+ baseOptions = configuration.baseOptions;
270
+ }
271
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
272
+ const localVarHeaderParameter = {};
273
+ const localVarQueryParameter = {};
274
+ if (limit !== undefined) {
275
+ localVarQueryParameter['limit'] = limit;
276
+ }
277
+ if (offset !== undefined) {
278
+ localVarQueryParameter['offset'] = offset;
279
+ }
280
+ localVarHeaderParameter['Accept'] = 'application/json';
281
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
282
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
283
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
284
+ return {
285
+ url: toPathString(localVarUrlObj),
286
+ options: localVarRequestOptions,
287
+ };
288
+ }),
289
+ /**
290
+ *
291
+ * @summary Enrollment Funnel
292
+ * @param {string} organization_id
293
+ * @param {number} contract_id
294
+ * @param {number} [limit]
295
+ * @param {number} [offset]
296
+ * @param {*} [options] Override http request option.
297
+ * @throws {RequiredError}
298
+ */
299
+ contractsEnrollmentFunnelRetrieve: (organization_id_1, contract_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, contract_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, contract_id, limit, offset, options = {}) {
300
+ // verify required parameter 'organization_id' is not null or undefined
301
+ assertParamExists('contractsEnrollmentFunnelRetrieve', 'organization_id', organization_id);
302
+ // verify required parameter 'contract_id' is not null or undefined
303
+ assertParamExists('contractsEnrollmentFunnelRetrieve', 'contract_id', contract_id);
304
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/contracts/{contract_id}/enrollment-funnel`
305
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)))
306
+ .replace('{contract_id}', encodeURIComponent(String(contract_id)));
307
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
308
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
309
+ let baseOptions;
310
+ if (configuration) {
311
+ baseOptions = configuration.baseOptions;
312
+ }
313
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
314
+ const localVarHeaderParameter = {};
315
+ const localVarQueryParameter = {};
316
+ if (limit !== undefined) {
317
+ localVarQueryParameter['limit'] = limit;
318
+ }
319
+ if (offset !== undefined) {
320
+ localVarQueryParameter['offset'] = offset;
321
+ }
322
+ localVarHeaderParameter['Accept'] = 'application/json';
323
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
324
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
325
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
326
+ return {
327
+ url: toPathString(localVarUrlObj),
328
+ options: localVarRequestOptions,
329
+ };
330
+ }),
331
+ /**
332
+ *
333
+ * @summary Program Funnel
334
+ * @param {string} organization_id
335
+ * @param {number} contract_id
336
+ * @param {number} [limit]
337
+ * @param {number} [offset]
338
+ * @param {*} [options] Override http request option.
339
+ * @throws {RequiredError}
340
+ */
341
+ contractsProgramFunnelRetrieve: (organization_id_1, contract_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, contract_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, contract_id, limit, offset, options = {}) {
342
+ // verify required parameter 'organization_id' is not null or undefined
343
+ assertParamExists('contractsProgramFunnelRetrieve', 'organization_id', organization_id);
344
+ // verify required parameter 'contract_id' is not null or undefined
345
+ assertParamExists('contractsProgramFunnelRetrieve', 'contract_id', contract_id);
346
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/contracts/{contract_id}/program-funnel`
347
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)))
348
+ .replace('{contract_id}', encodeURIComponent(String(contract_id)));
349
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
350
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
351
+ let baseOptions;
352
+ if (configuration) {
353
+ baseOptions = configuration.baseOptions;
354
+ }
355
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
356
+ const localVarHeaderParameter = {};
357
+ const localVarQueryParameter = {};
358
+ if (limit !== undefined) {
359
+ localVarQueryParameter['limit'] = limit;
360
+ }
361
+ if (offset !== undefined) {
362
+ localVarQueryParameter['offset'] = offset;
363
+ }
364
+ localVarHeaderParameter['Accept'] = 'application/json';
365
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
366
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
367
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
368
+ return {
369
+ url: toPathString(localVarUrlObj),
370
+ options: localVarRequestOptions,
371
+ };
372
+ }),
373
+ };
374
+ };
375
+ /**
376
+ * ContractsApi - functional programming interface
377
+ */
378
+ export const ContractsApiFp = function (configuration) {
379
+ const localVarAxiosParamCreator = ContractsApiAxiosParamCreator(configuration);
380
+ return {
381
+ /**
382
+ *
383
+ * @summary Content Engagement
384
+ * @param {string} organization_id
385
+ * @param {number} contract_id
386
+ * @param {number} [limit]
387
+ * @param {number} [offset]
388
+ * @param {*} [options] Override http request option.
389
+ * @throws {RequiredError}
390
+ */
391
+ contractsContentEngagementRetrieve(organization_id, contract_id, limit, offset, options) {
392
+ return __awaiter(this, void 0, void 0, function* () {
393
+ var _a, _b, _c;
394
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.contractsContentEngagementRetrieve(organization_id, contract_id, limit, offset, options);
395
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
396
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ContractsApi.contractsContentEngagementRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
397
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
398
+ });
399
+ },
400
+ /**
401
+ *
402
+ * @summary Contract Utilization
403
+ * @param {string} organization_id
404
+ * @param {number} contract_id
405
+ * @param {number} [limit]
406
+ * @param {number} [offset]
407
+ * @param {*} [options] Override http request option.
408
+ * @throws {RequiredError}
409
+ */
410
+ contractsContractUtilizationRetrieve(organization_id, contract_id, limit, offset, options) {
411
+ return __awaiter(this, void 0, void 0, function* () {
412
+ var _a, _b, _c;
413
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.contractsContractUtilizationRetrieve(organization_id, contract_id, limit, offset, options);
414
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
415
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ContractsApi.contractsContractUtilizationRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
416
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
417
+ });
418
+ },
419
+ /**
420
+ *
421
+ * @summary Engagement Trend
422
+ * @param {string} organization_id
423
+ * @param {number} contract_id
424
+ * @param {number} [limit]
425
+ * @param {number} [offset]
426
+ * @param {*} [options] Override http request option.
427
+ * @throws {RequiredError}
428
+ */
429
+ contractsEngagementTrendRetrieve(organization_id, contract_id, limit, offset, options) {
430
+ return __awaiter(this, void 0, void 0, function* () {
431
+ var _a, _b, _c;
432
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.contractsEngagementTrendRetrieve(organization_id, contract_id, limit, offset, options);
433
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
434
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ContractsApi.contractsEngagementTrendRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
435
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
436
+ });
437
+ },
438
+ /**
439
+ *
440
+ * @summary Enrollment Funnel
441
+ * @param {string} organization_id
442
+ * @param {number} contract_id
443
+ * @param {number} [limit]
444
+ * @param {number} [offset]
445
+ * @param {*} [options] Override http request option.
446
+ * @throws {RequiredError}
447
+ */
448
+ contractsEnrollmentFunnelRetrieve(organization_id, contract_id, limit, offset, options) {
449
+ return __awaiter(this, void 0, void 0, function* () {
450
+ var _a, _b, _c;
451
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.contractsEnrollmentFunnelRetrieve(organization_id, contract_id, limit, offset, options);
452
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
453
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ContractsApi.contractsEnrollmentFunnelRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
454
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
455
+ });
456
+ },
457
+ /**
458
+ *
459
+ * @summary Program Funnel
460
+ * @param {string} organization_id
461
+ * @param {number} contract_id
462
+ * @param {number} [limit]
463
+ * @param {number} [offset]
464
+ * @param {*} [options] Override http request option.
465
+ * @throws {RequiredError}
466
+ */
467
+ contractsProgramFunnelRetrieve(organization_id, contract_id, limit, offset, options) {
468
+ return __awaiter(this, void 0, void 0, function* () {
469
+ var _a, _b, _c;
470
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.contractsProgramFunnelRetrieve(organization_id, contract_id, limit, offset, options);
471
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
472
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['ContractsApi.contractsProgramFunnelRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
473
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
474
+ });
475
+ },
476
+ };
477
+ };
478
+ /**
479
+ * ContractsApi - factory interface
480
+ */
481
+ export const ContractsApiFactory = function (configuration, basePath, axios) {
482
+ const localVarFp = ContractsApiFp(configuration);
483
+ return {
484
+ /**
485
+ *
486
+ * @summary Content Engagement
487
+ * @param {ContractsApiContractsContentEngagementRetrieveRequest} requestParameters Request parameters.
488
+ * @param {*} [options] Override http request option.
489
+ * @throws {RequiredError}
490
+ */
491
+ contractsContentEngagementRetrieve(requestParameters, options) {
492
+ return localVarFp.contractsContentEngagementRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
493
+ },
494
+ /**
495
+ *
496
+ * @summary Contract Utilization
497
+ * @param {ContractsApiContractsContractUtilizationRetrieveRequest} requestParameters Request parameters.
498
+ * @param {*} [options] Override http request option.
499
+ * @throws {RequiredError}
500
+ */
501
+ contractsContractUtilizationRetrieve(requestParameters, options) {
502
+ return localVarFp.contractsContractUtilizationRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
503
+ },
504
+ /**
505
+ *
506
+ * @summary Engagement Trend
507
+ * @param {ContractsApiContractsEngagementTrendRetrieveRequest} requestParameters Request parameters.
508
+ * @param {*} [options] Override http request option.
509
+ * @throws {RequiredError}
510
+ */
511
+ contractsEngagementTrendRetrieve(requestParameters, options) {
512
+ return localVarFp.contractsEngagementTrendRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
513
+ },
514
+ /**
515
+ *
516
+ * @summary Enrollment Funnel
517
+ * @param {ContractsApiContractsEnrollmentFunnelRetrieveRequest} requestParameters Request parameters.
518
+ * @param {*} [options] Override http request option.
519
+ * @throws {RequiredError}
520
+ */
521
+ contractsEnrollmentFunnelRetrieve(requestParameters, options) {
522
+ return localVarFp.contractsEnrollmentFunnelRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
523
+ },
524
+ /**
525
+ *
526
+ * @summary Program Funnel
527
+ * @param {ContractsApiContractsProgramFunnelRetrieveRequest} requestParameters Request parameters.
528
+ * @param {*} [options] Override http request option.
529
+ * @throws {RequiredError}
530
+ */
531
+ contractsProgramFunnelRetrieve(requestParameters, options) {
532
+ return localVarFp.contractsProgramFunnelRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
533
+ },
534
+ };
535
+ };
536
+ /**
537
+ * ContractsApi - object-oriented interface
538
+ */
539
+ export class ContractsApi extends BaseAPI {
540
+ /**
541
+ *
542
+ * @summary Content Engagement
543
+ * @param {ContractsApiContractsContentEngagementRetrieveRequest} requestParameters Request parameters.
544
+ * @param {*} [options] Override http request option.
545
+ * @throws {RequiredError}
546
+ */
547
+ contractsContentEngagementRetrieve(requestParameters, options) {
548
+ return ContractsApiFp(this.configuration).contractsContentEngagementRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
549
+ }
550
+ /**
551
+ *
552
+ * @summary Contract Utilization
553
+ * @param {ContractsApiContractsContractUtilizationRetrieveRequest} requestParameters Request parameters.
554
+ * @param {*} [options] Override http request option.
555
+ * @throws {RequiredError}
556
+ */
557
+ contractsContractUtilizationRetrieve(requestParameters, options) {
558
+ return ContractsApiFp(this.configuration).contractsContractUtilizationRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
559
+ }
560
+ /**
561
+ *
562
+ * @summary Engagement Trend
563
+ * @param {ContractsApiContractsEngagementTrendRetrieveRequest} requestParameters Request parameters.
564
+ * @param {*} [options] Override http request option.
565
+ * @throws {RequiredError}
566
+ */
567
+ contractsEngagementTrendRetrieve(requestParameters, options) {
568
+ return ContractsApiFp(this.configuration).contractsEngagementTrendRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
569
+ }
570
+ /**
571
+ *
572
+ * @summary Enrollment Funnel
573
+ * @param {ContractsApiContractsEnrollmentFunnelRetrieveRequest} requestParameters Request parameters.
574
+ * @param {*} [options] Override http request option.
575
+ * @throws {RequiredError}
576
+ */
577
+ contractsEnrollmentFunnelRetrieve(requestParameters, options) {
578
+ return ContractsApiFp(this.configuration).contractsEnrollmentFunnelRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
579
+ }
580
+ /**
581
+ *
582
+ * @summary Program Funnel
583
+ * @param {ContractsApiContractsProgramFunnelRetrieveRequest} requestParameters Request parameters.
584
+ * @param {*} [options] Override http request option.
585
+ * @throws {RequiredError}
586
+ */
587
+ contractsProgramFunnelRetrieve(requestParameters, options) {
588
+ return ContractsApiFp(this.configuration).contractsProgramFunnelRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
589
+ }
590
+ }
591
+ /**
592
+ * LearnersApi - axios parameter creator
593
+ */
594
+ export const LearnersApiAxiosParamCreator = function (configuration) {
595
+ return {
596
+ /**
597
+ *
598
+ * @summary Course runs under the contract, for the learner-progress module filter
599
+ * @param {string} organization_id
600
+ * @param {number} contract_id
601
+ * @param {number} [limit]
602
+ * @param {number} [offset]
603
+ * @param {*} [options] Override http request option.
604
+ * @throws {RequiredError}
605
+ */
606
+ learnersCourseRunsRetrieve: (organization_id_1, contract_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, contract_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, contract_id, limit, offset, options = {}) {
607
+ // verify required parameter 'organization_id' is not null or undefined
608
+ assertParamExists('learnersCourseRunsRetrieve', 'organization_id', organization_id);
609
+ // verify required parameter 'contract_id' is not null or undefined
610
+ assertParamExists('learnersCourseRunsRetrieve', 'contract_id', contract_id);
611
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/contracts/{contract_id}/course-runs`
612
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)))
613
+ .replace('{contract_id}', encodeURIComponent(String(contract_id)));
614
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
615
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
616
+ let baseOptions;
617
+ if (configuration) {
618
+ baseOptions = configuration.baseOptions;
619
+ }
620
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
621
+ const localVarHeaderParameter = {};
622
+ const localVarQueryParameter = {};
623
+ if (limit !== undefined) {
624
+ localVarQueryParameter['limit'] = limit;
625
+ }
626
+ if (offset !== undefined) {
627
+ localVarQueryParameter['offset'] = offset;
628
+ }
629
+ localVarHeaderParameter['Accept'] = 'application/json';
630
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
631
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
632
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
633
+ return {
634
+ url: toPathString(localVarUrlObj),
635
+ options: localVarRequestOptions,
636
+ };
637
+ }),
638
+ /**
639
+ * A learner is listed when at least one of their active enrollments matches every filter at once. Their other active enrollments are returned too, whether or not they match. `limit` and `offset` count learners, not enrollments. `completion_status`, `courserun_readable_id` and `needs_attention` narrow together: several values of one filter OR, and different filters AND on a single enrollment.
640
+ * @summary Each learner under the contract with all of their enrollments, paged by learner
641
+ * @param {string} organization_id
642
+ * @param {number} contract_id
643
+ * @param {string | null} [search] Case-insensitive match on email or name.
644
+ * @param {Array<CompletionStatusFilter>} [completion_status] Repeat for several. &#x60;unknown&#x60; selects rows with withheld outcomes.
645
+ * @param {Array<string>} [courserun_readable_id] Repeat for several modules; they OR together and AND with the other filters. At most 50.
646
+ * @param {boolean | null} [needs_attention] Keep only learners with an enrollment that needs attention, or with one that doesn\&#39;t. Rows with withheld outcomes match neither, so omit this to see them.
647
+ * @param {number} [limit]
648
+ * @param {number} [offset]
649
+ * @param {*} [options] Override http request option.
650
+ * @throws {RequiredError}
651
+ */
652
+ learnersList: (organization_id_1, contract_id_1, search_1, completion_status_1, courserun_readable_id_1, needs_attention_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, contract_id_1, search_1, completion_status_1, courserun_readable_id_1, needs_attention_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, contract_id, search, completion_status, courserun_readable_id, needs_attention, limit, offset, options = {}) {
653
+ // verify required parameter 'organization_id' is not null or undefined
654
+ assertParamExists('learnersList', 'organization_id', organization_id);
655
+ // verify required parameter 'contract_id' is not null or undefined
656
+ assertParamExists('learnersList', 'contract_id', contract_id);
657
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/contracts/{contract_id}/learners`
658
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)))
659
+ .replace('{contract_id}', encodeURIComponent(String(contract_id)));
660
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
661
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
662
+ let baseOptions;
663
+ if (configuration) {
664
+ baseOptions = configuration.baseOptions;
665
+ }
666
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
667
+ const localVarHeaderParameter = {};
668
+ const localVarQueryParameter = {};
669
+ if (search !== undefined) {
670
+ localVarQueryParameter['search'] = search;
671
+ }
672
+ if (completion_status) {
673
+ localVarQueryParameter['completion_status'] = completion_status;
674
+ }
675
+ if (courserun_readable_id) {
676
+ localVarQueryParameter['courserun_readable_id'] = courserun_readable_id;
677
+ }
678
+ if (needs_attention !== undefined) {
679
+ localVarQueryParameter['needs_attention'] = needs_attention;
680
+ }
681
+ if (limit !== undefined) {
682
+ localVarQueryParameter['limit'] = limit;
683
+ }
684
+ if (offset !== undefined) {
685
+ localVarQueryParameter['offset'] = offset;
686
+ }
687
+ localVarHeaderParameter['Accept'] = 'application/json';
688
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
689
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
690
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
691
+ return {
692
+ url: toPathString(localVarUrlObj),
693
+ options: localVarRequestOptions,
694
+ };
695
+ }),
696
+ /**
697
+ *
698
+ * @summary Each learner\'s enrollment and completion in each course run under the contract
699
+ * @param {string} organization_id
700
+ * @param {number} contract_id
701
+ * @param {string | null} [search] Case-insensitive match on email or name.
702
+ * @param {Array<CompletionStatusFilter>} [completion_status] Repeat for several. &#x60;unknown&#x60; selects rows with withheld outcomes.
703
+ * @param {string | null} [courserun_readable_id] Exact match. Narrows to one course run, e.g. the module filter.
704
+ * @param {boolean | null} [needs_attention] Keep only the learners who need attention, or only those who don\&#39;t. Cuts the same rows &#x60;needs_attention_count&#x60; counts. Rows with withheld outcomes match neither, so omit this to see them.
705
+ * @param {boolean} [include_inactive] Include deactivated enrollments (unenrolled, refunded).
706
+ * @param {SortKey} [sort]
707
+ * @param {boolean} [descending]
708
+ * @param {number} [limit]
709
+ * @param {number} [offset]
710
+ * @param {*} [options] Override http request option.
711
+ * @throws {RequiredError}
712
+ */
713
+ learnersProgressRetrieve: (organization_id_1, contract_id_1, search_1, completion_status_1, courserun_readable_id_1, needs_attention_1, include_inactive_1, sort_1, descending_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, contract_id_1, search_1, completion_status_1, courserun_readable_id_1, needs_attention_1, include_inactive_1, sort_1, descending_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, contract_id, search, completion_status, courserun_readable_id, needs_attention, include_inactive, sort, descending, limit, offset, options = {}) {
714
+ // verify required parameter 'organization_id' is not null or undefined
715
+ assertParamExists('learnersProgressRetrieve', 'organization_id', organization_id);
716
+ // verify required parameter 'contract_id' is not null or undefined
717
+ assertParamExists('learnersProgressRetrieve', 'contract_id', contract_id);
718
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/contracts/{contract_id}/learner-progress`
719
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)))
720
+ .replace('{contract_id}', encodeURIComponent(String(contract_id)));
721
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
722
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
723
+ let baseOptions;
724
+ if (configuration) {
725
+ baseOptions = configuration.baseOptions;
726
+ }
727
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
728
+ const localVarHeaderParameter = {};
729
+ const localVarQueryParameter = {};
730
+ if (search !== undefined) {
731
+ localVarQueryParameter['search'] = search;
732
+ }
733
+ if (completion_status) {
734
+ localVarQueryParameter['completion_status'] = completion_status;
735
+ }
736
+ if (courserun_readable_id !== undefined) {
737
+ localVarQueryParameter['courserun_readable_id'] = courserun_readable_id;
738
+ }
739
+ if (needs_attention !== undefined) {
740
+ localVarQueryParameter['needs_attention'] = needs_attention;
741
+ }
742
+ if (include_inactive !== undefined) {
743
+ localVarQueryParameter['include_inactive'] = include_inactive;
744
+ }
745
+ if (sort !== undefined) {
746
+ localVarQueryParameter['sort'] = sort;
747
+ }
748
+ if (descending !== undefined) {
749
+ localVarQueryParameter['descending'] = descending;
750
+ }
751
+ if (limit !== undefined) {
752
+ localVarQueryParameter['limit'] = limit;
753
+ }
754
+ if (offset !== undefined) {
755
+ localVarQueryParameter['offset'] = offset;
756
+ }
757
+ localVarHeaderParameter['Accept'] = 'application/json';
758
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
759
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
760
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
761
+ return {
762
+ url: toPathString(localVarUrlObj),
763
+ options: localVarRequestOptions,
764
+ };
765
+ }),
766
+ };
767
+ };
768
+ /**
769
+ * LearnersApi - functional programming interface
770
+ */
771
+ export const LearnersApiFp = function (configuration) {
772
+ const localVarAxiosParamCreator = LearnersApiAxiosParamCreator(configuration);
773
+ return {
774
+ /**
775
+ *
776
+ * @summary Course runs under the contract, for the learner-progress module filter
777
+ * @param {string} organization_id
778
+ * @param {number} contract_id
779
+ * @param {number} [limit]
780
+ * @param {number} [offset]
781
+ * @param {*} [options] Override http request option.
782
+ * @throws {RequiredError}
783
+ */
784
+ learnersCourseRunsRetrieve(organization_id, contract_id, limit, offset, options) {
785
+ return __awaiter(this, void 0, void 0, function* () {
786
+ var _a, _b, _c;
787
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.learnersCourseRunsRetrieve(organization_id, contract_id, limit, offset, options);
788
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
789
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['LearnersApi.learnersCourseRunsRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
790
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
791
+ });
792
+ },
793
+ /**
794
+ * A learner is listed when at least one of their active enrollments matches every filter at once. Their other active enrollments are returned too, whether or not they match. `limit` and `offset` count learners, not enrollments. `completion_status`, `courserun_readable_id` and `needs_attention` narrow together: several values of one filter OR, and different filters AND on a single enrollment.
795
+ * @summary Each learner under the contract with all of their enrollments, paged by learner
796
+ * @param {string} organization_id
797
+ * @param {number} contract_id
798
+ * @param {string | null} [search] Case-insensitive match on email or name.
799
+ * @param {Array<CompletionStatusFilter>} [completion_status] Repeat for several. &#x60;unknown&#x60; selects rows with withheld outcomes.
800
+ * @param {Array<string>} [courserun_readable_id] Repeat for several modules; they OR together and AND with the other filters. At most 50.
801
+ * @param {boolean | null} [needs_attention] Keep only learners with an enrollment that needs attention, or with one that doesn\&#39;t. Rows with withheld outcomes match neither, so omit this to see them.
802
+ * @param {number} [limit]
803
+ * @param {number} [offset]
804
+ * @param {*} [options] Override http request option.
805
+ * @throws {RequiredError}
806
+ */
807
+ learnersList(organization_id, contract_id, search, completion_status, courserun_readable_id, needs_attention, limit, offset, options) {
808
+ return __awaiter(this, void 0, void 0, function* () {
809
+ var _a, _b, _c;
810
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.learnersList(organization_id, contract_id, search, completion_status, courserun_readable_id, needs_attention, limit, offset, options);
811
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
812
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['LearnersApi.learnersList']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
813
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
814
+ });
815
+ },
816
+ /**
817
+ *
818
+ * @summary Each learner\'s enrollment and completion in each course run under the contract
819
+ * @param {string} organization_id
820
+ * @param {number} contract_id
821
+ * @param {string | null} [search] Case-insensitive match on email or name.
822
+ * @param {Array<CompletionStatusFilter>} [completion_status] Repeat for several. &#x60;unknown&#x60; selects rows with withheld outcomes.
823
+ * @param {string | null} [courserun_readable_id] Exact match. Narrows to one course run, e.g. the module filter.
824
+ * @param {boolean | null} [needs_attention] Keep only the learners who need attention, or only those who don\&#39;t. Cuts the same rows &#x60;needs_attention_count&#x60; counts. Rows with withheld outcomes match neither, so omit this to see them.
825
+ * @param {boolean} [include_inactive] Include deactivated enrollments (unenrolled, refunded).
826
+ * @param {SortKey} [sort]
827
+ * @param {boolean} [descending]
828
+ * @param {number} [limit]
829
+ * @param {number} [offset]
830
+ * @param {*} [options] Override http request option.
831
+ * @throws {RequiredError}
832
+ */
833
+ learnersProgressRetrieve(organization_id, contract_id, search, completion_status, courserun_readable_id, needs_attention, include_inactive, sort, descending, limit, offset, options) {
834
+ return __awaiter(this, void 0, void 0, function* () {
835
+ var _a, _b, _c;
836
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.learnersProgressRetrieve(organization_id, contract_id, search, completion_status, courserun_readable_id, needs_attention, include_inactive, sort, descending, limit, offset, options);
837
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
838
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['LearnersApi.learnersProgressRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
839
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
840
+ });
841
+ },
842
+ };
843
+ };
844
+ /**
845
+ * LearnersApi - factory interface
846
+ */
847
+ export const LearnersApiFactory = function (configuration, basePath, axios) {
848
+ const localVarFp = LearnersApiFp(configuration);
849
+ return {
850
+ /**
851
+ *
852
+ * @summary Course runs under the contract, for the learner-progress module filter
853
+ * @param {LearnersApiLearnersCourseRunsRetrieveRequest} requestParameters Request parameters.
854
+ * @param {*} [options] Override http request option.
855
+ * @throws {RequiredError}
856
+ */
857
+ learnersCourseRunsRetrieve(requestParameters, options) {
858
+ return localVarFp.learnersCourseRunsRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
859
+ },
860
+ /**
861
+ * A learner is listed when at least one of their active enrollments matches every filter at once. Their other active enrollments are returned too, whether or not they match. `limit` and `offset` count learners, not enrollments. `completion_status`, `courserun_readable_id` and `needs_attention` narrow together: several values of one filter OR, and different filters AND on a single enrollment.
862
+ * @summary Each learner under the contract with all of their enrollments, paged by learner
863
+ * @param {LearnersApiLearnersListRequest} requestParameters Request parameters.
864
+ * @param {*} [options] Override http request option.
865
+ * @throws {RequiredError}
866
+ */
867
+ learnersList(requestParameters, options) {
868
+ return localVarFp.learnersList(requestParameters.organization_id, requestParameters.contract_id, requestParameters.search, requestParameters.completion_status, requestParameters.courserun_readable_id, requestParameters.needs_attention, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
869
+ },
870
+ /**
871
+ *
872
+ * @summary Each learner\'s enrollment and completion in each course run under the contract
873
+ * @param {LearnersApiLearnersProgressRetrieveRequest} requestParameters Request parameters.
874
+ * @param {*} [options] Override http request option.
875
+ * @throws {RequiredError}
876
+ */
877
+ learnersProgressRetrieve(requestParameters, options) {
878
+ return localVarFp.learnersProgressRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.search, requestParameters.completion_status, requestParameters.courserun_readable_id, requestParameters.needs_attention, requestParameters.include_inactive, requestParameters.sort, requestParameters.descending, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
879
+ },
880
+ };
881
+ };
882
+ /**
883
+ * LearnersApi - object-oriented interface
884
+ */
885
+ export class LearnersApi extends BaseAPI {
886
+ /**
887
+ *
888
+ * @summary Course runs under the contract, for the learner-progress module filter
889
+ * @param {LearnersApiLearnersCourseRunsRetrieveRequest} requestParameters Request parameters.
890
+ * @param {*} [options] Override http request option.
891
+ * @throws {RequiredError}
892
+ */
893
+ learnersCourseRunsRetrieve(requestParameters, options) {
894
+ return LearnersApiFp(this.configuration).learnersCourseRunsRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
895
+ }
896
+ /**
897
+ * A learner is listed when at least one of their active enrollments matches every filter at once. Their other active enrollments are returned too, whether or not they match. `limit` and `offset` count learners, not enrollments. `completion_status`, `courserun_readable_id` and `needs_attention` narrow together: several values of one filter OR, and different filters AND on a single enrollment.
898
+ * @summary Each learner under the contract with all of their enrollments, paged by learner
899
+ * @param {LearnersApiLearnersListRequest} requestParameters Request parameters.
900
+ * @param {*} [options] Override http request option.
901
+ * @throws {RequiredError}
902
+ */
903
+ learnersList(requestParameters, options) {
904
+ return LearnersApiFp(this.configuration).learnersList(requestParameters.organization_id, requestParameters.contract_id, requestParameters.search, requestParameters.completion_status, requestParameters.courserun_readable_id, requestParameters.needs_attention, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
905
+ }
906
+ /**
907
+ *
908
+ * @summary Each learner\'s enrollment and completion in each course run under the contract
909
+ * @param {LearnersApiLearnersProgressRetrieveRequest} requestParameters Request parameters.
910
+ * @param {*} [options] Override http request option.
911
+ * @throws {RequiredError}
912
+ */
913
+ learnersProgressRetrieve(requestParameters, options) {
914
+ return LearnersApiFp(this.configuration).learnersProgressRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.search, requestParameters.completion_status, requestParameters.courserun_readable_id, requestParameters.needs_attention, requestParameters.include_inactive, requestParameters.sort, requestParameters.descending, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
915
+ }
916
+ }
917
+ /**
918
+ * NeedsAttentionApi - axios parameter creator
919
+ */
920
+ export const NeedsAttentionApiAxiosParamCreator = function (configuration) {
921
+ return {
922
+ /**
923
+ *
924
+ * @summary Learners who may need a nudge, counted once each, per contract
925
+ * @param {string} organization_id
926
+ * @param {number} contract_id
927
+ * @param {number} [limit]
928
+ * @param {number} [offset]
929
+ * @param {*} [options] Override http request option.
930
+ * @throws {RequiredError}
931
+ */
932
+ contractsNeedsAttentionRetrieve: (organization_id_1, contract_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, contract_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, contract_id, limit, offset, options = {}) {
933
+ // verify required parameter 'organization_id' is not null or undefined
934
+ assertParamExists('contractsNeedsAttentionRetrieve', 'organization_id', organization_id);
935
+ // verify required parameter 'contract_id' is not null or undefined
936
+ assertParamExists('contractsNeedsAttentionRetrieve', 'contract_id', contract_id);
937
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/contracts/{contract_id}/needs-attention`
938
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)))
939
+ .replace('{contract_id}', encodeURIComponent(String(contract_id)));
940
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
941
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
942
+ let baseOptions;
943
+ if (configuration) {
944
+ baseOptions = configuration.baseOptions;
945
+ }
946
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
947
+ const localVarHeaderParameter = {};
948
+ const localVarQueryParameter = {};
949
+ if (limit !== undefined) {
950
+ localVarQueryParameter['limit'] = limit;
951
+ }
952
+ if (offset !== undefined) {
953
+ localVarQueryParameter['offset'] = offset;
954
+ }
955
+ localVarHeaderParameter['Accept'] = 'application/json';
956
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
957
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
958
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
959
+ return {
960
+ url: toPathString(localVarUrlObj),
961
+ options: localVarRequestOptions,
962
+ };
963
+ }),
964
+ /**
965
+ *
966
+ * @summary Learners who may need a nudge, counted once each, per contract
967
+ * @param {string} organization_id
968
+ * @param {number} [limit]
969
+ * @param {number} [offset]
970
+ * @param {*} [options] Override http request option.
971
+ * @throws {RequiredError}
972
+ */
973
+ organizationsNeedsAttentionRetrieve: (organization_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, limit, offset, options = {}) {
974
+ // verify required parameter 'organization_id' is not null or undefined
975
+ assertParamExists('organizationsNeedsAttentionRetrieve', 'organization_id', organization_id);
976
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/needs-attention`
977
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)));
978
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
979
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
980
+ let baseOptions;
981
+ if (configuration) {
982
+ baseOptions = configuration.baseOptions;
983
+ }
984
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
985
+ const localVarHeaderParameter = {};
986
+ const localVarQueryParameter = {};
987
+ if (limit !== undefined) {
988
+ localVarQueryParameter['limit'] = limit;
989
+ }
990
+ if (offset !== undefined) {
991
+ localVarQueryParameter['offset'] = offset;
992
+ }
993
+ localVarHeaderParameter['Accept'] = 'application/json';
994
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
995
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
996
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
997
+ return {
998
+ url: toPathString(localVarUrlObj),
999
+ options: localVarRequestOptions,
1000
+ };
1001
+ }),
1002
+ };
1003
+ };
1004
+ /**
1005
+ * NeedsAttentionApi - functional programming interface
1006
+ */
1007
+ export const NeedsAttentionApiFp = function (configuration) {
1008
+ const localVarAxiosParamCreator = NeedsAttentionApiAxiosParamCreator(configuration);
1009
+ return {
1010
+ /**
1011
+ *
1012
+ * @summary Learners who may need a nudge, counted once each, per contract
1013
+ * @param {string} organization_id
1014
+ * @param {number} contract_id
1015
+ * @param {number} [limit]
1016
+ * @param {number} [offset]
1017
+ * @param {*} [options] Override http request option.
1018
+ * @throws {RequiredError}
1019
+ */
1020
+ contractsNeedsAttentionRetrieve(organization_id, contract_id, limit, offset, options) {
1021
+ return __awaiter(this, void 0, void 0, function* () {
1022
+ var _a, _b, _c;
1023
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.contractsNeedsAttentionRetrieve(organization_id, contract_id, limit, offset, options);
1024
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1025
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NeedsAttentionApi.contractsNeedsAttentionRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1026
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1027
+ });
1028
+ },
1029
+ /**
1030
+ *
1031
+ * @summary Learners who may need a nudge, counted once each, per contract
1032
+ * @param {string} organization_id
1033
+ * @param {number} [limit]
1034
+ * @param {number} [offset]
1035
+ * @param {*} [options] Override http request option.
1036
+ * @throws {RequiredError}
1037
+ */
1038
+ organizationsNeedsAttentionRetrieve(organization_id, limit, offset, options) {
1039
+ return __awaiter(this, void 0, void 0, function* () {
1040
+ var _a, _b, _c;
1041
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.organizationsNeedsAttentionRetrieve(organization_id, limit, offset, options);
1042
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1043
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['NeedsAttentionApi.organizationsNeedsAttentionRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1044
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1045
+ });
1046
+ },
1047
+ };
1048
+ };
1049
+ /**
1050
+ * NeedsAttentionApi - factory interface
1051
+ */
1052
+ export const NeedsAttentionApiFactory = function (configuration, basePath, axios) {
1053
+ const localVarFp = NeedsAttentionApiFp(configuration);
1054
+ return {
1055
+ /**
1056
+ *
1057
+ * @summary Learners who may need a nudge, counted once each, per contract
1058
+ * @param {NeedsAttentionApiContractsNeedsAttentionRetrieveRequest} requestParameters Request parameters.
1059
+ * @param {*} [options] Override http request option.
1060
+ * @throws {RequiredError}
1061
+ */
1062
+ contractsNeedsAttentionRetrieve(requestParameters, options) {
1063
+ return localVarFp.contractsNeedsAttentionRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
1064
+ },
1065
+ /**
1066
+ *
1067
+ * @summary Learners who may need a nudge, counted once each, per contract
1068
+ * @param {NeedsAttentionApiOrganizationsNeedsAttentionRetrieveRequest} requestParameters Request parameters.
1069
+ * @param {*} [options] Override http request option.
1070
+ * @throws {RequiredError}
1071
+ */
1072
+ organizationsNeedsAttentionRetrieve(requestParameters, options) {
1073
+ return localVarFp.organizationsNeedsAttentionRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
1074
+ },
1075
+ };
1076
+ };
1077
+ /**
1078
+ * NeedsAttentionApi - object-oriented interface
1079
+ */
1080
+ export class NeedsAttentionApi extends BaseAPI {
1081
+ /**
1082
+ *
1083
+ * @summary Learners who may need a nudge, counted once each, per contract
1084
+ * @param {NeedsAttentionApiContractsNeedsAttentionRetrieveRequest} requestParameters Request parameters.
1085
+ * @param {*} [options] Override http request option.
1086
+ * @throws {RequiredError}
1087
+ */
1088
+ contractsNeedsAttentionRetrieve(requestParameters, options) {
1089
+ return NeedsAttentionApiFp(this.configuration).contractsNeedsAttentionRetrieve(requestParameters.organization_id, requestParameters.contract_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
1090
+ }
1091
+ /**
1092
+ *
1093
+ * @summary Learners who may need a nudge, counted once each, per contract
1094
+ * @param {NeedsAttentionApiOrganizationsNeedsAttentionRetrieveRequest} requestParameters Request parameters.
1095
+ * @param {*} [options] Override http request option.
1096
+ * @throws {RequiredError}
1097
+ */
1098
+ organizationsNeedsAttentionRetrieve(requestParameters, options) {
1099
+ return NeedsAttentionApiFp(this.configuration).organizationsNeedsAttentionRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
1100
+ }
1101
+ }
1102
+ /**
1103
+ * OrganizationsApi - axios parameter creator
1104
+ */
1105
+ export const OrganizationsApiAxiosParamCreator = function (configuration) {
1106
+ return {
1107
+ /**
1108
+ *
1109
+ * @summary Content Engagement
1110
+ * @param {string} organization_id
1111
+ * @param {number} [limit]
1112
+ * @param {number} [offset]
1113
+ * @param {*} [options] Override http request option.
1114
+ * @throws {RequiredError}
1115
+ */
1116
+ organizationsContentEngagementRetrieve: (organization_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, limit, offset, options = {}) {
1117
+ // verify required parameter 'organization_id' is not null or undefined
1118
+ assertParamExists('organizationsContentEngagementRetrieve', 'organization_id', organization_id);
1119
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/content-engagement`
1120
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)));
1121
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1122
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1123
+ let baseOptions;
1124
+ if (configuration) {
1125
+ baseOptions = configuration.baseOptions;
1126
+ }
1127
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1128
+ const localVarHeaderParameter = {};
1129
+ const localVarQueryParameter = {};
1130
+ if (limit !== undefined) {
1131
+ localVarQueryParameter['limit'] = limit;
1132
+ }
1133
+ if (offset !== undefined) {
1134
+ localVarQueryParameter['offset'] = offset;
1135
+ }
1136
+ localVarHeaderParameter['Accept'] = 'application/json';
1137
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1138
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1139
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1140
+ return {
1141
+ url: toPathString(localVarUrlObj),
1142
+ options: localVarRequestOptions,
1143
+ };
1144
+ }),
1145
+ /**
1146
+ *
1147
+ * @summary Contract Utilization
1148
+ * @param {string} organization_id
1149
+ * @param {number} [limit]
1150
+ * @param {number} [offset]
1151
+ * @param {*} [options] Override http request option.
1152
+ * @throws {RequiredError}
1153
+ */
1154
+ organizationsContractUtilizationRetrieve: (organization_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, limit, offset, options = {}) {
1155
+ // verify required parameter 'organization_id' is not null or undefined
1156
+ assertParamExists('organizationsContractUtilizationRetrieve', 'organization_id', organization_id);
1157
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/contract-utilization`
1158
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)));
1159
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1160
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1161
+ let baseOptions;
1162
+ if (configuration) {
1163
+ baseOptions = configuration.baseOptions;
1164
+ }
1165
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1166
+ const localVarHeaderParameter = {};
1167
+ const localVarQueryParameter = {};
1168
+ if (limit !== undefined) {
1169
+ localVarQueryParameter['limit'] = limit;
1170
+ }
1171
+ if (offset !== undefined) {
1172
+ localVarQueryParameter['offset'] = offset;
1173
+ }
1174
+ localVarHeaderParameter['Accept'] = 'application/json';
1175
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1176
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1177
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1178
+ return {
1179
+ url: toPathString(localVarUrlObj),
1180
+ options: localVarRequestOptions,
1181
+ };
1182
+ }),
1183
+ /**
1184
+ *
1185
+ * @summary Engagement Trend
1186
+ * @param {string} organization_id
1187
+ * @param {number} [limit]
1188
+ * @param {number} [offset]
1189
+ * @param {*} [options] Override http request option.
1190
+ * @throws {RequiredError}
1191
+ */
1192
+ organizationsEngagementTrendRetrieve: (organization_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, limit, offset, options = {}) {
1193
+ // verify required parameter 'organization_id' is not null or undefined
1194
+ assertParamExists('organizationsEngagementTrendRetrieve', 'organization_id', organization_id);
1195
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/engagement-trend`
1196
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)));
1197
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1198
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1199
+ let baseOptions;
1200
+ if (configuration) {
1201
+ baseOptions = configuration.baseOptions;
1202
+ }
1203
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1204
+ const localVarHeaderParameter = {};
1205
+ const localVarQueryParameter = {};
1206
+ if (limit !== undefined) {
1207
+ localVarQueryParameter['limit'] = limit;
1208
+ }
1209
+ if (offset !== undefined) {
1210
+ localVarQueryParameter['offset'] = offset;
1211
+ }
1212
+ localVarHeaderParameter['Accept'] = 'application/json';
1213
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1214
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1215
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1216
+ return {
1217
+ url: toPathString(localVarUrlObj),
1218
+ options: localVarRequestOptions,
1219
+ };
1220
+ }),
1221
+ /**
1222
+ *
1223
+ * @summary Enrollment Funnel
1224
+ * @param {string} organization_id
1225
+ * @param {number} [limit]
1226
+ * @param {number} [offset]
1227
+ * @param {*} [options] Override http request option.
1228
+ * @throws {RequiredError}
1229
+ */
1230
+ organizationsEnrollmentFunnelRetrieve: (organization_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, limit, offset, options = {}) {
1231
+ // verify required parameter 'organization_id' is not null or undefined
1232
+ assertParamExists('organizationsEnrollmentFunnelRetrieve', 'organization_id', organization_id);
1233
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/enrollment-funnel`
1234
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)));
1235
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1236
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1237
+ let baseOptions;
1238
+ if (configuration) {
1239
+ baseOptions = configuration.baseOptions;
1240
+ }
1241
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1242
+ const localVarHeaderParameter = {};
1243
+ const localVarQueryParameter = {};
1244
+ if (limit !== undefined) {
1245
+ localVarQueryParameter['limit'] = limit;
1246
+ }
1247
+ if (offset !== undefined) {
1248
+ localVarQueryParameter['offset'] = offset;
1249
+ }
1250
+ localVarHeaderParameter['Accept'] = 'application/json';
1251
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1252
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1253
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1254
+ return {
1255
+ url: toPathString(localVarUrlObj),
1256
+ options: localVarRequestOptions,
1257
+ };
1258
+ }),
1259
+ /**
1260
+ *
1261
+ * @summary Program Funnel
1262
+ * @param {string} organization_id
1263
+ * @param {number} [limit]
1264
+ * @param {number} [offset]
1265
+ * @param {*} [options] Override http request option.
1266
+ * @throws {RequiredError}
1267
+ */
1268
+ organizationsProgramFunnelRetrieve: (organization_id_1, limit_1, offset_1, ...args_1) => __awaiter(this, [organization_id_1, limit_1, offset_1, ...args_1], void 0, function* (organization_id, limit, offset, options = {}) {
1269
+ // verify required parameter 'organization_id' is not null or undefined
1270
+ assertParamExists('organizationsProgramFunnelRetrieve', 'organization_id', organization_id);
1271
+ const localVarPath = `/api/v1/analytics/organizations/{organization_id}/program-funnel`
1272
+ .replace('{organization_id}', encodeURIComponent(String(organization_id)));
1273
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
1274
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
1275
+ let baseOptions;
1276
+ if (configuration) {
1277
+ baseOptions = configuration.baseOptions;
1278
+ }
1279
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
1280
+ const localVarHeaderParameter = {};
1281
+ const localVarQueryParameter = {};
1282
+ if (limit !== undefined) {
1283
+ localVarQueryParameter['limit'] = limit;
1284
+ }
1285
+ if (offset !== undefined) {
1286
+ localVarQueryParameter['offset'] = offset;
1287
+ }
1288
+ localVarHeaderParameter['Accept'] = 'application/json';
1289
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
1290
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
1291
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
1292
+ return {
1293
+ url: toPathString(localVarUrlObj),
1294
+ options: localVarRequestOptions,
1295
+ };
1296
+ }),
1297
+ };
1298
+ };
1299
+ /**
1300
+ * OrganizationsApi - functional programming interface
1301
+ */
1302
+ export const OrganizationsApiFp = function (configuration) {
1303
+ const localVarAxiosParamCreator = OrganizationsApiAxiosParamCreator(configuration);
1304
+ return {
1305
+ /**
1306
+ *
1307
+ * @summary Content Engagement
1308
+ * @param {string} organization_id
1309
+ * @param {number} [limit]
1310
+ * @param {number} [offset]
1311
+ * @param {*} [options] Override http request option.
1312
+ * @throws {RequiredError}
1313
+ */
1314
+ organizationsContentEngagementRetrieve(organization_id, limit, offset, options) {
1315
+ return __awaiter(this, void 0, void 0, function* () {
1316
+ var _a, _b, _c;
1317
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.organizationsContentEngagementRetrieve(organization_id, limit, offset, options);
1318
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1319
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationsApi.organizationsContentEngagementRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1320
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1321
+ });
1322
+ },
1323
+ /**
1324
+ *
1325
+ * @summary Contract Utilization
1326
+ * @param {string} organization_id
1327
+ * @param {number} [limit]
1328
+ * @param {number} [offset]
1329
+ * @param {*} [options] Override http request option.
1330
+ * @throws {RequiredError}
1331
+ */
1332
+ organizationsContractUtilizationRetrieve(organization_id, limit, offset, options) {
1333
+ return __awaiter(this, void 0, void 0, function* () {
1334
+ var _a, _b, _c;
1335
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.organizationsContractUtilizationRetrieve(organization_id, limit, offset, options);
1336
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1337
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationsApi.organizationsContractUtilizationRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1338
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1339
+ });
1340
+ },
1341
+ /**
1342
+ *
1343
+ * @summary Engagement Trend
1344
+ * @param {string} organization_id
1345
+ * @param {number} [limit]
1346
+ * @param {number} [offset]
1347
+ * @param {*} [options] Override http request option.
1348
+ * @throws {RequiredError}
1349
+ */
1350
+ organizationsEngagementTrendRetrieve(organization_id, limit, offset, options) {
1351
+ return __awaiter(this, void 0, void 0, function* () {
1352
+ var _a, _b, _c;
1353
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.organizationsEngagementTrendRetrieve(organization_id, limit, offset, options);
1354
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1355
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationsApi.organizationsEngagementTrendRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1356
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1357
+ });
1358
+ },
1359
+ /**
1360
+ *
1361
+ * @summary Enrollment Funnel
1362
+ * @param {string} organization_id
1363
+ * @param {number} [limit]
1364
+ * @param {number} [offset]
1365
+ * @param {*} [options] Override http request option.
1366
+ * @throws {RequiredError}
1367
+ */
1368
+ organizationsEnrollmentFunnelRetrieve(organization_id, limit, offset, options) {
1369
+ return __awaiter(this, void 0, void 0, function* () {
1370
+ var _a, _b, _c;
1371
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.organizationsEnrollmentFunnelRetrieve(organization_id, limit, offset, options);
1372
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1373
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationsApi.organizationsEnrollmentFunnelRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1374
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1375
+ });
1376
+ },
1377
+ /**
1378
+ *
1379
+ * @summary Program Funnel
1380
+ * @param {string} organization_id
1381
+ * @param {number} [limit]
1382
+ * @param {number} [offset]
1383
+ * @param {*} [options] Override http request option.
1384
+ * @throws {RequiredError}
1385
+ */
1386
+ organizationsProgramFunnelRetrieve(organization_id, limit, offset, options) {
1387
+ return __awaiter(this, void 0, void 0, function* () {
1388
+ var _a, _b, _c;
1389
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.organizationsProgramFunnelRetrieve(organization_id, limit, offset, options);
1390
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
1391
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['OrganizationsApi.organizationsProgramFunnelRetrieve']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
1392
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
1393
+ });
1394
+ },
1395
+ };
1396
+ };
1397
+ /**
1398
+ * OrganizationsApi - factory interface
1399
+ */
1400
+ export const OrganizationsApiFactory = function (configuration, basePath, axios) {
1401
+ const localVarFp = OrganizationsApiFp(configuration);
1402
+ return {
1403
+ /**
1404
+ *
1405
+ * @summary Content Engagement
1406
+ * @param {OrganizationsApiOrganizationsContentEngagementRetrieveRequest} requestParameters Request parameters.
1407
+ * @param {*} [options] Override http request option.
1408
+ * @throws {RequiredError}
1409
+ */
1410
+ organizationsContentEngagementRetrieve(requestParameters, options) {
1411
+ return localVarFp.organizationsContentEngagementRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
1412
+ },
1413
+ /**
1414
+ *
1415
+ * @summary Contract Utilization
1416
+ * @param {OrganizationsApiOrganizationsContractUtilizationRetrieveRequest} requestParameters Request parameters.
1417
+ * @param {*} [options] Override http request option.
1418
+ * @throws {RequiredError}
1419
+ */
1420
+ organizationsContractUtilizationRetrieve(requestParameters, options) {
1421
+ return localVarFp.organizationsContractUtilizationRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
1422
+ },
1423
+ /**
1424
+ *
1425
+ * @summary Engagement Trend
1426
+ * @param {OrganizationsApiOrganizationsEngagementTrendRetrieveRequest} requestParameters Request parameters.
1427
+ * @param {*} [options] Override http request option.
1428
+ * @throws {RequiredError}
1429
+ */
1430
+ organizationsEngagementTrendRetrieve(requestParameters, options) {
1431
+ return localVarFp.organizationsEngagementTrendRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
1432
+ },
1433
+ /**
1434
+ *
1435
+ * @summary Enrollment Funnel
1436
+ * @param {OrganizationsApiOrganizationsEnrollmentFunnelRetrieveRequest} requestParameters Request parameters.
1437
+ * @param {*} [options] Override http request option.
1438
+ * @throws {RequiredError}
1439
+ */
1440
+ organizationsEnrollmentFunnelRetrieve(requestParameters, options) {
1441
+ return localVarFp.organizationsEnrollmentFunnelRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
1442
+ },
1443
+ /**
1444
+ *
1445
+ * @summary Program Funnel
1446
+ * @param {OrganizationsApiOrganizationsProgramFunnelRetrieveRequest} requestParameters Request parameters.
1447
+ * @param {*} [options] Override http request option.
1448
+ * @throws {RequiredError}
1449
+ */
1450
+ organizationsProgramFunnelRetrieve(requestParameters, options) {
1451
+ return localVarFp.organizationsProgramFunnelRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(axios, basePath));
1452
+ },
1453
+ };
1454
+ };
1455
+ /**
1456
+ * OrganizationsApi - object-oriented interface
1457
+ */
1458
+ export class OrganizationsApi extends BaseAPI {
1459
+ /**
1460
+ *
1461
+ * @summary Content Engagement
1462
+ * @param {OrganizationsApiOrganizationsContentEngagementRetrieveRequest} requestParameters Request parameters.
1463
+ * @param {*} [options] Override http request option.
1464
+ * @throws {RequiredError}
1465
+ */
1466
+ organizationsContentEngagementRetrieve(requestParameters, options) {
1467
+ return OrganizationsApiFp(this.configuration).organizationsContentEngagementRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
1468
+ }
1469
+ /**
1470
+ *
1471
+ * @summary Contract Utilization
1472
+ * @param {OrganizationsApiOrganizationsContractUtilizationRetrieveRequest} requestParameters Request parameters.
1473
+ * @param {*} [options] Override http request option.
1474
+ * @throws {RequiredError}
1475
+ */
1476
+ organizationsContractUtilizationRetrieve(requestParameters, options) {
1477
+ return OrganizationsApiFp(this.configuration).organizationsContractUtilizationRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
1478
+ }
1479
+ /**
1480
+ *
1481
+ * @summary Engagement Trend
1482
+ * @param {OrganizationsApiOrganizationsEngagementTrendRetrieveRequest} requestParameters Request parameters.
1483
+ * @param {*} [options] Override http request option.
1484
+ * @throws {RequiredError}
1485
+ */
1486
+ organizationsEngagementTrendRetrieve(requestParameters, options) {
1487
+ return OrganizationsApiFp(this.configuration).organizationsEngagementTrendRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
1488
+ }
1489
+ /**
1490
+ *
1491
+ * @summary Enrollment Funnel
1492
+ * @param {OrganizationsApiOrganizationsEnrollmentFunnelRetrieveRequest} requestParameters Request parameters.
1493
+ * @param {*} [options] Override http request option.
1494
+ * @throws {RequiredError}
1495
+ */
1496
+ organizationsEnrollmentFunnelRetrieve(requestParameters, options) {
1497
+ return OrganizationsApiFp(this.configuration).organizationsEnrollmentFunnelRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
1498
+ }
1499
+ /**
1500
+ *
1501
+ * @summary Program Funnel
1502
+ * @param {OrganizationsApiOrganizationsProgramFunnelRetrieveRequest} requestParameters Request parameters.
1503
+ * @param {*} [options] Override http request option.
1504
+ * @throws {RequiredError}
1505
+ */
1506
+ organizationsProgramFunnelRetrieve(requestParameters, options) {
1507
+ return OrganizationsApiFp(this.configuration).organizationsProgramFunnelRetrieve(requestParameters.organization_id, requestParameters.limit, requestParameters.offset, options).then((request) => request(this.axios, this.basePath));
1508
+ }
1509
+ }
1510
+ //# sourceMappingURL=api.js.map