@iblai/iblai-api 4.378.2-core → 4.378.3-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.
- package/dist/index.cjs.js +86 -2
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +86 -2
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +86 -2
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +1 -0
- package/dist/types/models/PathwayEnrollmentRequest.d.ts +8 -0
- package/dist/types/models/UserProfileSummary.d.ts +22 -0
- package/dist/types/services/CatalogService.d.ts +115 -12
- package/dist/types/services/CoreService.d.ts +20 -0
- package/package.json +1 -1
- package/sdk_schema.yml +258 -2
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +1 -0
- package/src/models/PathwayEnrollmentRequest.ts +8 -0
- package/src/models/UserProfileSummary.ts +27 -0
- package/src/services/CatalogService.ts +154 -1
- package/src/services/CoreService.ts +37 -0
|
@@ -1862,9 +1862,12 @@ export class CatalogService {
|
|
|
1862
1862
|
* 500 Internal Server Error: If an unexpected error occurs
|
|
1863
1863
|
*
|
|
1864
1864
|
* Access Control:
|
|
1865
|
-
* - Requires IsDMAdmin, IsEdxUserReadOnly,
|
|
1865
|
+
* - Requires IsDMAdmin, IsEdxUserReadOnly, IsPlatformAdminOfUserReadOnly,
|
|
1866
|
+
* or IsWatcherOfUserReadOnly permission
|
|
1866
1867
|
* - Users can view their own enrollments
|
|
1867
1868
|
* - Platform admins can view enrollments for users in their platform
|
|
1869
|
+
* - Watchers can view enrollments for a user they watch, scoped to the
|
|
1870
|
+
* queried user and platform
|
|
1868
1871
|
* - DM admins can view all enrollments
|
|
1869
1872
|
* @returns CourseEnrollmentSearchResponse
|
|
1870
1873
|
* @throws ApiError
|
|
@@ -1874,10 +1877,12 @@ export class CatalogService {
|
|
|
1874
1877
|
courseName,
|
|
1875
1878
|
email,
|
|
1876
1879
|
includeDefaultPlatform,
|
|
1880
|
+
key,
|
|
1877
1881
|
org,
|
|
1878
1882
|
page,
|
|
1879
1883
|
pageSize,
|
|
1880
1884
|
platformKey,
|
|
1885
|
+
platformOrg,
|
|
1881
1886
|
slug,
|
|
1882
1887
|
sort = '-id',
|
|
1883
1888
|
userId,
|
|
@@ -1899,6 +1904,10 @@ export class CatalogService {
|
|
|
1899
1904
|
* Include enrollments from default platform
|
|
1900
1905
|
*/
|
|
1901
1906
|
includeDefaultPlatform?: boolean,
|
|
1907
|
+
/**
|
|
1908
|
+
* Alias of platform_key
|
|
1909
|
+
*/
|
|
1910
|
+
key?: string,
|
|
1902
1911
|
/**
|
|
1903
1912
|
* Filter enrollments by organization
|
|
1904
1913
|
*/
|
|
@@ -1915,6 +1924,10 @@ export class CatalogService {
|
|
|
1915
1924
|
* Filter enrollments by platform key
|
|
1916
1925
|
*/
|
|
1917
1926
|
platformKey?: string,
|
|
1927
|
+
/**
|
|
1928
|
+
* Alias of org
|
|
1929
|
+
*/
|
|
1930
|
+
platformOrg?: string,
|
|
1918
1931
|
/**
|
|
1919
1932
|
* Filter enrollments by course slug
|
|
1920
1933
|
*/
|
|
@@ -1940,10 +1953,12 @@ export class CatalogService {
|
|
|
1940
1953
|
'course_name': courseName,
|
|
1941
1954
|
'email': email,
|
|
1942
1955
|
'include_default_platform': includeDefaultPlatform,
|
|
1956
|
+
'key': key,
|
|
1943
1957
|
'org': org,
|
|
1944
1958
|
'page': page,
|
|
1945
1959
|
'page_size': pageSize,
|
|
1946
1960
|
'platform_key': platformKey,
|
|
1961
|
+
'platform_org': platformOrg,
|
|
1947
1962
|
'slug': slug,
|
|
1948
1963
|
'sort': sort,
|
|
1949
1964
|
'user_id': userId,
|
|
@@ -1960,11 +1975,13 @@ export class CatalogService {
|
|
|
1960
1975
|
active = true,
|
|
1961
1976
|
includeDefaultPlatform,
|
|
1962
1977
|
includeMetadata = true,
|
|
1978
|
+
key,
|
|
1963
1979
|
org,
|
|
1964
1980
|
pathwayId,
|
|
1965
1981
|
pathwayKey,
|
|
1966
1982
|
pathwayUuid,
|
|
1967
1983
|
platformKey,
|
|
1984
|
+
platformOrg,
|
|
1968
1985
|
slug,
|
|
1969
1986
|
userId,
|
|
1970
1987
|
username,
|
|
@@ -1981,6 +1998,10 @@ export class CatalogService {
|
|
|
1981
1998
|
* Include metadata in the response
|
|
1982
1999
|
*/
|
|
1983
2000
|
includeMetadata?: boolean,
|
|
2001
|
+
/**
|
|
2002
|
+
* Alias of platform_key
|
|
2003
|
+
*/
|
|
2004
|
+
key?: string,
|
|
1984
2005
|
/**
|
|
1985
2006
|
* Organization for the pathway
|
|
1986
2007
|
*/
|
|
@@ -2001,6 +2022,10 @@ export class CatalogService {
|
|
|
2001
2022
|
* Platform key for the pathway
|
|
2002
2023
|
*/
|
|
2003
2024
|
platformKey?: string,
|
|
2025
|
+
/**
|
|
2026
|
+
* Alias of org
|
|
2027
|
+
*/
|
|
2028
|
+
platformOrg?: string,
|
|
2004
2029
|
/**
|
|
2005
2030
|
* Pathway slug for enrollment
|
|
2006
2031
|
*/
|
|
@@ -2021,11 +2046,13 @@ export class CatalogService {
|
|
|
2021
2046
|
'active': active,
|
|
2022
2047
|
'include_default_platform': includeDefaultPlatform,
|
|
2023
2048
|
'include_metadata': includeMetadata,
|
|
2049
|
+
'key': key,
|
|
2024
2050
|
'org': org,
|
|
2025
2051
|
'pathway_id': pathwayId,
|
|
2026
2052
|
'pathway_key': pathwayKey,
|
|
2027
2053
|
'pathway_uuid': pathwayUuid,
|
|
2028
2054
|
'platform_key': platformKey,
|
|
2055
|
+
'platform_org': platformOrg,
|
|
2029
2056
|
'slug': slug,
|
|
2030
2057
|
'user_id': userId,
|
|
2031
2058
|
'username': username,
|
|
@@ -2041,11 +2068,13 @@ export class CatalogService {
|
|
|
2041
2068
|
active = true,
|
|
2042
2069
|
includeDefaultPlatform,
|
|
2043
2070
|
includeMetadata = true,
|
|
2071
|
+
key,
|
|
2044
2072
|
org,
|
|
2045
2073
|
pathwayId,
|
|
2046
2074
|
pathwayKey,
|
|
2047
2075
|
pathwayUuid,
|
|
2048
2076
|
platformKey,
|
|
2077
|
+
platformOrg,
|
|
2049
2078
|
slug,
|
|
2050
2079
|
userId,
|
|
2051
2080
|
username,
|
|
@@ -2063,6 +2092,10 @@ export class CatalogService {
|
|
|
2063
2092
|
* Include metadata in the response
|
|
2064
2093
|
*/
|
|
2065
2094
|
includeMetadata?: boolean,
|
|
2095
|
+
/**
|
|
2096
|
+
* Alias of platform_key
|
|
2097
|
+
*/
|
|
2098
|
+
key?: string,
|
|
2066
2099
|
/**
|
|
2067
2100
|
* Organization for the pathway
|
|
2068
2101
|
*/
|
|
@@ -2083,6 +2116,10 @@ export class CatalogService {
|
|
|
2083
2116
|
* Platform key for the pathway
|
|
2084
2117
|
*/
|
|
2085
2118
|
platformKey?: string,
|
|
2119
|
+
/**
|
|
2120
|
+
* Alias of org
|
|
2121
|
+
*/
|
|
2122
|
+
platformOrg?: string,
|
|
2086
2123
|
/**
|
|
2087
2124
|
* Pathway slug for enrollment
|
|
2088
2125
|
*/
|
|
@@ -2104,11 +2141,13 @@ export class CatalogService {
|
|
|
2104
2141
|
'active': active,
|
|
2105
2142
|
'include_default_platform': includeDefaultPlatform,
|
|
2106
2143
|
'include_metadata': includeMetadata,
|
|
2144
|
+
'key': key,
|
|
2107
2145
|
'org': org,
|
|
2108
2146
|
'pathway_id': pathwayId,
|
|
2109
2147
|
'pathway_key': pathwayKey,
|
|
2110
2148
|
'pathway_uuid': pathwayUuid,
|
|
2111
2149
|
'platform_key': platformKey,
|
|
2150
|
+
'platform_org': platformOrg,
|
|
2112
2151
|
'slug': slug,
|
|
2113
2152
|
'user_id': userId,
|
|
2114
2153
|
'username': username,
|
|
@@ -2126,11 +2165,13 @@ export class CatalogService {
|
|
|
2126
2165
|
active = true,
|
|
2127
2166
|
includeDefaultPlatform,
|
|
2128
2167
|
includeMetadata = true,
|
|
2168
|
+
key,
|
|
2129
2169
|
org,
|
|
2130
2170
|
pathwayId,
|
|
2131
2171
|
pathwayKey,
|
|
2132
2172
|
pathwayUuid,
|
|
2133
2173
|
platformKey,
|
|
2174
|
+
platformOrg,
|
|
2134
2175
|
slug,
|
|
2135
2176
|
userId,
|
|
2136
2177
|
username,
|
|
@@ -2147,6 +2188,10 @@ export class CatalogService {
|
|
|
2147
2188
|
* Include metadata in the response
|
|
2148
2189
|
*/
|
|
2149
2190
|
includeMetadata?: boolean,
|
|
2191
|
+
/**
|
|
2192
|
+
* Alias of platform_key
|
|
2193
|
+
*/
|
|
2194
|
+
key?: string,
|
|
2150
2195
|
/**
|
|
2151
2196
|
* Organization for the pathway
|
|
2152
2197
|
*/
|
|
@@ -2167,6 +2212,10 @@ export class CatalogService {
|
|
|
2167
2212
|
* Platform key for the pathway
|
|
2168
2213
|
*/
|
|
2169
2214
|
platformKey?: string,
|
|
2215
|
+
/**
|
|
2216
|
+
* Alias of org
|
|
2217
|
+
*/
|
|
2218
|
+
platformOrg?: string,
|
|
2170
2219
|
/**
|
|
2171
2220
|
* Pathway slug for enrollment
|
|
2172
2221
|
*/
|
|
@@ -2187,11 +2236,13 @@ export class CatalogService {
|
|
|
2187
2236
|
'active': active,
|
|
2188
2237
|
'include_default_platform': includeDefaultPlatform,
|
|
2189
2238
|
'include_metadata': includeMetadata,
|
|
2239
|
+
'key': key,
|
|
2190
2240
|
'org': org,
|
|
2191
2241
|
'pathway_id': pathwayId,
|
|
2192
2242
|
'pathway_key': pathwayKey,
|
|
2193
2243
|
'pathway_uuid': pathwayUuid,
|
|
2194
2244
|
'platform_key': platformKey,
|
|
2245
|
+
'platform_org': platformOrg,
|
|
2195
2246
|
'slug': slug,
|
|
2196
2247
|
'user_id': userId,
|
|
2197
2248
|
'username': username,
|
|
@@ -2350,8 +2401,10 @@ export class CatalogService {
|
|
|
2350
2401
|
ignoreExpiration = false,
|
|
2351
2402
|
includeDefaultPlatform,
|
|
2352
2403
|
includeMetadata = true,
|
|
2404
|
+
key,
|
|
2353
2405
|
org,
|
|
2354
2406
|
platformKey,
|
|
2407
|
+
platformOrg,
|
|
2355
2408
|
programId,
|
|
2356
2409
|
programKey,
|
|
2357
2410
|
programType,
|
|
@@ -2380,6 +2433,10 @@ export class CatalogService {
|
|
|
2380
2433
|
* Include metadata in the response
|
|
2381
2434
|
*/
|
|
2382
2435
|
includeMetadata?: boolean,
|
|
2436
|
+
/**
|
|
2437
|
+
* Alias of platform_key
|
|
2438
|
+
*/
|
|
2439
|
+
key?: string,
|
|
2383
2440
|
/**
|
|
2384
2441
|
* Organization for the program
|
|
2385
2442
|
*/
|
|
@@ -2388,6 +2445,10 @@ export class CatalogService {
|
|
|
2388
2445
|
* Platform key for the program
|
|
2389
2446
|
*/
|
|
2390
2447
|
platformKey?: string,
|
|
2448
|
+
/**
|
|
2449
|
+
* Alias of org
|
|
2450
|
+
*/
|
|
2451
|
+
platformOrg?: string,
|
|
2391
2452
|
/**
|
|
2392
2453
|
* Program ID for enrollment
|
|
2393
2454
|
*/
|
|
@@ -2426,8 +2487,10 @@ export class CatalogService {
|
|
|
2426
2487
|
'ignore_expiration': ignoreExpiration,
|
|
2427
2488
|
'include_default_platform': includeDefaultPlatform,
|
|
2428
2489
|
'include_metadata': includeMetadata,
|
|
2490
|
+
'key': key,
|
|
2429
2491
|
'org': org,
|
|
2430
2492
|
'platform_key': platformKey,
|
|
2493
|
+
'platform_org': platformOrg,
|
|
2431
2494
|
'program_id': programId,
|
|
2432
2495
|
'program_key': programKey,
|
|
2433
2496
|
'program_type': programType,
|
|
@@ -2449,8 +2512,10 @@ export class CatalogService {
|
|
|
2449
2512
|
ignoreExpiration = false,
|
|
2450
2513
|
includeDefaultPlatform,
|
|
2451
2514
|
includeMetadata = true,
|
|
2515
|
+
key,
|
|
2452
2516
|
org,
|
|
2453
2517
|
platformKey,
|
|
2518
|
+
platformOrg,
|
|
2454
2519
|
programId,
|
|
2455
2520
|
programKey,
|
|
2456
2521
|
programType,
|
|
@@ -2480,6 +2545,10 @@ export class CatalogService {
|
|
|
2480
2545
|
* Include metadata in the response
|
|
2481
2546
|
*/
|
|
2482
2547
|
includeMetadata?: boolean,
|
|
2548
|
+
/**
|
|
2549
|
+
* Alias of platform_key
|
|
2550
|
+
*/
|
|
2551
|
+
key?: string,
|
|
2483
2552
|
/**
|
|
2484
2553
|
* Organization for the program
|
|
2485
2554
|
*/
|
|
@@ -2488,6 +2557,10 @@ export class CatalogService {
|
|
|
2488
2557
|
* Platform key for the program
|
|
2489
2558
|
*/
|
|
2490
2559
|
platformKey?: string,
|
|
2560
|
+
/**
|
|
2561
|
+
* Alias of org
|
|
2562
|
+
*/
|
|
2563
|
+
platformOrg?: string,
|
|
2491
2564
|
/**
|
|
2492
2565
|
* Program ID for enrollment
|
|
2493
2566
|
*/
|
|
@@ -2527,8 +2600,10 @@ export class CatalogService {
|
|
|
2527
2600
|
'ignore_expiration': ignoreExpiration,
|
|
2528
2601
|
'include_default_platform': includeDefaultPlatform,
|
|
2529
2602
|
'include_metadata': includeMetadata,
|
|
2603
|
+
'key': key,
|
|
2530
2604
|
'org': org,
|
|
2531
2605
|
'platform_key': platformKey,
|
|
2606
|
+
'platform_org': platformOrg,
|
|
2532
2607
|
'program_id': programId,
|
|
2533
2608
|
'program_key': programKey,
|
|
2534
2609
|
'program_type': programType,
|
|
@@ -2552,8 +2627,10 @@ export class CatalogService {
|
|
|
2552
2627
|
ignoreExpiration = false,
|
|
2553
2628
|
includeDefaultPlatform,
|
|
2554
2629
|
includeMetadata = true,
|
|
2630
|
+
key,
|
|
2555
2631
|
org,
|
|
2556
2632
|
platformKey,
|
|
2633
|
+
platformOrg,
|
|
2557
2634
|
programId,
|
|
2558
2635
|
programKey,
|
|
2559
2636
|
programType,
|
|
@@ -2582,6 +2659,10 @@ export class CatalogService {
|
|
|
2582
2659
|
* Include metadata in the response
|
|
2583
2660
|
*/
|
|
2584
2661
|
includeMetadata?: boolean,
|
|
2662
|
+
/**
|
|
2663
|
+
* Alias of platform_key
|
|
2664
|
+
*/
|
|
2665
|
+
key?: string,
|
|
2585
2666
|
/**
|
|
2586
2667
|
* Organization for the program
|
|
2587
2668
|
*/
|
|
@@ -2590,6 +2671,10 @@ export class CatalogService {
|
|
|
2590
2671
|
* Platform key for the program
|
|
2591
2672
|
*/
|
|
2592
2673
|
platformKey?: string,
|
|
2674
|
+
/**
|
|
2675
|
+
* Alias of org
|
|
2676
|
+
*/
|
|
2677
|
+
platformOrg?: string,
|
|
2593
2678
|
/**
|
|
2594
2679
|
* Program ID for enrollment
|
|
2595
2680
|
*/
|
|
@@ -2628,8 +2713,10 @@ export class CatalogService {
|
|
|
2628
2713
|
'ignore_expiration': ignoreExpiration,
|
|
2629
2714
|
'include_default_platform': includeDefaultPlatform,
|
|
2630
2715
|
'include_metadata': includeMetadata,
|
|
2716
|
+
'key': key,
|
|
2631
2717
|
'org': org,
|
|
2632
2718
|
'platform_key': platformKey,
|
|
2719
|
+
'platform_org': platformOrg,
|
|
2633
2720
|
'program_id': programId,
|
|
2634
2721
|
'program_key': programKey,
|
|
2635
2722
|
'program_type': programType,
|
|
@@ -2647,10 +2734,12 @@ export class CatalogService {
|
|
|
2647
2734
|
*/
|
|
2648
2735
|
public static catalogEnrollmentProgramsSearchRetrieve({
|
|
2649
2736
|
includeDefaultPlatform,
|
|
2737
|
+
key,
|
|
2650
2738
|
org,
|
|
2651
2739
|
page,
|
|
2652
2740
|
pageSize,
|
|
2653
2741
|
platformKey,
|
|
2742
|
+
platformOrg,
|
|
2654
2743
|
programId,
|
|
2655
2744
|
programType,
|
|
2656
2745
|
slug,
|
|
@@ -2662,6 +2751,10 @@ export class CatalogService {
|
|
|
2662
2751
|
* Include enrollments from default platform
|
|
2663
2752
|
*/
|
|
2664
2753
|
includeDefaultPlatform?: boolean,
|
|
2754
|
+
/**
|
|
2755
|
+
* Alias of platform_key
|
|
2756
|
+
*/
|
|
2757
|
+
key?: string,
|
|
2665
2758
|
/**
|
|
2666
2759
|
* Filter enrollments by organization
|
|
2667
2760
|
*/
|
|
@@ -2678,6 +2771,10 @@ export class CatalogService {
|
|
|
2678
2771
|
* Filter enrollments by platform key
|
|
2679
2772
|
*/
|
|
2680
2773
|
platformKey?: string,
|
|
2774
|
+
/**
|
|
2775
|
+
* Alias of org
|
|
2776
|
+
*/
|
|
2777
|
+
platformOrg?: string,
|
|
2681
2778
|
/**
|
|
2682
2779
|
* Filter enrollments by program ID
|
|
2683
2780
|
*/
|
|
@@ -2708,10 +2805,12 @@ export class CatalogService {
|
|
|
2708
2805
|
url: '/api/catalog/enrollment/programs/search/',
|
|
2709
2806
|
query: {
|
|
2710
2807
|
'include_default_platform': includeDefaultPlatform,
|
|
2808
|
+
'key': key,
|
|
2711
2809
|
'org': org,
|
|
2712
2810
|
'page': page,
|
|
2713
2811
|
'page_size': pageSize,
|
|
2714
2812
|
'platform_key': platformKey,
|
|
2813
|
+
'platform_org': platformOrg,
|
|
2715
2814
|
'program_id': programId,
|
|
2716
2815
|
'program_type': programType,
|
|
2717
2816
|
'slug': slug,
|
|
@@ -7530,10 +7629,13 @@ export class CatalogService {
|
|
|
7530
7629
|
*/
|
|
7531
7630
|
public static catalogPathwaysList({
|
|
7532
7631
|
itemId,
|
|
7632
|
+
key,
|
|
7533
7633
|
name,
|
|
7634
|
+
org,
|
|
7534
7635
|
pathwayId,
|
|
7535
7636
|
pathwayUuid,
|
|
7536
7637
|
platformKey,
|
|
7638
|
+
platformOrg,
|
|
7537
7639
|
slug,
|
|
7538
7640
|
userId,
|
|
7539
7641
|
username,
|
|
@@ -7543,10 +7645,18 @@ export class CatalogService {
|
|
|
7543
7645
|
* Item ID associated with the pathway
|
|
7544
7646
|
*/
|
|
7545
7647
|
itemId?: string,
|
|
7648
|
+
/**
|
|
7649
|
+
* Alias of platform_key
|
|
7650
|
+
*/
|
|
7651
|
+
key?: string,
|
|
7546
7652
|
/**
|
|
7547
7653
|
* Pathway name
|
|
7548
7654
|
*/
|
|
7549
7655
|
name?: string,
|
|
7656
|
+
/**
|
|
7657
|
+
* Platform organization
|
|
7658
|
+
*/
|
|
7659
|
+
org?: string,
|
|
7550
7660
|
/**
|
|
7551
7661
|
* Pathway ID
|
|
7552
7662
|
*/
|
|
@@ -7559,6 +7669,10 @@ export class CatalogService {
|
|
|
7559
7669
|
* Platform key
|
|
7560
7670
|
*/
|
|
7561
7671
|
platformKey?: string,
|
|
7672
|
+
/**
|
|
7673
|
+
* Alias of org
|
|
7674
|
+
*/
|
|
7675
|
+
platformOrg?: string,
|
|
7562
7676
|
/**
|
|
7563
7677
|
* Pathway slug (case-insensitive)
|
|
7564
7678
|
*/
|
|
@@ -7581,10 +7695,13 @@ export class CatalogService {
|
|
|
7581
7695
|
url: '/api/catalog/pathways/',
|
|
7582
7696
|
query: {
|
|
7583
7697
|
'item_id': itemId,
|
|
7698
|
+
'key': key,
|
|
7584
7699
|
'name': name,
|
|
7700
|
+
'org': org,
|
|
7585
7701
|
'pathway_id': pathwayId,
|
|
7586
7702
|
'pathway_uuid': pathwayUuid,
|
|
7587
7703
|
'platform_key': platformKey,
|
|
7704
|
+
'platform_org': platformOrg,
|
|
7588
7705
|
'slug': slug,
|
|
7589
7706
|
'user_id': userId,
|
|
7590
7707
|
'username': username,
|
|
@@ -7600,10 +7717,13 @@ export class CatalogService {
|
|
|
7600
7717
|
public static catalogPathwaysCreate({
|
|
7601
7718
|
requestBody,
|
|
7602
7719
|
itemId,
|
|
7720
|
+
key,
|
|
7603
7721
|
name,
|
|
7722
|
+
org,
|
|
7604
7723
|
pathwayId,
|
|
7605
7724
|
pathwayUuid,
|
|
7606
7725
|
platformKey,
|
|
7726
|
+
platformOrg,
|
|
7607
7727
|
slug,
|
|
7608
7728
|
userId,
|
|
7609
7729
|
username,
|
|
@@ -7614,10 +7734,18 @@ export class CatalogService {
|
|
|
7614
7734
|
* Item ID associated with the pathway
|
|
7615
7735
|
*/
|
|
7616
7736
|
itemId?: string,
|
|
7737
|
+
/**
|
|
7738
|
+
* Alias of platform_key
|
|
7739
|
+
*/
|
|
7740
|
+
key?: string,
|
|
7617
7741
|
/**
|
|
7618
7742
|
* Pathway name
|
|
7619
7743
|
*/
|
|
7620
7744
|
name?: string,
|
|
7745
|
+
/**
|
|
7746
|
+
* Platform organization
|
|
7747
|
+
*/
|
|
7748
|
+
org?: string,
|
|
7621
7749
|
/**
|
|
7622
7750
|
* Pathway ID
|
|
7623
7751
|
*/
|
|
@@ -7630,6 +7758,10 @@ export class CatalogService {
|
|
|
7630
7758
|
* Platform key
|
|
7631
7759
|
*/
|
|
7632
7760
|
platformKey?: string,
|
|
7761
|
+
/**
|
|
7762
|
+
* Alias of org
|
|
7763
|
+
*/
|
|
7764
|
+
platformOrg?: string,
|
|
7633
7765
|
/**
|
|
7634
7766
|
* Pathway slug (case-insensitive)
|
|
7635
7767
|
*/
|
|
@@ -7652,10 +7784,13 @@ export class CatalogService {
|
|
|
7652
7784
|
url: '/api/catalog/pathways/',
|
|
7653
7785
|
query: {
|
|
7654
7786
|
'item_id': itemId,
|
|
7787
|
+
'key': key,
|
|
7655
7788
|
'name': name,
|
|
7789
|
+
'org': org,
|
|
7656
7790
|
'pathway_id': pathwayId,
|
|
7657
7791
|
'pathway_uuid': pathwayUuid,
|
|
7658
7792
|
'platform_key': platformKey,
|
|
7793
|
+
'platform_org': platformOrg,
|
|
7659
7794
|
'slug': slug,
|
|
7660
7795
|
'user_id': userId,
|
|
7661
7796
|
'username': username,
|
|
@@ -7677,9 +7812,12 @@ export class CatalogService {
|
|
|
7677
7812
|
pathwayId,
|
|
7678
7813
|
userId,
|
|
7679
7814
|
itemId,
|
|
7815
|
+
key,
|
|
7680
7816
|
name,
|
|
7817
|
+
org,
|
|
7681
7818
|
pathwayUuid,
|
|
7682
7819
|
platformKey,
|
|
7820
|
+
platformOrg,
|
|
7683
7821
|
slug,
|
|
7684
7822
|
username,
|
|
7685
7823
|
visible,
|
|
@@ -7696,10 +7834,18 @@ export class CatalogService {
|
|
|
7696
7834
|
* Item ID associated with the pathway
|
|
7697
7835
|
*/
|
|
7698
7836
|
itemId?: string,
|
|
7837
|
+
/**
|
|
7838
|
+
* Alias of platform_key
|
|
7839
|
+
*/
|
|
7840
|
+
key?: string,
|
|
7699
7841
|
/**
|
|
7700
7842
|
* Pathway name
|
|
7701
7843
|
*/
|
|
7702
7844
|
name?: string,
|
|
7845
|
+
/**
|
|
7846
|
+
* Platform organization
|
|
7847
|
+
*/
|
|
7848
|
+
org?: string,
|
|
7703
7849
|
/**
|
|
7704
7850
|
* Pathway UUID
|
|
7705
7851
|
*/
|
|
@@ -7708,6 +7854,10 @@ export class CatalogService {
|
|
|
7708
7854
|
* Platform key
|
|
7709
7855
|
*/
|
|
7710
7856
|
platformKey?: string,
|
|
7857
|
+
/**
|
|
7858
|
+
* Alias of org
|
|
7859
|
+
*/
|
|
7860
|
+
platformOrg?: string,
|
|
7711
7861
|
/**
|
|
7712
7862
|
* Pathway slug (case-insensitive)
|
|
7713
7863
|
*/
|
|
@@ -7726,10 +7876,13 @@ export class CatalogService {
|
|
|
7726
7876
|
url: '/api/catalog/pathways/',
|
|
7727
7877
|
query: {
|
|
7728
7878
|
'item_id': itemId,
|
|
7879
|
+
'key': key,
|
|
7729
7880
|
'name': name,
|
|
7881
|
+
'org': org,
|
|
7730
7882
|
'pathway_id': pathwayId,
|
|
7731
7883
|
'pathway_uuid': pathwayUuid,
|
|
7732
7884
|
'platform_key': platformKey,
|
|
7885
|
+
'platform_org': platformOrg,
|
|
7733
7886
|
'slug': slug,
|
|
7734
7887
|
'user_id': userId,
|
|
7735
7888
|
'username': username,
|
|
@@ -81,6 +81,7 @@ import type { UserPlatformSelfLinkResponse } from '../models/UserPlatformSelfLin
|
|
|
81
81
|
import type { UserPlatformViewPostRequest } from '../models/UserPlatformViewPostRequest';
|
|
82
82
|
import type { UserPolicyUpdate } from '../models/UserPolicyUpdate';
|
|
83
83
|
import type { UserPolicyUpdateResponse } from '../models/UserPolicyUpdateResponse';
|
|
84
|
+
import type { UserProfileSummary } from '../models/UserProfileSummary';
|
|
84
85
|
import type { UserProxyBulkRequest } from '../models/UserProxyBulkRequest';
|
|
85
86
|
import type { UserProxyGetResponse } from '../models/UserProxyGetResponse';
|
|
86
87
|
import type { UserProxyPostRequest } from '../models/UserProxyPostRequest';
|
|
@@ -3811,6 +3812,42 @@ export class CoreService {
|
|
|
3811
3812
|
mediaType: 'application/json',
|
|
3812
3813
|
});
|
|
3813
3814
|
}
|
|
3815
|
+
/**
|
|
3816
|
+
* Read a user's profile fields, for a viewer authorized to see them.
|
|
3817
|
+
*
|
|
3818
|
+
* This is not a public endpoint: access is controlled by the permission set
|
|
3819
|
+
* (the user themselves, a platform admin over them, a DM admin, or a watcher
|
|
3820
|
+
* of the user). It returns only the allowlist (see
|
|
3821
|
+
* UserProfileSummarySerializer): profile-card fields plus email, and no other
|
|
3822
|
+
* account PII. It does not reach edX. Profile
|
|
3823
|
+
* metadata is a single global record per user, so no platform scopes the
|
|
3824
|
+
* returned fields; the platform is used only to resolve the watcher
|
|
3825
|
+
* relationship. Read only.
|
|
3826
|
+
* @returns UserProfileSummary
|
|
3827
|
+
* @throws ApiError
|
|
3828
|
+
*/
|
|
3829
|
+
public static coreUsersProfileSummaryRetrieve({
|
|
3830
|
+
email,
|
|
3831
|
+
platformKey,
|
|
3832
|
+
userId,
|
|
3833
|
+
username,
|
|
3834
|
+
}: {
|
|
3835
|
+
email?: string,
|
|
3836
|
+
platformKey?: string,
|
|
3837
|
+
userId?: number,
|
|
3838
|
+
username?: string,
|
|
3839
|
+
}): CancelablePromise<UserProfileSummary> {
|
|
3840
|
+
return __request(OpenAPI, {
|
|
3841
|
+
method: 'GET',
|
|
3842
|
+
url: '/api/core/users/profile/summary/',
|
|
3843
|
+
query: {
|
|
3844
|
+
'email': email,
|
|
3845
|
+
'platform_key': platformKey,
|
|
3846
|
+
'user_id': userId,
|
|
3847
|
+
'username': username,
|
|
3848
|
+
},
|
|
3849
|
+
});
|
|
3850
|
+
}
|
|
3814
3851
|
/**
|
|
3815
3852
|
* Retrieve proxy user information by user_id
|
|
3816
3853
|
* @returns UserProxyGetResponse
|