@easyedu/js-lsm-api 1.103.0 → 1.105.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.
Files changed (122) hide show
  1. package/.openapi-generator/FILES +30 -0
  2. package/README.md +24 -2
  3. package/dist/apis/ChatApi.d.ts +98 -0
  4. package/dist/apis/ChatApi.js +255 -0
  5. package/dist/apis/EmailTemplateApi.d.ts +32 -0
  6. package/dist/apis/EmailTemplateApi.js +64 -1
  7. package/dist/esm/apis/ChatApi.d.ts +98 -0
  8. package/dist/esm/apis/ChatApi.js +255 -0
  9. package/dist/esm/apis/EmailTemplateApi.d.ts +32 -0
  10. package/dist/esm/apis/EmailTemplateApi.js +63 -0
  11. package/dist/esm/models/AdminChatMessage.d.ts +51 -0
  12. package/dist/esm/models/AdminChatMessage.js +54 -0
  13. package/dist/esm/models/AdminConversationDetail.d.ts +90 -0
  14. package/dist/esm/models/AdminConversationDetail.js +81 -0
  15. package/dist/esm/models/AdminConversationList.d.ts +57 -0
  16. package/dist/esm/models/AdminConversationList.js +60 -0
  17. package/dist/esm/models/AdminConversationSummary.d.ts +83 -0
  18. package/dist/esm/models/AdminConversationSummary.js +76 -0
  19. package/dist/esm/models/ChatDailyUsage.d.ts +39 -0
  20. package/dist/esm/models/ChatDailyUsage.js +48 -0
  21. package/dist/esm/models/ChatModelUsage.d.ts +68 -0
  22. package/dist/esm/models/ChatModelUsage.js +67 -0
  23. package/dist/esm/models/ChatQuota.d.ts +56 -0
  24. package/dist/esm/models/ChatQuota.js +59 -0
  25. package/dist/esm/models/ChatQuotaExceeded.d.ts +56 -0
  26. package/dist/esm/models/ChatQuotaExceeded.js +59 -0
  27. package/dist/esm/models/ChatTurnUsage.d.ts +82 -0
  28. package/dist/esm/models/ChatTurnUsage.js +78 -0
  29. package/dist/esm/models/ChatUsageTotals.d.ts +68 -0
  30. package/dist/esm/models/ChatUsageTotals.js +67 -0
  31. package/dist/esm/models/ChatUserIdentity.d.ts +50 -0
  32. package/dist/esm/models/ChatUserIdentity.js +55 -0
  33. package/dist/esm/models/GetChatSettings.d.ts +51 -0
  34. package/dist/esm/models/GetChatSettings.js +57 -0
  35. package/dist/esm/models/GetChatUsage.d.ts +59 -0
  36. package/dist/esm/models/GetChatUsage.js +62 -0
  37. package/dist/esm/models/GetEmailDelivery.d.ts +31 -0
  38. package/dist/esm/models/GetEmailDelivery.js +13 -0
  39. package/dist/esm/models/GetPortalInvitationSummary.d.ts +102 -0
  40. package/dist/esm/models/GetPortalInvitationSummary.js +87 -0
  41. package/dist/esm/models/GetPortalUser.d.ts +7 -0
  42. package/dist/esm/models/GetPortalUser.js +3 -0
  43. package/dist/esm/models/PutChatSettings.d.ts +32 -0
  44. package/dist/esm/models/PutChatSettings.js +43 -0
  45. package/dist/esm/models/index.d.ts +15 -0
  46. package/dist/esm/models/index.js +15 -0
  47. package/dist/models/AdminChatMessage.d.ts +51 -0
  48. package/dist/models/AdminChatMessage.js +61 -0
  49. package/dist/models/AdminConversationDetail.d.ts +90 -0
  50. package/dist/models/AdminConversationDetail.js +88 -0
  51. package/dist/models/AdminConversationList.d.ts +57 -0
  52. package/dist/models/AdminConversationList.js +67 -0
  53. package/dist/models/AdminConversationSummary.d.ts +83 -0
  54. package/dist/models/AdminConversationSummary.js +83 -0
  55. package/dist/models/ChatDailyUsage.d.ts +39 -0
  56. package/dist/models/ChatDailyUsage.js +55 -0
  57. package/dist/models/ChatModelUsage.d.ts +68 -0
  58. package/dist/models/ChatModelUsage.js +74 -0
  59. package/dist/models/ChatQuota.d.ts +56 -0
  60. package/dist/models/ChatQuota.js +66 -0
  61. package/dist/models/ChatQuotaExceeded.d.ts +56 -0
  62. package/dist/models/ChatQuotaExceeded.js +66 -0
  63. package/dist/models/ChatTurnUsage.d.ts +82 -0
  64. package/dist/models/ChatTurnUsage.js +86 -0
  65. package/dist/models/ChatUsageTotals.d.ts +68 -0
  66. package/dist/models/ChatUsageTotals.js +74 -0
  67. package/dist/models/ChatUserIdentity.d.ts +50 -0
  68. package/dist/models/ChatUserIdentity.js +62 -0
  69. package/dist/models/GetChatSettings.d.ts +51 -0
  70. package/dist/models/GetChatSettings.js +65 -0
  71. package/dist/models/GetChatUsage.d.ts +59 -0
  72. package/dist/models/GetChatUsage.js +69 -0
  73. package/dist/models/GetEmailDelivery.d.ts +31 -0
  74. package/dist/models/GetEmailDelivery.js +13 -0
  75. package/dist/models/GetPortalInvitationSummary.d.ts +102 -0
  76. package/dist/models/GetPortalInvitationSummary.js +95 -0
  77. package/dist/models/GetPortalUser.d.ts +7 -0
  78. package/dist/models/GetPortalUser.js +3 -0
  79. package/dist/models/PutChatSettings.d.ts +32 -0
  80. package/dist/models/PutChatSettings.js +50 -0
  81. package/dist/models/index.d.ts +15 -0
  82. package/dist/models/index.js +15 -0
  83. package/docs/AdminChatMessage.md +40 -0
  84. package/docs/AdminConversationDetail.md +52 -0
  85. package/docs/AdminConversationList.md +42 -0
  86. package/docs/AdminConversationSummary.md +50 -0
  87. package/docs/ChatApi.md +422 -0
  88. package/docs/ChatDailyUsage.md +36 -0
  89. package/docs/ChatModelUsage.md +46 -0
  90. package/docs/ChatQuota.md +42 -0
  91. package/docs/ChatQuotaExceeded.md +42 -0
  92. package/docs/ChatTurnUsage.md +48 -0
  93. package/docs/ChatUsageTotals.md +46 -0
  94. package/docs/ChatUserIdentity.md +40 -0
  95. package/docs/EmailTemplateApi.md +82 -1
  96. package/docs/GetChatSettings.md +38 -0
  97. package/docs/GetChatUsage.md +42 -0
  98. package/docs/GetEmailDelivery.md +10 -0
  99. package/docs/GetPortalInvitationSummary.md +51 -0
  100. package/docs/GetPortalUser.md +2 -0
  101. package/docs/PutChatSettings.md +34 -0
  102. package/package.json +1 -1
  103. package/src/apis/ChatApi.ts +339 -0
  104. package/src/apis/EmailTemplateApi.ts +83 -0
  105. package/src/models/AdminChatMessage.ts +100 -0
  106. package/src/models/AdminConversationDetail.ts +175 -0
  107. package/src/models/AdminConversationList.ts +110 -0
  108. package/src/models/AdminConversationSummary.ts +159 -0
  109. package/src/models/ChatDailyUsage.ts +83 -0
  110. package/src/models/ChatModelUsage.ts +120 -0
  111. package/src/models/ChatQuota.ts +102 -0
  112. package/src/models/ChatQuotaExceeded.ts +102 -0
  113. package/src/models/ChatTurnUsage.ts +140 -0
  114. package/src/models/ChatUsageTotals.ts +120 -0
  115. package/src/models/ChatUserIdentity.ts +93 -0
  116. package/src/models/GetChatSettings.ts +94 -0
  117. package/src/models/GetChatUsage.ts +124 -0
  118. package/src/models/GetEmailDelivery.ts +49 -0
  119. package/src/models/GetPortalInvitationSummary.ts +160 -0
  120. package/src/models/GetPortalUser.ts +16 -0
  121. package/src/models/PutChatSettings.ts +66 -0
  122. package/src/models/index.ts +15 -0
@@ -2,6 +2,10 @@
2
2
  .npmignore
3
3
  .openapi-generator-ignore
4
4
  README.md
5
+ docs/AdminChatMessage.md
6
+ docs/AdminConversationDetail.md
7
+ docs/AdminConversationList.md
8
+ docs/AdminConversationSummary.md
5
9
  docs/ArtifactConflict.md
6
10
  docs/BadgeIssuer.md
7
11
  docs/Certificate.md
@@ -28,6 +32,13 @@ docs/CertificateTemplateApi.md
28
32
  docs/CertificateTemplateVersion.md
29
33
  docs/ChangelogApi.md
30
34
  docs/ChatApi.md
35
+ docs/ChatDailyUsage.md
36
+ docs/ChatModelUsage.md
37
+ docs/ChatQuota.md
38
+ docs/ChatQuotaExceeded.md
39
+ docs/ChatTurnUsage.md
40
+ docs/ChatUsageTotals.md
41
+ docs/ChatUserIdentity.md
31
42
  docs/ContentLaunchMode.md
32
43
  docs/ContentLibraryApi.md
33
44
  docs/ContentLibraryQuizApi.md
@@ -54,6 +65,8 @@ docs/GetCertificateTemplateList.md
54
65
  docs/GetChangelogEntry.md
55
66
  docs/GetChangelogList.md
56
67
  docs/GetChatMessage.md
68
+ docs/GetChatSettings.md
69
+ docs/GetChatUsage.md
57
70
  docs/GetContentLibraryVersion.md
58
71
  docs/GetConversation.md
59
72
  docs/GetConversationList.md
@@ -96,6 +109,7 @@ docs/GetLibraryQuizVersion.md
96
109
  docs/GetPermission.md
97
110
  docs/GetPortal.md
98
111
  docs/GetPortalFaviconUpload.md
112
+ docs/GetPortalInvitationSummary.md
99
113
  docs/GetPortalList.md
100
114
  docs/GetPortalLogoUpload.md
101
115
  docs/GetPortalUser.md
@@ -237,6 +251,7 @@ docs/PutBadgeIssuer.md
237
251
  docs/PutCertificateConfig.md
238
252
  docs/PutCertificateTemplate.md
239
253
  docs/PutCertificateTemplateDraft.md
254
+ docs/PutChatSettings.md
240
255
  docs/PutCourse.md
241
256
  docs/PutCourseCatalog.md
242
257
  docs/PutCourseEnrollment.md
@@ -310,6 +325,10 @@ src/apis/SystemApi.ts
310
325
  src/apis/UserApi.ts
311
326
  src/apis/index.ts
312
327
  src/index.ts
328
+ src/models/AdminChatMessage.ts
329
+ src/models/AdminConversationDetail.ts
330
+ src/models/AdminConversationList.ts
331
+ src/models/AdminConversationSummary.ts
313
332
  src/models/ArtifactConflict.ts
314
333
  src/models/BadgeIssuer.ts
315
334
  src/models/Certificate.ts
@@ -332,6 +351,13 @@ src/models/CertificatePublic.ts
332
351
  src/models/CertificateRenewalPolicy.ts
333
352
  src/models/CertificateTemplate.ts
334
353
  src/models/CertificateTemplateVersion.ts
354
+ src/models/ChatDailyUsage.ts
355
+ src/models/ChatModelUsage.ts
356
+ src/models/ChatQuota.ts
357
+ src/models/ChatQuotaExceeded.ts
358
+ src/models/ChatTurnUsage.ts
359
+ src/models/ChatUsageTotals.ts
360
+ src/models/ChatUserIdentity.ts
335
361
  src/models/ContentLaunchMode.ts
336
362
  src/models/ContentLibraryVersionStatus.ts
337
363
  src/models/CourseCatalog.ts
@@ -351,6 +377,8 @@ src/models/GetCertificateTemplateList.ts
351
377
  src/models/GetChangelogEntry.ts
352
378
  src/models/GetChangelogList.ts
353
379
  src/models/GetChatMessage.ts
380
+ src/models/GetChatSettings.ts
381
+ src/models/GetChatUsage.ts
354
382
  src/models/GetContentLibraryVersion.ts
355
383
  src/models/GetConversation.ts
356
384
  src/models/GetConversationList.ts
@@ -393,6 +421,7 @@ src/models/GetLibraryQuizVersion.ts
393
421
  src/models/GetPermission.ts
394
422
  src/models/GetPortal.ts
395
423
  src/models/GetPortalFaviconUpload.ts
424
+ src/models/GetPortalInvitationSummary.ts
396
425
  src/models/GetPortalList.ts
397
426
  src/models/GetPortalLogoUpload.ts
398
427
  src/models/GetPortalUser.ts
@@ -530,6 +559,7 @@ src/models/PutBadgeIssuer.ts
530
559
  src/models/PutCertificateConfig.ts
531
560
  src/models/PutCertificateTemplate.ts
532
561
  src/models/PutCertificateTemplateDraft.ts
562
+ src/models/PutChatSettings.ts
533
563
  src/models/PutCourse.ts
534
564
  src/models/PutCourseCatalog.ts
535
565
  src/models/PutCourseEnrollment.ts
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- # @easyedu/js-lsm-api@1.103.0
1
+ # @easyedu/js-lsm-api@1.105.0
2
2
 
3
3
  A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
4
4
 
@@ -118,10 +118,16 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
118
118
  *CertificateTemplateApi* | [**putPlatformCertificateTemplateDraft**](docs/CertificateTemplateApi.md#putplatformcertificatetemplatedraft) | **PUT** /system/certificate-templates/{templateId}/draft | Update a platform certificate design draft
119
119
  *ChangelogApi* | [**getChangelog**](docs/ChangelogApi.md#getchangelog) | **GET** /changelog | List user-facing product updates
120
120
  *ChatApi* | [**deleteConversation**](docs/ChatApi.md#deleteconversation) | **DELETE** /chat/conversations/{conversationId} | Delete a conversation
121
+ *ChatApi* | [**getChatAdminConversation**](docs/ChatApi.md#getchatadminconversation) | **GET** /chat/admin/conversations/{conversationId} | Get a conversation transcript from the selected portal
122
+ *ChatApi* | [**getChatAdminConversations**](docs/ChatApi.md#getchatadminconversations) | **GET** /chat/admin/conversations | List conversations in the selected portal
123
+ *ChatApi* | [**getChatAdminSettings**](docs/ChatApi.md#getchatadminsettings) | **GET** /chat/admin/settings | Get chatbot settings for the selected portal
124
+ *ChatApi* | [**getChatAdminUsage**](docs/ChatApi.md#getchatadminusage) | **GET** /chat/admin/usage | Get chatbot usage analytics for the selected portal
125
+ *ChatApi* | [**getChatQuota**](docs/ChatApi.md#getchatquota) | **GET** /chat/quota | Get the current user\'s chat quota
121
126
  *ChatApi* | [**getConversationMessages**](docs/ChatApi.md#getconversationmessages) | **GET** /chat/conversations/{conversationId}/messages | Get all messages in a conversation
122
127
  *ChatApi* | [**getConversations**](docs/ChatApi.md#getconversations) | **GET** /chat/conversations | List conversations for the current user
123
128
  *ChatApi* | [**postConversation**](docs/ChatApi.md#postconversation) | **POST** /chat/conversations | Create a new conversation
124
129
  *ChatApi* | [**postMessage**](docs/ChatApi.md#postmessage) | **POST** /chat/conversations/{conversationId}/messages | Send a message to a conversation
130
+ *ChatApi* | [**putChatAdminSettings**](docs/ChatApi.md#putchatadminsettings) | **PUT** /chat/admin/settings | Update chatbot settings for the selected portal
125
131
  *ContentLibraryApi* | [**deleteResourceVersion**](docs/ContentLibraryApi.md#deleteresourceversion) | **DELETE** /content-library/resources/{resourceId}/versions/{versionId} | Discard an unreferenced draft resource version
126
132
  *ContentLibraryApi* | [**getContentLibraryItemList**](docs/ContentLibraryApi.md#getcontentlibraryitemlist) | **GET** /content-library/items | Search Content Library items
127
133
  *ContentLibraryApi* | [**getResource**](docs/ContentLibraryApi.md#getresource) | **GET** /content-library/resources/{resourceId} | Get a resource and all versions
@@ -256,6 +262,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
256
262
  *EmailTemplateApi* | [**putEmailTemplateDraft**](docs/EmailTemplateApi.md#putemailtemplatedraft) | **PUT** /email-templates/{templateKey}/draft | Update a portal email template draft
257
263
  *EmailTemplateApi* | [**putSystemEmailAssetFile**](docs/EmailTemplateApi.md#putsystememailassetfile) | **PUT** /system/email-assets/{assetId}/file | Upload a pending platform email image
258
264
  *EmailTemplateApi* | [**putSystemEmailTemplateDraft**](docs/EmailTemplateApi.md#putsystememailtemplatedraft) | **PUT** /system/email-templates/{templateKey}/draft | Update a platform email template draft
265
+ *EmailTemplateApi* | [**resendEmailDelivery**](docs/EmailTemplateApi.md#resendemaildelivery) | **POST** /email-deliveries/{deliveryId}/resend | Regenerate and queue a portal email from its current business source
259
266
  *OtherApi* | [**getHealth**](docs/OtherApi.md#gethealth) | **GET** /healthcheck | Health check endpoint
260
267
  *PlayerApi* | [**commitResourceScormSession**](docs/PlayerApi.md#commitresourcescormsession) | **POST** /resource/sessions/{sessionId}/commit | Commit a reusable SCORM resource session
261
268
  *PlayerApi* | [**getCourseVersionResourceAsset**](docs/PlayerApi.md#getcourseversionresourceasset) | **GET** /resource/course-versions/{courseVersionId}/items/{itemId}/asset/{assetPath} | Stream an asset from an exact course and resource version
@@ -351,6 +358,10 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
351
358
 
352
359
  ### Models
353
360
 
361
+ - [AdminChatMessage](docs/AdminChatMessage.md)
362
+ - [AdminConversationDetail](docs/AdminConversationDetail.md)
363
+ - [AdminConversationList](docs/AdminConversationList.md)
364
+ - [AdminConversationSummary](docs/AdminConversationSummary.md)
354
365
  - [ArtifactConflict](docs/ArtifactConflict.md)
355
366
  - [BadgeIssuer](docs/BadgeIssuer.md)
356
367
  - [Certificate](docs/Certificate.md)
@@ -373,6 +384,13 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
373
384
  - [CertificateRenewalPolicy](docs/CertificateRenewalPolicy.md)
374
385
  - [CertificateTemplate](docs/CertificateTemplate.md)
375
386
  - [CertificateTemplateVersion](docs/CertificateTemplateVersion.md)
387
+ - [ChatDailyUsage](docs/ChatDailyUsage.md)
388
+ - [ChatModelUsage](docs/ChatModelUsage.md)
389
+ - [ChatQuota](docs/ChatQuota.md)
390
+ - [ChatQuotaExceeded](docs/ChatQuotaExceeded.md)
391
+ - [ChatTurnUsage](docs/ChatTurnUsage.md)
392
+ - [ChatUsageTotals](docs/ChatUsageTotals.md)
393
+ - [ChatUserIdentity](docs/ChatUserIdentity.md)
376
394
  - [ContentLaunchMode](docs/ContentLaunchMode.md)
377
395
  - [ContentLibraryVersionStatus](docs/ContentLibraryVersionStatus.md)
378
396
  - [CourseCatalog](docs/CourseCatalog.md)
@@ -392,6 +410,8 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
392
410
  - [GetChangelogEntry](docs/GetChangelogEntry.md)
393
411
  - [GetChangelogList](docs/GetChangelogList.md)
394
412
  - [GetChatMessage](docs/GetChatMessage.md)
413
+ - [GetChatSettings](docs/GetChatSettings.md)
414
+ - [GetChatUsage](docs/GetChatUsage.md)
395
415
  - [GetContentLibraryVersion](docs/GetContentLibraryVersion.md)
396
416
  - [GetConversation](docs/GetConversation.md)
397
417
  - [GetConversationList](docs/GetConversationList.md)
@@ -434,6 +454,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
434
454
  - [GetPermission](docs/GetPermission.md)
435
455
  - [GetPortal](docs/GetPortal.md)
436
456
  - [GetPortalFaviconUpload](docs/GetPortalFaviconUpload.md)
457
+ - [GetPortalInvitationSummary](docs/GetPortalInvitationSummary.md)
437
458
  - [GetPortalList](docs/GetPortalList.md)
438
459
  - [GetPortalLogoUpload](docs/GetPortalLogoUpload.md)
439
460
  - [GetPortalUser](docs/GetPortalUser.md)
@@ -571,6 +592,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
571
592
  - [PutCertificateConfig](docs/PutCertificateConfig.md)
572
593
  - [PutCertificateTemplate](docs/PutCertificateTemplate.md)
573
594
  - [PutCertificateTemplateDraft](docs/PutCertificateTemplateDraft.md)
595
+ - [PutChatSettings](docs/PutChatSettings.md)
574
596
  - [PutCourse](docs/PutCourse.md)
575
597
  - [PutCourseCatalog](docs/PutCourseCatalog.md)
576
598
  - [PutCourseEnrollment](docs/PutCourseEnrollment.md)
@@ -625,7 +647,7 @@ and is automatically generated by the
625
647
  [OpenAPI Generator](https://openapi-generator.tech) project:
626
648
 
627
649
  - API version: `1.0.0`
628
- - Package version: `1.103.0`
650
+ - Package version: `1.105.0`
629
651
  - Generator version: `7.22.0`
630
652
  - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
631
653
 
@@ -10,15 +10,38 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
+ import { type AdminConversationDetail } from '../models/AdminConversationDetail';
14
+ import { type AdminConversationList } from '../models/AdminConversationList';
15
+ import { type ChatQuota } from '../models/ChatQuota';
13
16
  import { type GetChatMessage } from '../models/GetChatMessage';
17
+ import { type GetChatSettings } from '../models/GetChatSettings';
18
+ import { type GetChatUsage } from '../models/GetChatUsage';
14
19
  import { type GetConversationList } from '../models/GetConversationList';
15
20
  import { type PostConversation } from '../models/PostConversation';
16
21
  import { type PostConversationResponse } from '../models/PostConversationResponse';
17
22
  import { type PostMessage } from '../models/PostMessage';
18
23
  import { type PostMessageResponse } from '../models/PostMessageResponse';
24
+ import { type PutChatSettings } from '../models/PutChatSettings';
19
25
  export interface DeleteConversationRequest {
20
26
  conversationId: string;
21
27
  }
28
+ export interface GetChatAdminConversationRequest {
29
+ conversationId: string;
30
+ }
31
+ export interface GetChatAdminConversationsRequest {
32
+ page?: number;
33
+ pageSize?: number;
34
+ userId?: string;
35
+ model?: string;
36
+ createdFrom?: number;
37
+ createdTo?: number;
38
+ }
39
+ export interface GetChatAdminUsageRequest {
40
+ userId?: string;
41
+ model?: string;
42
+ from?: number;
43
+ to?: number;
44
+ }
22
45
  export interface GetConversationMessagesRequest {
23
46
  conversationId: string;
24
47
  }
@@ -33,6 +56,9 @@ export interface PostMessageRequest {
33
56
  conversationId: string;
34
57
  postMessage: PostMessage;
35
58
  }
59
+ export interface PutChatAdminSettingsRequest {
60
+ putChatSettings: PutChatSettings;
61
+ }
36
62
  /**
37
63
  *
38
64
  */
@@ -49,6 +75,66 @@ export declare class ChatApi extends runtime.BaseAPI {
49
75
  * Delete a conversation
50
76
  */
51
77
  deleteConversation(requestParameters: DeleteConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
78
+ /**
79
+ * Creates request options for getChatAdminConversation without sending the request
80
+ */
81
+ getChatAdminConversationRequestOpts(requestParameters: GetChatAdminConversationRequest): Promise<runtime.RequestOpts>;
82
+ /**
83
+ * Get a conversation transcript from the selected portal
84
+ */
85
+ getChatAdminConversationRaw(requestParameters: GetChatAdminConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConversationDetail>>;
86
+ /**
87
+ * Get a conversation transcript from the selected portal
88
+ */
89
+ getChatAdminConversation(requestParameters: GetChatAdminConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConversationDetail>;
90
+ /**
91
+ * Creates request options for getChatAdminConversations without sending the request
92
+ */
93
+ getChatAdminConversationsRequestOpts(requestParameters: GetChatAdminConversationsRequest): Promise<runtime.RequestOpts>;
94
+ /**
95
+ * List conversations in the selected portal
96
+ */
97
+ getChatAdminConversationsRaw(requestParameters: GetChatAdminConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<AdminConversationList>>;
98
+ /**
99
+ * List conversations in the selected portal
100
+ */
101
+ getChatAdminConversations(requestParameters?: GetChatAdminConversationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<AdminConversationList>;
102
+ /**
103
+ * Creates request options for getChatAdminSettings without sending the request
104
+ */
105
+ getChatAdminSettingsRequestOpts(): Promise<runtime.RequestOpts>;
106
+ /**
107
+ * Get chatbot settings for the selected portal
108
+ */
109
+ getChatAdminSettingsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChatSettings>>;
110
+ /**
111
+ * Get chatbot settings for the selected portal
112
+ */
113
+ getChatAdminSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChatSettings>;
114
+ /**
115
+ * Creates request options for getChatAdminUsage without sending the request
116
+ */
117
+ getChatAdminUsageRequestOpts(requestParameters: GetChatAdminUsageRequest): Promise<runtime.RequestOpts>;
118
+ /**
119
+ * Get chatbot usage analytics for the selected portal
120
+ */
121
+ getChatAdminUsageRaw(requestParameters: GetChatAdminUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChatUsage>>;
122
+ /**
123
+ * Get chatbot usage analytics for the selected portal
124
+ */
125
+ getChatAdminUsage(requestParameters?: GetChatAdminUsageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChatUsage>;
126
+ /**
127
+ * Creates request options for getChatQuota without sending the request
128
+ */
129
+ getChatQuotaRequestOpts(): Promise<runtime.RequestOpts>;
130
+ /**
131
+ * Get the current user\'s chat quota
132
+ */
133
+ getChatQuotaRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ChatQuota>>;
134
+ /**
135
+ * Get the current user\'s chat quota
136
+ */
137
+ getChatQuota(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ChatQuota>;
52
138
  /**
53
139
  * Creates request options for getConversationMessages without sending the request
54
140
  */
@@ -97,4 +183,16 @@ export declare class ChatApi extends runtime.BaseAPI {
97
183
  * Send a message to a conversation
98
184
  */
99
185
  postMessage(requestParameters: PostMessageRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PostMessageResponse>;
186
+ /**
187
+ * Creates request options for putChatAdminSettings without sending the request
188
+ */
189
+ putChatAdminSettingsRequestOpts(requestParameters: PutChatAdminSettingsRequest): Promise<runtime.RequestOpts>;
190
+ /**
191
+ * Update chatbot settings for the selected portal
192
+ */
193
+ putChatAdminSettingsRaw(requestParameters: PutChatAdminSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetChatSettings>>;
194
+ /**
195
+ * Update chatbot settings for the selected portal
196
+ */
197
+ putChatAdminSettings(requestParameters: PutChatAdminSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetChatSettings>;
100
198
  }
@@ -24,12 +24,18 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
24
24
  Object.defineProperty(exports, "__esModule", { value: true });
25
25
  exports.ChatApi = void 0;
26
26
  const runtime = require("../runtime");
27
+ const AdminConversationDetail_1 = require("../models/AdminConversationDetail");
28
+ const AdminConversationList_1 = require("../models/AdminConversationList");
29
+ const ChatQuota_1 = require("../models/ChatQuota");
27
30
  const GetChatMessage_1 = require("../models/GetChatMessage");
31
+ const GetChatSettings_1 = require("../models/GetChatSettings");
32
+ const GetChatUsage_1 = require("../models/GetChatUsage");
28
33
  const GetConversationList_1 = require("../models/GetConversationList");
29
34
  const PostConversation_1 = require("../models/PostConversation");
30
35
  const PostConversationResponse_1 = require("../models/PostConversationResponse");
31
36
  const PostMessage_1 = require("../models/PostMessage");
32
37
  const PostMessageResponse_1 = require("../models/PostMessageResponse");
38
+ const PutChatSettings_1 = require("../models/PutChatSettings");
33
39
  /**
34
40
  *
35
41
  */
@@ -72,6 +78,215 @@ class ChatApi extends runtime.BaseAPI {
72
78
  yield this.deleteConversationRaw(requestParameters, initOverrides);
73
79
  });
74
80
  }
81
+ /**
82
+ * Creates request options for getChatAdminConversation without sending the request
83
+ */
84
+ getChatAdminConversationRequestOpts(requestParameters) {
85
+ return __awaiter(this, void 0, void 0, function* () {
86
+ if (requestParameters['conversationId'] == null) {
87
+ throw new runtime.RequiredError('conversationId', 'Required parameter "conversationId" was null or undefined when calling getChatAdminConversation().');
88
+ }
89
+ const queryParameters = {};
90
+ const headerParameters = {};
91
+ let urlPath = `/chat/admin/conversations/{conversationId}`;
92
+ urlPath = urlPath.replace('{conversationId}', encodeURIComponent(String(requestParameters['conversationId'])));
93
+ return {
94
+ path: urlPath,
95
+ method: 'GET',
96
+ headers: headerParameters,
97
+ query: queryParameters,
98
+ };
99
+ });
100
+ }
101
+ /**
102
+ * Get a conversation transcript from the selected portal
103
+ */
104
+ getChatAdminConversationRaw(requestParameters, initOverrides) {
105
+ return __awaiter(this, void 0, void 0, function* () {
106
+ const requestOptions = yield this.getChatAdminConversationRequestOpts(requestParameters);
107
+ const response = yield this.request(requestOptions, initOverrides);
108
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, AdminConversationDetail_1.AdminConversationDetailFromJSON)(jsonValue));
109
+ });
110
+ }
111
+ /**
112
+ * Get a conversation transcript from the selected portal
113
+ */
114
+ getChatAdminConversation(requestParameters, initOverrides) {
115
+ return __awaiter(this, void 0, void 0, function* () {
116
+ const response = yield this.getChatAdminConversationRaw(requestParameters, initOverrides);
117
+ return yield response.value();
118
+ });
119
+ }
120
+ /**
121
+ * Creates request options for getChatAdminConversations without sending the request
122
+ */
123
+ getChatAdminConversationsRequestOpts(requestParameters) {
124
+ return __awaiter(this, void 0, void 0, function* () {
125
+ const queryParameters = {};
126
+ if (requestParameters['page'] != null) {
127
+ queryParameters['page'] = requestParameters['page'];
128
+ }
129
+ if (requestParameters['pageSize'] != null) {
130
+ queryParameters['pageSize'] = requestParameters['pageSize'];
131
+ }
132
+ if (requestParameters['userId'] != null) {
133
+ queryParameters['userId'] = requestParameters['userId'];
134
+ }
135
+ if (requestParameters['model'] != null) {
136
+ queryParameters['model'] = requestParameters['model'];
137
+ }
138
+ if (requestParameters['createdFrom'] != null) {
139
+ queryParameters['createdFrom'] = requestParameters['createdFrom'];
140
+ }
141
+ if (requestParameters['createdTo'] != null) {
142
+ queryParameters['createdTo'] = requestParameters['createdTo'];
143
+ }
144
+ const headerParameters = {};
145
+ let urlPath = `/chat/admin/conversations`;
146
+ return {
147
+ path: urlPath,
148
+ method: 'GET',
149
+ headers: headerParameters,
150
+ query: queryParameters,
151
+ };
152
+ });
153
+ }
154
+ /**
155
+ * List conversations in the selected portal
156
+ */
157
+ getChatAdminConversationsRaw(requestParameters, initOverrides) {
158
+ return __awaiter(this, void 0, void 0, function* () {
159
+ const requestOptions = yield this.getChatAdminConversationsRequestOpts(requestParameters);
160
+ const response = yield this.request(requestOptions, initOverrides);
161
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, AdminConversationList_1.AdminConversationListFromJSON)(jsonValue));
162
+ });
163
+ }
164
+ /**
165
+ * List conversations in the selected portal
166
+ */
167
+ getChatAdminConversations() {
168
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
169
+ const response = yield this.getChatAdminConversationsRaw(requestParameters, initOverrides);
170
+ return yield response.value();
171
+ });
172
+ }
173
+ /**
174
+ * Creates request options for getChatAdminSettings without sending the request
175
+ */
176
+ getChatAdminSettingsRequestOpts() {
177
+ return __awaiter(this, void 0, void 0, function* () {
178
+ const queryParameters = {};
179
+ const headerParameters = {};
180
+ let urlPath = `/chat/admin/settings`;
181
+ return {
182
+ path: urlPath,
183
+ method: 'GET',
184
+ headers: headerParameters,
185
+ query: queryParameters,
186
+ };
187
+ });
188
+ }
189
+ /**
190
+ * Get chatbot settings for the selected portal
191
+ */
192
+ getChatAdminSettingsRaw(initOverrides) {
193
+ return __awaiter(this, void 0, void 0, function* () {
194
+ const requestOptions = yield this.getChatAdminSettingsRequestOpts();
195
+ const response = yield this.request(requestOptions, initOverrides);
196
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetChatSettings_1.GetChatSettingsFromJSON)(jsonValue));
197
+ });
198
+ }
199
+ /**
200
+ * Get chatbot settings for the selected portal
201
+ */
202
+ getChatAdminSettings(initOverrides) {
203
+ return __awaiter(this, void 0, void 0, function* () {
204
+ const response = yield this.getChatAdminSettingsRaw(initOverrides);
205
+ return yield response.value();
206
+ });
207
+ }
208
+ /**
209
+ * Creates request options for getChatAdminUsage without sending the request
210
+ */
211
+ getChatAdminUsageRequestOpts(requestParameters) {
212
+ return __awaiter(this, void 0, void 0, function* () {
213
+ const queryParameters = {};
214
+ if (requestParameters['userId'] != null) {
215
+ queryParameters['userId'] = requestParameters['userId'];
216
+ }
217
+ if (requestParameters['model'] != null) {
218
+ queryParameters['model'] = requestParameters['model'];
219
+ }
220
+ if (requestParameters['from'] != null) {
221
+ queryParameters['from'] = requestParameters['from'];
222
+ }
223
+ if (requestParameters['to'] != null) {
224
+ queryParameters['to'] = requestParameters['to'];
225
+ }
226
+ const headerParameters = {};
227
+ let urlPath = `/chat/admin/usage`;
228
+ return {
229
+ path: urlPath,
230
+ method: 'GET',
231
+ headers: headerParameters,
232
+ query: queryParameters,
233
+ };
234
+ });
235
+ }
236
+ /**
237
+ * Get chatbot usage analytics for the selected portal
238
+ */
239
+ getChatAdminUsageRaw(requestParameters, initOverrides) {
240
+ return __awaiter(this, void 0, void 0, function* () {
241
+ const requestOptions = yield this.getChatAdminUsageRequestOpts(requestParameters);
242
+ const response = yield this.request(requestOptions, initOverrides);
243
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetChatUsage_1.GetChatUsageFromJSON)(jsonValue));
244
+ });
245
+ }
246
+ /**
247
+ * Get chatbot usage analytics for the selected portal
248
+ */
249
+ getChatAdminUsage() {
250
+ return __awaiter(this, arguments, void 0, function* (requestParameters = {}, initOverrides) {
251
+ const response = yield this.getChatAdminUsageRaw(requestParameters, initOverrides);
252
+ return yield response.value();
253
+ });
254
+ }
255
+ /**
256
+ * Creates request options for getChatQuota without sending the request
257
+ */
258
+ getChatQuotaRequestOpts() {
259
+ return __awaiter(this, void 0, void 0, function* () {
260
+ const queryParameters = {};
261
+ const headerParameters = {};
262
+ let urlPath = `/chat/quota`;
263
+ return {
264
+ path: urlPath,
265
+ method: 'GET',
266
+ headers: headerParameters,
267
+ query: queryParameters,
268
+ };
269
+ });
270
+ }
271
+ /**
272
+ * Get the current user\'s chat quota
273
+ */
274
+ getChatQuotaRaw(initOverrides) {
275
+ return __awaiter(this, void 0, void 0, function* () {
276
+ const requestOptions = yield this.getChatQuotaRequestOpts();
277
+ const response = yield this.request(requestOptions, initOverrides);
278
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, ChatQuota_1.ChatQuotaFromJSON)(jsonValue));
279
+ });
280
+ }
281
+ /**
282
+ * Get the current user\'s chat quota
283
+ */
284
+ getChatQuota(initOverrides) {
285
+ return __awaiter(this, void 0, void 0, function* () {
286
+ const response = yield this.getChatQuotaRaw(initOverrides);
287
+ return yield response.value();
288
+ });
289
+ }
75
290
  /**
76
291
  * Creates request options for getConversationMessages without sending the request
77
292
  */
@@ -236,5 +451,45 @@ class ChatApi extends runtime.BaseAPI {
236
451
  return yield response.value();
237
452
  });
238
453
  }
454
+ /**
455
+ * Creates request options for putChatAdminSettings without sending the request
456
+ */
457
+ putChatAdminSettingsRequestOpts(requestParameters) {
458
+ return __awaiter(this, void 0, void 0, function* () {
459
+ if (requestParameters['putChatSettings'] == null) {
460
+ throw new runtime.RequiredError('putChatSettings', 'Required parameter "putChatSettings" was null or undefined when calling putChatAdminSettings().');
461
+ }
462
+ const queryParameters = {};
463
+ const headerParameters = {};
464
+ headerParameters['Content-Type'] = 'application/json';
465
+ let urlPath = `/chat/admin/settings`;
466
+ return {
467
+ path: urlPath,
468
+ method: 'PUT',
469
+ headers: headerParameters,
470
+ query: queryParameters,
471
+ body: (0, PutChatSettings_1.PutChatSettingsToJSON)(requestParameters['putChatSettings']),
472
+ };
473
+ });
474
+ }
475
+ /**
476
+ * Update chatbot settings for the selected portal
477
+ */
478
+ putChatAdminSettingsRaw(requestParameters, initOverrides) {
479
+ return __awaiter(this, void 0, void 0, function* () {
480
+ const requestOptions = yield this.putChatAdminSettingsRequestOpts(requestParameters);
481
+ const response = yield this.request(requestOptions, initOverrides);
482
+ return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetChatSettings_1.GetChatSettingsFromJSON)(jsonValue));
483
+ });
484
+ }
485
+ /**
486
+ * Update chatbot settings for the selected portal
487
+ */
488
+ putChatAdminSettings(requestParameters, initOverrides) {
489
+ return __awaiter(this, void 0, void 0, function* () {
490
+ const response = yield this.putChatAdminSettingsRaw(requestParameters, initOverrides);
491
+ return yield response.value();
492
+ });
493
+ }
239
494
  }
240
495
  exports.ChatApi = ChatApi;
@@ -31,6 +31,10 @@ export interface DeleteSystemEmailTemplateDraftRequest {
31
31
  export interface GetEmailDeliveryListRequest {
32
32
  page?: number;
33
33
  pageSize?: number;
34
+ templateKey?: string;
35
+ status?: GetEmailDeliveryListStatusEnum;
36
+ recipient?: string;
37
+ isTest?: boolean;
34
38
  }
35
39
  export interface GetEmailTemplateRequest {
36
40
  templateKey: string;
@@ -125,6 +129,9 @@ export interface PutSystemEmailTemplateDraftRequest {
125
129
  templateKey: string;
126
130
  putEmailTemplateDraft: PutEmailTemplateDraft;
127
131
  }
132
+ export interface ResendEmailDeliveryRequest {
133
+ deliveryId: string;
134
+ }
128
135
  /**
129
136
  *
130
137
  */
@@ -501,4 +508,29 @@ export declare class EmailTemplateApi extends runtime.BaseAPI {
501
508
  * Update a platform email template draft
502
509
  */
503
510
  putSystemEmailTemplateDraft(requestParameters: PutSystemEmailTemplateDraftRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailTemplateVersion>;
511
+ /**
512
+ * Creates request options for resendEmailDelivery without sending the request
513
+ */
514
+ resendEmailDeliveryRequestOpts(requestParameters: ResendEmailDeliveryRequest): Promise<runtime.RequestOpts>;
515
+ /**
516
+ * Regenerate and queue a portal email from its current business source
517
+ */
518
+ resendEmailDeliveryRaw(requestParameters: ResendEmailDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEmailDelivery>>;
519
+ /**
520
+ * Regenerate and queue a portal email from its current business source
521
+ */
522
+ resendEmailDelivery(requestParameters: ResendEmailDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEmailDelivery>;
504
523
  }
524
+ /**
525
+ * @export
526
+ */
527
+ export declare const GetEmailDeliveryListStatusEnum: {
528
+ readonly Queued: "queued";
529
+ readonly Processing: "processing";
530
+ readonly Accepted: "accepted";
531
+ readonly Delivered: "delivered";
532
+ readonly Deferred: "deferred";
533
+ readonly Failed: "failed";
534
+ readonly Complained: "complained";
535
+ };
536
+ export type GetEmailDeliveryListStatusEnum = typeof GetEmailDeliveryListStatusEnum[keyof typeof GetEmailDeliveryListStatusEnum];