BusinessEntity extends RecurlyResource
Table of Contents
- $array_hints : mixed
- $_code : mixed
- $_created_at : mixed
- $_default_liability_gl_account_id : mixed
- $_default_registration_number : mixed
- $_default_revenue_gl_account_id : mixed
- $_default_vat_number : mixed
- $_destination_tax_address_source : mixed
- $_id : mixed
- $_invoice_display_address : mixed
- $_name : mixed
- $_object : mixed
- $_origin_tax_address_source : mixed
- $_response : mixed
- $_subscriber_location_countries : mixed
- $_tax_address : 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.
- getCode() : string|null
- Getter method for the code attribute.
- getCreatedAt() : string|null
- Getter method for the created_at attribute.
- getDefaultLiabilityGlAccountId() : string|null
- Getter method for the default_liability_gl_account_id attribute.
- getDefaultRegistrationNumber() : string|null
- Getter method for the default_registration_number attribute.
- getDefaultRevenueGlAccountId() : string|null
- Getter method for the default_revenue_gl_account_id attribute.
- getDefaultVatNumber() : string|null
- Getter method for the default_vat_number attribute.
- getDestinationTaxAddressSource() : string|null
- Getter method for the destination_tax_address_source attribute.
- getId() : string|null
- Getter method for the id attribute.
- getInvoiceDisplayAddress() : Address|null
- Getter method for the invoice_display_address attribute.
- getName() : string|null
- Getter method for the name attribute.
- getObject() : string|null
- Getter method for the object attribute.
- getOriginTaxAddressSource() : string|null
- Getter method for the origin_tax_address_source attribute.
- getResponse() : Response
- Getter for the Recurly HTTP Response
- getSubscriberLocationCountries() : array<string|int, mixed>
- Getter method for the subscriber_location_countries attribute.
- getTaxAddress() : Address|null
- Getter method for the tax_address attribute.
- getUpdatedAt() : string|null
- Getter method for the updated_at attribute.
- setCode() : void
- Setter method for the code attribute.
- setCreatedAt() : void
- Setter method for the created_at attribute.
- setDefaultLiabilityGlAccountId() : void
- Setter method for the default_liability_gl_account_id attribute.
- setDefaultRegistrationNumber() : void
- Setter method for the default_registration_number attribute.
- setDefaultRevenueGlAccountId() : void
- Setter method for the default_revenue_gl_account_id attribute.
- setDefaultVatNumber() : void
- Setter method for the default_vat_number attribute.
- setDestinationTaxAddressSource() : void
- Setter method for the destination_tax_address_source attribute.
- setId() : void
- Setter method for the id attribute.
- setInvoiceDisplayAddress() : void
- Setter method for the invoice_display_address attribute.
- setName() : void
- Setter method for the name attribute.
- setObject() : void
- Setter method for the object attribute.
- setOriginTaxAddressSource() : void
- Setter method for the origin_tax_address_source attribute.
- setSubscriberLocationCountries() : void
- Setter method for the subscriber_location_countries attribute.
- setTaxAddress() : void
- Setter method for the tax_address 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
= ['setSubscriberLocationCountries' => 'string']
$_code
private
mixed
$_code
$_created_at
private
mixed
$_created_at
$_default_liability_gl_account_id
private
mixed
$_default_liability_gl_account_id
$_default_registration_number
private
mixed
$_default_registration_number
$_default_revenue_gl_account_id
private
mixed
$_default_revenue_gl_account_id
$_default_vat_number
private
mixed
$_default_vat_number
$_destination_tax_address_source
private
mixed
$_destination_tax_address_source
$_id
private
mixed
$_id
$_invoice_display_address
private
mixed
$_invoice_display_address
$_name
private
mixed
$_name
$_object
private
mixed
$_object
$_origin_tax_address_source
private
mixed
$_origin_tax_address_source
$_response
private
mixed
$_response
$_subscriber_location_countries
private
mixed
$_subscriber_location_countries
$_tax_address
private
mixed
$_tax_address
$_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
getCode()
Getter method for the code attribute.
public
getCode() : string|null
The entity code of the business entity.
Return values
string|null —getCreatedAt()
Getter method for the created_at attribute.
public
getCreatedAt() : string|null
Created at
Return values
string|null —getDefaultLiabilityGlAccountId()
Getter method for the default_liability_gl_account_id attribute.
public
getDefaultLiabilityGlAccountId() : string|null
The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
Return values
string|null —getDefaultRegistrationNumber()
Getter method for the default_registration_number attribute.
public
getDefaultRegistrationNumber() : string|null
Registration number for the customer used on the invoice.
Return values
string|null —getDefaultRevenueGlAccountId()
Getter method for the default_revenue_gl_account_id attribute.
public
getDefaultRevenueGlAccountId() : string|null
The ID of a general ledger account. General ledger accounts are only accessible as a part of the Recurly RevRec Standard and Recurly RevRec Advanced features.
Return values
string|null —getDefaultVatNumber()
Getter method for the default_vat_number attribute.
public
getDefaultVatNumber() : string|null
VAT number for the customer used on the invoice.
Return values
string|null —getDestinationTaxAddressSource()
Getter method for the destination_tax_address_source attribute.
public
getDestinationTaxAddressSource() : string|null
The source of the address that will be used as the destinaion in determining taxes. Available only when the site is on an Elite plan. A value of "destination" refers to the "Customer tax address". A value of "origin" refers to the "Business entity tax address".
Return values
string|null —getId()
Getter method for the id attribute.
public
getId() : string|null
Business entity ID
Return values
string|null —getInvoiceDisplayAddress()
Getter method for the invoice_display_address attribute.
public
getInvoiceDisplayAddress() : Address|null
Address information for the business entity that will appear on the invoice.
Return values
Address|null —getName()
Getter method for the name attribute.
public
getName() : string|null
This name describes your business entity and will appear on the invoice.
Return values
string|null —getObject()
Getter method for the object attribute.
public
getObject() : string|null
Object type
Return values
string|null —getOriginTaxAddressSource()
Getter method for the origin_tax_address_source attribute.
public
getOriginTaxAddressSource() : string|null
The source of the address that will be used as the origin in determining taxes. Available only when the site is on an Elite plan. A value of "origin" refers to the "Business entity tax address". A value of "destination" refers to the "Customer tax address".
Return values
string|null —getResponse()
Getter for the Recurly HTTP Response
public
getResponse() : Response
Return values
Response —The Recurly HTTP Response
getSubscriberLocationCountries()
Getter method for the subscriber_location_countries attribute.
public
getSubscriberLocationCountries() : array<string|int, mixed>
List of countries for which the business entity will be used.
Return values
array<string|int, mixed> —getTaxAddress()
Getter method for the tax_address attribute.
public
getTaxAddress() : Address|null
Address information for the business entity that will be used for calculating taxes.
Return values
Address|null —getUpdatedAt()
Getter method for the updated_at attribute.
public
getUpdatedAt() : string|null
Last updated at
Return values
string|null —setCode()
Setter method for the code attribute.
public
setCode(string $code) : void
Parameters
- $code : string
Return values
void —setCreatedAt()
Setter method for the created_at attribute.
public
setCreatedAt(string $created_at) : void
Parameters
- $created_at : string
Return values
void —setDefaultLiabilityGlAccountId()
Setter method for the default_liability_gl_account_id attribute.
public
setDefaultLiabilityGlAccountId(string $default_liability_gl_account_id) : void
Parameters
- $default_liability_gl_account_id : string
Return values
void —setDefaultRegistrationNumber()
Setter method for the default_registration_number attribute.
public
setDefaultRegistrationNumber(string $default_registration_number) : void
Parameters
- $default_registration_number : string
Return values
void —setDefaultRevenueGlAccountId()
Setter method for the default_revenue_gl_account_id attribute.
public
setDefaultRevenueGlAccountId(string $default_revenue_gl_account_id) : void
Parameters
- $default_revenue_gl_account_id : string
Return values
void —setDefaultVatNumber()
Setter method for the default_vat_number attribute.
public
setDefaultVatNumber(string $default_vat_number) : void
Parameters
- $default_vat_number : string
Return values
void —setDestinationTaxAddressSource()
Setter method for the destination_tax_address_source attribute.
public
setDestinationTaxAddressSource(string $destination_tax_address_source) : void
Parameters
- $destination_tax_address_source : string
Return values
void —setId()
Setter method for the id attribute.
public
setId(string $id) : void
Parameters
- $id : string
Return values
void —setInvoiceDisplayAddress()
Setter method for the invoice_display_address attribute.
public
setInvoiceDisplayAddress(Address $invoice_display_address) : void
Parameters
- $invoice_display_address : Address
Return values
void —setName()
Setter method for the name attribute.
public
setName(string $name) : void
Parameters
- $name : string
Return values
void —setObject()
Setter method for the object attribute.
public
setObject(string $object) : void
Parameters
- $object : string
Return values
void —setOriginTaxAddressSource()
Setter method for the origin_tax_address_source attribute.
public
setOriginTaxAddressSource(string $origin_tax_address_source) : void
Parameters
- $origin_tax_address_source : string
Return values
void —setSubscriberLocationCountries()
Setter method for the subscriber_location_countries attribute.
public
setSubscriberLocationCountries(array<string|int, mixed> $subscriber_location_countries) : void
Parameters
- $subscriber_location_countries : array<string|int, mixed>
Return values
void —setTaxAddress()
Setter method for the tax_address attribute.
public
setTaxAddress(Address $tax_address) : void
Parameters
- $tax_address : Address
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