forked from LiveCarta/PayPal-PHP-Server-SDK
cf6ca18307
* Automated commit message * Automated commit message --------- Co-authored-by: PayPalServerSDKs <server-sdks@paypal.com>
494 lines
23 KiB
PHP
494 lines
23 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* PaypalServerSdkLib
|
|
*
|
|
* This file was automatically generated by APIMATIC v3.0 ( https://www.apimatic.io ).
|
|
*/
|
|
|
|
namespace PaypalServerSdkLib\Controllers;
|
|
|
|
use Core\Request\Parameters\BodyParam;
|
|
use Core\Request\Parameters\HeaderParam;
|
|
use Core\Request\Parameters\QueryParam;
|
|
use Core\Request\Parameters\TemplateParam;
|
|
use Core\Response\Types\ErrorType;
|
|
use CoreInterfaces\Core\Request\RequestMethod;
|
|
use PaypalServerSdkLib\Exceptions\ErrorException;
|
|
use PaypalServerSdkLib\Http\ApiResponse;
|
|
use PaypalServerSdkLib\Models\Order;
|
|
use PaypalServerSdkLib\Models\OrderAuthorizeResponse;
|
|
|
|
class OrdersController extends BaseController
|
|
{
|
|
/**
|
|
* Creates an order. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and
|
|
* payment processing costs. For more information about processing payments, see <a href="https:
|
|
* //developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https:
|
|
* //developer.paypal.com/docs/multiparty/checkout/advanced/processing/">multiparty checkout</a>.
|
|
* <blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https:
|
|
* //developer.paypal.com/api/rest/reference/orders/v2/errors/#create-order">Orders v2 errors</a>.
|
|
* </blockquote>
|
|
*
|
|
* @param array $options Array with all options for search
|
|
*
|
|
* @return ApiResponse Response from the API call
|
|
*/
|
|
public function ordersCreate(array $options): ApiResponse
|
|
{
|
|
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders')
|
|
->auth('Oauth2')
|
|
->parameters(
|
|
HeaderParam::init('Content-Type', 'application/json'),
|
|
BodyParam::init($options)->extract('body'),
|
|
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
|
HeaderParam::init('PayPal-Partner-Attribution-Id', $options)->extract('paypalPartnerAttributionId'),
|
|
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
|
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
|
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion')
|
|
);
|
|
|
|
$_resHandler = $this->responseHandler()
|
|
->throwErrorOn(
|
|
'400',
|
|
ErrorType::init(
|
|
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn(
|
|
'401',
|
|
ErrorType::init(
|
|
'Authentication failed due to missing authorization header, or invalid auth' .
|
|
'entication credentials.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn(
|
|
'422',
|
|
ErrorType::init(
|
|
'The requested action could not be performed, semantically incorrect, or fa' .
|
|
'iled business validation.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
|
->type(Order::class)
|
|
->returnApiResponse();
|
|
|
|
return $this->execute($_reqBuilder, $_resHandler);
|
|
}
|
|
|
|
/**
|
|
* Shows details for an order, by ID.<blockquote><strong>Note:</strong> For error handling and
|
|
* troubleshooting, see <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#get-
|
|
* order">Orders v2 errors</a>.</blockquote>
|
|
*
|
|
* @param array $options Array with all options for search
|
|
*
|
|
* @return ApiResponse Response from the API call
|
|
*/
|
|
public function ordersGet(array $options): ApiResponse
|
|
{
|
|
$_reqBuilder = $this->requestBuilder(RequestMethod::GET, '/v2/checkout/orders/{id}')
|
|
->auth('Oauth2')
|
|
->parameters(
|
|
TemplateParam::init('id', $options)->extract('id'),
|
|
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
|
QueryParam::init('fields', $options)->extract('fields')
|
|
);
|
|
|
|
$_resHandler = $this->responseHandler()
|
|
->throwErrorOn(
|
|
'401',
|
|
ErrorType::init(
|
|
'Authentication failed due to missing authorization header, or invalid auth' .
|
|
'entication credentials.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
|
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
|
->type(Order::class)
|
|
->returnApiResponse();
|
|
|
|
return $this->execute($_reqBuilder, $_resHandler);
|
|
}
|
|
|
|
/**
|
|
* Updates an order with a `CREATED` or `APPROVED` status. You cannot update an order with the
|
|
* `COMPLETED` status.<br/><br/>To make an update, you must provide a `reference_id`. If you omit this
|
|
* value with an order that contains only one purchase unit, PayPal sets the value to `default` which
|
|
* enables you to use the path: <code>\"/purchase_units/@reference_id=='default'/{attribute-or-
|
|
* object}\"</code>. Merchants and partners can add Level 2 and 3 data to payments to reduce risk and
|
|
* payment processing costs. For more information about processing payments, see <a href="https:
|
|
* //developer.paypal.com/docs/checkout/advanced/processing/">checkout</a> or <a href="https:
|
|
* //developer.paypal.com/docs/multiparty/checkout/advanced/processing/">multiparty checkout</a>.
|
|
* <blockquote><strong>Note:</strong> For error handling and troubleshooting, see <a href="https:
|
|
* //developer.paypal.com/api/rest/reference/orders/v2/errors/#patch-order">Orders v2 errors</a>.
|
|
* </blockquote>Patchable attributes or objects:
|
|
* <br/><br/><table><thead><th>Attribute</th><th>Op</th><th>Notes</th></thead><tbody><tr><td><code>inte
|
|
* nt</code></td><td>replace</td><td></td></tr><tr><td><code>payer</code></td><td>replace,
|
|
* add</td><td>Using replace op for <code>payer</code> will replace the whole <code>payer</code> object
|
|
* with the value sent in request.</td></tr><tr><td><code>purchase_units</code></td><td>replace,
|
|
* add</td><td></td></tr><tr><td><code>purchase_units[].custom_id</code></td><td>replace, add,
|
|
* remove</td><td></td></tr><tr><td><code>purchase_units[].description</code></td><td>replace, add,
|
|
* remove</td><td></td></tr><tr><td><code>purchase_units[].payee.
|
|
* email</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].shipping.
|
|
* name</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.
|
|
* email_address</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.
|
|
* phone_number</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.
|
|
* options</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.
|
|
* address</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].shipping.
|
|
* type</code></td><td>replace, add</td><td></td></tr><tr><td><code>purchase_units[].
|
|
* soft_descriptor</code></td><td>replace, remove</td><td></td></tr><tr><td><code>purchase_units[].
|
|
* amount</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].
|
|
* items</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].
|
|
* invoice_id</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].
|
|
* payment_instruction</code></td><td>replace</td><td></td></tr><tr><td><code>purchase_units[].
|
|
* payment_instruction.disbursement_mode</code></td><td>replace</td><td>By default,
|
|
* <code>disbursement_mode</code> is <code>INSTANT</code>.</td></tr><tr><td><code>purchase_units[].
|
|
* payment_instruction.payee_receivable_fx_rate_id</code></td><td>replace, add,
|
|
* remove</td><td></td></tr><tr><td><code>purchase_units[].payment_instruction.
|
|
* platform_fees</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>purchase_units[].
|
|
* supplementary_data.airline</code></td><td>replace, add,
|
|
* remove</td><td></td></tr><tr><td><code>purchase_units[].supplementary_data.
|
|
* card</code></td><td>replace, add, remove</td><td></td></tr><tr><td><code>application_context.
|
|
* client_configuration</code></td><td>replace, add</td><td></td></tr></tbody></table>
|
|
*
|
|
* @param array $options Array with all options for search
|
|
*
|
|
* @return ApiResponse Response from the API call
|
|
*/
|
|
public function ordersPatch(array $options): ApiResponse
|
|
{
|
|
$_reqBuilder = $this->requestBuilder(RequestMethod::PATCH, '/v2/checkout/orders/{id}')
|
|
->auth('Oauth2')
|
|
->parameters(
|
|
TemplateParam::init('id', $options)->extract('id'),
|
|
HeaderParam::init('Content-Type', 'application/json'),
|
|
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
|
BodyParam::init($options)->extract('body')
|
|
);
|
|
|
|
$_resHandler = $this->responseHandler()
|
|
->throwErrorOn(
|
|
'400',
|
|
ErrorType::init(
|
|
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn(
|
|
'401',
|
|
ErrorType::init(
|
|
'Authentication failed due to missing authorization header, or invalid auth' .
|
|
'entication credentials.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
|
->throwErrorOn(
|
|
'422',
|
|
ErrorType::init(
|
|
'The requested action could not be performed, semantically incorrect, or fa' .
|
|
'iled business validation.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
|
->returnApiResponse();
|
|
|
|
return $this->execute($_reqBuilder, $_resHandler);
|
|
}
|
|
|
|
/**
|
|
* Payer confirms their intent to pay for the the Order with the given payment source.
|
|
*
|
|
* @param array $options Array with all options for search
|
|
*
|
|
* @return ApiResponse Response from the API call
|
|
*/
|
|
public function ordersConfirm(array $options): ApiResponse
|
|
{
|
|
$_reqBuilder = $this->requestBuilder(
|
|
RequestMethod::POST,
|
|
'/v2/checkout/orders/{id}/confirm-payment-source'
|
|
)
|
|
->auth('Oauth2')
|
|
->parameters(
|
|
TemplateParam::init('id', $options)->extract('id'),
|
|
HeaderParam::init('Content-Type', 'application/json'),
|
|
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
|
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
|
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
|
BodyParam::init($options)->extract('body')
|
|
);
|
|
|
|
$_resHandler = $this->responseHandler()
|
|
->throwErrorOn(
|
|
'400',
|
|
ErrorType::init(
|
|
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn(
|
|
'403',
|
|
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
|
)
|
|
->throwErrorOn(
|
|
'422',
|
|
ErrorType::init(
|
|
'The requested action could not be performed, semantically incorrect, or fa' .
|
|
'iled business validation.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
|
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
|
->type(Order::class)
|
|
->returnApiResponse();
|
|
|
|
return $this->execute($_reqBuilder, $_resHandler);
|
|
}
|
|
|
|
/**
|
|
* Authorizes payment for an order. To successfully authorize payment for an order, the buyer must
|
|
* first approve the order or a valid payment_source must be provided in the request. A buyer can
|
|
* approve the order upon being redirected to the rel:approve URL that was returned in the HATEOAS
|
|
* links in the create order response.<blockquote><strong>Note:</strong> For error handling and
|
|
* troubleshooting, see <a href="https://developer.paypal.
|
|
* com/api/rest/reference/orders/v2/errors/#authorize-order">Orders v2 errors</a>.</blockquote>
|
|
*
|
|
* @param array $options Array with all options for search
|
|
*
|
|
* @return ApiResponse Response from the API call
|
|
*/
|
|
public function ordersAuthorize(array $options): ApiResponse
|
|
{
|
|
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/authorize')
|
|
->auth('Oauth2')
|
|
->parameters(
|
|
TemplateParam::init('id', $options)->extract('id'),
|
|
HeaderParam::init('Content-Type', 'application/json'),
|
|
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
|
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
|
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
|
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
|
BodyParam::init($options)->extract('body')
|
|
);
|
|
|
|
$_resHandler = $this->responseHandler()
|
|
->throwErrorOn(
|
|
'400',
|
|
ErrorType::init(
|
|
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn(
|
|
'401',
|
|
ErrorType::init(
|
|
'Authentication failed due to missing authorization header, or invalid auth' .
|
|
'entication credentials.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn(
|
|
'403',
|
|
ErrorType::init(
|
|
'The authorized payment failed due to insufficient permissions.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
|
->throwErrorOn(
|
|
'422',
|
|
ErrorType::init(
|
|
'The requested action could not be performed, semantically incorrect, or fa' .
|
|
'iled business validation.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
|
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
|
->type(OrderAuthorizeResponse::class)
|
|
->returnApiResponse();
|
|
|
|
return $this->execute($_reqBuilder, $_resHandler);
|
|
}
|
|
|
|
/**
|
|
* Captures payment for an order. To successfully capture payment for an order, the buyer must first
|
|
* approve the order or a valid payment_source must be provided in the request. A buyer can approve the
|
|
* order upon being redirected to the rel:approve URL that was returned in the HATEOAS links in the
|
|
* create order response.<blockquote><strong>Note:</strong> For error handling and troubleshooting, see
|
|
* <a href="https://developer.paypal.com/api/rest/reference/orders/v2/errors/#capture-order">Orders v2
|
|
* errors</a>.</blockquote>
|
|
*
|
|
* @param array $options Array with all options for search
|
|
*
|
|
* @return ApiResponse Response from the API call
|
|
*/
|
|
public function ordersCapture(array $options): ApiResponse
|
|
{
|
|
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/capture')
|
|
->auth('Oauth2')
|
|
->parameters(
|
|
TemplateParam::init('id', $options)->extract('id'),
|
|
HeaderParam::init('Content-Type', 'application/json'),
|
|
HeaderParam::init('PayPal-Request-Id', $options)->extract('paypalRequestId'),
|
|
HeaderParam::init('Prefer', $options)->extract('prefer', 'return=minimal'),
|
|
HeaderParam::init('PayPal-Client-Metadata-Id', $options)->extract('paypalClientMetadataId'),
|
|
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
|
BodyParam::init($options)->extract('body')
|
|
);
|
|
|
|
$_resHandler = $this->responseHandler()
|
|
->throwErrorOn(
|
|
'400',
|
|
ErrorType::init(
|
|
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn(
|
|
'401',
|
|
ErrorType::init(
|
|
'Authentication failed due to missing authorization header, or invalid auth' .
|
|
'entication credentials.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn(
|
|
'403',
|
|
ErrorType::init(
|
|
'The authorized payment failed due to insufficient permissions.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
|
->throwErrorOn(
|
|
'422',
|
|
ErrorType::init(
|
|
'The requested action could not be performed, semantically incorrect, or fa' .
|
|
'iled business validation.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
|
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
|
->type(Order::class)
|
|
->returnApiResponse();
|
|
|
|
return $this->execute($_reqBuilder, $_resHandler);
|
|
}
|
|
|
|
/**
|
|
* Adds tracking information for an Order.
|
|
*
|
|
* @param array $options Array with all options for search
|
|
*
|
|
* @return ApiResponse Response from the API call
|
|
*/
|
|
public function ordersTrackCreate(array $options): ApiResponse
|
|
{
|
|
$_reqBuilder = $this->requestBuilder(RequestMethod::POST, '/v2/checkout/orders/{id}/track')
|
|
->auth('Oauth2')
|
|
->parameters(
|
|
TemplateParam::init('id', $options)->extract('id'),
|
|
HeaderParam::init('Content-Type', 'application/json'),
|
|
BodyParam::init($options)->extract('body'),
|
|
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion')
|
|
);
|
|
|
|
$_resHandler = $this->responseHandler()
|
|
->throwErrorOn(
|
|
'400',
|
|
ErrorType::init(
|
|
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn(
|
|
'403',
|
|
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
|
)
|
|
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
|
->throwErrorOn(
|
|
'422',
|
|
ErrorType::init(
|
|
'The requested action could not be performed, semantically incorrect, or fa' .
|
|
'iled business validation.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
|
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
|
->type(Order::class)
|
|
->returnApiResponse();
|
|
|
|
return $this->execute($_reqBuilder, $_resHandler);
|
|
}
|
|
|
|
/**
|
|
* Updates or cancels the tracking information for a PayPal order, by ID. Updatable attributes or
|
|
* objects:
|
|
* <br/><br/><table><thead><th>Attribute</th><th>Op</th><th>Notes</th></thead><tbody></tr><tr><td><code
|
|
* >items</code></td><td>replace</td><td>Using replace op for <code>items</code> will replace the
|
|
* entire <code>items</code> object with the value sent in request.
|
|
* </td></tr><tr><td><code>notify_payer</code></td><td>replace,
|
|
* add</td><td></td></tr><tr><td><code>status</code></td><td>replace</td><td>Only patching status to
|
|
* CANCELLED is currently supported.</td></tr></tbody></table>
|
|
*
|
|
* @param array $options Array with all options for search
|
|
*
|
|
* @return ApiResponse Response from the API call
|
|
*/
|
|
public function ordersTrackersPatch(array $options): ApiResponse
|
|
{
|
|
$_reqBuilder = $this->requestBuilder(
|
|
RequestMethod::PATCH,
|
|
'/v2/checkout/orders/{id}/trackers/{tracker_id}'
|
|
)
|
|
->auth('Oauth2')
|
|
->parameters(
|
|
TemplateParam::init('id', $options)->extract('id'),
|
|
TemplateParam::init('tracker_id', $options)->extract('trackerId'),
|
|
HeaderParam::init('Content-Type', 'application/json'),
|
|
HeaderParam::init('PayPal-Auth-Assertion', $options)->extract('paypalAuthAssertion'),
|
|
BodyParam::init($options)->extract('body')
|
|
);
|
|
|
|
$_resHandler = $this->responseHandler()
|
|
->throwErrorOn(
|
|
'400',
|
|
ErrorType::init(
|
|
'Request is not well-formed, syntactically incorrect, or violates schema.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn(
|
|
'403',
|
|
ErrorType::init('Authorization failed due to insufficient permissions.', ErrorException::class)
|
|
)
|
|
->throwErrorOn('404', ErrorType::init('The specified resource does not exist.', ErrorException::class))
|
|
->throwErrorOn(
|
|
'422',
|
|
ErrorType::init(
|
|
'The requested action could not be performed, semantically incorrect, or fa' .
|
|
'iled business validation.',
|
|
ErrorException::class
|
|
)
|
|
)
|
|
->throwErrorOn('500', ErrorType::init('An internal server error has occurred.', ErrorException::class))
|
|
->throwErrorOn('0', ErrorType::init('The error response.', ErrorException::class))
|
|
->returnApiResponse();
|
|
|
|
return $this->execute($_reqBuilder, $_resHandler);
|
|
}
|
|
}
|