AddressAdd
extends BaseComponent
in package
AddressAdd Model
Table of Contents
Properties
- $city : string
- $country : string|null
- $line_one : string
- $line_three : string|null
- $line_two : string|null
- $mailing_address : bool
- $postal_code : string|null
- $primary : bool
- $province : string|null
- $region : string|null
- $salutations : Salutations
- $state : string|null
- $type_id : int
- $user_id : int
- $fields : array<string|int, string>
Properties
$city
public
string
$city
City (Charleston)
$country
public
string|null
$country
Country full name (United States)
$line_one
public
string
$line_one
Address Line 1 (123 Main Street)
$line_three
public
string|null
$line_three
Address Line 3
$line_two
public
string|null
$line_two
Address Line 2 (Suite 100)
$mailing_address
public
bool
$mailing_address
Set to true to set this address as the mailing address
$postal_code
public
string|null
$postal_code
Postal code
$primary
public
bool
$primary
Set to true to make this the primary address
$province
public
string|null
$province
Province
$region
public
string|null
$region
Region
$salutations
public
Salutations
$salutations
Salutations Model
$state
public
string|null
$state
State 2 letter abbreviation (SC) or full name. Required only if Country property is United States
$type_id
public
int
$type_id
Address Type ID associated with an address. The list of address types can be found using the GET Users Address Types List.
$user_id
public
int
$user_id
The ID of the user of the address
$fields
protected
static array<string|int, string>
$fields
= ["user_id" => "int", "type_id" => "int", "salutations" => "\\Blackbaud\\SKY\\School\\Components\\Salutations", "country" => "string", "line_one" => "string", "line_two" => "string", "line_three" => "string", "city" => "string", "state" => "string", "postal_code" => "string", "province" => "string", "region" => "string", "mailing_address" => "bool", "primary" => "bool"]