CouponRedemption extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_account : mixed
- $_coupon : mixed
- $_created_at : mixed
- $_currency : mixed
- $_discounted : mixed
- $_id : mixed
- $_object : mixed
- $_removed_at : mixed
- $_response : mixed
- $_state : mixed
- $_subscription_id : mixed
- $_updated_at : 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.
- getAccount() : AccountMini|null
- Getter method for the account attribute.
- getCoupon() : Coupon|null
- Getter method for the coupon attribute.
- getCreatedAt() : string|null
- Getter method for the created_at attribute.
- getCurrency() : string|null
- Getter method for the currency attribute.
- getDiscounted() : float|null
- Getter method for the discounted attribute.
- getId() : string|null
- Getter method for the id attribute.
- getObject() : string|null
- Getter method for the object attribute.
- getRemovedAt() : string|null
- Getter method for the removed_at attribute.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getState() : string|null
- Getter method for the state attribute.
- getSubscriptionId() : string|null
- Getter method for the subscription_id attribute.
- getUpdatedAt() : string|null
- Getter method for the updated_at attribute.
- setAccount() : void
- Setter method for the account attribute.
- setCoupon() : void
- Setter method for the coupon attribute.
- setCreatedAt() : void
- Setter method for the created_at attribute.
- setCurrency() : void
- Setter method for the currency attribute.
- setDiscounted() : void
- Setter method for the discounted attribute.
- setId() : void
- Setter method for the id attribute.
- setObject() : void
- Setter method for the object attribute.
- setRemovedAt() : void
- Setter method for the removed_at attribute.
- setState() : void
- Setter method for the state attribute.
- setSubscriptionId() : void
- Setter method for the subscription_id attribute.
- setUpdatedAt() : void
- Setter method for the updated_at 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
= []
$_account
private
mixed
$_account
$_coupon
private
mixed
$_coupon
$_created_at
private
mixed
$_created_at
$_currency
private
mixed
$_currency
$_discounted
private
mixed
$_discounted
$_id
private
mixed
$_id
$_object
private
mixed
$_object
$_removed_at
private
mixed
$_removed_at
$_response
private
mixed
$_response
$_state
private
mixed
$_state
$_subscription_id
private
mixed
$_subscription_id
$_updated_at
private
mixed
$_updated_at
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
getAccount()
Getter method for the account attribute.
public
getAccount() : AccountMini|null
The Account on which the coupon was applied.
Return values
AccountMini|null —getCoupon()
Getter method for the coupon attribute.
public
getCoupon() : Coupon|null
Return values
Coupon|null —getCreatedAt()
Getter method for the created_at attribute.
public
getCreatedAt() : string|null
Created at
Return values
string|null —getCurrency()
Getter method for the currency attribute.
public
getCurrency() : string|null
3-letter ISO 4217 currency code.
Return values
string|null —getDiscounted()
Getter method for the discounted attribute.
public
getDiscounted() : float|null
The amount that was discounted upon the application of the coupon, formatted with the currency.
Return values
float|null —getId()
Getter method for the id attribute.
public
getId() : string|null
Coupon Redemption ID
Return values
string|null —getObject()
Getter method for the object attribute.
public
getObject() : string|null
Will always be coupon.
Return values
string|null —getRemovedAt()
Getter method for the removed_at attribute.
public
getRemovedAt() : string|null
The date and time the redemption was removed from the account (un-redeemed).
Return values
string|null —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getState()
Getter method for the state attribute.
public
getState() : string|null
Coupon Redemption state
Return values
string|null —getSubscriptionId()
Getter method for the subscription_id attribute.
public
getSubscriptionId() : string|null
Subscription ID
Return values
string|null —getUpdatedAt()
Getter method for the updated_at attribute.
public
getUpdatedAt() : string|null
Last updated at
Return values
string|null —setAccount()
Setter method for the account attribute.
public
setAccount(AccountMini $account) : void
Parameters
- $account : AccountMini
Return values
void —setCoupon()
Setter method for the coupon attribute.
public
setCoupon(Coupon $coupon) : void
Parameters
- $coupon : Coupon
Return values
void —setCreatedAt()
Setter method for the created_at attribute.
public
setCreatedAt(string $created_at) : void
Parameters
- $created_at : string
Return values
void —setCurrency()
Setter method for the currency attribute.
public
setCurrency(string $currency) : void
Parameters
- $currency : string
Return values
void —setDiscounted()
Setter method for the discounted attribute.
public
setDiscounted(float $discounted) : void
Parameters
- $discounted : float
Return values
void —setId()
Setter method for the id attribute.
public
setId(string $id) : void
Parameters
- $id : string
Return values
void —setObject()
Setter method for the object attribute.
public
setObject(string $object) : void
Parameters
- $object : string
Return values
void —setRemovedAt()
Setter method for the removed_at attribute.
public
setRemovedAt(string $removed_at) : void
Parameters
- $removed_at : string
Return values
void —setState()
Setter method for the state attribute.
public
setState(string $state) : void
Parameters
- $state : string
Return values
void —setSubscriptionId()
Setter method for the subscription_id attribute.
public
setSubscriptionId(string $subscription_id) : void
Parameters
- $subscription_id : 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 —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