summaryrefslogtreecommitdiffstats
path: root/dom/webidl/PaymentRequest.webidl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 00:47:55 +0000
commit26a029d407be480d791972afb5975cf62c9360a6 (patch)
treef435a8308119effd964b339f76abb83a57c29483 /dom/webidl/PaymentRequest.webidl
parentInitial commit. (diff)
downloadfirefox-26a029d407be480d791972afb5975cf62c9360a6.tar.xz
firefox-26a029d407be480d791972afb5975cf62c9360a6.zip
Adding upstream version 124.0.1.upstream/124.0.1
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'dom/webidl/PaymentRequest.webidl')
-rw-r--r--dom/webidl/PaymentRequest.webidl132
1 files changed, 132 insertions, 0 deletions
diff --git a/dom/webidl/PaymentRequest.webidl b/dom/webidl/PaymentRequest.webidl
new file mode 100644
index 0000000000..b9021e0b06
--- /dev/null
+++ b/dom/webidl/PaymentRequest.webidl
@@ -0,0 +1,132 @@
+/* -*- Mode: IDL; tab-width: 2; indent-tabs-mode: nil; c-basic-offset: 2 -*- */
+/* This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this file,
+ * You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * The origin of this WebIDL file is
+ * https://w3c.github.io/payment-request/#paymentrequest-interface
+ * https://w3c.github.io/payment-request/#idl-index
+ *
+ * Copyright © 2018 W3C® (MIT, ERCIM, Keio), All Rights Reserved. W3C
+ * liability, trademark and document use rules apply.
+ */
+
+dictionary PaymentMethodData {
+ required DOMString supportedMethods;
+ object data;
+};
+
+dictionary PaymentCurrencyAmount {
+ required DOMString currency;
+ required DOMString value;
+};
+
+dictionary PaymentItem {
+ required DOMString label;
+ required PaymentCurrencyAmount amount;
+ boolean pending = false;
+};
+
+dictionary PaymentShippingOption {
+ required DOMString id;
+ required DOMString label;
+ required PaymentCurrencyAmount amount;
+ boolean selected = false;
+};
+
+dictionary PaymentDetailsModifier {
+ required DOMString supportedMethods;
+ PaymentItem total;
+ sequence<PaymentItem> additionalDisplayItems;
+ object data;
+};
+
+dictionary PaymentDetailsBase {
+ sequence<PaymentItem> displayItems;
+ sequence<PaymentShippingOption> shippingOptions;
+ sequence<PaymentDetailsModifier> modifiers;
+};
+
+dictionary PaymentDetailsInit : PaymentDetailsBase {
+ DOMString id;
+ required PaymentItem total;
+};
+
+[GenerateInitFromJSON, GenerateToJSON]
+dictionary AddressErrors {
+ DOMString addressLine;
+ DOMString city;
+ DOMString country;
+ DOMString dependentLocality;
+ DOMString organization;
+ DOMString phone;
+ DOMString postalCode;
+ DOMString recipient;
+ DOMString region;
+ DOMString regionCode;
+ DOMString sortingCode;
+};
+
+dictionary PaymentValidationErrors {
+ PayerErrors payer;
+ AddressErrors shippingAddress;
+ DOMString error;
+ object paymentMethod;
+};
+
+[GenerateInitFromJSON, GenerateToJSON]
+dictionary PayerErrors {
+ DOMString email;
+ DOMString name;
+ DOMString phone;
+};
+
+dictionary PaymentDetailsUpdate : PaymentDetailsBase {
+ DOMString error;
+ AddressErrors shippingAddressErrors;
+ PayerErrors payerErrors;
+ object paymentMethodErrors;
+ PaymentItem total;
+};
+
+enum PaymentShippingType {
+ "shipping",
+ "delivery",
+ "pickup"
+};
+
+dictionary PaymentOptions {
+ boolean requestPayerName = false;
+ boolean requestPayerEmail = false;
+ boolean requestPayerPhone = false;
+ boolean requestShipping = false;
+ boolean requestBillingAddress = false;
+ PaymentShippingType shippingType = "shipping";
+};
+
+[SecureContext,
+ Func="mozilla::dom::PaymentRequest::PrefEnabled",
+ Exposed=Window]
+interface PaymentRequest : EventTarget {
+ [Throws]
+ constructor(sequence<PaymentMethodData> methodData,
+ PaymentDetailsInit details,
+ optional PaymentOptions options = {});
+
+ [NewObject]
+ Promise<PaymentResponse> show(optional Promise<PaymentDetailsUpdate> detailsPromise);
+ [NewObject]
+ Promise<undefined> abort();
+ [NewObject]
+ Promise<boolean> canMakePayment();
+
+ readonly attribute DOMString id;
+ readonly attribute PaymentAddress? shippingAddress;
+ readonly attribute DOMString? shippingOption;
+ readonly attribute PaymentShippingType? shippingType;
+
+ attribute EventHandler onmerchantvalidation;
+ attribute EventHandler onshippingaddresschange;
+ attribute EventHandler onshippingoptionchange;
+ attribute EventHandler onpaymentmethodchange;
+};