PHP Class EasyPost\User

Inheritance: extends EasypostResource

Show file Open project: easypost/easypost-php Class Usage Examples

Public Methods

Method	Description
all_api_keys ( null $apiKey = null ) : mixed	get all API keys
api_keys ( string $apiKey = null ) : array \| null	api keys
create ( mixed $params = null, string $apiKey = null ) : mixed	create a user
retrieve ( string $id, string $apiKey = null ) : mixed	retrieve a user
retrieve_me ( string $apiKey = null ) : mixed	retrieve me
save ( )	save a user

Method Details

all_api_keys() public static method

get all API keys

public static all_api_keys ( null $apiKey = null ) : mixed
$apiKey	null
return	mixed

api_keys() public method

api keys

public api_keys ( string $apiKey = null ) : array \| null
$apiKey	string
return	array \| null

create() public static method

create a user

public static create ( mixed $params = null, string $apiKey = null ) : mixed
$params	mixed
$apiKey	string
return	mixed

retrieve() public static method

retrieve a user

public static retrieve ( string $id, string $apiKey = null ) : mixed
$id	string
$apiKey	string
return	mixed

retrieve_me() public static method

retrieve me

public static retrieve_me ( string $apiKey = null ) : mixed
$apiKey	string
return	mixed

save() public method

save a user

public save ( )