ProductApi
extends BaseApi
in package
Table of Contents
Properties
Methods
- __construct() : mixed
- BaseApi constructor.
- all() : array{message: string, data: array}
- Get products history <code> <?php $response = $olc->products()->all(); ?> </code>
- getDetailsByType() : array{message: string, data: array}
- Get product details by product type details <code> <?php $response = $olc->products()->getDetailsByType('Personal Letters'); ?> </code>'
- getTemplateById() : array{message: string, data: array}
- Get product template details <code> <?php $response = $olc->products()->getTemplateById(87); ?> </code>'
- productTypes() : array{message: string, data: array}
- Get product types <code> <?php $response = $olc->products()->productTypes(); ?> </code>
- getInstance() : OlcInstance
- Gets the OlcInstance that this API is associated with.
Properties
$_olcInstance
private
OlcInstance
$_olcInstance
Methods
__construct()
BaseApi constructor.
public
__construct(OlcInstance $_olcInstance) : mixed
Parameters
- $_olcInstance : OlcInstance
-
OlcInstance that this API is associated with
all()
Get products history <code> <?php $response = $olc->products()->all(); ?> </code>
public
all([array<string|int, mixed> $params = [] ]) : array{message: string, data: array}
Parameters
- $params : array<string|int, mixed> = []
-
Parameters to send with the request.
Tags
Return values
array{message: string, data: array} —The response data.
getDetailsByType()
Get product details by product type details <code> <?php $response = $olc->products()->getDetailsByType('Personal Letters'); ?> </code>'
public
getDetailsByType(string $productType) : array{message: string, data: array}
Parameters
- $productType : string
-
Product type
Tags
Return values
array{message: string, data: array} —The response data.
getTemplateById()
Get product template details <code> <?php $response = $olc->products()->getTemplateById(87); ?> </code>'
public
getTemplateById(int $templateId) : array{message: string, data: array}
Parameters
- $templateId : int
-
The template ID
Tags
Return values
array{message: string, data: array} —The response data.
productTypes()
Get product types <code> <?php $response = $olc->products()->productTypes(); ?> </code>
public
productTypes([array<string|int, mixed> $params = [] ]) : array{message: string, data: array}
Parameters
- $params : array<string|int, mixed> = []
-
Parameters to send with the request.
Tags
Return values
array{message: string, data: array} —The response data.
getInstance()
Gets the OlcInstance that this API is associated with.
protected
getInstance() : OlcInstance