@wildix/wilma-agents-client 1.0.22 → 1.0.25

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.
@@ -217,6 +217,7 @@ const _dict = "dictionary";
217
217
  const _e = "error";
218
218
  const _eA = "expiresAt";
219
219
  const _eC = "endCall";
220
+ const _eUA = "expectedUpdatedAt";
220
221
  const _en = "engine";
221
222
  const _ena = "enabled";
222
223
  const _enc = "encoding";
@@ -750,13 +751,13 @@ exports.ListAgentVersionsOutput$ = [3, n2, _LAVO,
750
751
  ];
751
752
  exports.ListPronunciationDictionariesInput$ = [3, n2, _LPDI,
752
753
  0,
753
- [_com],
754
- [[0, { [_hQ]: _com }]]
754
+ [_com, _l, _cu],
755
+ [[0, { [_hQ]: _com }], [1, { [_hQ]: _l }], [0, { [_hQ]: _cu }]]
755
756
  ];
756
757
  exports.ListPronunciationDictionariesOutput$ = [3, n2, _LPDO,
757
758
  0,
758
- [_dic],
759
- [() => PronunciationDictionaryList], 1
759
+ [_dic, _nC],
760
+ [() => PronunciationDictionaryList, 0], 1
760
761
  ];
761
762
  exports.PronunciationDictionary$ = [3, n2, _PD,
762
763
  0,
@@ -785,8 +786,8 @@ exports.PutAgentDeploymentOutput$ = [3, n2, _PADO,
785
786
  ];
786
787
  exports.PutPronunciationDictionaryInput$ = [3, n2, _PPDI,
787
788
  0,
788
- [_cod, _ru, _com],
789
- [[0, 1], () => VoicePronunciationList, [0, { [_hQ]: _com }]], 2
789
+ [_cod, _ru, _com, _eUA],
790
+ [[0, 1], () => VoicePronunciationList, [0, { [_hQ]: _com }], 0], 2
790
791
  ];
791
792
  exports.PutPronunciationDictionaryOutput$ = [3, n2, _PPDO,
792
793
  0,
@@ -881,7 +882,7 @@ exports.VoiceTerminateHangupAction$ = [3, n2, _VTHA,
881
882
  exports.VoiceTranscriptionSettings$ = [3, n2, _VTS,
882
883
  0,
883
884
  [_ven],
884
- [0], 1
885
+ [0]
885
886
  ];
886
887
  exports.VoiceTransferTarget$ = [3, n2, _VTT,
887
888
  0,
@@ -212,6 +212,7 @@ const _dict = "dictionary";
212
212
  const _e = "error";
213
213
  const _eA = "expiresAt";
214
214
  const _eC = "endCall";
215
+ const _eUA = "expectedUpdatedAt";
215
216
  const _en = "engine";
216
217
  const _ena = "enabled";
217
218
  const _enc = "encoding";
@@ -745,13 +746,13 @@ export var ListAgentVersionsOutput$ = [3, n2, _LAVO,
745
746
  ];
746
747
  export var ListPronunciationDictionariesInput$ = [3, n2, _LPDI,
747
748
  0,
748
- [_com],
749
- [[0, { [_hQ]: _com }]]
749
+ [_com, _l, _cu],
750
+ [[0, { [_hQ]: _com }], [1, { [_hQ]: _l }], [0, { [_hQ]: _cu }]]
750
751
  ];
751
752
  export var ListPronunciationDictionariesOutput$ = [3, n2, _LPDO,
752
753
  0,
753
- [_dic],
754
- [() => PronunciationDictionaryList], 1
754
+ [_dic, _nC],
755
+ [() => PronunciationDictionaryList, 0], 1
755
756
  ];
756
757
  export var PronunciationDictionary$ = [3, n2, _PD,
757
758
  0,
@@ -780,8 +781,8 @@ export var PutAgentDeploymentOutput$ = [3, n2, _PADO,
780
781
  ];
781
782
  export var PutPronunciationDictionaryInput$ = [3, n2, _PPDI,
782
783
  0,
783
- [_cod, _ru, _com],
784
- [[0, 1], () => VoicePronunciationList, [0, { [_hQ]: _com }]], 2
784
+ [_cod, _ru, _com, _eUA],
785
+ [[0, 1], () => VoicePronunciationList, [0, { [_hQ]: _com }], 0], 2
785
786
  ];
786
787
  export var PutPronunciationDictionaryOutput$ = [3, n2, _PPDO,
787
788
  0,
@@ -876,7 +877,7 @@ export var VoiceTerminateHangupAction$ = [3, n2, _VTHA,
876
877
  export var VoiceTranscriptionSettings$ = [3, n2, _VTS,
877
878
  0,
878
879
  [_ven],
879
- [0], 1
880
+ [0]
880
881
  ];
881
882
  export var VoiceTransferTarget$ = [3, n2, _VTT,
882
883
  0,
@@ -83,7 +83,7 @@ declare const CreateAgentCommand_base: {
83
83
  * autoDetect: true || false,
84
84
  * greetEveryLanguage: true || false,
85
85
  * transcription: { // VoiceTranscriptionSettings
86
- * vendor: "aws", // required
86
+ * vendor: "aws",
87
87
  * },
88
88
  * synthesis: {
89
89
  * model: "STRING_VALUE",
@@ -484,7 +484,7 @@ declare const CreateAgentCommand_base: {
484
484
  * // autoDetect: true || false,
485
485
  * // greetEveryLanguage: true || false,
486
486
  * // transcription: { // VoiceTranscriptionSettings
487
- * // vendor: "aws", // required
487
+ * // vendor: "aws",
488
488
  * // },
489
489
  * // synthesis: {
490
490
  * // model: "STRING_VALUE",
@@ -29,6 +29,12 @@ declare const DeletePronunciationDictionaryCommand_base: {
29
29
  /**
30
30
  * Deletes the dictionary for one language. Agents keep their own rules, and their suppressions
31
31
  * become no-ops rather than errors — the two are edited independently.
32
+ *
33
+ * A LANGUAGE WITH NO DICTIONARY IS A SUCCESS, not a NotFoundException. The operation is
34
+ * @idempotent, which is a promise that a retry is safe, and a retried DELETE — the ordinary
35
+ * outcome of a timed-out response — would otherwise report failure for a row it had already
36
+ * removed. The output is empty either way, so there is nothing a caller could do with the
37
+ * distinction; it says the same thing the paragraph above says about suppressions.
32
38
  * @example
33
39
  * Use a bare-bones client and the command you need to make an API call.
34
40
  * ```javascript
@@ -53,8 +59,6 @@ declare const DeletePronunciationDictionaryCommand_base: {
53
59
  * @see {@link DeletePronunciationDictionaryCommandOutput} for command's `response` shape.
54
60
  * @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
55
61
  *
56
- * @throws {@link NotFoundException} (client fault)
57
- *
58
62
  * @throws {@link ValidationException} (client fault)
59
63
  *
60
64
  * @throws {@link WilmaAgentsServiceException}
@@ -90,7 +90,7 @@ declare const GetAgentCommand_base: {
90
90
  * // autoDetect: true || false,
91
91
  * // greetEveryLanguage: true || false,
92
92
  * // transcription: { // VoiceTranscriptionSettings
93
- * // vendor: "aws", // required
93
+ * // vendor: "aws",
94
94
  * // },
95
95
  * // synthesis: {
96
96
  * // model: "STRING_VALUE",
@@ -97,7 +97,7 @@ declare const GetAgentVersionCommand_base: {
97
97
  * // autoDetect: true || false,
98
98
  * // greetEveryLanguage: true || false,
99
99
  * // transcription: { // VoiceTranscriptionSettings
100
- * // vendor: "aws", // required
100
+ * // vendor: "aws",
101
101
  * // },
102
102
  * // synthesis: {
103
103
  * // model: "STRING_VALUE",
@@ -95,7 +95,7 @@ declare const ListAgentsCommand_base: {
95
95
  * // autoDetect: true || false,
96
96
  * // greetEveryLanguage: true || false,
97
97
  * // transcription: { // VoiceTranscriptionSettings
98
- * // vendor: "aws", // required
98
+ * // vendor: "aws",
99
99
  * // },
100
100
  * // synthesis: {
101
101
  * // model: "STRING_VALUE",
@@ -27,9 +27,13 @@ declare const ListPronunciationDictionariesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * Lists every pronunciation dictionary of the company. Returns all languages at once: the
31
- * management surface shows them together and the set is bounded by the languages a company
32
- * actually configures.
30
+ * Lists the pronunciation dictionaries of the company.
31
+ *
32
+ * PAGINATED LIKE EVERY OTHER LIST IN THIS SERVICE, but with an ABSENT `limit` meaning EVERY
33
+ * LANGUAGE — which is what this operation always did, and what the management surface relies on:
34
+ * it shows the languages together and the set is bounded by the languages a company actually
35
+ * configures. So a caller that sends neither member is unaffected, and one that wants pages opts
36
+ * in. `nextCursor` is returned only while there is another page.
33
37
  * @example
34
38
  * Use a bare-bones client and the command you need to make an API call.
35
39
  * ```javascript
@@ -40,6 +44,8 @@ declare const ListPronunciationDictionariesCommand_base: {
40
44
  * const client = new WilmaAgentsClient(config);
41
45
  * const input = { // ListPronunciationDictionariesInput
42
46
  * company: "STRING_VALUE",
47
+ * limit: Number("int"),
48
+ * cursor: "STRING_VALUE",
43
49
  * };
44
50
  * const command = new ListPronunciationDictionariesCommand(input);
45
51
  * const response = await client.send(command);
@@ -63,6 +69,7 @@ declare const ListPronunciationDictionariesCommand_base: {
63
69
  * // },
64
70
  * // },
65
71
  * // ],
72
+ * // nextCursor: "STRING_VALUE",
66
73
  * // };
67
74
  *
68
75
  * ```
@@ -99,7 +99,7 @@ declare const PublishAgentVersionCommand_base: {
99
99
  * // autoDetect: true || false,
100
100
  * // greetEveryLanguage: true || false,
101
101
  * // transcription: { // VoiceTranscriptionSettings
102
- * // vendor: "aws", // required
102
+ * // vendor: "aws",
103
103
  * // },
104
104
  * // synthesis: {
105
105
  * // model: "STRING_VALUE",
@@ -36,6 +36,11 @@ declare const PutPronunciationDictionaryCommand_base: {
36
36
  * the agents. The dictionary is shared, so a rule added here can overflow an agent nobody
37
37
  * editing it is looking at; truncating silently would drop rules from a running agent with no
38
38
  * signal anywhere.
39
+ *
40
+ * OPTIMISTIC LOCKING via `expectedUpdatedAt`, for the same reason the write is a replace: two
41
+ * administrators editing one company dictionary otherwise silently lose one of the two edits,
42
+ * and every agent speaking that language loses the missing rules on its next call. Absent means
43
+ * last-write-wins, exactly as before this member existed.
39
44
  * @example
40
45
  * Use a bare-bones client and the command you need to make an API call.
41
46
  * ```javascript
@@ -54,6 +59,7 @@ declare const PutPronunciationDictionaryCommand_base: {
54
59
  * encoding: "alias" || "ipa",
55
60
  * },
56
61
  * ],
62
+ * expectedUpdatedAt: "STRING_VALUE",
57
63
  * };
58
64
  * const command = new PutPronunciationDictionaryCommand(input);
59
65
  * const response = await client.send(command);
@@ -85,6 +91,9 @@ declare const PutPronunciationDictionaryCommand_base: {
85
91
  * @see {@link PutPronunciationDictionaryCommandOutput} for command's `response` shape.
86
92
  * @see {@link WilmaAgentsClientResolvedConfig | config} for WilmaAgentsClient's `config` shape.
87
93
  *
94
+ * @throws {@link RevisionConflictException} (client fault)
95
+ * The resource was modified concurrently; re-read it and retry with the latest revision.
96
+ *
88
97
  * @throws {@link ValidationException} (client fault)
89
98
  *
90
99
  * @throws {@link WilmaAgentsServiceException}
@@ -92,7 +92,7 @@ declare const RestoreAgentVersionToDraftCommand_base: {
92
92
  * // autoDetect: true || false,
93
93
  * // greetEveryLanguage: true || false,
94
94
  * // transcription: { // VoiceTranscriptionSettings
95
- * // vendor: "aws", // required
95
+ * // vendor: "aws",
96
96
  * // },
97
97
  * // synthesis: {
98
98
  * // model: "STRING_VALUE",
@@ -83,7 +83,7 @@ declare const UpdateAgentCommand_base: {
83
83
  * autoDetect: true || false,
84
84
  * greetEveryLanguage: true || false,
85
85
  * transcription: { // VoiceTranscriptionSettings
86
- * vendor: "aws", // required
86
+ * vendor: "aws",
87
87
  * },
88
88
  * synthesis: {
89
89
  * model: "STRING_VALUE",
@@ -486,7 +486,7 @@ declare const UpdateAgentCommand_base: {
486
486
  * // autoDetect: true || false,
487
487
  * // greetEveryLanguage: true || false,
488
488
  * // transcription: { // VoiceTranscriptionSettings
489
- * // vendor: "aws", // required
489
+ * // vendor: "aws",
490
490
  * // },
491
491
  * // synthesis: {
492
492
  * // model: "STRING_VALUE",
@@ -329,6 +329,12 @@ export interface VoiceLanguage {
329
329
  provider?: VoiceSpeechProvider | undefined;
330
330
  /**
331
331
  * Provider voice id (ElevenLabs voice_id, Google voice name, Polly Id).
332
+ * A CR OR LF IS REFUSED BY THE PATTERN, and the reason is not tidiness: this value reaches the
333
+ * PBX as an AMI action parameter, and AMI frames on CRLF, so a newline inside it closes the
334
+ * action and starts another one on a local, already-authenticated manager connection. Whoever
335
+ * configures a voice agent in the cloud needs no PBX credential, so the model is the first place
336
+ * that can refuse it. `pbx-data-engine` refuses it again on the send path — two layers, because
337
+ * the AMI serializer is out of tree and neither layer can promise the other's behaviour.
332
338
  * @public
333
339
  */
334
340
  voice: string;
@@ -401,10 +407,17 @@ export interface VoiceLanguage {
401
407
  */
402
408
  export interface VoiceTranscriptionSettings {
403
409
  /**
404
- * Recognition vendor. Absent resolves to the platform default (`aws` today), resolved by the server so exactly one component decides it.
410
+ * Recognition vendor. Absent resolves to the platform default (`aws` today), resolved by the
411
+ * server so exactly one component decides it.
412
+ *
413
+ * DELIBERATELY NOT @required, and the sentence above is why: the server already answers the
414
+ * default for a `transcription` that carries no vendor, and both consoles were written to
415
+ * that promise. @required contradicted it — it made the server-side default reachable only
416
+ * for a WHOLLY ABSENT `transcription`, and refused a shape this documentation describes as
417
+ * legal.
405
418
  * @public
406
419
  */
407
- vendor: VoiceTranscriptionVendor;
420
+ vendor?: VoiceTranscriptionVendor | undefined;
408
421
  }
409
422
  /**
410
423
  * Speech configuration for the voice channel. When present it WINS over the dialplan's `voice` and
@@ -2321,6 +2334,16 @@ export interface ListAgentVersionsOutput {
2321
2334
  */
2322
2335
  export interface ListPronunciationDictionariesInput {
2323
2336
  company?: string | undefined;
2337
+ /**
2338
+ * Page size. ABSENT MEANS EVERY DICTIONARY — see the operation's documentation.
2339
+ * @public
2340
+ */
2341
+ limit?: number | undefined;
2342
+ /**
2343
+ * Opaque cursor returned by a previous page; pass it back to fetch the next page.
2344
+ * @public
2345
+ */
2346
+ cursor?: string | undefined;
2324
2347
  }
2325
2348
  /**
2326
2349
  * Every pronunciation rule a company has written for one language.
@@ -2366,6 +2389,11 @@ export interface PronunciationDictionary {
2366
2389
  */
2367
2390
  export interface ListPronunciationDictionariesOutput {
2368
2391
  dictionaries: PronunciationDictionary[];
2392
+ /**
2393
+ * Absent on the last page, and always absent when `limit` was not sent — there is then nothing left to continue from.
2394
+ * @public
2395
+ */
2396
+ nextCursor?: string | undefined;
2369
2397
  }
2370
2398
  /**
2371
2399
  * @public
@@ -2447,6 +2475,24 @@ export interface PutPronunciationDictionaryInput {
2447
2475
  * @public
2448
2476
  */
2449
2477
  rules: VoicePronunciation[];
2478
+ /**
2479
+ * Precondition: the `updatedAt` of the dictionary this edit was made against, echoed back
2480
+ * from the PronunciationDictionary the caller read. When it does not match the stored value
2481
+ * the write is refused with RevisionConflictException and the caller re-reads rather than
2482
+ * overwriting an edit it never saw.
2483
+ *
2484
+ * A TIMESTAMP RATHER THAN AN INTEGER REVISION, unlike UpdateAgent: the dictionary already
2485
+ * carries `updatedAt` on every read, so the round trip exists today and no stored record
2486
+ * needs a new field to take part. The meaning is UpdateAgent's meaning — 'based on the
2487
+ * version I read' — and the error is the same one.
2488
+ *
2489
+ * OPTIONAL, and ABSENCE MEANS LAST-WRITE-WINS: this operation shipped without a precondition,
2490
+ * so making it mandatory would break every existing caller for a guarantee they can opt into.
2491
+ * RevisionConflictException carries no `currentRevision` here — this resource is versioned by
2492
+ * its timestamp, and the current one is on the dictionary a re-read returns.
2493
+ * @public
2494
+ */
2495
+ expectedUpdatedAt?: string | undefined;
2450
2496
  }
2451
2497
  /**
2452
2498
  * @public
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@wildix/wilma-agents-client",
3
3
  "description": "@wildix/wilma-agents-client client",
4
- "version": "1.0.22",
4
+ "version": "1.0.25",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -56,4 +56,4 @@
56
56
  "browser": {
57
57
  "./dist-es/runtimeConfig": "./dist-es/runtimeConfig.browser"
58
58
  }
59
- }
59
+ }