CustomerSettingsApi
extends V3ApiBase
in package
Uses
GetResource, UpdateResource
V3ApiBase
Add constructors and some basic scaffolding that will work for all API classes regardless of which endpoints they implement
Tags
Table of Contents
- CUSTOMER_SETTINGS_ENDPOINT = 'customers/settings'
- __construct() : mixed
- channel() : CustomerSettingsPerChannelApi
- get() : CustomerSettingsResponse
- getClient() : Client
- getParentResourceId() : int|null
- getResourceId() : int|null
- singleResourceUrl() : string
- update() : CustomerSettingsResponse
Constants
CUSTOMER_SETTINGS_ENDPOINT
public
mixed
CUSTOMER_SETTINGS_ENDPOINT
= 'customers/settings'
Tags
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 —channel()
public
channel(int $channelId) : CustomerSettingsPerChannelApi
Parameters
- $channelId : int
Tags
Return values
CustomerSettingsPerChannelApi —get()
public
get() : CustomerSettingsResponse
Tags
Return values
CustomerSettingsResponse —getClient()
public
getClient() : Client
Tags
Return values
Client —getParentResourceId()
public
getParentResourceId() : int|null
Tags
Return values
int|null —getResourceId()
public
getResourceId() : int|null
Tags
Return values
int|null —singleResourceUrl()
public
singleResourceUrl() : string
Tags
Return values
string —update()
public
update(CustomerSettings $settings) : CustomerSettingsResponse
Parameters
- $settings : CustomerSettings