RefundsApi
extends V3ApiBase
in package
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Tags
Table of Contents
- __construct() : mixed
- create() : RefundResponse
- createQuote() : RefundQuoteResponse
- getAll() : RefundsResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
Methods
__construct()
public
__construct(Client $client[, int|null $resourceId = null ][, int|null $parentResourceId = null ]) : mixed
Parameters
- $client : Client
- $resourceId : int|null = null
- $parentResourceId : int|null = null
Tags
Return values
mixed —create()
public
create(array<string|int, OrderRefundItem> $items, string $reason) : RefundResponse
Parameters
- $items : array<string|int, OrderRefundItem>
- $reason : string
Tags
Return values
RefundResponse —createQuote()
public
createQuote() : RefundQuoteResponse
Tags
Return values
RefundQuoteResponse —getAll()
public
getAll() : RefundsResponse
Tags
Return values
RefundsResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null