@wildix/wilma-copilot-client 1.0.19 → 1.0.20

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 (20) hide show
  1. package/dist-cjs/models/enums.js +22 -7
  2. package/dist-cjs/schemas/schemas_0.js +57 -59
  3. package/dist-es/models/enums.js +21 -6
  4. package/dist-es/schemas/schemas_0.js +54 -56
  5. package/dist-types/commands/AttachProfileResourceCommand.d.ts +14 -10
  6. package/dist-types/commands/CreateIntentCommand.d.ts +2 -4
  7. package/dist-types/commands/CreateProfileCommand.d.ts +28 -20
  8. package/dist-types/commands/DeleteProfileResourceCommand.d.ts +14 -10
  9. package/dist-types/commands/GetIntentCommand.d.ts +1 -2
  10. package/dist-types/commands/GetProfileCommand.d.ts +14 -10
  11. package/dist-types/commands/GetProfileVersionCommand.d.ts +17 -16
  12. package/dist-types/commands/ListProfilesCommand.d.ts +16 -2
  13. package/dist-types/commands/PublishProfileVersionCommand.d.ts +17 -16
  14. package/dist-types/commands/RestoreProfileVersionToDraftCommand.d.ts +14 -10
  15. package/dist-types/commands/UpdateIntentCommand.d.ts +2 -4
  16. package/dist-types/commands/UpdateProfileCommand.d.ts +28 -20
  17. package/dist-types/models/enums.d.ts +40 -9
  18. package/dist-types/models/models_0.d.ts +144 -79
  19. package/dist-types/schemas/schemas_0.d.ts +1 -2
  20. package/package.json +1 -1
package/dist-types/commands/PublishProfileVersionCommand.d.ts CHANGED
@@ -52,17 +52,21 @@ declare const PublishProfileVersionCommand_base: {
52
52
  * // definition: { // ProfileDefinitionSnapshot
53
53
  * // name: "STRING_VALUE", // required
54
54
  * // description: "STRING_VALUE",
55
- * // channel: "calls" || "chats" || "any", // required
55
+ * // audience: [ // CopilotAudienceList
56
+ * // { // CopilotAudienceEntry
57
+ * // kind: "user" || "group" || "department" || "agent" || "queue" || "service" || "trunk", // required
58
+ * // values: [ // StringList // required
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // },
62
+ * // ],
63
+ * // stages: [ // CopilotStageList
64
+ * // "before" || "during" || "after",
65
+ * // ],
66
+ * // channels: [ // CopilotChannelList
67
+ * // "call" || "conference" || "chat",
68
+ * // ],
56
69
  * // conditions: "DOCUMENT_VALUE",
57
- * // access: { // CopilotAccess
58
- * // visibility: "explicit" || "organization",
59
- * // grants: [ // CopilotGrantPrincipalList
60
- * // { // CopilotGrantPrincipal Union: only one key present
61
- * // userId: "STRING_VALUE",
62
- * // groupId: "STRING_VALUE",
63
- * // },
64
- * // ],
65
- * // },
66
70
  * // features: [ // CopilotFeaturesList
67
71
  * // { // CopilotFeature Union: only one key present
68
72
  * // csat: {},
@@ -85,7 +89,6 @@ declare const PublishProfileVersionCommand_base: {
85
89
  * // description: "STRING_VALUE",
86
90
  * // handlers: { // IntentHandlers
87
91
  * // textMatch: { // IntentTextMatch
88
- * // enabled: true || false, // required
89
92
  * // options: [ // IntentTextMatchOptionsList
90
93
  * // { // IntentTextMatchOption
91
94
  * // id: "STRING_VALUE", // required
@@ -95,7 +98,6 @@ declare const PublishProfileVersionCommand_base: {
95
98
  * // ],
96
99
  * // },
97
100
  * // aiMatch: { // IntentAiMatch
98
- * // enabled: true || false, // required
99
101
  * // instructions: "STRING_VALUE",
100
102
  * // fields: [ // CopilotFieldsList
101
103
  * // { // CopilotField
@@ -105,7 +107,7 @@ declare const PublishProfileVersionCommand_base: {
105
107
  * // optional: true || false,
106
108
  * // parameter: { // CopilotFieldParameter Union: only one key present
107
109
  * // text: { // CopilotTextParameter
108
- * // examples: [ // StringList
110
+ * // examples: [
109
111
  * // "STRING_VALUE",
110
112
  * // ],
111
113
  * // },
@@ -132,6 +134,7 @@ declare const PublishProfileVersionCommand_base: {
132
134
  * // },
133
135
  * // ],
134
136
  * // },
137
+ * // saidBy: "anyone" || "agent" || "customer",
135
138
  * // },
136
139
  * // conditions: "DOCUMENT_VALUE",
137
140
  * // id: "STRING_VALUE", // required
@@ -150,9 +153,7 @@ declare const PublishProfileVersionCommand_base: {
150
153
  * // optional: true || false,
151
154
  * // parameter: {// Union: only one key present
152
155
  * // text: {
153
- * // examples: [
154
- * // "STRING_VALUE",
155
- * // ],
156
+ * // examples: "<StringList>",
156
157
  * // },
157
158
  * // multiline: {
158
159
  * // examples: "<StringList>",
package/dist-types/commands/RestoreProfileVersionToDraftCommand.d.ts CHANGED
@@ -48,17 +48,21 @@ declare const RestoreProfileVersionToDraftCommand_base: {
48
48
  * // profile: { // Profile
49
49
  * // name: "STRING_VALUE", // required
50
50
  * // description: "STRING_VALUE",
51
- * // channel: "calls" || "chats" || "any", // required
51
+ * // audience: [ // CopilotAudienceList
52
+ * // { // CopilotAudienceEntry
53
+ * // kind: "user" || "group" || "department" || "agent" || "queue" || "service" || "trunk", // required
54
+ * // values: [ // StringList // required
55
+ * // "STRING_VALUE",
56
+ * // ],
57
+ * // },
58
+ * // ],
59
+ * // stages: [ // CopilotStageList
60
+ * // "before" || "during" || "after",
61
+ * // ],
62
+ * // channels: [ // CopilotChannelList
63
+ * // "call" || "conference" || "chat",
64
+ * // ],
52
65
  * // conditions: "DOCUMENT_VALUE",
53
- * // access: { // CopilotAccess
54
- * // visibility: "explicit" || "organization",
55
- * // grants: [ // CopilotGrantPrincipalList
56
- * // { // CopilotGrantPrincipal Union: only one key present
57
- * // userId: "STRING_VALUE",
58
- * // groupId: "STRING_VALUE",
59
- * // },
60
- * // ],
61
- * // },
62
66
  * // features: [ // CopilotFeaturesList
63
67
  * // { // CopilotFeature Union: only one key present
64
68
  * // csat: {},
package/dist-types/commands/UpdateIntentCommand.d.ts CHANGED
@@ -41,7 +41,6 @@ declare const UpdateIntentCommand_base: {
41
41
  * description: "STRING_VALUE",
42
42
  * handlers: { // IntentHandlers
43
43
  * textMatch: { // IntentTextMatch
44
- * enabled: true || false, // required
45
44
  * options: [ // IntentTextMatchOptionsList
46
45
  * { // IntentTextMatchOption
47
46
  * id: "STRING_VALUE", // required
@@ -51,7 +50,6 @@ declare const UpdateIntentCommand_base: {
51
50
  * ],
52
51
  * },
53
52
  * aiMatch: { // IntentAiMatch
54
- * enabled: true || false, // required
55
53
  * instructions: "STRING_VALUE",
56
54
  * fields: [ // CopilotFieldsList
57
55
  * { // CopilotField
@@ -88,6 +86,7 @@ declare const UpdateIntentCommand_base: {
88
86
  * },
89
87
  * ],
90
88
  * },
89
+ * saidBy: "anyone" || "agent" || "customer",
91
90
  * },
92
91
  * conditions: "DOCUMENT_VALUE",
93
92
  * company: "STRING_VALUE",
@@ -102,7 +101,6 @@ declare const UpdateIntentCommand_base: {
102
101
  * // description: "STRING_VALUE",
103
102
  * // handlers: { // IntentHandlers
104
103
  * // textMatch: { // IntentTextMatch
105
- * // enabled: true || false, // required
106
104
  * // options: [ // IntentTextMatchOptionsList
107
105
  * // { // IntentTextMatchOption
108
106
  * // id: "STRING_VALUE", // required
@@ -112,7 +110,6 @@ declare const UpdateIntentCommand_base: {
112
110
  * // ],
113
111
  * // },
114
112
  * // aiMatch: { // IntentAiMatch
115
- * // enabled: true || false, // required
116
113
  * // instructions: "STRING_VALUE",
117
114
  * // fields: [ // CopilotFieldsList
118
115
  * // { // CopilotField
@@ -149,6 +146,7 @@ declare const UpdateIntentCommand_base: {
149
146
  * // },
150
147
  * // ],
151
148
  * // },
149
+ * // saidBy: "anyone" || "agent" || "customer",
152
150
  * // },
153
151
  * // conditions: "DOCUMENT_VALUE",
154
152
  * // createdAt: "STRING_VALUE", // required
package/dist-types/commands/UpdateProfileCommand.d.ts CHANGED
@@ -39,17 +39,21 @@ declare const UpdateProfileCommand_base: {
39
39
  * const input = { // UpdateProfileInput
40
40
  * name: "STRING_VALUE", // required
41
41
  * description: "STRING_VALUE",
42
- * channel: "calls" || "chats" || "any", // required
42
+ * audience: [ // CopilotAudienceList
43
+ * { // CopilotAudienceEntry
44
+ * kind: "user" || "group" || "department" || "agent" || "queue" || "service" || "trunk", // required
45
+ * values: [ // StringList // required
46
+ * "STRING_VALUE",
47
+ * ],
48
+ * },
49
+ * ],
50
+ * stages: [ // CopilotStageList
51
+ * "before" || "during" || "after",
52
+ * ],
53
+ * channels: [ // CopilotChannelList
54
+ * "call" || "conference" || "chat",
55
+ * ],
43
56
  * conditions: "DOCUMENT_VALUE",
44
- * access: { // CopilotAccess
45
- * visibility: "explicit" || "organization",
46
- * grants: [ // CopilotGrantPrincipalList
47
- * { // CopilotGrantPrincipal Union: only one key present
48
- * userId: "STRING_VALUE",
49
- * groupId: "STRING_VALUE",
50
- * },
51
- * ],
52
- * },
53
57
  * company: "STRING_VALUE",
54
58
  * profileId: "STRING_VALUE", // required
55
59
  * revision: Number("int"), // required
@@ -60,17 +64,21 @@ declare const UpdateProfileCommand_base: {
60
64
  * // profile: { // Profile
61
65
  * // name: "STRING_VALUE", // required
62
66
  * // description: "STRING_VALUE",
63
- * // channel: "calls" || "chats" || "any", // required
67
+ * // audience: [ // CopilotAudienceList
68
+ * // { // CopilotAudienceEntry
69
+ * // kind: "user" || "group" || "department" || "agent" || "queue" || "service" || "trunk", // required
70
+ * // values: [ // StringList // required
71
+ * // "STRING_VALUE",
72
+ * // ],
73
+ * // },
74
+ * // ],
75
+ * // stages: [ // CopilotStageList
76
+ * // "before" || "during" || "after",
77
+ * // ],
78
+ * // channels: [ // CopilotChannelList
79
+ * // "call" || "conference" || "chat",
80
+ * // ],
64
81
  * // conditions: "DOCUMENT_VALUE",
65
- * // access: { // CopilotAccess
66
- * // visibility: "explicit" || "organization",
67
- * // grants: [ // CopilotGrantPrincipalList
68
- * // { // CopilotGrantPrincipal Union: only one key present
69
- * // userId: "STRING_VALUE",
70
- * // groupId: "STRING_VALUE",
71
- * // },
72
- * // ],
73
- * // },
74
82
  * // features: [ // CopilotFeaturesList
75
83
  * // { // CopilotFeature Union: only one key present
76
84
  * // csat: {},
package/dist-types/models/enums.d.ts CHANGED
@@ -153,33 +153,51 @@ export type ContextualKnowledgeSource = (typeof ContextualKnowledgeSource)[keyof
153
153
  * @public
154
154
  * @enum
155
155
  */
156
- export declare const CopilotVisibility: {
156
+ export declare const CopilotAudienceKind: {
157
157
  /**
158
- * Only the users and groups listed in `grants` are assisted by the profile.
158
+ * A Wilma AI agent handling the conversation itself, by `wildix.wilma.agents#AgentId`.
159
159
  */
160
- readonly EXPLICIT: "explicit";
160
+ readonly AGENT: "agent";
161
+ readonly DEPARTMENT: "department";
162
+ readonly GROUP: "group";
163
+ readonly QUEUE: "queue";
164
+ readonly SERVICE: "service";
165
+ readonly TRUNK: "trunk";
161
166
  /**
162
- * Everyone in the organization is assisted by the profile.
167
+ * A person, by email.
163
168
  */
164
- readonly ORGANIZATION: "organization";
169
+ readonly USER: "user";
165
170
  };
166
171
  /**
167
172
  * @public
168
173
  */
169
- export type CopilotVisibility = (typeof CopilotVisibility)[keyof typeof CopilotVisibility];
174
+ export type CopilotAudienceKind = (typeof CopilotAudienceKind)[keyof typeof CopilotAudienceKind];
170
175
  /**
171
176
  * @public
172
177
  * @enum
173
178
  */
174
179
  export declare const CopilotChannel: {
175
- readonly ANY: "any";
176
- readonly CALLS: "calls";
177
- readonly CHATS: "chats";
180
+ readonly CALL: "call";
181
+ readonly CHAT: "chat";
182
+ readonly CONFERENCE: "conference";
178
183
  };
179
184
  /**
180
185
  * @public
181
186
  */
182
187
  export type CopilotChannel = (typeof CopilotChannel)[keyof typeof CopilotChannel];
188
+ /**
189
+ * @public
190
+ * @enum
191
+ */
192
+ export declare const CopilotStage: {
193
+ readonly AFTER: "after";
194
+ readonly BEFORE: "before";
195
+ readonly DURING: "during";
196
+ };
197
+ /**
198
+ * @public
199
+ */
200
+ export type CopilotStage = (typeof CopilotStage)[keyof typeof CopilotStage];
183
201
  /**
184
202
  * @public
185
203
  * @enum
@@ -198,6 +216,19 @@ export declare const ProfileStatus: {
198
216
  * @public
199
217
  */
200
218
  export type ProfileStatus = (typeof ProfileStatus)[keyof typeof ProfileStatus];
219
+ /**
220
+ * @public
221
+ * @enum
222
+ */
223
+ export declare const CopilotSpeaker: {
224
+ readonly AGENT: "agent";
225
+ readonly ANYONE: "anyone";
226
+ readonly CUSTOMER: "customer";
227
+ };
228
+ /**
229
+ * @public
230
+ */
231
+ export type CopilotSpeaker = (typeof CopilotSpeaker)[keyof typeof CopilotSpeaker];
201
232
  /**
202
233
  * @public
203
234
  * @enum