• Skip to primary navigation
  • Skip to main content
  • Skip to primary sidebar
  • Skip to footer
Easy Digital Downloads a2z

Easy Digital Downloads a2z

Easy Digital Downloads a2z

  • Home
  • Plugins
  • Shortcodes
  • APIs
  • Classes
  • Files
  • Hooks
  • Sitemap
  • Blog
Home / Files / includes/gateways/libs/amazon/Interface.php


Lines:

1 to 100 of 483
<?php
namespace PayWithAmazon;

// Exit if accessed directly
if ( ! defined( 'ABSPATH' ) ) exit;

/* Interface class to showcase the public API methods for Pay With Amazon */

interface ClientInterface
{
    /* Takes user configuration array from the user as input
     * Takes JSON file path with configuration information as input
     * Validates the user configuation array against existing config array
     */

/* function __construct() – */

    /* Setter for sandbox
     * Sets the boolean value for config['sandbox'] variable
     */

/* function setSandbox() – */

    /* Setter for config['client_id']
     * Sets the  value for config['client_id'] variable
     */

/* function setClientId() – */

    /* Setter for Proxy
     * input $proxy [array]
     * @param $proxy['proxy_user_host'] - hostname for the proxy
     * @param $proxy['proxy_user_port'] - hostname for the proxy
     * @param $proxy['proxy_user_name'] - if your proxy required a username
     * @param $proxy['proxy_user_password'] - if your proxy required a passowrd
     */

/* function setProxy() – */

    /* Setter for $_mwsServiceUrl
     * Set the URL to which the post request has to be made for unit testing
     */

/* function setMwsServiceUrl() – */

    /* Getter
     * Gets the value for the key if the key exists in config
     */

/* function __get() – */

    /* Getter for parameters string
     * Gets the value for the parameters string for unit testing
     */

/* function getParameters() – */

    /* GetUserInfo convenience funtion - Returns user's profile information from Amazon using the access token returned by the Button widget.
     *
     * @see http://docs.developer.amazonservices.com/en_US/apa_guide/APAGuide_ObtainProfile.html
     * @param $access_token [String]
     */

/* function getUserInfo() – */

    /* GetOrderReferenceDetails API call - Returns details about the Order Reference object and its current state.
     * @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_GetOrderReferenceDetails.html
     *
     * @param requestParameters['merchant_id'] - [String]
     * @param requestParameters['amazon_order_reference_id'] - [String]
     * @optional requestParameters['address_consent_token'] - [String]
     * @optional requestParameters['mws_auth_token'] - [String]
     */

/* function getOrderReferenceDetails() – */

    /* SetOrderReferenceDetails API call - Sets order reference details such as the order total and a description for the order.
     * @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_SetOrderReferenceDetails.html
     *
     * @param requestParameters['merchant_id'] - [String]
     * @param requestParameters['amazon_order_reference_id'] - [String]
     * @param requestParameters['amount'] - [String]
     * @param requestParameters['currency_code'] - [String]
     * @optional requestParameters['platform_id'] - [String]
     * @optional requestParameters['seller_note'] - [String]
     * @optional requestParameters['seller_order_id'] - [String]
     * @optional requestParameters['store_name'] - [String]
     * @optional requestParameters['custom_information'] - [String]
     * @optional requestParameters['mws_auth_token'] - [String]
     */

/* function setOrderReferenceDetails() – */

    /* ConfirmOrderReferenceDetails API call - Confirms that the order reference is free of constraints and all required information has been set on the order reference.
     * @see http://docs.developer.amazonservices.com/en_US/off_amazon_payments/OffAmazonPayments_ConfirmOrderReference.html

     * @param requestParameters['merchant_id'] - [String]
     * @param requestParameters['amazon_order_reference_id'] - [String]
     * @optional requestParameters['mws_auth_token'] - [String]
     */
[1] [2] [3] … [5] Next »

 View on GitHub View on Trac

Called by

    Invoked by

      Calls

      Call hooks

      File name: includes/gateways/libs/amazon/Interface.php
      Plugin ref: Easy Digital Downloads
      Version: 2.11.6
      Deprecated?: No
      API Letters: A,G,I,L

      Published: 26th November 2019 | Last updated: 26th November 2019

      Primary Sidebar

      Information

      File name: includes/gateways/libs/amazon/Interface.php
      Plugin ref: Easy Digital Downloads
      Version: 2.11.6
      Deprecated?: No
      API Letters: A,G,I,L

      includes/gateways/libs/amazon

      Footer

      Easy Digital Downloads a2z
      Easy Digital Downloads a2z
      Easy Digital Downloads a2z
      WordPress 5.9.3
      WordPress a2z
      WordPress core a2z
      Genesis Theme Framework a2z
      Jetpack a2z
      WordPress develop tests
      Easy Digital Downloads a2z
      WooCommerce a2z
      Yoast SEO a2z
      WordPress Blocks

      Site:  edd.wp-a2z.org
      © Copyright Easy Digital Downloads a2z 2014-2022. All rights reserved.


      Website designed and developed by Herb Miller
      Proudly powered by WordPress and oik plugins

      • Home
      • Blog
      • Sitemap
      • Sites