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