@ikonintegration/bccsa-program-api 3.0.33 → 3.0.35

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 InputSol3K0Ly82 {
20
+ export interface InputRr9Kp8P5Qu {
21
21
  /**
22
22
  * Name of the person filling out the contact form
23
23
  * @example "John Doe"
@@ -516,6 +516,8 @@ export interface PendingApprovalResponseSchema {
516
516
  sponsorshipRemindersStudent?: SponsorshipRemindersStudent
517
517
  /** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
518
518
  sponsorshipRemindersSponsor?: SponsorshipRemindersSponsor
519
+ /** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
520
+ remindersStartedOn?: RemindersStartedOn
519
521
  }[]
520
522
  | null
521
523
  }
@@ -565,7 +567,10 @@ export type SponsorshipRemindersStudent = string[]
565
567
  /** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
566
568
  export type SponsorshipRemindersSponsor = string[]
567
569
 
568
- export interface InputHtrrxf8Yp9K {
570
+ /** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
571
+ export type RemindersStartedOn = number
572
+
573
+ export interface InputHvh2Rhjuk6 {
569
574
  /**
570
575
  * ID of the certification to filter applications by
571
576
  * @example "certification123"
@@ -623,7 +628,7 @@ export interface InputHtrrxf8Yp9K {
623
628
  ignoreCompletedCertifications?: boolean | null
624
629
  }
625
630
 
626
- export interface InputTq7O0B5F3S {
631
+ export interface Input5K8X950Ztg {
627
632
  /**
628
633
  * ID of the certification to filter applications by
629
634
  * @example "certification123"
@@ -681,7 +686,7 @@ export interface InputTq7O0B5F3S {
681
686
  ignoreCompletedCertifications?: boolean | null
682
687
  }
683
688
 
684
- export interface InputVeillj4Rt0L {
689
+ export interface InputV73Gd5K2S3 {
685
690
  /**
686
691
  * ID of the certification to filter applications by
687
692
  * @example "certification123"
@@ -739,7 +744,7 @@ export interface InputVeillj4Rt0L {
739
744
  ignoreCompletedCertifications?: boolean | null
740
745
  }
741
746
 
742
- export interface InputOaldjlebnx {
747
+ export interface InputYuucneuxkg {
743
748
  /**
744
749
  * The ID of the certificate specifications to be used for the email
745
750
  * @example "certSpecsID123"
@@ -781,7 +786,7 @@ export interface InputOaldjlebnx {
781
786
  }[]
782
787
  }
783
788
 
784
- export interface InputKkyamupnlt {
789
+ export interface InputIc5N9Ldrci {
785
790
  /**
786
791
  * The ID of the product for which the license is being redeemed
787
792
  * @example "productID123"
@@ -794,7 +799,7 @@ export interface InputKkyamupnlt {
794
799
  sessionID?: string
795
800
  }
796
801
 
797
- export interface InputUkvmhdqu3Zh {
802
+ export interface InputJu8Q7Jd4Rm {
798
803
  /**
799
804
  * Search term to filter licenses
800
805
  * @example "active"
@@ -812,7 +817,7 @@ export interface InputUkvmhdqu3Zh {
812
817
  sortField?: any
813
818
  }
814
819
 
815
- export interface Input0Hxcnrsc8S {
820
+ export interface InputU8Srhwp84Ch {
816
821
  /**
817
822
  * Search term to filter licenses
818
823
  * @example "active"
@@ -949,10 +954,12 @@ export interface SearchPendingApprovalsResponseSchema {
949
954
  sponsorshipRemindersStudent?: SponsorshipRemindersStudent
950
955
  /** Pending sponsorship request reminders sent to the sponsor (array with reminder IDs, where reminderID is template-numdays) */
951
956
  sponsorshipRemindersSponsor?: SponsorshipRemindersSponsor
957
+ /** Timestamp when the current sponsorship reminder schedule started (set on create and on reset). Reminder dueness is measured from it; when absent, from createdOn. */
958
+ remindersStartedOn?: RemindersStartedOn
952
959
  }[]
953
960
  }
954
961
 
955
- export interface Input7Il0Lvxsvl {
962
+ export interface InputF5Jjnrfmt7I {
956
963
  /**
957
964
  * Start date for the report
958
965
  * @example "2023-01-01T00:00:00Z"
@@ -975,12 +982,12 @@ export interface Input7Il0Lvxsvl {
975
982
  dateType?: string
976
983
  }
977
984
 
978
- export interface InputJ0Hrmeexdj {
985
+ export interface Input5Nynw58Ws1 {
979
986
  /** List of user IDs to search for in the tenant. */
980
987
  IDs: (string | null)[]
981
988
  }
982
989
 
983
- export interface InputVawcwl0959 {
990
+ export interface Input4H67Nuuo8P {
984
991
  /** The term to search for in the user profiles. */
985
992
  searchTerm?: string | null
986
993
  /** Filter criteria for the user search. */
@@ -1021,7 +1028,7 @@ export interface InputVawcwl0959 {
1021
1028
  }
1022
1029
  }
1023
1030
 
1024
- export interface InputHlghz0Fmyni {
1031
+ export interface Input2Mihdr2Tcif {
1025
1032
  /** The term to search for in the user profiles. */
1026
1033
  searchTerm?: string | null
1027
1034
  /** Filter criteria for the user search. */
@@ -1062,7 +1069,7 @@ export interface InputHlghz0Fmyni {
1062
1069
  }
1063
1070
  }
1064
1071
 
1065
- export interface OutputCd7158Kel5 {
1072
+ export interface OutputJqh0F2Rq94L {
1066
1073
  /** External system ID 2 */
1067
1074
  userCount: ExternalID2
1068
1075
  transactionID?: string | null
@@ -1071,7 +1078,7 @@ export interface OutputCd7158Kel5 {
1071
1078
  /** External system ID 2 */
1072
1079
  export type ExternalID2 = number
1073
1080
 
1074
- export interface Output3O35Fw2D54 {
1081
+ export interface Output5Qmmfjb7J6 {
1075
1082
  /**
1076
1083
  * Signed URL for the course file
1077
1084
  * @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"
@@ -1079,7 +1086,7 @@ export interface Output3O35Fw2D54 {
1079
1086
  fileURL: string
1080
1087
  }
1081
1088
 
1082
- export interface Output50Y5W4Go7Uk {
1089
+ export interface Output7Jte254C0P {
1083
1090
  /**
1084
1091
  * Amount to be refunded for the cancellation
1085
1092
  * @example 0
@@ -1405,7 +1412,7 @@ export interface CourseResponseEntity {
1405
1412
  /** Label of the course enrolled (course version) */
1406
1413
  export type OnlineCourseLabel = string
1407
1414
 
1408
- export interface OutputEm74Prnnzq {
1415
+ export interface Output6Lxou5Wadvl {
1409
1416
  /**
1410
1417
  * Signed URL for the course file
1411
1418
  * @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"
@@ -1425,7 +1432,7 @@ export interface UserExpandedCPResponseSchema {
1425
1432
  }
1426
1433
 
1427
1434
  /** Application Foreign Fill response type */
1428
- export interface OutputXqrs2Wd9Tkl {
1435
+ export interface OutputDrnp2Yirpi {
1429
1436
  items: {
1430
1437
  userID: string
1431
1438
  createdOn?: number
@@ -1629,7 +1636,7 @@ export interface CertificationProcessResponseEntity {
1629
1636
  transactionID?: string | null
1630
1637
  }
1631
1638
 
1632
- export interface InputZe9R08Tm0T {
1639
+ export interface InputUdco8Yiz4U {
1633
1640
  issuedOn?: number
1634
1641
  expiresOn?: number
1635
1642
  fileItems?: {
@@ -1639,7 +1646,7 @@ export interface InputZe9R08Tm0T {
1639
1646
  additionalNotes?: string | null
1640
1647
  }
1641
1648
 
1642
- export interface Input5Xqw5Xwyot {
1649
+ export interface InputWkff4Yaywy {
1643
1650
  /**
1644
1651
  * Indicates whether the application is locked
1645
1652
  * @example true
@@ -1647,7 +1654,7 @@ export interface Input5Xqw5Xwyot {
1647
1654
  isApplicationLocked: boolean
1648
1655
  }
1649
1656
 
1650
- export interface OutputZe2P71Jl4Ph {
1657
+ export interface Output6S8Rfzxiuf {
1651
1658
  /**
1652
1659
  * Signed URL for the course file
1653
1660
  * @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"
@@ -1655,7 +1662,7 @@ export interface OutputZe2P71Jl4Ph {
1655
1662
  fileURL: string
1656
1663
  }
1657
1664
 
1658
- export interface InputKc1Ehdb5Ps {
1665
+ export interface InputKa30H4Ner6 {
1659
1666
  /**
1660
1667
  * Indicates whether the waiver is approved
1661
1668
  * @example true
@@ -1668,7 +1675,7 @@ export interface InputKc1Ehdb5Ps {
1668
1675
  additionalNotes?: string | null
1669
1676
  }
1670
1677
 
1671
- export interface InputFrbe30I85S {
1678
+ export interface InputP7Rzxtpwwc {
1672
1679
  /**
1673
1680
  * Optional notes regarding the waiver
1674
1681
  * @example "Waiver granted due to special circumstances."
@@ -1676,7 +1683,7 @@ export interface InputFrbe30I85S {
1676
1683
  additionalNotes?: string | null
1677
1684
  }
1678
1685
 
1679
- export interface Input5L25G7Qxfo {
1686
+ export interface InputY2D9S4Qy4S {
1680
1687
  students: {
1681
1688
  /**
1682
1689
  * User ID of the student to redeem the course for
@@ -1711,7 +1718,7 @@ export interface Input5L25G7Qxfo {
1711
1718
  autoEnrolSessionID?: string
1712
1719
  }
1713
1720
 
1714
- export interface InputLkqgxr42Ux {
1721
+ export interface Input62Nyiggonmh {
1715
1722
  invites: {
1716
1723
  /**
1717
1724
  * Email address of the user to invite
@@ -1741,7 +1748,7 @@ export interface InputLkqgxr42Ux {
1741
1748
  isReservedSeat: boolean
1742
1749
  }
1743
1750
 
1744
- export interface InputHvql6Tv30P {
1751
+ export interface InputXqdgr5Oa5Vh {
1745
1752
  /**
1746
1753
  * Indicates whether to waive the certification process
1747
1754
  * @example true
@@ -1755,7 +1762,7 @@ export interface InputHvql6Tv30P {
1755
1762
  }
1756
1763
 
1757
1764
  /** Certification move response schema */
1758
- export interface OutputIpk3Gr4Jn2 {
1765
+ export interface Output6D4Ct52Qpe {
1759
1766
  errors?: {
1760
1767
  status: string
1761
1768
  object?: Record<string, any>
@@ -1764,12 +1771,12 @@ export interface OutputIpk3Gr4Jn2 {
1764
1771
  }
1765
1772
 
1766
1773
  /** Schema for writing a certification trigger check. */
1767
- export interface InputIccc9Wkdt9 {
1774
+ export interface InputUysjux8Zp4 {
1768
1775
  /**
1769
1776
  * The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
1770
1777
  * @example "CHECKED"
1771
1778
  */
1772
- value: InputIccc9Wkdt9ValueEnum
1779
+ value: InputUysjux8Zp4ValueEnum
1773
1780
  /**
1774
1781
  * List of course IDs that are blocked by this trigger check.
1775
1782
  * @example ["course1","course2"]
@@ -1777,7 +1784,7 @@ export interface InputIccc9Wkdt9 {
1777
1784
  blockedCourses?: string[]
1778
1785
  }
1779
1786
 
1780
- export interface InputWk711Xrjeq {
1787
+ export interface Input1Lghooas4I {
1781
1788
  /**
1782
1789
  * Indicates whether the application item is approved
1783
1790
  * @example true
@@ -1805,7 +1812,7 @@ export interface StudentHistoryRequestSchema {
1805
1812
  requirements: string[]
1806
1813
  }
1807
1814
 
1808
- export interface InputTtdoeespbb {
1815
+ export interface InputCgletgibfvi {
1809
1816
  /**
1810
1817
  * Optional activation key for the application
1811
1818
  * @example "AK-123456"
@@ -1814,7 +1821,7 @@ export interface InputTtdoeespbb {
1814
1821
  }
1815
1822
 
1816
1823
  /** Schema for course submission item details post request. */
1817
- export interface InputCvqczxrsu6 {
1824
+ export interface InputOszbc2Lfht {
1818
1825
  /**
1819
1826
  * The ID of the file being submitted.
1820
1827
  * @example "fileID123"
@@ -1828,7 +1835,7 @@ export interface InputCvqczxrsu6 {
1828
1835
  }
1829
1836
 
1830
1837
  /** Schema for the response to course submission item details post request. */
1831
- export interface OutputCvqczxrsu6 {
1838
+ export interface OutputOszbc2Lfht {
1832
1839
  submissionItems: {
1833
1840
  /**
1834
1841
  * The ID of the file being submitted.
@@ -1844,7 +1851,7 @@ export interface OutputCvqczxrsu6 {
1844
1851
  }
1845
1852
 
1846
1853
  /** Pending approval submission parameters */
1847
- export interface InputPmeud0A4Jo {
1854
+ export interface InputDv9Ni3Aar5 {
1848
1855
  /**
1849
1856
  * Type of pending approval
1850
1857
  * @example "certification"
@@ -1865,7 +1872,7 @@ export interface InputPmeud0A4Jo {
1865
1872
  }[]
1866
1873
  }
1867
1874
 
1868
- export interface Input92Ud3Ap8Ee {
1875
+ export interface InputGhxoi4I6V8 {
1869
1876
  /**
1870
1877
  * The ID of the course for which the license is being redeemed
1871
1878
  * @example "courseID123"
@@ -1934,7 +1941,7 @@ export interface Input92Ud3Ap8Ee {
1934
1941
  }
1935
1942
 
1936
1943
  /** Validate certification move response schema */
1937
- export interface OutputZ780Quci3Tj {
1944
+ export interface OutputMlk3Y0Sufr {
1938
1945
  courses: {
1939
1946
  name: string
1940
1947
  status: string
@@ -1946,7 +1953,7 @@ export interface OutputZ780Quci3Tj {
1946
1953
  mustCreateCP: boolean
1947
1954
  }
1948
1955
 
1949
- export interface InputAyclmizttx {
1956
+ export interface InputHod6Xcmzr8 {
1950
1957
  /**
1951
1958
  * Comments regarding the end of the cooldown period
1952
1959
  * @example "Cooldown period ended successfully."
@@ -1954,7 +1961,7 @@ export interface InputAyclmizttx {
1954
1961
  comments: string
1955
1962
  }
1956
1963
 
1957
- export interface OutputKqxt1Tamp1K {
1964
+ export interface OutputFn02Htoomy {
1958
1965
  /**
1959
1966
  * Signed URL for the course file
1960
1967
  * @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"
@@ -1962,7 +1969,7 @@ export interface OutputKqxt1Tamp1K {
1962
1969
  fileURL: string
1963
1970
  }
1964
1971
 
1965
- export interface InputQeh5M92Xpeh {
1972
+ export interface Input4S9Bu0T1Ng {
1966
1973
  /** @example true */
1967
1974
  agreedWithCertTerms: boolean
1968
1975
  /** @example 1717230000000 */
@@ -2049,7 +2056,7 @@ export interface Sponsor {
2049
2056
  title?: Title
2050
2057
  }
2051
2058
 
2052
- export interface Input7Tzs0Tv2Q5 {
2059
+ export interface InputX4U7C4Jq36 {
2053
2060
  /**
2054
2061
  * Comments regarding the course unlock action
2055
2062
  * @example "Course unlocked successfully."
@@ -2057,7 +2064,7 @@ export interface Input7Tzs0Tv2Q5 {
2057
2064
  comments: string
2058
2065
  }
2059
2066
 
2060
- export interface Input0J4N9Uwfcb {
2067
+ export interface InputBmpgyhghyb {
2061
2068
  /**
2062
2069
  * ITA number to update for the user
2063
2070
  * @example "ITA123456"
@@ -2065,7 +2072,7 @@ export interface Input0J4N9Uwfcb {
2065
2072
  itaNumber: string
2066
2073
  }
2067
2074
 
2068
- export interface InputCe5785R8Zs {
2075
+ export interface Input3Q79Al8T06 {
2069
2076
  /** @example true */
2070
2077
  agreedWithCertTerms: boolean
2071
2078
  /** @example 1717230000000 */
@@ -2140,7 +2147,7 @@ export interface InputCe5785R8Zs {
2140
2147
  sponsor?: Sponsor
2141
2148
  }
2142
2149
 
2143
- export interface InputFih2S2Mlabl {
2150
+ export interface InputW1Qz7Aegx2 {
2144
2151
  /**
2145
2152
  * The grade to override the course result with
2146
2153
  * @example "A"
@@ -2149,7 +2156,7 @@ export interface InputFih2S2Mlabl {
2149
2156
  }
2150
2157
 
2151
2158
  /** Pending approval review parameters */
2152
- export interface Input711J32K5Lx {
2159
+ export interface InputAihldyxydl {
2153
2160
  /**
2154
2161
  * Notes provided by the reviewer for the pending approval
2155
2162
  * @example "Please review the submitted documents."
@@ -2163,7 +2170,7 @@ export interface Input711J32K5Lx {
2163
2170
  }
2164
2171
 
2165
2172
  /** Schema for overriding course result dates. */
2166
- export interface InputLwd5Q9Dzkoi {
2173
+ export interface InputL5Uvh80Jwdh {
2167
2174
  /**
2168
2175
  * The date when the course result expires, in milliseconds since epoch.
2169
2176
  * @example 1735689600000
@@ -2176,7 +2183,10 @@ export interface InputLwd5Q9Dzkoi {
2176
2183
  completionDate?: number
2177
2184
  }
2178
2185
 
2179
- export interface InputF71Vj36Lnw {
2186
+ /** Reset sponsorship request takes no body */
2187
+ export type ResetSponsorshipBody = object
2188
+
2189
+ export interface InputWmysx72Yqg {
2180
2190
  filter: {
2181
2191
  from?: number
2182
2192
  sortOrder?: string
@@ -2184,7 +2194,7 @@ export interface InputF71Vj36Lnw {
2184
2194
  }
2185
2195
  }
2186
2196
 
2187
- export interface OutputF71Vj36Lnw {
2197
+ export interface OutputWmysx72Yqg {
2188
2198
  users: {
2189
2199
  firstName: string
2190
2200
  lastName: string
@@ -2210,7 +2220,7 @@ export enum ReportXlsxSchemaContentTypeEnum {
2210
2220
  * The value of the trigger check, [CHECKED, UNCHECKED, NOVALUE]
2211
2221
  * @example "CHECKED"
2212
2222
  */
2213
- export enum InputIccc9Wkdt9ValueEnum {
2223
+ export enum InputUysjux8Zp4ValueEnum {
2214
2224
  CHECKED = 'CHECKED',
2215
2225
  UNCHECKED = 'UNCHECKED',
2216
2226
  NOVALUE = 'NOVALUE',
@@ -2368,7 +2378,7 @@ export type CreateReportUsersSimpleData = any
2368
2378
 
2369
2379
  export type CreateReportUsersSimpleError = ErrorResponse
2370
2380
 
2371
- export type CreateSearchUsersCountData = OutputCd7158Kel5
2381
+ export type CreateSearchUsersCountData = OutputJqh0F2Rq94L
2372
2382
 
2373
2383
  export type CreateSearchUsersCountError = ErrorResponse
2374
2384
 
@@ -2416,7 +2426,7 @@ export type DeleteCertificationCourseFileSignData = any
2416
2426
 
2417
2427
  export type DeleteCertificationCourseFileSignError = ErrorResponse
2418
2428
 
2419
- export type GetCertificationCourseFileSignData = OutputEm74Prnnzq
2429
+ export type GetCertificationCourseFileSignData = Output6Lxou5Wadvl
2420
2430
 
2421
2431
  export type GetCertificationCourseFileSignError = ErrorResponse
2422
2432
 
@@ -2433,7 +2443,7 @@ export interface CreateCertificationCourseFileSignParams {
2433
2443
  fileId: string
2434
2444
  }
2435
2445
 
2436
- export type CreateCertificationCourseFileSignData = OutputKqxt1Tamp1K
2446
+ export type CreateCertificationCourseFileSignData = OutputFn02Htoomy
2437
2447
 
2438
2448
  export type CreateCertificationCourseFileSignError = ErrorResponse
2439
2449
 
@@ -2441,7 +2451,7 @@ export type DeleteCertificationCourseDocumentData = any
2441
2451
 
2442
2452
  export type DeleteCertificationCourseDocumentError = ErrorResponse
2443
2453
 
2444
- export type CreateCertificationCourseDocumentData = OutputCvqczxrsu6
2454
+ export type CreateCertificationCourseDocumentData = OutputOszbc2Lfht
2445
2455
 
2446
2456
  export type CreateCertificationCourseDocumentError = ErrorResponse
2447
2457
 
@@ -2465,7 +2475,7 @@ export type DeleteCertificationCourseData = any
2465
2475
 
2466
2476
  export type DeleteCertificationCourseError = ErrorResponse
2467
2477
 
2468
- export type GetCertificationApplicationItemFileData = Output3O35Fw2D54
2478
+ export type GetCertificationApplicationItemFileData = Output5Qmmfjb7J6
2469
2479
 
2470
2480
  export type GetCertificationApplicationItemFileError = ErrorResponse
2471
2481
 
@@ -2482,11 +2492,11 @@ export interface CreateCertificationApplicationItemFileParams {
2482
2492
  fileVersion: string
2483
2493
  }
2484
2494
 
2485
- export type CreateCertificationApplicationItemFileData = OutputZe2P71Jl4Ph
2495
+ export type CreateCertificationApplicationItemFileData = Output6S8Rfzxiuf
2486
2496
 
2487
2497
  export type CreateCertificationApplicationItemFileError = ErrorResponse
2488
2498
 
2489
- export type GetCertificationCourseSessionCalcCancelationChargesData = Output50Y5W4Go7Uk
2499
+ export type GetCertificationCourseSessionCalcCancelationChargesData = Output7Jte254C0P
2490
2500
 
2491
2501
  export type GetCertificationCourseSessionCalcCancelationChargesError = ErrorResponse
2492
2502
 
@@ -2502,7 +2512,7 @@ export type GetCertificationsExpandedData = UserExpandedCPResponseSchema
2502
2512
 
2503
2513
  export type GetCertificationsExpandedError = ErrorResponse
2504
2514
 
2505
- export type GetCertificationApplicationForeignFillData = OutputXqrs2Wd9Tkl
2515
+ export type GetCertificationApplicationForeignFillData = OutputDrnp2Yirpi
2506
2516
 
2507
2517
  export type GetCertificationApplicationForeignFillError = ErrorResponse
2508
2518
 
@@ -2570,7 +2580,7 @@ export type CreateCertificationWaiveData = any
2570
2580
 
2571
2581
  export type CreateCertificationWaiveError = ErrorResponse
2572
2582
 
2573
- export type CreateCertificationMoveData = OutputIpk3Gr4Jn2
2583
+ export type CreateCertificationMoveData = Output6D4Ct52Qpe
2574
2584
 
2575
2585
  export type CreateCertificationMoveError = ErrorResponse
2576
2586
 
@@ -2634,7 +2644,7 @@ export type CreateCertificationCourseRedeemData = any
2634
2644
 
2635
2645
  export type CreateCertificationCourseRedeemError = ErrorResponse
2636
2646
 
2637
- export type CreateCertificationMoveValidateData = OutputZ780Quci3Tj
2647
+ export type CreateCertificationMoveValidateData = OutputMlk3Y0Sufr
2638
2648
 
2639
2649
  export type CreateCertificationMoveValidateError = ErrorResponse
2640
2650
 
@@ -2666,7 +2676,11 @@ export type CreateCertificationCourseRequestEnrolmentData = any
2666
2676
 
2667
2677
  export type CreateCertificationCourseRequestEnrolmentError = ErrorResponse
2668
2678
 
2669
- export type CreateCertificationResult = OutputF71Vj36Lnw
2679
+ export type CreateSponsorshipResetData = any
2680
+
2681
+ export type CreateSponsorshipResetError = ErrorResponse
2682
+
2683
+ export type CreateCertificationResult = OutputWmysx72Yqg
2670
2684
 
2671
2685
  export type CreateCertificationFail = ErrorResponse
2672
2686
 
@@ -2812,7 +2826,7 @@ export class HttpClient<SecurityDataType = unknown> {
2812
2826
 
2813
2827
  /**
2814
2828
  * @title BCCSA Program API
2815
- * @version 3.0.33
2829
+ * @version 3.0.35
2816
2830
  * @baseUrl http://localhost:8080
2817
2831
  * @contact Ikon Integration <ikon@ikonintegration.com> (http://example.com)
2818
2832
  */
@@ -2827,7 +2841,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
2827
2841
  * @request POST:/contactUs
2828
2842
  * @secure
2829
2843
  */
2830
- listContactUs: (data: InputSol3K0Ly82, params: RequestParams = {}) =>
2844
+ listContactUs: (data: InputRr9Kp8P5Qu, params: RequestParams = {}) =>
2831
2845
  this.request<ListContactUsData, ListContactUsError>({
2832
2846
  path: `/contactUs`,
2833
2847
  method: 'POST',
@@ -3008,7 +3022,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3008
3022
  * @request POST:/tenant/report/applicationExport
3009
3023
  * @secure
3010
3024
  */
3011
- createReportApplicationExport: (data: InputHtrrxf8Yp9K, params: RequestParams = {}) =>
3025
+ createReportApplicationExport: (data: InputHvh2Rhjuk6, params: RequestParams = {}) =>
3012
3026
  this.request<CreateReportApplicationExportData, CreateReportApplicationExportError>({
3013
3027
  path: `/tenant/report/applicationExport`,
3014
3028
  method: 'POST',
@@ -3027,7 +3041,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3027
3041
  * @request POST:/tenant/report/applicationStatus
3028
3042
  * @secure
3029
3043
  */
3030
- listReportApplicationStatus: (data: InputTq7O0B5F3S, params: RequestParams = {}) =>
3044
+ listReportApplicationStatus: (data: Input5K8X950Ztg, params: RequestParams = {}) =>
3031
3045
  this.request<ListReportApplicationStatusData, ListReportApplicationStatusError>({
3032
3046
  path: `/tenant/report/applicationStatus`,
3033
3047
  method: 'POST',
@@ -3046,7 +3060,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3046
3060
  * @request POST:/tenant/report/applicationsReport
3047
3061
  * @secure
3048
3062
  */
3049
- createReportApplicationsReport: (data: InputVeillj4Rt0L, params: RequestParams = {}) =>
3063
+ createReportApplicationsReport: (data: InputV73Gd5K2S3, params: RequestParams = {}) =>
3050
3064
  this.request<CreateReportApplicationsReportData, CreateReportApplicationsReportError>({
3051
3065
  path: `/tenant/report/applicationsReport`,
3052
3066
  method: 'POST',
@@ -3065,7 +3079,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3065
3079
  * @request POST:/tenant/certificates/email
3066
3080
  * @secure
3067
3081
  */
3068
- createCertificatesEmail: (data: InputOaldjlebnx, params: RequestParams = {}) =>
3082
+ createCertificatesEmail: (data: InputYuucneuxkg, params: RequestParams = {}) =>
3069
3083
  this.request<CreateCertificatesEmailData, CreateCertificatesEmailError>({
3070
3084
  path: `/tenant/certificates/email`,
3071
3085
  method: 'POST',
@@ -3123,7 +3137,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3123
3137
  * @request POST:/tenant/license/redeem/{userID}
3124
3138
  * @secure
3125
3139
  */
3126
- createLicenseRedeem: (userId: string, data: InputKkyamupnlt, params: RequestParams = {}) =>
3140
+ createLicenseRedeem: (userId: string, data: InputIc5N9Ldrci, params: RequestParams = {}) =>
3127
3141
  this.request<CreateLicenseRedeemData, CreateLicenseRedeemError>({
3128
3142
  path: `/tenant/license/redeem/${userId}`,
3129
3143
  method: 'POST',
@@ -3142,7 +3156,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3142
3156
  * @request POST:/tenant/report/orglicenses/
3143
3157
  * @secure
3144
3158
  */
3145
- listReportOrglicenses: (data: InputUkvmhdqu3Zh, params: RequestParams = {}) =>
3159
+ listReportOrglicenses: (data: InputJu8Q7Jd4Rm, params: RequestParams = {}) =>
3146
3160
  this.request<ListReportOrglicensesData, ListReportOrglicensesError>({
3147
3161
  path: `/tenant/report/orglicenses/`,
3148
3162
  method: 'POST',
@@ -3161,7 +3175,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3161
3175
  * @request POST:/tenant/report/orglicenses/preview
3162
3176
  * @secure
3163
3177
  */
3164
- createReportOrglicensesPreview: (data: Input0Hxcnrsc8S, params: RequestParams = {}) =>
3178
+ createReportOrglicensesPreview: (data: InputU8Srhwp84Ch, params: RequestParams = {}) =>
3165
3179
  this.request<CreateReportOrglicensesPreviewData, CreateReportOrglicensesPreviewError>({
3166
3180
  path: `/tenant/report/orglicenses/preview`,
3167
3181
  method: 'POST',
@@ -3240,7 +3254,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3240
3254
  * @request POST:/tenant/report/users/advanced
3241
3255
  * @secure
3242
3256
  */
3243
- createReportUsersAdvanced: (data: Input7Il0Lvxsvl, params: RequestParams = {}) =>
3257
+ createReportUsersAdvanced: (data: InputF5Jjnrfmt7I, params: RequestParams = {}) =>
3244
3258
  this.request<CreateReportUsersAdvancedData, CreateReportUsersAdvancedError>({
3245
3259
  path: `/tenant/report/users/advanced`,
3246
3260
  method: 'POST',
@@ -3259,7 +3273,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3259
3273
  * @request POST:/tenant/search/users/ids
3260
3274
  * @secure
3261
3275
  */
3262
- listSearchUsersIds: (data: InputJ0Hrmeexdj, params: RequestParams = {}) =>
3276
+ listSearchUsersIds: (data: Input5Nynw58Ws1, params: RequestParams = {}) =>
3263
3277
  this.request<ListSearchUsersIdsData, ListSearchUsersIdsError>({
3264
3278
  path: `/tenant/search/users/ids`,
3265
3279
  method: 'POST',
@@ -3278,7 +3292,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3278
3292
  * @request POST:/tenant/search/users/term
3279
3293
  * @secure
3280
3294
  */
3281
- createSearchUsersTerm: (data: InputVawcwl0959, params: RequestParams = {}) =>
3295
+ createSearchUsersTerm: (data: Input4H67Nuuo8P, params: RequestParams = {}) =>
3282
3296
  this.request<CreateSearchUsersTermData, CreateSearchUsersTermError>({
3283
3297
  path: `/tenant/search/users/term`,
3284
3298
  method: 'POST',
@@ -3297,7 +3311,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3297
3311
  * @request POST:/tenant/report/users/simple
3298
3312
  * @secure
3299
3313
  */
3300
- createReportUsersSimple: (data: InputHlghz0Fmyni, params: RequestParams = {}) =>
3314
+ createReportUsersSimple: (data: Input2Mihdr2Tcif, params: RequestParams = {}) =>
3301
3315
  this.request<CreateReportUsersSimpleData, CreateReportUsersSimpleError>({
3302
3316
  path: `/tenant/report/users/simple`,
3303
3317
  method: 'POST',
@@ -3385,7 +3399,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3385
3399
  certProcId: string,
3386
3400
  applicationType: string,
3387
3401
  sourceId: string,
3388
- data: InputZe9R08Tm0T,
3402
+ data: InputUdco8Yiz4U,
3389
3403
  params: RequestParams = {}
3390
3404
  ) =>
3391
3405
  this.request<CreateCertificationApplicationItemData, CreateCertificationApplicationItemError>({
@@ -3645,7 +3659,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3645
3659
  certProcId: string,
3646
3660
  courseId: string,
3647
3661
  fileId: string,
3648
- data: InputCvqczxrsu6,
3662
+ data: InputOszbc2Lfht,
3649
3663
  params: RequestParams = {}
3650
3664
  ) =>
3651
3665
  this.request<CreateCertificationCourseDocumentData, CreateCertificationCourseDocumentError>({
@@ -3702,7 +3716,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3702
3716
  * @request POST:/user/{userID}
3703
3717
  * @secure
3704
3718
  */
3705
- createUser: (userId: string, data: InputQeh5M92Xpeh, params: RequestParams = {}) =>
3719
+ createUser: (userId: string, data: Input4S9Bu0T1Ng, params: RequestParams = {}) =>
3706
3720
  this.request<CreateUserData, CreateUserError>({
3707
3721
  path: `/user/${userId}`,
3708
3722
  method: 'POST',
@@ -3713,7 +3727,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3713
3727
  }),
3714
3728
 
3715
3729
  /**
3716
- * @description Update user in the system. This endpoint allows you to update a user with the provided details. The user will be updated to the database and an email notification will be sent to the user.
3730
+ * @description Update user in the system. This endpoint allows you to update a user with the provided details. The user will be updated to the database and an email notification will be sent to the user. When provided, the sponsor is saved on the user only; this does not update the pending sponsorship request or email the sponsor. Use POST /user/{userID}/sponsorship/reset to refresh the pending request from the stored sponsor and re-send the request.
3717
3731
  *
3718
3732
  * @tags User
3719
3733
  * @name UpdateUser
@@ -3721,7 +3735,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3721
3735
  * @request PUT:/user/{userID}
3722
3736
  * @secure
3723
3737
  */
3724
- updateUser: (userId: string, data: InputCe5785R8Zs, params: RequestParams = {}) =>
3738
+ updateUser: (userId: string, data: Input3Q79Al8T06, params: RequestParams = {}) =>
3725
3739
  this.request<UpdateUserData, UpdateUserError>({
3726
3740
  path: `/user/${userId}`,
3727
3741
  method: 'PUT',
@@ -3999,7 +4013,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
3999
4013
  userId: string,
4000
4014
  certProcId: string,
4001
4015
  applicationType: string,
4002
- data: Input5Xqw5Xwyot,
4016
+ data: InputWkff4Yaywy,
4003
4017
  params: RequestParams = {}
4004
4018
  ) =>
4005
4019
  this.request<CreateCertificationApplicationLockData, CreateCertificationApplicationLockError>({
@@ -4063,7 +4077,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4063
4077
  userId: string,
4064
4078
  certProcId: string,
4065
4079
  applicationType: string,
4066
- data: InputKc1Ehdb5Ps,
4080
+ data: InputKa30H4Ner6,
4067
4081
  params: RequestParams = {}
4068
4082
  ) =>
4069
4083
  this.request<CreateCertificationApplicationReviewData, CreateCertificationApplicationReviewError>({
@@ -4088,7 +4102,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4088
4102
  userId: string,
4089
4103
  certProcId: string,
4090
4104
  applicationType: string,
4091
- data: InputFrbe30I85S,
4105
+ data: InputP7Rzxtpwwc,
4092
4106
  params: RequestParams = {}
4093
4107
  ) =>
4094
4108
  this.request<
@@ -4112,7 +4126,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4112
4126
  * @request POST:/user/certification/{certSpecID}/course/batchRedeem
4113
4127
  * @secure
4114
4128
  */
4115
- createCertificationCourseBatchRedeem: (certSpecId: string, data: Input5L25G7Qxfo, params: RequestParams = {}) =>
4129
+ createCertificationCourseBatchRedeem: (certSpecId: string, data: InputY2D9S4Qy4S, params: RequestParams = {}) =>
4116
4130
  this.request<CreateCertificationCourseBatchRedeemData, CreateCertificationCourseBatchRedeemError>({
4117
4131
  path: `/user/certification/${certSpecId}/course/batchRedeem`,
4118
4132
  method: 'POST',
@@ -4131,7 +4145,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4131
4145
  * @request POST:/user/certification/{certSpecID}/course/batchInvite
4132
4146
  * @secure
4133
4147
  */
4134
- createCertificationCourseBatchInvite: (certSpecId: string, data: InputLkqgxr42Ux, params: RequestParams = {}) =>
4148
+ createCertificationCourseBatchInvite: (certSpecId: string, data: Input62Nyiggonmh, params: RequestParams = {}) =>
4135
4149
  this.request<CreateCertificationCourseBatchInviteData, CreateCertificationCourseBatchInviteError>({
4136
4150
  path: `/user/certification/${certSpecId}/course/batchInvite`,
4137
4151
  method: 'POST',
@@ -4207,7 +4221,12 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4207
4221
  * @request POST:/user/{userID}/certification/{certProcID}/waive
4208
4222
  * @secure
4209
4223
  */
4210
- createCertificationWaive: (userId: string, certProcId: string, data: InputHvql6Tv30P, params: RequestParams = {}) =>
4224
+ createCertificationWaive: (
4225
+ userId: string,
4226
+ certProcId: string,
4227
+ data: InputXqdgr5Oa5Vh,
4228
+ params: RequestParams = {}
4229
+ ) =>
4211
4230
  this.request<CreateCertificationWaiveData, CreateCertificationWaiveError>({
4212
4231
  path: `/user/${userId}/certification/${certProcId}/waive`,
4213
4232
  method: 'POST',
@@ -4312,7 +4331,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4312
4331
  createCertificationTriggerSet: (
4313
4332
  userId: string,
4314
4333
  certProcId: string,
4315
- data: InputIccc9Wkdt9,
4334
+ data: InputUysjux8Zp4,
4316
4335
  params: RequestParams = {}
4317
4336
  ) =>
4318
4337
  this.request<CreateCertificationTriggerSetData, CreateCertificationTriggerSetError>({
@@ -4439,7 +4458,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4439
4458
  certProcId: string,
4440
4459
  sourceId: string,
4441
4460
  itemVersion: string,
4442
- data: InputWk711Xrjeq,
4461
+ data: Input1Lghooas4I,
4443
4462
  params: RequestParams = {}
4444
4463
  ) =>
4445
4464
  this.request<CreateCertificationApplicationItemReviewData, CreateCertificationApplicationItemReviewError>({
@@ -4484,7 +4503,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4484
4503
  userId: string,
4485
4504
  certProcId: string,
4486
4505
  applicationType: string,
4487
- data: InputTtdoeespbb,
4506
+ data: InputCgletgibfvi,
4488
4507
  params: RequestParams = {}
4489
4508
  ) =>
4490
4509
  this.request<CreateCertificationApplicationSubmitData, CreateCertificationApplicationSubmitError>({
@@ -4510,7 +4529,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4510
4529
  certProcId: string,
4511
4530
  courseId: string,
4512
4531
  paId: string,
4513
- data: InputPmeud0A4Jo,
4532
+ data: InputDv9Ni3Aar5,
4514
4533
  params: RequestParams = {}
4515
4534
  ) =>
4516
4535
  this.request<CreateCertificationCoursePendingApprovalData, CreateCertificationCoursePendingApprovalError>({
@@ -4536,7 +4555,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4536
4555
  certProcId: string,
4537
4556
  courseId: string,
4538
4557
  paId: string,
4539
- data: Input711J32K5Lx,
4558
+ data: InputAihldyxydl,
4540
4559
  params: RequestParams = {}
4541
4560
  ) =>
4542
4561
  this.request<UpdateCertificationCoursePendingApprovalData, UpdateCertificationCoursePendingApprovalError>({
@@ -4560,7 +4579,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4560
4579
  createCertificationCourseRedeem: (
4561
4580
  userId: string,
4562
4581
  certProcId: string,
4563
- data: Input92Ud3Ap8Ee,
4582
+ data: InputGhxoi4I6V8,
4564
4583
  params: RequestParams = {}
4565
4584
  ) =>
4566
4585
  this.request<CreateCertificationCourseRedeemData, CreateCertificationCourseRedeemError>({
@@ -4608,7 +4627,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4608
4627
  userId: string,
4609
4628
  certProcId: string,
4610
4629
  courseId: string,
4611
- data: InputAyclmizttx,
4630
+ data: InputHod6Xcmzr8,
4612
4631
  params: RequestParams = {}
4613
4632
  ) =>
4614
4633
  this.request<CreateCertificationCourseEndCooldownData, CreateCertificationCourseEndCooldownError>({
@@ -4633,7 +4652,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4633
4652
  userId: string,
4634
4653
  certProcId: string,
4635
4654
  courseId: string,
4636
- data: Input7Tzs0Tv2Q5,
4655
+ data: InputX4U7C4Jq36,
4637
4656
  params: RequestParams = {}
4638
4657
  ) =>
4639
4658
  this.request<CreateCertificationCourseUnlockCourseData, CreateCertificationCourseUnlockCourseError>({
@@ -4654,7 +4673,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4654
4673
  * @request POST:/user/{userID}/updateITA
4655
4674
  * @secure
4656
4675
  */
4657
- createUpdateIta: (userId: string, data: Input0J4N9Uwfcb, params: RequestParams = {}) =>
4676
+ createUpdateIta: (userId: string, data: InputBmpgyhghyb, params: RequestParams = {}) =>
4658
4677
  this.request<CreateUpdateItaData, CreateUpdateItaError>({
4659
4678
  path: `/user/${userId}/updateITA`,
4660
4679
  method: 'POST',
@@ -4677,7 +4696,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4677
4696
  userId: string,
4678
4697
  certProcId: string,
4679
4698
  courseId: string,
4680
- data: InputFih2S2Mlabl,
4699
+ data: InputW1Qz7Aegx2,
4681
4700
  params: RequestParams = {}
4682
4701
  ) =>
4683
4702
  this.request<UpdateCertificationCourseOverrideResultData, UpdateCertificationCourseOverrideResultError>({
@@ -4701,7 +4720,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4701
4720
  updateCertificationSetDates: (
4702
4721
  userId: string,
4703
4722
  certProcId: string,
4704
- data: InputLwd5Q9Dzkoi,
4723
+ data: InputL5Uvh80Jwdh,
4705
4724
  params: RequestParams = {}
4706
4725
  ) =>
4707
4726
  this.request<UpdateCertificationSetDatesData, UpdateCertificationSetDatesError>({
@@ -4751,6 +4770,25 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4751
4770
  secure: true,
4752
4771
  ...params,
4753
4772
  }),
4773
+
4774
+ /**
4775
+ * @description Restart a user sponsorship / attestation request from the user's currently stored sponsor data. Refreshes an existing pending request in place, or creates a new request when the previous one is completed or missing, and re-sends the sponsor request email.
4776
+ *
4777
+ * @tags Sponsorship
4778
+ * @name CreateSponsorshipReset
4779
+ * @summary ResetSponsorshipRequest
4780
+ * @request POST:/user/{userID}/sponsorship/reset
4781
+ * @secure
4782
+ */
4783
+ createSponsorshipReset: (userId: string, data: ResetSponsorshipBody, params: RequestParams = {}) =>
4784
+ this.request<CreateSponsorshipResetData, CreateSponsorshipResetError>({
4785
+ path: `/user/${userId}/sponsorship/reset`,
4786
+ method: 'POST',
4787
+ body: data,
4788
+ secure: true,
4789
+ type: ContentType.Json,
4790
+ ...params,
4791
+ }),
4754
4792
  }
4755
4793
  users = {
4756
4794
  /**
@@ -4762,7 +4800,7 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
4762
4800
  * @request POST:/users/certification/{certSpecID}
4763
4801
  * @secure
4764
4802
  */
4765
- createCertification: (certSpecId: string, data: InputF71Vj36Lnw, params: RequestParams = {}) =>
4803
+ createCertification: (certSpecId: string, data: InputWmysx72Yqg, params: RequestParams = {}) =>
4766
4804
  this.request<CreateCertificationResult, CreateCertificationFail>({
4767
4805
  path: `/users/certification/${certSpecId}`,
4768
4806
  method: 'POST',