@easyedu/js-lsm-api 1.86.0 → 1.88.0
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/.openapi-generator/FILES +66 -0
- package/README.md +87 -2
- package/dist/apis/CertificateApi.d.ts +273 -0
- package/dist/apis/CertificateApi.js +663 -2
- package/dist/apis/CertificateTemplateApi.d.ts +591 -0
- package/dist/apis/CertificateTemplateApi.js +1546 -0
- package/dist/apis/index.d.ts +1 -0
- package/dist/apis/index.js +1 -0
- package/dist/esm/apis/CertificateApi.d.ts +273 -0
- package/dist/esm/apis/CertificateApi.js +662 -1
- package/dist/esm/apis/CertificateTemplateApi.d.ts +591 -0
- package/dist/esm/apis/CertificateTemplateApi.js +1542 -0
- package/dist/esm/apis/index.d.ts +1 -0
- package/dist/esm/apis/index.js +1 -0
- package/dist/esm/models/ArtifactConflict.d.ts +52 -0
- package/dist/esm/models/ArtifactConflict.js +58 -0
- package/dist/esm/models/BadgeIssuer.d.ts +80 -0
- package/dist/esm/models/BadgeIssuer.js +69 -0
- package/dist/esm/models/Certificate.d.ts +54 -0
- package/dist/esm/models/Certificate.js +30 -1
- package/dist/esm/models/CertificateArtifact.d.ts +72 -0
- package/dist/esm/models/CertificateArtifact.js +62 -0
- package/dist/esm/models/CertificateBadgePolicy.d.ts +69 -0
- package/dist/esm/models/CertificateBadgePolicy.js +64 -0
- package/dist/esm/models/CertificateBadgePolicyAlignmentsInner.d.ts +50 -0
- package/dist/esm/models/CertificateBadgePolicyAlignmentsInner.js +51 -0
- package/dist/esm/models/CertificateCanvasDocument.d.ts +53 -0
- package/dist/esm/models/CertificateCanvasDocument.js +59 -0
- package/dist/esm/models/CertificateCanvasDocumentPage.d.ts +60 -0
- package/dist/esm/models/CertificateCanvasDocumentPage.js +63 -0
- package/dist/esm/models/CertificateCanvasElement.d.ts +39 -0
- package/dist/esm/models/CertificateCanvasElement.js +67 -0
- package/dist/esm/models/CertificateCanvasImageElement.d.ts +90 -0
- package/dist/esm/models/CertificateCanvasImageElement.js +83 -0
- package/dist/esm/models/CertificateCanvasLineElement.d.ts +81 -0
- package/dist/esm/models/CertificateCanvasLineElement.js +77 -0
- package/dist/esm/models/CertificateCanvasPortalLogoElement.d.ts +69 -0
- package/dist/esm/models/CertificateCanvasPortalLogoElement.js +69 -0
- package/dist/esm/models/CertificateCanvasShapeElement.d.ts +87 -0
- package/dist/esm/models/CertificateCanvasShapeElement.js +81 -0
- package/dist/esm/models/CertificateCanvasTextElement.d.ts +115 -0
- package/dist/esm/models/CertificateCanvasTextElement.js +101 -0
- package/dist/esm/models/CertificateCanvasVerificationQrElement.d.ts +69 -0
- package/dist/esm/models/CertificateCanvasVerificationQrElement.js +69 -0
- package/dist/esm/models/CertificateConfig.d.ts +27 -0
- package/dist/esm/models/CertificateConfig.js +11 -0
- package/dist/esm/models/CertificateEvent.d.ts +74 -0
- package/dist/esm/models/CertificateEvent.js +61 -0
- package/dist/esm/models/CertificateNotificationPolicy.d.ts +76 -0
- package/dist/esm/models/CertificateNotificationPolicy.js +74 -0
- package/dist/esm/models/CertificatePublic.d.ts +35 -0
- package/dist/esm/models/CertificatePublic.js +22 -0
- package/dist/esm/models/CertificateRenewalPolicy.d.ts +46 -0
- package/dist/esm/models/CertificateRenewalPolicy.js +54 -0
- package/dist/esm/models/CertificateTemplate.d.ts +121 -0
- package/dist/esm/models/CertificateTemplate.js +97 -0
- package/dist/esm/models/CertificateTemplateVersion.d.ts +85 -0
- package/dist/esm/models/CertificateTemplateVersion.js +77 -0
- package/dist/esm/models/EffectiveCertificateConfig.d.ts +56 -0
- package/dist/esm/models/EffectiveCertificateConfig.js +35 -0
- package/dist/esm/models/GetCertificateAssetUpload.d.ts +64 -0
- package/dist/esm/models/GetCertificateAssetUpload.js +66 -0
- package/dist/esm/models/GetCertificateEventList.d.ts +33 -0
- package/dist/esm/models/GetCertificateEventList.js +44 -0
- package/dist/esm/models/GetCertificateTemplateList.d.ts +33 -0
- package/dist/esm/models/GetCertificateTemplateList.js +44 -0
- package/dist/esm/models/GetPublicBadgeCredentialStatus200Response.d.ts +48 -0
- package/dist/esm/models/GetPublicBadgeCredentialStatus200Response.js +56 -0
- package/dist/esm/models/GetUserCourseListItemCertificate.d.ts +1 -0
- package/dist/esm/models/GetUserCourseListItemCertificate.js +2 -1
- package/dist/esm/models/PostCertificateAssetComplete.d.ts +32 -0
- package/dist/esm/models/PostCertificateAssetComplete.js +43 -0
- package/dist/esm/models/PostCertificateAssetUpload.d.ts +53 -0
- package/dist/esm/models/PostCertificateAssetUpload.js +59 -0
- package/dist/esm/models/PostCertificateConfig.d.ts +27 -0
- package/dist/esm/models/PostCertificateConfig.js +11 -0
- package/dist/esm/models/PostCertificateLifecycleAction.d.ts +38 -0
- package/dist/esm/models/PostCertificateLifecycleAction.js +45 -0
- package/dist/esm/models/PostCertificateTemplate.d.ts +51 -0
- package/dist/esm/models/PostCertificateTemplate.js +50 -0
- package/dist/esm/models/PostCertificateTemplateClone.d.ts +44 -0
- package/dist/esm/models/PostCertificateTemplateClone.js +47 -0
- package/dist/esm/models/PostCertificateTemplatePreview.d.ts +41 -0
- package/dist/esm/models/PostCertificateTemplatePreview.js +46 -0
- package/dist/esm/models/PutBadgeIssuer.d.ts +44 -0
- package/dist/esm/models/PutBadgeIssuer.js +47 -0
- package/dist/esm/models/PutCertificateConfig.d.ts +27 -0
- package/dist/esm/models/PutCertificateConfig.js +11 -0
- package/dist/esm/models/PutCertificateTemplate.d.ts +44 -0
- package/dist/esm/models/PutCertificateTemplate.js +45 -0
- package/dist/esm/models/PutCertificateTemplateDraft.d.ts +39 -0
- package/dist/esm/models/PutCertificateTemplateDraft.js +46 -0
- package/dist/esm/models/index.d.ts +32 -0
- package/dist/esm/models/index.js +32 -0
- package/dist/models/ArtifactConflict.d.ts +52 -0
- package/dist/models/ArtifactConflict.js +66 -0
- package/dist/models/BadgeIssuer.d.ts +80 -0
- package/dist/models/BadgeIssuer.js +76 -0
- package/dist/models/Certificate.d.ts +54 -0
- package/dist/models/Certificate.js +31 -2
- package/dist/models/CertificateArtifact.d.ts +72 -0
- package/dist/models/CertificateArtifact.js +70 -0
- package/dist/models/CertificateBadgePolicy.d.ts +69 -0
- package/dist/models/CertificateBadgePolicy.js +71 -0
- package/dist/models/CertificateBadgePolicyAlignmentsInner.d.ts +50 -0
- package/dist/models/CertificateBadgePolicyAlignmentsInner.js +58 -0
- package/dist/models/CertificateCanvasDocument.d.ts +53 -0
- package/dist/models/CertificateCanvasDocument.js +67 -0
- package/dist/models/CertificateCanvasDocumentPage.d.ts +60 -0
- package/dist/models/CertificateCanvasDocumentPage.js +71 -0
- package/dist/models/CertificateCanvasElement.d.ts +39 -0
- package/dist/models/CertificateCanvasElement.js +73 -0
- package/dist/models/CertificateCanvasImageElement.d.ts +90 -0
- package/dist/models/CertificateCanvasImageElement.js +91 -0
- package/dist/models/CertificateCanvasLineElement.d.ts +81 -0
- package/dist/models/CertificateCanvasLineElement.js +85 -0
- package/dist/models/CertificateCanvasPortalLogoElement.d.ts +69 -0
- package/dist/models/CertificateCanvasPortalLogoElement.js +77 -0
- package/dist/models/CertificateCanvasShapeElement.d.ts +87 -0
- package/dist/models/CertificateCanvasShapeElement.js +89 -0
- package/dist/models/CertificateCanvasTextElement.d.ts +115 -0
- package/dist/models/CertificateCanvasTextElement.js +109 -0
- package/dist/models/CertificateCanvasVerificationQrElement.d.ts +69 -0
- package/dist/models/CertificateCanvasVerificationQrElement.js +77 -0
- package/dist/models/CertificateConfig.d.ts +27 -0
- package/dist/models/CertificateConfig.js +11 -0
- package/dist/models/CertificateEvent.d.ts +74 -0
- package/dist/models/CertificateEvent.js +68 -0
- package/dist/models/CertificateNotificationPolicy.d.ts +76 -0
- package/dist/models/CertificateNotificationPolicy.js +82 -0
- package/dist/models/CertificatePublic.d.ts +35 -0
- package/dist/models/CertificatePublic.js +23 -1
- package/dist/models/CertificateRenewalPolicy.d.ts +46 -0
- package/dist/models/CertificateRenewalPolicy.js +62 -0
- package/dist/models/CertificateTemplate.d.ts +121 -0
- package/dist/models/CertificateTemplate.js +105 -0
- package/dist/models/CertificateTemplateVersion.d.ts +85 -0
- package/dist/models/CertificateTemplateVersion.js +85 -0
- package/dist/models/EffectiveCertificateConfig.d.ts +56 -0
- package/dist/models/EffectiveCertificateConfig.js +36 -0
- package/dist/models/GetCertificateAssetUpload.d.ts +64 -0
- package/dist/models/GetCertificateAssetUpload.js +74 -0
- package/dist/models/GetCertificateEventList.d.ts +33 -0
- package/dist/models/GetCertificateEventList.js +51 -0
- package/dist/models/GetCertificateTemplateList.d.ts +33 -0
- package/dist/models/GetCertificateTemplateList.js +51 -0
- package/dist/models/GetPublicBadgeCredentialStatus200Response.d.ts +48 -0
- package/dist/models/GetPublicBadgeCredentialStatus200Response.js +64 -0
- package/dist/models/GetUserCourseListItemCertificate.d.ts +1 -0
- package/dist/models/GetUserCourseListItemCertificate.js +2 -1
- package/dist/models/PostCertificateAssetComplete.d.ts +32 -0
- package/dist/models/PostCertificateAssetComplete.js +50 -0
- package/dist/models/PostCertificateAssetUpload.d.ts +53 -0
- package/dist/models/PostCertificateAssetUpload.js +67 -0
- package/dist/models/PostCertificateConfig.d.ts +27 -0
- package/dist/models/PostCertificateConfig.js +11 -0
- package/dist/models/PostCertificateLifecycleAction.d.ts +38 -0
- package/dist/models/PostCertificateLifecycleAction.js +52 -0
- package/dist/models/PostCertificateTemplate.d.ts +51 -0
- package/dist/models/PostCertificateTemplate.js +57 -0
- package/dist/models/PostCertificateTemplateClone.d.ts +44 -0
- package/dist/models/PostCertificateTemplateClone.js +54 -0
- package/dist/models/PostCertificateTemplatePreview.d.ts +41 -0
- package/dist/models/PostCertificateTemplatePreview.js +53 -0
- package/dist/models/PutBadgeIssuer.d.ts +44 -0
- package/dist/models/PutBadgeIssuer.js +54 -0
- package/dist/models/PutCertificateConfig.d.ts +27 -0
- package/dist/models/PutCertificateConfig.js +11 -0
- package/dist/models/PutCertificateTemplate.d.ts +44 -0
- package/dist/models/PutCertificateTemplate.js +52 -0
- package/dist/models/PutCertificateTemplateDraft.d.ts +39 -0
- package/dist/models/PutCertificateTemplateDraft.js +53 -0
- package/dist/models/index.d.ts +32 -0
- package/dist/models/index.js +32 -0
- package/docs/ArtifactConflict.md +38 -0
- package/docs/BadgeIssuer.md +50 -0
- package/docs/Certificate.md +14 -0
- package/docs/CertificateApi.md +1119 -48
- package/docs/CertificateArtifact.md +44 -0
- package/docs/CertificateBadgePolicy.md +46 -0
- package/docs/CertificateBadgePolicyAlignmentsInner.md +40 -0
- package/docs/CertificateCanvasDocument.md +39 -0
- package/docs/CertificateCanvasDocumentPage.md +38 -0
- package/docs/CertificateCanvasElement.md +65 -0
- package/docs/CertificateCanvasImageElement.md +48 -0
- package/docs/CertificateCanvasLineElement.md +48 -0
- package/docs/CertificateCanvasPortalLogoElement.md +44 -0
- package/docs/CertificateCanvasShapeElement.md +50 -0
- package/docs/CertificateCanvasTextElement.md +54 -0
- package/docs/CertificateCanvasVerificationQrElement.md +44 -0
- package/docs/CertificateConfig.md +8 -0
- package/docs/CertificateEvent.md +46 -0
- package/docs/CertificateNotificationPolicy.md +46 -0
- package/docs/CertificatePublic.md +8 -0
- package/docs/CertificateRenewalPolicy.md +36 -0
- package/docs/CertificateTemplate.md +60 -0
- package/docs/CertificateTemplateApi.md +2493 -0
- package/docs/CertificateTemplateVersion.md +48 -0
- package/docs/EffectiveCertificateConfig.md +14 -0
- package/docs/GetCertificateAssetUpload.md +42 -0
- package/docs/GetCertificateEventList.md +34 -0
- package/docs/GetCertificateTemplateList.md +34 -0
- package/docs/GetPublicBadgeCredentialStatus200Response.md +36 -0
- package/docs/PostCertificateAssetComplete.md +34 -0
- package/docs/PostCertificateAssetUpload.md +38 -0
- package/docs/PostCertificateConfig.md +8 -0
- package/docs/PostCertificateLifecycleAction.md +36 -0
- package/docs/PostCertificateTemplate.md +40 -0
- package/docs/PostCertificateTemplateClone.md +38 -0
- package/docs/PostCertificateTemplatePreview.md +36 -0
- package/docs/PutBadgeIssuer.md +38 -0
- package/docs/PutCertificateConfig.md +8 -0
- package/docs/PutCertificateTemplate.md +38 -0
- package/docs/PutCertificateTemplateDraft.md +36 -0
- package/package.json +1 -1
- package/src/apis/CertificateApi.ts +952 -98
- package/src/apis/CertificateTemplateApi.ts +2020 -0
- package/src/apis/index.ts +1 -0
- package/src/models/ArtifactConflict.ts +95 -0
- package/src/models/BadgeIssuer.ts +135 -0
- package/src/models/Certificate.ts +79 -1
- package/src/models/CertificateArtifact.ts +119 -0
- package/src/models/CertificateBadgePolicy.ts +126 -0
- package/src/models/CertificateBadgePolicyAlignmentsInner.ts +91 -0
- package/src/models/CertificateCanvasDocument.ts +109 -0
- package/src/models/CertificateCanvasDocumentPage.ts +103 -0
- package/src/models/CertificateCanvasElement.ts +116 -0
- package/src/models/CertificateCanvasImageElement.ts +148 -0
- package/src/models/CertificateCanvasLineElement.ts +139 -0
- package/src/models/CertificateCanvasPortalLogoElement.ts +121 -0
- package/src/models/CertificateCanvasShapeElement.ts +148 -0
- package/src/models/CertificateCanvasTextElement.ts +183 -0
- package/src/models/CertificateCanvasVerificationQrElement.ts +121 -0
- package/src/models/CertificateConfig.ts +54 -0
- package/src/models/CertificateEvent.ts +117 -0
- package/src/models/CertificateNotificationPolicy.ts +131 -0
- package/src/models/CertificatePublic.ts +46 -0
- package/src/models/CertificateRenewalPolicy.ts +86 -0
- package/src/models/CertificateTemplate.ts +200 -0
- package/src/models/CertificateTemplateVersion.ts +148 -0
- package/src/models/EffectiveCertificateConfig.ts +96 -0
- package/src/models/GetCertificateAssetUpload.ts +113 -0
- package/src/models/GetCertificateEventList.ts +74 -0
- package/src/models/GetCertificateTemplateList.ts +74 -0
- package/src/models/GetPublicBadgeCredentialStatus200Response.ts +88 -0
- package/src/models/GetUserCourseListItemCertificate.ts +2 -1
- package/src/models/PostCertificateAssetComplete.ts +66 -0
- package/src/models/PostCertificateAssetUpload.ts +96 -0
- package/src/models/PostCertificateConfig.ts +54 -0
- package/src/models/PostCertificateLifecycleAction.ts +74 -0
- package/src/models/PostCertificateTemplate.ts +98 -0
- package/src/models/PostCertificateTemplateClone.ts +82 -0
- package/src/models/PostCertificateTemplatePreview.ts +82 -0
- package/src/models/PutBadgeIssuer.ts +82 -0
- package/src/models/PutCertificateConfig.ts +54 -0
- package/src/models/PutCertificateTemplate.ts +81 -0
- package/src/models/PutCertificateTemplateDraft.ts +82 -0
- package/src/models/index.ts +32 -0
|
@@ -13,11 +13,26 @@
|
|
|
13
13
|
*/
|
|
14
14
|
|
|
15
15
|
import * as runtime from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
type ArtifactConflict,
|
|
18
|
+
ArtifactConflictFromJSON,
|
|
19
|
+
ArtifactConflictToJSON,
|
|
20
|
+
} from '../models/ArtifactConflict';
|
|
21
|
+
import {
|
|
22
|
+
type BadgeIssuer,
|
|
23
|
+
BadgeIssuerFromJSON,
|
|
24
|
+
BadgeIssuerToJSON,
|
|
25
|
+
} from '../models/BadgeIssuer';
|
|
16
26
|
import {
|
|
17
27
|
type Certificate,
|
|
18
28
|
CertificateFromJSON,
|
|
19
29
|
CertificateToJSON,
|
|
20
30
|
} from '../models/Certificate';
|
|
31
|
+
import {
|
|
32
|
+
type CertificateArtifact,
|
|
33
|
+
CertificateArtifactFromJSON,
|
|
34
|
+
CertificateArtifactToJSON,
|
|
35
|
+
} from '../models/CertificateArtifact';
|
|
21
36
|
import {
|
|
22
37
|
type CertificateConfig,
|
|
23
38
|
CertificateConfigFromJSON,
|
|
@@ -38,11 +53,21 @@ import {
|
|
|
38
53
|
GetCertificateConfigListFromJSON,
|
|
39
54
|
GetCertificateConfigListToJSON,
|
|
40
55
|
} from '../models/GetCertificateConfigList';
|
|
56
|
+
import {
|
|
57
|
+
type GetCertificateEventList,
|
|
58
|
+
GetCertificateEventListFromJSON,
|
|
59
|
+
GetCertificateEventListToJSON,
|
|
60
|
+
} from '../models/GetCertificateEventList';
|
|
41
61
|
import {
|
|
42
62
|
type GetCertificateList,
|
|
43
63
|
GetCertificateListFromJSON,
|
|
44
64
|
GetCertificateListToJSON,
|
|
45
65
|
} from '../models/GetCertificateList';
|
|
66
|
+
import {
|
|
67
|
+
type GetPublicBadgeCredentialStatus200Response,
|
|
68
|
+
GetPublicBadgeCredentialStatus200ResponseFromJSON,
|
|
69
|
+
GetPublicBadgeCredentialStatus200ResponseToJSON,
|
|
70
|
+
} from '../models/GetPublicBadgeCredentialStatus200Response';
|
|
46
71
|
import {
|
|
47
72
|
type PostCertificate,
|
|
48
73
|
PostCertificateFromJSON,
|
|
@@ -53,11 +78,21 @@ import {
|
|
|
53
78
|
PostCertificateConfigFromJSON,
|
|
54
79
|
PostCertificateConfigToJSON,
|
|
55
80
|
} from '../models/PostCertificateConfig';
|
|
81
|
+
import {
|
|
82
|
+
type PostCertificateLifecycleAction,
|
|
83
|
+
PostCertificateLifecycleActionFromJSON,
|
|
84
|
+
PostCertificateLifecycleActionToJSON,
|
|
85
|
+
} from '../models/PostCertificateLifecycleAction';
|
|
56
86
|
import {
|
|
57
87
|
type PostRevokeCertificate,
|
|
58
88
|
PostRevokeCertificateFromJSON,
|
|
59
89
|
PostRevokeCertificateToJSON,
|
|
60
90
|
} from '../models/PostRevokeCertificate';
|
|
91
|
+
import {
|
|
92
|
+
type PutBadgeIssuer,
|
|
93
|
+
PutBadgeIssuerFromJSON,
|
|
94
|
+
PutBadgeIssuerToJSON,
|
|
95
|
+
} from '../models/PutBadgeIssuer';
|
|
61
96
|
import {
|
|
62
97
|
type PutCertificateConfig,
|
|
63
98
|
PutCertificateConfigFromJSON,
|
|
@@ -81,6 +116,18 @@ export interface GetCertificateConfigsRequest {
|
|
|
81
116
|
scope?: GetCertificateConfigsScopeEnum;
|
|
82
117
|
}
|
|
83
118
|
|
|
119
|
+
export interface GetCertificateCsvExportRequest {
|
|
120
|
+
userId?: string;
|
|
121
|
+
courseId?: string;
|
|
122
|
+
status?: GetCertificateCsvExportStatusEnum;
|
|
123
|
+
issuedAfter?: number;
|
|
124
|
+
issuedBefore?: number;
|
|
125
|
+
}
|
|
126
|
+
|
|
127
|
+
export interface GetCertificateEventsRequest {
|
|
128
|
+
certificateId: string;
|
|
129
|
+
}
|
|
130
|
+
|
|
84
131
|
export interface GetCertificatePdfRequest {
|
|
85
132
|
certificateId: string;
|
|
86
133
|
}
|
|
@@ -100,10 +147,57 @@ export interface GetEffectiveCertificateConfigRequest {
|
|
|
100
147
|
courseId: string;
|
|
101
148
|
}
|
|
102
149
|
|
|
150
|
+
export interface GetPublicBadgeAchievementRequest {
|
|
151
|
+
achievementId: string;
|
|
152
|
+
}
|
|
153
|
+
|
|
154
|
+
export interface GetPublicBadgeAchievementImageRequest {
|
|
155
|
+
achievementId: string;
|
|
156
|
+
}
|
|
157
|
+
|
|
158
|
+
export interface GetPublicBadgeCredentialRequest {
|
|
159
|
+
credentialId: string;
|
|
160
|
+
}
|
|
161
|
+
|
|
162
|
+
export interface GetPublicBadgeCredentialDocumentRequest {
|
|
163
|
+
credentialId: string;
|
|
164
|
+
}
|
|
165
|
+
|
|
166
|
+
export interface GetPublicBadgeCredentialStatusRequest {
|
|
167
|
+
credentialId: string;
|
|
168
|
+
}
|
|
169
|
+
|
|
170
|
+
export interface GetPublicBadgeIssuerRequest {
|
|
171
|
+
portalId: string;
|
|
172
|
+
}
|
|
173
|
+
|
|
174
|
+
export interface GetPublicBadgeIssuerDidDocumentRequest {
|
|
175
|
+
portalId: string;
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
export interface GetPublicCertificatePdfRequest {
|
|
179
|
+
certificateId: string;
|
|
180
|
+
}
|
|
181
|
+
|
|
182
|
+
export interface PostCertificateArtifactRetryRequest {
|
|
183
|
+
certificateId: string;
|
|
184
|
+
}
|
|
185
|
+
|
|
103
186
|
export interface PostCertificateConfigRequest {
|
|
104
187
|
postCertificateConfig: PostCertificateConfig;
|
|
105
188
|
}
|
|
106
189
|
|
|
190
|
+
export interface PostCertificateRenewRequest {
|
|
191
|
+
certificateId: string;
|
|
192
|
+
postCertificateLifecycleAction: PostCertificateLifecycleAction;
|
|
193
|
+
}
|
|
194
|
+
|
|
195
|
+
export interface PostCertificateReplaceRequest {
|
|
196
|
+
certificateId: string;
|
|
197
|
+
postCertificateLifecycleAction: PostCertificateLifecycleAction;
|
|
198
|
+
correction?: boolean;
|
|
199
|
+
}
|
|
200
|
+
|
|
107
201
|
export interface PostCourseCertificateRequest {
|
|
108
202
|
courseId: string;
|
|
109
203
|
postCertificate: PostCertificate;
|
|
@@ -114,6 +208,10 @@ export interface PostRevokeCertificateRequest {
|
|
|
114
208
|
postRevokeCertificate: PostRevokeCertificate;
|
|
115
209
|
}
|
|
116
210
|
|
|
211
|
+
export interface PutBadgeIssuerRequest {
|
|
212
|
+
putBadgeIssuer: PutBadgeIssuer;
|
|
213
|
+
}
|
|
214
|
+
|
|
117
215
|
export interface PutCertificateConfigRequest {
|
|
118
216
|
configId: string;
|
|
119
217
|
putCertificateConfig: PutCertificateConfig;
|
|
@@ -172,6 +270,43 @@ export class CertificateApi extends runtime.BaseAPI {
|
|
|
172
270
|
await this.deleteCertificateConfigRaw(requestParameters, initOverrides);
|
|
173
271
|
}
|
|
174
272
|
|
|
273
|
+
/**
|
|
274
|
+
* Creates request options for getBadgeIssuer without sending the request
|
|
275
|
+
*/
|
|
276
|
+
async getBadgeIssuerRequestOpts(): Promise<runtime.RequestOpts> {
|
|
277
|
+
const queryParameters: any = {};
|
|
278
|
+
|
|
279
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
280
|
+
|
|
281
|
+
|
|
282
|
+
let urlPath = `/badge-issuer`;
|
|
283
|
+
|
|
284
|
+
return {
|
|
285
|
+
path: urlPath,
|
|
286
|
+
method: 'GET',
|
|
287
|
+
headers: headerParameters,
|
|
288
|
+
query: queryParameters,
|
|
289
|
+
};
|
|
290
|
+
}
|
|
291
|
+
|
|
292
|
+
/**
|
|
293
|
+
* Get the selected portal Open Badges issuer
|
|
294
|
+
*/
|
|
295
|
+
async getBadgeIssuerRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BadgeIssuer>> {
|
|
296
|
+
const requestOptions = await this.getBadgeIssuerRequestOpts();
|
|
297
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
298
|
+
|
|
299
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => BadgeIssuerFromJSON(jsonValue));
|
|
300
|
+
}
|
|
301
|
+
|
|
302
|
+
/**
|
|
303
|
+
* Get the selected portal Open Badges issuer
|
|
304
|
+
*/
|
|
305
|
+
async getBadgeIssuer(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BadgeIssuer> {
|
|
306
|
+
const response = await this.getBadgeIssuerRaw(initOverrides);
|
|
307
|
+
return await response.value();
|
|
308
|
+
}
|
|
309
|
+
|
|
175
310
|
/**
|
|
176
311
|
* Creates request options for getCertificate without sending the request
|
|
177
312
|
*/
|
|
@@ -307,6 +442,108 @@ export class CertificateApi extends runtime.BaseAPI {
|
|
|
307
442
|
return await response.value();
|
|
308
443
|
}
|
|
309
444
|
|
|
445
|
+
/**
|
|
446
|
+
* Creates request options for getCertificateCsvExport without sending the request
|
|
447
|
+
*/
|
|
448
|
+
async getCertificateCsvExportRequestOpts(requestParameters: GetCertificateCsvExportRequest): Promise<runtime.RequestOpts> {
|
|
449
|
+
const queryParameters: any = {};
|
|
450
|
+
|
|
451
|
+
if (requestParameters['userId'] != null) {
|
|
452
|
+
queryParameters['user_id'] = requestParameters['userId'];
|
|
453
|
+
}
|
|
454
|
+
|
|
455
|
+
if (requestParameters['courseId'] != null) {
|
|
456
|
+
queryParameters['course_id'] = requestParameters['courseId'];
|
|
457
|
+
}
|
|
458
|
+
|
|
459
|
+
if (requestParameters['status'] != null) {
|
|
460
|
+
queryParameters['status'] = requestParameters['status'];
|
|
461
|
+
}
|
|
462
|
+
|
|
463
|
+
if (requestParameters['issuedAfter'] != null) {
|
|
464
|
+
queryParameters['issued_after'] = requestParameters['issuedAfter'];
|
|
465
|
+
}
|
|
466
|
+
|
|
467
|
+
if (requestParameters['issuedBefore'] != null) {
|
|
468
|
+
queryParameters['issued_before'] = requestParameters['issuedBefore'];
|
|
469
|
+
}
|
|
470
|
+
|
|
471
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
472
|
+
|
|
473
|
+
|
|
474
|
+
let urlPath = `/certificates/export`;
|
|
475
|
+
|
|
476
|
+
return {
|
|
477
|
+
path: urlPath,
|
|
478
|
+
method: 'GET',
|
|
479
|
+
headers: headerParameters,
|
|
480
|
+
query: queryParameters,
|
|
481
|
+
};
|
|
482
|
+
}
|
|
483
|
+
|
|
484
|
+
/**
|
|
485
|
+
* Export filtered certificate records as CSV
|
|
486
|
+
*/
|
|
487
|
+
async getCertificateCsvExportRaw(requestParameters: GetCertificateCsvExportRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
|
|
488
|
+
const requestOptions = await this.getCertificateCsvExportRequestOpts(requestParameters);
|
|
489
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
490
|
+
|
|
491
|
+
return new runtime.BlobApiResponse(response);
|
|
492
|
+
}
|
|
493
|
+
|
|
494
|
+
/**
|
|
495
|
+
* Export filtered certificate records as CSV
|
|
496
|
+
*/
|
|
497
|
+
async getCertificateCsvExport(requestParameters: GetCertificateCsvExportRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
|
|
498
|
+
const response = await this.getCertificateCsvExportRaw(requestParameters, initOverrides);
|
|
499
|
+
return await response.value();
|
|
500
|
+
}
|
|
501
|
+
|
|
502
|
+
/**
|
|
503
|
+
* Creates request options for getCertificateEvents without sending the request
|
|
504
|
+
*/
|
|
505
|
+
async getCertificateEventsRequestOpts(requestParameters: GetCertificateEventsRequest): Promise<runtime.RequestOpts> {
|
|
506
|
+
if (requestParameters['certificateId'] == null) {
|
|
507
|
+
throw new runtime.RequiredError(
|
|
508
|
+
'certificateId',
|
|
509
|
+
'Required parameter "certificateId" was null or undefined when calling getCertificateEvents().'
|
|
510
|
+
);
|
|
511
|
+
}
|
|
512
|
+
|
|
513
|
+
const queryParameters: any = {};
|
|
514
|
+
|
|
515
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
let urlPath = `/certificates/{certificateId}/events`;
|
|
519
|
+
urlPath = urlPath.replace('{certificateId}', encodeURIComponent(String(requestParameters['certificateId'])));
|
|
520
|
+
|
|
521
|
+
return {
|
|
522
|
+
path: urlPath,
|
|
523
|
+
method: 'GET',
|
|
524
|
+
headers: headerParameters,
|
|
525
|
+
query: queryParameters,
|
|
526
|
+
};
|
|
527
|
+
}
|
|
528
|
+
|
|
529
|
+
/**
|
|
530
|
+
* List immutable lifecycle events for a certificate
|
|
531
|
+
*/
|
|
532
|
+
async getCertificateEventsRaw(requestParameters: GetCertificateEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetCertificateEventList>> {
|
|
533
|
+
const requestOptions = await this.getCertificateEventsRequestOpts(requestParameters);
|
|
534
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
535
|
+
|
|
536
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetCertificateEventListFromJSON(jsonValue));
|
|
537
|
+
}
|
|
538
|
+
|
|
539
|
+
/**
|
|
540
|
+
* List immutable lifecycle events for a certificate
|
|
541
|
+
*/
|
|
542
|
+
async getCertificateEvents(requestParameters: GetCertificateEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetCertificateEventList> {
|
|
543
|
+
const response = await this.getCertificateEventsRaw(requestParameters, initOverrides);
|
|
544
|
+
return await response.value();
|
|
545
|
+
}
|
|
546
|
+
|
|
310
547
|
/**
|
|
311
548
|
* Creates request options for getCertificatePdf without sending the request
|
|
312
549
|
*/
|
|
@@ -504,13 +741,13 @@ export class CertificateApi extends runtime.BaseAPI {
|
|
|
504
741
|
}
|
|
505
742
|
|
|
506
743
|
/**
|
|
507
|
-
* Creates request options for
|
|
744
|
+
* Creates request options for getPublicBadgeAchievement without sending the request
|
|
508
745
|
*/
|
|
509
|
-
async
|
|
510
|
-
if (requestParameters['
|
|
746
|
+
async getPublicBadgeAchievementRequestOpts(requestParameters: GetPublicBadgeAchievementRequest): Promise<runtime.RequestOpts> {
|
|
747
|
+
if (requestParameters['achievementId'] == null) {
|
|
511
748
|
throw new runtime.RequiredError(
|
|
512
|
-
'
|
|
513
|
-
'Required parameter "
|
|
749
|
+
'achievementId',
|
|
750
|
+
'Required parameter "achievementId" was null or undefined when calling getPublicBadgeAchievement().'
|
|
514
751
|
);
|
|
515
752
|
}
|
|
516
753
|
|
|
@@ -518,53 +755,44 @@ export class CertificateApi extends runtime.BaseAPI {
|
|
|
518
755
|
|
|
519
756
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
520
757
|
|
|
521
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
522
|
-
|
|
523
758
|
|
|
524
|
-
let urlPath = `/
|
|
759
|
+
let urlPath = `/public/badge-achievements/{achievementId}`;
|
|
760
|
+
urlPath = urlPath.replace('{achievementId}', encodeURIComponent(String(requestParameters['achievementId'])));
|
|
525
761
|
|
|
526
762
|
return {
|
|
527
763
|
path: urlPath,
|
|
528
|
-
method: '
|
|
764
|
+
method: 'GET',
|
|
529
765
|
headers: headerParameters,
|
|
530
766
|
query: queryParameters,
|
|
531
|
-
body: PostCertificateConfigToJSON(requestParameters['postCertificateConfig']),
|
|
532
767
|
};
|
|
533
768
|
}
|
|
534
769
|
|
|
535
770
|
/**
|
|
536
|
-
*
|
|
771
|
+
* Get a hosted Open Badges Achievement
|
|
537
772
|
*/
|
|
538
|
-
async
|
|
539
|
-
const requestOptions = await this.
|
|
773
|
+
async getPublicBadgeAchievementRaw(requestParameters: GetPublicBadgeAchievementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: any; }>> {
|
|
774
|
+
const requestOptions = await this.getPublicBadgeAchievementRequestOpts(requestParameters);
|
|
540
775
|
const response = await this.request(requestOptions, initOverrides);
|
|
541
776
|
|
|
542
|
-
return new runtime.JSONApiResponse(response
|
|
777
|
+
return new runtime.JSONApiResponse<any>(response);
|
|
543
778
|
}
|
|
544
779
|
|
|
545
780
|
/**
|
|
546
|
-
*
|
|
781
|
+
* Get a hosted Open Badges Achievement
|
|
547
782
|
*/
|
|
548
|
-
async
|
|
549
|
-
const response = await this.
|
|
783
|
+
async getPublicBadgeAchievement(requestParameters: GetPublicBadgeAchievementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: any; }> {
|
|
784
|
+
const response = await this.getPublicBadgeAchievementRaw(requestParameters, initOverrides);
|
|
550
785
|
return await response.value();
|
|
551
786
|
}
|
|
552
787
|
|
|
553
788
|
/**
|
|
554
|
-
* Creates request options for
|
|
789
|
+
* Creates request options for getPublicBadgeAchievementImage without sending the request
|
|
555
790
|
*/
|
|
556
|
-
async
|
|
557
|
-
if (requestParameters['
|
|
558
|
-
throw new runtime.RequiredError(
|
|
559
|
-
'courseId',
|
|
560
|
-
'Required parameter "courseId" was null or undefined when calling postCourseCertificate().'
|
|
561
|
-
);
|
|
562
|
-
}
|
|
563
|
-
|
|
564
|
-
if (requestParameters['postCertificate'] == null) {
|
|
791
|
+
async getPublicBadgeAchievementImageRequestOpts(requestParameters: GetPublicBadgeAchievementImageRequest): Promise<runtime.RequestOpts> {
|
|
792
|
+
if (requestParameters['achievementId'] == null) {
|
|
565
793
|
throw new runtime.RequiredError(
|
|
566
|
-
'
|
|
567
|
-
'Required parameter "
|
|
794
|
+
'achievementId',
|
|
795
|
+
'Required parameter "achievementId" was null or undefined when calling getPublicBadgeAchievementImage().'
|
|
568
796
|
);
|
|
569
797
|
}
|
|
570
798
|
|
|
@@ -572,54 +800,44 @@ export class CertificateApi extends runtime.BaseAPI {
|
|
|
572
800
|
|
|
573
801
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
574
802
|
|
|
575
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
576
|
-
|
|
577
803
|
|
|
578
|
-
let urlPath = `/
|
|
579
|
-
urlPath = urlPath.replace('{
|
|
804
|
+
let urlPath = `/public/badge-achievements/{achievementId}/image`;
|
|
805
|
+
urlPath = urlPath.replace('{achievementId}', encodeURIComponent(String(requestParameters['achievementId'])));
|
|
580
806
|
|
|
581
807
|
return {
|
|
582
808
|
path: urlPath,
|
|
583
|
-
method: '
|
|
809
|
+
method: 'GET',
|
|
584
810
|
headers: headerParameters,
|
|
585
811
|
query: queryParameters,
|
|
586
|
-
body: PostCertificateToJSON(requestParameters['postCertificate']),
|
|
587
812
|
};
|
|
588
813
|
}
|
|
589
814
|
|
|
590
815
|
/**
|
|
591
|
-
*
|
|
816
|
+
* Get a validated square PNG badge image
|
|
592
817
|
*/
|
|
593
|
-
async
|
|
594
|
-
const requestOptions = await this.
|
|
818
|
+
async getPublicBadgeAchievementImageRaw(requestParameters: GetPublicBadgeAchievementImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
|
|
819
|
+
const requestOptions = await this.getPublicBadgeAchievementImageRequestOpts(requestParameters);
|
|
595
820
|
const response = await this.request(requestOptions, initOverrides);
|
|
596
821
|
|
|
597
|
-
return new runtime.
|
|
822
|
+
return new runtime.BlobApiResponse(response);
|
|
598
823
|
}
|
|
599
824
|
|
|
600
825
|
/**
|
|
601
|
-
*
|
|
826
|
+
* Get a validated square PNG badge image
|
|
602
827
|
*/
|
|
603
|
-
async
|
|
604
|
-
const response = await this.
|
|
828
|
+
async getPublicBadgeAchievementImage(requestParameters: GetPublicBadgeAchievementImageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
|
|
829
|
+
const response = await this.getPublicBadgeAchievementImageRaw(requestParameters, initOverrides);
|
|
605
830
|
return await response.value();
|
|
606
831
|
}
|
|
607
832
|
|
|
608
833
|
/**
|
|
609
|
-
* Creates request options for
|
|
834
|
+
* Creates request options for getPublicBadgeCredential without sending the request
|
|
610
835
|
*/
|
|
611
|
-
async
|
|
612
|
-
if (requestParameters['
|
|
613
|
-
throw new runtime.RequiredError(
|
|
614
|
-
'certificateId',
|
|
615
|
-
'Required parameter "certificateId" was null or undefined when calling postRevokeCertificate().'
|
|
616
|
-
);
|
|
617
|
-
}
|
|
618
|
-
|
|
619
|
-
if (requestParameters['postRevokeCertificate'] == null) {
|
|
836
|
+
async getPublicBadgeCredentialRequestOpts(requestParameters: GetPublicBadgeCredentialRequest): Promise<runtime.RequestOpts> {
|
|
837
|
+
if (requestParameters['credentialId'] == null) {
|
|
620
838
|
throw new runtime.RequiredError(
|
|
621
|
-
'
|
|
622
|
-
'Required parameter "
|
|
839
|
+
'credentialId',
|
|
840
|
+
'Required parameter "credentialId" was null or undefined when calling getPublicBadgeCredential().'
|
|
623
841
|
);
|
|
624
842
|
}
|
|
625
843
|
|
|
@@ -627,54 +845,48 @@ export class CertificateApi extends runtime.BaseAPI {
|
|
|
627
845
|
|
|
628
846
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
629
847
|
|
|
630
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
631
|
-
|
|
632
848
|
|
|
633
|
-
let urlPath = `/
|
|
634
|
-
urlPath = urlPath.replace('{
|
|
849
|
+
let urlPath = `/public/badge-credentials/{credentialId}`;
|
|
850
|
+
urlPath = urlPath.replace('{credentialId}', encodeURIComponent(String(requestParameters['credentialId'])));
|
|
635
851
|
|
|
636
852
|
return {
|
|
637
853
|
path: urlPath,
|
|
638
|
-
method: '
|
|
854
|
+
method: 'GET',
|
|
639
855
|
headers: headerParameters,
|
|
640
856
|
query: queryParameters,
|
|
641
|
-
body: PostRevokeCertificateToJSON(requestParameters['postRevokeCertificate']),
|
|
642
857
|
};
|
|
643
858
|
}
|
|
644
859
|
|
|
645
860
|
/**
|
|
646
|
-
*
|
|
861
|
+
* Download an Open Badges 3.0 VC-JWT
|
|
647
862
|
*/
|
|
648
|
-
async
|
|
649
|
-
const requestOptions = await this.
|
|
863
|
+
async getPublicBadgeCredentialRaw(requestParameters: GetPublicBadgeCredentialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<string>> {
|
|
864
|
+
const requestOptions = await this.getPublicBadgeCredentialRequestOpts(requestParameters);
|
|
650
865
|
const response = await this.request(requestOptions, initOverrides);
|
|
651
866
|
|
|
652
|
-
|
|
867
|
+
if (this.isJsonMime(response.headers.get('content-type'))) {
|
|
868
|
+
return new runtime.JSONApiResponse<string>(response);
|
|
869
|
+
} else {
|
|
870
|
+
return new runtime.TextApiResponse(response) as any;
|
|
871
|
+
}
|
|
653
872
|
}
|
|
654
873
|
|
|
655
874
|
/**
|
|
656
|
-
*
|
|
875
|
+
* Download an Open Badges 3.0 VC-JWT
|
|
657
876
|
*/
|
|
658
|
-
async
|
|
659
|
-
const response = await this.
|
|
877
|
+
async getPublicBadgeCredential(requestParameters: GetPublicBadgeCredentialRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<string> {
|
|
878
|
+
const response = await this.getPublicBadgeCredentialRaw(requestParameters, initOverrides);
|
|
660
879
|
return await response.value();
|
|
661
880
|
}
|
|
662
881
|
|
|
663
882
|
/**
|
|
664
|
-
* Creates request options for
|
|
883
|
+
* Creates request options for getPublicBadgeCredentialDocument without sending the request
|
|
665
884
|
*/
|
|
666
|
-
async
|
|
667
|
-
if (requestParameters['
|
|
668
|
-
throw new runtime.RequiredError(
|
|
669
|
-
'configId',
|
|
670
|
-
'Required parameter "configId" was null or undefined when calling putCertificateConfig().'
|
|
671
|
-
);
|
|
672
|
-
}
|
|
673
|
-
|
|
674
|
-
if (requestParameters['putCertificateConfig'] == null) {
|
|
885
|
+
async getPublicBadgeCredentialDocumentRequestOpts(requestParameters: GetPublicBadgeCredentialDocumentRequest): Promise<runtime.RequestOpts> {
|
|
886
|
+
if (requestParameters['credentialId'] == null) {
|
|
675
887
|
throw new runtime.RequiredError(
|
|
676
|
-
'
|
|
677
|
-
'Required parameter "
|
|
888
|
+
'credentialId',
|
|
889
|
+
'Required parameter "credentialId" was null or undefined when calling getPublicBadgeCredentialDocument().'
|
|
678
890
|
);
|
|
679
891
|
}
|
|
680
892
|
|
|
@@ -682,47 +894,679 @@ export class CertificateApi extends runtime.BaseAPI {
|
|
|
682
894
|
|
|
683
895
|
const headerParameters: runtime.HTTPHeaders = {};
|
|
684
896
|
|
|
685
|
-
headerParameters['Content-Type'] = 'application/json';
|
|
686
|
-
|
|
687
897
|
|
|
688
|
-
let urlPath = `/
|
|
689
|
-
urlPath = urlPath.replace('{
|
|
898
|
+
let urlPath = `/public/badge-credentials/{credentialId}/document`;
|
|
899
|
+
urlPath = urlPath.replace('{credentialId}', encodeURIComponent(String(requestParameters['credentialId'])));
|
|
690
900
|
|
|
691
901
|
return {
|
|
692
902
|
path: urlPath,
|
|
693
|
-
method: '
|
|
903
|
+
method: 'GET',
|
|
694
904
|
headers: headerParameters,
|
|
695
905
|
query: queryParameters,
|
|
696
|
-
body: PutCertificateConfigToJSON(requestParameters['putCertificateConfig']),
|
|
697
906
|
};
|
|
698
907
|
}
|
|
699
908
|
|
|
700
909
|
/**
|
|
701
|
-
*
|
|
910
|
+
* Read the signed Open Badges credential document
|
|
702
911
|
*/
|
|
703
|
-
async
|
|
704
|
-
const requestOptions = await this.
|
|
912
|
+
async getPublicBadgeCredentialDocumentRaw(requestParameters: GetPublicBadgeCredentialDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: any; }>> {
|
|
913
|
+
const requestOptions = await this.getPublicBadgeCredentialDocumentRequestOpts(requestParameters);
|
|
705
914
|
const response = await this.request(requestOptions, initOverrides);
|
|
706
915
|
|
|
707
|
-
return new runtime.JSONApiResponse(response
|
|
916
|
+
return new runtime.JSONApiResponse<any>(response);
|
|
708
917
|
}
|
|
709
918
|
|
|
710
919
|
/**
|
|
711
|
-
*
|
|
920
|
+
* Read the signed Open Badges credential document
|
|
712
921
|
*/
|
|
713
|
-
async
|
|
714
|
-
const response = await this.
|
|
922
|
+
async getPublicBadgeCredentialDocument(requestParameters: GetPublicBadgeCredentialDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: any; }> {
|
|
923
|
+
const response = await this.getPublicBadgeCredentialDocumentRaw(requestParameters, initOverrides);
|
|
715
924
|
return await response.value();
|
|
716
925
|
}
|
|
717
926
|
|
|
718
927
|
/**
|
|
719
|
-
* Creates request options for
|
|
928
|
+
* Creates request options for getPublicBadgeCredentialStatus without sending the request
|
|
720
929
|
*/
|
|
721
|
-
async
|
|
722
|
-
if (requestParameters['
|
|
930
|
+
async getPublicBadgeCredentialStatusRequestOpts(requestParameters: GetPublicBadgeCredentialStatusRequest): Promise<runtime.RequestOpts> {
|
|
931
|
+
if (requestParameters['credentialId'] == null) {
|
|
723
932
|
throw new runtime.RequiredError(
|
|
724
|
-
'
|
|
725
|
-
'Required parameter "
|
|
933
|
+
'credentialId',
|
|
934
|
+
'Required parameter "credentialId" was null or undefined when calling getPublicBadgeCredentialStatus().'
|
|
935
|
+
);
|
|
936
|
+
}
|
|
937
|
+
|
|
938
|
+
const queryParameters: any = {};
|
|
939
|
+
|
|
940
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
let urlPath = `/public/badge-credentials/{credentialId}/status`;
|
|
944
|
+
urlPath = urlPath.replace('{credentialId}', encodeURIComponent(String(requestParameters['credentialId'])));
|
|
945
|
+
|
|
946
|
+
return {
|
|
947
|
+
path: urlPath,
|
|
948
|
+
method: 'GET',
|
|
949
|
+
headers: headerParameters,
|
|
950
|
+
query: queryParameters,
|
|
951
|
+
};
|
|
952
|
+
}
|
|
953
|
+
|
|
954
|
+
/**
|
|
955
|
+
* Get mutable hosted status without changing the signed credential
|
|
956
|
+
*/
|
|
957
|
+
async getPublicBadgeCredentialStatusRaw(requestParameters: GetPublicBadgeCredentialStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPublicBadgeCredentialStatus200Response>> {
|
|
958
|
+
const requestOptions = await this.getPublicBadgeCredentialStatusRequestOpts(requestParameters);
|
|
959
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
960
|
+
|
|
961
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetPublicBadgeCredentialStatus200ResponseFromJSON(jsonValue));
|
|
962
|
+
}
|
|
963
|
+
|
|
964
|
+
/**
|
|
965
|
+
* Get mutable hosted status without changing the signed credential
|
|
966
|
+
*/
|
|
967
|
+
async getPublicBadgeCredentialStatus(requestParameters: GetPublicBadgeCredentialStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPublicBadgeCredentialStatus200Response> {
|
|
968
|
+
const response = await this.getPublicBadgeCredentialStatusRaw(requestParameters, initOverrides);
|
|
969
|
+
return await response.value();
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* Creates request options for getPublicBadgeIssuer without sending the request
|
|
974
|
+
*/
|
|
975
|
+
async getPublicBadgeIssuerRequestOpts(requestParameters: GetPublicBadgeIssuerRequest): Promise<runtime.RequestOpts> {
|
|
976
|
+
if (requestParameters['portalId'] == null) {
|
|
977
|
+
throw new runtime.RequiredError(
|
|
978
|
+
'portalId',
|
|
979
|
+
'Required parameter "portalId" was null or undefined when calling getPublicBadgeIssuer().'
|
|
980
|
+
);
|
|
981
|
+
}
|
|
982
|
+
|
|
983
|
+
const queryParameters: any = {};
|
|
984
|
+
|
|
985
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
let urlPath = `/public/badge-issuers/{portalId}`;
|
|
989
|
+
urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
|
|
990
|
+
|
|
991
|
+
return {
|
|
992
|
+
path: urlPath,
|
|
993
|
+
method: 'GET',
|
|
994
|
+
headers: headerParameters,
|
|
995
|
+
query: queryParameters,
|
|
996
|
+
};
|
|
997
|
+
}
|
|
998
|
+
|
|
999
|
+
/**
|
|
1000
|
+
* Get an Open Badges issuer profile
|
|
1001
|
+
*/
|
|
1002
|
+
async getPublicBadgeIssuerRaw(requestParameters: GetPublicBadgeIssuerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: any; }>> {
|
|
1003
|
+
const requestOptions = await this.getPublicBadgeIssuerRequestOpts(requestParameters);
|
|
1004
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1005
|
+
|
|
1006
|
+
return new runtime.JSONApiResponse<any>(response);
|
|
1007
|
+
}
|
|
1008
|
+
|
|
1009
|
+
/**
|
|
1010
|
+
* Get an Open Badges issuer profile
|
|
1011
|
+
*/
|
|
1012
|
+
async getPublicBadgeIssuer(requestParameters: GetPublicBadgeIssuerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: any; }> {
|
|
1013
|
+
const response = await this.getPublicBadgeIssuerRaw(requestParameters, initOverrides);
|
|
1014
|
+
return await response.value();
|
|
1015
|
+
}
|
|
1016
|
+
|
|
1017
|
+
/**
|
|
1018
|
+
* Creates request options for getPublicBadgeIssuerDidDocument without sending the request
|
|
1019
|
+
*/
|
|
1020
|
+
async getPublicBadgeIssuerDidDocumentRequestOpts(requestParameters: GetPublicBadgeIssuerDidDocumentRequest): Promise<runtime.RequestOpts> {
|
|
1021
|
+
if (requestParameters['portalId'] == null) {
|
|
1022
|
+
throw new runtime.RequiredError(
|
|
1023
|
+
'portalId',
|
|
1024
|
+
'Required parameter "portalId" was null or undefined when calling getPublicBadgeIssuerDidDocument().'
|
|
1025
|
+
);
|
|
1026
|
+
}
|
|
1027
|
+
|
|
1028
|
+
const queryParameters: any = {};
|
|
1029
|
+
|
|
1030
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
let urlPath = `/public/badge-issuers/{portalId}/did.json`;
|
|
1034
|
+
urlPath = urlPath.replace('{portalId}', encodeURIComponent(String(requestParameters['portalId'])));
|
|
1035
|
+
|
|
1036
|
+
return {
|
|
1037
|
+
path: urlPath,
|
|
1038
|
+
method: 'GET',
|
|
1039
|
+
headers: headerParameters,
|
|
1040
|
+
query: queryParameters,
|
|
1041
|
+
};
|
|
1042
|
+
}
|
|
1043
|
+
|
|
1044
|
+
/**
|
|
1045
|
+
* Get the portal-specific did:web document and retained public keys
|
|
1046
|
+
*/
|
|
1047
|
+
async getPublicBadgeIssuerDidDocumentRaw(requestParameters: GetPublicBadgeIssuerDidDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<{ [key: string]: any; }>> {
|
|
1048
|
+
const requestOptions = await this.getPublicBadgeIssuerDidDocumentRequestOpts(requestParameters);
|
|
1049
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1050
|
+
|
|
1051
|
+
return new runtime.JSONApiResponse<any>(response);
|
|
1052
|
+
}
|
|
1053
|
+
|
|
1054
|
+
/**
|
|
1055
|
+
* Get the portal-specific did:web document and retained public keys
|
|
1056
|
+
*/
|
|
1057
|
+
async getPublicBadgeIssuerDidDocument(requestParameters: GetPublicBadgeIssuerDidDocumentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<{ [key: string]: any; }> {
|
|
1058
|
+
const response = await this.getPublicBadgeIssuerDidDocumentRaw(requestParameters, initOverrides);
|
|
1059
|
+
return await response.value();
|
|
1060
|
+
}
|
|
1061
|
+
|
|
1062
|
+
/**
|
|
1063
|
+
* Creates request options for getPublicCertificatePdf without sending the request
|
|
1064
|
+
*/
|
|
1065
|
+
async getPublicCertificatePdfRequestOpts(requestParameters: GetPublicCertificatePdfRequest): Promise<runtime.RequestOpts> {
|
|
1066
|
+
if (requestParameters['certificateId'] == null) {
|
|
1067
|
+
throw new runtime.RequiredError(
|
|
1068
|
+
'certificateId',
|
|
1069
|
+
'Required parameter "certificateId" was null or undefined when calling getPublicCertificatePdf().'
|
|
1070
|
+
);
|
|
1071
|
+
}
|
|
1072
|
+
|
|
1073
|
+
const queryParameters: any = {};
|
|
1074
|
+
|
|
1075
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
let urlPath = `/public/certificates/{certificateId}/pdf`;
|
|
1079
|
+
urlPath = urlPath.replace('{certificateId}', encodeURIComponent(String(requestParameters['certificateId'])));
|
|
1080
|
+
|
|
1081
|
+
return {
|
|
1082
|
+
path: urlPath,
|
|
1083
|
+
method: 'GET',
|
|
1084
|
+
headers: headerParameters,
|
|
1085
|
+
query: queryParameters,
|
|
1086
|
+
};
|
|
1087
|
+
}
|
|
1088
|
+
|
|
1089
|
+
/**
|
|
1090
|
+
* Download an immutable public certificate PDF
|
|
1091
|
+
*/
|
|
1092
|
+
async getPublicCertificatePdfRaw(requestParameters: GetPublicCertificatePdfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
|
|
1093
|
+
const requestOptions = await this.getPublicCertificatePdfRequestOpts(requestParameters);
|
|
1094
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1095
|
+
|
|
1096
|
+
return new runtime.BlobApiResponse(response);
|
|
1097
|
+
}
|
|
1098
|
+
|
|
1099
|
+
/**
|
|
1100
|
+
* Download an immutable public certificate PDF
|
|
1101
|
+
*/
|
|
1102
|
+
async getPublicCertificatePdf(requestParameters: GetPublicCertificatePdfRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
|
|
1103
|
+
const response = await this.getPublicCertificatePdfRaw(requestParameters, initOverrides);
|
|
1104
|
+
return await response.value();
|
|
1105
|
+
}
|
|
1106
|
+
|
|
1107
|
+
/**
|
|
1108
|
+
* Creates request options for postBadgeIssuerKeyRotate without sending the request
|
|
1109
|
+
*/
|
|
1110
|
+
async postBadgeIssuerKeyRotateRequestOpts(): Promise<runtime.RequestOpts> {
|
|
1111
|
+
const queryParameters: any = {};
|
|
1112
|
+
|
|
1113
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
let urlPath = `/badge-issuer/keys/rotate`;
|
|
1117
|
+
|
|
1118
|
+
return {
|
|
1119
|
+
path: urlPath,
|
|
1120
|
+
method: 'POST',
|
|
1121
|
+
headers: headerParameters,
|
|
1122
|
+
query: queryParameters,
|
|
1123
|
+
};
|
|
1124
|
+
}
|
|
1125
|
+
|
|
1126
|
+
/**
|
|
1127
|
+
* Generate and activate a new KMS-wrapped portal signing key
|
|
1128
|
+
*/
|
|
1129
|
+
async postBadgeIssuerKeyRotateRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BadgeIssuer>> {
|
|
1130
|
+
const requestOptions = await this.postBadgeIssuerKeyRotateRequestOpts();
|
|
1131
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1132
|
+
|
|
1133
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => BadgeIssuerFromJSON(jsonValue));
|
|
1134
|
+
}
|
|
1135
|
+
|
|
1136
|
+
/**
|
|
1137
|
+
* Generate and activate a new KMS-wrapped portal signing key
|
|
1138
|
+
*/
|
|
1139
|
+
async postBadgeIssuerKeyRotate(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BadgeIssuer> {
|
|
1140
|
+
const response = await this.postBadgeIssuerKeyRotateRaw(initOverrides);
|
|
1141
|
+
return await response.value();
|
|
1142
|
+
}
|
|
1143
|
+
|
|
1144
|
+
/**
|
|
1145
|
+
* Creates request options for postCertificateArtifactRetry without sending the request
|
|
1146
|
+
*/
|
|
1147
|
+
async postCertificateArtifactRetryRequestOpts(requestParameters: PostCertificateArtifactRetryRequest): Promise<runtime.RequestOpts> {
|
|
1148
|
+
if (requestParameters['certificateId'] == null) {
|
|
1149
|
+
throw new runtime.RequiredError(
|
|
1150
|
+
'certificateId',
|
|
1151
|
+
'Required parameter "certificateId" was null or undefined when calling postCertificateArtifactRetry().'
|
|
1152
|
+
);
|
|
1153
|
+
}
|
|
1154
|
+
|
|
1155
|
+
const queryParameters: any = {};
|
|
1156
|
+
|
|
1157
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1158
|
+
|
|
1159
|
+
|
|
1160
|
+
let urlPath = `/certificates/{certificateId}/artifacts/retry`;
|
|
1161
|
+
urlPath = urlPath.replace('{certificateId}', encodeURIComponent(String(requestParameters['certificateId'])));
|
|
1162
|
+
|
|
1163
|
+
return {
|
|
1164
|
+
path: urlPath,
|
|
1165
|
+
method: 'POST',
|
|
1166
|
+
headers: headerParameters,
|
|
1167
|
+
query: queryParameters,
|
|
1168
|
+
};
|
|
1169
|
+
}
|
|
1170
|
+
|
|
1171
|
+
/**
|
|
1172
|
+
* Retry failed certificate artifact generation
|
|
1173
|
+
*/
|
|
1174
|
+
async postCertificateArtifactRetryRaw(requestParameters: PostCertificateArtifactRetryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CertificateArtifact>> {
|
|
1175
|
+
const requestOptions = await this.postCertificateArtifactRetryRequestOpts(requestParameters);
|
|
1176
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1177
|
+
|
|
1178
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CertificateArtifactFromJSON(jsonValue));
|
|
1179
|
+
}
|
|
1180
|
+
|
|
1181
|
+
/**
|
|
1182
|
+
* Retry failed certificate artifact generation
|
|
1183
|
+
*/
|
|
1184
|
+
async postCertificateArtifactRetry(requestParameters: PostCertificateArtifactRetryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CertificateArtifact> {
|
|
1185
|
+
const response = await this.postCertificateArtifactRetryRaw(requestParameters, initOverrides);
|
|
1186
|
+
return await response.value();
|
|
1187
|
+
}
|
|
1188
|
+
|
|
1189
|
+
/**
|
|
1190
|
+
* Creates request options for postCertificateConfig without sending the request
|
|
1191
|
+
*/
|
|
1192
|
+
async postCertificateConfigRequestOpts(requestParameters: PostCertificateConfigRequest): Promise<runtime.RequestOpts> {
|
|
1193
|
+
if (requestParameters['postCertificateConfig'] == null) {
|
|
1194
|
+
throw new runtime.RequiredError(
|
|
1195
|
+
'postCertificateConfig',
|
|
1196
|
+
'Required parameter "postCertificateConfig" was null or undefined when calling postCertificateConfig().'
|
|
1197
|
+
);
|
|
1198
|
+
}
|
|
1199
|
+
|
|
1200
|
+
const queryParameters: any = {};
|
|
1201
|
+
|
|
1202
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1203
|
+
|
|
1204
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
let urlPath = `/certificate-configs`;
|
|
1208
|
+
|
|
1209
|
+
return {
|
|
1210
|
+
path: urlPath,
|
|
1211
|
+
method: 'POST',
|
|
1212
|
+
headers: headerParameters,
|
|
1213
|
+
query: queryParameters,
|
|
1214
|
+
body: PostCertificateConfigToJSON(requestParameters['postCertificateConfig']),
|
|
1215
|
+
};
|
|
1216
|
+
}
|
|
1217
|
+
|
|
1218
|
+
/**
|
|
1219
|
+
* Create a certificate config
|
|
1220
|
+
*/
|
|
1221
|
+
async postCertificateConfigRaw(requestParameters: PostCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CertificateConfig>> {
|
|
1222
|
+
const requestOptions = await this.postCertificateConfigRequestOpts(requestParameters);
|
|
1223
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1224
|
+
|
|
1225
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CertificateConfigFromJSON(jsonValue));
|
|
1226
|
+
}
|
|
1227
|
+
|
|
1228
|
+
/**
|
|
1229
|
+
* Create a certificate config
|
|
1230
|
+
*/
|
|
1231
|
+
async postCertificateConfig(requestParameters: PostCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CertificateConfig> {
|
|
1232
|
+
const response = await this.postCertificateConfigRaw(requestParameters, initOverrides);
|
|
1233
|
+
return await response.value();
|
|
1234
|
+
}
|
|
1235
|
+
|
|
1236
|
+
/**
|
|
1237
|
+
* Creates request options for postCertificateRenew without sending the request
|
|
1238
|
+
*/
|
|
1239
|
+
async postCertificateRenewRequestOpts(requestParameters: PostCertificateRenewRequest): Promise<runtime.RequestOpts> {
|
|
1240
|
+
if (requestParameters['certificateId'] == null) {
|
|
1241
|
+
throw new runtime.RequiredError(
|
|
1242
|
+
'certificateId',
|
|
1243
|
+
'Required parameter "certificateId" was null or undefined when calling postCertificateRenew().'
|
|
1244
|
+
);
|
|
1245
|
+
}
|
|
1246
|
+
|
|
1247
|
+
if (requestParameters['postCertificateLifecycleAction'] == null) {
|
|
1248
|
+
throw new runtime.RequiredError(
|
|
1249
|
+
'postCertificateLifecycleAction',
|
|
1250
|
+
'Required parameter "postCertificateLifecycleAction" was null or undefined when calling postCertificateRenew().'
|
|
1251
|
+
);
|
|
1252
|
+
}
|
|
1253
|
+
|
|
1254
|
+
const queryParameters: any = {};
|
|
1255
|
+
|
|
1256
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1257
|
+
|
|
1258
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1259
|
+
|
|
1260
|
+
|
|
1261
|
+
let urlPath = `/certificates/{certificateId}/renew`;
|
|
1262
|
+
urlPath = urlPath.replace('{certificateId}', encodeURIComponent(String(requestParameters['certificateId'])));
|
|
1263
|
+
|
|
1264
|
+
return {
|
|
1265
|
+
path: urlPath,
|
|
1266
|
+
method: 'POST',
|
|
1267
|
+
headers: headerParameters,
|
|
1268
|
+
query: queryParameters,
|
|
1269
|
+
body: PostCertificateLifecycleActionToJSON(requestParameters['postCertificateLifecycleAction']),
|
|
1270
|
+
};
|
|
1271
|
+
}
|
|
1272
|
+
|
|
1273
|
+
/**
|
|
1274
|
+
* Manually renew an eligible certificate
|
|
1275
|
+
*/
|
|
1276
|
+
async postCertificateRenewRaw(requestParameters: PostCertificateRenewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Certificate>> {
|
|
1277
|
+
const requestOptions = await this.postCertificateRenewRequestOpts(requestParameters);
|
|
1278
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1279
|
+
|
|
1280
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CertificateFromJSON(jsonValue));
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
/**
|
|
1284
|
+
* Manually renew an eligible certificate
|
|
1285
|
+
*/
|
|
1286
|
+
async postCertificateRenew(requestParameters: PostCertificateRenewRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Certificate> {
|
|
1287
|
+
const response = await this.postCertificateRenewRaw(requestParameters, initOverrides);
|
|
1288
|
+
return await response.value();
|
|
1289
|
+
}
|
|
1290
|
+
|
|
1291
|
+
/**
|
|
1292
|
+
* Creates request options for postCertificateReplace without sending the request
|
|
1293
|
+
*/
|
|
1294
|
+
async postCertificateReplaceRequestOpts(requestParameters: PostCertificateReplaceRequest): Promise<runtime.RequestOpts> {
|
|
1295
|
+
if (requestParameters['certificateId'] == null) {
|
|
1296
|
+
throw new runtime.RequiredError(
|
|
1297
|
+
'certificateId',
|
|
1298
|
+
'Required parameter "certificateId" was null or undefined when calling postCertificateReplace().'
|
|
1299
|
+
);
|
|
1300
|
+
}
|
|
1301
|
+
|
|
1302
|
+
if (requestParameters['postCertificateLifecycleAction'] == null) {
|
|
1303
|
+
throw new runtime.RequiredError(
|
|
1304
|
+
'postCertificateLifecycleAction',
|
|
1305
|
+
'Required parameter "postCertificateLifecycleAction" was null or undefined when calling postCertificateReplace().'
|
|
1306
|
+
);
|
|
1307
|
+
}
|
|
1308
|
+
|
|
1309
|
+
const queryParameters: any = {};
|
|
1310
|
+
|
|
1311
|
+
if (requestParameters['correction'] != null) {
|
|
1312
|
+
queryParameters['correction'] = requestParameters['correction'];
|
|
1313
|
+
}
|
|
1314
|
+
|
|
1315
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1316
|
+
|
|
1317
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1318
|
+
|
|
1319
|
+
|
|
1320
|
+
let urlPath = `/certificates/{certificateId}/replace`;
|
|
1321
|
+
urlPath = urlPath.replace('{certificateId}', encodeURIComponent(String(requestParameters['certificateId'])));
|
|
1322
|
+
|
|
1323
|
+
return {
|
|
1324
|
+
path: urlPath,
|
|
1325
|
+
method: 'POST',
|
|
1326
|
+
headers: headerParameters,
|
|
1327
|
+
query: queryParameters,
|
|
1328
|
+
body: PostCertificateLifecycleActionToJSON(requestParameters['postCertificateLifecycleAction']),
|
|
1329
|
+
};
|
|
1330
|
+
}
|
|
1331
|
+
|
|
1332
|
+
/**
|
|
1333
|
+
* Replace or correct an issued certificate
|
|
1334
|
+
*/
|
|
1335
|
+
async postCertificateReplaceRaw(requestParameters: PostCertificateReplaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Certificate>> {
|
|
1336
|
+
const requestOptions = await this.postCertificateReplaceRequestOpts(requestParameters);
|
|
1337
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1338
|
+
|
|
1339
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CertificateFromJSON(jsonValue));
|
|
1340
|
+
}
|
|
1341
|
+
|
|
1342
|
+
/**
|
|
1343
|
+
* Replace or correct an issued certificate
|
|
1344
|
+
*/
|
|
1345
|
+
async postCertificateReplace(requestParameters: PostCertificateReplaceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Certificate> {
|
|
1346
|
+
const response = await this.postCertificateReplaceRaw(requestParameters, initOverrides);
|
|
1347
|
+
return await response.value();
|
|
1348
|
+
}
|
|
1349
|
+
|
|
1350
|
+
/**
|
|
1351
|
+
* Creates request options for postCourseCertificate without sending the request
|
|
1352
|
+
*/
|
|
1353
|
+
async postCourseCertificateRequestOpts(requestParameters: PostCourseCertificateRequest): Promise<runtime.RequestOpts> {
|
|
1354
|
+
if (requestParameters['courseId'] == null) {
|
|
1355
|
+
throw new runtime.RequiredError(
|
|
1356
|
+
'courseId',
|
|
1357
|
+
'Required parameter "courseId" was null or undefined when calling postCourseCertificate().'
|
|
1358
|
+
);
|
|
1359
|
+
}
|
|
1360
|
+
|
|
1361
|
+
if (requestParameters['postCertificate'] == null) {
|
|
1362
|
+
throw new runtime.RequiredError(
|
|
1363
|
+
'postCertificate',
|
|
1364
|
+
'Required parameter "postCertificate" was null or undefined when calling postCourseCertificate().'
|
|
1365
|
+
);
|
|
1366
|
+
}
|
|
1367
|
+
|
|
1368
|
+
const queryParameters: any = {};
|
|
1369
|
+
|
|
1370
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1371
|
+
|
|
1372
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
let urlPath = `/courses/{courseId}/certificates`;
|
|
1376
|
+
urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
|
|
1377
|
+
|
|
1378
|
+
return {
|
|
1379
|
+
path: urlPath,
|
|
1380
|
+
method: 'POST',
|
|
1381
|
+
headers: headerParameters,
|
|
1382
|
+
query: queryParameters,
|
|
1383
|
+
body: PostCertificateToJSON(requestParameters['postCertificate']),
|
|
1384
|
+
};
|
|
1385
|
+
}
|
|
1386
|
+
|
|
1387
|
+
/**
|
|
1388
|
+
* Manually issue a certificate for a course
|
|
1389
|
+
*/
|
|
1390
|
+
async postCourseCertificateRaw(requestParameters: PostCourseCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Certificate>> {
|
|
1391
|
+
const requestOptions = await this.postCourseCertificateRequestOpts(requestParameters);
|
|
1392
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1393
|
+
|
|
1394
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CertificateFromJSON(jsonValue));
|
|
1395
|
+
}
|
|
1396
|
+
|
|
1397
|
+
/**
|
|
1398
|
+
* Manually issue a certificate for a course
|
|
1399
|
+
*/
|
|
1400
|
+
async postCourseCertificate(requestParameters: PostCourseCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Certificate> {
|
|
1401
|
+
const response = await this.postCourseCertificateRaw(requestParameters, initOverrides);
|
|
1402
|
+
return await response.value();
|
|
1403
|
+
}
|
|
1404
|
+
|
|
1405
|
+
/**
|
|
1406
|
+
* Creates request options for postRevokeCertificate without sending the request
|
|
1407
|
+
*/
|
|
1408
|
+
async postRevokeCertificateRequestOpts(requestParameters: PostRevokeCertificateRequest): Promise<runtime.RequestOpts> {
|
|
1409
|
+
if (requestParameters['certificateId'] == null) {
|
|
1410
|
+
throw new runtime.RequiredError(
|
|
1411
|
+
'certificateId',
|
|
1412
|
+
'Required parameter "certificateId" was null or undefined when calling postRevokeCertificate().'
|
|
1413
|
+
);
|
|
1414
|
+
}
|
|
1415
|
+
|
|
1416
|
+
if (requestParameters['postRevokeCertificate'] == null) {
|
|
1417
|
+
throw new runtime.RequiredError(
|
|
1418
|
+
'postRevokeCertificate',
|
|
1419
|
+
'Required parameter "postRevokeCertificate" was null or undefined when calling postRevokeCertificate().'
|
|
1420
|
+
);
|
|
1421
|
+
}
|
|
1422
|
+
|
|
1423
|
+
const queryParameters: any = {};
|
|
1424
|
+
|
|
1425
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1426
|
+
|
|
1427
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1428
|
+
|
|
1429
|
+
|
|
1430
|
+
let urlPath = `/certificates/{certificateId}/revoke`;
|
|
1431
|
+
urlPath = urlPath.replace('{certificateId}', encodeURIComponent(String(requestParameters['certificateId'])));
|
|
1432
|
+
|
|
1433
|
+
return {
|
|
1434
|
+
path: urlPath,
|
|
1435
|
+
method: 'POST',
|
|
1436
|
+
headers: headerParameters,
|
|
1437
|
+
query: queryParameters,
|
|
1438
|
+
body: PostRevokeCertificateToJSON(requestParameters['postRevokeCertificate']),
|
|
1439
|
+
};
|
|
1440
|
+
}
|
|
1441
|
+
|
|
1442
|
+
/**
|
|
1443
|
+
* Revoke a certificate
|
|
1444
|
+
*/
|
|
1445
|
+
async postRevokeCertificateRaw(requestParameters: PostRevokeCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Certificate>> {
|
|
1446
|
+
const requestOptions = await this.postRevokeCertificateRequestOpts(requestParameters);
|
|
1447
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1448
|
+
|
|
1449
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CertificateFromJSON(jsonValue));
|
|
1450
|
+
}
|
|
1451
|
+
|
|
1452
|
+
/**
|
|
1453
|
+
* Revoke a certificate
|
|
1454
|
+
*/
|
|
1455
|
+
async postRevokeCertificate(requestParameters: PostRevokeCertificateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Certificate> {
|
|
1456
|
+
const response = await this.postRevokeCertificateRaw(requestParameters, initOverrides);
|
|
1457
|
+
return await response.value();
|
|
1458
|
+
}
|
|
1459
|
+
|
|
1460
|
+
/**
|
|
1461
|
+
* Creates request options for putBadgeIssuer without sending the request
|
|
1462
|
+
*/
|
|
1463
|
+
async putBadgeIssuerRequestOpts(requestParameters: PutBadgeIssuerRequest): Promise<runtime.RequestOpts> {
|
|
1464
|
+
if (requestParameters['putBadgeIssuer'] == null) {
|
|
1465
|
+
throw new runtime.RequiredError(
|
|
1466
|
+
'putBadgeIssuer',
|
|
1467
|
+
'Required parameter "putBadgeIssuer" was null or undefined when calling putBadgeIssuer().'
|
|
1468
|
+
);
|
|
1469
|
+
}
|
|
1470
|
+
|
|
1471
|
+
const queryParameters: any = {};
|
|
1472
|
+
|
|
1473
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1474
|
+
|
|
1475
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
let urlPath = `/badge-issuer`;
|
|
1479
|
+
|
|
1480
|
+
return {
|
|
1481
|
+
path: urlPath,
|
|
1482
|
+
method: 'PUT',
|
|
1483
|
+
headers: headerParameters,
|
|
1484
|
+
query: queryParameters,
|
|
1485
|
+
body: PutBadgeIssuerToJSON(requestParameters['putBadgeIssuer']),
|
|
1486
|
+
};
|
|
1487
|
+
}
|
|
1488
|
+
|
|
1489
|
+
/**
|
|
1490
|
+
* Create or update the selected portal Open Badges issuer
|
|
1491
|
+
*/
|
|
1492
|
+
async putBadgeIssuerRaw(requestParameters: PutBadgeIssuerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<BadgeIssuer>> {
|
|
1493
|
+
const requestOptions = await this.putBadgeIssuerRequestOpts(requestParameters);
|
|
1494
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1495
|
+
|
|
1496
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => BadgeIssuerFromJSON(jsonValue));
|
|
1497
|
+
}
|
|
1498
|
+
|
|
1499
|
+
/**
|
|
1500
|
+
* Create or update the selected portal Open Badges issuer
|
|
1501
|
+
*/
|
|
1502
|
+
async putBadgeIssuer(requestParameters: PutBadgeIssuerRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<BadgeIssuer> {
|
|
1503
|
+
const response = await this.putBadgeIssuerRaw(requestParameters, initOverrides);
|
|
1504
|
+
return await response.value();
|
|
1505
|
+
}
|
|
1506
|
+
|
|
1507
|
+
/**
|
|
1508
|
+
* Creates request options for putCertificateConfig without sending the request
|
|
1509
|
+
*/
|
|
1510
|
+
async putCertificateConfigRequestOpts(requestParameters: PutCertificateConfigRequest): Promise<runtime.RequestOpts> {
|
|
1511
|
+
if (requestParameters['configId'] == null) {
|
|
1512
|
+
throw new runtime.RequiredError(
|
|
1513
|
+
'configId',
|
|
1514
|
+
'Required parameter "configId" was null or undefined when calling putCertificateConfig().'
|
|
1515
|
+
);
|
|
1516
|
+
}
|
|
1517
|
+
|
|
1518
|
+
if (requestParameters['putCertificateConfig'] == null) {
|
|
1519
|
+
throw new runtime.RequiredError(
|
|
1520
|
+
'putCertificateConfig',
|
|
1521
|
+
'Required parameter "putCertificateConfig" was null or undefined when calling putCertificateConfig().'
|
|
1522
|
+
);
|
|
1523
|
+
}
|
|
1524
|
+
|
|
1525
|
+
const queryParameters: any = {};
|
|
1526
|
+
|
|
1527
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
1528
|
+
|
|
1529
|
+
headerParameters['Content-Type'] = 'application/json';
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
let urlPath = `/certificate-configs/{configId}`;
|
|
1533
|
+
urlPath = urlPath.replace('{configId}', encodeURIComponent(String(requestParameters['configId'])));
|
|
1534
|
+
|
|
1535
|
+
return {
|
|
1536
|
+
path: urlPath,
|
|
1537
|
+
method: 'PUT',
|
|
1538
|
+
headers: headerParameters,
|
|
1539
|
+
query: queryParameters,
|
|
1540
|
+
body: PutCertificateConfigToJSON(requestParameters['putCertificateConfig']),
|
|
1541
|
+
};
|
|
1542
|
+
}
|
|
1543
|
+
|
|
1544
|
+
/**
|
|
1545
|
+
* Update a certificate config
|
|
1546
|
+
*/
|
|
1547
|
+
async putCertificateConfigRaw(requestParameters: PutCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CertificateConfig>> {
|
|
1548
|
+
const requestOptions = await this.putCertificateConfigRequestOpts(requestParameters);
|
|
1549
|
+
const response = await this.request(requestOptions, initOverrides);
|
|
1550
|
+
|
|
1551
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => CertificateConfigFromJSON(jsonValue));
|
|
1552
|
+
}
|
|
1553
|
+
|
|
1554
|
+
/**
|
|
1555
|
+
* Update a certificate config
|
|
1556
|
+
*/
|
|
1557
|
+
async putCertificateConfig(requestParameters: PutCertificateConfigRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CertificateConfig> {
|
|
1558
|
+
const response = await this.putCertificateConfigRaw(requestParameters, initOverrides);
|
|
1559
|
+
return await response.value();
|
|
1560
|
+
}
|
|
1561
|
+
|
|
1562
|
+
/**
|
|
1563
|
+
* Creates request options for verifyCertificate without sending the request
|
|
1564
|
+
*/
|
|
1565
|
+
async verifyCertificateRequestOpts(requestParameters: VerifyCertificateRequest): Promise<runtime.RequestOpts> {
|
|
1566
|
+
if (requestParameters['certificateId'] == null) {
|
|
1567
|
+
throw new runtime.RequiredError(
|
|
1568
|
+
'certificateId',
|
|
1569
|
+
'Required parameter "certificateId" was null or undefined when calling verifyCertificate().'
|
|
726
1570
|
);
|
|
727
1571
|
}
|
|
728
1572
|
|
|
@@ -770,11 +1614,21 @@ export const GetCertificateConfigsScopeEnum = {
|
|
|
770
1614
|
Course: 'course'
|
|
771
1615
|
} as const;
|
|
772
1616
|
export type GetCertificateConfigsScopeEnum = typeof GetCertificateConfigsScopeEnum[keyof typeof GetCertificateConfigsScopeEnum];
|
|
1617
|
+
/**
|
|
1618
|
+
* @export
|
|
1619
|
+
*/
|
|
1620
|
+
export const GetCertificateCsvExportStatusEnum = {
|
|
1621
|
+
Active: 'active',
|
|
1622
|
+
Revoked: 'revoked',
|
|
1623
|
+
Superseded: 'superseded'
|
|
1624
|
+
} as const;
|
|
1625
|
+
export type GetCertificateCsvExportStatusEnum = typeof GetCertificateCsvExportStatusEnum[keyof typeof GetCertificateCsvExportStatusEnum];
|
|
773
1626
|
/**
|
|
774
1627
|
* @export
|
|
775
1628
|
*/
|
|
776
1629
|
export const GetCertificatesStatusEnum = {
|
|
777
1630
|
Active: 'active',
|
|
778
|
-
Revoked: 'revoked'
|
|
1631
|
+
Revoked: 'revoked',
|
|
1632
|
+
Superseded: 'superseded'
|
|
779
1633
|
} as const;
|
|
780
1634
|
export type GetCertificatesStatusEnum = typeof GetCertificatesStatusEnum[keyof typeof GetCertificatesStatusEnum];
|