UserService
extends BaseService
in package
User service containing all the logic to make API calls.
Table of Contents
- $client : EasyPostClient
- allApiKeys() : mixed
- Retrieve a list of all API keys.
- allChildren() : mixed
- Retrieve all child users.
- apiKeys() : mixed
- Retrieve a list of API keys (works for the authenticated user or a child user).
- create() : mixed
- Create a child user.
- delete() : void
- Delete a user.
- getNextPageOfChildren() : mixed
- Retrieve the next page of child User collection
- retrieve() : mixed
- Retrieve a user.
- retrieveMe() : mixed
- Retrieve the authenticated user.
- update() : mixed
- Update a user.
- updateBrand() : mixed
- Update the User's Brand object.
- __construct() : mixed
- Service constructor shared by all child services.
- allResources() : mixed
- Internal retrieve all method.
- className() : string
- The class name of an object.
- classUrl() : string
- The class URL of an object.
- createResource() : mixed
- Internal create method.
- deleteResource() : void
- Internal delete method.
- getNextPageResources() : mixed
- Internal retrieve next page method.
- instanceUrl() : string
- The instance URL of an object.
- retrieveResource() : mixed
- Internal retrieve method.
- serviceModelClassName() : string
- Gets the class name of a Service's model.
- updateResource() : mixed
- Internal update method.
- validate() : void
- Validate library usage.
Properties
$client
protected
EasyPostClient
$client
Methods
allApiKeys()
Retrieve a list of all API keys.
public
allApiKeys() : mixed
Tags
Return values
mixed —allChildren()
Retrieve all child users.
public
allChildren([mixed $params = null ]) : mixed
Parameters
- $params : mixed = null
Return values
mixed —apiKeys()
Retrieve a list of API keys (works for the authenticated user or a child user).
public
apiKeys(string $id) : mixed
Parameters
- $id : string
Tags
Return values
mixed —create()
Create a child user.
public
create([mixed $params = null ]) : mixed
Parameters
- $params : mixed = null
Return values
mixed —delete()
Delete a user.
public
delete(string $id[, mixed $params = null ]) : void
Parameters
- $id : string
- $params : mixed = null
Return values
void —getNextPageOfChildren()
Retrieve the next page of child User collection
public
getNextPageOfChildren(mixed $children[, int|null $pageSize = null ]) : mixed
Parameters
- $children : mixed
- $pageSize : int|null = null
Return values
mixed —retrieve()
Retrieve a user.
public
retrieve(string $id) : mixed
Parameters
- $id : string
Return values
mixed —retrieveMe()
Retrieve the authenticated user.
public
retrieveMe() : mixed
Return values
mixed —update()
Update a user.
public
update(string $id, mixed $params) : mixed
Parameters
- $id : string
- $params : mixed
Return values
mixed —updateBrand()
Update the User's Brand object.
public
updateBrand(string $id[, mixed $params = null ]) : mixed
Parameters
- $id : string
- $params : mixed = null
Return values
mixed —__construct()
Service constructor shared by all child services.
protected
__construct(EasyPostClient $client) : mixed
Parameters
- $client : EasyPostClient
Return values
mixed —allResources()
Internal retrieve all method.
protected
allResources(string $class[, mixed $params = null ][, bool $beta = false ]) : mixed
Parameters
- $class : string
- $params : mixed = null
- $beta : bool = false
Return values
mixed —className()
The class name of an object.
protected
static className(string $class) : string
Parameters
- $class : string
Return values
string —classUrl()
The class URL of an object.
protected
static classUrl(string $class) : string
Parameters
- $class : string
Return values
string —createResource()
Internal create method.
protected
createResource(string $class[, mixed $params = null ][, bool $beta = false ]) : mixed
Parameters
- $class : string
- $params : mixed = null
- $beta : bool = false
Return values
mixed —deleteResource()
Internal delete method.
protected
deleteResource(string $class, string $id[, mixed $params = null ][, bool $beta = false ]) : void
Parameters
- $class : string
- $id : string
- $params : mixed = null
- $beta : bool = false
Return values
void —getNextPageResources()
Internal retrieve next page method.
protected
getNextPageResources(string $class, mixed $collection[, int|null $pageSize = null ]) : mixed
TODO: Use this method in EndShipper and Batch once the API fully support it.
Parameters
- $class : string
- $collection : mixed
- $pageSize : int|null = null
Return values
mixed —instanceUrl()
The instance URL of an object.
protected
instanceUrl(string $class, string $id) : string
Parameters
- $class : string
- $id : string
Tags
Return values
string —retrieveResource()
Internal retrieve method.
protected
retrieveResource(string $class, string $id[, bool $beta = false ]) : mixed
Parameters
- $class : string
- $id : string
- $beta : bool = false
Return values
mixed —serviceModelClassName()
Gets the class name of a Service's model.
protected
static serviceModelClassName(string $serviceClassName) : string
Parameters
- $serviceClassName : string
Return values
string —updateResource()
Internal update method.
protected
updateResource(string $class, string $id[, mixed $params = null ][, string|null $method = 'patch' ][, bool $beta = false ]) : mixed
Parameters
- $class : string
- $id : string
- $params : mixed = null
- $method : string|null = 'patch'
- $beta : bool = false
Return values
mixed —validate()
Validate library usage.
protected
static validate([mixed $params = null ]) : void
Parameters
- $params : mixed = null