@wildix/wilma-agents-client 1.0.57 → 1.0.58

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.
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.AgentStatus = exports.AgentWorkflowLayout = exports.AgentWorkflowFailureKind = exports.AgentWorkflowMessageButtonVariant = exports.AgentWorkflowEntryBehavior = exports.AgentVariableType = exports.AgentGuardrailWindow = exports.AgentGuardrailMode = exports.AgentGuardrailErrorMode = exports.AgentGuardrailSensitivity = exports.AgentGuardrailPreset = exports.WebSearchContextSize = exports.AgentTransferVariant = exports.AgentTransferPipelineType = exports.SandboxSize = exports.SandboxNetworkAccess = exports.KnowledgeBaseSearchThreshold = exports.KnowledgeBaseSearchStrategy = exports.AgentHangupPipelineType = exports.AgentHandoverVariant = exports.AgentHandoverPipelineType = exports.AgentToolPipelineType = exports.ChannelType = exports.ActorType = exports.VoicePronunciationEncoding = exports.AgentVisibility = void 0;
3
+ exports.AgentEngineKind = exports.AgentStatus = exports.AgentWorkflowLayout = exports.AgentWorkflowFailureKind = exports.AgentWorkflowMessageButtonVariant = exports.AgentWorkflowEntryBehavior = exports.AgentVariableType = exports.AgentGuardrailWindow = exports.AgentGuardrailMode = exports.AgentGuardrailErrorMode = exports.AgentGuardrailSensitivity = exports.AgentGuardrailPreset = exports.WebSearchContextSize = exports.AgentTransferVariant = exports.AgentTransferPipelineType = exports.SandboxSize = exports.SandboxNetworkAccess = exports.KnowledgeBaseSearchThreshold = exports.KnowledgeBaseSearchStrategy = exports.AgentHangupPipelineType = exports.AgentHandoverVariant = exports.AgentHandoverPipelineType = exports.AgentToolPipelineType = exports.ChannelType = exports.ActorType = exports.VoicePronunciationEncoding = exports.AgentVisibility = void 0;
4
4
  exports.AgentVisibility = {
5
5
  EXPLICIT: "explicit",
6
6
  ORGANIZATION: "organization",
@@ -138,3 +138,8 @@ exports.AgentStatus = {
138
138
  ACTIVE: "active",
139
139
  DRAFT: "draft",
140
140
  };
141
+ exports.AgentEngineKind = {
142
+ AI: "ai",
143
+ SQS: "sqs",
144
+ WEBHOOK: "webhook",
145
+ };
@@ -598,8 +598,8 @@ exports.AgentHangupPipeline$ = [3, n2, _AHPg,
598
598
  ];
599
599
  exports.AgentInfo$ = [3, n2, _AI,
600
600
  0,
601
- [_i, _n, _st, _ch, _p, _ca, _sC, _aVs, _sI, _as, _lV],
602
- [0, 0, 0, 64 | 0, 0, 0, 2, () => exports.AssistantVoiceSettings$, 64 | 0, () => exports.AssistantUiSettings$, 1], 4
601
+ [_i, _n, _st, _ch, _p, _ca, _sC, _en, _aVs, _sI, _as, _lV],
602
+ [0, 0, 0, 64 | 0, 0, 0, 2, 0, () => exports.AssistantVoiceSettings$, 64 | 0, () => exports.AssistantUiSettings$, 1], 4
603
603
  ];
604
604
  exports.AgentInlineSandboxOptions$ = [3, n2, _AISO,
605
605
  0,
@@ -629,7 +629,7 @@ exports.AgentSpokenPhrase$ = [3, n2, _ASP,
629
629
  exports.AgentSqsEngine$ = [3, n2, _ASE,
630
630
  0,
631
631
  [_u, _ke, _sec],
632
- [0, 0, () => exports.SecretRef$], 3
632
+ [0, 0, () => exports.SecretRef$], 2
633
633
  ];
634
634
  exports.AgentSuggestionsCapability$ = [3, n2, _ASC,
635
635
  0,
@@ -749,7 +749,7 @@ exports.AgentWebFetchCapability$ = [3, n2, _AWFC,
749
749
  exports.AgentWebhookEngine$ = [3, n2, _AWE,
750
750
  0,
751
751
  [_u, _sec, _ti],
752
- [0, () => exports.SecretRef$, 1], 2
752
+ [0, () => exports.SecretRef$, 1], 1
753
753
  ];
754
754
  exports.AgentWebSearchCapability$ = [3, n2, _AWSC,
755
755
  0,
@@ -135,3 +135,8 @@ export const AgentStatus = {
135
135
  ACTIVE: "active",
136
136
  DRAFT: "draft",
137
137
  };
138
+ export const AgentEngineKind = {
139
+ AI: "ai",
140
+ SQS: "sqs",
141
+ WEBHOOK: "webhook",
142
+ };
@@ -592,8 +592,8 @@ export var AgentHangupPipeline$ = [3, n2, _AHPg,
592
592
  ];
593
593
  export var AgentInfo$ = [3, n2, _AI,
594
594
  0,
595
- [_i, _n, _st, _ch, _p, _ca, _sC, _aVs, _sI, _as, _lV],
596
- [0, 0, 0, 64 | 0, 0, 0, 2, () => AssistantVoiceSettings$, 64 | 0, () => AssistantUiSettings$, 1], 4
595
+ [_i, _n, _st, _ch, _p, _ca, _sC, _en, _aVs, _sI, _as, _lV],
596
+ [0, 0, 0, 64 | 0, 0, 0, 2, 0, () => AssistantVoiceSettings$, 64 | 0, () => AssistantUiSettings$, 1], 4
597
597
  ];
598
598
  export var AgentInlineSandboxOptions$ = [3, n2, _AISO,
599
599
  0,
@@ -623,7 +623,7 @@ export var AgentSpokenPhrase$ = [3, n2, _ASP,
623
623
  export var AgentSqsEngine$ = [3, n2, _ASE,
624
624
  0,
625
625
  [_u, _ke, _sec],
626
- [0, 0, () => SecretRef$], 3
626
+ [0, 0, () => SecretRef$], 2
627
627
  ];
628
628
  export var AgentSuggestionsCapability$ = [3, n2, _ASC,
629
629
  0,
@@ -743,7 +743,7 @@ export var AgentWebFetchCapability$ = [3, n2, _AWFC,
743
743
  export var AgentWebhookEngine$ = [3, n2, _AWE,
744
744
  0,
745
745
  [_u, _sec, _ti],
746
- [0, () => SecretRef$, 1], 2
746
+ [0, () => SecretRef$, 1], 1
747
747
  ];
748
748
  export var AgentWebSearchCapability$ = [3, n2, _AWSC,
749
749
  0,
@@ -54,6 +54,7 @@ declare const ListAgentsNamesCommand_base: {
54
54
  * // "voice" || "chat" || "assistant",
55
55
  * // ],
56
56
  * // speechConfigured: true || false,
57
+ * // engine: "ai" || "webhook" || "sqs",
57
58
  * // assistantVoice: { // AssistantVoiceSettings
58
59
  * // enabled: true || false, // required
59
60
  * // },
@@ -505,3 +505,25 @@ export declare const AgentStatus: {
505
505
  * @public
506
506
  */
507
507
  export type AgentStatus = (typeof AgentStatus)[keyof typeof AgentStatus];
508
+ /**
509
+ * @public
510
+ * @enum
511
+ */
512
+ export declare const AgentEngineKind: {
513
+ /**
514
+ * The managed engine: the platform runs the model, tools and knowledge lookups.
515
+ */
516
+ readonly AI: "ai";
517
+ /**
518
+ * An external backend over SQS.
519
+ */
520
+ readonly SQS: "sqs";
521
+ /**
522
+ * An external backend over HTTPS.
523
+ */
524
+ readonly WEBHOOK: "webhook";
525
+ };
526
+ /**
527
+ * @public
528
+ */
529
+ export type AgentEngineKind = (typeof AgentEngineKind)[keyof typeof AgentEngineKind];
@@ -1,5 +1,5 @@
1
1
  import type { DocumentType as __DocumentType } from "@smithy/types";
2
- import type { ActorType, AgentGuardrailErrorMode, AgentGuardrailMode, AgentGuardrailPreset, AgentGuardrailSensitivity, AgentGuardrailWindow, AgentHandoverPipelineType, AgentHandoverVariant, AgentHangupPipelineType, AgentStatus, AgentToolPipelineType, AgentTransferPipelineType, AgentTransferVariant, AgentVariableType, AgentVisibility, AgentWorkflowEntryBehavior, AgentWorkflowFailureKind, AgentWorkflowLayout, AgentWorkflowMessageButtonVariant, ChannelType, KnowledgeBaseSearchStrategy, KnowledgeBaseSearchThreshold, SandboxNetworkAccess, SandboxSize, VoicePronunciationEncoding, WebSearchContextSize } from "./enums";
2
+ import type { ActorType, AgentEngineKind, AgentGuardrailErrorMode, AgentGuardrailMode, AgentGuardrailPreset, AgentGuardrailSensitivity, AgentGuardrailWindow, AgentHandoverPipelineType, AgentHandoverVariant, AgentHangupPipelineType, AgentStatus, AgentToolPipelineType, AgentTransferPipelineType, AgentTransferVariant, AgentVariableType, AgentVisibility, AgentWorkflowEntryBehavior, AgentWorkflowFailureKind, AgentWorkflowLayout, AgentWorkflowMessageButtonVariant, ChannelType, KnowledgeBaseSearchStrategy, KnowledgeBaseSearchThreshold, SandboxNetworkAccess, SandboxSize, VoicePronunciationEncoding, WebSearchContextSize } from "./enums";
3
3
  /**
4
4
  * A user or group that access is granted to.
5
5
  * @public
@@ -3283,33 +3283,53 @@ export interface SecretRef {
3283
3283
  id: string;
3284
3284
  }
3285
3285
  /**
3286
- * Bring-your-own backend over SQS: turns are forwarded to the queue, replies are posted back via the API.
3286
+ * Bring-your-own backend over SQS: the platform sends what happens to the queue and the backend
3287
+ * answers out of band through the channel's command plane. Authentication is the credential that
3288
+ * makes the send; there is no signature and no response.
3287
3289
  * @public
3288
3290
  */
3289
3291
  export interface AgentSqsEngine {
3290
3292
  url: string;
3291
3293
  key: string;
3292
3294
  /**
3293
- * Reference to the SQS secret access key in wilma-secrets.
3295
+ * Reference to the SQS secret access key in wilma-secrets. Optional for the same reason the
3296
+ * webhook engine's is: an agent is created before it is configured, and a console cannot
3297
+ * supply a reference to a secret nobody has chosen. The call refuses instead, naming what is
3298
+ * missing.
3294
3299
  * @public
3295
3300
  */
3296
- secret: SecretRef;
3301
+ secret?: SecretRef | undefined;
3297
3302
  }
3298
3303
  /**
3299
- * Bring-your-own backend over HTTPS: each turn is POSTed to the URL, the response is the reply.
3304
+ * Bring-your-own backend over HTTPS: the platform POSTs what happens to the URL and the backend
3305
+ * answers out of band through the channel's command plane, never in the response body — which is
3306
+ * what lets one contract serve both this engine and the queue one, where there is no body to
3307
+ * answer in. The response body is not read.
3300
3308
  * @public
3301
3309
  */
3302
3310
  export interface AgentWebhookEngine {
3303
3311
  url: string;
3304
3312
  /**
3305
- * Reference to the HMAC signing secret in wilma-secrets. Was the secret itself, which put
3306
- * credential material in the agent document — readable back out of a stored row and carried
3307
- * into any export of the definition. The sibling AgentSqsEngine has always held a reference;
3308
- * this is the same shape, so nothing that reads an engine has to special-case which of the
3309
- * two it is looking at.
3313
+ * Reference to the HMAC signing secret in wilma-secrets, resolved server-to-server at
3314
+ * delivery. A reference and never the value: an agent holds no credential, like everything
3315
+ * else on this platform, and the member is named for what it holds — `secret`, as on the
3316
+ * queue engine and on a sandbox's environment — because the reference is the type's job to
3317
+ * say. An agent migrated from the previous stack gets one created for the secret it was
3318
+ * configured with.
3319
+ *
3320
+ * A DRAFT MAY NOT HAVE ONE YET. An agent is created before it is configured — that is what
3321
+ * the draft status is for — and a console cannot supply a reference to a secret nobody has
3322
+ * chosen. The call refuses instead, naming what is missing, which is where the author finds
3323
+ * out at the only moment it matters.
3324
+ * @public
3325
+ */
3326
+ secret?: SecretRef | undefined;
3327
+ /**
3328
+ * How long one delivery may take, in MILLISECONDS. It bounds a single request and not the
3329
+ * call: a backend that spends all of it on every event is told about the call late, never
3330
+ * less often.
3310
3331
  * @public
3311
3332
  */
3312
- secret: SecretRef;
3313
3333
  timeout?: number | undefined;
3314
3334
  }
3315
3335
  /**
@@ -3332,7 +3352,10 @@ export declare namespace AgentEngine {
3332
3352
  $unknown?: never;
3333
3353
  }
3334
3354
  /**
3335
- * Bring-your-own backend over HTTPS: each turn is POSTed to the URL, the response is the reply.
3355
+ * Bring-your-own backend over HTTPS: the platform POSTs what happens to the URL and the backend
3356
+ * answers out of band through the channel's command plane, never in the response body — which is
3357
+ * what lets one contract serve both this engine and the queue one, where there is no body to
3358
+ * answer in. The response body is not read.
3336
3359
  * @public
3337
3360
  */
3338
3361
  interface WebhookMember {
@@ -3342,7 +3365,9 @@ export declare namespace AgentEngine {
3342
3365
  $unknown?: never;
3343
3366
  }
3344
3367
  /**
3345
- * Bring-your-own backend over SQS: turns are forwarded to the queue, replies are posted back via the API.
3368
+ * Bring-your-own backend over SQS: the platform sends what happens to the queue and the backend
3369
+ * answers out of band through the channel's command plane. Authentication is the credential that
3370
+ * makes the send; there is no signature and no response.
3346
3371
  * @public
3347
3372
  */
3348
3373
  interface SqsMember {
@@ -3577,6 +3602,19 @@ export interface AgentInfo {
3577
3602
  * @public
3578
3603
  */
3579
3604
  speechConfigured?: boolean | undefined;
3605
+ /**
3606
+ * Which engine produces this agent's replies: the managed one, or somebody else's backend
3607
+ * over a webhook or a queue. `channels` is what the agent DECLARES, and an engine is
3608
+ * implemented per channel, so the two are not the same question — an agent that declares a
3609
+ * channel its engine cannot serve is configured, listed, and silent there.
3610
+ *
3611
+ * Which channels each engine can serve is a property of the platform rather than of this
3612
+ * agent, so it does not travel per agent: every `ai` agent would carry the same answer. The
3613
+ * service enforces it where it matters — a listing filtered by channel omits an agent whose
3614
+ * engine cannot answer there, and the channel refuses the connection.
3615
+ * @public
3616
+ */
3617
+ engine?: AgentEngineKind | undefined;
3580
3618
  /**
3581
3619
  * Assistant voice as an end-user client needs it. Answered from the definition the agent currently runs — the deployment's routed version, else the latest published version, else the draft only when nothing was ever published. Absent means the agent offers no voice.
3582
3620
  * @public
@@ -3898,7 +3936,14 @@ export interface ListAgentApiKeysOutput {
3898
3936
  export interface ListAgentsInput {
3899
3937
  company?: string | undefined;
3900
3938
  /**
3901
- * Only agents that have this channel enabled (voice / chat / assistant). An agent serving no channel matches no value of this filter, so a caller listing agents to run as a task — rather than to reach on a surface — must leave it unset.
3939
+ * Only agents that have this channel enabled (voice / chat / assistant). An agent serving no
3940
+ * channel matches no value of this filter, so a caller listing agents to run as a task —
3941
+ * rather than to reach on a surface — must leave it unset.
3942
+ *
3943
+ * TWO CONDITIONS, not one: an agent whose ENGINE has no runtime for the asked channel is
3944
+ * omitted as well, however its `channels` are set. A dialplan picker asking for `voice` would
3945
+ * otherwise be offered agents whose every call drops at attach. `AgentInfo.engine` says which
3946
+ * engine each remaining agent runs on.
3902
3947
  * @public
3903
3948
  */
3904
3949
  channel?: ChannelType | undefined;
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.57",
4
+ "version": "1.0.58",
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",