Client
in package
Class Client
Do not instantiate API client directly! Use ClientFactory, SimpleClientFactory or ClientBuilder.
Tags
Table of Contents
Properties
- $api : Api
- $costs : Costs
- $customerInteraction : CustomerInteraction
- $customers : Customers
- $customersCorporate : CustomersCorporate
- $customFields : CustomFields
- $customMethods : CustomMethods
- $delivery : Delivery
- $features : Features
- $files : Files
- $integration : Integration
- $loyalty : Loyalty
- $notifications : Notifications
- $orders : Orders
- $packs : Packs
- $payments : Payments
- $references : References
- $segments : Segments
- $settings : Settings
- $statistics : Statistics
- $store : Store
- $tasks : Tasks
- $telephony : Telephony
- $users : Users
- $verification : Verification
- $webAnalytics : WebAnalytics
Methods
- __construct() : mixed
- Client constructor.
- getStreamFactory() : StreamFactoryInterface
- Returns PSR-17 stream factory.
Properties
$api
public
Api
$api
$costs
public
Costs
$costs
$customerInteraction
public
CustomerInteraction
$customerInteraction
$customers
public
Customers
$customers
$customersCorporate
public
CustomersCorporate
$customersCorporate
$customFields
public
CustomFields
$customFields
$customMethods
public
CustomMethods
$customMethods
$delivery
public
Delivery
$delivery
$features
public
Features
$features
$files
public
Files
$files
$integration
public
Integration
$integration
$loyalty
public
Loyalty
$loyalty
$notifications
public
Notifications
$notifications
$orders
public
Orders
$orders
$packs
public
Packs
$packs
$payments
public
Payments
$payments
$references
public
References
$references
$segments
public
Segments
$segments
$settings
public
Settings
$settings
$statistics
public
Statistics
$statistics
$store
public
Store
$store
$tasks
public
Tasks
$tasks
$telephony
public
Telephony
$telephony
$users
public
Users
$users
$verification
public
Verification
$verification
$webAnalytics
public
WebAnalytics
$webAnalytics
Methods
__construct()
Client constructor.
public
__construct(string $apiUrl, ClientInterface $httpClient, RequestTransformerInterface $requestTransformer, ResponseTransformerInterface $responseTransformer, StreamFactoryInterface $streamFactory[, EventDispatcherInterface|null $eventDispatcher = null ][, LoggerInterface|null $logger = null ]) : mixed
Parameters
- $apiUrl : string
- $httpClient : ClientInterface
- $requestTransformer : RequestTransformerInterface
- $responseTransformer : ResponseTransformerInterface
- $streamFactory : StreamFactoryInterface
- $eventDispatcher : EventDispatcherInterface|null = null
- $logger : LoggerInterface|null = null
Tags
getStreamFactory()
Returns PSR-17 stream factory.
public
getStreamFactory() : StreamFactoryInterface
StreamFactory can be used to create a PSR-7 StreamInterface from various sources.