DepositFinder
in package
Uses
ValidatesQueryTrait
Tags
Table of Contents
- $client : Client
- __construct() : mixed
- buildQueryString() : array<string|int, mixed>
- Build an array of query params to be sent in the call
- find() : DepositList
- Finds deposits matching the criteria.
- findOne() : Deposit|null
- Find one deposit
- validateQuery() : mixed
Properties
$client
private
Client
$client
Tags
Methods
__construct()
public
__construct(Client $client) : mixed
Parameters
- $client : Client
Tags
Return values
mixed —buildQueryString()
Build an array of query params to be sent in the call
public
buildQueryString(Query $query) : array<string|int, mixed>
Parameters
- $query : Query
Tags
Return values
array<string|int, mixed> —find()
Finds deposits matching the criteria.
public
find(Query $query) : DepositList
TS docs reference for more detailed descriptions
Query parameter must have the following value:
organization_id: <string> T-hub Organization UUID
Query parameter can have the following values:
available_on_before: <int> unix timestamp
available_on_after: <int> unix timestamp
created_before: <int> unix timestamp
created_after: <int> unix timestamp
currency: <string> case-sensitive
deposit_account: <string> UUID
location_id: <string> T-hub Location UUID
net_amount: <int>
status: <string> Options: paid, pending, in_transit, canceled, failed: alphanumeric - exact match (case-insensitive)
`order_by:
reconciled: <boolean>
page: <int>
page_size: <int>
Parameters
- $query : Query
Tags
Return values
DepositList —findOne()
Find one deposit
public
findOne(Query $query) : Deposit|null
Query parameter must have the following values:
id: <string> e.g. dep_343d42bcb694a3d2ecd1b380426a
organization_id: <string> T-hub Organization UUID
Parameters
- $query : Query
Tags
Return values
Deposit|null —validateQuery()
public
validateQuery(Query $query, array<string|int, mixed> $requiredParameters) : mixed
Parameters
- $query : Query
- $requiredParameters : array<string|int, mixed>