stentor-models 1.57.38 → 1.57.40

package/lib/Request/ChannelActionRequest.d.ts

@@ -0,0 +1,41 @@
+/*! Copyright (c) 2022, XAPP AI */
+import { BaseRequest } from "./Request";
+import { ChannelActionRequestType } from "./Types";
+/**
+ * A user initiated action performed on the channel.  The most common is opening a URL.
+ *
+ * This can be used to provide a follow up response to the user performing an action or simply for keeping
+ * track of if the URL opened.
+ *
+ * @beta This is new and subject to change
+ */
+export interface ChannelActionRequest extends BaseRequest {
+    type: ChannelActionRequestType;
+    /**
+     * The current session ID
+     */
+    sessionId?: string;
+    /**
+     * Action taken
+     */
+    action: "OPEN_URL" | "FEEDBACK_RESPONSE" | string;
+    /**
+     * Optional, reference ID passed back.
+     */
+    referenceId?: string;
+    /**
+     * Optional, used differently depending on the action.
+     *
+     * Use this for "OPEN_URL" action types.
+     */
+    uri?: string;
+    /**
+     * Optional, used to provide feedback on a posed question such as "How would you rate this experience?"
+     * or "Was the response relevant?"
+     */
+    feedback?: "POSITIVE" | "NEGATIVE" | "RELEVANT" | "NOT_RELEVANT" | string;
+    /**
+     * Optional, open ended detail, can be used for stringified JSON or notes from the end user.
+     */
+    detail?: string;
+}

package/lib/Request/ChannelActionRequest.js

@@ -0,0 +1,3 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+//# sourceMappingURL=ChannelActionRequest.js.map

package/lib/Request/ChannelActionRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ChannelActionRequest.js","sourceRoot":"","sources":["../../src/Request/ChannelActionRequest.ts"],"names":[],"mappings":""}

package/lib/Request/Request.d.ts

@@ -17,6 +17,7 @@ import { RequestTypes } from "./Types";
 import { DeliveryAddressRequest } from "./DeliveryAddressRequest";
 import { TransactionDecisionRequest } from "./TransactionDecisionRequest";
 import { TransactionRequirementCheckRequest } from "./TransactionRequirementCheckRequest";
+import { ChannelActionRequest } from "./ChannelActionRequest";
 /**
  * Shared parameters for each Request
  */
@@ -150,4 +151,4 @@ export interface ApiAccessData {
     apiBaseUrl: string;
     apiAuthToken: string;
 }
-export type Request = LaunchRequest | SessionEndedRequest | InputUnknownRequest | IntentRequest | AudioPlayerRequest | PlaybackControlRequest | PermissionRequest | SurfaceChangeRequest | NotificationPermissionRequest | SignInRequest | OptionSelectRequest | RawQueryRequest | DeliveryAddressRequest | TransactionDecisionRequest | TransactionRequirementCheckRequest;
+export type Request = AudioPlayerRequest | ChannelActionRequest | DeliveryAddressRequest | InputUnknownRequest | IntentRequest | LaunchRequest | NotificationPermissionRequest | OptionSelectRequest | PermissionRequest | PlaybackControlRequest | RawQueryRequest | SessionEndedRequest | SignInRequest | SurfaceChangeRequest | TransactionDecisionRequest | TransactionRequirementCheckRequest;

package/lib/Request/Types.d.ts

@@ -1,5 +1,6 @@
 /*! Copyright (c) 2019, XAPPmedia */
 export type AudioPlayerRequestType = "AUDIO_PLAYER_REQUEST";
+export type ChannelActionRequestType = "CHANNEL_ACTION_REQUEST";
 export type InputUnknownRequestType = "INPUT_UNKNOWN_REQUEST";
 export type IntentRequestType = "INTENT_REQUEST";
 export type LaunchRequestType = "LAUNCH_REQUEST";
@@ -14,7 +15,7 @@ export type SurfaceChangeRequestType = "SURFACE_CHANGE_REQUEST";
 export type TransactionRequirementCheckType = "TRANSACTION_REQUIREMENT_CHECK_REQUEST";
 export type TransactionDecisionType = "TRANSACTION_DECISION_REQUEST";
 export type TransactionDeliveryAddressType = "TRANSACTION_DELIVERY_ADDRESS_REQUEST";
-export type RequestTypes = AudioPlayerRequestType | InputUnknownRequestType | IntentRequestType | LaunchRequestType | NotificationPermissionRequestType | OptionSelectRequestType | PermissionRequestType | PlaybackControlRequestType | RawQueryRequestType | SessionEndedRequestType | SignInRequestType | SurfaceChangeRequestType | TransactionRequirementCheckType | TransactionDecisionType | TransactionDeliveryAddressType;
+export type RequestTypes = AudioPlayerRequestType | ChannelActionRequestType | InputUnknownRequestType | IntentRequestType | LaunchRequestType | NotificationPermissionRequestType | OptionSelectRequestType | PermissionRequestType | PlaybackControlRequestType | RawQueryRequestType | SessionEndedRequestType | SignInRequestType | SurfaceChangeRequestType | TransactionRequirementCheckType | TransactionDecisionType | TransactionDeliveryAddressType;
 export type LaunchRequestID = "LaunchRequest";
 export type PermissionGrantID = "PermissionGrant";
 export type InputUnknownID = "InputUnknown";

package/lib/Request/index.d.ts

@@ -1,5 +1,6 @@
 /*! Copyright (c) 2019, XAPPmedia */
 export * from "./AudioPlayerRequest";
+export * from "./ChannelActionRequest";
 export * from "./InputUnknownRequest";
 export * from "./IntentRequest";
 export * from "./KnowledgeBase";

package/lib/Request/index.js

@@ -16,6 +16,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 /*! Copyright (c) 2019, XAPPmedia */
 __exportStar(require("./AudioPlayerRequest"), exports);
+__exportStar(require("./ChannelActionRequest"), exports);
 __exportStar(require("./InputUnknownRequest"), exports);
 __exportStar(require("./IntentRequest"), exports);
 __exportStar(require("./KnowledgeBase"), exports);

package/lib/Request/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,uDAAqC;AACrC,wDAAsC;AACtC,kDAAgC;AAChC,kDAAgC;AAChC,kDAAgC;AAChC,kEAAgD;AAChD,wDAAsC;AACtC,sDAAoC;AACpC,2DAAyC;AACzC,4CAA0B;AAC1B,qDAAmC;AACnC,wDAAsC;AACtC,kDAAgC;AAChC,yDAAuC;AACvC,oDAAkC;AAClC,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/Request/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,oCAAoC;AACpC,uDAAqC;AACrC,yDAAuC;AACvC,wDAAsC;AACtC,kDAAgC;AAChC,kDAAgC;AAChC,kDAAgC;AAChC,kEAAgD;AAChD,wDAAsC;AACtC,sDAAoC;AACpC,2DAAyC;AACzC,4CAA0B;AAC1B,qDAAmC;AACnC,wDAAsC;AACtC,kDAAgC;AAChC,yDAAuC;AACvC,oDAAkC;AAClC,0CAAwB"}

package/package.json

@@ -4,7 +4,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.57.38",
+  "version": "1.57.40",
   "description": "Models for 📣 stentor",
   "types": "lib/index",
   "typings": "lib/index",
@@ -31,7 +31,7 @@
     "clean": "rm -rf ./lib/* && rm -rf ./dist/*"
   },
   "dependencies": {
-    "@xapp/patterns": "1.43.4"
+    "@xapp/patterns": "1.43.38"
   },
-  "gitHead": "b6384a0607f153daa9778b9f626861cb83f64412"
+  "gitHead": "072b5f40e94929b039d7833fd846905a04d42606"
 }