@iblai/iblai-api 3.48.3-core → 3.48.4-core

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (63) hide show
  1. package/dist/index.cjs.js +3038 -2750
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +3038 -2750
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +3038 -2750
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/services/AnalyticsService.d.ts +42 -13
  8. package/dist/types/services/AudienceService.d.ts +345 -149
  9. package/dist/types/services/CareerService.d.ts +117 -90
  10. package/dist/types/services/CatalogService.d.ts +3735 -1072
  11. package/dist/types/services/CoreService.d.ts +421 -210
  12. package/dist/types/services/CredentialsService.d.ts +173 -138
  13. package/dist/types/services/DepartmentsService.d.ts +53 -16
  14. package/dist/types/services/EngagementService.d.ts +459 -179
  15. package/dist/types/services/FeaturesService.d.ts +16 -7
  16. package/dist/types/services/FinanceService.d.ts +49 -20
  17. package/dist/types/services/MediaResourcesService.d.ts +243 -67
  18. package/dist/types/services/NotificationBuilderService.d.ts +31 -17
  19. package/dist/types/services/NotificationService.d.ts +56 -49
  20. package/dist/types/services/OrgsService.d.ts +106 -77
  21. package/dist/types/services/OverviewService.d.ts +154 -55
  22. package/dist/types/services/PerformanceService.d.ts +132 -56
  23. package/dist/types/services/PerlearnerService.d.ts +431 -217
  24. package/dist/types/services/PlatformService.d.ts +221 -116
  25. package/dist/types/services/ProviderAssociationService.d.ts +3 -2
  26. package/dist/types/services/ProvidersService.d.ts +27 -18
  27. package/dist/types/services/ProvisionService.d.ts +3 -2
  28. package/dist/types/services/RecommendationsService.d.ts +3 -3
  29. package/dist/types/services/ReportsService.d.ts +22 -16
  30. package/dist/types/services/RolesService.d.ts +8 -6
  31. package/dist/types/services/SearchService.d.ts +305 -80
  32. package/dist/types/services/ServiceService.d.ts +33 -29
  33. package/dist/types/services/SkillsService.d.ts +40 -32
  34. package/dist/types/services/UserGroupsService.d.ts +53 -16
  35. package/package.json +1 -1
  36. package/src/services/AnalyticsService.ts +45 -16
  37. package/src/services/AudienceService.ts +380 -184
  38. package/src/services/CareerService.ts +144 -117
  39. package/src/services/CatalogService.ts +3995 -1332
  40. package/src/services/CoreService.ts +503 -286
  41. package/src/services/CredentialsService.ts +253 -173
  42. package/src/services/DepartmentsService.ts +56 -19
  43. package/src/services/EngagementService.ts +528 -236
  44. package/src/services/FeaturesService.ts +19 -10
  45. package/src/services/FinanceService.ts +54 -25
  46. package/src/services/MediaResourcesService.ts +251 -75
  47. package/src/services/NotificationBuilderService.ts +36 -22
  48. package/src/services/NotificationService.ts +73 -61
  49. package/src/services/OrgsService.ts +135 -106
  50. package/src/services/OverviewService.ts +172 -73
  51. package/src/services/PerformanceService.ts +153 -77
  52. package/src/services/PerlearnerService.ts +591 -279
  53. package/src/services/PlatformService.ts +278 -157
  54. package/src/services/ProviderAssociationService.ts +4 -3
  55. package/src/services/ProvidersService.ts +36 -27
  56. package/src/services/ProvisionService.ts +4 -3
  57. package/src/services/RecommendationsService.ts +5 -4
  58. package/src/services/ReportsService.ts +28 -22
  59. package/src/services/RolesService.ts +10 -8
  60. package/src/services/SearchService.ts +323 -98
  61. package/src/services/ServiceService.ts +49 -39
  62. package/src/services/SkillsService.ts +56 -44
  63. package/src/services/UserGroupsService.ts +56 -19
@@ -12,13 +12,14 @@ export class ProviderAssociationService {
12
12
  * Updates:
13
13
  * - Platform launch state
14
14
  * - Association configuration status
15
- * @param launchId
16
15
  * @returns any
17
16
  * @throws ApiError
18
17
  */
19
- public static providerAssociationStripeCallbackRetrieve(
18
+ public static providerAssociationStripeCallbackRetrieve({
19
+ launchId,
20
+ }: {
20
21
  launchId: string,
21
- ): CancelablePromise<{
22
+ }): CancelablePromise<{
22
23
  message?: string;
23
24
  }> {
24
25
  return __request(OpenAPI, {
@@ -21,13 +21,14 @@ import { request as __request } from '../core/request';
21
21
  export class ProvidersService {
22
22
  /**
23
23
  * Associate an Apple account with a user known user
24
- * @param requestBody
25
24
  * @returns AssociateAccountResponse
26
25
  * @throws ApiError
27
26
  */
28
- public static providersAppleAssociateAccountCreate(
27
+ public static providersAppleAssociateAccountCreate({
28
+ requestBody,
29
+ }: {
29
30
  requestBody: AssociateAppleAccount,
30
- ): CancelablePromise<AssociateAccountResponse> {
31
+ }): CancelablePromise<AssociateAccountResponse> {
31
32
  return __request(OpenAPI, {
32
33
  method: 'POST',
33
34
  url: '/api/providers/apple/associate-account/',
@@ -48,13 +49,14 @@ export class ProvidersService {
48
49
  }
49
50
  /**
50
51
  * Returns information about a user subscription status
51
- * @param requestBody
52
52
  * @returns AppleSubscriptionStatusView
53
53
  * @throws ApiError
54
54
  */
55
- public static providersAppleSubscriptionStatusCreate(
55
+ public static providersAppleSubscriptionStatusCreate({
56
+ requestBody,
57
+ }: {
56
58
  requestBody?: AppleSubscriptionStatusRequest,
57
- ): CancelablePromise<AppleSubscriptionStatusView> {
59
+ }): CancelablePromise<AppleSubscriptionStatusView> {
58
60
  return __request(OpenAPI, {
59
61
  method: 'POST',
60
62
  url: '/api/providers/apple/subscription-status/',
@@ -64,13 +66,14 @@ export class ProvidersService {
64
66
  }
65
67
  /**
66
68
  * Checks if a provided transaction_id is valid
67
- * @param requestBody
68
69
  * @returns BaseResponse
69
70
  * @throws ApiError
70
71
  */
71
- public static providersAppleValidateTransactionIdCreate(
72
+ public static providersAppleValidateTransactionIdCreate({
73
+ requestBody,
74
+ }: {
72
75
  requestBody: AppleVerifyTransactionId,
73
- ): CancelablePromise<BaseResponse> {
76
+ }): CancelablePromise<BaseResponse> {
74
77
  return __request(OpenAPI, {
75
78
  method: 'POST',
76
79
  url: '/api/providers/apple/validate-transaction-id/',
@@ -109,13 +112,14 @@ export class ProvidersService {
109
112
  * We cannot expose launching a tenant to an authorized user hence the need for the API
110
113
  *
111
114
  * The API validates the x_amzn_marketplace_token and then proxies the request to the Platform Launch API
112
- * @param requestBody
113
115
  * @returns TenantLaunchResponse
114
116
  * @throws ApiError
115
117
  */
116
- public static providersAwsLaunchTenantCreate(
118
+ public static providersAwsLaunchTenantCreate({
119
+ requestBody,
120
+ }: {
117
121
  requestBody: AWSTenantLaunchRequest,
118
- ): CancelablePromise<TenantLaunchResponse> {
122
+ }): CancelablePromise<TenantLaunchResponse> {
119
123
  return __request(OpenAPI, {
120
124
  method: 'POST',
121
125
  url: '/api/providers/aws/launch-tenant/',
@@ -164,13 +168,14 @@ export class ProvidersService {
164
168
  *
165
169
  * Set CREATE_ORGANIZATION_URL in GlobalConfigurationFetcher to the URL of the GCP marketplace create organization
166
170
  * page
167
- * @param productId
168
171
  * @returns any No response body
169
172
  * @throws ApiError
170
173
  */
171
- public static providersGcpCreateOrganizationCreate2(
174
+ public static providersGcpCreateOrganizationCreate2({
175
+ productId,
176
+ }: {
172
177
  productId: string,
173
- ): CancelablePromise<any> {
178
+ }): CancelablePromise<any> {
174
179
  return __request(OpenAPI, {
175
180
  method: 'POST',
176
181
  url: '/api/providers/gcp/create-organization/{product_id}/',
@@ -195,13 +200,14 @@ export class ProvidersService {
195
200
  * We cannot expose launching a tenant to an authorized user hence the need for the API
196
201
  *
197
202
  * The API validates the x_gcp_marketplace_token and then proxies the request to the Platform Launc API
198
- * @param requestBody
199
203
  * @returns TenantLaunchResponse
200
204
  * @throws ApiError
201
205
  */
202
- public static providersGcpLaunchTenantCreate(
206
+ public static providersGcpLaunchTenantCreate({
207
+ requestBody,
208
+ }: {
203
209
  requestBody: GCPTenantLaunchRequest,
204
- ): CancelablePromise<TenantLaunchResponse> {
210
+ }): CancelablePromise<TenantLaunchResponse> {
205
211
  return __request(OpenAPI, {
206
212
  method: 'POST',
207
213
  url: '/api/providers/gcp/launch-tenant/',
@@ -210,13 +216,14 @@ export class ProvidersService {
210
216
  });
211
217
  }
212
218
  /**
213
- * @param requestBody
214
219
  * @returns VerifyGCPMarketPlaceResponse
215
220
  * @throws ApiError
216
221
  */
217
- public static providersGcpValidateSignupTokenCreate(
222
+ public static providersGcpValidateSignupTokenCreate({
223
+ requestBody,
224
+ }: {
218
225
  requestBody: VerifyGCPMarketPlaceRequest,
219
- ): CancelablePromise<VerifyGCPMarketPlaceResponse> {
226
+ }): CancelablePromise<VerifyGCPMarketPlaceResponse> {
220
227
  return __request(OpenAPI, {
221
228
  method: 'POST',
222
229
  url: '/api/providers/gcp/validate-signup-token/',
@@ -226,13 +233,14 @@ export class ProvidersService {
226
233
  }
227
234
  /**
228
235
  * Google Allows us to pass an obfuscated account id to be sent to during a subscription purchase
229
- * @param bundleId
230
236
  * @returns GooglePayAccountResponse
231
237
  * @throws ApiError
232
238
  */
233
- public static providersGooglePayGetAccountRetrieve(
239
+ public static providersGooglePayGetAccountRetrieve({
240
+ bundleId,
241
+ }: {
234
242
  bundleId: string,
235
- ): CancelablePromise<GooglePayAccountResponse> {
243
+ }): CancelablePromise<GooglePayAccountResponse> {
236
244
  return __request(OpenAPI, {
237
245
  method: 'GET',
238
246
  url: '/api/providers/google-pay/get-account/{bundle_id}',
@@ -254,13 +262,14 @@ export class ProvidersService {
254
262
  }
255
263
  /**
256
264
  * Associate a Google Pay account with a known user
257
- * @param requestBody
258
265
  * @returns BaseResponse
259
266
  * @throws ApiError
260
267
  */
261
- public static providersGooglePayValidateTransactionIdCreate(
268
+ public static providersGooglePayValidateTransactionIdCreate({
269
+ requestBody,
270
+ }: {
262
271
  requestBody: GooglePayVerifyToken,
263
- ): CancelablePromise<BaseResponse> {
272
+ }): CancelablePromise<BaseResponse> {
264
273
  return __request(OpenAPI, {
265
274
  method: 'POST',
266
275
  url: '/api/providers/google-pay/validate-transaction-id/',
@@ -12,13 +12,14 @@ export class ProvisionService {
12
12
  *
13
13
  * request body:
14
14
  * {"config_name": "demo_config}
15
- * @param configName
16
15
  * @returns any No response body
17
16
  * @throws ApiError
18
17
  */
19
- public static provisionCreate(
18
+ public static provisionCreate({
19
+ configName,
20
+ }: {
20
21
  configName: string,
21
- ): CancelablePromise<any> {
22
+ }): CancelablePromise<any> {
22
23
  return __request(OpenAPI, {
23
24
  method: 'POST',
24
25
  url: '/api/provision/{config_name}/',
@@ -10,15 +10,16 @@ export class RecommendationsService {
10
10
  /**
11
11
  * API endpoint that returns a search api url prepopulated with context data
12
12
  * See http://localhost:8000/api/schema/swagger-ui/#/recommendations
13
- * @param org
14
- * @param userId
15
13
  * @returns RecommendationSearchAPI
16
14
  * @throws ApiError
17
15
  */
18
- public static recommendationsOrgsUsersRetrieve(
16
+ public static recommendationsOrgsUsersRetrieve({
17
+ org,
18
+ userId,
19
+ }: {
19
20
  org: string,
20
21
  userId: string,
21
- ): CancelablePromise<RecommendationSearchAPI> {
22
+ }): CancelablePromise<RecommendationSearchAPI> {
22
23
  return __request(OpenAPI, {
23
24
  method: 'GET',
24
25
  url: '/api/recommendations/orgs/{org}/users/{user_id}/',
@@ -24,13 +24,14 @@ export class ReportsService {
24
24
  *
25
25
  * Returns:
26
26
  * A list of report objects with their metadata and status information.
27
- * @param org
28
27
  * @returns ReportList
29
28
  * @throws ApiError
30
29
  */
31
- public static reportsOrgsRetrieve(
30
+ public static reportsOrgsRetrieve({
31
+ org,
32
+ }: {
32
33
  org: string,
33
- ): CancelablePromise<ReportList> {
34
+ }): CancelablePromise<ReportList> {
34
35
  return __request(OpenAPI, {
35
36
  method: 'GET',
36
37
  url: '/api/reports/orgs/{org}/',
@@ -56,15 +57,16 @@ export class ReportsService {
56
57
  *
57
58
  * Error Responses:
58
59
  * 404 Not Found: If the specified report type doesn't exist
59
- * @param org
60
- * @param reportName
61
60
  * @returns ReportDetail
62
61
  * @throws ApiError
63
62
  */
64
- public static reportsOrgsRetrieve2(
63
+ public static reportsOrgsRetrieve2({
64
+ org,
65
+ reportName,
66
+ }: {
65
67
  org: string,
66
68
  reportName: string,
67
- ): CancelablePromise<ReportDetail> {
69
+ }): CancelablePromise<ReportDetail> {
68
70
  return __request(OpenAPI, {
69
71
  method: 'GET',
70
72
  url: '/api/reports/orgs/{org}/{report_name}',
@@ -116,15 +118,16 @@ export class ReportsService {
116
118
  * 400 Bad Request: Invalid parameters or report configuration
117
119
  * 404 Not Found: Report type not found
118
120
  * 403 Forbidden: User doesn't have permission for the requested report
119
- * @param org
120
- * @param requestBody
121
121
  * @returns ReportCreate
122
122
  * @throws ApiError
123
123
  */
124
- public static reportsOrgsNewCreate(
124
+ public static reportsOrgsNewCreate({
125
+ org,
126
+ requestBody,
127
+ }: {
125
128
  org: string,
126
129
  requestBody?: ReportRequest,
127
- ): CancelablePromise<ReportCreate> {
130
+ }): CancelablePromise<ReportCreate> {
128
131
  return __request(OpenAPI, {
129
132
  method: 'POST',
130
133
  url: '/api/reports/orgs/{org}/new',
@@ -148,13 +151,14 @@ export class ReportsService {
148
151
  * - status: Current status of the report if it has been previously requested
149
152
  *
150
153
  * The status will include details like the report ID, state, and download URL if completed.
151
- * @param key
152
154
  * @returns ReportList
153
155
  * @throws ApiError
154
156
  */
155
- public static reportsPlatformsRetrieve(
157
+ public static reportsPlatformsRetrieve({
158
+ key,
159
+ }: {
156
160
  key: string,
157
- ): CancelablePromise<ReportList> {
161
+ }): CancelablePromise<ReportList> {
158
162
  return __request(OpenAPI, {
159
163
  method: 'GET',
160
164
  url: '/api/reports/platforms/{key}/',
@@ -165,15 +169,16 @@ export class ReportsService {
165
169
  }
166
170
  /**
167
171
  * Returns details of a specific report type including its status if previously requested.
168
- * @param key
169
- * @param reportName
170
172
  * @returns ReportDetail
171
173
  * @throws ApiError
172
174
  */
173
- public static reportsPlatformsRetrieve2(
175
+ public static reportsPlatformsRetrieve2({
176
+ key,
177
+ reportName,
178
+ }: {
174
179
  key: string,
175
180
  reportName: string,
176
- ): CancelablePromise<ReportDetail> {
181
+ }): CancelablePromise<ReportDetail> {
177
182
  return __request(OpenAPI, {
178
183
  method: 'GET',
179
184
  url: '/api/reports/platforms/{key}/{report_name}',
@@ -196,15 +201,16 @@ export class ReportsService {
196
201
  * - force: (optional) Force generation of a new report even if one exists
197
202
  * - filters: (optional) Additional filters for the report
198
203
  * - departments: (optional) Department IDs to filter by
199
- * @param key
200
- * @param requestBody
201
204
  * @returns ReportCreate
202
205
  * @throws ApiError
203
206
  */
204
- public static reportsPlatformsNewCreate(
207
+ public static reportsPlatformsNewCreate({
208
+ key,
209
+ requestBody,
210
+ }: {
205
211
  key: string,
206
212
  requestBody?: ReportRequest,
207
- ): CancelablePromise<ReportCreate> {
213
+ }): CancelablePromise<ReportCreate> {
208
214
  return __request(OpenAPI, {
209
215
  method: 'POST',
210
216
  url: '/api/reports/platforms/{key}/new',
@@ -28,15 +28,16 @@ export class RolesService {
28
28
  * Error Responses:
29
29
  * 400 Bad Request: If the user doesn't exist in the platform or has no desired role
30
30
  * 404 Not Found: If the specified platform doesn't exist
31
- * @param org
32
- * @param username
33
31
  * @returns DesiredRole
34
32
  * @throws ApiError
35
33
  */
36
- public static rolesPlatformOrgsRolesUsersDesiredRolesRetrieve(
34
+ public static rolesPlatformOrgsRolesUsersDesiredRolesRetrieve({
35
+ org,
36
+ username,
37
+ }: {
37
38
  org: string,
38
39
  username: string,
39
- ): CancelablePromise<DesiredRole> {
40
+ }): CancelablePromise<DesiredRole> {
40
41
  return __request(OpenAPI, {
41
42
  method: 'GET',
42
43
  url: '/api/roles/platform/orgs/{org}/roles/users/{username}/desired-roles/',
@@ -66,15 +67,16 @@ export class RolesService {
66
67
  * Error Responses:
67
68
  * 400 Bad Request: If the user doesn't exist in the platform or has no reported role
68
69
  * 404 Not Found: If the specified platform doesn't exist
69
- * @param org
70
- * @param username
71
70
  * @returns ReportedRole
72
71
  * @throws ApiError
73
72
  */
74
- public static rolesPlatformOrgsRolesUsersReportedRolesRetrieve(
73
+ public static rolesPlatformOrgsRolesUsersReportedRolesRetrieve({
74
+ org,
75
+ username,
76
+ }: {
75
77
  org: string,
76
78
  username: string,
77
- ): CancelablePromise<ReportedRole> {
79
+ }): CancelablePromise<ReportedRole> {
78
80
  return __request(OpenAPI, {
79
81
  method: 'GET',
80
82
  url: '/api/roles/platform/orgs/{org}/roles/users/{username}/reported-roles/',