botframework-schema - npm Package Compare versions

Comparing version 4.0.0-m3.0 to 4.0.0-m4.0

lib/index.d.ts

@@ -9,2 +9,18 @@ /**
 /**
+ * copy of RequestOptionsBase so we don't have dependency on ms-rest-js in our schema package
+ */
+/**
+ * Describes the base structure of the options object that will be used in every operation.
+ */
+export interface RequestOptionsBase {
+    /**
+     * @property {object} [customHeaders] - User defined custom request headers that
+     * will be applied before the request is sent.
+     */
+    customHeaders?: {
+        [key: string]: string;
+    };
+    [key: string]: any;
+}
+/**
  * @interface
@@ -89,2 +105,7 @@ * An interface representing AttachmentView.
     name: string;
+    /**
+     * @member {RoleTypes} [role] Role of the entity behind the account (Example:
+     * User, Bot, etc.). Possible values include: 'user', 'bot'
+     */
+    role: RoleTypes | string;
 }
@@ -99,6 +120,12 @@ /**
     /**
-     * @member {boolean} [isGroup] Is this a reference to a group
+     * @member {boolean} [isGroup] Indicates whether the conversation contains
+     * more than two participants at the time the activity was generated
      */
     isGroup: boolean;
     /**
+     * @member {string} [conversationType] Indicates the type of the conversation
+     * in channels that distinguish between conversation types
+     */
+    conversationType: string;
+    /**
      * @member {string} [id] Channel id for the user or bot on this channel
@@ -112,2 +139,7 @@ * (Example: [e-mail], or @joesmith or 123456)
     name: string;
+    /**
+     * @member {RoleTypes} [role] Role of the entity behind the account (Example:
+     * User, Bot, etc.). Possible values include: 'user', 'bot'
+     */
+    role: RoleTypes;
 }
@@ -160,6 +192,6 @@ /**
     /**
-     * @member {string} [value] Supplementary parameter for action. Content of
-     * this property depends on the ActionType
+     * @member {any} [value] Supplementary parameter for action. Content of this
+     * property depends on the ActionType
      */
-    value: string;
+    value: any;
 }
@@ -287,3 +319,3 @@ /**
      * 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate',
-     * 'messageReaction', 'suggestion'
+     * 'messageReaction', 'suggestion', 'trace'
      */
@@ -416,2 +448,11 @@ type: ActivityTypes | string;
     /**
+     * @member {string} [label] Descriptive label
+     */
+    label: string;
+    /**
+     * @member {string} [valueType] Unique string which identifies the shape of
+     * the value object
+     */
+    valueType: string;
+    /**
      * @member {any} [value] Open-ended value
@@ -519,2 +560,34 @@ */
  * @interface
+ * An interface representing ConversationMembers.
+ * Conversation and its members
+ *
+ */
+export interface ConversationMembers {
+    /**
+     * @member {string} [id] Conversation ID
+     */
+    id: string;
+    /**
+     * @member {ChannelAccount[]} [members] List of members in this conversation
+     */
+    members: ChannelAccount[];
+}
+/**
+ * @interface
+ * An interface representing ConversationsResult.
+ * Conversations result
+ *
+ */
+export interface ConversationsResult {
+    /**
+     * @member {string} [continuationToken] Paging token
+     */
+    continuationToken: string;
+    /**
+     * @member {ConversationMembers[]} [conversations] List of conversations
+     */
+    conversations: ConversationMembers[];
+}
+/**
+ * @interface
  * An interface representing ResourceResponse.
@@ -694,5 +767,5 @@ * A response containing a resource ID
     /**
-     * @member {string} [value] Supplementary parameter for this card
+     * @member {any} [value] Supplementary parameter for this card
      */
-    value: string;
+    value: any;
 }
@@ -751,5 +824,5 @@ /**
     /**
-     * @member {string} [value] Supplementary parameter for this card
+     * @member {any} [value] Supplementary parameter for this card
      */
-    value: string;
+    value: any;
 }
@@ -842,4 +915,23 @@ /**
     /**
-     * @member {string} [value] Supplementary parameter for this card
+     * @member {any} [value] Supplementary parameter for this card
      */
+    value: any;
+}
+/**
+ * @interface
+ * An interface representing Fact.
+ * Set of key-value pairs. Advantage of this section is that key and value
+ * properties will be
+ * rendered with default style information with some delimiter between them. So
+ * there is no need for developer to specify style information.
+ *
+ */
+export interface Fact {
+    /**
+     * @member {string} [key] The key for this Fact
+     */
+    key: string;
+    /**
+     * @member {string} [value] The value for this Fact
+     */
     value: string;
@@ -888,21 +980,2 @@ }
  * @interface
- * An interface representing Fact.
- * Set of key-value pairs. Advantage of this section is that key and value
- * properties will be
- * rendered with default style information with some delimiter between them. So
- * there is no need for developer to specify style information.
- *
- */
-export interface Fact {
-    /**
-     * @member {string} [key] The key for this Fact
-     */
-    key: string;
-    /**
-     * @member {string} [value] The value for this Fact
-     */
-    value: string;
-}
-/**
- * @interface
  * An interface representing ReceiptCard.
@@ -918,2 +991,6 @@ * A receipt card
     /**
+     * @member {Fact[]} [facts] Array of Fact objects
+     */
+    facts: Fact[];
+    /**
      * @member {ReceiptItem[]} [items] Array of Receipt Items
@@ -923,6 +1000,2 @@ */
     /**
-     * @member {Fact[]} [facts] Array of Fact Objects   Array of key-value pairs.
-     */
-    facts: Fact[];
-    /**
      * @member {CardAction} [tap] This action will be activated when user taps on
@@ -933,11 +1006,11 @@ * the card
     /**
-     * @member {string} [total] Total amount of money paid (or should be paid)
+     * @member {string} [total] Total amount of money paid (or to be paid)
      */
     total: string;
     /**
-     * @member {string} [tax] Total amount of TAX paid(or should be paid)
+     * @member {string} [tax] Total amount of tax paid (or to be paid)
      */
     tax: string;
     /**
-     * @member {string} [vat] Total amount of VAT paid(or should be paid)
+     * @member {string} [vat] Total amount of VAT paid (or to be paid)
      */
@@ -969,2 +1042,22 @@ vat: string;
  * @interface
+ * An interface representing OAuthCard.
+ * A card representing a request to peform a sign in via OAuth
+ *
+ */
+export interface OAuthCard {
+    /**
+     * @member {string} [text] Text for signin request
+     */
+    text: string;
+    /**
+     * @member {string} [connectionName] The name of the registered connection
+     */
+    connectionName: string;
+    /**
+     * @member {CardAction[]} [buttons] Action to use to perform signin
+     */
+    buttons: CardAction[];
+}
+/**
+ * @interface
  * An interface representing ThumbnailCard.
@@ -1054,5 +1147,5 @@ * A thumbnail card (card with a single, small thumbnail image)
     /**
-     * @member {string} [value] Supplementary parameter for this card
+     * @member {any} [value] Supplementary parameter for this card
      */
-    value: string;
+    value: any;
 }
@@ -1173,2 +1266,42 @@ /**
  * @interface
+ * An interface representing TokenRequest.
+ * A request to receive a user token
+ *
+ */
+export interface TokenRequest {
+    /**
+     * @member {string} [provider] The provider to request a user token from
+     */
+    provider: string;
+    /**
+     * @member {{ [propertyName: string]: any }} [settings] A collection of
+     * settings for the specific provider for this request
+     */
+    settings: {
+        [propertyName: string]: any;
+    };
+}
+/**
+ * @interface
+ * An interface representing TokenResponse.
+ * A response that includes a user token
+ *
+ */
+export interface TokenResponse {
+    /**
+     * @member {string} [connectionName] The connection name
+     */
+    connectionName: string;
+    /**
+     * @member {string} [token] The user token
+     */
+    token: string;
+    /**
+     * @member {string} [expiration] Expiration for the token, in ISO 8601 format
+     * (e.g. "2007-04-05T14:30Z")
+     */
+    expiration: string;
+}
+/**
+ * @interface
  * An interface representing MicrosoftPayMethodData.
@@ -1595,2 +1728,29 @@ * W3C Payment Method Data for Microsoft Pay
 /**
+ * @interface
+ * An interface representing ConversationsGetConversationsOptionalParams.
+ * Optional Parameters.
+ *
+ * @extends RequestOptionsBase
+ */
+export interface ConversationsGetConversationsOptionalParams extends RequestOptionsBase {
+    /**
+     * @member {string} [continuationToken] skip or continuation token
+     */
+    continuationToken: string;
+}
+/**
+ * Defines values for RoleTypes.
+ * Possible values include: 'user', 'bot'
+ * There could be more values for this enum apart from the ones defined here.If
+ * you want to set a value that is not from the known values then you can do
+ * the following:
+ * let param: RoleTypes = <RoleTypes>"someUnknownValueThatWillStillBeValid";
+ * @readonly
+ * @enum {string}
+ */
+export declare enum RoleTypes {
+    User = "user",
+    Bot = "bot",
+}
+/**
  * Defines values for ActivityTypes.
@@ -1600,3 +1760,3 @@ * Possible values include: 'message', 'contactRelationUpdate',
  * 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete',
- * 'installationUpdate', 'messageReaction', 'suggestion'
+ * 'installationUpdate', 'messageReaction', 'suggestion', 'trace'
  * There could be more values for this enum apart from the ones defined here.If
@@ -1625,2 +1785,3 @@ * you want to set a value that is not from the known values then you can do
     Suggestion = "suggestion",
+    Trace = "trace",
 }
@@ -1627,0 +1788,0 @@ /**

lib/index.js

@@ -11,2 +11,17 @@ "use strict";
 /**
+ * Defines values for RoleTypes.
+ * Possible values include: 'user', 'bot'
+ * There could be more values for this enum apart from the ones defined here.If
+ * you want to set a value that is not from the known values then you can do
+ * the following:
+ * let param: RoleTypes = <RoleTypes>"someUnknownValueThatWillStillBeValid";
+ * @readonly
+ * @enum {string}
+ */
+var RoleTypes;
+(function (RoleTypes) {
+    RoleTypes["User"] = "user";
+    RoleTypes["Bot"] = "bot";
+})(RoleTypes = exports.RoleTypes || (exports.RoleTypes = {}));
+/**
  * Defines values for ActivityTypes.
@@ -16,3 +31,3 @@ * Possible values include: 'message', 'contactRelationUpdate',
  * 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete',
- * 'installationUpdate', 'messageReaction', 'suggestion'
+ * 'installationUpdate', 'messageReaction', 'suggestion', 'trace'
  * There could be more values for this enum apart from the ones defined here.If
@@ -42,2 +57,3 @@ * you want to set a value that is not from the known values then you can do
     ActivityTypes["Suggestion"] = "suggestion";
+    ActivityTypes["Trace"] = "trace";
 })(ActivityTypes = exports.ActivityTypes || (exports.ActivityTypes = {}));
@@ -44,0 +60,0 @@ /**

package.json

 {
   "name": "botframework-schema",
-  "version": "4.0.0-m3.0",
+  "version": "4.0.0-m4.0",
   "keywords": [
@@ -5,0 +5,0 @@ "botconnector",

src/index.ts

@@ -9,2 +9,19 @@ /**
 
+/**
+ * copy of RequestOptionsBase so we don't have dependency on ms-rest-js in our schema package
+ */
+ 
+/**
+ * Describes the base structure of the options object that will be used in every operation.
+ */
+export interface RequestOptionsBase {
+  /**
+   * @property {object} [customHeaders] - User defined custom request headers that
+   * will be applied before the request is sent.
+   */
+  customHeaders?: {
+      [key: string]: string;
+  };
+  [key: string]: any;
+}
 
@@ -96,2 +113,7 @@
   name: string;
+  /**
+   * @member {RoleTypes} [role] Role of the entity behind the account (Example:
+   * User, Bot, etc.). Possible values include: 'user', 'bot'
+   */
+  role: RoleTypes | string;
 }
@@ -107,6 +129,12 @@
   /**
-   * @member {boolean} [isGroup] Is this a reference to a group
+   * @member {boolean} [isGroup] Indicates whether the conversation contains
+   * more than two participants at the time the activity was generated
    */
   isGroup: boolean;
   /**
+   * @member {string} [conversationType] Indicates the type of the conversation
+   * in channels that distinguish between conversation types
+   */
+  conversationType: string;
+  /**
    * @member {string} [id] Channel id for the user or bot on this channel
@@ -120,2 +148,7 @@ * (Example: [e-mail], or @joesmith or 123456)
   name: string;
+  /**
+   * @member {RoleTypes} [role] Role of the entity behind the account (Example:
+   * User, Bot, etc.). Possible values include: 'user', 'bot'
+   */
+  role: RoleTypes;
 }
@@ -170,6 +203,6 @@
   /**
-   * @member {string} [value] Supplementary parameter for action. Content of
-   * this property depends on the ActionType
+   * @member {any} [value] Supplementary parameter for action. Content of this
+   * property depends on the ActionType
    */
-  value: string;
+  value: any;
 }
@@ -303,3 +336,3 @@
    * 'deleteUserData', 'messageUpdate', 'messageDelete', 'installationUpdate',
-   * 'messageReaction', 'suggestion'
+   * 'messageReaction', 'suggestion', 'trace'
    */
@@ -432,2 +465,11 @@ type: ActivityTypes | string;
   /**
+   * @member {string} [label] Descriptive label
+   */
+  label: string;
+  /**
+   * @member {string} [valueType] Unique string which identifies the shape of
+   * the value object
+   */
+  valueType: string;
+  /**
    * @member {any} [value] Open-ended value
@@ -538,2 +580,36 @@ */
  * @interface
+ * An interface representing ConversationMembers.
+ * Conversation and its members
+ *
+ */
+export interface ConversationMembers {
+  /**
+   * @member {string} [id] Conversation ID
+   */
+  id: string;
+  /**
+   * @member {ChannelAccount[]} [members] List of members in this conversation
+   */
+  members: ChannelAccount[];
+}
+
+/**
+ * @interface
+ * An interface representing ConversationsResult.
+ * Conversations result
+ *
+ */
+export interface ConversationsResult {
+  /**
+   * @member {string} [continuationToken] Paging token
+   */
+  continuationToken: string;
+  /**
+   * @member {ConversationMembers[]} [conversations] List of conversations
+   */
+  conversations: ConversationMembers[];
+}
+
+/**
+ * @interface
  * An interface representing ResourceResponse.
@@ -719,5 +795,5 @@ * A response containing a resource ID
   /**
-   * @member {string} [value] Supplementary parameter for this card
+   * @member {any} [value] Supplementary parameter for this card
    */
-  value: string;
+  value: any;
 }
@@ -777,5 +853,5 @@
   /**
-   * @member {string} [value] Supplementary parameter for this card
+   * @member {any} [value] Supplementary parameter for this card
    */
-  value: string;
+  value: any;
 }
@@ -870,4 +946,24 @@
   /**
-   * @member {string} [value] Supplementary parameter for this card
+   * @member {any} [value] Supplementary parameter for this card
    */
+  value: any;
+}
+
+/**
+ * @interface
+ * An interface representing Fact.
+ * Set of key-value pairs. Advantage of this section is that key and value
+ * properties will be
+ * rendered with default style information with some delimiter between them. So
+ * there is no need for developer to specify style information.
+ *
+ */
+export interface Fact {
+  /**
+   * @member {string} [key] The key for this Fact
+   */
+  key: string;
+  /**
+   * @member {string} [value] The value for this Fact
+   */
   value: string;
@@ -918,22 +1014,2 @@ }
  * @interface
- * An interface representing Fact.
- * Set of key-value pairs. Advantage of this section is that key and value
- * properties will be
- * rendered with default style information with some delimiter between them. So
- * there is no need for developer to specify style information.
- *
- */
-export interface Fact {
-  /**
-   * @member {string} [key] The key for this Fact
-   */
-  key: string;
-  /**
-   * @member {string} [value] The value for this Fact
-   */
-  value: string;
-}
-
-/**
- * @interface
  * An interface representing ReceiptCard.
@@ -949,2 +1025,6 @@ * A receipt card
   /**
+   * @member {Fact[]} [facts] Array of Fact objects
+   */
+  facts: Fact[];
+  /**
    * @member {ReceiptItem[]} [items] Array of Receipt Items
@@ -954,6 +1034,2 @@ */
   /**
-   * @member {Fact[]} [facts] Array of Fact Objects   Array of key-value pairs.
-   */
-  facts: Fact[];
-  /**
    * @member {CardAction} [tap] This action will be activated when user taps on
@@ -964,11 +1040,11 @@ * the card
   /**
-   * @member {string} [total] Total amount of money paid (or should be paid)
+   * @member {string} [total] Total amount of money paid (or to be paid)
    */
   total: string;
   /**
-   * @member {string} [tax] Total amount of TAX paid(or should be paid)
+   * @member {string} [tax] Total amount of tax paid (or to be paid)
    */
   tax: string;
   /**
-   * @member {string} [vat] Total amount of VAT paid(or should be paid)
+   * @member {string} [vat] Total amount of VAT paid (or to be paid)
    */
@@ -1002,2 +1078,23 @@ vat: string;
  * @interface
+ * An interface representing OAuthCard.
+ * A card representing a request to peform a sign in via OAuth
+ *
+ */
+export interface OAuthCard {
+  /**
+   * @member {string} [text] Text for signin request
+   */
+  text: string;
+  /**
+   * @member {string} [connectionName] The name of the registered connection
+   */
+  connectionName: string;
+  /**
+   * @member {CardAction[]} [buttons] Action to use to perform signin
+   */
+  buttons: CardAction[];
+}
+
+/**
+ * @interface
  * An interface representing ThumbnailCard.
@@ -1088,5 +1185,5 @@ * A thumbnail card (card with a single, small thumbnail image)
   /**
-   * @member {string} [value] Supplementary parameter for this card
+   * @member {any} [value] Supplementary parameter for this card
    */
-  value: string;
+  value: any;
 }
@@ -1213,2 +1310,42 @@
  * @interface
+ * An interface representing TokenRequest.
+ * A request to receive a user token
+ *
+ */
+export interface TokenRequest {
+  /**
+   * @member {string} [provider] The provider to request a user token from
+   */
+  provider: string;
+  /**
+   * @member {{ [propertyName: string]: any }} [settings] A collection of
+   * settings for the specific provider for this request
+   */
+  settings: { [propertyName: string]: any };
+}
+
+/**
+ * @interface
+ * An interface representing TokenResponse.
+ * A response that includes a user token
+ *
+ */
+export interface TokenResponse {
+  /**
+   * @member {string} [connectionName] The connection name
+   */
+  connectionName: string;
+  /**
+   * @member {string} [token] The user token
+   */
+  token: string;
+  /**
+   * @member {string} [expiration] Expiration for the token, in ISO 8601 format
+   * (e.g. "2007-04-05T14:30Z")
+   */
+  expiration: string;
+}
+
+/**
+ * @interface
  * An interface representing MicrosoftPayMethodData.
@@ -1650,2 +1787,31 @@ * W3C Payment Method Data for Microsoft Pay
 /**
+ * @interface
+ * An interface representing ConversationsGetConversationsOptionalParams.
+ * Optional Parameters.
+ *
+ * @extends RequestOptionsBase
+ */
+export interface ConversationsGetConversationsOptionalParams extends RequestOptionsBase {
+  /**
+   * @member {string} [continuationToken] skip or continuation token
+   */
+  continuationToken: string;
+}
+
+/**
+ * Defines values for RoleTypes.
+ * Possible values include: 'user', 'bot'
+ * There could be more values for this enum apart from the ones defined here.If
+ * you want to set a value that is not from the known values then you can do
+ * the following:
+ * let param: RoleTypes = <RoleTypes>"someUnknownValueThatWillStillBeValid";
+ * @readonly
+ * @enum {string}
+ */
+export enum RoleTypes {
+  User = 'user',
+  Bot = 'bot',
+}
+
+/**
  * Defines values for ActivityTypes.
@@ -1655,3 +1821,3 @@ * Possible values include: 'message', 'contactRelationUpdate',
  * 'invoke', 'deleteUserData', 'messageUpdate', 'messageDelete',
- * 'installationUpdate', 'messageReaction', 'suggestion'
+ * 'installationUpdate', 'messageReaction', 'suggestion', 'trace'
  * There could be more values for this enum apart from the ones defined here.If
@@ -1680,2 +1846,3 @@ * you want to set a value that is not from the known values then you can do
   Suggestion = 'suggestion',
+  Trace = 'trace',
 }
@@ -1682,0 +1849,0 @@

No alert changes

Improved metrics

Total package byte prevSize

118909

increased by8.66%

Lines of code

4067

increased by9.01%

No dependency changes