Deprecate Payments (#1462)

microsoft · Dec 9, 2019 · 7c18d90 · 7c18d90
1 parent 4c18275
commit 7c18d90
Show file tree

Hide file tree

Showing 3 changed files with 94 additions and 19 deletions.
diff --git a/libraries/botframework-connector/src/connectorApi/models/mappers.ts b/libraries/botframework-connector/src/connectorApi/models/mappers.ts
@@ -2147,6 +2147,9 @@ export const MicrosoftPayMethodData: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentAddress: msRest.CompositeMapper = {
   serializedName: "PaymentAddress",
   type: {
@@ -2228,6 +2231,9 @@ export const PaymentAddress: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentCurrencyAmount: msRest.CompositeMapper = {
   serializedName: "PaymentCurrencyAmount",
   type: {
@@ -2256,6 +2262,9 @@ export const PaymentCurrencyAmount: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentItem: msRest.CompositeMapper = {
   serializedName: "PaymentItem",
   type: {
@@ -2285,6 +2294,9 @@ export const PaymentItem: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentShippingOption: msRest.CompositeMapper = {
   serializedName: "PaymentShippingOption",
   type: {
@@ -2320,6 +2332,9 @@ export const PaymentShippingOption: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentDetailsModifier: msRest.CompositeMapper = {
   serializedName: "PaymentDetailsModifier",
   type: {
@@ -2366,6 +2381,9 @@ export const PaymentDetailsModifier: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentDetails: msRest.CompositeMapper = {
   serializedName: "PaymentDetails",
   type: {
@@ -2425,6 +2443,9 @@ export const PaymentDetails: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentMethodData: msRest.CompositeMapper = {
   serializedName: "PaymentMethodData",
   type: {
@@ -2452,6 +2473,9 @@ export const PaymentMethodData: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentOptions: msRest.CompositeMapper = {
   serializedName: "PaymentOptions",
   type: {
@@ -2492,6 +2516,9 @@ export const PaymentOptions: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentRequest: msRest.CompositeMapper = {
   serializedName: "PaymentRequest",
   type: {
@@ -2540,6 +2567,9 @@ export const PaymentRequest: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentResponse: msRest.CompositeMapper = {
   serializedName: "PaymentResponse",
   type: {
@@ -2587,6 +2617,9 @@ export const PaymentResponse: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentRequestComplete: msRest.CompositeMapper = {
   serializedName: "PaymentRequestComplete",
   type: {
@@ -2617,6 +2650,9 @@ export const PaymentRequestComplete: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentRequestCompleteResult: msRest.CompositeMapper = {
   serializedName: "PaymentRequestCompleteResult",
   type: {
@@ -2633,6 +2669,9 @@ export const PaymentRequestCompleteResult: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentRequestUpdate: msRest.CompositeMapper = {
   serializedName: "PaymentRequestUpdate",
   type: {
@@ -2669,6 +2708,9 @@ export const PaymentRequestUpdate: msRest.CompositeMapper = {
   }
 };
 
+/**
+ * @deprecated Bot Framework no longer supports payments
+ */
 export const PaymentRequestUpdateResult: msRest.CompositeMapper = {
   serializedName: "PaymentRequestUpdateResult",
   type: {

diff --git a/libraries/botframework-schema/src/index.ts b/libraries/botframework-schema/src/index.ts
@@ -163,7 +163,7 @@ export interface CardAction {
   /**
    * The type of action implemented by this button. Possible values include: 'openUrl', 'imBack',
    * 'postBack', 'playAudio', 'playVideo', 'showImage', 'downloadFile', 'signin', 'call',
-   * 'payment', 'messageBack', 'openApp'
+   * messageBack', 'openApp'
    */
   type: ActionTypes | string;
   /**
@@ -1251,6 +1251,7 @@ export interface TokenResponse {
 
 /**
  * W3C Payment Method Data for Microsoft Pay
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface MicrosoftPayMethodData {
   /**
@@ -1269,6 +1270,7 @@ export interface MicrosoftPayMethodData {
 
 /**
  * Address within a Payment Request
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentAddress {
   /**
@@ -1324,6 +1326,7 @@ export interface PaymentAddress {
 
 /**
  * Supplies monetary amounts
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentCurrencyAmount {
   /**
@@ -1342,6 +1345,7 @@ export interface PaymentCurrencyAmount {
 
 /**
  * Indicates what the payment request is for and the value asked for
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentItem {
   /**
@@ -1360,6 +1364,7 @@ export interface PaymentItem {
 
 /**
  * Describes a shipping option
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentShippingOption {
   /**
@@ -1382,6 +1387,7 @@ export interface PaymentShippingOption {
 
 /**
  * Provides details that modify the PaymentDetails based on payment method identifier
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentDetailsModifier {
   /**
@@ -1407,6 +1413,7 @@ export interface PaymentDetailsModifier {
 
 /**
  * Provides information about the requested transaction
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentDetails {
   /**
@@ -1434,6 +1441,7 @@ export interface PaymentDetails {
 /**
  * Indicates a set of supported payment methods and any associated payment method specific data for
  * those methods
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentMethodData {
   /**
@@ -1450,6 +1458,7 @@ export interface PaymentMethodData {
 
 /**
  * Provides information about the options desired for the payment request
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentOptions {
   /**
@@ -1481,6 +1490,7 @@ export interface PaymentOptions {
 
 /**
  * A request to make a payment
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentRequest {
   /**
@@ -1508,6 +1518,7 @@ export interface PaymentRequest {
 /**
  * A PaymentResponse is returned when a user has selected a payment method and approved a payment
  * request
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentResponse {
   /**
@@ -1545,6 +1556,7 @@ export interface PaymentResponse {
 
 /**
  * Payload delivered when completing a payment request
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentRequestComplete {
   /**
@@ -1563,6 +1575,7 @@ export interface PaymentRequestComplete {
 
 /**
  * Result from a completed payment request
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentRequestCompleteResult {
   /**
@@ -1573,6 +1586,7 @@ export interface PaymentRequestCompleteResult {
 
 /**
  * An update to a payment request
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentRequestUpdate {
   /**
@@ -1595,6 +1609,7 @@ export interface PaymentRequestUpdate {
 
 /**
  * A result object from a Payment Request Update invoke operation
+ * @deprecated Bot Framework no longer supports payments
  */
 export interface PaymentRequestUpdateResult {
   /**
@@ -1690,7 +1705,7 @@ export enum InputHints {
 /**
  * Defines values for ActionTypes.
  * Possible values include: 'openUrl', 'imBack', 'postBack', 'playAudio', 'playVideo', 'showImage',
- * 'downloadFile', 'signin', 'call', 'payment', 'messageBack', 'openApp'
+ * 'downloadFile', 'signin', 'call', messageBack', 'openApp'
  * @readonly
  * @enum {string}
  */
@@ -1704,6 +1719,7 @@ export enum ActionTypes {
   DownloadFile = 'downloadFile',
   Signin = 'signin',
   Call = 'call',
+  // @deprecated Bot Framework no longer supports payments
   Payment = 'payment',
   MessageBack = 'messageBack',
   OpenApp = 'openApp',