@ikonintegration/bccsa-program-api 3.0.16 → 3.0.17

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/Api.ts CHANGED
@@ -17,7 +17,7 @@ export interface ErrorResponse {
17
17
  errCode: string
18
18
  }
19
19
 
20
- export interface InputUd1Py882Ha {
20
+ export interface InputEn99Qyf92S {
21
21
  /**
22
22
  * Name of the person filling out the contact form
23
23
  * @example "John Doe"
@@ -529,7 +529,7 @@ export interface PendingApprovalResponseSchema {
529
529
  | null
530
530
  }
531
531
 
532
- export interface InputD3Dhjn9Ys4 {
532
+ export interface Input38Hcfrecd8 {
533
533
  /**
534
534
  * ID of the certification to filter applications by
535
535
  * @example "certification123"
@@ -587,7 +587,7 @@ export interface InputD3Dhjn9Ys4 {
587
587
  ignoreCompletedCertifications?: boolean | null
588
588
  }
589
589
 
590
- export interface InputTyyuqx8L2O {
590
+ export interface InputKme51Dz7A6 {
591
591
  /**
592
592
  * ID of the certification to filter applications by
593
593
  * @example "certification123"
@@ -645,7 +645,7 @@ export interface InputTyyuqx8L2O {
645
645
  ignoreCompletedCertifications?: boolean | null
646
646
  }
647
647
 
648
- export interface InputJycvujxvg4H {
648
+ export interface InputZimh3Glsfmj {
649
649
  /**
650
650
  * ID of the certification to filter applications by
651
651
  * @example "certification123"
@@ -703,7 +703,7 @@ export interface InputJycvujxvg4H {
703
703
  ignoreCompletedCertifications?: boolean | null
704
704
  }
705
705
 
706
- export interface InputOd8Hvevtkh {
706
+ export interface InputTsj7Au05Gw {
707
707
  /**
708
708
  * The ID of the certificate specifications to be used for the email
709
709
  * @example "certSpecsID123"
@@ -745,7 +745,7 @@ export interface InputOd8Hvevtkh {
745
745
  }[]
746
746
  }
747
747
 
748
- export interface Input8Oiix3Elgyj {
748
+ export interface InputUf1J0E7Mb6 {
749
749
  /**
750
750
  * The ID of the product for which the license is being redeemed
751
751
  * @example "productID123"
@@ -758,7 +758,7 @@ export interface Input8Oiix3Elgyj {
758
758
  sessionID?: string
759
759
  }
760
760
 
761
- export interface InputFpgop3Isd5 {
761
+ export interface InputH7P19Hfii4I {
762
762
  /**
763
763
  * Search term to filter licenses
764
764
  * @example "active"
@@ -776,7 +776,7 @@ export interface InputFpgop3Isd5 {
776
776
  sortField?: any
777
777
  }
778
778
 
779
- export interface InputIdt7Y9Ryz7L {
779
+ export interface InputHah5Gla80Q {
780
780
  /**
781
781
  * Search term to filter licenses
782
782
  * @example "active"
@@ -835,7 +835,7 @@ export interface ReportXLSXSchema {
835
835
  contentType: ReportXlsxSchemaContentTypeEnum
836
836
  }
837
837
 
838
- export interface InputOazpxrxma7 {
838
+ export interface InputUplth6C9Ad {
839
839
  /**
840
840
  * Start date for the report
841
841
  * @example "2023-01-01T00:00:00Z"
@@ -858,12 +858,12 @@ export interface InputOazpxrxma7 {
858
858
  dateType?: string
859
859
  }
860
860
 
861
- export interface InputVwx4A531Dx {
861
+ export interface Input7Jsubguwhpl {
862
862
  /** List of user IDs to search for in the tenant. */
863
863
  IDs: (string | null)[]
864
864
  }
865
865
 
866
- export interface InputRyccpgocqi {
866
+ export interface InputJp1H3Pxa2V {
867
867
  /** The term to search for in the user profiles. */
868
868
  searchTerm?: string | null
869
869
  /** Filter criteria for the user search. */
@@ -904,7 +904,7 @@ export interface InputRyccpgocqi {
904
904
  }
905
905
  }
906
906
 
907
- export interface InputVvhra13Jmh {
907
+ export interface Input061Ikqn2Yo {
908
908
  /** The term to search for in the user profiles. */
909
909
  searchTerm?: string | null
910
910
  /** Filter criteria for the user search. */
@@ -948,13 +948,13 @@ export interface InputVvhra13Jmh {
948
948
  /** External system ID 2 */
949
949
  export type ExternalID2 = number
950
950
 
951
- export interface Output3Ic5X329Tg {
951
+ export interface OutputH0Jr66Rgmi {
952
952
  /** External system ID 2 */
953
953
  userCount: ExternalID2
954
954
  transactionID?: string | null
955
955
  }
956
956
 
957
- export interface OutputBwweo9Hk3I {
957
+ export interface Output9162449N3V {
958
958
  /**
959
959
  * Signed URL for the course file
960
960
  * @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
@@ -962,7 +962,7 @@ export interface OutputBwweo9Hk3I {
962
962
  fileURL: string
963
963
  }
964
964
 
965
- export interface Output50Cxzsa2Jw {
965
+ export interface Output99Bafbnty2 {
966
966
  /**
967
967
  * Amount to be refunded for the cancellation
968
968
  * @example 0
@@ -1279,7 +1279,7 @@ export interface CourseResponseEntity {
1279
1279
  overwrittenJustification?: OverwrittenJustification
1280
1280
  }
1281
1281
 
1282
- export interface OutputP2Duut4Rdr {
1282
+ export interface OutputW20V1Q9Cfzh {
1283
1283
  /**
1284
1284
  * Signed URL for the course file
1285
1285
  * @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
@@ -1299,7 +1299,7 @@ export interface UserExpandedCPResponseSchema {
1299
1299
  }
1300
1300
 
1301
1301
  /** Application Foreign Fill response type */
1302
- export interface Output5Ma5Cfwu78K {
1302
+ export interface OutputBmyceqkfzo {
1303
1303
  items: {
1304
1304
  userID: string
1305
1305
  createdOn?: number
@@ -1479,6 +1479,22 @@ export type IsEnabled = boolean
1479
1479
  /** Whether the user has opted out of having their certification information published to 3rd party integrations */
1480
1480
  export type CertifiedUserOptOut = boolean
1481
1481
 
1482
+ export interface PartitionEntry {
1483
+ partID: string
1484
+ userID: string
1485
+ updateByApp?: string
1486
+ updateOn?: number
1487
+ value?: any
1488
+ }
1489
+
1490
+ /** User data from IDM including user profile and partition data */
1491
+ export interface UserDataResponse {
1492
+ /** IDM user object */
1493
+ user: Record<string, any>
1494
+ /** User partition data from IDM */
1495
+ partitions: PartitionEntry[]
1496
+ }
1497
+
1482
1498
  /** Response schema for certification process data */
1483
1499
  export interface CertificationProcessResponseEntity {
1484
1500
  /** @example "abc123" */
@@ -1563,7 +1579,7 @@ export interface CertificationProcessResponseEntity {
1563
1579
  transactionID?: string | null
1564
1580
  }
1565
1581
 
1566
- export interface InputJ86Ad2Cw25 {
1582
+ export interface InputA3Yzaj9Yge {
1567
1583
  issuedOn?: number
1568
1584
  expiresOn?: number
1569
1585
  fileItems?: {
@@ -1573,7 +1589,7 @@ export interface InputJ86Ad2Cw25 {
1573
1589
  additionalNotes?: string | null
1574
1590
  }
1575
1591
 
1576
- export interface InputKnvh2Z7Rse {
1592
+ export interface InputYkrswdxt80H {
1577
1593
  /**
1578
1594
  * Indicates whether the application is locked
1579
1595
  * @example true
@@ -1581,7 +1597,7 @@ export interface InputKnvh2Z7Rse {
1581
1597
  isApplicationLocked: boolean
1582
1598
  }
1583
1599
 
1584
- export interface OutputI4R7Bcx3T7G {
1600
+ export interface OutputH9Obb07K5S {
1585
1601
  /**
1586
1602
  * Signed URL for the course file
1587
1603
  * @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
@@ -1589,7 +1605,7 @@ export interface OutputI4R7Bcx3T7G {
1589
1605
  fileURL: string
1590
1606
  }
1591
1607
 
1592
- export interface InputPn24Tkrz5N {
1608
+ export interface InputOu74Xwaupt {
1593
1609
  /**
1594
1610
  * Indicates whether the waiver is approved
1595
1611
  * @example true
@@ -1602,7 +1618,7 @@ export interface InputPn24Tkrz5N {
1602
1618
  additionalNotes?: string | null
1603
1619
  }
1604
1620
 
1605
- export interface Input2Dvhr78Yv {
1621
+ export interface InputEoy83X4Gst {
1606
1622
  /**
1607
1623
  * Optional notes regarding the waiver
1608
1624
  * @example "Waiver granted due to special circumstances."
@@ -1610,7 +1626,7 @@ export interface Input2Dvhr78Yv {
1610
1626
  additionalNotes?: string | null
1611
1627
  }
1612
1628
 
1613
- export interface Input766Ii876Sj {
1629
+ export interface InputSzy4Sbd1Vek {
1614
1630
  students: {
1615
1631
  /**
1616
1632
  * User ID of the student to redeem the course for
@@ -1645,7 +1661,7 @@ export interface Input766Ii876Sj {
1645
1661
  autoEnrolSessionID?: string
1646
1662
  }
1647
1663
 
1648
- export interface InputG1V252Slib {
1664
+ export interface Input0Xoiyidh46 {
1649
1665
  invites: {
1650
1666
  /**
1651
1667
  * Email address of the user to invite
@@ -1675,7 +1691,7 @@ export interface InputG1V252Slib {
1675
1691
  isReservedSeat: boolean
1676
1692
  }
1677
1693
 
1678
- export interface InputQfsksefyis {
1694
+ export interface Input9Gk1Eer7Ldh {
1679
1695
  /**
1680
1696
  * Indicates whether to waive the certification process
1681
1697
  * @example true
@@ -1689,7 +1705,7 @@ export interface InputQfsksefyis {
1689
1705
  }
1690
1706
 
1691
1707
  /** Certification move response schema */
1692
- export interface OutputYon3Esf9Sd {
1708
+ export interface Output8K3Kc2235 {
1693
1709
  errors?: {
1694
1710
  status: string
1695
1711
  object?: Record<string, any>
@@ -1698,12 +1714,12 @@ export interface OutputYon3Esf9Sd {
1698
1714
  }
1699
1715
 
1700
1716
  /** Schema for writing a certification trigger check. */
1701
- export interface Input0Ckjw53Cpo {
1717
+ export interface InputB03Ca4Xqtw {
1702
1718
  /**
1703
1719
  * The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
1704
1720
  * @example "CHECKED"
1705
1721
  */
1706
- value: Input0Ckjw53CpoValueEnum
1722
+ value: InputB03Ca4XqtwValueEnum
1707
1723
  /**
1708
1724
  * List of course IDs that are blocked by this trigger check.
1709
1725
  * @example ["course1","course2"]
@@ -1711,7 +1727,7 @@ export interface Input0Ckjw53Cpo {
1711
1727
  blockedCourses?: string[]
1712
1728
  }
1713
1729
 
1714
- export interface Input2D3A4F27Ipf {
1730
+ export interface InputNqcjc8Hvq6 {
1715
1731
  /**
1716
1732
  * Indicates whether the application item is approved
1717
1733
  * @example true
@@ -1739,7 +1755,7 @@ export interface StudentHistoryRequestSchema {
1739
1755
  requirements: string[]
1740
1756
  }
1741
1757
 
1742
- export interface InputRw404Uorif {
1758
+ export interface InputEdu05Vaqm1 {
1743
1759
  /**
1744
1760
  * Optional activation key for the application
1745
1761
  * @example "AK-123456"
@@ -1748,7 +1764,7 @@ export interface InputRw404Uorif {
1748
1764
  }
1749
1765
 
1750
1766
  /** Schema for course submission item details post request. */
1751
- export interface InputAt2Qquee7L {
1767
+ export interface Input2Kraeg1Oyh {
1752
1768
  /**
1753
1769
  * The ID of the file being submitted.
1754
1770
  * @example "fileID123"
@@ -1762,7 +1778,7 @@ export interface InputAt2Qquee7L {
1762
1778
  }
1763
1779
 
1764
1780
  /** Schema for the response to course submission item details post request. */
1765
- export interface OutputAt2Qquee7L {
1781
+ export interface Output2Kraeg1Oyh {
1766
1782
  submissionItems: {
1767
1783
  /**
1768
1784
  * The ID of the file being submitted.
@@ -1778,7 +1794,7 @@ export interface OutputAt2Qquee7L {
1778
1794
  }
1779
1795
 
1780
1796
  /** Pending approval submission parameters */
1781
- export interface InputWoyg2Gtn48L {
1797
+ export interface Input6Wmqoozm3 {
1782
1798
  /**
1783
1799
  * Type of pending approval
1784
1800
  * @example "certification"
@@ -1799,7 +1815,7 @@ export interface InputWoyg2Gtn48L {
1799
1815
  }[]
1800
1816
  }
1801
1817
 
1802
- export interface InputHd03Cx4Ul6 {
1818
+ export interface Input7Bzeouyok2 {
1803
1819
  /**
1804
1820
  * The ID of the course for which the license is being redeemed
1805
1821
  * @example "courseID123"
@@ -1868,7 +1884,7 @@ export interface InputHd03Cx4Ul6 {
1868
1884
  }
1869
1885
 
1870
1886
  /** Validate certification move response schema */
1871
- export interface Output901E0Rl7D1K {
1887
+ export interface OutputUwt1Sn61Y6 {
1872
1888
  courses: {
1873
1889
  name: string
1874
1890
  status: string
@@ -1880,7 +1896,7 @@ export interface Output901E0Rl7D1K {
1880
1896
  mustCreateCP: boolean
1881
1897
  }
1882
1898
 
1883
- export interface InputLa0684Ab34 {
1899
+ export interface InputIvdyk9Pfse {
1884
1900
  /**
1885
1901
  * Comments regarding the end of the cooldown period
1886
1902
  * @example "Cooldown period ended successfully."
@@ -1888,7 +1904,7 @@ export interface InputLa0684Ab34 {
1888
1904
  comments: string
1889
1905
  }
1890
1906
 
1891
- export interface Output6Xbu13Oam3 {
1907
+ export interface OutputMwn8En7U7W {
1892
1908
  /**
1893
1909
  * Signed URL for the course file
1894
1910
  * @example "https://<bucket-name>.s3.amazonaws.com/<object-key>?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=...&X-Amz-Date=...&X-Amz-Expires=...&X-Amz-Signature=...&X-Amz-SignedHeaders=host"
@@ -1896,7 +1912,7 @@ export interface Output6Xbu13Oam3 {
1896
1912
  fileURL: string
1897
1913
  }
1898
1914
 
1899
- export interface InputT28Ksq4Qbh {
1915
+ export interface InputGmvq9Lbnmi {
1900
1916
  /** @example true */
1901
1917
  agreedWithCertTerms: boolean
1902
1918
  /** @example 1717230000000 */
@@ -1969,7 +1985,7 @@ export interface InputT28Ksq4Qbh {
1969
1985
  externalID2?: string | null
1970
1986
  }
1971
1987
 
1972
- export interface Input80Urs698Ps {
1988
+ export interface Input1Ev9Bv5Hdvl {
1973
1989
  /**
1974
1990
  * Comments regarding the course unlock action
1975
1991
  * @example "Course unlocked successfully."
@@ -1977,7 +1993,7 @@ export interface Input80Urs698Ps {
1977
1993
  comments: string
1978
1994
  }
1979
1995
 
1980
- export interface InputThrd8Gc9Hsk {
1996
+ export interface InputTlq6Xv9Taz {
1981
1997
  /**
1982
1998
  * ITA number to update for the user
1983
1999
  * @example "ITA123456"
@@ -1985,7 +2001,7 @@ export interface InputThrd8Gc9Hsk {
1985
2001
  itaNumber: string
1986
2002
  }
1987
2003
 
1988
- export interface InputR78Km2A863 {
2004
+ export interface Input7Ny7Clq7Hog {
1989
2005
  /** @example true */
1990
2006
  agreedWithCertTerms: boolean
1991
2007
  /** @example 1717230000000 */
@@ -2058,7 +2074,7 @@ export interface InputR78Km2A863 {
2058
2074
  externalID2?: string | null
2059
2075
  }
2060
2076
 
2061
- export interface InputCo4Zlxh4K7 {
2077
+ export interface InputThseotb1Em {
2062
2078
  /**
2063
2079
  * The grade to override the course result with
2064
2080
  * @example "A"
@@ -2067,7 +2083,7 @@ export interface InputCo4Zlxh4K7 {
2067
2083
  }
2068
2084
 
2069
2085
  /** Pending approval review parameters */
2070
- export interface InputDfj95F0L6A {
2086
+ export interface InputLir3Krf8Mnf {
2071
2087
  /**
2072
2088
  * Notes provided by the reviewer for the pending approval
2073
2089
  * @example "Please review the submitted documents."
@@ -2081,7 +2097,7 @@ export interface InputDfj95F0L6A {
2081
2097
  }
2082
2098
 
2083
2099
  /** Schema for overriding course result dates. */
2084
- export interface InputDfrz7Yoxs1 {
2100
+ export interface InputNhgat59Crhi {
2085
2101
  /**
2086
2102
  * The date when the course result expires, in milliseconds since epoch.
2087
2103
  * @example 1735689600000
@@ -2094,7 +2110,7 @@ export interface InputDfrz7Yoxs1 {
2094
2110
  completionDate?: number
2095
2111
  }
2096
2112
 
2097
- export interface InputI1Fdsdjf1C {
2113
+ export interface InputMiwmdmv0H5 {
2098
2114
  filter: {
2099
2115
  from?: number
2100
2116
  sortOrder?: string
@@ -2102,7 +2118,7 @@ export interface InputI1Fdsdjf1C {
2102
2118
  }
2103
2119
  }
2104
2120
 
2105
- export interface OutputI1Fdsdjf1C {
2121
+ export interface OutputMiwmdmv0H5 {
2106
2122
  users: {
2107
2123
  firstName: string
2108
2124
  lastName: string
@@ -2124,7 +2140,7 @@ export enum ReportXlsxSchemaContentTypeEnum {
2124
2140
  * The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
2125
2141
  * @example "CHECKED"
2126
2142
  */
2127
- export enum Input0Ckjw53CpoValueEnum {
2143
+ export enum InputB03Ca4XqtwValueEnum {
2128
2144
  CHECKED = 'CHECKED',
2129
2145
  UNCHECKED = 'UNCHECKED',
2130
2146
  NOVALUE = 'NOVALUE',
@@ -2273,7 +2289,7 @@ export type CreateReportUsersSimpleData = any
2273
2289
 
2274
2290
  export type CreateReportUsersSimpleError = ErrorResponse
2275
2291
 
2276
- export type CreateSearchUsersCountData = Output3Ic5X329Tg
2292
+ export type CreateSearchUsersCountData = OutputH0Jr66Rgmi
2277
2293
 
2278
2294
  export type CreateSearchUsersCountError = ErrorResponse
2279
2295
 
@@ -2321,7 +2337,7 @@ export type DeleteCertificationCourseFileSignData = any
2321
2337
 
2322
2338
  export type DeleteCertificationCourseFileSignError = ErrorResponse
2323
2339
 
2324
- export type GetCertificationCourseFileSignData = OutputP2Duut4Rdr
2340
+ export type GetCertificationCourseFileSignData = OutputW20V1Q9Cfzh
2325
2341
 
2326
2342
  export type GetCertificationCourseFileSignError = ErrorResponse
2327
2343
 
@@ -2338,7 +2354,7 @@ export interface CreateCertificationCourseFileSignParams {
2338
2354
  fileId: string
2339
2355
  }
2340
2356
 
2341
- export type CreateCertificationCourseFileSignData = Output6Xbu13Oam3
2357
+ export type CreateCertificationCourseFileSignData = OutputMwn8En7U7W
2342
2358
 
2343
2359
  export type CreateCertificationCourseFileSignError = ErrorResponse
2344
2360
 
@@ -2346,7 +2362,7 @@ export type DeleteCertificationCourseDocumentData = any
2346
2362
 
2347
2363
  export type DeleteCertificationCourseDocumentError = ErrorResponse
2348
2364
 
2349
- export type CreateCertificationCourseDocumentData = OutputAt2Qquee7L
2365
+ export type CreateCertificationCourseDocumentData = Output2Kraeg1Oyh
2350
2366
 
2351
2367
  export type CreateCertificationCourseDocumentError = ErrorResponse
2352
2368
 
@@ -2370,7 +2386,7 @@ export type DeleteCertificationCourseData = any
2370
2386
 
2371
2387
  export type DeleteCertificationCourseError = ErrorResponse
2372
2388
 
2373
- export type GetCertificationApplicationItemFileData = OutputBwweo9Hk3I
2389
+ export type GetCertificationApplicationItemFileData = Output9162449N3V
2374
2390
 
2375
2391
  export type GetCertificationApplicationItemFileError = ErrorResponse
2376
2392
 
@@ -2387,11 +2403,11 @@ export interface CreateCertificationApplicationItemFileParams {
2387
2403
  fileVersion: string
2388
2404
  }
2389
2405
 
2390
- export type CreateCertificationApplicationItemFileData = OutputI4R7Bcx3T7G
2406
+ export type CreateCertificationApplicationItemFileData = OutputH9Obb07K5S
2391
2407
 
2392
2408
  export type CreateCertificationApplicationItemFileError = ErrorResponse
2393
2409
 
2394
- export type GetCertificationCourseSessionCalcCancelationChargesData = Output50Cxzsa2Jw
2410
+ export type GetCertificationCourseSessionCalcCancelationChargesData = Output99Bafbnty2
2395
2411
 
2396
2412
  export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse
2397
2413
 
@@ -2407,7 +2423,7 @@ export type GetCertificationsExpandedData = UserExpandedCPResponseSchema
2407
2423
 
2408
2424
  export type GetCertificationsExpandedError = ErrorResponse
2409
2425
 
2410
- export type GetCertificationApplicationForeignFillData = Output5Ma5Cfwu78K
2426
+ export type GetCertificationApplicationForeignFillData = OutputBmyceqkfzo
2411
2427
 
2412
2428
  export type GetCertificationApplicationForeignFillError = ErrorResponse
2413
2429
 
@@ -2427,6 +2443,10 @@ export type GetCertificationsUpcomingCoursesData = UserUpcomingCoursesResponseSc
2427
2443
 
2428
2444
  export type GetCertificationsUpcomingCoursesError = ErrorResponse
2429
2445
 
2446
+ export type GetUserDataData = UserDataResponse
2447
+
2448
+ export type GetUserDataError = ErrorResponse
2449
+
2430
2450
  export type CreateCertificationApplicationLockData = any
2431
2451
 
2432
2452
  export type CreateCertificationApplicationLockError = ErrorResponse
@@ -2471,7 +2491,7 @@ export type CreateCertificationWaiveData = any
2471
2491
 
2472
2492
  export type CreateCertificationWaiveError = ErrorResponse
2473
2493
 
2474
- export type CreateCertificationMoveData = OutputYon3Esf9Sd
2494
+ export type CreateCertificationMoveData = Output8K3Kc2235
2475
2495
 
2476
2496
  export type CreateCertificationMoveError = ErrorResponse
2477
2497
 
@@ -2527,7 +2547,7 @@ export type CreateCertificationCourseRedeemData = any
2527
2547
 
2528
2548
  export type CreateCertificationCourseRedeemError = ErrorResponse
2529
2549
 
2530
- export type CreateCertificationMoveValidateData = Output901E0Rl7D1K
2550
+ export type CreateCertificationMoveValidateData = OutputUwt1Sn61Y6
2531
2551
 
2532
2552
  export type CreateCertificationMoveValidateError = ErrorResponse
2533
2553
 
@@ -2555,7 +2575,7 @@ export type CreateCertificationPublishInfoData = any
2555
2575
 
2556
2576
  export type CreateCertificationPublishInfoError = ErrorResponse
2557
2577
 
2558
- export type CreateCertificationResult = OutputI1Fdsdjf1C
2578
+ export type CreateCertificationResult = OutputMiwmdmv0H5
2559
2579
 
2560
2580
  export type CreateCertificationFail = ErrorResponse
2561
2581
 
@@ -2701,7 +2721,7 @@ export class HttpClient<SecurityDataType = unknown> {
2701
2721
 
2702
2722
  /**
2703
2723
  * @title BCCSA Program API
2704
- * @version 3.0.16
2724
+ * @version 3.0.17
2705
2725
  * @baseUrl http://localhost:8080
2706
2726
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
2707
2727
  */
@@ -2716,7 +2736,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
2716
2736
  * @request POST:/contactUs
2717
2737
  * @secure
2718
2738
  */
2719
- listContactUs: (data: InputUd1Py882Ha, params: RequestParams = {}) =>
2739
+ listContactUs: (data: InputEn99Qyf92S, params: RequestParams = {}) =>
2720
2740
  this.request<ListContactUsData, ListContactUsError>({
2721
2741
  path: `/contactUs`,
2722
2742
  method: 'POST',
@@ -2896,7 +2916,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
2896
2916
  * @request POST:/tenant/report/applicationExport
2897
2917
  * @secure
2898
2918
  */
2899
- createReportApplicationExport: (data: InputD3Dhjn9Ys4, params: RequestParams = {}) =>
2919
+ createReportApplicationExport: (data: Input38Hcfrecd8, params: RequestParams = {}) =>
2900
2920
  this.request<CreateReportApplicationExportData, CreateReportApplicationExportError>({
2901
2921
  path: `/tenant/report/applicationExport`,
2902
2922
  method: 'POST',
@@ -2915,7 +2935,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
2915
2935
  * @request POST:/tenant/report/applicationStatus
2916
2936
  * @secure
2917
2937
  */
2918
- listReportApplicationStatus: (data: InputTyyuqx8L2O, params: RequestParams = {}) =>
2938
+ listReportApplicationStatus: (data: InputKme51Dz7A6, params: RequestParams = {}) =>
2919
2939
  this.request<ListReportApplicationStatusData, ListReportApplicationStatusError>({
2920
2940
  path: `/tenant/report/applicationStatus`,
2921
2941
  method: 'POST',
@@ -2934,7 +2954,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
2934
2954
  * @request POST:/tenant/report/applicationsReport
2935
2955
  * @secure
2936
2956
  */
2937
- createReportApplicationsReport: (data: InputJycvujxvg4H, params: RequestParams = {}) =>
2957
+ createReportApplicationsReport: (data: InputZimh3Glsfmj, params: RequestParams = {}) =>
2938
2958
  this.request<CreateReportApplicationsReportData, CreateReportApplicationsReportError>({
2939
2959
  path: `/tenant/report/applicationsReport`,
2940
2960
  method: 'POST',
@@ -2953,7 +2973,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
2953
2973
  * @request POST:/tenant/certificates/email
2954
2974
  * @secure
2955
2975
  */
2956
- createCertificatesEmail: (data: InputOd8Hvevtkh, params: RequestParams = {}) =>
2976
+ createCertificatesEmail: (data: InputTsj7Au05Gw, params: RequestParams = {}) =>
2957
2977
  this.request<CreateCertificatesEmailData, CreateCertificatesEmailError>({
2958
2978
  path: `/tenant/certificates/email`,
2959
2979
  method: 'POST',
@@ -3011,7 +3031,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3011
3031
  * @request POST:/tenant/license/redeem/{userID}
3012
3032
  * @secure
3013
3033
  */
3014
- createLicenseRedeem: (userId: string, data: Input8Oiix3Elgyj, params: RequestParams = {}) =>
3034
+ createLicenseRedeem: (userId: string, data: InputUf1J0E7Mb6, params: RequestParams = {}) =>
3015
3035
  this.request<CreateLicenseRedeemData, CreateLicenseRedeemError>({
3016
3036
  path: `/tenant/license/redeem/${userId}`,
3017
3037
  method: 'POST',
@@ -3030,7 +3050,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3030
3050
  * @request POST:/tenant/report/orglicenses/
3031
3051
  * @secure
3032
3052
  */
3033
- listReportOrglicenses: (data: InputFpgop3Isd5, params: RequestParams = {}) =>
3053
+ listReportOrglicenses: (data: InputH7P19Hfii4I, params: RequestParams = {}) =>
3034
3054
  this.request<ListReportOrglicensesData, ListReportOrglicensesError>({
3035
3055
  path: `/tenant/report/orglicenses/`,
3036
3056
  method: 'POST',
@@ -3049,7 +3069,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3049
3069
  * @request POST:/tenant/report/orglicenses/preview
3050
3070
  * @secure
3051
3071
  */
3052
- createReportOrglicensesPreview: (data: InputIdt7Y9Ryz7L, params: RequestParams = {}) =>
3072
+ createReportOrglicensesPreview: (data: InputHah5Gla80Q, params: RequestParams = {}) =>
3053
3073
  this.request<CreateReportOrglicensesPreviewData, CreateReportOrglicensesPreviewError>({
3054
3074
  path: `/tenant/report/orglicenses/preview`,
3055
3075
  method: 'POST',
@@ -3108,7 +3128,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3108
3128
  * @request POST:/tenant/report/users/advanced
3109
3129
  * @secure
3110
3130
  */
3111
- createReportUsersAdvanced: (data: InputOazpxrxma7, params: RequestParams = {}) =>
3131
+ createReportUsersAdvanced: (data: InputUplth6C9Ad, params: RequestParams = {}) =>
3112
3132
  this.request<CreateReportUsersAdvancedData, CreateReportUsersAdvancedError>({
3113
3133
  path: `/tenant/report/users/advanced`,
3114
3134
  method: 'POST',
@@ -3127,7 +3147,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3127
3147
  * @request POST:/tenant/search/users/ids
3128
3148
  * @secure
3129
3149
  */
3130
- listSearchUsersIds: (data: InputVwx4A531Dx, params: RequestParams = {}) =>
3150
+ listSearchUsersIds: (data: Input7Jsubguwhpl, params: RequestParams = {}) =>
3131
3151
  this.request<ListSearchUsersIdsData, ListSearchUsersIdsError>({
3132
3152
  path: `/tenant/search/users/ids`,
3133
3153
  method: 'POST',
@@ -3146,7 +3166,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3146
3166
  * @request POST:/tenant/search/users/term
3147
3167
  * @secure
3148
3168
  */
3149
- createSearchUsersTerm: (data: InputRyccpgocqi, params: RequestParams = {}) =>
3169
+ createSearchUsersTerm: (data: InputJp1H3Pxa2V, params: RequestParams = {}) =>
3150
3170
  this.request<CreateSearchUsersTermData, CreateSearchUsersTermError>({
3151
3171
  path: `/tenant/search/users/term`,
3152
3172
  method: 'POST',
@@ -3165,7 +3185,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3165
3185
  * @request POST:/tenant/report/users/simple
3166
3186
  * @secure
3167
3187
  */
3168
- createReportUsersSimple: (data: InputVvhra13Jmh, params: RequestParams = {}) =>
3188
+ createReportUsersSimple: (data: Input061Ikqn2Yo, params: RequestParams = {}) =>
3169
3189
  this.request<CreateReportUsersSimpleData, CreateReportUsersSimpleError>({
3170
3190
  path: `/tenant/report/users/simple`,
3171
3191
  method: 'POST',
@@ -3253,7 +3273,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3253
3273
  certProcId: string,
3254
3274
  applicationType: string,
3255
3275
  sourceId: string,
3256
- data: InputJ86Ad2Cw25,
3276
+ data: InputA3Yzaj9Yge,
3257
3277
  params: RequestParams = {}
3258
3278
  ) =>
3259
3279
  this.request<CreateCertificationApplicationItemData, CreateCertificationApplicationItemError>({
@@ -3513,7 +3533,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3513
3533
  certProcId: string,
3514
3534
  courseId: string,
3515
3535
  fileId: string,
3516
- data: InputAt2Qquee7L,
3536
+ data: Input2Kraeg1Oyh,
3517
3537
  params: RequestParams = {}
3518
3538
  ) =>
3519
3539
  this.request<CreateCertificationCourseDocumentData, CreateCertificationCourseDocumentError>({
@@ -3570,7 +3590,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3570
3590
  * @request POST:/user/{userID}
3571
3591
  * @secure
3572
3592
  */
3573
- createUser: (userId: string, data: InputT28Ksq4Qbh, params: RequestParams = {}) =>
3593
+ createUser: (userId: string, data: InputGmvq9Lbnmi, params: RequestParams = {}) =>
3574
3594
  this.request<CreateUserData, CreateUserError>({
3575
3595
  path: `/user/${userId}`,
3576
3596
  method: 'POST',
@@ -3589,7 +3609,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3589
3609
  * @request PUT:/user/{userID}
3590
3610
  * @secure
3591
3611
  */
3592
- updateUser: (userId: string, data: InputR78Km2A863, params: RequestParams = {}) =>
3612
+ updateUser: (userId: string, data: Input7Ny7Clq7Hog, params: RequestParams = {}) =>
3593
3613
  this.request<UpdateUserData, UpdateUserError>({
3594
3614
  path: `/user/${userId}`,
3595
3615
  method: 'PUT',
@@ -3836,6 +3856,24 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3836
3856
  ...params,
3837
3857
  }),
3838
3858
 
3859
+ /**
3860
+ * @description Retrieve user data from IDM including user profile and partition data. Uses API credentials for full read access.
3861
+ *
3862
+ * @tags User
3863
+ * @name GetUserData
3864
+ * @summary Get User Data
3865
+ * @request GET:/user/{userID}/userData
3866
+ * @secure
3867
+ */
3868
+ getUserData: (userId: string, params: RequestParams = {}) =>
3869
+ this.request<GetUserDataData, GetUserDataError>({
3870
+ path: `/user/${userId}/userData`,
3871
+ method: 'GET',
3872
+ secure: true,
3873
+ format: 'json',
3874
+ ...params,
3875
+ }),
3876
+
3839
3877
  /**
3840
3878
  * @description This route indicates users should not be able to advance or make changes to applications in this certification.
3841
3879
  *
@@ -3849,7 +3887,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3849
3887
  userId: string,
3850
3888
  certProcId: string,
3851
3889
  applicationType: string,
3852
- data: InputKnvh2Z7Rse,
3890
+ data: InputYkrswdxt80H,
3853
3891
  params: RequestParams = {}
3854
3892
  ) =>
3855
3893
  this.request<CreateCertificationApplicationLockData, CreateCertificationApplicationLockError>({
@@ -3913,7 +3951,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3913
3951
  userId: string,
3914
3952
  certProcId: string,
3915
3953
  applicationType: string,
3916
- data: InputPn24Tkrz5N,
3954
+ data: InputOu74Xwaupt,
3917
3955
  params: RequestParams = {}
3918
3956
  ) =>
3919
3957
  this.request<CreateCertificationApplicationReviewData, CreateCertificationApplicationReviewError>({
@@ -3938,7 +3976,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3938
3976
  userId: string,
3939
3977
  certProcId: string,
3940
3978
  applicationType: string,
3941
- data: Input2Dvhr78Yv,
3979
+ data: InputEoy83X4Gst,
3942
3980
  params: RequestParams = {}
3943
3981
  ) =>
3944
3982
  this.request<
@@ -3962,7 +4000,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3962
4000
  * @request POST:/user/certification/{certSpecID}/course/batchRedeem
3963
4001
  * @secure
3964
4002
  */
3965
- createCertificationCourseBatchRedeem: (certSpecId: string, data: Input766Ii876Sj, params: RequestParams = {}) =>
4003
+ createCertificationCourseBatchRedeem: (certSpecId: string, data: InputSzy4Sbd1Vek, params: RequestParams = {}) =>
3966
4004
  this.request<CreateCertificationCourseBatchRedeemData, CreateCertificationCourseBatchRedeemError>({
3967
4005
  path: `/user/certification/${certSpecId}/course/batchRedeem`,
3968
4006
  method: 'POST',
@@ -3981,7 +4019,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3981
4019
  * @request POST:/user/certification/{certSpecID}/course/batchInvite
3982
4020
  * @secure
3983
4021
  */
3984
- createCertificationCourseBatchInvite: (certSpecId: string, data: InputG1V252Slib, params: RequestParams = {}) =>
4022
+ createCertificationCourseBatchInvite: (certSpecId: string, data: Input0Xoiyidh46, params: RequestParams = {}) =>
3985
4023
  this.request<CreateCertificationCourseBatchInviteData, CreateCertificationCourseBatchInviteError>({
3986
4024
  path: `/user/certification/${certSpecId}/course/batchInvite`,
3987
4025
  method: 'POST',
@@ -4057,7 +4095,12 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4057
4095
  * @request POST:/user/{userID}/certification/{certProcID}/waive
4058
4096
  * @secure
4059
4097
  */
4060
- createCertificationWaive: (userId: string, certProcId: string, data: InputQfsksefyis, params: RequestParams = {}) =>
4098
+ createCertificationWaive: (
4099
+ userId: string,
4100
+ certProcId: string,
4101
+ data: Input9Gk1Eer7Ldh,
4102
+ params: RequestParams = {}
4103
+ ) =>
4061
4104
  this.request<CreateCertificationWaiveData, CreateCertificationWaiveError>({
4062
4105
  path: `/user/${userId}/certification/${certProcId}/waive`,
4063
4106
  method: 'POST',
@@ -4138,7 +4181,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4138
4181
  createCertificationTriggerSet: (
4139
4182
  userId: string,
4140
4183
  certProcId: string,
4141
- data: Input0Ckjw53Cpo,
4184
+ data: InputB03Ca4Xqtw,
4142
4185
  params: RequestParams = {}
4143
4186
  ) =>
4144
4187
  this.request<CreateCertificationTriggerSetData, CreateCertificationTriggerSetError>({
@@ -4248,7 +4291,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4248
4291
  certProcId: string,
4249
4292
  sourceId: string,
4250
4293
  itemVersion: string,
4251
- data: Input2D3A4F27Ipf,
4294
+ data: InputNqcjc8Hvq6,
4252
4295
  params: RequestParams = {}
4253
4296
  ) =>
4254
4297
  this.request<CreateCertificationApplicationItemReviewData, CreateCertificationApplicationItemReviewError>({
@@ -4293,7 +4336,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4293
4336
  userId: string,
4294
4337
  certProcId: string,
4295
4338
  applicationType: string,
4296
- data: InputRw404Uorif,
4339
+ data: InputEdu05Vaqm1,
4297
4340
  params: RequestParams = {}
4298
4341
  ) =>
4299
4342
  this.request<CreateCertificationApplicationSubmitData, CreateCertificationApplicationSubmitError>({
@@ -4319,7 +4362,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4319
4362
  certProcId: string,
4320
4363
  courseId: string,
4321
4364
  paId: string,
4322
- data: InputWoyg2Gtn48L,
4365
+ data: Input6Wmqoozm3,
4323
4366
  params: RequestParams = {}
4324
4367
  ) =>
4325
4368
  this.request<CreateCertificationCoursePendingApprovalData, CreateCertificationCoursePendingApprovalError>({
@@ -4345,7 +4388,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4345
4388
  certProcId: string,
4346
4389
  courseId: string,
4347
4390
  paId: string,
4348
- data: InputDfj95F0L6A,
4391
+ data: InputLir3Krf8Mnf,
4349
4392
  params: RequestParams = {}
4350
4393
  ) =>
4351
4394
  this.request<UpdateCertificationCoursePendingApprovalData, UpdateCertificationCoursePendingApprovalError>({
@@ -4369,7 +4412,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4369
4412
  createCertificationCourseRedeem: (
4370
4413
  userId: string,
4371
4414
  certProcId: string,
4372
- data: InputHd03Cx4Ul6,
4415
+ data: Input7Bzeouyok2,
4373
4416
  params: RequestParams = {}
4374
4417
  ) =>
4375
4418
  this.request<CreateCertificationCourseRedeemData, CreateCertificationCourseRedeemError>({
@@ -4417,7 +4460,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4417
4460
  userId: string,
4418
4461
  certProcId: string,
4419
4462
  courseId: string,
4420
- data: InputLa0684Ab34,
4463
+ data: InputIvdyk9Pfse,
4421
4464
  params: RequestParams = {}
4422
4465
  ) =>
4423
4466
  this.request<CreateCertificationCourseEndCooldownData, CreateCertificationCourseEndCooldownError>({
@@ -4442,7 +4485,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4442
4485
  userId: string,
4443
4486
  certProcId: string,
4444
4487
  courseId: string,
4445
- data: Input80Urs698Ps,
4488
+ data: Input1Ev9Bv5Hdvl,
4446
4489
  params: RequestParams = {}
4447
4490
  ) =>
4448
4491
  this.request<CreateCertificationCourseUnlockCourseData, CreateCertificationCourseUnlockCourseError>({
@@ -4463,7 +4506,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4463
4506
  * @request POST:/user/{userID}/updateITA
4464
4507
  * @secure
4465
4508
  */
4466
- createUpdateIta: (userId: string, data: InputThrd8Gc9Hsk, params: RequestParams = {}) =>
4509
+ createUpdateIta: (userId: string, data: InputTlq6Xv9Taz, params: RequestParams = {}) =>
4467
4510
  this.request<CreateUpdateItaData, CreateUpdateItaError>({
4468
4511
  path: `/user/${userId}/updateITA`,
4469
4512
  method: 'POST',
@@ -4486,7 +4529,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4486
4529
  userId: string,
4487
4530
  certProcId: string,
4488
4531
  courseId: string,
4489
- data: InputCo4Zlxh4K7,
4532
+ data: InputThseotb1Em,
4490
4533
  params: RequestParams = {}
4491
4534
  ) =>
4492
4535
  this.request<UpdateCertificationCourseOverrideResultData, UpdateCertificationCourseOverrideResultError>({
@@ -4510,7 +4553,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4510
4553
  updateCertificationSetDates: (
4511
4554
  userId: string,
4512
4555
  certProcId: string,
4513
- data: InputDfrz7Yoxs1,
4556
+ data: InputNhgat59Crhi,
4514
4557
  params: RequestParams = {}
4515
4558
  ) =>
4516
4559
  this.request<UpdateCertificationSetDatesData, UpdateCertificationSetDatesError>({
@@ -4549,7 +4592,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4549
4592
  * @request POST:/users/certification/{certSpecID}
4550
4593
  * @secure
4551
4594
  */
4552
- createCertification: (certSpecId: string, data: InputI1Fdsdjf1C, params: RequestParams = {}) =>
4595
+ createCertification: (certSpecId: string, data: InputMiwmdmv0H5, params: RequestParams = {}) =>
4553
4596
  this.request<CreateCertificationResult, CreateCertificationFail>({
4554
4597
  path: `/users/certification/${certSpecId}`,
4555
4598
  method: 'POST',