Documentation

FirstPromoterClient
in package

Table of Contents

Constants

ACTION_CANCELLATION  = 'cancellation'
ACTION_CREATE  = 'create'
ACTION_DELETE  = 'DELETE'
ACTION_LIST  = 'list'
ACTION_METHOD_DELETE  = 'DELETE'
ACTION_METHOD_GET  = 'GET'
ACTION_METHOD_POST  = 'POST'
ACTION_METHOD_PUT  = 'PUT'
ACTION_MOVE_TO_CAMPAIGN  = 'move_to_campaign'
ACTION_REFRESH_TOKEN  = 'refresh_token'
ACTION_REFUND  = 'refund'
ACTION_SALE  = 'sale'
ACTION_SHOW  = 'show'
ACTION_SIGNUP  = 'signup'
ACTION_UPDATE  = 'update'
ALLOWED_RESOURCE_ACTIONS  = [self::RESOURCE_TRACKING => [self::ACTION_SIGNUP], self::RESOURCE_PROMOTER => [self::ACTION_SHOW], self::RESOURCE_LEAD => [self::ACTION_SHOW, self::ACTION_UPDATE]]
ALLOWED_RESOURCES  = [self::RESOURCE_TRACKING, self::RESOURCE_LEAD, self::RESOURCE_PROMOTER]
RESOURCE_ACTION_METHOD  = [self::ACTION_LIST => self::ACTION_METHOD_GET, self::ACTION_SHOW => self::ACTION_METHOD_GET, self::ACTION_MOVE_TO_CAMPAIGN => self::ACTION_METHOD_GET, self::ACTION_SIGNUP => self::ACTION_METHOD_POST, self::ACTION_SALE => self::ACTION_METHOD_POST, self::ACTION_REFUND => self::ACTION_METHOD_POST, self::ACTION_CANCELLATION => self::ACTION_METHOD_POST, self::ACTION_CREATE => self::ACTION_METHOD_POST, self::ACTION_UPDATE => self::ACTION_METHOD_PUT, self::ACTION_REFRESH_TOKEN => self::ACTION_METHOD_PUT, self::ACTION_DELETE => self::ACTION_METHOD_DELETE]
RESOURCE_LEAD  = 'leads'
RESOURCE_PROMOTER  = 'promoters'
RESOURCE_REWARD  = 'reward'
RESOURCE_TRACKING  = 'track'
CONNECT_TIMEOUT  = 10
FPROM_API_BASE_URI  = 'https://firstpromoter.com/api/v1/'
REQUEST_TIMEOUT  = 20

Properties

$httpClient  : Client
$isEnabled  : bool
$logger  : Logger

Methods

__call()  : mixed
__construct()  : mixed
trackSignup()  : void
_doCall()  : mixed
doCall()  : mixed
getApiBaseUri()  : string

Constants

ALLOWED_RESOURCE_ACTIONS

public mixed ALLOWED_RESOURCE_ACTIONS = [self::RESOURCE_TRACKING => [self::ACTION_SIGNUP], self::RESOURCE_PROMOTER => [self::ACTION_SHOW], self::RESOURCE_LEAD => [self::ACTION_SHOW, self::ACTION_UPDATE]]

ALLOWED_RESOURCES

public mixed ALLOWED_RESOURCES = [self::RESOURCE_TRACKING, self::RESOURCE_LEAD, self::RESOURCE_PROMOTER]

RESOURCE_ACTION_METHOD

public mixed RESOURCE_ACTION_METHOD = [self::ACTION_LIST => self::ACTION_METHOD_GET, self::ACTION_SHOW => self::ACTION_METHOD_GET, self::ACTION_MOVE_TO_CAMPAIGN => self::ACTION_METHOD_GET, self::ACTION_SIGNUP => self::ACTION_METHOD_POST, self::ACTION_SALE => self::ACTION_METHOD_POST, self::ACTION_REFUND => self::ACTION_METHOD_POST, self::ACTION_CANCELLATION => self::ACTION_METHOD_POST, self::ACTION_CREATE => self::ACTION_METHOD_POST, self::ACTION_UPDATE => self::ACTION_METHOD_PUT, self::ACTION_REFRESH_TOKEN => self::ACTION_METHOD_PUT, self::ACTION_DELETE => self::ACTION_METHOD_DELETE]

FPROM_API_BASE_URI

private mixed FPROM_API_BASE_URI = 'https://firstpromoter.com/api/v1/'

Properties

Methods

__call()

public __call(mixed $method, mixed $args) : mixed
Parameters
$method : mixed
$args : mixed

__construct()

public __construct(Logger $logger) : mixed
Parameters
$logger : Logger

_doCall()

private _doCall(string $method, string $uri[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
$method : string
$uri : string
$options : array<string|int, mixed> = []

doCall()

private doCall(mixed $resource, mixed $action, mixed $args) : mixed
Parameters
$resource : mixed
$action : mixed
$args : mixed

        
On this page

Search results