Skip to content

Commit

Permalink
Fix links to Developer API Reference #1302
Browse files Browse the repository at this point in the history
* Fix links to Developer API Reference
  • Loading branch information
prakash-gangadharan authored Oct 15, 2019
1 parent 4ddb1de commit 2f35368
Show file tree
Hide file tree
Showing 42 changed files with 73 additions and 73 deletions.
4 changes: 2 additions & 2 deletions sample/billing/CreateBillingAgreementWithPayPal.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Create Billing Agreement with PayPal as Payment Source
//
// This sample code demonstrate how you can create a billing agreement, as documented here at:
// https://developer.paypal.com/docs/api/#create-an-agreement
// API used: /v1/payments/billing-agreements
// https://developer.paypal.com/docs/api/payments.billing-agreements/v1/#billing-agreements_post
// API used: POST /v1/payments/billing-agreements

// Retrieving the Plan from the Create Update Sample. This would be used to
// define Plan information to create an agreement. Make sure the plan you are using is in active state.
Expand Down
4 changes: 2 additions & 2 deletions sample/billing/CreatePlan.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Create Plan Sample
//
// This sample code demonstrate how you can create a billing plan, as documented here at:
// https://developer.paypal.com/docs/api/#create-a-plan
// API used: /v1/payments/billing-plans
// https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_post
// API used: POST /v1/payments/billing-plans

require __DIR__ . '/../bootstrap.php';
use PayPal\Api\ChargeModel;
Expand Down
4 changes: 2 additions & 2 deletions sample/billing/DeletePlan.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Delete Plan Sample
//
// This sample code demonstrate how you can delete a billing plan, as documented here at:
// https://developer.paypal.com/docs/api/#retrieve-a-plan
// API used: /v1/payments/billing-plans
// https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_patch
// API used: PATCH /v1/payments/billing-plans/{plan_id}

// Retrieving the Plan object from Create Plan Sample
/** @var Plan $createdPlan */
Expand Down
4 changes: 2 additions & 2 deletions sample/billing/GetBillingAgreement.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Get Billing Agreement Sample
//
// This sample code demonstrate how you can get a billing agreement, as documented here at:
// https://developer.paypal.com/docs/api/#retrieve-an-agreement
// API used: /v1/payments/billing-agreements/<Agreement-Id>
// https://developer.paypal.com/docs/api/payments.billing-agreements/v1/#billing-agreements_get
// API used: GET /v1/payments/billing-agreements/{agreement_id}
require __DIR__ . '/../bootstrap.php';

// Retrieving the Agreement object from Create Agreement From Credit Card Sample
Expand Down
4 changes: 2 additions & 2 deletions sample/billing/GetPlan.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Get Plan Sample
//
// This sample code demonstrate how you can get a billing plan, as documented here at:
// https://developer.paypal.com/docs/api/#retrieve-a-plan
// API used: /v1/payments/billing-plans
// https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_get
// API used: GET /v1/payments/billing-plans

// Retrieving the Plan object from Create Plan Sample
/** @var Plan $createdPlan */
Expand Down
4 changes: 2 additions & 2 deletions sample/billing/ListPlans.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Get List of Plan Sample
//
// This sample code demonstrate how you can get a list of billing plan, as documented here at:
// https://developer.paypal.com/docs/api/#list-plans
// API used: /v1/payments/billing-plans
// https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_list
// API used: GET /v1/payments/billing-plans

// Retrieving the Plan object from Create Plan Sample to demonstrate the List
/** @var Plan $createdPlan */
Expand Down
4 changes: 2 additions & 2 deletions sample/billing/ReactivateBillingAgreement.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Reactivate an agreement
//
// This sample code demonstrate how you can reactivate a billing agreement, as documented here at:
// https://developer.paypal.com/docs/api/#suspend-an-agreement
// API used: /v1/payments/billing-agreements/<Agreement-Id>/suspend
// https://developer.paypal.com/docs/api/payments.billing-agreements/v1/#billing-agreements_re-activate
// API used: POST /v1/payments/billing-agreements/{agreement_id}/re-activate

// Retrieving the Agreement object from Suspend Agreement Sample to demonstrate the List
/** @var Agreement $suspendedAgreement */
Expand Down
4 changes: 2 additions & 2 deletions sample/billing/SearchBillingTransactions.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Search Billing Transactions Sample
//
// This sample code demonstrate how you can search all billing transactions, as documented here at:
// https://developer.paypal.com/docs/api/#search-for-transactions
// API used: GET /v1/payments/billing-agreements/<Agreement-Id>/transactions? start-date=yyyy-mm-dd&end-date=yyyy-mm-dd
// https://developer.paypal.com/docs/api/payments.billing-agreements/v1/#billing-agreements_transactions
// API used: GET /v1/payments/billing-agreements/{agreement_id}/transactions? start-date=yyyy-mm-dd&end-date=yyyy-mm-dd

// Retrieving the Agreement object from Get Billing Agreement. This may not be necessary if you are trying to search for transactions of already created Agreement.
/** @var Agreement $agreement */
Expand Down
4 changes: 2 additions & 2 deletions sample/billing/SuspendBillingAgreement.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Suspend an agreement
//
// This sample code demonstrate how you can suspend a billing agreement, as documented here at:
// https://developer.paypal.com/docs/api/#suspend-an-agreement
// API used: /v1/payments/billing-agreements/<Agreement-Id>/suspend
// https://developer.paypal.com/docs/api/payments.billing-agreements/v1/#billing-agreements_suspend
// API used: POST /v1/payments/billing-agreements/{agreement_id}/suspend

// Retrieving the Agreement object from Create Agreement Sample to demonstrate the List
require __DIR__ . '/../bootstrap.php';
Expand Down
4 changes: 2 additions & 2 deletions sample/billing/UpdateBillingAgreement.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Update an agreement
//
// This sample code demonstrate how you can update a billing agreement, as documented here at:
// https://developer.paypal.com/docs/api/#update-an-agreement
// API used: /v1/payments/billing-agreements/<Agreement-Id>
// https://developer.paypal.com/docs/api/payments.billing-agreements/v1/#billing-agreements_patch
// API used: PATCH /v1/payments/billing-agreements/{agreement_id}

require __DIR__ . '/../bootstrap.php';

Expand Down
4 changes: 2 additions & 2 deletions sample/billing/UpdatePlan.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Update a plan
//
// This sample code demonstrate how you can update a billing plan, as documented here at:
// https://developer.paypal.com/docs/api/#update-a-plan
// API used: /v1/payments/billing-plans/<Plan-Id>
// https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_patch
// API used: PATCH /v1/payments/billing-plans/{plan_id}

// ### Making Plan Active
// This example demonstrate how you could activate the Plan.
Expand Down
4 changes: 2 additions & 2 deletions sample/billing/UpdatePlanPaymentDefinitions.php
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
// # Update a plan
//
// This sample code demonstrate how you can update a billing plan, as documented here at:
// https://developer.paypal.com/docs/api/#update-a-plan
// API used: /v1/payments/billing-plans/<Plan-Id>
// https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_patch
// API used: PATCH /v1/payments/billing-plans/{plan_id}

// ### Changing Plan Amount
// This example demonstrate how you could change the plan amount
Expand Down
4 changes: 2 additions & 2 deletions sample/doc/billing/CreateBillingAgreementWithPayPal.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html><html lang="en"><head><title>billing/CreateBillingAgreementWithPayPal</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content="../"><meta name="groc-document-path" content="billing/CreateBillingAgreementWithPayPal"><meta name="groc-project-path" content="billing/CreateBillingAgreementWithPayPal.php"><link rel="stylesheet" type="text/css" media="all" href="../assets/style.css"><script type="text/javascript" src="../assets/behavior.js"></script><body><div id="meta"><div class="file-path">billing/CreateBillingAgreementWithPayPal.php</div></div><div id="document"><div class="segment"><div class="code"><div class="wrapper"><span class="hljs-preprocessor">&lt;?php</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><h1 id="create-billing-agreement-with-paypal-as-payment-source">Create Billing Agreement with PayPal as Payment Source</h1>
<p>This sample code demonstrate how you can create a billing agreement, as documented here at:
<a href="https://developer.paypal.com/docs/api/#create-an-agreement">https://developer.paypal.com/docs/api/#create-an-agreement</a>
API used: /v1/payments/billing-agreements</p></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Retrieving the Plan from the Create Update Sample. This would be used to
<a href="https://developer.paypal.com/docs/api/payments.billing-agreements/v1/#billing-agreements_post">https://developer.paypal.com/docs/api/payments.billing-agreements/v1/#billing-agreements_post</a>
API used: POST /v1/payments/billing-agreements</p></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Retrieving the Plan from the Create Update Sample. This would be used to
define Plan information to create an agreement. Make sure the plan you are using is in active state.</p></div></div><div class="code"><div class="wrapper"><span class="hljs-comment">/** <span class="hljs-doctag">@var</span> Plan $createdPlan */</span>
<span class="hljs-variable">$createdPlan</span> = <span class="hljs-keyword">require</span> <span class="hljs-string">'UpdatePlan.php'</span>;

Expand Down
4 changes: 2 additions & 2 deletions sample/doc/billing/CreatePlan.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html><html lang="en"><head><title>billing/CreatePlan</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content="../"><meta name="groc-document-path" content="billing/CreatePlan"><meta name="groc-project-path" content="billing/CreatePlan.php"><link rel="stylesheet" type="text/css" media="all" href="../assets/style.css"><script type="text/javascript" src="../assets/behavior.js"></script><body><div id="meta"><div class="file-path">billing/CreatePlan.php</div></div><div id="document"><div class="segment"><div class="code"><div class="wrapper"><span class="hljs-preprocessor">&lt;?php</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><h1 id="create-plan-sample">Create Plan Sample</h1>
<p>This sample code demonstrate how you can create a billing plan, as documented here at:
<a href="https://developer.paypal.com/docs/api/#create-a-plan">https://developer.paypal.com/docs/api/#create-a-plan</a>
API used: /v1/payments/billing-plans</p></div></div><div class="code"><div class="wrapper"><span class="hljs-keyword">require</span> <span class="hljs-keyword">__DIR__</span> . <span class="hljs-string">'/../bootstrap.php'</span>;
<a href="https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_post">https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_post</a>
API used: POST /v1/payments/billing-plans</p></div></div><div class="code"><div class="wrapper"><span class="hljs-keyword">require</span> <span class="hljs-keyword">__DIR__</span> . <span class="hljs-string">'/../bootstrap.php'</span>;
<span class="hljs-keyword">use</span> <span class="hljs-title">PayPal</span>\<span class="hljs-title">Api</span>\<span class="hljs-title">ChargeModel</span>;
<span class="hljs-keyword">use</span> <span class="hljs-title">PayPal</span>\<span class="hljs-title">Api</span>\<span class="hljs-title">Currency</span>;
<span class="hljs-keyword">use</span> <span class="hljs-title">PayPal</span>\<span class="hljs-title">Api</span>\<span class="hljs-title">MerchantPreferences</span>;
Expand Down
4 changes: 2 additions & 2 deletions sample/doc/billing/DeletePlan.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html><html lang="en"><head><title>billing/DeletePlan</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content="../"><meta name="groc-document-path" content="billing/DeletePlan"><meta name="groc-project-path" content="billing/DeletePlan.php"><link rel="stylesheet" type="text/css" media="all" href="../assets/style.css"><script type="text/javascript" src="../assets/behavior.js"></script><body><div id="meta"><div class="file-path">billing/DeletePlan.php</div></div><div id="document"><div class="segment"><div class="code"><div class="wrapper"><span class="hljs-preprocessor">&lt;?php</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><h1 id="delete-plan-sample">Delete Plan Sample</h1>
<p>This sample code demonstrate how you can delete a billing plan, as documented here at:
<a href="https://developer.paypal.com/docs/api/#retrieve-a-plan">https://developer.paypal.com/docs/api/#retrieve-a-plan</a>
API used: /v1/payments/billing-plans</p></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Retrieving the Plan object from Create Plan Sample</p></div></div><div class="code"><div class="wrapper"><span class="hljs-comment">/** <span class="hljs-doctag">@var</span> Plan $createdPlan */</span>
<a href="https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_patch">https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_patch</a>
API used: PATCH /v1/payments/billing-plans/{plan_id}</p></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Retrieving the Plan object from Create Plan Sample</p></div></div><div class="code"><div class="wrapper"><span class="hljs-comment">/** <span class="hljs-doctag">@var</span> Plan $createdPlan */</span>
<span class="hljs-variable">$createdPlan</span> = <span class="hljs-keyword">require</span> <span class="hljs-string">'CreatePlan.php'</span>;

<span class="hljs-keyword">use</span> <span class="hljs-title">PayPal</span>\<span class="hljs-title">Api</span>\<span class="hljs-title">Plan</span>;
Expand Down
4 changes: 2 additions & 2 deletions sample/doc/billing/GetBillingAgreement.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html><html lang="en"><head><title>billing/GetBillingAgreement</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content="../"><meta name="groc-document-path" content="billing/GetBillingAgreement"><meta name="groc-project-path" content="billing/GetBillingAgreement.php"><link rel="stylesheet" type="text/css" media="all" href="../assets/style.css"><script type="text/javascript" src="../assets/behavior.js"></script><body><div id="meta"><div class="file-path">billing/GetBillingAgreement.php</div></div><div id="document"><div class="segment"><div class="code"><div class="wrapper"><span class="hljs-preprocessor">&lt;?php</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><h1 id="get-billing-agreement-sample">Get Billing Agreement Sample</h1>
<p>This sample code demonstrate how you can get a billing agreement, as documented here at:
<a href="https://developer.paypal.com/docs/api/#retrieve-an-agreement">https://developer.paypal.com/docs/api/#retrieve-an-agreement</a>
API used: /v1/payments/billing-agreements/<Agreement-Id></p></div></div><div class="code"><div class="wrapper"><span class="hljs-keyword">require</span> <span class="hljs-keyword">__DIR__</span> . <span class="hljs-string">'/../bootstrap.php'</span>;</div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Retrieving the Agreement object from Create Agreement From Credit Card Sample</p></div></div><div class="code"><div class="wrapper"><span class="hljs-comment">/** <span class="hljs-doctag">@var</span> Agreement $createdAgreement */</span>
<a href="https://developer.paypal.com/docs/api/payments.billing-agreements/v1/#billing-agreements_get">https://developer.paypal.com/docs/api/payments.billing-agreements/v1/#billing-agreements_get</a>
API used: GET /v1/payments/billing-agreements/{agreement_id}</p></div></div><div class="code"><div class="wrapper"><span class="hljs-keyword">require</span> <span class="hljs-keyword">__DIR__</span> . <span class="hljs-string">'/../bootstrap.php'</span>;</div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Retrieving the Agreement object from Create Agreement From Credit Card Sample</p></div></div><div class="code"><div class="wrapper"><span class="hljs-comment">/** <span class="hljs-doctag">@var</span> Agreement $createdAgreement */</span>
<span class="hljs-variable">$createdAgreement</span> = <span class="hljs-string">"your billing agreement id"</span>;

<span class="hljs-keyword">use</span> <span class="hljs-title">PayPal</span>\<span class="hljs-title">Api</span>\<span class="hljs-title">Agreement</span>;
Expand Down
4 changes: 2 additions & 2 deletions sample/doc/billing/GetPlan.html
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<!DOCTYPE html><html lang="en"><head><title>billing/GetPlan</title></head><meta http-equiv="Content-Type" content="text/html; charset=utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0, maximum-scale=1.0"><meta name="groc-relative-root" content="../"><meta name="groc-document-path" content="billing/GetPlan"><meta name="groc-project-path" content="billing/GetPlan.php"><link rel="stylesheet" type="text/css" media="all" href="../assets/style.css"><script type="text/javascript" src="../assets/behavior.js"></script><body><div id="meta"><div class="file-path">billing/GetPlan.php</div></div><div id="document"><div class="segment"><div class="code"><div class="wrapper"><span class="hljs-preprocessor">&lt;?php</span></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><h1 id="get-plan-sample">Get Plan Sample</h1>
<p>This sample code demonstrate how you can get a billing plan, as documented here at:
<a href="https://developer.paypal.com/docs/api/#retrieve-a-plan">https://developer.paypal.com/docs/api/#retrieve-a-plan</a>
API used: /v1/payments/billing-plans</p></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Retrieving the Plan object from Create Plan Sample</p></div></div><div class="code"><div class="wrapper"><span class="hljs-comment">/** <span class="hljs-doctag">@var</span> Plan $createdPlan */</span>
<a href="https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_list">https://developer.paypal.com/docs/api/payments.billing-plans/v1/#billing-plans_list</a>
API used: GET /v1/payments/billing-plans/{plan_id}</p></div></div></div><div class="segment"><div class="comments "><div class="wrapper"><p>Retrieving the Plan object from Create Plan Sample</p></div></div><div class="code"><div class="wrapper"><span class="hljs-comment">/** <span class="hljs-doctag">@var</span> Plan $createdPlan */</span>
<span class="hljs-variable">$createdPlan</span> = <span class="hljs-keyword">require</span> <span class="hljs-string">'CreatePlan.php'</span>;

<span class="hljs-keyword">use</span> <span class="hljs-title">PayPal</span>\<span class="hljs-title">Api</span>\<span class="hljs-title">Plan</span>;
Expand Down
Loading

0 comments on commit 2f35368

Please sign in to comment.