@paydock/client-sdk 1.121.0 → 1.122.2-beta

package/README.md

@@ -6812,6 +6812,9 @@ A full description of the meta parameters for [PaypalWalletButtonExpress](#Paypa
 <dt><a href="#EVENT">EVENT</a> : <code>object</code></dt>
 <dd><p>List of available event&#39;s name in the wallet button lifecycle</p>
 </dd>
+<dt><a href="#ContactFieldType">ContactFieldType</a> : <code>object</code></dt>
+<dd><p>List of available contact fields for ContactFieldType</p>
+</dd>
 </dl>
 
 ## Typedefs
@@ -6832,6 +6835,12 @@ A full description of the meta parameters for [PaypalWalletButtonExpress](#Paypa
 <dt><a href="#OnCheckoutCloseCallback">OnCheckoutCloseCallback</a> : <code>function</code></dt>
 <dd><p>Callback for onCheckoutClose method.</p>
 </dd>
+<dt><a href="#OnShippingAddressChangeCallback">OnShippingAddressChangeCallback</a> ⇒ <code><a href="#OnShippingAddressChangeEventResponse">Promise.&lt;OnShippingAddressChangeEventResponse&gt;</a></code></dt>
+<dd><p>Callback for onShippingAddressChange method.</p>
+</dd>
+<dt><a href="#OnShippingOptionsChangeCallback">OnShippingOptionsChangeCallback</a> ⇒ <code><a href="#OnShippingOptionChangeEventResponse">Promise.&lt;OnShippingOptionChangeEventResponse&gt;</a></code></dt>
+<dd><p>Callback for onShippingOptionsChange method.</p>
+</dd>
 <dt><a href="#OnUnavailableCallback">OnUnavailableCallback</a> : <code>function</code></dt>
 <dd><p>Callback for onUnavailable method.</p>
 </dd>
@@ -6874,6 +6883,25 @@ For in-depth information, please refer to the <a href="https://developer.paypal.
 <dt><a href="#OnErrorEventData">OnErrorEventData</a> : <code>object</code></dt>
 <dd><p>Interface for OnErrorEventData</p>
 </dd>
+<dt><a href="#OnShippingAddressChangeEventData">OnShippingAddressChangeEventData</a> : <code>object</code></dt>
+<dd><p>Interface for OnShippingAddressChangeEventData.</p>
+</dd>
+<dt><a href="#OnShippingAddressChangeEventResponse">OnShippingAddressChangeEventResponse</a> : <code>object</code></dt>
+<dd><p>Interface for OnShippingAddressChangeEventResponse.</p>
+</dd>
+<dt><a href="#IApplePayShippingOption">IApplePayShippingOption</a> : <code>object</code></dt>
+<dd><p>Interface for IApplePayShippingOption.
+Used for adding new shippings options when customer updates the shipping address.</p>
+</dd>
+<dt><a href="#OnShippingOptionChangeEventData">OnShippingOptionChangeEventData</a> : <code>object</code></dt>
+<dd><p>Interface for OnShippingOptionChangeEventData.</p>
+</dd>
+<dt><a href="#OnShippingOptionChangeEventResponse">OnShippingOptionChangeEventResponse</a> : <code>object</code></dt>
+<dd><p>Interface for OnShippingOptionChangeEventResponse.</p>
+</dd>
+<dt><a href="#IApplePayError">IApplePayError</a> : <code>object</code></dt>
+<dd><p>Interface for IApplePayError.</p>
+</dd>
 </dl>
 
 <a name="ApplePayWalletMeta" id="ApplePayWalletMeta" href="#ApplePayWalletMeta">&nbsp;</a>
@@ -6895,11 +6923,14 @@ If the determinated value is credentials_status_unknown, the payment possbily sh
 | [merchant_capabilities] | <code>Array.&lt;(&#x27;supports3DS&#x27;\|&#x27;supportsEMV&#x27;\|&#x27;supportsCredit&#x27;\|&#x27;supportsDebit&#x27;)&gt;</code> | Array of capabilities that the merchant supports, influencing the transaction processing features available. |
 | [supported_networks] | <code>Array.&lt;(&#x27;visa&#x27;\|&#x27;masterCard&#x27;\|&#x27;amex&#x27;\|&#x27;chinaUnionPay&#x27;\|&#x27;discover&#x27;\|&#x27;interac&#x27;\|&#x27;jcb&#x27;\|&#x27;privateLabel&#x27;)&gt;</code> | List of payment networks supported by the merchant for ApplePay transactions. |
 | [required_billing_contact_fields] | <code>Array.&lt;(&#x27;email&#x27;\|&#x27;name&#x27;\|&#x27;phone&#x27;\|&#x27;postalAddress&#x27;)&gt;</code> | Contact fields required from the user for billing purposes, improving transaction verification and fraud prevention. Phone and email are currently not returned by Apple. |
-| [required_shipping_contact_fields] | <code>Array.&lt;(&#x27;email&#x27;\|&#x27;phone&#x27;)&gt;</code> | Shipping contact fields that are mandatory to complete the transaction. Use email and phone to collect from customer wallet in the abscense of billing one. |
+| [required_shipping_contact_fields] | <code>Array.&lt;(&#x27;email&#x27;\|&#x27;phone&#x27;)&gt;</code> | Shipping contact fields that are mandatory to complete the transaction. Use email and phone to collect from customer wallet in the abscense of billing one. Required for onShippingAddressChange callback. |
 | [supported_countries] | <code>Array.&lt;string&gt;</code> | List of countries where ApplePay is supported by the merchant, restricting usage to specified regions. |
 | [style] | <code>object</code> | Styling configuration for ApplePay buttons displayed during checkout. |
 | [style.button_type] | <code>ApplePayButtonType</code> | Enum type to select the type of ApplePay button (e.g., 'buy', 'donate', etc.), providing user interface customization. |
 | [style.button_style] | <code>ApplePayButtonStyle</code> | Style applied to the ApplePay button, which can include color and form factor adjustments according to the brand's visual guidelines. |
+| [shipping_editing_mode] | <code>&#x27;available&#x27;</code> \| <code>&#x27;store\_pickup&#x27;</code> | ApplePay - available for allowing editing shipping, store_pickup for not allowing editing shipping. |
+| [shipping_data] | <code>object</code> | ApplePay - Preloaded data used for populate shipping address information |
+| [shipping_data.email_address] | <code>string</code> | ApplePay - The shipping address email |
 | [apple_pay_capabilities] | <code>Array.&lt;(&#x27;credentials\_available&#x27;\|&#x27;credentials\_status\_unknown&#x27;\|&#x27;credentials\_unavailable&#x27;)&gt;</code> | Device capabilities needed for wallet button to be available. |
 
 <a name="PaypalWalletMeta" id="PaypalWalletMeta" href="#PaypalWalletMeta">&nbsp;</a>
@@ -7032,6 +7063,115 @@ Interface for OnErrorEventData
 | [chargeId] | <code>string</code> | chargeId in case it's already set after onClick event |
 | [data] | <code>Error</code> | Error object if present |
 
+<a name="OnShippingAddressChangeEventData" id="OnShippingAddressChangeEventData" href="#OnShippingAddressChangeEventData">&nbsp;</a>
+
+## OnShippingAddressChangeEventData : <code>object</code>
+Interface for OnShippingAddressChangeEventData.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event Name is 'onShippingAddressChange' |
+| chargeId | <code>string</code> | chargeId set after onClick event |
+| data.address_city | <code>string</code> | PayPal and ApplePay - Shipping address city |
+| data.address_state | <code>string</code> | PayPal and ApplePay - Shipping address state |
+| data.address_postcode | <code>string</code> | PayPal and ApplePay - Shipping address postcode |
+| data.address_country | <code>string</code> | PayPal and ApplePay - Shipping address country code |
+| [data.address_line1] | <code>string</code> | ApplePay - Shipping address line 1 |
+| [data.address_line2] | <code>string</code> | ApplePay - Shipping address line 2 |
+| [data.contact.phone] | <code>string</code> | ApplePay - Shipping contact phone |
+| [data.contact.email] | <code>string</code> | ApplePay - Shipping contact email |
+| [data.contact.first_name] | <code>string</code> | ApplePay - Shipping contact first name |
+| [data.contact.last_name] | <code>string</code> | ApplePay - Shipping contact last name |
+
+<a name="OnShippingAddressChangeEventResponse" id="OnShippingAddressChangeEventResponse" href="#OnShippingAddressChangeEventResponse">&nbsp;</a>
+
+## OnShippingAddressChangeEventResponse : <code>object</code>
+Interface for OnShippingAddressChangeEventResponse.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [token] | <code>string</code> | Updated Wallet Token if any |
+| [label] | <code>string</code> | ApplePay - Required. Label to show to the customer. |
+| [amount] | <code>string</code> | ApplePay - Required. New amount for shipping option. |
+| [error] | <code>string</code> | PayPal and ApplePay - Error object in case of error when processing shipping address in if new address unsupported or any other possible error. |
+| error.code | <code>string</code> | PayPal and ApplePay - Error code, mandatory in case of error. Possible values for Paypal are 'address_error', 'country_error', 'state_error', 'zip_error' or any other string if none applies. For ApplePay values are 'address_error', 'shipping_contact_invalid' and 'billing_contact_invalid'. |
+| [error.field] | <code>string</code> | ApplePay - Error field in case of specifically showing it. Possible values for Apple Pay are 'phone', 'email', 'name', 'phonetic_name', 'address_lines', 'locality', 'postal_code', 'administrative_area', 'country', 'country_code'. |
+| [error.message] | <code>string</code> | ApplePay - Custom user facing error message. |
+
+<a name="IApplePayShippingOption" id="IApplePayShippingOption" href="#IApplePayShippingOption">&nbsp;</a>
+
+## IApplePayShippingOption : <code>object</code>
+Interface for IApplePayShippingOption.
+Used for adding new shippings options when customer updates the shipping address.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [id] | <code>string</code> | Updated Wallet Token if any |
+| [label] | <code>string</code> | ApplePay - Required. Label to show to the customer. |
+| [amount] | <code>string</code> | ApplePay - Required. New amount for shipping option. |
+| [detail] | <code>string</code> | ApplePay - Optional detail for shipping option. |
+| [date_components_range] | <code>object</code> | ApplePay - Object that contains the dates for shipping |
+| [date_components_range.start_date_components] | <code>object</code> | ApplePay - Contains the start date object |
+| [date_components_range.start_date_components.years] | <code>string</code> | ApplePay - Contains the start date year |
+| [date_components_range.start_date_components.months] | <code>string</code> | ApplePay - Contains the start date month |
+| [date_components_range.start_date_components.days] | <code>string</code> | ApplePay - Contains the start date day |
+| [date_components_range.start_date_components.hours] | <code>string</code> | ApplePay - Contains the start date hour |
+| [date_components_range.end_date_components] | <code>object</code> | ApplePay - Contains the end date year |
+| [date_components_range.end_date_components.years] | <code>string</code> | ApplePay - Contains the end date year |
+| [date_components_range.end_date_components.months] | <code>string</code> | ApplePay - Contains the end date month |
+| [date_components_range.end_date_components.days] | <code>string</code> | ApplePay - Contains the end date day |
+| [date_components_range.end_date_components.hours] | <code>string</code> | ApplePay - Contains the end date hour |
+
+<a name="OnShippingOptionChangeEventData" id="OnShippingOptionChangeEventData" href="#OnShippingOptionChangeEventData">&nbsp;</a>
+
+## OnShippingOptionChangeEventData : <code>object</code>
+Interface for OnShippingOptionChangeEventData.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| event | <code>string</code> | Event Name is 'onShippingOptionsChange' |
+| chargeId | <code>string</code> | chargeId set after onClick event |
+| [data.shipping_option_id] | <code>string</code> | PayPal and ApplePay - Selected shipping option id |
+| [data.amount] | <code>string</code> | Paypal and ApplePay - Selected shipping option amount |
+| [data.label] | <code>string</code> | ApplePay - Selected shipping option label |
+| [data.detail] | <code>string</code> | ApplePay - Selected shipping option detail |
+
+<a name="OnShippingOptionChangeEventResponse" id="OnShippingOptionChangeEventResponse" href="#OnShippingOptionChangeEventResponse">&nbsp;</a>
+
+## OnShippingOptionChangeEventResponse : <code>object</code>
+Interface for OnShippingOptionChangeEventResponse.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [token] | <code>string</code> | Updated Wallet Token if any |
+| [label] | <code>string</code> | ApplePay - Required. Label to show to the customer. |
+| [amount] | <code>string</code> | ApplePay - Required. New amount for shipping option. |
+| [error] | <code>string</code> | PayPal - Error object in case of error when processing shipping option selection. |
+| error.code | <code>string</code> | Possible values for Paypal are 'method_unavailable', 'store_unavailable' or any other string if none applies. |
+
+<a name="IApplePayError" id="IApplePayError" href="#IApplePayError">&nbsp;</a>
+
+## IApplePayError : <code>object</code>
+Interface for IApplePayError.
+
+**Kind**: global interface  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| code | <code>&#x27;shipping\_contact\_invalid&#x27;</code> \| <code>&#x27;billing\_contact\_invalid&#x27;</code> \| <code>&#x27;address\_unserviceable&#x27;</code> \| <code>&#x27;coupon\_code\_invalid&#x27;</code> \| <code>&#x27;coupon\_code\_expired&#x27;</code> \| <code>&#x27;unknown&#x27;</code> | The error code for this instance. |
+| contact_field | [<code>ContactFieldType</code>](#ContactFieldType) | The error code for this instance. |
+| message | <code>string</code> \| <code>undefined</code> | TA localized, user-facing string that describes the error. |
+
 <a name="ApplePayWalletButtonExpress" id="ApplePayWalletButtonExpress" href="#ApplePayWalletButtonExpress">&nbsp;</a>
 
 ## ApplePayWalletButtonExpress ⇐ <code>BaseWalletButton</code>
@@ -7050,6 +7190,8 @@ Class ApplePayWalletButtonExpress to work with Apple Pay Wallet.
     * [.onPaymentInReview([handler])](#BaseWalletButton+onPaymentInReview)
     * [.onPaymentError([handler])](#BaseWalletButton+onPaymentError)
     * [.onCheckoutClose(handler)](#BaseWalletButton+onCheckoutClose)
+    * [.onShippingAddressChange([handler])](#BaseWalletButton+onShippingAddressChange)
+    * [.onShippingOptionsChange([handler])](#BaseWalletButton+onShippingOptionsChange)
     * [.onUnavailable(handler)](#BaseWalletButton+onUnavailable)
     * [.onError(handler)](#BaseWalletButton+onError)
 
@@ -7226,6 +7368,52 @@ button.onCheckoutClose(() => {
      console.log('Wallet checkout closes');
 });
 ```
+<a name="BaseWalletButton+onShippingAddressChange" id="BaseWalletButton+onShippingAddressChange" href="#BaseWalletButton+onShippingAddressChange">&nbsp;</a>
+
+### applePayWalletButtonExpress.onShippingAddressChange([handler])
+If shipping address data is updated, the function passed as parameter will be called.
+Use this method to listen for shipping address selection or input from customer when shipping is enabled.
+The event handler needs to return a new token in case a backend to backend wallet update call was executed.
+In addition, if any error occured, an error string must be supplied.
+By default, the event handler will be processed successfuly if neither token nor error is returned.
+
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)  
+**Overrides**: [<code>onShippingAddressChange</code>](#BaseWalletButton+onShippingAddressChange)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnShippingAddressChangeCallback</code>](#OnShippingAddressChangeCallback) | Function to be called when the shipping address data is updated. |
+
+**Example**  
+```js
+button.onShippingAddressChange((data) => {
+    const responseData = await fetch('https://your-server.com/update-shipping-info');
+    return { error: null, token: responseData.walletToken };
+});
+```
+<a name="BaseWalletButton+onShippingOptionsChange" id="BaseWalletButton+onShippingOptionsChange" href="#BaseWalletButton+onShippingOptionsChange">&nbsp;</a>
+
+### applePayWalletButtonExpress.onShippingOptionsChange([handler])
+If shipping options data is updated, the function passed as parameter will be called.
+Use this method to listen for shipping option selection from customer when shipping is enabled.
+The event handler needs to return a new token in case a backend to backend wallet update call was executed.
+In addition, if any error occured, an error string must be supplied.
+By default, the event handler will be processed successfuly if neither token nor error is returned.
+
+**Kind**: instance method of [<code>ApplePayWalletButtonExpress</code>](#ApplePayWalletButtonExpress)  
+**Overrides**: [<code>onShippingOptionsChange</code>](#BaseWalletButton+onShippingOptionsChange)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnShippingOptionsChangeCallback</code>](#OnShippingOptionsChangeCallback) | Function to be called when the shipping options data is updated. |
+
+**Example**  
+```js
+button.onShippingOptionsChange((data) => {
+    const responseData = await fetch('https://your-server.com/update-shipping-info');
+    return { error: null, token: responseData.walletToken };
+});
+```
 <a name="BaseWalletButton+onUnavailable" id="BaseWalletButton+onUnavailable" href="#BaseWalletButton+onUnavailable">&nbsp;</a>
 
 ### applePayWalletButtonExpress.onUnavailable(handler)
@@ -7281,6 +7469,8 @@ Class PaypalWalletButtonExpress to work with Paypal Wallet.
     * [.onPaymentInReview([handler])](#BaseWalletButton+onPaymentInReview)
     * [.onPaymentError([handler])](#BaseWalletButton+onPaymentError)
     * [.onCheckoutClose(handler)](#BaseWalletButton+onCheckoutClose)
+    * [.onShippingAddressChange([handler])](#BaseWalletButton+onShippingAddressChange)
+    * [.onShippingOptionsChange([handler])](#BaseWalletButton+onShippingOptionsChange)
     * [.onUnavailable(handler)](#BaseWalletButton+onUnavailable)
     * [.onError(handler)](#BaseWalletButton+onError)
 
@@ -7457,6 +7647,52 @@ button.onCheckoutClose(() => {
      console.log('Wallet checkout closes');
 });
 ```
+<a name="BaseWalletButton+onShippingAddressChange" id="BaseWalletButton+onShippingAddressChange" href="#BaseWalletButton+onShippingAddressChange">&nbsp;</a>
+
+### paypalWalletButtonExpress.onShippingAddressChange([handler])
+If shipping address data is updated, the function passed as parameter will be called.
+Use this method to listen for shipping address selection or input from customer when shipping is enabled.
+The event handler needs to return a new token in case a backend to backend wallet update call was executed.
+In addition, if any error occured, an error string must be supplied.
+By default, the event handler will be processed successfuly if neither token nor error is returned.
+
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)  
+**Overrides**: [<code>onShippingAddressChange</code>](#BaseWalletButton+onShippingAddressChange)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnShippingAddressChangeCallback</code>](#OnShippingAddressChangeCallback) | Function to be called when the shipping address data is updated. |
+
+**Example**  
+```js
+button.onShippingAddressChange((data) => {
+    const responseData = await fetch('https://your-server.com/update-shipping-info');
+    return { error: null, token: responseData.walletToken };
+});
+```
+<a name="BaseWalletButton+onShippingOptionsChange" id="BaseWalletButton+onShippingOptionsChange" href="#BaseWalletButton+onShippingOptionsChange">&nbsp;</a>
+
+### paypalWalletButtonExpress.onShippingOptionsChange([handler])
+If shipping options data is updated, the function passed as parameter will be called.
+Use this method to listen for shipping option selection from customer when shipping is enabled.
+The event handler needs to return a new token in case a backend to backend wallet update call was executed.
+In addition, if any error occured, an error string must be supplied.
+By default, the event handler will be processed successfuly if neither token nor error is returned.
+
+**Kind**: instance method of [<code>PaypalWalletButtonExpress</code>](#PaypalWalletButtonExpress)  
+**Overrides**: [<code>onShippingOptionsChange</code>](#BaseWalletButton+onShippingOptionsChange)  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| [handler] | [<code>OnShippingOptionsChangeCallback</code>](#OnShippingOptionsChangeCallback) | Function to be called when the shipping options data is updated. |
+
+**Example**  
+```js
+button.onShippingOptionsChange((data) => {
+    const responseData = await fetch('https://your-server.com/update-shipping-info');
+    return { error: null, token: responseData.walletToken };
+});
+```
 <a name="BaseWalletButton+onUnavailable" id="BaseWalletButton+onUnavailable" href="#BaseWalletButton+onUnavailable">&nbsp;</a>
 
 ### paypalWalletButtonExpress.onUnavailable(handler)
@@ -7510,6 +7746,28 @@ List of available event's name in the wallet button lifecycle
 | PAYMENT_IN_REVIEW | <code>string</code> | <code>&quot;paymentInReview&quot;</code> | 
 | ON_CLICK | <code>string</code> | <code>&quot;onClick&quot;</code> | 
 | ON_CHECKOUT_CLOSE | <code>string</code> | <code>&quot;onCheckoutClose&quot;</code> | 
+| ON_SHIPPING_ADDRESS_CHANGE | <code>string</code> | <code>&quot;onShippingAddressChange&quot;</code> | 
+| ON_SHIPPING_OPTIONS_CHANGE | <code>string</code> | <code>&quot;onShippingOptionsChange&quot;</code> | 
+
+<a name="ContactFieldType" id="ContactFieldType" href="#ContactFieldType">&nbsp;</a>
+
+## ContactFieldType : <code>object</code>
+List of available contact fields for ContactFieldType
+
+**Kind**: global constant  
+
+| Param | Type |
+| --- | --- |
+| phone | <code>string</code> | 
+| email | <code>string</code> | 
+| name | <code>string</code> | 
+| phonetic_name | <code>string</code> | 
+| address_lines | <code>string</code> | 
+| address_city | <code>string</code> | 
+| address_postcode | <code>string</code> | 
+| address_state | <code>string</code> | 
+| address_country | <code>string</code> | 
+| address_country_code | <code>string</code> | 
 
 <a name="OnClickCallback" id="OnClickCallback" href="#OnClickCallback">&nbsp;</a>
 
@@ -7567,6 +7825,30 @@ Callback for onCheckoutClose method.
 | --- | --- |
 | data | [<code>OnCloseEventData</code>](#OnCloseEventData) | 
 
+<a name="OnShippingAddressChangeCallback" id="OnShippingAddressChangeCallback" href="#OnShippingAddressChangeCallback">&nbsp;</a>
+
+## OnShippingAddressChangeCallback ⇒ [<code>Promise.&lt;OnShippingAddressChangeEventResponse&gt;</code>](#OnShippingAddressChangeEventResponse)
+Callback for onShippingAddressChange method.
+
+**Kind**: global typedef  
+**Returns**: [<code>Promise.&lt;OnShippingAddressChangeEventResponse&gt;</code>](#OnShippingAddressChangeEventResponse) - Address update result  
+
+| Param | Type |
+| --- | --- |
+| data | [<code>OnShippingAddressChangeEventData</code>](#OnShippingAddressChangeEventData) | 
+
+<a name="OnShippingOptionsChangeCallback" id="OnShippingOptionsChangeCallback" href="#OnShippingOptionsChangeCallback">&nbsp;</a>
+
+## OnShippingOptionsChangeCallback ⇒ [<code>Promise.&lt;OnShippingOptionChangeEventResponse&gt;</code>](#OnShippingOptionChangeEventResponse)
+Callback for onShippingOptionsChange method.
+
+**Kind**: global typedef  
+**Returns**: [<code>Promise.&lt;OnShippingOptionChangeEventResponse&gt;</code>](#OnShippingOptionChangeEventResponse) - Address update result  
+
+| Param | Type |
+| --- | --- |
+| data | [<code>OnShippingOptionChangeEventData</code>](#OnShippingOptionChangeEventData) | 
+
 <a name="OnUnavailableCallback" id="OnUnavailableCallback" href="#OnUnavailableCallback">&nbsp;</a>
 
 ## OnUnavailableCallback : <code>function</code>