DunningCycle extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_applies_to_manual_trial : mixed
- $_created_at : mixed
- $_expire_subscription : mixed
- $_fail_invoice : mixed
- $_first_communication_interval : mixed
- $_intervals : mixed
- $_response : mixed
- $_send_immediately_on_hard_decline : mixed
- $_total_dunning_days : mixed
- $_total_recycling_days : mixed
- $_type : mixed
- $_updated_at : mixed
- $_version : mixed
- __construct() : mixed
- Constructor
- __debugInfo() : array<string|int, mixed>
- Override of the magic method __debugInfo that will only return the relevant attributes of the \Recurly\RecurlyResource
- __set() : void
- Guard against setting invalid properties
- cast() : RecurlyResource
- Recursively converts a response object into a \Recurly\RecurlyResource.
- fromBinary() : BinaryFile
- Converts a binary response into a Recurly BinaryFile
- fromEmpty() : EmptyResource
- Returns a \Recurly\EmptyResource for API requests that do not have a response body.
- fromResponse() : RecurlyResource
- Converts a Recurly response object into a \Recurly\RecurlyResource.
- getAppliesToManualTrial() : bool|null
- Getter method for the applies_to_manual_trial attribute.
- getCreatedAt() : string|null
- Getter method for the created_at attribute.
- getExpireSubscription() : bool|null
- Getter method for the expire_subscription attribute.
- getFailInvoice() : bool|null
- Getter method for the fail_invoice attribute.
- getFirstCommunicationInterval() : int|null
- Getter method for the first_communication_interval attribute.
- getIntervals() : array<string|int, mixed>
- Getter method for the intervals attribute.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getSendImmediatelyOnHardDecline() : bool|null
- Getter method for the send_immediately_on_hard_decline attribute.
- getTotalDunningDays() : int|null
- Getter method for the total_dunning_days attribute.
- getTotalRecyclingDays() : int|null
- Getter method for the total_recycling_days attribute.
- getType() : string|null
- Getter method for the type attribute.
- getUpdatedAt() : string|null
- Getter method for the updated_at attribute.
- getVersion() : int|null
- Getter method for the version attribute.
- setAppliesToManualTrial() : void
- Setter method for the applies_to_manual_trial attribute.
- setCreatedAt() : void
- Setter method for the created_at attribute.
- setExpireSubscription() : void
- Setter method for the expire_subscription attribute.
- setFailInvoice() : void
- Setter method for the fail_invoice attribute.
- setFirstCommunicationInterval() : void
- Setter method for the first_communication_interval attribute.
- setIntervals() : void
- Setter method for the intervals attribute.
- setSendImmediatelyOnHardDecline() : void
- Setter method for the send_immediately_on_hard_decline attribute.
- setTotalDunningDays() : void
- Setter method for the total_dunning_days attribute.
- setTotalRecyclingDays() : void
- Setter method for the total_recycling_days attribute.
- setType() : void
- Setter method for the type attribute.
- setUpdatedAt() : void
- Setter method for the updated_at attribute.
- setVersion() : void
- Setter method for the version attribute.
- encodeApiKey() : string
- Base64 encodes the API key
- getUserAgent() : string
- Generates User-Agent for API requests
- hintArrayType() : string
- The hintArrayType method will provide type hinting for setter methods that have array parameters.
- resourceClass() : string
- Converts a string into a representation of a Recurly Resource
- setResponse() : void
- Setter for the Recurly HTTP Response
- setterParamClass() : string
- Uses the Reflection API to determine what \Recurly\RecurlyResource is the expected parameter for the given method.
- titleize() : string
- Capitalizes all the words in the $input.
Properties
$array_hints
protected
static mixed
$array_hints
= ['setIntervals' => '\Recurly\Resources\DunningInterval']
$_applies_to_manual_trial
private
mixed
$_applies_to_manual_trial
$_created_at
private
mixed
$_created_at
$_expire_subscription
private
mixed
$_expire_subscription
$_fail_invoice
private
mixed
$_fail_invoice
$_first_communication_interval
private
mixed
$_first_communication_interval
$_intervals
private
mixed
$_intervals
$_response
private
mixed
$_response
$_send_immediately_on_hard_decline
private
mixed
$_send_immediately_on_hard_decline
$_total_dunning_days
private
mixed
$_total_dunning_days
$_total_recycling_days
private
mixed
$_total_recycling_days
$_type
private
mixed
$_type
$_updated_at
private
mixed
$_updated_at
$_version
private
mixed
$_version
Methods
__construct()
Constructor
public
final __construct() : mixed
Return values
mixed —__debugInfo()
Override of the magic method __debugInfo that will only return the relevant attributes of the \Recurly\RecurlyResource
public
__debugInfo() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —__set()
Guard against setting invalid properties
public
__set(string $key, mixed $value) : void
Parameters
- $key : string
-
The parameter name that is being set
- $value : mixed
-
The parameter value that is being set
Tags
Return values
void —cast()
Recursively converts a response object into a \Recurly\RecurlyResource.
public
static cast(object $data) : RecurlyResource
Parameters
- $data : object
-
PHP Object containing the decoded JSON
Return values
RecurlyResource —An instance of a Recurly Resource
fromBinary()
Converts a binary response into a Recurly BinaryFile
public
static fromBinary(string $data, Response $response) : BinaryFile
Parameters
- $data : string
-
The binary file data
- $response : Response
-
(optional) The Recurly HTTP Response
Return values
BinaryFile —An instance of a Recurly BinaryFile
fromEmpty()
Returns a \Recurly\EmptyResource for API requests that do not have a response body.
public
static fromEmpty(Response $response) : EmptyResource
Parameters
- $response : Response
-
(optional) The Recurly HTTP Response
Return values
EmptyResource —fromResponse()
Converts a Recurly response object into a \Recurly\RecurlyResource.
public
static fromResponse(Response $response[, object $json = null ]) : RecurlyResource
Parameters
- $response : Response
-
The Recurly HTTP Response
- $json : object = null
-
(optional) JSON payload to use instead of the $response's. Primarily used for errors
Return values
RecurlyResource —An instance of a Recurly Resource
getAppliesToManualTrial()
Getter method for the applies_to_manual_trial attribute.
public
getAppliesToManualTrial() : bool|null
Whether the dunning settings will be applied to manual trials. Only applies to trial cycles.
Return values
bool|null —getCreatedAt()
Getter method for the created_at attribute.
public
getCreatedAt() : string|null
When the current settings were created in Recurly.
Return values
string|null —getExpireSubscription()
Getter method for the expire_subscription attribute.
public
getExpireSubscription() : bool|null
Whether the subscription(s) should be cancelled at the end of the dunning cycle.
Return values
bool|null —getFailInvoice()
Getter method for the fail_invoice attribute.
public
getFailInvoice() : bool|null
Whether the invoice should be failed at the end of the dunning cycle.
Return values
bool|null —getFirstCommunicationInterval()
Getter method for the first_communication_interval attribute.
public
getFirstCommunicationInterval() : int|null
The number of days after a transaction failure before the first dunning email is sent.
Return values
int|null —getIntervals()
Getter method for the intervals attribute.
public
getIntervals() : array<string|int, mixed>
Dunning intervals.
Return values
array<string|int, mixed> —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getSendImmediatelyOnHardDecline()
Getter method for the send_immediately_on_hard_decline attribute.
public
getSendImmediatelyOnHardDecline() : bool|null
Whether or not to send an extra email immediately to customers whose initial payment attempt fails with either a hard decline or invalid billing info.
Return values
bool|null —getTotalDunningDays()
Getter method for the total_dunning_days attribute.
public
getTotalDunningDays() : int|null
The number of days between the first dunning email being sent and the end of the dunning cycle.
Return values
int|null —getTotalRecyclingDays()
Getter method for the total_recycling_days attribute.
public
getTotalRecyclingDays() : int|null
The number of days between a transaction failure and the end of the dunning cycle.
Return values
int|null —getType()
Getter method for the type attribute.
public
getType() : string|null
The type of invoice this cycle applies to.
Return values
string|null —getUpdatedAt()
Getter method for the updated_at attribute.
public
getUpdatedAt() : string|null
When the current settings were updated in Recurly.
Return values
string|null —getVersion()
Getter method for the version attribute.
public
getVersion() : int|null
Current campaign version.
Return values
int|null —setAppliesToManualTrial()
Setter method for the applies_to_manual_trial attribute.
public
setAppliesToManualTrial(bool $applies_to_manual_trial) : void
Parameters
- $applies_to_manual_trial : bool
Return values
void —setCreatedAt()
Setter method for the created_at attribute.
public
setCreatedAt(string $created_at) : void
Parameters
- $created_at : string
Return values
void —setExpireSubscription()
Setter method for the expire_subscription attribute.
public
setExpireSubscription(bool $expire_subscription) : void
Parameters
- $expire_subscription : bool
Return values
void —setFailInvoice()
Setter method for the fail_invoice attribute.
public
setFailInvoice(bool $fail_invoice) : void
Parameters
- $fail_invoice : bool
Return values
void —setFirstCommunicationInterval()
Setter method for the first_communication_interval attribute.
public
setFirstCommunicationInterval(int $first_communication_interval) : void
Parameters
- $first_communication_interval : int
Return values
void —setIntervals()
Setter method for the intervals attribute.
public
setIntervals(array<string|int, mixed> $intervals) : void
Parameters
- $intervals : array<string|int, mixed>
Return values
void —setSendImmediatelyOnHardDecline()
Setter method for the send_immediately_on_hard_decline attribute.
public
setSendImmediatelyOnHardDecline(bool $send_immediately_on_hard_decline) : void
Parameters
- $send_immediately_on_hard_decline : bool
Return values
void —setTotalDunningDays()
Setter method for the total_dunning_days attribute.
public
setTotalDunningDays(int $total_dunning_days) : void
Parameters
- $total_dunning_days : int
Return values
void —setTotalRecyclingDays()
Setter method for the total_recycling_days attribute.
public
setTotalRecyclingDays(int $total_recycling_days) : void
Parameters
- $total_recycling_days : int
Return values
void —setType()
Setter method for the type attribute.
public
setType(string $type) : void
Parameters
- $type : string
Return values
void —setUpdatedAt()
Setter method for the updated_at attribute.
public
setUpdatedAt(string $updated_at) : void
Parameters
- $updated_at : string
Return values
void —setVersion()
Setter method for the version attribute.
public
setVersion(int $version) : void
Parameters
- $version : int
Return values
void —encodeApiKey()
Base64 encodes the API key
protected
static encodeApiKey(string $key) : string
Parameters
- $key : string
-
The API key to encode
Return values
string —base64 encoded API key
getUserAgent()
Generates User-Agent for API requests
protected
static getUserAgent() : string
Return values
string —Recurly client User-Agent string
hintArrayType()
The hintArrayType method will provide type hinting for setter methods that have array parameters.
protected
static hintArrayType(string $key) : string
Parameters
- $key : string
-
The property to get teh type hint for.
Return values
string —The class name of the expected array type.
resourceClass()
Converts a string into a representation of a Recurly Resource
protected
static resourceClass(string $type) : string
Parameters
- $type : string
-
A string to convert to a Recurly Resource
Return values
string —The string representation of a Recurly Resource
setResponse()
Setter for the Recurly HTTP Response
protected
setResponse(Response $response) : void
Parameters
- $response : Response
-
The Recurly HTTP Response
Return values
void —setterParamClass()
Uses the Reflection API to determine what \Recurly\RecurlyResource is the expected parameter for the given method.
protected
static setterParamClass(string $method) : string
Parameters
- $method : string
-
The name of the setter method to find the type hint for
Return values
string —The \Recurly\RecurlyResource that the setter method expects
titleize()
Capitalizes all the words in the $input.
protected
static titleize(string $input[, string $prefix = '' ]) : string
Parameters
- $input : string
-
The string to titleize
- $prefix : string = ''
-
(optional) Prefix to add to the beginning of the titleized string. The prefix will not be titleized.
Return values
string —The titleized $input wtih the prepended $prefix