NPSPClient

class NPSPClient extends Client

Class NPSPClient

Client for interacting with the Nonprofit Success Pack package. This client extends the functionality of the base SalesForce client by adding CRUD support for the custom objects that are supplied by the NPSP package.

$client = new NPSPClient(SFAPIClient::connect($endpoint, $auth));

Properties

`protected SFAPIClient`	`$_client`	from Client
`protected array`	`$_types`	from Client
`protected array`	`$_typeNames`	from Client

Methods

`public`		`__construct(SFAPIClient $client)`	NPSPClient constructor.
`public`	`SFRecordsResult`	`search(string $query)`	No description	from Client
`public`	`SFRecordsResult`	`fullSearch(string $query)`	No description	from Client
`public`		`__call(string $name, array $arguments)`	No description	from Client
`public`	`null\|array`	`getRESTParts(string $name)`	No description	from Client
	`SFCreationResult`	`createAccount(array $data)`	No description
	`SFObjectResult`	`getAccount(string $id, array $fields = [])`	No description
	`BoolResult`	`patchAccount(string $id, array $data)`	No description
	`BoolResult`	`deleteAccount(string $id)`	No description
	`SFCreationResult`	`createActivity(array $data)`	No description
	`SFObjectResult`	`getActivity(string $id, array $fields = [])`	No description
	`BoolResult`	`patchActivity(string $id, array $data)`	No description
	`BoolResult`	`deleteActivity(string $id)`	No description
	`SFCreationResult`	`createAsset(array $data)`	No description
	`SFObjectResult`	`getAsset(string $id, array $fields = [])`	No description
	`BoolResult`	`patchAsset(string $id, array $data)`	No description
	`BoolResult`	`deleteAsset(string $id)`	No description
	`SFCreationResult`	`createAssetRelationship(array $data)`	No description
	`SFObjectResult`	`getAssetRelationship(string $id, array $fields = [])`	No description
	`BoolResult`	`patchAssetRelationship(string $id, array $data)`	No description
	`BoolResult`	`deleteAssetRelationship(string $id)`	No description
	`SFCreationResult`	`createCampaign(array $data)`	No description
	`SFObjectResult`	`getCampaign(string $id, array $fields = [])`	No description
	`BoolResult`	`patchCampaign(string $id, array $data)`	No description
	`BoolResult`	`deleteCampaign(string $id)`	No description
	`SFCreationResult`	`createCampaignMember(array $data)`	No description
	`SFObjectResult`	`getCampaignMember(string $id, array $fields = [])`	No description
	`BoolResult`	`patchCampaignMember(string $id, array $data)`	No description
	`BoolResult`	`deleteCampaignMember(string $id)`	No description
	`SFCreationResult`	`createCase(array $data)`	No description
	`SFObjectResult`	`getCase(string $id, array $fields = [])`	No description
	`BoolResult`	`patchCase(string $id, array $data)`	No description
	`BoolResult`	`deleteCase(string $id)`	No description
	`SFCreationResult`	`createContact(array $data)`	No description
	`SFObjectResult`	`getContact(string $id, array $fields = [])`	No description
	`BoolResult`	`patchContact(string $id, array $data)`	No description
	`BoolResult`	`deleteContact(string $id)`	No description
	`SFCreationResult`	`createContentVersion(array $data)`	No description
	`SFObjectResult`	`getContentVersion(string $id, array $fields = [])`	No description
	`BoolResult`	`patchContentVersion(string $id, array $data)`	No description
	`BoolResult`	`deleteContentVersion(string $id)`	No description
	`SFCreationResult`	`createContract(array $data)`	No description
	`SFObjectResult`	`getContract(string $id, array $fields = [])`	No description
	`BoolResult`	`patchContract(string $id, array $data)`	No description
	`BoolResult`	`deleteContract(string $id)`	No description
	`SFCreationResult`	`createContractContactRole(array $data)`	No description
	`SFObjectResult`	`getContractContactRole(string $id, array $fields = [])`	No description
	`BoolResult`	`patchContractContactRole(string $id, array $data)`	No description
	`BoolResult`	`deleteContractContactRole(string $id)`	No description
	`SFCreationResult`	`createDuplicateRecordItem(array $data)`	No description
	`SFObjectResult`	`getDuplicateRecordItem(string $id, array $fields = [])`	No description
	`BoolResult`	`patchDuplicateRecordItem(string $id, array $data)`	No description
	`BoolResult`	`deleteDuplicateRecordItem(string $id)`	No description
	`SFCreationResult`	`createDuplicateRecordSet(array $data)`	No description
	`SFObjectResult`	`getDuplicateRecordSet(string $id, array $fields = [])`	No description
	`BoolResult`	`patchDuplicateRecordSet(string $id, array $data)`	No description
	`BoolResult`	`deleteDuplicateRecordSet(string $id)`	No description
	`SFCreationResult`	`createEmailMessage(array $data)`	No description
	`SFObjectResult`	`getEmailMessage(string $id, array $fields = [])`	No description
	`BoolResult`	`patchEmailMessage(string $id, array $data)`	No description
	`BoolResult`	`deleteEmailMessage(string $id)`	No description
	`SFCreationResult`	`createEvent(array $data)`	No description
	`SFObjectResult`	`getEvent(string $id, array $fields = [])`	No description
	`BoolResult`	`patchEvent(string $id, array $data)`	No description
	`BoolResult`	`deleteEvent(string $id)`	No description
	`SFCreationResult`	`createLead(array $data)`	No description
	`SFObjectResult`	`getLead(string $id, array $fields = [])`	No description
	`BoolResult`	`patchLead(string $id, array $data)`	No description
	`BoolResult`	`deleteLead(string $id)`	No description
	`SFCreationResult`	`createMacro(array $data)`	No description
	`SFObjectResult`	`getMacro(string $id, array $fields = [])`	No description
	`BoolResult`	`patchMacro(string $id, array $data)`	No description
	`BoolResult`	`deleteMacro(string $id)`	No description
	`SFCreationResult`	`createOpportunity(array $data)`	No description
	`SFObjectResult`	`getOpportunity(string $id, array $fields = [])`	No description
	`BoolResult`	`patchOpportunity(string $id, array $data)`	No description
	`BoolResult`	`deleteOpportunity(string $id)`	No description
	`SFCreationResult`	`createOpportunityLineItem(array $data)`	No description
	`SFObjectResult`	`getOpportunityLineItem(string $id, array $fields = [])`	No description
	`BoolResult`	`patchOpportunityLineItem(string $id, array $data)`	No description
	`BoolResult`	`deleteOpportunityLineItem(string $id)`	No description
	`SFCreationResult`	`createOrder(array $data)`	No description
	`SFObjectResult`	`getOrder(string $id, array $fields = [])`	No description
	`BoolResult`	`patchOrder(string $id, array $data)`	No description
	`BoolResult`	`deleteOrder(string $id)`	No description
	`SFCreationResult`	`createOrderItem(array $data)`	No description
	`SFObjectResult`	`getOrderItem(string $id, array $fields = [])`	No description
	`BoolResult`	`patchOrderItem(string $id, array $data)`	No description
	`BoolResult`	`deleteOrderItem(string $id)`	No description
	`SFCreationResult`	`createPricebook2(array $data)`	No description
	`SFObjectResult`	`getPricebook2(string $id, array $fields = [])`	No description
	`BoolResult`	`patchPricebook2(string $id, array $data)`	No description
	`BoolResult`	`deletePricebook2(string $id)`	No description
	`SFCreationResult`	`createPricebookEntry(array $data)`	No description
	`SFObjectResult`	`getPricebookEntry(string $id, array $fields = [])`	No description
	`BoolResult`	`patchPricebookEntry(string $id, array $data)`	No description
	`BoolResult`	`deletePricebookEntry(string $id)`	No description
	`SFCreationResult`	`createQuickText(array $data)`	No description
	`SFObjectResult`	`getQuickText(string $id, array $fields = [])`	No description
	`BoolResult`	`patchQuickText(string $id, array $data)`	No description
	`BoolResult`	`deleteQuickText(string $id)`	No description
	`SFCreationResult`	`createScorecard(array $data)`	No description
	`SFObjectResult`	`getScorecard(string $id, array $fields = [])`	No description
	`BoolResult`	`patchScorecard(string $id, array $data)`	No description
	`BoolResult`	`deleteScorecard(string $id)`	No description
	`SFCreationResult`	`createScorecardAssociation(array $data)`	No description
	`SFObjectResult`	`getScorecardAssociation(string $id, array $fields = [])`	No description
	`BoolResult`	`patchScorecardAssociation(string $id, array $data)`	No description
	`BoolResult`	`deleteScorecardAssociation(string $id)`	No description
	`SFCreationResult`	`createScorecardMetric(array $data)`	No description
	`SFObjectResult`	`getScorecardMetric(string $id, array $fields = [])`	No description
	`BoolResult`	`patchScorecardMetric(string $id, array $data)`	No description
	`BoolResult`	`deleteScorecardMetric(string $id)`	No description
	`SFCreationResult`	`createSignupRequest(array $data)`	No description
	`SFObjectResult`	`getSignupRequest(string $id, array $fields = [])`	No description
	`BoolResult`	`patchSignupRequest(string $id, array $data)`	No description
	`BoolResult`	`deleteSignupRequest(string $id)`	No description
	`SFCreationResult`	`createSocialPersona(array $data)`	No description
	`SFObjectResult`	`getSocialPersona(string $id, array $fields = [])`	No description
	`BoolResult`	`patchSocialPersona(string $id, array $data)`	No description
	`BoolResult`	`deleteSocialPersona(string $id)`	No description
	`SFCreationResult`	`createSocialPost(array $data)`	No description
	`SFObjectResult`	`getSocialPost(string $id, array $fields = [])`	No description
	`BoolResult`	`patchSocialPost(string $id, array $data)`	No description
	`BoolResult`	`deleteSocialPost(string $id)`	No description
	`SFCreationResult`	`createTask(array $data)`	No description
	`SFObjectResult`	`getTask(string $id, array $fields = [])`	No description
	`BoolResult`	`patchTask(string $id, array $data)`	No description
	`BoolResult`	`deleteTask(string $id)`	No description
	`SFCreationResult`	`createUser(array $data)`	No description
	`SFObjectResult`	`getUser(string $id, array $fields = [])`	No description
	`BoolResult`	`patchUser(string $id, array $data)`	No description
	`BoolResult`	`deleteUser(string $id)`	No description
	`SFCreationResult`	`createUserProvisioningRequest(array $data)`	No description
	`SFObjectResult`	`getUserProvisioningRequest(string $id, array $fields = [])`	No description
	`BoolResult`	`patchUserProvisioningRequest(string $id, array $data)`	No description
	`BoolResult`	`deleteUserProvisioningRequest(string $id)`	No description
	`SFCreationResult`	`createAddress(array $data)`	No description
	`SFObjectResult`	`getAddress(string $id, array $fields = [])`	No description
	`BoolResult`	`patchAddress(string $id, array $data)`	No description
	`BoolResult`	`deleteAddress(string $id)`	No description
	`SFCreationResult`	`createAffiliation(array $data)`	No description
	`SFObjectResult`	`getAffiliation(string $id, array $fields = [])`	No description
	`BoolResult`	`patchAffiliation(string $id, array $data)`	No description
	`BoolResult`	`deleteAffiliation(string $id)`	No description
	`SFCreationResult`	`createAllocation(array $data)`	No description
	`SFObjectResult`	`getAllocation(string $id, array $fields = [])`	No description
	`BoolResult`	`patchAllocation(string $id, array $data)`	No description
	`BoolResult`	`deleteAllocation(string $id)`	No description
	`SFCreationResult`	`createBatch(array $data)`	No description
	`SFObjectResult`	`getBatch(string $id, array $fields = [])`	No description
	`BoolResult`	`patchBatch(string $id, array $data)`	No description
	`BoolResult`	`deleteBatch(string $id)`	No description
	`SFCreationResult`	`createDataImport(array $data)`	No description
	`SFObjectResult`	`getDataImport(string $id, array $fields = [])`	No description
	`BoolResult`	`patchDataImport(string $id, array $data)`	No description
	`BoolResult`	`deleteDataImport(string $id)`	No description
	`SFCreationResult`	`createDataImportBatch(array $data)`	No description
	`SFObjectResult`	`getDataImportBatch(string $id, array $fields = [])`	No description
	`BoolResult`	`patchDataImportBatch(string $id, array $data)`	No description
	`BoolResult`	`deleteDataImportBatch(string $id)`	No description
	`SFCreationResult`	`createEngagementPlan(array $data)`	No description
	`SFObjectResult`	`getEngagementPlan(string $id, array $fields = [])`	No description
	`BoolResult`	`patchEngagementPlan(string $id, array $data)`	No description
	`BoolResult`	`deleteEngagementPlan(string $id)`	No description
	`SFCreationResult`	`createEngagementPlanTask(array $data)`	No description
	`SFObjectResult`	`getEngagementPlanTask(string $id, array $fields = [])`	No description
	`BoolResult`	`patchEngagementPlanTask(string $id, array $data)`	No description
	`BoolResult`	`deleteEngagementPlanTask(string $id)`	No description
	`SFCreationResult`	`createEngagementPlanTemplate(array $data)`	No description
	`SFObjectResult`	`getEngagementPlanTemplate(string $id, array $fields = [])`	No description
	`BoolResult`	`patchEngagementPlanTemplate(string $id, array $data)`	No description
	`BoolResult`	`deleteEngagementPlanTemplate(string $id)`	No description
	`SFCreationResult`	`createError(array $data)`	No description
	`SFObjectResult`	`getError(string $id, array $fields = [])`	No description
	`BoolResult`	`patchError(string $id, array $data)`	No description
	`BoolResult`	`deleteError(string $id)`	No description
	`SFCreationResult`	`createGeneralAccountingUnit(array $data)`	No description
	`SFObjectResult`	`getGeneralAccountingUnit(string $id, array $fields = [])`	No description
	`BoolResult`	`patchGeneralAccountingUnit(string $id, array $data)`	No description
	`BoolResult`	`deleteGeneralAccountingUnit(string $id)`	No description
	`SFCreationResult`	`createGrantDeadline(array $data)`	No description
	`SFObjectResult`	`getGrantDeadline(string $id, array $fields = [])`	No description
	`BoolResult`	`patchGrantDeadline(string $id, array $data)`	No description
	`BoolResult`	`deleteGrantDeadline(string $id)`	No description
	`SFCreationResult`	`createHousehold(array $data)`	No description
	`SFObjectResult`	`getHousehold(string $id, array $fields = [])`	No description
	`BoolResult`	`patchHousehold(string $id, array $data)`	No description
	`BoolResult`	`deleteHousehold(string $id)`	No description
	`SFCreationResult`	`createLevel(array $data)`	No description
	`SFObjectResult`	`getLevel(string $id, array $fields = [])`	No description
	`BoolResult`	`patchLevel(string $id, array $data)`	No description
	`BoolResult`	`deleteLevel(string $id)`	No description
	`SFCreationResult`	`createOppPayment(array $data)`	No description
	`SFObjectResult`	`getOppPayment(string $id, array $fields = [])`	No description
	`BoolResult`	`patchOppPayment(string $id, array $data)`	No description
	`BoolResult`	`deleteOppPayment(string $id)`	No description
	`SFCreationResult`	`createPartialSoftCredit(array $data)`	No description
	`SFObjectResult`	`getPartialSoftCredit(string $id, array $fields = [])`	No description
	`BoolResult`	`patchPartialSoftCredit(string $id, array $data)`	No description
	`BoolResult`	`deletePartialSoftCredit(string $id)`	No description
	`SFCreationResult`	`createRecurringDonation(array $data)`	No description
	`SFObjectResult`	`getRecurringDonation(string $id, array $fields = [])`	No description
	`BoolResult`	`patchRecurringDonation(string $id, array $data)`	No description
	`BoolResult`	`deleteRecurringDonation(string $id)`	No description
	`SFCreationResult`	`createRelationship(array $data)`	No description
	`SFObjectResult`	`getRelationship(string $id, array $fields = [])`	No description
	`BoolResult`	`patchRelationship(string $id, array $data)`	No description
	`BoolResult`	`deleteRelationship(string $id)`	No description
	`SFCreationResult`	`createTriggerHandler(array $data)`	No description
	`SFObjectResult`	`getTriggerHandler(string $id, array $fields = [])`	No description
	`BoolResult`	`patchTriggerHandler(string $id, array $data)`	No description
	`BoolResult`	`deleteTriggerHandler(string $id)`	No description

Details

at line 238

`__construct()`

public __construct(SFAPIClient $client)

NPSPClient constructor.

Parameters

SFAPIClient $client

in Client at line 189

`search()`

public SFRecordsResult search(string $query)

Parameters

string $query

Return Value

SFRecordsResult

in Client at line 197

`fullSearch()`

public SFRecordsResult fullSearch(string $query)

Parameters

string $query

Return Value

SFRecordsResult

in Client at line 206

`__call()`

public __call(string $name, array $arguments)

Parameters

`string`	`$name`
`array`	`$arguments`

in Client at line 219

`getRESTParts()`

public null|array getRESTParts(string $name)

Parameters

string $name

Return Value

null|array

at line 232

`createAccount()`

SFCreationResult createAccount(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getAccount()`

SFObjectResult getAccount(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchAccount()`

BoolResult patchAccount(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteAccount()`

BoolResult deleteAccount(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createActivity()`

SFCreationResult createActivity(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getActivity()`

SFObjectResult getActivity(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchActivity()`

BoolResult patchActivity(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteActivity()`

BoolResult deleteActivity(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createAsset()`

SFCreationResult createAsset(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getAsset()`

SFObjectResult getAsset(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchAsset()`

BoolResult patchAsset(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteAsset()`

BoolResult deleteAsset(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createAssetRelationship()`

SFCreationResult createAssetRelationship(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getAssetRelationship()`

SFObjectResult getAssetRelationship(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchAssetRelationship()`

BoolResult patchAssetRelationship(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteAssetRelationship()`

BoolResult deleteAssetRelationship(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createCampaign()`

SFCreationResult createCampaign(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getCampaign()`

SFObjectResult getCampaign(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchCampaign()`

BoolResult patchCampaign(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteCampaign()`

BoolResult deleteCampaign(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createCampaignMember()`

SFCreationResult createCampaignMember(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getCampaignMember()`

SFObjectResult getCampaignMember(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchCampaignMember()`

BoolResult patchCampaignMember(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteCampaignMember()`

BoolResult deleteCampaignMember(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createCase()`

SFCreationResult createCase(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getCase()`

SFObjectResult getCase(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchCase()`

BoolResult patchCase(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteCase()`

BoolResult deleteCase(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createContact()`

SFCreationResult createContact(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getContact()`

SFObjectResult getContact(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchContact()`

BoolResult patchContact(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteContact()`

BoolResult deleteContact(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createContentVersion()`

SFCreationResult createContentVersion(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getContentVersion()`

SFObjectResult getContentVersion(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchContentVersion()`

BoolResult patchContentVersion(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteContentVersion()`

BoolResult deleteContentVersion(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createContract()`

SFCreationResult createContract(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getContract()`

SFObjectResult getContract(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchContract()`

BoolResult patchContract(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteContract()`

BoolResult deleteContract(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createContractContactRole()`

SFCreationResult createContractContactRole(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getContractContactRole()`

SFObjectResult getContractContactRole(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchContractContactRole()`

BoolResult patchContractContactRole(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteContractContactRole()`

BoolResult deleteContractContactRole(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createDuplicateRecordItem()`

SFCreationResult createDuplicateRecordItem(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getDuplicateRecordItem()`

SFObjectResult getDuplicateRecordItem(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchDuplicateRecordItem()`

BoolResult patchDuplicateRecordItem(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteDuplicateRecordItem()`

BoolResult deleteDuplicateRecordItem(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createDuplicateRecordSet()`

SFCreationResult createDuplicateRecordSet(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getDuplicateRecordSet()`

SFObjectResult getDuplicateRecordSet(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchDuplicateRecordSet()`

BoolResult patchDuplicateRecordSet(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteDuplicateRecordSet()`

BoolResult deleteDuplicateRecordSet(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createEmailMessage()`

SFCreationResult createEmailMessage(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getEmailMessage()`

SFObjectResult getEmailMessage(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchEmailMessage()`

BoolResult patchEmailMessage(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteEmailMessage()`

BoolResult deleteEmailMessage(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createEvent()`

SFCreationResult createEvent(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getEvent()`

SFObjectResult getEvent(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchEvent()`

BoolResult patchEvent(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteEvent()`

BoolResult deleteEvent(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createLead()`

SFCreationResult createLead(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getLead()`

SFObjectResult getLead(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchLead()`

BoolResult patchLead(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteLead()`

BoolResult deleteLead(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createMacro()`

SFCreationResult createMacro(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getMacro()`

SFObjectResult getMacro(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchMacro()`

BoolResult patchMacro(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteMacro()`

BoolResult deleteMacro(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createOpportunity()`

SFCreationResult createOpportunity(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getOpportunity()`

SFObjectResult getOpportunity(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchOpportunity()`

BoolResult patchOpportunity(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteOpportunity()`

BoolResult deleteOpportunity(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createOpportunityLineItem()`

SFCreationResult createOpportunityLineItem(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getOpportunityLineItem()`

SFObjectResult getOpportunityLineItem(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchOpportunityLineItem()`

BoolResult patchOpportunityLineItem(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteOpportunityLineItem()`

BoolResult deleteOpportunityLineItem(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createOrder()`

SFCreationResult createOrder(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getOrder()`

SFObjectResult getOrder(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchOrder()`

BoolResult patchOrder(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteOrder()`

BoolResult deleteOrder(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createOrderItem()`

SFCreationResult createOrderItem(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getOrderItem()`

SFObjectResult getOrderItem(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchOrderItem()`

BoolResult patchOrderItem(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteOrderItem()`

BoolResult deleteOrderItem(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createPricebook2()`

SFCreationResult createPricebook2(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getPricebook2()`

SFObjectResult getPricebook2(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchPricebook2()`

BoolResult patchPricebook2(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deletePricebook2()`

BoolResult deletePricebook2(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createPricebookEntry()`

SFCreationResult createPricebookEntry(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getPricebookEntry()`

SFObjectResult getPricebookEntry(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchPricebookEntry()`

BoolResult patchPricebookEntry(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deletePricebookEntry()`

BoolResult deletePricebookEntry(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createQuickText()`

SFCreationResult createQuickText(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getQuickText()`

SFObjectResult getQuickText(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchQuickText()`

BoolResult patchQuickText(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteQuickText()`

BoolResult deleteQuickText(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createScorecard()`

SFCreationResult createScorecard(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getScorecard()`

SFObjectResult getScorecard(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchScorecard()`

BoolResult patchScorecard(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteScorecard()`

BoolResult deleteScorecard(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createScorecardAssociation()`

SFCreationResult createScorecardAssociation(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getScorecardAssociation()`

SFObjectResult getScorecardAssociation(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchScorecardAssociation()`

BoolResult patchScorecardAssociation(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteScorecardAssociation()`

BoolResult deleteScorecardAssociation(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createScorecardMetric()`

SFCreationResult createScorecardMetric(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getScorecardMetric()`

SFObjectResult getScorecardMetric(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchScorecardMetric()`

BoolResult patchScorecardMetric(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteScorecardMetric()`

BoolResult deleteScorecardMetric(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createSignupRequest()`

SFCreationResult createSignupRequest(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getSignupRequest()`

SFObjectResult getSignupRequest(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchSignupRequest()`

BoolResult patchSignupRequest(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteSignupRequest()`

BoolResult deleteSignupRequest(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createSocialPersona()`

SFCreationResult createSocialPersona(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getSocialPersona()`

SFObjectResult getSocialPersona(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchSocialPersona()`

BoolResult patchSocialPersona(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteSocialPersona()`

BoolResult deleteSocialPersona(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createSocialPost()`

SFCreationResult createSocialPost(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getSocialPost()`

SFObjectResult getSocialPost(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchSocialPost()`

BoolResult patchSocialPost(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteSocialPost()`

BoolResult deleteSocialPost(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createTask()`

SFCreationResult createTask(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getTask()`

SFObjectResult getTask(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchTask()`

BoolResult patchTask(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteTask()`

BoolResult deleteTask(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createUser()`

SFCreationResult createUser(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getUser()`

SFObjectResult getUser(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchUser()`

BoolResult patchUser(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteUser()`

BoolResult deleteUser(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createUserProvisioningRequest()`

SFCreationResult createUserProvisioningRequest(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getUserProvisioningRequest()`

SFObjectResult getUserProvisioningRequest(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchUserProvisioningRequest()`

BoolResult patchUserProvisioningRequest(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteUserProvisioningRequest()`

BoolResult deleteUserProvisioningRequest(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createAddress()`

SFCreationResult createAddress(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getAddress()`

SFObjectResult getAddress(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchAddress()`

BoolResult patchAddress(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteAddress()`

BoolResult deleteAddress(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createAffiliation()`

SFCreationResult createAffiliation(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getAffiliation()`

SFObjectResult getAffiliation(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchAffiliation()`

BoolResult patchAffiliation(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteAffiliation()`

BoolResult deleteAffiliation(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createAllocation()`

SFCreationResult createAllocation(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getAllocation()`

SFObjectResult getAllocation(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchAllocation()`

BoolResult patchAllocation(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteAllocation()`

BoolResult deleteAllocation(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createBatch()`

SFCreationResult createBatch(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getBatch()`

SFObjectResult getBatch(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchBatch()`

BoolResult patchBatch(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteBatch()`

BoolResult deleteBatch(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createDataImport()`

SFCreationResult createDataImport(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getDataImport()`

SFObjectResult getDataImport(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchDataImport()`

BoolResult patchDataImport(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteDataImport()`

BoolResult deleteDataImport(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createDataImportBatch()`

SFCreationResult createDataImportBatch(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getDataImportBatch()`

SFObjectResult getDataImportBatch(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchDataImportBatch()`

BoolResult patchDataImportBatch(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteDataImportBatch()`

BoolResult deleteDataImportBatch(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createEngagementPlan()`

SFCreationResult createEngagementPlan(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getEngagementPlan()`

SFObjectResult getEngagementPlan(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchEngagementPlan()`

BoolResult patchEngagementPlan(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteEngagementPlan()`

BoolResult deleteEngagementPlan(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createEngagementPlanTask()`

SFCreationResult createEngagementPlanTask(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getEngagementPlanTask()`

SFObjectResult getEngagementPlanTask(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchEngagementPlanTask()`

BoolResult patchEngagementPlanTask(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteEngagementPlanTask()`

BoolResult deleteEngagementPlanTask(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createEngagementPlanTemplate()`

SFCreationResult createEngagementPlanTemplate(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getEngagementPlanTemplate()`

SFObjectResult getEngagementPlanTemplate(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchEngagementPlanTemplate()`

BoolResult patchEngagementPlanTemplate(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteEngagementPlanTemplate()`

BoolResult deleteEngagementPlanTemplate(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createError()`

SFCreationResult createError(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getError()`

SFObjectResult getError(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchError()`

BoolResult patchError(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteError()`

BoolResult deleteError(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createGeneralAccountingUnit()`

SFCreationResult createGeneralAccountingUnit(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getGeneralAccountingUnit()`

SFObjectResult getGeneralAccountingUnit(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchGeneralAccountingUnit()`

BoolResult patchGeneralAccountingUnit(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteGeneralAccountingUnit()`

BoolResult deleteGeneralAccountingUnit(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createGrantDeadline()`

SFCreationResult createGrantDeadline(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getGrantDeadline()`

SFObjectResult getGrantDeadline(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchGrantDeadline()`

BoolResult patchGrantDeadline(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteGrantDeadline()`

BoolResult deleteGrantDeadline(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createHousehold()`

SFCreationResult createHousehold(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getHousehold()`

SFObjectResult getHousehold(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchHousehold()`

BoolResult patchHousehold(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteHousehold()`

BoolResult deleteHousehold(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createLevel()`

SFCreationResult createLevel(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getLevel()`

SFObjectResult getLevel(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchLevel()`

BoolResult patchLevel(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteLevel()`

BoolResult deleteLevel(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createOppPayment()`

SFCreationResult createOppPayment(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getOppPayment()`

SFObjectResult getOppPayment(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchOppPayment()`

BoolResult patchOppPayment(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteOppPayment()`

BoolResult deleteOppPayment(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createPartialSoftCredit()`

SFCreationResult createPartialSoftCredit(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getPartialSoftCredit()`

SFObjectResult getPartialSoftCredit(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchPartialSoftCredit()`

BoolResult patchPartialSoftCredit(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deletePartialSoftCredit()`

BoolResult deletePartialSoftCredit(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createRecurringDonation()`

SFCreationResult createRecurringDonation(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getRecurringDonation()`

SFObjectResult getRecurringDonation(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchRecurringDonation()`

BoolResult patchRecurringDonation(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteRecurringDonation()`

BoolResult deleteRecurringDonation(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createRelationship()`

SFCreationResult createRelationship(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getRelationship()`

SFObjectResult getRelationship(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchRelationship()`

BoolResult patchRelationship(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteRelationship()`

BoolResult deleteRelationship(string $id)

Parameters

string $id

Return Value

BoolResult

at line 232

`createTriggerHandler()`

SFCreationResult createTriggerHandler(array $data)

Parameters

array $data

Return Value

SFCreationResult

at line 232

`getTriggerHandler()`

SFObjectResult getTriggerHandler(string $id, array $fields = [])

Parameters

`string`	`$id`
`array`	`$fields`

Return Value

SFObjectResult

at line 232

`patchTriggerHandler()`

BoolResult patchTriggerHandler(string $id, array $data)

Parameters

`string`	`$id`
`array`	`$data`

Return Value

BoolResult

at line 232

`deleteTriggerHandler()`

BoolResult deleteTriggerHandler(string $id)

Parameters

string $id

Return Value

BoolResult

Source code

<?php

namespace SFClient;

use SFClient\Result\BoolResult;
use SFClient\Result\SFCreationResult;
use SFClient\Result\SFObjectResult;
use SFClient\SalesForce\SFAPIClient;

/**
 * Class NPSPClient
 *
 * Client for interacting with the Nonprofit Success Pack package. This client
 * extends the functionality of the base SalesForce client by adding CRUD
 * support for the custom objects that are supplied by the NPSP package.
 *
 * ```php
 * $client = new NPSPClient(SFAPIClient::connect($endpoint, $auth));
 * ```
 *
 * @package SFClient
 *
 * @method SFCreationResult createAccount(array $data)
 * @method SFObjectResult getAccount(string $id, array $fields = [])
 * @method BoolResult patchAccount(string $id, array $data)
 * @method BoolResult deleteAccount(string $id)
 * @method SFCreationResult createActivity(array $data)
 * @method SFObjectResult getActivity(string $id, array $fields = [])
 * @method BoolResult patchActivity(string $id, array $data)
 * @method BoolResult deleteActivity(string $id)
 * @method SFCreationResult createAddress(array $data)
 * @method SFObjectResult getAddress(string $id, array $fields = [])
 * @method BoolResult patchAddress(string $id, array $data)
 * @method BoolResult deleteAddress(string $id)
 * @method SFCreationResult createAffiliation(array $data)
 * @method SFObjectResult getAffiliation(string $id, array $fields = [])
 * @method BoolResult patchAffiliation(string $id, array $data)
 * @method BoolResult deleteAffiliation(string $id)
 * @method SFCreationResult createAllocation(array $data)
 * @method SFObjectResult getAllocation(string $id, array $fields = [])
 * @method BoolResult patchAllocation(string $id, array $data)
 * @method BoolResult deleteAllocation(string $id)
 * @method SFCreationResult createAsset(array $data)
 * @method SFObjectResult getAsset(string $id, array $fields = [])
 * @method BoolResult patchAsset(string $id, array $data)
 * @method BoolResult deleteAsset(string $id)
 * @method SFCreationResult createAssetRelationship(array $data)
 * @method SFObjectResult getAssetRelationship(string $id, array $fields = [])
 * @method BoolResult patchAssetRelationship(string $id, array $data)
 * @method BoolResult deleteAssetRelationship(string $id)
 * @method SFCreationResult createBatch(array $data)
 * @method SFObjectResult getBatch(string $id, array $fields = [])
 * @method BoolResult patchBatch(string $id, array $data)
 * @method BoolResult deleteBatch(string $id)
 * @method SFCreationResult createCampaign(array $data)
 * @method SFObjectResult getCampaign(string $id, array $fields = [])
 * @method BoolResult patchCampaign(string $id, array $data)
 * @method BoolResult deleteCampaign(string $id)
 * @method SFCreationResult createCampaignMember(array $data)
 * @method SFObjectResult getCampaignMember(string $id, array $fields = [])
 * @method BoolResult patchCampaignMember(string $id, array $data)
 * @method BoolResult deleteCampaignMember(string $id)
 * @method SFCreationResult createCase(array $data)
 * @method SFObjectResult getCase(string $id, array $fields = [])
 * @method BoolResult patchCase(string $id, array $data)
 * @method BoolResult deleteCase(string $id)
 * @method SFCreationResult createContact(array $data)
 * @method SFObjectResult getContact(string $id, array $fields = [])
 * @method BoolResult patchContact(string $id, array $data)
 * @method BoolResult deleteContact(string $id)
 * @method SFCreationResult createContentVersion(array $data)
 * @method SFObjectResult getContentVersion(string $id, array $fields = [])
 * @method BoolResult patchContentVersion(string $id, array $data)
 * @method BoolResult deleteContentVersion(string $id)
 * @method SFCreationResult createContract(array $data)
 * @method SFObjectResult getContract(string $id, array $fields = [])
 * @method BoolResult patchContract(string $id, array $data)
 * @method BoolResult deleteContract(string $id)
 * @method SFCreationResult createContractContactRole(array $data)
 * @method SFObjectResult getContractContactRole(string $id, array $fields = [])
 * @method BoolResult patchContractContactRole(string $id, array $data)
 * @method BoolResult deleteContractContactRole(string $id)
 * @method SFCreationResult createDataImport(array $data)
 * @method SFObjectResult getDataImport(string $id, array $fields = [])
 * @method BoolResult patchDataImport(string $id, array $data)
 * @method BoolResult deleteDataImport(string $id)
 * @method SFCreationResult createDataImportBatch(array $data)
 * @method SFObjectResult getDataImportBatch(string $id, array $fields = [])
 * @method BoolResult patchDataImportBatch(string $id, array $data)
 * @method BoolResult deleteDataImportBatch(string $id)
 * @method SFCreationResult createDuplicateRecordItem(array $data)
 * @method SFObjectResult getDuplicateRecordItem(string $id, array $fields = [])
 * @method BoolResult patchDuplicateRecordItem(string $id, array $data)
 * @method BoolResult deleteDuplicateRecordItem(string $id)
 * @method SFCreationResult createDuplicateRecordSet(array $data)
 * @method SFObjectResult getDuplicateRecordSet(string $id, array $fields = [])
 * @method BoolResult patchDuplicateRecordSet(string $id, array $data)
 * @method BoolResult deleteDuplicateRecordSet(string $id)
 * @method SFCreationResult createEmailMessage(array $data)
 * @method SFObjectResult getEmailMessage(string $id, array $fields = [])
 * @method BoolResult patchEmailMessage(string $id, array $data)
 * @method BoolResult deleteEmailMessage(string $id)
 * @method SFCreationResult createEngagementPlan(array $data)
 * @method SFObjectResult getEngagementPlan(string $id, array $fields = [])
 * @method BoolResult patchEngagementPlan(string $id, array $data)
 * @method BoolResult deleteEngagementPlan(string $id)
 * @method SFCreationResult createEngagementPlanTask(array $data)
 * @method SFObjectResult getEngagementPlanTask(string $id, array $fields = [])
 * @method BoolResult patchEngagementPlanTask(string $id, array $data)
 * @method BoolResult deleteEngagementPlanTask(string $id)
 * @method SFCreationResult createEngagementPlanTemplate(array $data)
 * @method SFObjectResult getEngagementPlanTemplate(string $id, array $fields = [])
 * @method BoolResult patchEngagementPlanTemplate(string $id, array $data)
 * @method BoolResult deleteEngagementPlanTemplate(string $id)
 * @method SFCreationResult createError(array $data)
 * @method SFObjectResult getError(string $id, array $fields = [])
 * @method BoolResult patchError(string $id, array $data)
 * @method BoolResult deleteError(string $id)
 * @method SFCreationResult createEvent(array $data)
 * @method SFObjectResult getEvent(string $id, array $fields = [])
 * @method BoolResult patchEvent(string $id, array $data)
 * @method BoolResult deleteEvent(string $id)
 * @method SFCreationResult createGeneralAccountingUnit(array $data)
 * @method SFObjectResult getGeneralAccountingUnit(string $id, array $fields = [])
 * @method BoolResult patchGeneralAccountingUnit(string $id, array $data)
 * @method BoolResult deleteGeneralAccountingUnit(string $id)
 * @method SFCreationResult createGrantDeadline(array $data)
 * @method SFObjectResult getGrantDeadline(string $id, array $fields = [])
 * @method BoolResult patchGrantDeadline(string $id, array $data)
 * @method BoolResult deleteGrantDeadline(string $id)
 * @method SFCreationResult createHousehold(array $data)
 * @method SFObjectResult getHousehold(string $id, array $fields = [])
 * @method BoolResult patchHousehold(string $id, array $data)
 * @method BoolResult deleteHousehold(string $id)
 * @method SFCreationResult createLead(array $data)
 * @method SFObjectResult getLead(string $id, array $fields = [])
 * @method BoolResult patchLead(string $id, array $data)
 * @method BoolResult deleteLead(string $id)
 * @method SFCreationResult createLevel(array $data)
 * @method SFObjectResult getLevel(string $id, array $fields = [])
 * @method BoolResult patchLevel(string $id, array $data)
 * @method BoolResult deleteLevel(string $id)
 * @method SFCreationResult createMacro(array $data)
 * @method SFObjectResult getMacro(string $id, array $fields = [])
 * @method BoolResult patchMacro(string $id, array $data)
 * @method BoolResult deleteMacro(string $id)
 * @method SFCreationResult createOppPayment(array $data)
 * @method SFObjectResult getOppPayment(string $id, array $fields = [])
 * @method BoolResult patchOppPayment(string $id, array $data)
 * @method BoolResult deleteOppPayment(string $id)
 * @method SFCreationResult createOpportunity(array $data)
 * @method SFObjectResult getOpportunity(string $id, array $fields = [])
 * @method BoolResult patchOpportunity(string $id, array $data)
 * @method BoolResult deleteOpportunity(string $id)
 * @method SFCreationResult createOpportunityLineItem(array $data)
 * @method SFObjectResult getOpportunityLineItem(string $id, array $fields = [])
 * @method BoolResult patchOpportunityLineItem(string $id, array $data)
 * @method BoolResult deleteOpportunityLineItem(string $id)
 * @method SFCreationResult createOrder(array $data)
 * @method SFObjectResult getOrder(string $id, array $fields = [])
 * @method BoolResult patchOrder(string $id, array $data)
 * @method BoolResult deleteOrder(string $id)
 * @method SFCreationResult createOrderItem(array $data)
 * @method SFObjectResult getOrderItem(string $id, array $fields = [])
 * @method BoolResult patchOrderItem(string $id, array $data)
 * @method BoolResult deleteOrderItem(string $id)
 * @method SFCreationResult createPartialSoftCredit(array $data)
 * @method SFObjectResult getPartialSoftCredit(string $id, array $fields = [])
 * @method BoolResult patchPartialSoftCredit(string $id, array $data)
 * @method BoolResult deletePartialSoftCredit(string $id)
 * @method SFCreationResult createPricebook2(array $data)
 * @method SFObjectResult getPricebook2(string $id, array $fields = [])
 * @method BoolResult patchPricebook2(string $id, array $data)
 * @method BoolResult deletePricebook2(string $id)
 * @method SFCreationResult createPricebookEntry(array $data)
 * @method SFObjectResult getPricebookEntry(string $id, array $fields = [])
 * @method BoolResult patchPricebookEntry(string $id, array $data)
 * @method BoolResult deletePricebookEntry(string $id)
 * @method SFCreationResult createQuickText(array $data)
 * @method SFObjectResult getQuickText(string $id, array $fields = [])
 * @method BoolResult patchQuickText(string $id, array $data)
 * @method BoolResult deleteQuickText(string $id)
 * @method SFCreationResult createRecurringDonation(array $data)
 * @method SFObjectResult getRecurringDonation(string $id, array $fields = [])
 * @method BoolResult patchRecurringDonation(string $id, array $data)
 * @method BoolResult deleteRecurringDonation(string $id)
 * @method SFCreationResult createRelationship(array $data)
 * @method SFObjectResult getRelationship(string $id, array $fields = [])
 * @method BoolResult patchRelationship(string $id, array $data)
 * @method BoolResult deleteRelationship(string $id)
 * @method SFCreationResult createScorecard(array $data)
 * @method SFObjectResult getScorecard(string $id, array $fields = [])
 * @method BoolResult patchScorecard(string $id, array $data)
 * @method BoolResult deleteScorecard(string $id)
 * @method SFCreationResult createScorecardAssociation(array $data)
 * @method SFObjectResult getScorecardAssociation(string $id, array $fields = [])
 * @method BoolResult patchScorecardAssociation(string $id, array $data)
 * @method BoolResult deleteScorecardAssociation(string $id)
 * @method SFCreationResult createScorecardMetric(array $data)
 * @method SFObjectResult getScorecardMetric(string $id, array $fields = [])
 * @method BoolResult patchScorecardMetric(string $id, array $data)
 * @method BoolResult deleteScorecardMetric(string $id)
 * @method SFCreationResult createSignupRequest(array $data)
 * @method SFObjectResult getSignupRequest(string $id, array $fields = [])
 * @method BoolResult patchSignupRequest(string $id, array $data)
 * @method BoolResult deleteSignupRequest(string $id)
 * @method SFCreationResult createSocialPersona(array $data)
 * @method SFObjectResult getSocialPersona(string $id, array $fields = [])
 * @method BoolResult patchSocialPersona(string $id, array $data)
 * @method BoolResult deleteSocialPersona(string $id)
 * @method SFCreationResult createSocialPost(array $data)
 * @method SFObjectResult getSocialPost(string $id, array $fields = [])
 * @method BoolResult patchSocialPost(string $id, array $data)
 * @method BoolResult deleteSocialPost(string $id)
 * @method SFCreationResult createTask(array $data)
 * @method SFObjectResult getTask(string $id, array $fields = [])
 * @method BoolResult patchTask(string $id, array $data)
 * @method BoolResult deleteTask(string $id)
 * @method SFCreationResult createTriggerHandler(array $data)
 * @method SFObjectResult getTriggerHandler(string $id, array $fields = [])
 * @method BoolResult patchTriggerHandler(string $id, array $data)
 * @method BoolResult deleteTriggerHandler(string $id)
 * @method SFCreationResult createUser(array $data)
 * @method SFObjectResult getUser(string $id, array $fields = [])
 * @method BoolResult patchUser(string $id, array $data)
 * @method BoolResult deleteUser(string $id)
 * @method SFCreationResult createUserProvisioningRequest(array $data)
 * @method SFObjectResult getUserProvisioningRequest(string $id, array $fields = [])
 * @method BoolResult patchUserProvisioningRequest(string $id, array $data)
 * @method BoolResult deleteUserProvisioningRequest(string $id)
 */
class NPSPClient extends Client {

  /**
   * NPSPClient constructor.
   * @param SFAPIClient $client
   */
  public function __construct(SFAPIClient $client) {
    parent::__construct($client);
    $types = require __DIR__ . DS . 'SalesForce' . DS . 'ObjectTypes.php';
    $npspTypes = require __DIR__ . DS . 'SalesForce' . DS . 'NPSPObjectTypes.php';

    $this->_types = array_merge($types, $npspTypes);
    $this->_typeNames = array_keys($this->_types);
  }
}