AddressPatch
extends BaseComponent
in package
AddressPatch Model
Table of Contents
Properties
- $city : string|null
- $country : string|null
- $fields_to_delete : array<string|int, string>|null
- $id : int
- $line_one : string|null
- $line_three : string|null
- $line_two : string|null
- $links : array<string|int, AddressTypeLink>|null
- $mailing_address : bool
- $postal_code : string|null
- $primary : bool
- $province : string|null
- $region : string|null
- $salutations : Salutations
- $state : string|null
- $type_id : int|null
- $user_id : int|null
- $fields : array<string|int, string>
Properties
$city
public
string|null
$city
The city for the address
$country
public
string|null
$country
The country for the address
$fields_to_delete
public
array<string|int, string>|null
$fields_to_delete
An array of strings representing field names. Due to an inherent check against deleting data only accessible through the UI, this unusual step is necessary. To delete or clear data from a user field (such as line_two or line_three), you must include the field in this array. If a field is included in this array, the data for that field will be deleted and this will override any other value set for the field in the request body. Only fields that can be cleared will be processed. Any required fields, Booleans or fields with no blank option will be ignored. Allowed values: The field name as listed for the request body (e.g. "line_two" or "line_three").
$id
public
int
$id
The ID of the address
$line_one
public
string|null
$line_one
The first line of the address
$line_three
public
string|null
$line_three
The third line of the address
$line_two
public
string|null
$line_two
The second line of the address
$links
public
array<string|int, AddressTypeLink>|null
$links
Returns each instance of an address type for each relationship to the user
$mailing_address
public
bool
$mailing_address
Returns True if user accepts mail from the address
$postal_code
public
string|null
$postal_code
The postal code for the address
$primary
public
bool
$primary
Returns true if the address is primary
$province
public
string|null
$province
The province for the address
$region
public
string|null
$region
The region for the address
$salutations
public
Salutations
$salutations
Salutations Model
$state
public
string|null
$state
The state for the address
$type_id
public
int|null
$type_id
The type ID associated with an address that is based upon a user's primary relationship to the address
$user_id
public
int|null
$user_id
The ID of the user of the address
$fields
protected
static array<string|int, string>
$fields
= ["id" => "int", "city" => "string", "country" => "string", "line_one" => "string", "line_two" => "string", "line_three" => "string", "mailing_address" => "bool", "postal_code" => "string", "primary" => "bool", "province" => "string", "region" => "string", "state" => "string", "type_id" => "int", "user_id" => "int", "links" => "\\Blackbaud\\SKY\\School\\Components\\AddressTypeLink[]", "salutations" => "\\Blackbaud\\SKY\\School\\Components\\Salutations", "fields_to_delete" => "string[]"]