@types/applepayjs - npm Package Compare versions

Comparing version 14.0.5 to 14.0.6

applepayjs/index.d.ts

@@ -329,5 +329,5 @@ /**
         /**
-         * The [ISO 8601 formatted] date of the first payment.
+         * The date of the first payment.
          */
-        recurringPaymentStartDate?: string;
+        recurringPaymentStartDate?: Date;
 
@@ -345,10 +345,10 @@ /**
         /**
-         * The [ISO 8601 formatted] date of the final payment.
+         * The date of the final payment.
          */
-        recurringPaymentEndDate?: string;
+        recurringPaymentEndDate?: Date;
 
         /**
-         * The [ISO 8601 formatted] date, in the future, of the payment.
+         * The date, in the future, of the payment.
          */
-        deferredPaymentDate?: string;
+        deferredPaymentDate?: Date;
 
@@ -473,2 +473,3 @@ /**
      * The result of payment authorization, including status and errors.
+     * See more: https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypaymentauthorizationresult
      */
@@ -485,4 +486,28 @@ interface ApplePayPaymentAuthorizationResult {
         errors?: ApplePayError[] | undefined;
+
+        /**
+         * Optional metadata for an order that the customer placed using this payment method.
+         */
+        orderDetails?: ApplePayPaymentOrderDetails;
     }
 
+    interface ApplePayPaymentOrderDetails {
+        /**
+         * An identifier for the order type associated with the order.
+         */
+        orderTypeIdentifier: string;
+        /**
+         * A unique order identifier scoped to your order type identifier.
+         */
+        orderIdentifier: string;
+        /**
+         * The URL of your web service.
+         */
+        webServiceURL: string;
+        /**
+         * The authentication token supplied to your web service.
+         */
+        authenticationToken: string;
+    }
+
     /**
@@ -614,10 +639,10 @@ * Encapsulates contact information needed for billing and shipping.
         /**
-         * An optional list of line items.
+         * The new total resulting from a change in the payment method.
          */
-        newLineItems?: ApplePayLineItem[] | undefined;
+        newTotal: ApplePayLineItem;
 
         /**
-         * The new total resulting from a change in the payment method.
+         * An optional list of updated line items for the payment request that results from the user’s change to the payment method.
          */
-        newTotal: ApplePayLineItem;
+        newLineItems?: ApplePayLineItem[] | undefined;
 
@@ -640,2 +665,7 @@ /**
         /**
+         * An updated request for a deferred payment.
+         */
+        newDeferredPaymentRequest?: ApplePayDeferredPaymentRequest;
+
+        /**
          * A list of customized errors you provide that results from the user's change to the payment method.
@@ -708,5 +738,17 @@ */
      * Encapsulates a request for payment, including information about payment processing capabilities, the payment amount, and shipping information.
+     * See more: https://developer.apple.com/documentation/apple_pay_on_the_web/applepaypaymentrequest
      */
     interface ApplePayPaymentRequest {
         /**
+         * An array of the payment capabilities that the merchant supports, such as credit or debit.
+         * The value must at least contain ApplePayMerchantCapability.supports3DS.
+         */
+        merchantCapabilities: ApplePayMerchantCapability[];
+
+        /**
+         * The payment networks supported by the merchant.
+         */
+        supportedNetworks: string[];
+
+        /**
          * The merchant's two-letter ISO 3166 country code.
@@ -717,53 +759,62 @@ */
         /**
-         * The three-letter ISO 4217 currency code for the payment.
+         * The billing information that you require from the user in order to process the transaction.
          */
-        currencyCode: string;
+        requiredBillingContactFields?: ApplePayContactField[] | undefined;
 
         /**
-         * A set of line items that explain recurring payments and/or additional charges.
+         * Billing contact information for the user.
          */
-        lineItems?: ApplePayLineItem[] | undefined;
+        billingContact?: ApplePayPaymentContact | undefined;
 
         /**
-         * The payment capabilities supported by the merchant.
-         * The value must at least contain ApplePayMerchantCapability.supports3DS.
+         * The shipping information that you require from the user in order to fulfill the order.
          */
-        merchantCapabilities: ApplePayMerchantCapability[];
+        requiredShippingContactFields?: ApplePayContactField[] | undefined;
 
         /**
-         * The payment networks supported by the merchant.
+         * Shipping contact information for the user.
          */
-        supportedNetworks: string[];
+        shippingContact?: ApplePayPaymentContact | undefined;
 
         /**
-         * A line item representing the total for the payment.
+         * Optional user-defined data.
          */
-        total: ApplePayLineItem;
+        applicationData?: string | undefined;
 
         /**
-         * Billing contact information for the user.
+         * A list of ISO 3166 country codes for limiting payments to cards from specific countries.
          */
-        billingContact?: ApplePayPaymentContact | undefined;
+        supportedCountries?: string[] | undefined;
 
         /**
-         * The billing information that you require from the user in order to process the transaction.
+         * A Boolean value that determines whether the payment sheet displays the coupon code field.
          */
-        requiredBillingContactFields?: ApplePayContactField[] | undefined;
+        supportsCouponCode?: boolean | undefined;
 
         /**
-         * The shipping information that you require from the user in order to fulfill the order.
+         * The initial coupon code for the payment request.
          */
-        requiredShippingContactFields?: ApplePayContactField[] | undefined;
+        couponCode?: string | undefined;
 
         /**
-         * Shipping contact information for the user.
+         * A value that indicates whether the shipping mode prevents the user from editing the shipping address.
          */
-        shippingContact?: ApplePayPaymentContact | undefined;
+        shippingContactEditingMode?: ApplePayShippingContactEditingMode;
 
         /**
-         * A set of shipping method objects that describe the available shipping methods.
+         * A line item representing the total for the payment.
          */
-        shippingMethods?: ApplePayShippingMethod[] | undefined;
+        total: ApplePayLineItem;
 
         /**
+         * A set of line items that explain recurring payments and/or additional charges.
+         */
+        lineItems?: ApplePayLineItem[] | undefined;
+
+        /**
+         * The three-letter ISO 4217 currency code for the payment.
+         */
+        currencyCode: string;
+
+        /**
          * How the items are to be shipped.
@@ -774,12 +825,17 @@ */
         /**
-         * A list of ISO 3166 country codes for limiting payments to cards from specific countries.
+         * A set of shipping method objects that describe the available shipping methods.
          */
-        supportedCountries?: string[] | undefined;
+        shippingMethods?: ApplePayShippingMethod[] | undefined;
 
         /**
-         * Optional user-defined data.
+         * An array of payment token contexts that requests multiple payment tokens to support a multimerchant payment.
          */
-        applicationData?: string | undefined;
+        multiTokenContexts?: ApplePayPaymentTokenContext[];
 
         /**
+         * A property that requests an automatic reload payment, such as a store card top-up.
+         */
+        automaticReloadPaymentRequest?: ApplePayAutomaticReloadPaymentRequest;
+
+        /**
          * This property is optional. Use it to indicate that the payment request is for a recurring payment.
@@ -796,15 +852,5 @@ * Apple Pay issues an Apple Pay Merchant Token if the user’s payment network supports merchant-specific payment tokens.
         /**
-         * A property that requests an automatic reload payment, such as a store card top-up.
+         * A property that requests a deferred payment, such as a hotel booking or a pre-order.
          */
-        automaticReloadPaymentRequest?: ApplePayAutomaticReloadPaymentRequest;
-
-        /**
-         * An array of payment token contexts that requests multiple payment tokens to support a multimerchant payment.
-         */
-        multiTokenContexts?: ApplePayPaymentTokenContext[];
-
-        /**
-         * A Boolean value that determines whether the payment sheet displays the coupon code field.
-         */
-        supportsCouponCode?: boolean | undefined;
+        deferredPaymentRequest?: ApplePayDeferredPaymentRequest;
     }
@@ -928,2 +974,20 @@
     /**
+     * A value that indicates whether the shipping mode prevents the user from editing the shipping address.
+     */
+    type ApplePayShippingContactEditingMode =
+        /**
+         * The user can edit the shipping contact on the payment sheet.
+         */
+        | "available"
+        /**
+         * The user can’t edit the shipping contact on the payment sheet.
+         */
+        | "storePickup"
+        /**
+         * The user can edit the shipping contact on the payment sheet.
+         * @deprecated Use ApplePayShippingContactEditingMode.available instead.
+         */
+        | "enabled";
+
+    /**
      * Use ApplePayPaymentTokenContext to authorize a payment amount for each payment token in a multimerchant payment request.
@@ -993,8 +1057,9 @@ * To enable multiple merchants for a transaction, use one ApplePayPaymentTokenContext object for each merchant.
      * Updated transaction details resulting from a change in shipping contact, including any errors.
+     * See more: https://developer.apple.com/documentation/apple_pay_on_the_web/applepayshippingcontactupdate
      */
     class ApplePayShippingContactUpdate {
         /**
-         * List of custom errors to display on the payment sheet.
+         * The new total resulting from a change in the shipping contact.
          */
-        errors?: ApplePayError[] | undefined;
+        newTotal: ApplePayLineItem;
 
@@ -1007,10 +1072,30 @@ /**
         /**
-         * A list of shipping methods that are available to the updated shipping contact.
+         * An array of updated multitoken contexts for a multimerchant payment request.
          */
-        newShippingMethods?: ApplePayShippingMethod[] | undefined;
+        newMultiTokenContexts?: ApplePayPaymentTokenContext[];
 
         /**
-         * The new total resulting from a change in the shipping contact.
+         * An updated request for an automatic reload payment.
          */
-        newTotal: ApplePayLineItem;
+        newAutomaticReloadPaymentRequest?: ApplePayAutomaticReloadPaymentRequest;
+
+        /**
+         * An updated request for a recurring payment.
+         */
+        newRecurringPaymentRequest?: ApplePayRecurringPaymentRequest;
+
+        /**
+         * An updated request for a deferred payment.
+         */
+        newDeferredPaymentRequest?: ApplePayDeferredPaymentRequest;
+
+        /**
+         * List of custom errors to display on the payment sheet.
+         */
+        errors?: ApplePayError[] | undefined;
+
+        /**
+         * A list of shipping methods that are available to the updated shipping contact.
+         */
+        newShippingMethods?: ApplePayShippingMethod[] | undefined;
     }
@@ -1102,5 +1187,11 @@
      * Updated transaction details resulting from a change in shipping method.
+     * See more: https://developer.apple.com/documentation/apple_pay_on_the_web/applepayshippingmethodupdate
      */
     interface ApplePayShippingMethodUpdate {
         /**
+         * The new total resulting from a change in the shipping method.
+         */
+        newTotal: ApplePayLineItem;
+
+        /**
          * An optional list of updated line items.
@@ -1111,5 +1202,25 @@ */
         /**
-         * The new total resulting from a change in the shipping method.
+         * An array of updated multitoken contexts for a multimerchant payment request.
          */
-        newTotal: ApplePayLineItem;
+        newMultiTokenContexts?: ApplePayPaymentTokenContext[];
+
+        /**
+         * An updated request for an automatic reload payment.
+         */
+        newAutomaticReloadPaymentRequest?: ApplePayAutomaticReloadPaymentRequest;
+
+        /**
+         * An updated request for a recurring payment.
+         */
+        newRecurringPaymentRequest?: ApplePayRecurringPaymentRequest;
+
+        /**
+         * An updated request for a deferred payment.
+         */
+        newDeferredPaymentRequest?: ApplePayDeferredPaymentRequest;
+
+        /**
+         * The updated list of available shipping methods that results from the user's change to the payment method.
+         */
+        newShippingMethods?: ApplePayShippingMethod[];
     }
@@ -1119,13 +1230,14 @@
      * The attributes contained by the oncouponcodechanged callback function.
+     * See more: https://developer.apple.com/documentation/apple_pay_on_the_web/applepaycouponcodeupdate
      */
     abstract class ApplePayCouponCodeUpdate {
         /**
-         * An optional list of line items.
+         * The new total resulting from a change in the payment method.
          */
-        newLineItems?: ApplePayLineItem[] | undefined;
+        newTotal: ApplePayLineItem;
 
         /**
-         * The new total resulting from a change in the payment method.
+         * An optional list of line items.
          */
-        newTotal: ApplePayLineItem;
+        newLineItems?: ApplePayLineItem[] | undefined;
 
@@ -1132,0 +1244,0 @@ /**

applepayjs/package.json

 {
     "name": "@types/applepayjs",
-    "version": "14.0.5",
+    "version": "14.0.6",
     "description": "TypeScript definitions for applepayjs",
@@ -23,5 +23,5 @@ "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/applepayjs",
     "dependencies": {},
-    "typesPublisherContentHash": "ab41eb042c4230cdf440d2fb9d35209b519e3fe2881a4eec4bc002bfb656fecb",
+    "typesPublisherContentHash": "3ebe48638c5ba84c17548fd0fb13e9ca78f79fb4023d72ebe7d5bdd47dcd9efe",
     "typeScriptVersion": "4.6",
     "nonNpm": true
 }

applepayjs/README.md

@@ -11,3 +11,3 @@ # Installation
 ### Additional Details
- * Last updated: Thu, 15 Feb 2024 12:09:10 GMT
+ * Last updated: Fri, 16 Feb 2024 17:35:23 GMT
  * Dependencies: none
@@ -14,0 +14,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

46623

increased by9.58%

Lines of code

1140

increased by9.2%

No dependency changes