Your IP : 216.73.216.95
<?php
/**
* Copyright 2014 Klarna AB
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* File containing the Capture class.
*/
namespace Klarna\Rest\OrderManagement;
use GuzzleHttp\Exception\RequestException;
use Klarna\Rest\Resource;
use Klarna\Rest\Transport\Connector;
use Klarna\Rest\Transport\Exception\ConnectorException;
/**
* Capture resource.
*
* @example docs/examples/order/fetch_capture.php
* @example docs/examples/order/create_capture.php
* @example docs/examples/capture/append_shipping_info.php
* @example docs/examples/capture/trigger_send_out.php
* @example docs/examples/capture/update_customer_details.php
*/
class Capture extends Resource
{
/**
* {@inheritDoc}
*/
const ID_FIELD = 'capture_id';
/**
* {@inheritDoc}
*/
public static $path = '/captures';
/**
* Constructs an order instance.
*
* @param Connector $connector HTTP transport connector
* @param string $orderUrl Parent order resource url
* @param string $captureId Capture ID
*/
public function __construct(Connector $connector, $orderUrl, $captureId = null)
{
parent::__construct($connector);
$url = $orderUrl . self::$path;
if ($captureId !== null) {
$url = "{$url}/{$captureId}";
$this[static::ID_FIELD] = $captureId;
}
$this->setLocation($url);
}
/**
* Creates the resource.
*
* @param array $data Creation data
*
* @throws ConnectorException When the API replies with an error response
* @throws RequestException When an error is encountered
* @throws \RuntimeException If the location header is missing
* @throws \RuntimeException If the API replies with an unexpected response
* @throws \LogicException When Guzzle cannot populate the response
*
* @return self
*/
public function create(array $data)
{
$url = $this->post($this->getLocation(), $data)
->status('201')
->getLocation();
$this->setLocation($url);
return $this;
}
/**
* Appends shipping information to the capture.
*
* @param array $data Shipping info data
*
* @throws ConnectorException When the API replies with an error response
* @throws RequestException When an error is encountered
* @throws \RuntimeException If the API replies with an unexpected response
* @throws \LogicException When Guzzle cannot populate the response
*
* @return self
*/
public function addShippingInfo(array $data)
{
$this->post($this->getLocation() . '/shipping-info', $data)
->status('204');
return $this;
}
/**
* Updates the customers details.
*
* @param array $data Customer details data
*
* @throws ConnectorException When the API replies with an error response
* @throws RequestException When an error is encountered
* @throws \RuntimeException If the API replies with an unexpected response
* @throws \LogicException When Guzzle cannot populate the response
*
* @return self
*/
public function updateCustomerDetails(array $data)
{
$this->patch($this->getLocation() . '/customer-details', $data)
->status('204');
return $this;
}
/**
* Trigger send outs for this capture.
*
* @throws ConnectorException When the API replies with an error response
* @throws RequestException When an error is encountered
* @throws \RuntimeException If the API replies with an unexpected response
* @throws \LogicException When Guzzle cannot populate the response
*
* @return self
*/
public function triggerSendout()
{
$this->post($this->getLocation() . '/trigger-send-out')
->status('204');
return $this;
}
}