README

This API manages constituent information and related entities such as addresses, phones, emails, and notes.

Installation & Usage

Requirements

PHP 7.2 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/burger-digital/blackbaud-php-sdk.git"
    }
  ],
  "require": {
    "burger-digital/blackbaud-php-sdk": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/Blackbaud Php Sdk/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure API key authorization: apiKeyHeader
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('Bb-Api-Subscription-Key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('Bb-Api-Subscription-Key', 'Bearer');

// Configure API key authorization: apiKeyQuery
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKey('subscription-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// $config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setApiKeyPrefix('subscription-key', 'Bearer');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');

// Configure OAuth2 access token for authorization: oauth2Blackbaud OAuth 2.0 ServiceImplicit
$config = BurgerDigital\BlackbaudPhpSdk\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BurgerDigital\BlackbaudPhpSdk\Api\ActionApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$action_add = new \BurgerDigital\BlackbaudPhpSdk\Model\ActionAdd(); // \BurgerDigital\BlackbaudPhpSdk\Model\ActionAdd | An object that represents the action to create.

try {
    $result = $apiInstance->createAction($action_add);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ActionApi->createAction: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.sky.blackbaud.com/constituent/v1

Class	Method	HTTP request	Description
ActionApi	createAction	POST /actions	Action (Create)
ActionApi	createActionAttachment	POST /actions/attachments	Action attachment (Create)
ActionApi	createActionCustomField	POST /actions/customfields	Action custom field (Create)
ActionApi	deleteAction	DELETE /actions/{action_id}	Action (Delete)
ActionApi	deleteActionAttachment	DELETE /actions/attachments/{attachment_id}	Action attachment (Delete)
ActionApi	deleteActionCustomField	DELETE /actions/customfields/{custom_field_id}	Action custom field (Delete)
ActionApi	editAction	PATCH /actions/{action_id}	Action (Edit)
ActionApi	editActionAttachment	PATCH /actions/attachments/{attachment_id}	Action attachment (Edit)
ActionApi	editActionCustomField	PATCH /actions/customfields/{custom_field_id}	Action custom field (Edit)
ActionApi	getAction	GET /actions/{action_id}	Action (Get)
ActionApi	listActionAttachmentsSingleAction	GET /actions/{action_id}/attachments	Action attachment list (Single action)
ActionApi	listActionCustomFieldCategories	GET /actions/customfields/categories	Action custom field categories
ActionApi	listActionCustomFieldCategoryDetails	GET /actions/customfields/categories/details	Action custom field category details
ActionApi	listActionCustomFieldCategoryValues	GET /actions/customfields/categories/values	Action custom field category values
ActionApi	listActionCustomFieldsSingleAction	GET /actions/{action_id}/customfields	Action custom field list (Single action)
ActionApi	listActionLocations	GET /actionlocations	Action locations
ActionApi	listActionStatusTypes	GET /actionstatustypes	Action status types
ActionApi	listActionTypes	GET /actiontypes	Action types
ActionApi	listActionsAllConstituents	GET /actions	Action list (All constituents)
ActionApi	listActionsSingleConstituent	GET /constituents/{constituent_id}/actions	Action list (Single constituent)
AddressApi	createConstituentAddress	POST /addresses	Address (Create)
AddressApi	deleteConstituentAddress	DELETE /addresses/{address_id}	Address (Delete)
AddressApi	editConstituentAddress	PATCH /addresses/{address_id}	Address (Edit)
AddressApi	getConstituentAddress	GET /constituents/addresses/{address_id}	Address
AddressApi	listAddressTypes	GET /addresstypes	Address types
AddressApi	listConstituentAddressesAllConstituents	GET /addresses	Address list (All constituents)
AddressApi	listConstituentAddressesSingleConstituent	GET /constituents/{constituent_id}/addresses	Address list (Single constituent)
AddressApi	listCountries	GET /countries	Countries
AliasApi	createConstituentAlias	POST /aliases	Alias (Create)
AliasApi	deleteConstituentAlias	DELETE /aliases/{alias_id}	Alias (Delete)
AliasApi	editConstituentAlias	PATCH /aliases/{alias_id}	Alias (Edit)
AliasApi	listAliasTypes	GET /aliastypes	Alias types
AliasApi	listConstituentAliasesSingleConstituent	GET /constituents/{constituent_id}/aliases	Alias list (Single constituent)
CommunicationPreferenceApi	createConstituentCommunicationPreference	POST /communicationpreferences	Communication preference (Create)
CommunicationPreferenceApi	deleteConstituentCommunicationPreference	DELETE /communicationpreferences/{communication_preference_id}	Communication preference (Delete)
CommunicationPreferenceApi	editConstituentCommunicationPreference	PATCH /communicationpreferences/{communication_preference_id}	Communication preference (Edit)
CommunicationPreferenceApi	listCommunicationPreferences	GET /communicationpreferences	Communication preferences
CommunicationPreferenceApi	listConstituentCommunicationPreferencesSingleConstituent	GET /constituents/{constituent_id}/communicationpreferences	Communication preference list (Single constituent)
ConstituentApi	createConstituent	POST /constituents	Constituent (Create)
ConstituentApi	createConstituentAttachment	POST /constituents/attachments	Constituent attachment (Create)
ConstituentApi	createConstituentCode	POST /constituentcodes	Constituent code (Create)
ConstituentApi	createConstituentCustomField	POST /constituents/customfields	Constituent custom field (Create)
ConstituentApi	createDocument	POST /documents	Document (Create)
ConstituentApi	deleteConstituentAttachment	DELETE /constituents/attachments/{attachment_id}	Constituent attachment (Delete)
ConstituentApi	deleteConstituentCode	DELETE /constituentcodes/{constituent_code_id}	Constituent code (Delete)
ConstituentApi	deleteConstituentCustomField	DELETE /constituents/customfields/{custom_field_id}	Constituent custom field (Delete)
ConstituentApi	editConstituent	PATCH /constituents/{constituent_id}	Constituent (Edit)
ConstituentApi	editConstituentAttachment	PATCH /constituents/attachments/{attachment_id}	Constituent attachment (Edit)
ConstituentApi	editConstituentCode	PATCH /constituentcodes/{constituent_code_id}	Constituent code (Edit)
ConstituentApi	editConstituentCustomField	PATCH /constituents/customfields/{custom_field_id}	Constituent custom field (Edit)
ConstituentApi	getConstituent	GET /constituents/{constituent_id}	Constituent (Get)
ConstituentApi	getConstituentCode	GET /constituents/constituentcodes/{constituent_code_id}	Constituent code (Get)
ConstituentApi	getConstituentProfilePicture	GET /constituents/{constituent_id}/profilepicture	Profile picture (Get)
ConstituentApi	getCurrencyConfiguration	GET /currencyconfiguration	Currency configuration (Get)
ConstituentApi	listAttachmentTags	GET /attachmenttags	Attachment tags
ConstituentApi	listConstituentAttachmentsSingleConstituent	GET /constituents/{constituent_id}/attachments	Constituent attachment list (Single constituent)
ConstituentApi	listConstituentCodeTypes	GET /constituentcodetypes	Constituent code types
ConstituentApi	listConstituentCodesAllConstituents	GET /constituents/constituentcodes	Constituent code list (All constituents)
ConstituentApi	listConstituentCodesSingleConstituent	GET /constituents/{constituent_id}/constituentcodes	Constituent code list (Single constituent)
ConstituentApi	listConstituentCustomFieldCategories	GET /constituents/customfields/categories	Constituent custom field categories
ConstituentApi	listConstituentCustomFieldCategoryDetails	GET /constituents/customfields/categories/details	Constituent custom field category details
ConstituentApi	listConstituentCustomFieldCategoryValues	GET /constituents/customfields/categories/values	Constituent custom field category values
ConstituentApi	listConstituentCustomFieldsAllConstituents	GET /constituents/customfields	Constituent custom field list (All constituents)
ConstituentApi	listConstituentCustomFieldsSingleConstituent	GET /constituents/{constituent_id}/customfields	Constituent custom field list (Single constituent)
ConstituentApi	listConstituentFundraiserAssignmentsSingleConstituent	GET /constituents/{constituent_id}/fundraiserassignments	Fundraiser assignment list (Single constituent)
ConstituentApi	listConstituentFundraisersSingleConstituent	GET /constituents/{constituent_id}/fundraisers	Fundraiser list (Single constituent)
ConstituentApi	listConstituents	GET /constituents	Constituent list
ConstituentApi	listGenders	GET /genders	Genders
ConstituentApi	listMaritalStatuses	GET /maritalstatuses	Marital statuses
ConstituentApi	listSuffixes	GET /suffixes	Suffixes
ConstituentApi	listTitles	GET /titles	Titles
ConstituentApi	patchConstituentProfilePicture	PATCH /constituents/{constituent_id}/profilepicture	Profile picture
ConstituentApi	searchConstituent	GET /constituents/search	Constituent (Search)
ConstituentAppealApi	listConstituentAppealsSingleConstituent	GET /constituents/{constituent_id}/appeals	Constituent appeal list (Single constituent)
ConstituentEducationApi	createConstituentEducation	POST /educations	Education (Create)
ConstituentEducationApi	deleteConstituentEducation	DELETE /educations/{education_id}	Education (Delete)
ConstituentEducationApi	editConstituentEducation	PATCH /educations/{education_id}	Education (Edit)
ConstituentEducationApi	getConstituentEducation	GET /constituents/educations/{education_id}	Education (Get)
ConstituentEducationApi	listConstituentEducationsAllConstituents	GET /educations	Education list (All constituents)
ConstituentEducationApi	listConstituentEducationsSingleConstituent	GET /constituents/{constituent_id}/educations	Education list (Single constituent)
ConstituentEducationApi	listEducationDegreeClasses	GET /educations/degreeclasses	Education degree classes
ConstituentEducationApi	listEducationDegrees	GET /educations/degrees	Education degrees
ConstituentEducationApi	listEducationDepartments	GET /educations/departments	Education departments
ConstituentEducationApi	listEducationFaculties	GET /educations/faculties	Education faculties
ConstituentEducationApi	listEducationSchools	GET /educations/schools	Education schools
ConstituentEducationApi	listEducationStatuses	GET /educations/statuses	Education statuses
ConstituentEducationApi	listEducationSubjects	GET /educations/subjects	Education subjects
ConstituentEducationApi	listEducationTypes	GET /educations/types	Education types
ConstituentMembershipApi	listConstituentMembershipsSingleConstituent	GET /constituents/{constituent_id}/memberships	Membership list (Single constituent)
ConstituentMembershipApi	listMemberships	GET /memberships	Membership list (All constituents)
ConstituentRatingApi	createConstituentRating	POST /ratings	Rating (Create)
ConstituentRatingApi	deleteConstituentRating	DELETE /ratings/{rating_id}	Rating (Delete)
ConstituentRatingApi	editConstituentRating	PATCH /ratings/{rating_id}	Rating (Edit)
ConstituentRatingApi	listConstituentRatingsSingleConstituent	GET /constituents/{constituent_id}/ratings	Rating list (Single constituent)
ConstituentRatingApi	listRatingCategories	GET /ratings/categories	Rating categories
ConstituentRatingApi	listRatingCategoryValues	GET /ratings/categories/values	Rating category values
ConstituentRatingApi	listRatingSources	GET /ratings/sources	Rating sources
ConstituentRelationshipApi	createConstituentRelationship	POST /relationships	Relationship (Create)
ConstituentRelationshipApi	deleteConstituentRelationship	DELETE /relationships/{relationship_id}	Relationship (Delete)
ConstituentRelationshipApi	editConstituentRelationship	PATCH /relationships/{relationship_id}	Relationship (Edit)
ConstituentRelationshipApi	getConstituentRelationship	GET /constituents/relationships/{relationship_id}	Relationship (Get)
ConstituentRelationshipApi	listConstituentRelationshipsAllConstituents	GET /relationships	Relationship list (All constituents)
ConstituentRelationshipApi	listConstituentRelationshipsSingleConstituent	GET /constituents/{constituent_id}/relationships	Relationship list (Single constituent)
ConstituentRelationshipApi	listOrganizationContactTypes	GET /organizationcontacttypes	Organization contact types
ConstituentRelationshipApi	listRelationshipTypes	GET /relationshiptypes	Relationship types
EmailAddressApi	createConstituentEmailAddress	POST /emailaddresses	Email address (Create)
EmailAddressApi	deleteConstituentEmailAddress	DELETE /emailaddresses/{email_address_id}	Email address (Delete)
EmailAddressApi	editConstituentEmailAddress	PATCH /emailaddresses/{email_address_id}	Email address (Edit)
EmailAddressApi	listConstituentEmailAddressesAllConstituents	GET /emailaddresses	Email address list (All constituents)
EmailAddressApi	listConstituentEmailAddressesSingleConstituent	GET /constituents/{constituent_id}/emailaddresses	Email address list (Single constituent)
EmailAddressApi	listEmailAddressTypes	GET /emailaddresstypes	Email address types
GiftApi	getConstituentGiftFirst	GET /constituents/{constituent_id}/givingsummary/first	First gift (Get)
GiftApi	getConstituentGiftGreatest	GET /constituents/{constituent_id}/givingsummary/greatest	Greatest gift (Get)
GiftApi	getConstituentGiftLatest	GET /constituents/{constituent_id}/givingsummary/latest	Latest gift (Get)
GiftApi	getConstituentGivingSummaryLifetime	GET /constituents/{constituent_id}/givingsummary/lifetimegiving	Lifetime giving (Get)
NameFormatApi	createConstituentNameFormat	POST /nameformats	Name format (Create)
NameFormatApi	createConstituentPrimaryNameFormat	POST /primarynameformats	Primary name format (Create)
NameFormatApi	deleteConstituentNameFormat	DELETE /nameformats/{name_format_id}	Name format (Delete)
NameFormatApi	deleteConstituentPrimaryNameFormat	DELETE /primarynameformats/{primary_name_format_id}	Primary name format (Delete)
NameFormatApi	editConstituentNameFormat	PATCH /nameformats/{name_format_id}	Name format (Edit)
NameFormatApi	editConstituentPrimaryNameFormat	PATCH /primarynameformats/{primary_name_format_id}	Primary name format (Edit)
NameFormatApi	getConstituentNameFormat	GET /constituents/nameformats/{name_format_id}	Name format (Get)
NameFormatApi	getConstituentNameFormatSummary	GET /constituents/{constituent_id}/nameformats/summary	Name format summary (Get)
NameFormatApi	listNameFormatConfigurations	GET /nameformatconfigurations	Name format configuration list
NameFormatApi	listNameFormatTypes	GET /nameformattypes	Name format types
NoteApi	createConstituentNote	POST /notes	Note (Create)
NoteApi	deleteConstituentNote	DELETE /notes/{note_id}	Note (Delete)
NoteApi	editConstituentNote	PATCH /notes/{note_id}	Note (Edit)
NoteApi	getConstituentNote	GET /notes/{note_id}	Note (Get)
NoteApi	listConstituentNotesAllConstituents	GET /notes	Note list (All constituents)
NoteApi	listConstituentNotesSingleConstituent	GET /constituents/{constituent_id}/notes	Note list (Single constituent)
NoteApi	listNoteTypes	GET /notetypes	Note types
OnlinePresenceApi	createConstituentOnlinePresence	POST /onlinepresences	Online presence (Create)
OnlinePresenceApi	deleteConstituentOnlinePresence	DELETE /onlinepresences/{online_presence_id}	Online presence (Delete)
OnlinePresenceApi	editConstituentOnlinePresence	PATCH /onlinepresences/{online_presence_id}	Online presence (Edit)
OnlinePresenceApi	listConstituentOnlinePresencesAllConstituents	GET /onlinepresences	Online presence list (All constituents)
OnlinePresenceApi	listConstituentOnlinePresencesSingleConstituent	GET /constituents/{constituent_id}/onlinepresences	Online presence list (Single constituent)
OnlinePresenceApi	listOnlinePresenceTypes	GET /onlinepresencetypes	Online presence types
PhoneApi	createConstituentPhone	POST /phones	Phone (Create)
PhoneApi	deleteConstituentPhone	DELETE /phones/{phone_id}	Phone (Delete)
PhoneApi	editConstituentPhone	PATCH /phones/{phone_id}	Phone (Edit)
PhoneApi	getConstituentPhone	GET /constituents/phones/{phone_id}	Phone (Get)
PhoneApi	listConstituentPhonesAllConstituents	GET /phones	Phone list (All constituents)
PhoneApi	listConstituentPhonesSingleConstituent	GET /constituents/{constituent_id}/phones	Phone list (Single constituent)
PhoneApi	listPhoneTypes	GET /phonetypes	Phone types
ProspectStatusApi	getConstituentProspectStatus	GET /constituents/{constituent_id}/prospectstatus	Prospect status (Get)

Models

Authorization

apiKeyHeader

Type: API key
API key parameter name: Bb-Api-Subscription-Key
Location: HTTP header

apiKeyQuery

Type: API key
API key parameter name: subscription-key
Location: URL query string

oauth2Blackbaud OAuth 2.0 ServiceAuthorizationCode

Type: OAuth
Flow: accessCode
Authorization URL: https://oauth2.sky.blackbaud.com/authorization
Scopes: N/A

oauth2Blackbaud OAuth 2.0 ServiceImplicit

Type: OAuth
Flow: implicit
Authorization URL: https://oauth2.sky.blackbaud.com/authorization
Scopes: N/A

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

API version: 1.0
- Package version: 1.0.0
Build package: org.openapitools.codegen.languages.PhpClientCodegen

burger-digital / blackbaud-php-sdk

Maintainers

Details